@apideck/node/dist/gen/models/HrisCompany.d.ts

Apideck Node.js SDK

/**
 * Apideck
 * The Apideck OpenAPI Spec: SDK Optimized
 *
 * The version of the OpenAPI document: 10.13.0
 * Contact: support@apideck.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { Address } from './Address';
import { Currency } from './Currency';
import { Email } from './Email';
import { PassThroughBody } from './PassThroughBody';
import { PhoneNumber } from './PhoneNumber';
import { Website } from './Website';
/**
 *
 * @export
 * @interface HrisCompany
 */
export interface HrisCompany {
    /**
     *
     * @type {string}
     * @memberof HrisCompany
     */
    legal_name: string | null;
    /**
     * A unique identifier for an object.
     * @type {string}
     * @memberof HrisCompany
     */
    readonly id?: string;
    /**
     *
     * @type {string}
     * @memberof HrisCompany
     */
    display_name?: string | null;
    /**
     *
     * @type {string}
     * @memberof HrisCompany
     */
    subdomain?: string | null;
    /**
     *
     * @type {string}
     * @memberof HrisCompany
     */
    status?: HrisCompanyStatus;
    /**
     * An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
     * @type {string}
     * @memberof HrisCompany
     */
    company_number?: string | null;
    /**
     *
     * @type {Currency}
     * @memberof HrisCompany
     */
    currency?: Currency | null;
    /**
     *
     * @type {Array<Address>}
     * @memberof HrisCompany
     */
    addresses?: Array<Address>;
    /**
     *
     * @type {Array<PhoneNumber>}
     * @memberof HrisCompany
     */
    phone_numbers?: Array<PhoneNumber>;
    /**
     *
     * @type {Array<Email>}
     * @memberof HrisCompany
     */
    emails?: Array<Email>;
    /**
     *
     * @type {Array<Website>}
     * @memberof HrisCompany
     */
    websites?: Array<Website>;
    /**
     *
     * @type {string}
     * @memberof HrisCompany
     */
    debtor_id?: string | null;
    /**
     * When custom mappings are configured on the resource, the result is included here.
     * @type {object}
     * @memberof HrisCompany
     */
    readonly custom_mappings?: object | null;
    /**
     *
     * @type {boolean}
     * @memberof HrisCompany
     */
    readonly deleted?: boolean;
    /**
     * The user who last updated the object.
     * @type {string}
     * @memberof HrisCompany
     */
    readonly updated_by?: string | null;
    /**
     * The user who created the object.
     * @type {string}
     * @memberof HrisCompany
     */
    readonly created_by?: string | null;
    /**
     * The date and time when the object was last updated.
     * @type {Date}
     * @memberof HrisCompany
     */
    readonly updated_at?: Date | null;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof HrisCompany
     */
    readonly created_at?: Date | null;
    /**
     *
     * @type {PassThroughBody}
     * @memberof HrisCompany
     */
    pass_through?: PassThroughBody;
}
/**
 * @export
 * @enum {string}
 */
export declare enum HrisCompanyStatus {
    active = "active",
    inactive = "inactive",
    trial = "trial",
    other = "other"
}
export declare function HrisCompanyFromJSON(json: any): HrisCompany;
export declare function HrisCompanyFromJSONTyped(json: any, ignoreDiscriminator: boolean): HrisCompany;
export declare function HrisCompanyToJSON(value?: HrisCompany | null): any;