@tryfinch/finch-api 6.27.0 → 6.29.0

package/src/resources/sandbox/employment.ts

@@ -1,13 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as HRISAPI from '../hris/hris';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "../hris/hris.js";
 
 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/index.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Company, type CompanyUpdateResponse, type CompanyUpdateParams } from './company';
-export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections/index';
-export { Directory, type DirectoryCreateResponse, type DirectoryCreateParams } from './directory';
-export { Employment, type EmploymentUpdateResponse, type EmploymentUpdateParams } from './employment';
-export { Individual, type IndividualUpdateResponse, type IndividualUpdateParams } from './individual';
-export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs/index';
-export { Payment, type PaymentCreateResponse, type PaymentCreateParams } from './payment';
-export { Sandbox } from './sandbox';
+export { Company, type CompanyUpdateResponse, type CompanyUpdateParams } from "./company.js";
+export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from "./connections/index.js";
+export { Directory, type DirectoryCreateResponse, type DirectoryCreateParams } from "./directory.js";
+export { Employment, type EmploymentUpdateResponse, type EmploymentUpdateParams } from "./employment.js";
+export { Individual, type IndividualUpdateResponse, type IndividualUpdateParams } from "./individual.js";
+export { Jobs, type JobCreateResponse, type JobCreateParams } from "./jobs/index.js";
+export { Payment, type PaymentCreateResponse, type PaymentCreateParams } from "./payment.js";
+export { Sandbox } from "./sandbox.js";

package/src/resources/sandbox/individual.ts

@@ -1,13 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as HRISAPI from '../hris/hris';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "../hris/hris.js";
 
 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

@@ -1,11 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
 
 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/index.ts

@@ -5,5 +5,5 @@ export {
   type SandboxJobConfiguration,
   type ConfigurationRetrieveResponse,
   type ConfigurationUpdateParams,
-} from './configuration';
-export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs';
+} from "./configuration.js";
+export { Jobs, type JobCreateResponse, type JobCreateParams } from "./jobs.js";

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

