/* tslint:disable */
/* eslint-disable */
/**
 * consumers
 * 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 { UserManagedBranch } from './user-managed-branch';

/**
 * Represents the API consumer permissions and access rights.
 */
export interface ApiConsumerAccess {
  /**
   * `TRUE` if the API consumer has the administrator user type, `FALSE` otherwise. Administrators (admins) have all permissions and can perform any action in Mambu.
   */
  administratorAccess?: boolean;
  /**
   * `TRUE` if the API consumer can authenticate and interact with Mambu APIs, `FALSE` otherwise. The API consumer may still require additional permissions for specific API requests.
   */
  apiAccess?: boolean;
  /**
   * `TRUE` if the API consumer permissions apply to all branches, `FALSE` if they only apply to specific branches.
   */
  canManageAllBranches?: boolean;
  /**
   * `TRUE` if the API consumer (that has the credit officer access) can access entities (for example, clients or accounts) assigned to other credit officers, `FALSE` otherwise.
   */
  canManageEntitiesAssignedToOtherOfficers?: boolean;
  /**
   * `TRUE` if the API consumer has the credit officer user type, `FALSE` otherwise. Credit officers have the option of having clients and groups assigned to them.
   */
  creditOfficerAccess?: boolean;
  /**
   * The list of branches that can be managed by the API consumer. If the API consumer has the `canManageAllBranches` property set to `TRUE`, this list does not apply.
   */
  managedBranches?: Array<UserManagedBranch>;
  /**
   * Permissions for the API consumer. The non-admin API consumers and users are authorized to do actions based a set of permissions in order to access Mambu features. Permissions may be relevant for the API and/or the Mambu UI.
   */
  permissions?: Array<ApiConsumerAccessPermissionsEnum>;
}

