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

/**
 * Represents a communication message.
 */
export interface CommunicationMessage {
  /**
   * The contents of the message.
   */
  body?: string;
  /**
   * The client the message was sent to.
   */
  clientKey?: string;
  /**
   * The date the communication message was created in UTC.
   */
  creationDate?: string;
  /**
   * The deposit account that triggered this message.
   */
  depositAccountKey?: string;
  /**
   * The destination (phone number or email address) this message was sent to.
   */
  destination?: string;
  /**
   * The encoded key of the communication message, which is generated automatically, and must be unique.
   */
  encodedKey?: string;
  /**
   * The event that triggered this message.
   */
  event?: CommunicationMessageEventEnum;
  /**
   * The failure code if the message failed to send.
   */
  failureCause?: string;
  /**
   * The reason for the communication message failure.
   */
  failureReason?: CommunicationMessageFailureReasonEnum;
  /**
   * The group the message was sent to.
   */
  groupKey?: string;
  /**
   * The loan account that triggered this message.
   */
  loanAccountKey?: string;
  /**
   * The number of retries to send the message.
   */
  numRetries?: number;
  /**
   * The reference ID of the communication message, generated by the SMS dispatcher.
   */
  referenceId?: string;
  /**
   * The repayment that triggered this message.
   */
  repaymentKey?: string;
  /**
   * The date the communication message was sent in UTC.
   */
  sendDate?: string;
  /**
   * The encoded key of the sender. If specified, it should be the encoded key of the current user.
   */
  senderKey?: string;
  /**
   * The state of the message.
   */
  state?: CommunicationMessageStateEnum;
  /**
   * The subject of the message.
   */
  subject?: string;
  /**
   * The communication message template key.
   */
  templateKey?: string;
  /**
   * The type of communication message.
   */
  type?: CommunicationMessageTypeEnum;
  /**
   * The user the message was sent to.
   */
  userKey?: string;
}

