company.ts

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as HRISAPI from '../hris/hris';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';

export class Company extends APIResource {
  /**
   * Update a sandbox company's data
   *
   * @example
   * ```ts
   * const company = await client.sandbox.company.update({
   *   accounts: [{}],
   *   departments: [{}],
   *   ein: 'ein',
   *   entity: {},
   *   legal_name: 'legal_name',
   *   locations: [
   *     {
   *       city: 'city',
   *       country: 'country',
   *       line1: 'line1',
   *       line2: 'line2',
   *       postal_code: 'postal_code',
   *       state: 'state',
   *     },
   *   ],
   *   primary_email: 'dev@stainless.com',
   *   primary_phone_number: 'primary_phone_number',
   * });
   * ```
   */
  update(body: CompanyUpdateParams, options?: RequestOptions): APIPromise<CompanyUpdateResponse> {
    return this._client.put('/sandbox/company', { body, ...options, __security: { bearerAuth: true } });
  }
}

export interface CompanyUpdateResponse {
  /**
   * An array of bank account objects associated with the payroll/HRIS system.
   */
  accounts: Array<CompanyUpdateResponse.Account> | null;

  /**
   * The array of company departments.
   */
  departments: Array<CompanyUpdateResponse.Department | null> | null;

  /**
   * The employer identification number.
   */
  ein: string | null;

  /**
   * The entity type object.
   */
  entity: CompanyUpdateResponse.Entity | null;

  /**
   * The legal name of the company.
   */
  legal_name: string | null;

  locations: Array<HRISAPI.Location | null> | null;

  /**
   * The email of the main administrator on the account.
   */
  primary_email: string | null;

  /**
   * The phone number of the main administrator on the account. Format: E.164, with
   * extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
   */
  primary_phone_number: string | null;
}

export namespace CompanyUpdateResponse {
  export interface Account {
    /**
     * The name of the bank associated in the payroll/HRIS system.
     */
    account_name?: string | null;

    /**
     * 10-12 digit number to specify the bank account
     */
    account_number?: string | null;

    /**
     * The type of bank account.
     */
    account_type?: 'checking' | 'savings' | null;

    /**
     * Name of the banking institution.
     */
    institution_name?: string | null;

    /**
     * A nine-digit code that's based on the U.S. Bank location where your account was
     * opened.
     */
    routing_number?: string | null;
  }

  export interface Department {
    /**
     * The department name.
     */
    name?: string | null;

    /**
     * The parent department, if present.
     */
    parent?: Department.Parent | null;
  }

  export namespace Department {
    /**
     * The parent department, if present.
     */
    export interface Parent {
      /**
       * The parent department's name.
       */
      name?: string | null;
    }
  }

  /**
   * The entity type object.
   */
  export interface Entity {
    /**
     * The tax payer subtype of the company.
     */
    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;

    /**
     * The tax payer type of the company.
     */
    type?:
      | 'llc'
      | 'lp'
      | 'corporation'
      | 'sole_proprietor'
      | 'non_profit'
      | 'partnership'
      | 'cooperative'
      | null;
  }
}

export interface CompanyUpdateParams {
  /**
   * An array of bank account objects associated with the payroll/HRIS system.
   */
  accounts: Array<CompanyUpdateParams.Account> | null;

  /**
   * The array of company departments.
   */
  departments: Array<CompanyUpdateParams.Department | null> | null;

  /**
   * The employer identification number.
   */
  ein: string | null;

  /**
   * The entity type object.
   */
  entity: CompanyUpdateParams.Entity | null;

  /**
   * The legal name of the company.
   */
  legal_name: string | null;

  locations: Array<HRISAPI.Location | null> | null;

  /**
   * The email of the main administrator on the account.
   */
  primary_email: string | null;

  /**
   * The phone number of the main administrator on the account. Format: E.164, with
   * extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
   */
  primary_phone_number: string | null;
}

export namespace CompanyUpdateParams {
  export interface Account {
    /**
     * The name of the bank associated in the payroll/HRIS system.
     */
    account_name?: string | null;

    /**
     * 10-12 digit number to specify the bank account
     */
    account_number?: string | null;

    /**
     * The type of bank account.
     */
    account_type?: 'checking' | 'savings' | null;

    /**
     * Name of the banking institution.
     */
    institution_name?: string | null;

    /**
     * A nine-digit code that's based on the U.S. Bank location where your account was
     * opened.
     */
    routing_number?: string | null;
  }

  export interface Department {
    /**
     * The department name.
     */
    name?: string | null;

    /**
     * The parent department, if present.
     */
    parent?: Department.Parent | null;
  }

  export namespace Department {
    /**
     * The parent department, if present.
     */
    export interface Parent {
      /**
       * The parent department's name.
       */
      name?: string | null;
    }
  }

  /**
   * The entity type object.
   */
  export interface Entity {
    /**
     * The tax payer subtype of the company.
     */
    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;

    /**
     * The tax payer type of the company.
     */
    type?:
      | 'llc'
      | 'lp'
      | 'corporation'
      | 'sole_proprietor'
      | 'non_profit'
      | 'partnership'
      | 'cooperative'
      | null;
  }
}

export declare namespace Company {
  export {
    type CompanyUpdateResponse as CompanyUpdateResponse,
    type CompanyUpdateParams as CompanyUpdateParams,
  };
}