@tryfinch/finch-api 6.31.0 → 8.0.0

package/src/resources/hris/pay-statements.ts

@@ -1,11 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-import * as Shared from "../shared.js";
-import * as HRISAPI from "./hris.js";
-import * as BenefitsAPI from "./benefits/benefits.js";
-import { ResponsesPage } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import * as HRISAPI from './hris';
+import * as BenefitsAPI from './benefits/benefits';
+import { PagePromise, ResponsesPage } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class PayStatements extends APIResource {
   /**
@@ -31,10 +30,12 @@ export class PayStatements extends APIResource {
    * ```
    */
   retrieveMany(
-    body: PayStatementRetrieveManyParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayStatementResponsesPage, PayStatementResponse> {
-    return this._client.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {
+    params: PayStatementRetrieveManyParams,
+    options?: RequestOptions,
+  ): PagePromise<PayStatementResponsesPage, PayStatementResponse> {
+    const { entity_ids, ...body } = params;
+    return this._client.getAPIList('/employer/pay-statement', ResponsesPage<PayStatementResponse>, {
+      query: { entity_ids },
       body,
       method: 'post',
       ...options,
@@ -42,49 +43,49 @@ export class PayStatements extends APIResource {
   }
 }
 
-export class PayStatementResponsesPage extends ResponsesPage<PayStatementResponse> {}
+export type PayStatementResponsesPage = ResponsesPage<PayStatementResponse>;
 
 export interface PayStatement {
   /**
    * The array of earnings objects associated with this pay statement
    */
-  earnings?: Array<PayStatement.Earning | null> | null;
+  earnings: Array<PayStatement.Earning | null> | null;
 
   /**
    * The array of deductions objects associated with this pay statement.
    */
-  employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
+  employee_deductions: Array<PayStatement.EmployeeDeduction> | null;
 
-  employer_contributions?: Array<PayStatement.EmployerContribution | null> | null;
+  employer_contributions: Array<PayStatement.EmployerContribution> | null;
 
-  gross_pay?: HRISAPI.Money | null;
+  gross_pay: HRISAPI.Money | null;
 
   /**
    * A stable Finch `id` (UUID v4) for an individual in the company
    */
-  individual_id?: string;
+  individual_id: string;
 
-  net_pay?: HRISAPI.Money | null;
+  net_pay: HRISAPI.Money | null;
 
   /**
    * The payment method.
    */
-  payment_method?: 'check' | 'direct_deposit' | 'other' | null;
+  payment_method: 'check' | 'direct_deposit' | 'other' | null;
 
   /**
    * The array of taxes objects associated with this pay statement.
    */
-  taxes?: Array<PayStatement.Tax | null> | null;
+  taxes: Array<PayStatement.Tax> | null;
 
   /**
    * The number of hours worked for this pay period
    */
-  total_hours?: number | null;
+  total_hours: number | null;
 
   /**
    * The type of the payment associated with the pay statement.
    */
-  type?: 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | null;
+  type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll' | null;
 }
 
 export namespace PayStatement {
@@ -92,30 +93,28 @@ export namespace PayStatement {
     /**
      * The earnings amount in cents.
      */
-    amount?: number | null;
-
-    attributes?: Earning.Attributes | null;
+    amount: number | null;
 
     /**
      * The earnings currency code.
      */
-    currency?: string | null;
+    currency: string | null;
 
     /**
      * The number of hours associated with this earning. (For salaried employees, this
      * could be hours per pay period, `0` or `null`, depending on the provider).
      */
-    hours?: number | null;
+    hours: number | null;
 
     /**
      * The exact name of the deduction from the pay statement.
      */
-    name?: string | null;
+    name: string | null;
 
     /**
      * The type of earning.
      */
-    type?:
+    type:
       | 'salary'
       | 'wage'
       | 'reimbursement'
@@ -130,22 +129,18 @@ export namespace PayStatement {
       | '1099'
       | 'other'
       | null;
+
+    attributes?: Earning.Attributes | null;
   }
 
   export namespace Earning {
     export interface Attributes {
-      metadata?: Attributes.Metadata;
-    }
-
-    export namespace Attributes {
-      export interface Metadata {
-        /**
-         * The metadata to be attached to the entity by existing rules. It is a key-value
-         * pairs where the values can be of any type (string, number, boolean, object,
-         * array, etc.).
-         */
-        metadata?: Record<string, unknown>;
-      }
+      /**
+       * The metadata to be attached to the entity by existing rules. It is a key-value
+       * pairs where the values can be of any type (string, number, boolean, object,
+       * array, etc.).
+       */
+      metadata: { [key: string]: unknown };
     }
   }
 
@@ -153,158 +148,178 @@ export namespace PayStatement {
     /**
      * The deduction amount in cents.
      */
-    amount?: number | null;
-
-    attributes?: EmployeeDeduction.Attributes | null;
+    amount: number | null;
 
     /**
      * The deduction currency.
      */
-    currency?: string | null;
+    currency: string | null;
 
     /**
      * The deduction name from the pay statement.
      */
-    name?: string | null;
+    name: string | null;
 
     /**
      * Boolean indicating if the deduction is pre-tax.
      */
-    pre_tax?: boolean | null;
+    pre_tax: boolean | null;
 
     /**
      * Type of benefit.
      */
-    type?: BenefitsAPI.BenefitType | null;
+    type: BenefitsAPI.BenefitType | null;
+
+    attributes?: EmployeeDeduction.Attributes | null;
   }
 
   export namespace EmployeeDeduction {
     export interface Attributes {
-      metadata?: Attributes.Metadata;
-    }
-
-    export namespace Attributes {
-      export interface Metadata {
-        /**
-         * The metadata to be attached to the entity by existing rules. It is a key-value
-         * pairs where the values can be of any type (string, number, boolean, object,
-         * array, etc.).
-         */
-        metadata?: Record<string, unknown>;
-      }
+      /**
+       * The metadata to be attached to the entity by existing rules. It is a key-value
+       * pairs where the values can be of any type (string, number, boolean, object,
+       * array, etc.).
+       */
+      metadata: { [key: string]: unknown };
     }
   }
 
   export interface EmployerContribution {
-    /**
-     * The contribution amount in cents.
-     */
-    amount?: number | null;
-
-    attributes?: EmployerContribution.Attributes | null;
-
     /**
      * The contribution currency.
      */
-    currency?: string | null;
+    currency: string | null;
 
     /**
      * The contribution name from the pay statement.
      */
-    name?: string | null;
+    name: string | null;
 
     /**
      * Type of benefit.
      */
-    type?: BenefitsAPI.BenefitType | null;
+    type: BenefitsAPI.BenefitType | null;
+
+    /**
+     * The contribution amount in cents.
+     */
+    amount?: number | null;
+
+    attributes?: EmployerContribution.Attributes | null;
   }
 
   export namespace EmployerContribution {
     export interface Attributes {
-      metadata?: Attributes.Metadata;
-    }
-
-    export namespace Attributes {
-      export interface Metadata {
-        /**
-         * The metadata to be attached to the entity by existing rules. It is a key-value
-         * pairs where the values can be of any type (string, number, boolean, object,
-         * array, etc.).
-         */
-        metadata?: Record<string, unknown>;
-      }
+      /**
+       * The metadata to be attached to the entity by existing rules. It is a key-value
+       * pairs where the values can be of any type (string, number, boolean, object,
+       * array, etc.).
+       */
+      metadata: { [key: string]: unknown };
     }
   }
 
   export interface Tax {
-    /**
-     * The tax amount in cents.
-     */
-    amount?: number | null;
-
-    attributes?: Tax.Attributes | null;
-
     /**
      * The currency code.
      */
-    currency?: string | null;
+    currency: string | null;
 
     /**
      * `true` if the amount is paid by the employers.
      */
-    employer?: boolean | null;
+    employer: boolean | null;
 
     /**
      * The exact name of tax from the pay statement.
      */
-    name?: string | null;
+    name: string | null;
 
     /**
      * The type of taxes.
      */
-    type?: 'state' | 'federal' | 'local' | 'fica' | null;
+    type: 'state' | 'federal' | 'local' | 'fica' | null;
+
+    /**
+     * The tax amount in cents.
+     */
+    amount?: number | null;
+
+    attributes?: Tax.Attributes | null;
   }
 
   export namespace Tax {
     export interface Attributes {
-      metadata?: Attributes.Metadata;
-    }
-
-    export namespace Attributes {
-      export interface Metadata {
-        /**
-         * The metadata to be attached to the entity by existing rules. It is a key-value
-         * pairs where the values can be of any type (string, number, boolean, object,
-         * array, etc.).
-         */
-        metadata?: Record<string, unknown>;
-      }
+      /**
+       * The metadata to be attached to the entity by existing rules. It is a key-value
+       * pairs where the values can be of any type (string, number, boolean, object,
+       * array, etc.).
+       */
+      metadata: { [key: string]: unknown };
     }
   }
 }
 
+export interface PayStatementDataSyncInProgress {
+  code: 202;
+
+  finch_code: 'data_sync_in_progress';
+
+  message: 'The pay statements for this payment are being fetched. Please check back later.';
+
+  name: 'accepted';
+}
+
 export interface PayStatementResponse {
-  body?: PayStatementResponseBody;
+  body: PayStatementResponseBody | PayStatementResponse.BatchError | PayStatementDataSyncInProgress;
 
-  code?: number;
+  code: number;
 
-  payment_id?: string;
+  payment_id: string;
+}
+
+export namespace PayStatementResponse {
+  export interface BatchError {
+    code: number;
+
+    message: string;
+
+    name: string;
+
+    finch_code?: string;
+  }
 }
 
 export interface PayStatementResponseBody {
-  paging?: Shared.Paging;
+  paging: PayStatementResponseBody.Paging;
 
-  /**
-   * The array of pay statements for the current payment.
-   */
-  pay_statements?: Array<PayStatement>;
+  pay_statements: Array<PayStatement>;
+}
+
+export namespace PayStatementResponseBody {
+  export interface Paging {
+    /**
+     * The current start index of the returned list of elements
+     */
+    offset: number;
+
+    /**
+     * The total number of elements for the entire query (not just the given page)
+     */
+    count?: number;
+  }
 }
 
 export interface PayStatementRetrieveManyParams {
   /**
-   * The array of batch requests.
+   * Body param: The array of batch requests.
    */
   requests: Array<PayStatementRetrieveManyParams.Request>;
+
+  /**
+   * Query param: The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
 }
 
 export namespace PayStatementRetrieveManyParams {
@@ -326,14 +341,13 @@ export namespace PayStatementRetrieveManyParams {
   }
 }
 
-PayStatements.PayStatementResponsesPage = PayStatementResponsesPage;
-
 export declare namespace PayStatements {
   export {
     type PayStatement as PayStatement,
+    type PayStatementDataSyncInProgress as PayStatementDataSyncInProgress,
     type PayStatementResponse as PayStatementResponse,
     type PayStatementResponseBody as PayStatementResponseBody,
-    PayStatementResponsesPage as PayStatementResponsesPage,
+    type PayStatementResponsesPage as PayStatementResponsesPage,
     type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams,
   };
 }

package/src/resources/hris/payments.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-import * as HRISAPI from "./hris.js";
-import { SinglePage } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import * as HRISAPI from './hris';
+import { PagePromise, SinglePage } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Payments extends APIResource {
   /**
@@ -20,65 +20,62 @@ export class Payments extends APIResource {
    * }
    * ```
    */
-  list(
-    query: PaymentListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PaymentsSinglePage, Payment> {
-    return this._client.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
+  list(query: PaymentListParams, options?: RequestOptions): PagePromise<PaymentsSinglePage, Payment> {
+    return this._client.getAPIList('/employer/payment', SinglePage<Payment>, { query, ...options });
   }
 }
 
-export class PaymentsSinglePage extends SinglePage<Payment> {}
+export type PaymentsSinglePage = SinglePage<Payment>;
 
 export interface Payment {
   /**
    * The unique id for the payment.
    */
-  id?: string;
+  id: string;
 
-  company_debit?: HRISAPI.Money | null;
+  company_debit: HRISAPI.Money | null;
 
-  debit_date?: string | null;
+  debit_date: string | null;
 
-  employee_taxes?: HRISAPI.Money | null;
+  employee_taxes: HRISAPI.Money | null;
 
-  employer_taxes?: HRISAPI.Money | null;
+  employer_taxes: HRISAPI.Money | null;
 
-  gross_pay?: HRISAPI.Money | null;
+  gross_pay: HRISAPI.Money | null;
 
   /**
    * Array of every individual on this payment.
    */
-  individual_ids?: Array<string> | null;
+  individual_ids: Array<string> | null;
 
-  net_pay?: HRISAPI.Money | null;
+  net_pay: HRISAPI.Money | null;
 
-  pay_date?: string | null;
+  pay_date: string | null;
 
   /**
    * List of pay frequencies associated with this payment.
    */
-  pay_frequencies?: Array<
+  pay_frequencies: Array<
     | 'annually'
-    | 'semi_annually'
-    | 'quarterly'
-    | 'monthly'
-    | 'semi_monthly'
     | 'bi_weekly'
-    | 'weekly'
     | 'daily'
+    | 'monthly'
     | 'other'
+    | 'quarterly'
+    | 'semi_annually'
+    | 'semi_monthly'
+    | 'weekly'
   > | null;
 
   /**
    * Array of the Finch id (uuidv4) of every pay group associated with this payment.
    */
-  pay_group_ids?: Array<string> | null;
+  pay_group_ids: Array<string> | null;
 
   /**
    * The pay period object.
    */
-  pay_period?: Payment.PayPeriod | null;
+  pay_period: Payment.PayPeriod | null;
 }
 
 export namespace Payment {
@@ -86,9 +83,9 @@ export namespace Payment {
    * The pay period object.
    */
   export interface PayPeriod {
-    end_date?: string | null;
+    end_date: string | null;
 
-    start_date?: string | null;
+    start_date: string | null;
   }
 }
 
@@ -104,14 +101,17 @@ export interface PaymentListParams {
    * format.
    */
   start_date: string;
-}
 
-Payments.PaymentsSinglePage = PaymentsSinglePage;
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+}
 
 export declare namespace Payments {
   export {
     type Payment as Payment,
-    PaymentsSinglePage as PaymentsSinglePage,
+    type PaymentsSinglePage as PaymentsSinglePage,
     type PaymentListParams as PaymentListParams,
   };
 }

package/src/resources/hris.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./hris/index.js";
+export * from './hris/index';

package/src/resources/index.ts

@@ -1,19 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./shared.js";
-export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from "./access-tokens.js";
-export { Account, type DisconnectResponse, type Introspection } from "./account.js";
-export { Connect } from "./connect/connect.js";
-export { HRIS, type Income, type Location, type Money } from "./hris/hris.js";
-export { Jobs } from "./jobs/jobs.js";
-export { Payroll } from "./payroll/payroll.js";
-export { ProvidersSinglePage, Providers, type Provider } from "./providers.js";
+export * from './shared';
+export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens';
+export { Account, type DisconnectResponse, type Introspection } from './account';
+export { Connect } from './connect/connect';
+export { HRIS, type Income, type Location, type Money } from './hris/hris';
+export { Jobs } from './jobs/jobs';
+export { Payroll } from './payroll/payroll';
+export {
+  Providers,
+  type Provider,
+  type ProviderListResponse,
+  type ProviderListResponsesSinglePage,
+} from './providers';
 export {
   RequestForwarding,
   type RequestForwardingForwardResponse,
   type RequestForwardingForwardParams,
-} from "./request-forwarding.js";
-export { Sandbox } from "./sandbox/sandbox.js";
+} from './request-forwarding';
+export { Sandbox } from './sandbox/sandbox';
 export {
   Webhooks,
   type AccountUpdateEvent,
@@ -26,4 +31,4 @@ export {
   type PayStatementEvent,
   type PaymentEvent,
   type WebhookEvent,
-} from "./webhooks.js";
+} from './webhooks';