@tryfinch/finch-api 6.26.0 → 6.28.0

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

@@ -13,6 +13,22 @@ export class PayStatements extends APIResource {
    *
    * Deduction and contribution types are supported by the payroll systems that
    * supports Benefits.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
+   *   {
+   *     requests: [
+   *       {
+   *         payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       },
+   *     ],
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   retrieveMany(
     body: PayStatementRetrieveManyParams,

package/src/resources/hris/payments.ts

@@ -8,6 +8,17 @@ import { SinglePage } from '../../pagination';
 export class Payments extends APIResource {
   /**
    * Read payroll and contractor related payments by the company.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const payment of client.hris.payments.list({
+   *   end_date: '2021-01-01',
+   *   start_date: '2021-01-01',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: PaymentListParams,

package/src/resources/request-forwarding.ts

@@ -9,6 +9,16 @@ export class RequestForwarding extends APIResource {
    * Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
    * Forward allows you to push or pull data models directly against an integration’s
    * API.
+   *
+   * @example
+   * ```ts
+   * const response = await client.requestForwarding.forward({
+   *   method: 'POST',
+   *   route: '/people/search',
+   *   headers: { 'content-type': 'application/json' },
+   *   params: { showInactive: true, humanReadable: true },
+   * });
+   * ```
    */
   forward(
     body: RequestForwardingForwardParams,

package/src/resources/sandbox/company.ts

@@ -7,6 +7,29 @@ import * as HRISAPI from '../hris/hris';
 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?: Core.RequestOptions): Core.APIPromise<CompanyUpdateResponse> {
     return this._client.put('/sandbox/company', { body, ...options });

package/src/resources/sandbox/connections/accounts.ts

@@ -8,6 +8,15 @@ import * as Shared from '../../shared';
 export class Accounts extends APIResource {
   /**
    * Create a new account for an existing connection (company/provider pair)
+   *
+   * @example
+   * ```ts
+   * const account =
+   *   await client.sandbox.connections.accounts.create({
+   *     company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     provider_id: 'provider_id',
+   *   });
+   * ```
    */
   create(body: AccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<AccountCreateResponse> {
     return this._client.post('/sandbox/connections/accounts', { body, ...options });
@@ -16,6 +25,14 @@ export class Accounts extends APIResource {
   /**
    * Update an existing sandbox account. Change the connection status to understand
    * how the Finch API responds.
+   *
+   * @example
+   * ```ts
+   * const account =
+   *   await client.sandbox.connections.accounts.update({
+   *     connection_status: 'reauth',
+   *   });
+   * ```
    */
   update(body?: AccountUpdateParams, options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;
   update(options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;

package/src/resources/sandbox/connections/connections.ts

@@ -16,6 +16,13 @@ export class Connections extends APIResource {
 
   /**
    * Create a new connection (new company/provider pair) with a new account
+   *
+   * @example
+   * ```ts
+   * const connection = await client.sandbox.connections.create({
+   *   provider_id: 'provider_id',
+   * });
+   * ```
    */
   create(
     body: ConnectionCreateParams,

package/src/resources/sandbox/directory.ts

@@ -8,6 +8,13 @@ import * as HRISAPI from '../hris/hris';
 export class Directory extends APIResource {
   /**
    * Add new individuals to a sandbox company
+   *
+   * @example
+   * ```ts
+   * const directories = await client.sandbox.directory.create([
+   *   {},
+   * ]);
+   * ```
    */
   create(
     body?: DirectoryCreateParams,

package/src/resources/sandbox/employment.ts

@@ -8,6 +8,13 @@ import * as HRISAPI from '../hris/hris';
 export class Employment extends APIResource {
   /**
    * Update sandbox employment
+   *
+   * @example
+   * ```ts
+   * const employment = await client.sandbox.employment.update(
+   *   'individual_id',
+   * );
+   * ```
    */
   update(
     individualId: string,

package/src/resources/sandbox/individual.ts

@@ -8,6 +8,13 @@ import * as HRISAPI from '../hris/hris';
 export class Individual extends APIResource {
   /**
    * Update sandbox individual
+   *
+   * @example
+   * ```ts
+   * const individual = await client.sandbox.individual.update(
+   *   'individual_id',
+   * );
+   * ```
    */
   update(
     individualId: string,

package/src/resources/sandbox/jobs/configuration.ts

@@ -6,6 +6,12 @@ import * as Core from '../../../core';
 export class Configuration extends APIResource {
   /**
    * Get configurations for sandbox jobs
+   *
+   * @example
+   * ```ts
+   * const sandboxJobConfigurations =
+   *   await client.sandbox.jobs.configuration.retrieve();
+   * ```
    */
   retrieve(options?: Core.RequestOptions): Core.APIPromise<ConfigurationRetrieveResponse> {
     return this._client.get('/sandbox/jobs/configuration', options);
@@ -13,6 +19,15 @@ export class Configuration extends APIResource {
 
   /**
    * Update configurations for sandbox jobs
+   *
+   * @example
+   * ```ts
+   * const sandboxJobConfiguration =
+   *   await client.sandbox.jobs.configuration.update({
+   *     completion_status: 'complete',
+   *     type: 'data_sync_all',
+   *   });
+   * ```
    */
   update(
     body: ConfigurationUpdateParams,

package/src/resources/sandbox/jobs/jobs.ts

@@ -15,6 +15,13 @@ export class Jobs extends APIResource {
 
   /**
    * Enqueue a new sandbox job
+   *
+   * @example
+   * ```ts
+   * const job = await client.sandbox.jobs.create({
+   *   type: 'data_sync_all',
+   * });
+   * ```
    */
   create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<JobCreateResponse> {
     return this._client.post('/sandbox/jobs', { body, ...options });

package/src/resources/sandbox/payment.ts

@@ -9,6 +9,25 @@ import * as BenefitsAPI from '../hris/benefits/benefits';
 export class Payment extends APIResource {
   /**
    * Add a new sandbox payment
+   *
+   * @example
+   * ```ts
+   * const payment = await client.sandbox.payment.create({
+   *   pay_statements: [
+   *     {
+   *       individual_id: 'b2338cfb-472f-4f72-9faa-e028c083144a',
+   *       employee_deductions: [
+   *         {
+   *           name: '401k test',
+   *           type: '401k',
+   *           amount: 2000,
+   *           currency: 'usd',
+   *         },
+   *       ],
+   *     },
+   *   ],
+   * });
+   * ```
    */
   create(body?: PaymentCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentCreateResponse>;
   create(options?: Core.RequestOptions): Core.APIPromise<PaymentCreateResponse>;

package/src/resources/shared.ts

@@ -71,12 +71,12 @@ export interface OperationSupportMatrix {
 
 export interface Paging {
   /**
-   * The total number of elements for the entire query (not just the given page)
+   * The current start index of the returned list of elements
    */
-  count?: number;
+  offset: number;
 
   /**
-   * The current start index of the returned list of elements
+   * The total number of elements for the entire query (not just the given page)
    */
-  offset?: number;
+  count?: number;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.26.0'; // x-release-please-version
+export const VERSION = '6.28.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.26.0";
+export declare const VERSION = "6.28.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.26.0'; // x-release-please-version
+exports.VERSION = '6.28.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.26.0'; // x-release-please-version
+export const VERSION = '6.28.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map