conekta/model/company-response.ts

OpenAPI client for conekta

/* tslint:disable */
/* eslint-disable */
/**
 * Conekta API
 * Conekta sdk
 *
 * The version of the OpenAPI document: 2.2.0
 * Contact: engineering@conekta.com
 *
 * 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 { CompanyResponseDocumentsInner } from './company-response-documents-inner';

/**
 * 
 * @export
 * @interface CompanyResponse
 */
export interface CompanyResponse {
    /**
     * The unique identifier for the company.
     * @type {string}
     * @memberof CompanyResponse
     */
    'id': string;
    /**
     * The name of the company.
     * @type {string}
     * @memberof CompanyResponse
     */
    'name': string;
    /**
     * Indicates if the company is active.
     * @type {boolean}
     * @memberof CompanyResponse
     */
    'active': boolean;
    /**
     * The current status of the company\'s account.
     * @type {string}
     * @memberof CompanyResponse
     */
    'account_status': string;
    /**
     * The identifier of the parent company, if any.
     * @type {string}
     * @memberof CompanyResponse
     */
    'parent_company_id'?: string | null;
    /**
     * The current status of the company\'s onboarding process.
     * @type {string}
     * @memberof CompanyResponse
     */
    'onboarding_status': string;
    /**
     * A list of documents related to the company.
     * @type {Array<CompanyResponseDocumentsInner>}
     * @memberof CompanyResponse
     */
    'documents': Array<CompanyResponseDocumentsInner>;
    /**
     * Timestamp of when the company was created.
     * @type {number}
     * @memberof CompanyResponse
     */
    'created_at': number;
    /**
     * The type of object, typically \"company\".
     * @type {string}
     * @memberof CompanyResponse
     */
    'object': string;
    /**
     * Indicates if 3DS authentication is enabled for the company.
     * @type {boolean}
     * @memberof CompanyResponse
     */
    'three_ds_enabled'?: boolean;
    /**
     * The 3DS mode for the company, either \'smart\' or \'strict\'. This property is only applicable when three_ds_enabled is true. When three_ds_enabled is false, this field will be null.
     * @type {string}
     * @memberof CompanyResponse
     */
    'three_ds_mode'?: CompanyResponseThreeDsModeEnum | null;
}

export const CompanyResponseThreeDsModeEnum = {
    smart: 'smart',
    strict: 'strict'
} as const;

export type CompanyResponseThreeDsModeEnum = typeof CompanyResponseThreeDsModeEnum[keyof typeof CompanyResponseThreeDsModeEnum];