Skip to main content

API

This section describes the API of the ui-user-kit library.

Interfaces​

PrivacyPolicy​

interface PrivacyPolicy {
  version?: string;
  url?: string;
  release_date?: string;
  text?: string;
  download_link?: string;
}

CheckingAccount​

interface CheckingAccount {
  pk?: string;
  account_type?: number;
  bank_account_balance?: number;
  bank_account_current_balance?: number;
  bank_account_digit?: string;
  bank_account?: string;
  bank_branch?: string;
  bank_id?: BANK;
  company_pk?: string;
  company_related_pk?: string;
  covenant_number?: string;
  description?: string;
  is_active?: boolean;
  is_last_statement_conciliated?: boolean;
  is_released?: boolean;
  landmark_date?: string;
  last_statement_at?: string;
  last_statement_balance?: string;
  last_statement_url?: string;
  name?: string;
  overdraft_value?: string;
  pixs?: Pix[];
}

Company​

interface Company {
  pk: string;
  address: Address;
  current_balance: number;
  economic_group: {
    pk: string;
    name: string;
    is_testing: boolean;
    is_active: boolean;
  };
  fantasy_name: string;
  identity: {
    identity_type: IDENTITY_TYPE;
    number: number;
  };
  is_active: boolean;
  municipal_registration: string;
  official_name: string;
  service_codes: string[];
  tax_regime: TAX_REGIME;
  cnae_codes?: string[];
  established_at?: string;
  legal_representative?:
    | string
    | {
        pk: string;
        first_name: string;
        last_name: string;
      };
  mailing_options?: MailingOption[];
  main_cnae_code?: string;
  notes?: string;
  onboarding_end_at?: string;
  onboarding_start_at?: string;
  ongoing_end_at?: string;
  ongoing_start_at?: string;
  setup_end_at?: string;
  setup_start_at?: string;
}

KeyChain​

interface Keychain<RequestType extends 'simple' | 'complex' = undefined> {
  aux_text?: string;
  first_aux_text?: string;
  is_active?: boolean;
  pk?: string;
  second_aux_text?: string;
  service_name?: KEYCHAINS;
  status?: number;
  third_aux_text?: string;
  certification_url?: string;
  expires_at?: string;
  password?: string;
  token?: string;
  username?: string;
  main_checking_account?: string;
  automatic_transfer_checking_account?: string;
  credit_card_checking_account?: string;
  bill_checking_account?: string;
  cash_checking_account?: string;
  documents?: (RequestType extends undefined ? KeychainDocumentFieldType[keyof KeychainDocumentFieldType] : KeychainDocumentFieldType[RequestType])[];
  keychain_error_message?: string;
}

LayoutData​

interface LayoutData {
  title?: string;
  companyName?: string;
}

TwoFactorStatusModalData​

interface TwoFactorStatusModalData {
  activate: {
    titleText: string;
    bodyText: string;
    confirmationText: string;
  };
  deactivate: {
    titleText: string;
    bodyText: string;
    confirmationText: string;
  };
}

UserDataFormInput​

interface UserDataFormInput {
  label: string;
  control: string;
  placeholder?: string;
  required?: boolean;
  specialInput?: boolean;
  mask?: any;
  readOnly?: boolean;
  validator?: (control: AbstractControl) => Record<string, any> | null;
}

RadioListControllers​

interface RadioListControllers {
  name: string;
  label: string;
  value: string;
}

EconomicGroup​

interface EconomicGroup {
  companies?: (Company & {
    active_keychains: number[];
  })[];
  is_active?: boolean;
  is_testing?: boolean;
  in_cancellation_process?: boolean;
  max_accounts?: number;
  max_companies?: number;
  name?: string;
  pk?: string;
  plan?: ACCOUNT_PLAN;
  stage?: ACCOUNT_STEP;
  setup_stage?: number;
  created_at?: string;
  registered_accounts?: number;
  csm_user?: string;
  csa_user?: string;
  cs_ops_user?: string;
  team?: {
    pk?: string;
    name?: string;
    group_type?: number;
  };
  days_after_last_classification?: number;
  poc?: PILOT;
}

TourButton​

interface TourButton {
  arrowDirection: string;
  icon: string;
  step?: TEST_STEP;
}

Notification​

interface Notification {
  pk: string;
  title: string;
  list_message: string;
  is_read: boolean;
  created_at: string;
  slug: NOTIFICATION_SLUG;
  query_params: string;
  emission_setup: {
    name: string;
  };
}

Enums​

DASHBOARD_ACTIONS​

declare enum DASHBOARD_ACTIONS {
  importOfx = 0,
  createRecordFromDocument = 1,
  createCharge = 2,
  createRecord = 3,
  createTransfer = 4,
  paymentAuthorization = 5
}

Types​

OnboardingTaskTypes​

type OnboardingTaskTypes = 'task' | 'video' | 'article';