export const CommunicationMessageEventEnum = {
  Manual: 'MANUAL',
  DoNothing: 'DO_NOTHING',
  ClientCreated: 'CLIENT_CREATED',
  ClientApproved: 'CLIENT_APPROVED',
  GroupActivity: 'GROUP_ACTIVITY',
  GroupCreated: 'GROUP_CREATED',
  LoanCreated: 'LOAN_CREATED',
  InterestRateChanged: 'INTEREST_RATE_CHANGED',
  ClientRejected: 'CLIENT_REJECTED',
  ClientActivity: 'CLIENT_ACTIVITY',
  LoanRepayment: 'LOAN_REPAYMENT',
  LoanRepaymentReversal: 'LOAN_REPAYMENT_REVERSAL',
  FeeApplied: 'FEE_APPLIED',
  FeeAdjusted: 'FEE_ADJUSTED',
  FeeCharged: 'FEE_CHARGED',
  PenaltyApplied: 'PENALTY_APPLIED',
  PenaltyAdjustment: 'PENALTY_ADJUSTMENT',
  FeesDueReduced: 'FEES_DUE_REDUCED',
  FeeReductionAdjustment: 'FEE_REDUCTION_ADJUSTMENT',
  LoanApproval: 'LOAN_APPROVAL',
  LoanAccountClosure: 'LOAN_ACCOUNT_CLOSURE',
  LoanAccountWriteOff: 'LOAN_ACCOUNT_WRITE_OFF',
  LoanAccountRejection: 'LOAN_ACCOUNT_REJECTION',
  LoanAccountRescheduled: 'LOAN_ACCOUNT_RESCHEDULED',
  LoanAccountRefinanced: 'LOAN_ACCOUNT_REFINANCED',
  RepaymentReminder: 'REPAYMENT_REMINDER',
  AccountInArrears: 'ACCOUNT_IN_ARREARS',
  LoanDisbursement: 'LOAN_DISBURSEMENT',
  LoanDisbursementReversal: 'LOAN_DISBURSEMENT_REVERSAL',
  LoanAccountActivity: 'LOAN_ACCOUNT_ACTIVITY',
  LoanAnticipatedDisbursement: 'LOAN_ANTICIPATED_DISBURSEMENT',
  SavingsCreated: 'SAVINGS_CREATED',
  SavingsDeposit: 'SAVINGS_DEPOSIT',
  SavingsDepositReversal: 'SAVINGS_DEPOSIT_REVERSAL',
  ReappliedSavingsDeposit: 'REAPPLIED_SAVINGS_DEPOSIT',
  SavingsApproval: 'SAVINGS_APPROVAL',
  SavingsAccountActivated: 'SAVINGS_ACCOUNT_ACTIVATED',
  SavingsAccountClosure: 'SAVINGS_ACCOUNT_CLOSURE',
  SavingsAccountRejection: 'SAVINGS_ACCOUNT_REJECTION',
  SavingsWithdrawal: 'SAVINGS_WITHDRAWAL',
  SavingsWithdrawalReversal: 'SAVINGS_WITHDRAWAL_REVERSAL',
  ReappliedSavingsWithdrawal: 'REAPPLIED_SAVINGS_WITHDRAWAL',
  SavingsAccountActivity: 'SAVINGS_ACCOUNT_ACTIVITY',
  DepositInterestApplied: 'DEPOSIT_INTEREST_APPLIED',
  DepositInterestAppliedAdjustment: 'DEPOSIT_INTEREST_APPLIED_ADJUSTMENT',
  AccountAuthorisationHoldCreated: 'ACCOUNT_AUTHORISATION_HOLD_CREATED',
  AccountAuthorisationHoldReversed: 'ACCOUNT_AUTHORISATION_HOLD_REVERSED',
  AccountAuthorisationHoldSettled: 'ACCOUNT_AUTHORISATION_HOLD_SETTLED',
  CardsAuthorisationHoldCreated: 'CARDS_AUTHORISATION_HOLD_CREATED',
  CardsAuthorisationHoldInBulkCreated:
    'CARDS_AUTHORISATION_HOLD_IN_BULK_CREATED',
  CardsAuthorisationHoldSettled: 'CARDS_AUTHORISATION_HOLD_SETTLED',
  CardsAuthorisationHoldAmountDecreased:
    'CARDS_AUTHORISATION_HOLD_AMOUNT_DECREASED',
  CardsAuthorisationHoldAmountIncreased:
    'CARDS_AUTHORISATION_HOLD_AMOUNT_INCREASED',
  CardsAuthorisationHoldExpired: 'CARDS_AUTHORISATION_HOLD_EXPIRED',
  CardsAuthorisationHoldReversed: 'CARDS_AUTHORISATION_HOLD_REVERSED',
  PortalActivated: 'PORTAL_ACTIVATED',
  PortalPasswordReset: 'PORTAL_PASSWORD_RESET',
  EndOfDayProcessingCompleted: 'END_OF_DAY_PROCESSING_COMPLETED',
  DataAccessStateChanged: 'DATA_ACCESS_STATE_CHANGED',
  CreditArrangementCreated: 'CREDIT_ARRANGEMENT_CREATED',
  CreditArrangementClosed: 'CREDIT_ARRANGEMENT_CLOSED',
  CreditArrangementApproved: 'CREDIT_ARRANGEMENT_APPROVED',
  CreditArrangementRejected: 'CREDIT_ARRANGEMENT_REJECTED',
  CreditArrangementWithdrawn: 'CREDIT_ARRANGEMENT_WITHDRAWN',
  CreditArrangementDeleted: 'CREDIT_ARRANGEMENT_DELETED',
  CreditArrangementAccountAdded: 'CREDIT_ARRANGEMENT_ACCOUNT_ADDED',
  CreditArrangementAccountRemoved: 'CREDIT_ARRANGEMENT_ACCOUNT_REMOVED',
  CreditArrangementEdited: 'CREDIT_ARRANGEMENT_EDITED',
  PaymentOrderActivity: 'PAYMENT_ORDER_ACTIVITY',
  CollectionOrderActivity: 'COLLECTION_ORDER_ACTIVITY',
  JournalEntryAdded: 'JOURNAL_ENTRY_ADDED',
  JournalEntryAdjusted: 'JOURNAL_ENTRY_ADJUSTED',
  SavingsTransactionEdited: 'SAVINGS_TRANSACTION_EDITED',
  CardWithdrawalReversal: 'CARD_WITHDRAWAL_REVERSAL',
  CardDepositReversal: 'CARD_DEPOSIT_REVERSAL',
} as const;