export const ApiConsumerAccessPermissionsEnum = {
  AuditTransactions: 'AUDIT_TRANSACTIONS',
  ViewExchangeRates: 'VIEW_EXCHANGE_RATES',
  CreateExchangeRate: 'CREATE_EXCHANGE_RATE',
  ViewLoanAccountDetails: 'VIEW_LOAN_ACCOUNT_DETAILS',
  CreateLoanAccount: 'CREATE_LOAN_ACCOUNT',
  EditLoanAccount: 'EDIT_LOAN_ACCOUNT',
  ApproveLoans: 'APPROVE_LOANS',
  DiburseLoans: 'DIBURSE_LOANS',
  ApplyLoanFees: 'APPLY_LOAN_FEES',
  EnterRepayment: 'ENTER_REPAYMENT',
  EditPlannedFees: 'EDIT_PLANNED_FEES',
  EditRepaymentSchedule: 'EDIT_REPAYMENT_SCHEDULE',
  ApplyLoanAdjustments: 'APPLY_LOAN_ADJUSTMENTS',
  BackdateLoanTransactions: 'BACKDATE_LOAN_TRANSACTIONS',
  ApplyAccruedLoanInterest: 'APPLY_ACCRUED_LOAN_INTEREST',
  PostTransactionsOnLockedLoanAccounts:
    'POST_TRANSACTIONS_ON_LOCKED_LOAN_ACCOUNTS',
  EditPenaltyRate: 'EDIT_PENALTY_RATE',
  ViewInvestorFundsDetails: 'VIEW_INVESTOR_FUNDS_DETAILS',
  CreateInvestorFunds: 'CREATE_INVESTOR_FUNDS',
  EditInvestorFunds: 'EDIT_INVESTOR_FUNDS',
  DeleteInvestorFunds: 'DELETE_INVESTOR_FUNDS',
  SellLoanFraction: 'SELL_LOAN_FRACTION',
  RequestLoanApproval: 'REQUEST_LOAN_APPROVAL',
  EditLoanTranches: 'EDIT_LOAN_TRANCHES',
  RejectLoans: 'REJECT_LOANS',
  WriteOffLoanAccounts: 'WRITE_OFF_LOAN_ACCOUNTS',
  PayOffLoan: 'PAY_OFF_LOAN',
  ReverseLoanAccountWriteOff: 'REVERSE_LOAN_ACCOUNT_WRITE_OFF',
  CloseLoanAccounts: 'CLOSE_LOAN_ACCOUNTS',
  LockLoanAccounts: 'LOCK_LOAN_ACCOUNTS',
  WithdrawLoanAccounts: 'WITHDRAW_LOAN_ACCOUNTS',
  DeleteLoanAccount: 'DELETE_LOAN_ACCOUNT',
  SetDisbursementConditions: 'SET_DISBURSEMENT_CONDITIONS',
  RescheduleLoanAccount: 'RESCHEDULE_LOAN_ACCOUNT',
  RefinanceLoanAccount: 'REFINANCE_LOAN_ACCOUNT',
  EditLoanTransactions: 'EDIT_LOAN_TRANSACTIONS',
  BulkLoanCorrections: 'BULK_LOAN_CORRECTIONS',
  EditInterestRate: 'EDIT_INTEREST_RATE',
  EditRepaymentMethodValue: 'EDIT_REPAYMENT_METHOD_VALUE',
  EditPeriodicPaymentForActiveAccount:
    'EDIT_PERIODIC_PAYMENT_FOR_ACTIVE_ACCOUNT',
  UndoLoanAccountClosure: 'UNDO_LOAN_ACCOUNT_CLOSURE',
  UndoRejectLoans: 'UNDO_REJECT_LOANS',
  UndoWithdrawLoanAccounts: 'UNDO_WITHDRAW_LOAN_ACCOUNTS',
  LinkAccounts: 'LINK_ACCOUNTS',
  EditPrincipalPaymentActiveRevolvingCredit:
    'EDIT_PRINCIPAL_PAYMENT_ACTIVE_REVOLVING_CREDIT',
  PerformRepaymentsWithCustomAmountsAllocation:
    'PERFORM_REPAYMENTS_WITH_CUSTOM_AMOUNTS_ALLOCATION',
  ManageLoanAssociation: 'MANAGE_LOAN_ASSOCIATION',
  MakeWithdrawalRedraw: 'MAKE_WITHDRAWAL_REDRAW',
  EnterRefund: 'ENTER_REFUND',
  EditFeeRate: 'EDIT_FEE_RATE',
  CreditBalanceDeposit: 'CREDIT_BALANCE_DEPOSIT',
  ViewSavingsAccountDetails: 'VIEW_SAVINGS_ACCOUNT_DETAILS',
  CreateSavingsAccount: 'CREATE_SAVINGS_ACCOUNT',
  EditSavingsAccount: 'EDIT_SAVINGS_ACCOUNT',
  ApproveSavings: 'APPROVE_SAVINGS',
  MakeDeposit: 'MAKE_DEPOSIT',
  MakeBulkDeposits: 'MAKE_BULK_DEPOSITS',
  MakeWithdrawal: 'MAKE_WITHDRAWAL',
  BackdateSavingsTransactions: 'BACKDATE_SAVINGS_TRANSACTIONS',
  ApplySavingsAdjustments: 'APPLY_SAVINGS_ADJUSTMENTS',
  MakeTransfer: 'MAKE_TRANSFER',
  MakeInterClientsTransfers: 'MAKE_INTER_CLIENTS_TRANSFERS',
  CloseSavingsAccounts: 'CLOSE_SAVINGS_ACCOUNTS',
  ReopenSavingsAccount: 'REOPEN_SAVINGS_ACCOUNT',
  ApplySavingsFees: 'APPLY_SAVINGS_FEES',
  DeleteSavingsAccount: 'DELETE_SAVINGS_ACCOUNT',
  PostTransactionsOnDormantAccounts: 'POST_TRANSACTIONS_ON_DORMANT_ACCOUNTS',
  EditSavingsTransactions: 'EDIT_SAVINGS_TRANSACTIONS',
  BulkDepositCorrections: 'BULK_DEPOSIT_CORRECTIONS',
  ActivateMaturity: 'ACTIVATE_MATURITY',
  ApplyAccruedSavingsInterest: 'APPLY_ACCRUED_SAVINGS_INTEREST',
  LockSavingsAccount: 'LOCK_SAVINGS_ACCOUNT',
  UnlockSavingsAccount: 'UNLOCK_SAVINGS_ACCOUNT',
  UndoMaturity: 'UNDO_MATURITY',
  MakeEarlyWithdrawals: 'MAKE_EARLY_WITHDRAWALS',
  BlockAndSeizeFunds: 'BLOCK_AND_SEIZE_FUNDS',
  WithdrawBlockedFunds: 'WITHDRAW_BLOCKED_FUNDS',
  MakeBulkChangeInterestAvailability: 'MAKE_BULK_CHANGE_INTEREST_AVAILABILITY',
  ManageDepositAccountRecipient: 'MANAGE_DEPOSIT_ACCOUNT_RECIPIENT',
  ManageDepositAssociation: 'MANAGE_DEPOSIT_ASSOCIATION',
  BypassAccountOwnershipTransferViewRestriction:
    'BYPASS_ACCOUNT_OWNERSHIP_TRANSFER_VIEW_RESTRICTION',
  CreateCards: 'CREATE_CARDS',
  ViewCards: 'VIEW_CARDS',
  DeleteCards: 'DELETE_CARDS',
  ReverseCardWithdrawalTransaction: 'REVERSE_CARD_WITHDRAWAL_TRANSACTION',
  CardBalanceInquiry: 'CARD_BALANCE_INQUIRY',
  CreateAuthorizationHold: 'CREATE_AUTHORIZATION_HOLD',
  UpdateAuthorizationHold: 'UPDATE_AUTHORIZATION_HOLD',
  ViewAuthorizationHold: 'VIEW_AUTHORIZATION_HOLD',
  CreateCardTransaction: 'CREATE_CARD_TRANSACTION',
  CreateAccountHold: 'CREATE_ACCOUNT_HOLD',
  UpdateAccountHold: 'UPDATE_ACCOUNT_HOLD',
  ViewAccountHold: 'VIEW_ACCOUNT_HOLD',
  ViewSecuritiesDetails: 'VIEW_SECURITIES_DETAILS',
  CreateSecurities: 'CREATE_SECURITIES',
  EditSecurities: 'EDIT_SECURITIES',
  DeleteSecurities: 'DELETE_SECURITIES',
  CreateLinesOfCredit: 'CREATE_LINES_OF_CREDIT',
  EditLinesOfCredit: 'EDIT_LINES_OF_CREDIT',
  ViewLineOfCreditDetails: 'VIEW_LINE_OF_CREDIT_DETAILS',
  AddAccountsToLineOfCredit: 'ADD_ACCOUNTS_TO_LINE_OF_CREDIT',
  RemoveAccountsFromLineOfCredit: 'REMOVE_ACCOUNTS_FROM_LINE_OF_CREDIT',
  ApproveLineOfCredit: 'APPROVE_LINE_OF_CREDIT',
  UndoApproveLineOfCredit: 'UNDO_APPROVE_LINE_OF_CREDIT',
  WithdrawLineOfCredit: 'WITHDRAW_LINE_OF_CREDIT',
  UndoWithdrawLineOfCredit: 'UNDO_WITHDRAW_LINE_OF_CREDIT',
  RejectLineOfCredit: 'REJECT_LINE_OF_CREDIT',
  UndoRejectLineOfCredit: 'UNDO_REJECT_LINE_OF_CREDIT',
  CloseLinesOfCredit: 'CLOSE_LINES_OF_CREDIT',
  DeleteLinesOfCredit: 'DELETE_LINES_OF_CREDIT',
  ViewLoanProductDetails: 'VIEW_LOAN_PRODUCT_DETAILS',
  CreateLoanProduct: 'CREATE_LOAN_PRODUCT',
  DeleteLoanProducts: 'DELETE_LOAN_PRODUCTS',
  EditLoanProduct: 'EDIT_LOAN_PRODUCT',
  ViewSavingsProductDetails: 'VIEW_SAVINGS_PRODUCT_DETAILS',
  CreateSavingsProduct: 'CREATE_SAVINGS_PRODUCT',
  EditSavingsProduct: 'EDIT_SAVINGS_PRODUCT',
  DeleteSavingsProduct: 'DELETE_SAVINGS_PRODUCT',
  ViewClientDetails: 'VIEW_CLIENT_DETAILS',
  CreateClient: 'CREATE_CLIENT',
  EditClient: 'EDIT_CLIENT',
  DeleteClients: 'DELETE_CLIENTS',
  ViewGroupDetails: 'VIEW_GROUP_DETAILS',
  CreateGroup: 'CREATE_GROUP',
  EditGroup: 'EDIT_GROUP',
  DeleteGroup: 'DELETE_GROUP',
  ChangeClientType: 'CHANGE_CLIENT_TYPE',
  ChangeGroupType: 'CHANGE_GROUP_TYPE',
  ApproveClient: 'APPROVE_CLIENT',
  RejectClient: 'REJECT_CLIENT',
  ExitClient: 'EXIT_CLIENT',
  BlacklistClient: 'BLACKLIST_CLIENT',
  UndoClientStateChanged: 'UNDO_CLIENT_STATE_CHANGED',
  AnonymizeClient: 'ANONYMIZE_CLIENT',
  ManageClientAssociation: 'MANAGE_CLIENT_ASSOCIATION',
  ManageGroupAssociation: 'MANAGE_GROUP_ASSOCIATION',
  EditClientId: 'EDIT_CLIENT_ID',
  EditGroupId: 'EDIT_GROUP_ID',
  EditBlacklistedClientCfv: 'EDIT_BLACKLISTED_CLIENT_CFV',
  ViewAccountingReports: 'VIEW_ACCOUNTING_REPORTS',
  LogJournalEntries: 'LOG_JOURNAL_ENTRIES',
  BookingDateLoansGl: 'BOOKING_DATE_LOANS_GL',
  BookingDateSavingsGl: 'BOOKING_DATE_SAVINGS_GL',
  RectifyAdjustment: 'RECTIFY_ADJUSTMENT',
  ViewAccountingRates: 'VIEW_ACCOUNTING_RATES',
  CreateAccountingRates: 'CREATE_ACCOUNTING_RATES',
  ViewDocuments: 'VIEW_DOCUMENTS',
  CreateDocuments: 'CREATE_DOCUMENTS',
  EditDocuments: 'EDIT_DOCUMENTS',
  DeleteDocuments: 'DELETE_DOCUMENTS',
  ViewTask: 'VIEW_TASK',
  CreateTask: 'CREATE_TASK',
  EditTask: 'EDIT_TASK',
  DeleteTask: 'DELETE_TASK',
  ViewUserDetails: 'VIEW_USER_DETAILS',
  CreateUser: 'CREATE_USER',
  EditUser: 'EDIT_USER',
  DeleteUser: 'DELETE_USER',
  ViewRole: 'VIEW_ROLE',
  CreateRole: 'CREATE_ROLE',
  EditRole: 'EDIT_ROLE',
  DeleteRole: 'DELETE_ROLE',
  ResendFailedMessages: 'RESEND_FAILED_MESSAGES',
  SendManualSms: 'SEND_MANUAL_SMS',
  SendManualEmail: 'SEND_MANUAL_EMAIL',
  GetManageConfigurationAsCode: 'GET_MANAGE_CONFIGURATION_AS_CODE',
  PutManageConfigurationAsCode: 'PUT_MANAGE_CONFIGURATION_AS_CODE',
  ManageRiskLevels: 'MANAGE_RISK_LEVELS',
  ManageEodProcessing: 'MANAGE_EOD_PROCESSING',
  ManageCurrencies: 'MANAGE_CURRENCIES',
  ViewIntelligence: 'VIEW_INTELLIGENCE',
  CreateIndexRate: 'CREATE_INDEX_RATE',
  ViewComments: 'VIEW_COMMENTS',
  CreateComments: 'CREATE_COMMENTS',
  EditComments: 'EDIT_COMMENTS',
  ViewCommunicationHistory: 'VIEW_COMMUNICATION_HISTORY',
  DownloadBackups: 'DOWNLOAD_BACKUPS',
  ImportData: 'IMPORT_DATA',
  ViewTransactionChannels: 'VIEW_TRANSACTION_CHANNELS',
  CreateTransactionChannels: 'CREATE_TRANSACTION_CHANNELS',
  EditTransactionChannels: 'EDIT_TRANSACTION_CHANNELS',
  DeleteTransactionChannels: 'DELETE_TRANSACTION_CHANNELS',
  PostTransactionsWithoutOpenedTill: 'POST_TRANSACTIONS_WITHOUT_OPENED_TILL',
  ViewCustomField: 'VIEW_CUSTOM_FIELD',
  ViewBranchDetails: 'VIEW_BRANCH_DETAILS',
  CreateBranch: 'CREATE_BRANCH',
  EditBranch: 'EDIT_BRANCH',
  ViewCentreDetails: 'VIEW_CENTRE_DETAILS',
  CreateCentre: 'CREATE_CENTRE',
  EditCentre: 'EDIT_CENTRE',
  DeleteCentre: 'DELETE_CENTRE',
  ManageHolidays: 'MANAGE_HOLIDAYS',
  ManageIndexRates: 'MANAGE_INDEX_RATES',
  ManageEventsStreaming: 'MANAGE_EVENTS_STREAMING',
  ManageAuditTrail: 'MANAGE_AUDIT_TRAIL',
  ManagePayments: 'MANAGE_PAYMENTS',
  ManageCardsCapability: 'MANAGE_CARDS_CAPABILITY',
  CreateApiConsumersAndKeys: 'CREATE_API_CONSUMERS_AND_KEYS',
  DeleteApiConsumersAndKeys: 'DELETE_API_CONSUMERS_AND_KEYS',
  EditApiConsumersAndKeys: 'EDIT_API_CONSUMERS_AND_KEYS',
  ViewApiConsumersAndKeys: 'VIEW_API_CONSUMERS_AND_KEYS',
  ManageNotifications: 'MANAGE_NOTIFICATIONS',
  ViewMambuFunctions: 'VIEW_MAMBU_FUNCTIONS',
  CreateMambuFunctions: 'CREATE_MAMBU_FUNCTIONS',
  EditMambuFunctions: 'EDIT_MAMBU_FUNCTIONS',
  DeleteMambuFunctions: 'DELETE_MAMBU_FUNCTIONS',
  ViewMambuFunctionsSecrets: 'VIEW_MAMBU_FUNCTIONS_SECRETS',
  CreateMambuFunctionsSecrets: 'CREATE_MAMBU_FUNCTIONS_SECRETS',
  EditMambuFunctionsSecrets: 'EDIT_MAMBU_FUNCTIONS_SECRETS',
  DeleteMambuFunctionsSecrets: 'DELETE_MAMBU_FUNCTIONS_SECRETS',
  ViewProfitSharingProposals: 'VIEW_PROFIT_SHARING_PROPOSALS',
  CreateProfitSharingCashFlows: 'CREATE_PROFIT_SHARING_CASH_FLOWS',
  ViewProfitSharingCashFlows: 'VIEW_PROFIT_SHARING_CASH_FLOWS',
  EditProfitSharingCashFlows: 'EDIT_PROFIT_SHARING_CASH_FLOWS',
  DeleteProfitSharingCashFlows: 'DELETE_PROFIT_SHARING_CASH_FLOWS',
  CreateProfitSharingPools: 'CREATE_PROFIT_SHARING_POOLS',
  ViewProfitSharingPools: 'VIEW_PROFIT_SHARING_POOLS',
  EditProfitSharingPools: 'EDIT_PROFIT_SHARING_POOLS',
  DeleteProfitSharingPools: 'DELETE_PROFIT_SHARING_POOLS',
  CreateProfitSharingProductSettings: 'CREATE_PROFIT_SHARING_PRODUCT_SETTINGS',
  ViewProfitSharingProductSettings: 'VIEW_PROFIT_SHARING_PRODUCT_SETTINGS',
  EditProfitSharingProductSettings: 'EDIT_PROFIT_SHARING_PRODUCT_SETTINGS',
  DeleteProfitSharingProductSettings: 'DELETE_PROFIT_SHARING_PRODUCT_SETTINGS',
  CreateRateSheet: 'CREATE_RATE_SHEET',
  ViewRateSheet: 'VIEW_RATE_SHEET',
  CreateCreditAccount: 'CREATE_CREDIT_ACCOUNT',
} as const;

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