/* tslint:disable */
/* eslint-disable */
/**
 * clients
 * 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.
 */

/**
 * The unit that composes the list used for Clients searching
 */
export interface ClientFilterCriteria {
  /**
   * The fields to perform the search. They can be native (one from the provided list) or otherwise can specify a custom field definition using the format [customFieldSetId].[customFieldId].
   */
  field: ClientFilterCriteriaFieldEnum;
  /**
   * | **Operator**                | **Affected values**  | **Available for**                                                    | |---------------               |----------------------|----------------------------------------------------------------------| | EQUALS                       | ONE_VALUE            | BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY        | | EQUALS_CASE_SENSITIVE        | ONE_VALUE            | BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY     | | MORE_THAN                    | ONE_VALUE            | BIG_DECIMAL,NUMBER,MONEY                                             | | LESS_THAN                    | ONE_VALUE            | BIG_DECIMAL,NUMBER,MONEY                                             | | BETWEEN                      | TWO_VALUES           | BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_TIME                              | | ON                           | ONE_VALUE            | DATE,DATE_TIME                                                       | | AFTER                        | ONE_VALUE            | DATE,DATE_TIME                                                       | | BEFORE                       | ONE_VALUE            | DATE,DATE_TIME                                                       | | BEFORE_INCLUSIVE             | ONE_VALUE            | DATE,DATE_TIME                                                       | | STARTS_WITH                  | ONE_VALUE            | STRING                                                               | | STARTS_WITH_CASE_SENSITIVE   | ONE_VALUE            | STRING                                                               | | IN                           | LIST                 | ENUM,KEY                                                             | | TODAY                        | NO_VALUE             | DATE,DATE_TIME                                                       | | THIS_WEEK                    | NO_VALUE             | DATE,DATE_TIME                                                       | | THIS_MONTH                   | NO_VALUE             | DATE,DATE_TIME                                                       | | THIS_YEAR                    | NO_VALUE             | DATE,DATE_TIME                                                       | | LAST_DAYS                    | ONE_VALUE            | NUMBER                                                               | | EMPTY                        | NO_VALUE             | BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME | | NOT_EMPTY                    | NO_VALUE             | BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME |
   */
  operator: ClientFilterCriteriaOperatorEnum;
  /**
   * The second value to match the searching criteria, when the `BETWEEN` operator is used.
   */
  secondValue?: string;
  /**
   * The value to match the searching criteria.
   */
  value?: string;
  /**
   * List of values when the `IN` operator is used.
   */
  values?: Array<string>;
}

export const ClientFilterCriteriaFieldEnum = {
  EncodedKey: 'encodedKey',
  CreditOfficerKey: 'creditOfficerKey',
  ClientRoleKey: 'clientRoleKey',
  BranchKey: 'branchKey',
  CentreKey: 'centreKey',
  GroupKey: 'groupKey',
  FullName: 'fullName',
  FirstName: 'firstName',
  MiddleName: 'middleName',
  LastName: 'lastName',
  CreationDate: 'creationDate',
  LastModifiedDate: 'lastModifiedDate',
  Id: 'id',
  DepositsBalance: 'depositsBalance',
  LoansBalance: 'loansBalance',
  PendingLoanAmount: 'pendingLoanAmount',
  ApprovedLoanAmount: 'approvedLoanAmount',
  TotalBalance: 'totalBalance',
  TotalDue: 'totalDue',
  HomePhoneNumber: 'homePhoneNumber',
  MobilePhoneNumber: 'mobilePhoneNumber',
  MobilePhoneNumber2: 'mobilePhoneNumber2',
  EmailAddress: 'emailAddress',
  ClientAddress: 'clientAddress',
  Birthdate: 'birthdate',
  Gender: 'gender',
  LoanCycle: 'loanCycle',
  GroupLoanCycle: 'groupLoanCycle',
  ClientState: 'clientState',
  PortalState: 'portalState',
  PreferredLanguage: 'preferredLanguage',
  GroupId: 'groupId',
} as const;

export type ClientFilterCriteriaFieldEnum =
  (typeof ClientFilterCriteriaFieldEnum)[keyof typeof ClientFilterCriteriaFieldEnum];
export const ClientFilterCriteriaOperatorEnum = {
  Equals: 'EQUALS',
  EqualsCaseSensitive: 'EQUALS_CASE_SENSITIVE',
  DifferentThan: 'DIFFERENT_THAN',
  MoreThan: 'MORE_THAN',
  LessThan: 'LESS_THAN',
  Between: 'BETWEEN',
  On: 'ON',
  After: 'AFTER',
  AfterInclusive: 'AFTER_INCLUSIVE',
  Before: 'BEFORE',
  BeforeInclusive: 'BEFORE_INCLUSIVE',
  StartsWith: 'STARTS_WITH',
  StartsWithCaseSensitive: 'STARTS_WITH_CASE_SENSITIVE',
  In: 'IN',
  Today: 'TODAY',
  ThisWeek: 'THIS_WEEK',
  ThisMonth: 'THIS_MONTH',
  ThisYear: 'THIS_YEAR',
  LastDays: 'LAST_DAYS',
  Empty: 'EMPTY',
  NotEmpty: 'NOT_EMPTY',
} as const;

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