/* tslint:disable */
/* eslint-disable */
/**
 * groups
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v2
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

// May contain unused imports in some cases
// @ts-ignore
import type { Address } from './address';
// May contain unused imports in some cases
// @ts-ignore
import type { GroupMember } from './group-member';

/**
 * Represents a group. A group is a type of client that can represent a non-physical person such as a company client or a grouping of individual clients. A group can have its own accounts and can optionally have individual clients as members, in which case they also need to have an individual profile in Mambu.
 */
export interface Group {
  /**
   * The addresses associated with this group.
   */
  addresses?: Array<Address>;
  /**
   * Key of the branch this group is assigned to.
   */
  assignedBranchKey?: string;
  /**
   * Key of the centre this group is assigned to.
   */
  assignedCentreKey?: string;
  /**
   * Key of the user this group is assigned to.
   */
  assignedUserKey?: string;
  /**
   * The date the group was created.
   */
  creationDate?: string;
  /**
   * The email address associated with the group.
   */
  emailAddress?: string;
  /**
   * The encoded key of the group, which is auto generated, and must be unique.
   */
  encodedKey?: string;
  /**
   * The members of this group.
   */
  groupMembers?: Array<GroupMember>;
  /**
   * The name of the group.
   */
  groupName: string;
  /**
   * A role which describes the intended use of a group in the system.
   */
  groupRoleKey?: string;
  /**
   * The home phone number associated with the group.
   */
  homePhone?: string;
  /**
   * The ID of the group, which can be generated and customized, but must be unique.
   */
  id?: string;
  /**
   * The last date the group was updated.
   */
  lastModifiedDate?: string;
  /**
   * Number of paid and closed (with \'obligations met\') accounts for this client. When the closing operation is reverted, this is reduced.
   */
  loanCycle?: number;
  /**
   * The migration event encoded key associated with this group.
   */
  migrationEventKey?: string;
  /**
   * The mobile phone number associated with the group.
   */
  mobilePhone?: string;
  /**
   * Extra notes about this group.
   */
  notes?: string;
  /**
   * The preferred language associated with the group (used for the notifications).
   */
  preferredLanguage?: GroupPreferredLanguageEnum;
}

export const GroupPreferredLanguageEnum = {
  English: 'ENGLISH',
  Portugese: 'PORTUGESE',
  Spanish: 'SPANISH',
  Russian: 'RUSSIAN',
  French: 'FRENCH',
  Georgian: 'GEORGIAN',
  Chinese: 'CHINESE',
  Indonesian: 'INDONESIAN',
  Romanian: 'ROMANIAN',
  Burmese: 'BURMESE',
  German: 'GERMAN',
  PortugueseBrazil: 'PORTUGUESE_BRAZIL',
  Vietnamese: 'VIETNAMESE',
  Italian: 'ITALIAN',
  Thai: 'THAI',
  Norwegian: 'NORWEGIAN',
  Phrase: 'PHRASE',
} as const;

export type GroupPreferredLanguageEnum =
  (typeof GroupPreferredLanguageEnum)[keyof typeof GroupPreferredLanguageEnum];