@paciolan/cybersource-sdk/dist/models/boardingv1registrations-organization-information.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { Boardingv1registrationsOrganizationInformationBusinessInformation } from './boardingv1registrations-organization-information-business-information';
import { Boardingv1registrationsOrganizationInformationKYC } from './boardingv1registrations-organization-information-kyc';
import { Boardingv1registrationsOrganizationInformationOwners } from './boardingv1registrations-organization-information-owners';
/**
 *
 * @export
 * @interface Boardingv1registrationsOrganizationInformation
 */
export interface Boardingv1registrationsOrganizationInformation {
    /**
     *
     * @type {string}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    organizationId?: string;
    /**
     * This field is required for Organization Types: MERCHANT, TRANSACTING
     * @type {string}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    parentOrganizationId?: string;
    /**
     *
     * @type {Array<string>}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    childOrganizations?: Array<string>;
    /**
     * Determines the type of organization in the hirarchy that this registration will use to onboard this Organization Possible Values:   - 'TRANSACTING'   - 'STRUCTURAL'   - 'MERCHANT'
     * @type {string}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    type?: Boardingv1registrationsOrganizationInformationTypeEnum;
    /**
     * Determines the status that the organization will be after being onboarded Possible Values:             - 'LIVE'             - 'TEST'             - 'DRAFT'
     * @type {string}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    status?: Boardingv1registrationsOrganizationInformationStatusEnum;
    /**
     * This denotes the one organization, with exception to the TRANSACTING types, that is allowed to be used for configuration purposes against products.  Eventually this field will be deprecated and all organizations will be allowed for product configuration.
     * @type {boolean}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    configurable?: boolean;
    /**
     *
     * @type {Boardingv1registrationsOrganizationInformationBusinessInformation}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    businessInformation: Boardingv1registrationsOrganizationInformationBusinessInformation;
    /**
     *
     * @type {Boardingv1registrationsOrganizationInformationKYC}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    KYC?: Boardingv1registrationsOrganizationInformationKYC;
    /**
     *
     * @type {Array<Boardingv1registrationsOrganizationInformationOwners>}
     * @memberof Boardingv1registrationsOrganizationInformation
     */
    owners?: Array<Boardingv1registrationsOrganizationInformationOwners>;
}
/**
    * @export
    * @enum {string}
    */
export declare enum Boardingv1registrationsOrganizationInformationTypeEnum {
    TRANSACTING = "TRANSACTING",
    STRUCTURAL = "STRUCTURAL",
    MERCHANT = "MERCHANT"
}
/**
    * @export
    * @enum {string}
    */
export declare enum Boardingv1registrationsOrganizationInformationStatusEnum {
    LIVE = "LIVE",
    TEST = "TEST",
    DRAFT = "DRAFT"
}