@rippling/rippling-sdk 0.2.0-alpha.36 → 0.2.0-alpha.37

package/src/resources/company-legal-entities.ts

@@ -0,0 +1,237 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Legal entities registered by the company
+ */
+export class CompanyLegalEntities extends APIResource {
+  /**
+   * A list of company legal entities.
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `country_code`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: CompanyLegalEntityListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompanyLegalEntityListResponsesPageCursorURL, CompanyLegalEntityListResponse> {
+    return this._client.getAPIList(
+      '/company-legal-entities/',
+      PageCursorURL<CompanyLegalEntityListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieve a specific company legal entity
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CompanyLegalEntityRetrieveResponse> {
+    return this._client.get(path`/company-legal-entities/${id}/`, options);
+  }
+}
+
+export type CompanyLegalEntityListResponsesPageCursorURL = PageCursorURL<CompanyLegalEntityListResponse>;
+
+export interface CompanyLegalEntityListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The company associated with this entity relationship.
+   */
+  company_id?: string;
+
+  /**
+   * The ISO country code for the entity.
+   */
+  country_code?: string;
+
+  /**
+   * The entity's level in a hierarchy. _ `PARENT`: The legal entity is considered
+   * the ultimate holding entity. _ `SUBSIDIARY`: The legal entity is considered a
+   * subsidiary, fully or partially held by another. \* `BRANCH`: The legal entity is
+   * considered a branch, associated with a parent legal entity.
+   */
+  entity_level?: 'PARENT' | 'SUBSIDIARY' | 'BRANCH';
+
+  /**
+   * True if this entity relationship has been archived.
+   */
+  is_archived?: boolean;
+
+  /**
+   * True if this entity is managed as a Contractor of Record.
+   */
+  is_cor?: boolean;
+
+  /**
+   * True if this entity is managed as an Employer of Record.
+   */
+  is_eor?: boolean;
+
+  /**
+   * True if this entity is managed as a Professional Employment Organization.
+   */
+  is_peo?: boolean;
+
+  /**
+   * The legal name of the entity.
+   */
+  legal_name?: string;
+
+  /**
+   * The mailing address of the entity.
+   */
+  mailing_address?: Shared.Address;
+
+  /**
+   * The entity management type. _ `EOR`: The entity is managed as an Employer of
+   * Record. _ `COR`: The entity is managed as a Contractor of Record. _ `PEO`: The
+   * entity is managed as a Professional Employment Organization. _ `null`: The
+   * entity is a direct hire with no managed employment type.
+   */
+  management_type?: 'PEO' | 'EOR' | 'COR';
+
+  /**
+   * The physical address of the entity, if it differs from the mailing address.
+   */
+  physical_address?: Shared.Address;
+
+  /**
+   * The registration date of the entity.
+   */
+  registration_date?: string;
+
+  /**
+   * The tax identifier for this entity.
+   */
+  tax_identifier?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CompanyLegalEntityRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The company associated with this entity relationship.
+   */
+  company_id?: string;
+
+  /**
+   * The ISO country code for the entity.
+   */
+  country_code?: string;
+
+  /**
+   * The entity's level in a hierarchy. _ `PARENT`: The legal entity is considered
+   * the ultimate holding entity. _ `SUBSIDIARY`: The legal entity is considered a
+   * subsidiary, fully or partially held by another. \* `BRANCH`: The legal entity is
+   * considered a branch, associated with a parent legal entity.
+   */
+  entity_level?: 'PARENT' | 'SUBSIDIARY' | 'BRANCH';
+
+  /**
+   * True if this entity relationship has been archived.
+   */
+  is_archived?: boolean;
+
+  /**
+   * True if this entity is managed as a Contractor of Record.
+   */
+  is_cor?: boolean;
+
+  /**
+   * True if this entity is managed as an Employer of Record.
+   */
+  is_eor?: boolean;
+
+  /**
+   * True if this entity is managed as a Professional Employment Organization.
+   */
+  is_peo?: boolean;
+
+  /**
+   * The legal name of the entity.
+   */
+  legal_name?: string;
+
+  /**
+   * The mailing address of the entity.
+   */
+  mailing_address?: Shared.Address;
+
+  /**
+   * The entity management type. _ `EOR`: The entity is managed as an Employer of
+   * Record. _ `COR`: The entity is managed as a Contractor of Record. _ `PEO`: The
+   * entity is managed as a Professional Employment Organization. _ `null`: The
+   * entity is a direct hire with no managed employment type.
+   */
+  management_type?: 'PEO' | 'EOR' | 'COR';
+
+  /**
+   * The physical address of the entity, if it differs from the mailing address.
+   */
+  physical_address?: Shared.Address;
+
+  /**
+   * The registration date of the entity.
+   */
+  registration_date?: string;
+
+  /**
+   * The tax identifier for this entity.
+   */
+  tax_identifier?: string;
+}
+
+export interface CompanyLegalEntityListParams {
+  cursor?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export declare namespace CompanyLegalEntities {
+  export {
+    type CompanyLegalEntityListResponse as CompanyLegalEntityListResponse,
+    type CompanyLegalEntityRetrieveResponse as CompanyLegalEntityRetrieveResponse,
+    type CompanyLegalEntityListResponsesPageCursorURL as CompanyLegalEntityListResponsesPageCursorURL,
+    type CompanyLegalEntityListParams as CompanyLegalEntityListParams,
+  };
+}

package/src/resources/earning-types.ts

@@ -11,7 +11,7 @@ export class EarningTypes extends APIResource {
   /**
    * A list of earning-types.
    *
-   * - Requires: `Payroll API`
+   * - Requires: `Global Payroll`
    */
   list(
     options?: RequestOptions,
@@ -34,12 +34,6 @@ export interface EarningTypeListResponse {
    */
   id?: string;
 
-  /**
-   * Company entity relationship identifier (CER ID) linking the earning type to the
-   * HRIS legal entity.
-   */
-  company_entity_id?: string;
-
   /**
    * ISO country code where the earning type applies.
    */

package/src/resources/earnings-inputs.ts

@@ -14,7 +14,7 @@ export class EarningsInputs extends APIResource {
   /**
    * A list of earnings-inputs.
    *
-   * - Requires: `Payroll API`
+   * - Requires: `Global Payroll`
    */
   list(
     options?: RequestOptions,

package/src/resources/index.ts

@@ -33,6 +33,13 @@ export {
   type CandidateListResponsesPageCursorURL,
 } from './candidates';
 export { Companies, type Company, type CompanyListParams, type CompaniesPageCursorURL } from './companies';
+export {
+  CompanyLegalEntities,
+  type CompanyLegalEntityListResponse,
+  type CompanyLegalEntityRetrieveResponse,
+  type CompanyLegalEntityListParams,
+  type CompanyLegalEntityListResponsesPageCursorURL,
+} from './company-legal-entities';
 export {
   CompanyLegalEntityWorkers,
   type CompanyLegalEntityWorkerListResponse,
@@ -315,7 +322,7 @@ export {
   type PayrollRunRetrieveResponse,
   type PayrollRunListParams,
   type PayrollRunListResponsesPageCursorURL,
-} from './payroll-runs';
+} from './payroll-runs/payroll-runs';
 export {
   PlatformCapabilities,
   type PlatformCapabilityListResponse,

package/src/resources/legal-entities.ts

@@ -98,7 +98,7 @@ export interface LegalEntity {
    * considered a Professional Employment Organization (PEO). _ `EOR`: The legal
    * entity is considered an Employer of Record (EOR).
    */
-  management_type?: 'PEO' | 'EOR';
+  management_type?: 'PEO' | 'EOR' | 'COR';
 
   parent?: unknown;
 

package/src/resources/payroll-runs/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  PayrollRuns,
+  type PayrollRunListResponse,
+  type PayrollRunRetrieveResponse,
+  type PayrollRunListParams,
+  type PayrollRunListResponsesPageCursorURL,
+} from './payroll-runs';
+export {
+  WorkerPayrollRecords,
+  type WorkerPayrollRecordListResponse,
+  type WorkerPayrollRecordListParams,
+  type WorkerPayrollRecordListResponsesPageCursorURL,
+} from './worker-payroll-records';

package/src/resources/payroll-runs/payroll-runs.ts

@@ -0,0 +1,270 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BusinessPartnersAPI from '../business-partners';
+import * as WorkerPayrollRecordsAPI from './worker-payroll-records';
+import {
+  WorkerPayrollRecordListParams,
+  WorkerPayrollRecordListResponse,
+  WorkerPayrollRecordListResponsesPageCursorURL,
+  WorkerPayrollRecords,
+} from './worker-payroll-records';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Payroll runs for the company
+ */
+export class PayrollRuns extends APIResource {
+  workerPayrollRecords: WorkerPayrollRecordsAPI.WorkerPayrollRecords =
+    new WorkerPayrollRecordsAPI.WorkerPayrollRecords(this._client);
+
+  /**
+   * A list of payroll-runs.
+   *
+   * - Requires: `Global Payroll`
+   * - Sortable fields: `check_date`
+   */
+  list(
+    query: PayrollRunListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse> {
+    return this._client.getAPIList('/payroll-runs/', PageCursorURL<PayrollRunListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific payroll-run
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse> {
+    return this._client.get(path`/payroll-runs/${id}/`, options);
+  }
+}
+
+export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
+
+/**
+ * V2 DTO representing a single payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/      (list)
+ *       - GET /payroll-runs/{id}  (retrieve)
+ */
+export interface PayrollRunListResponse {
+  /**
+   * Unique identifier for the payroll run.
+   */
+  id?: string;
+
+  /**
+   * Deadline for approving the payroll run.
+   */
+  approval_deadline?: string;
+
+  /**
+   * Timestamp when the run was approved.
+   */
+  approved_at?: string;
+
+  /**
+   * Date the paycheck is issued.
+   */
+  check_date?: string;
+
+  /**
+   * Identifier linking this payroll run to the company's legal entity in the HRIS
+   * system.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the payroll run applies.
+   */
+  country_code?: string;
+
+  /**
+   * Date funds are debited from the company's account.
+   */
+  debit_date?: string;
+
+  /**
+   * Deadline after which the run is locked for changes.
+   */
+  lock_deadline?: string;
+
+  /**
+   * Timestamp when the run was marked as paid.
+   */
+  paid_at?: string;
+
+  /**
+   * Pay period details for this run.
+   */
+  pay_period?: PayrollRunListResponse.PayPeriod;
+
+  /**
+   * Payment method used (e.g. WIRE, ACH).
+   */
+  payment_type?: string;
+
+  /**
+   * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+   */
+  run_state?: string;
+
+  /**
+   * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+   */
+  run_type?: string;
+
+  /**
+   * Human-readable title of the payroll run.
+   */
+  title?: string;
+}
+
+export namespace PayrollRunListResponse {
+  /**
+   * Pay period details for this run.
+   */
+  export interface PayPeriod {
+    /**
+     * End date of the pay period.
+     */
+    end_date?: string;
+
+    /**
+     * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+     */
+    pay_frequency?: string;
+
+    /**
+     * Start date of the pay period.
+     */
+    start_date?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Unique identifier for the payroll run.
+   */
+  id?: string;
+
+  /**
+   * Deadline for approving the payroll run.
+   */
+  approval_deadline?: string;
+
+  /**
+   * Timestamp when the run was approved.
+   */
+  approved_at?: string;
+
+  /**
+   * Date the paycheck is issued.
+   */
+  check_date?: string;
+
+  /**
+   * Identifier linking this payroll run to the company's legal entity in the HRIS
+   * system.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the payroll run applies.
+   */
+  country_code?: string;
+
+  /**
+   * Date funds are debited from the company's account.
+   */
+  debit_date?: string;
+
+  /**
+   * Deadline after which the run is locked for changes.
+   */
+  lock_deadline?: string;
+
+  /**
+   * Timestamp when the run was marked as paid.
+   */
+  paid_at?: string;
+
+  /**
+   * Pay period details for this run.
+   */
+  pay_period?: PayrollRunRetrieveResponse.PayPeriod;
+
+  /**
+   * Payment method used (e.g. WIRE, ACH).
+   */
+  payment_type?: string;
+
+  /**
+   * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+   */
+  run_state?: string;
+
+  /**
+   * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+   */
+  run_type?: string;
+
+  /**
+   * Human-readable title of the payroll run.
+   */
+  title?: string;
+}
+
+export namespace PayrollRunRetrieveResponse {
+  /**
+   * Pay period details for this run.
+   */
+  export interface PayPeriod {
+    /**
+     * End date of the pay period.
+     */
+    end_date?: string;
+
+    /**
+     * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+     */
+    pay_frequency?: string;
+
+    /**
+     * Start date of the pay period.
+     */
+    start_date?: string;
+  }
+}
+
+export interface PayrollRunListParams {
+  order_by?: string;
+}
+
+PayrollRuns.WorkerPayrollRecords = WorkerPayrollRecords;
+
+export declare namespace PayrollRuns {
+  export {
+    type PayrollRunListResponse as PayrollRunListResponse,
+    type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse,
+    type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL,
+    type PayrollRunListParams as PayrollRunListParams,
+  };
+
+  export {
+    WorkerPayrollRecords as WorkerPayrollRecords,
+    type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse,
+    type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL,
+    type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams,
+  };
+}