export type CommunicationMessageEventEnum =
  (typeof CommunicationMessageEventEnum)[keyof typeof CommunicationMessageEventEnum];
export const CommunicationMessageFailureReasonEnum = {
  MessagingException: 'MESSAGING_EXCEPTION',
  InvalidSmtpCredentials: 'INVALID_SMTP_CREDENTIALS',
  UnsupportedEncodingException: 'UNSUPPORTED_ENCODING_EXCEPTION',
  EmailServiceNotEnabled: 'EMAIL_SERVICE_NOT_ENABLED',
  SmsTooLong: 'SMS_TOO_LONG',
  SmsServiceNotEnabled: 'SMS_SERVICE_NOT_ENABLED',
  SmsNotSent: 'SMS_NOT_SENT',
  SmsServiceError: 'SMS_SERVICE_ERROR',
  SmsConnectionException: 'SMS_CONNECTION_EXCEPTION',
  WebhookNotificationsDisabled: 'WEBHOOK_NOTIFICATIONS_DISABLED',
  InvalidHttpResponse: 'INVALID_HTTP_RESPONSE',
  HttpErrorWhileSending: 'HTTP_ERROR_WHILE_SENDING',
  InvalidJsonBodySyntax: 'INVALID_JSON_BODY_SYNTAX',
  MissingTemplateKey: 'MISSING_TEMPLATE_KEY',
  MaxMessageSizeLimitExceeded: 'MAX_MESSAGE_SIZE_LIMIT_EXCEEDED',
  UndefinedDestination: 'UNDEFINED_DESTINATION',
  InvalidHttpProtocol: 'INVALID_HTTP_PROTOCOL',
  BlacklistedUrl: 'BLACKLISTED_URL',
  InvalidSmsGatewayCredentials: 'INVALID_SMS_GATEWAY_CREDENTIALS',
  MissingSmsRecipient: 'MISSING_SMS_RECIPIENT',
  SmsGatewayError: 'SMS_GATEWAY_ERROR',
  MissingEmailRecipientAddress: 'MISSING_EMAIL_RECIPIENT_ADDRESS',
  Other: 'OTHER',
} as const;

export type CommunicationMessageFailureReasonEnum =
  (typeof CommunicationMessageFailureReasonEnum)[keyof typeof CommunicationMessageFailureReasonEnum];
export const CommunicationMessageStateEnum = {
  Sent: 'SENT',
  Queued: 'QUEUED',
  QueuedForStream: 'QUEUED_FOR_STREAM',
  Waiting: 'WAITING',
  SendingAsync: 'SENDING_ASYNC',
  Failed: 'FAILED',
  KafkaSuccessKinesisFailed: 'KAFKA_SUCCESS_KINESIS_FAILED',
} as const;

export type CommunicationMessageStateEnum =
  (typeof CommunicationMessageStateEnum)[keyof typeof CommunicationMessageStateEnum];
export const CommunicationMessageTypeEnum = {
  Email: 'EMAIL',
  Sms: 'SMS',
  WebHook: 'WEB_HOOK',
  EventStream: 'EVENT_STREAM',
  Task: 'TASK',
} as const;

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