@@ -1,20 +1,27 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as ConfigurationAPI from './configuration';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as ConfigurationAPI from "./configuration.js";
 import {
   Configuration,
   ConfigurationRetrieveResponse,
   ConfigurationUpdateParams,
   SandboxJobConfiguration,
-} from './configuration';
+} from "./configuration.js";
 
 export class Jobs extends APIResource {
   configuration: ConfigurationAPI.Configuration = new ConfigurationAPI.Configuration(this._client);
 
   /**
    * 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/jobs.ts

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

package/src/resources/sandbox/payment.ts

@@ -1,14 +1,33 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as HRISAPI from '../hris/hris';
-import * as BenefitsAPI from '../hris/benefits/benefits';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "../hris/hris.js";
+import * as BenefitsAPI from "../hris/benefits/benefits.js";
 
 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>;
@@ -69,7 +88,7 @@ export namespace PaymentCreateParams {
     /**
      * The payment method.
      */
-    payment_method?: 'check' | 'direct_deposit' | null;
+    payment_method?: 'check' | 'direct_deposit' | 'other' | null;
 
     /**
      * The array of taxes objects associated with this pay statement.

package/src/resources/sandbox/sandbox.ts

@@ -1,20 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as CompanyAPI from './company';
-import { Company, CompanyUpdateParams, CompanyUpdateResponse } from './company';
-import * as DirectoryAPI from './directory';
-import { Directory, DirectoryCreateParams, DirectoryCreateResponse } from './directory';
-import * as EmploymentAPI from './employment';
-import { Employment, EmploymentUpdateParams, EmploymentUpdateResponse } from './employment';
-import * as IndividualAPI from './individual';
-import { Individual, IndividualUpdateParams, IndividualUpdateResponse } from './individual';
-import * as PaymentAPI from './payment';
-import { Payment, PaymentCreateParams, PaymentCreateResponse } from './payment';
-import * as ConnectionsAPI from './connections/connections';
-import { ConnectionCreateParams, ConnectionCreateResponse, Connections } from './connections/connections';
-import * as JobsAPI from './jobs/jobs';
-import { JobCreateParams, JobCreateResponse, Jobs } from './jobs/jobs';
+import { APIResource } from "../../resource.js";
+import * as CompanyAPI from "./company.js";
+import { Company, CompanyUpdateParams, CompanyUpdateResponse } from "./company.js";
+import * as DirectoryAPI from "./directory.js";
+import { Directory, DirectoryCreateParams, DirectoryCreateResponse } from "./directory.js";
+import * as EmploymentAPI from "./employment.js";
+import { Employment, EmploymentUpdateParams, EmploymentUpdateResponse } from "./employment.js";
+import * as IndividualAPI from "./individual.js";
+import { Individual, IndividualUpdateParams, IndividualUpdateResponse } from "./individual.js";
+import * as PaymentAPI from "./payment.js";
+import { Payment, PaymentCreateParams, PaymentCreateResponse } from "./payment.js";
+import * as ConnectionsAPI from "./connections/connections.js";
+import { ConnectionCreateParams, ConnectionCreateResponse, Connections } from "./connections/connections.js";
+import * as JobsAPI from "./jobs/jobs.js";
+import { JobCreateParams, JobCreateResponse, Jobs } from "./jobs/jobs.js";
 
 export class Sandbox extends APIResource {
   connections: ConnectionsAPI.Connections = new ConnectionsAPI.Connections(this._client);

package/src/resources/sandbox.ts

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

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/resources/webhooks.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Shared from './shared';
-import * as BenefitsAPI from './hris/benefits/benefits';
-import { fromBase64, getRequiredHeader, HeadersLike, toBase64 } from '../core';
+import { APIResource } from "../resource.js";
+import * as Shared from "./shared.js";
+import * as BenefitsAPI from "./hris/benefits/benefits.js";
+import { fromBase64, getRequiredHeader, HeadersLike, toBase64 } from "../core.js";
 import { hmac } from '@noble/hashes/hmac';
 import { sha256 } from '@noble/hashes/sha2';
 

package/src/resources.ts

@@ -1 +1 @@
-export * from './resources/index';
+export * from "./resources/index.js";

package/src/shims/node.ts

@@ -1,7 +1,7 @@
 // @ts-ignore
-import * as types from '../_shims/node-types';
-import { setShims } from '../_shims/registry';
-import { getRuntime } from '../_shims/node-runtime';
+import * as types from "../_shims/node-types.js";
+import { setShims } from "../_shims/registry.js";
+import { getRuntime } from "../_shims/node-runtime.js";
 setShims(getRuntime());
 
 declare module '../_shims/manual-types' {

package/src/shims/web.ts

@@ -1,7 +1,7 @@
 // @ts-ignore
-import * as types from '../_shims/web-types';
-import { setShims } from '../_shims/registry';
-import { getRuntime } from '../_shims/web-runtime';
+import * as types from "../_shims/web-types.js";
+import { setShims } from "../_shims/registry.js";
+import { getRuntime } from "../_shims/web-runtime.js";
 setShims(getRuntime({ manuallyImported: true }));
 
 declare module '../_shims/manual-types' {

package/src/uploads.ts

@@ -1,4 +1,4 @@
-import { type RequestOptions } from './core';
+import { type RequestOptions } from "./core.js";
 import {
   FormData,
   File,
@@ -7,9 +7,9 @@ import {
   getMultipartRequestOptions,
   type FsReadStream,
   isFsReadStream,
-} from './_shims/index';
-import { MultipartBody } from './_shims/MultipartBody';
-export { fileFromPath } from './_shims/index';
+} from "./_shims/index.js";
+import { MultipartBody } from "./_shims/MultipartBody.js";
+export { fileFromPath } from "./_shims/index.js";
 
 type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.27.0'; // x-release-please-version
+export const VERSION = '6.29.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.27.0";
+export declare const VERSION = "6.29.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.27.0'; // x-release-please-version
+exports.VERSION = '6.29.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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