@tryfinch/finch-api 6.31.0 → 8.0.0

package/src/resources/request-forwarding.ts

@@ -1,58 +1,49 @@
 // 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 { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
 
 export class RequestForwarding extends APIResource {
   /**
    * The Forward API allows you to make direct requests to an employment system. If
-   * 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
+   * 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,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RequestForwardingForwardResponse> {
+    options?: RequestOptions,
+  ): APIPromise<RequestForwardingForwardResponse> {
     return this._client.post('/forward', { body, ...options });
   }
 }
 
 export interface RequestForwardingForwardResponse {
   /**
-   * A string representation of the HTTP response body of the forwarded request’s
-   * response received from the underlying integration’s API. This field may be null
-   * in the case where the upstream system’s response is empty.
+   * An object containing details of your original forwarded request, for your ease
+   * of reference.
    */
-  data: string | null;
+  request: RequestForwardingForwardResponse.Request;
 
   /**
-   * The HTTP headers of the forwarded request’s response, exactly as received from
-   * the underlying integration’s API.
+   * The HTTP status code of the forwarded request's response, exactly received from
+   * the underlying integration's API. This value will be returned as an integer.
    */
-  headers: unknown | null;
+  statusCode: number;
 
   /**
-   * An object containing details of your original forwarded request, for your ease
-   * of reference.
+   * A string representation of the HTTP response body of the forwarded request's
+   * response received from the underlying integration's API. This field may be null
+   * in the case where the upstream system's response is empty.
    */
-  request: RequestForwardingForwardResponse.Request;
+  data?: string | null;
 
   /**
-   * The HTTP status code of the forwarded request’s response, exactly received from
-   * the underlying integration’s API. This value will be returned as an integer.
+   * The HTTP headers of the forwarded request's response, exactly as received from
+   * the underlying integration's API.
    */
-  statusCode: number;
+  headers?: { [key: string]: unknown } | null;
 }
 
 export namespace RequestForwardingForwardResponse {
@@ -62,34 +53,30 @@ export namespace RequestForwardingForwardResponse {
    */
   export interface Request {
     /**
-     * The body that was specified for the forwarded request. If a value was not
-     * specified in the original request, this value will be returned as null ;
-     * otherwise, this value will always be returned as a string.
+     * The HTTP method that was specified for the forwarded request. Valid values
+     * include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
      */
-    data: string | null;
+    method: string;
 
     /**
-     * The specified HTTP headers that were included in the forwarded request. If no
-     * headers were specified, this will be returned as `null`.
+     * The URL route path that was specified for the forwarded request.
      */
-    headers: unknown | null;
+    route: string;
 
     /**
-     * The HTTP method that was specified for the forwarded request. Valid values
-     * include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
+     * The body that was specified for the forwarded request.
      */
-    method: string;
+    data?: string | { [key: string]: unknown } | null;
 
     /**
-     * The query parameters that were included in the forwarded request. If no query
-     * parameters were specified, this will be returned as `null`.
+     * The HTTP headers that were specified for the forwarded request.
      */
-    params: unknown | null;
+    headers?: { [key: string]: string } | null;
 
     /**
-     * The URL route path that was specified for the forwarded request.
+     * The query parameters that were specified for the forwarded request.
      */
-    route: string;
+    params?: { [key: string]: unknown } | null;
   }
 }
 
@@ -114,17 +101,17 @@ export interface RequestForwardingForwardParams {
   data?: string | null;
 
   /**
-   * The HTTP headers to include on the forwarded request. This value must be
-   * specified as an object of key-value pairs. Example:
-   * `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
+   * The query parameters for the forwarded request. This value must be specified as
+   * a valid JSON object rather than a query string.
    */
-  headers?: unknown | null;
+  params?: { [key: string]: unknown } | null;
 
   /**
-   * The query parameters for the forwarded request. This value must be specified as
-   * a valid JSON object rather than a query string.
+   * The HTTP headers to include on the forwarded request. This value must be
+   * specified as an object of key-value pairs. Example:
+   * `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
    */
-  params?: unknown | null;
+  request_headers?: { [key: string]: unknown } | null;
 }
 
 export declare namespace RequestForwarding {

package/src/resources/sandbox/company.ts

@@ -1,8 +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/hris.js";
+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 {
   /**
@@ -31,7 +32,7 @@ export class Company extends APIResource {
    * });
    * ```
    */
-  update(body: CompanyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CompanyUpdateResponse> {
+  update(body: CompanyUpdateParams, options?: RequestOptions): APIPromise<CompanyUpdateResponse> {
     return this._client.put('/sandbox/company', { body, ...options });
   }
 }

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

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import { isRequestOptions } from "../../../core.js";
-import * as Core from "../../../core.js";
-import * as Shared from "../../shared.js";
+import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Accounts extends APIResource {
   /**
@@ -18,7 +18,7 @@ export class Accounts extends APIResource {
    *   });
    * ```
    */
-  create(body: AccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<AccountCreateResponse> {
+  create(body: AccountCreateParams, options?: RequestOptions): APIPromise<AccountCreateResponse> {
     return this._client.post('/sandbox/connections/accounts', { body, ...options });
   }
 
@@ -34,15 +34,10 @@ export class Accounts extends APIResource {
    *   });
    * ```
    */
-  update(body?: AccountUpdateParams, options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;
-  update(options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;
   update(
-    body: AccountUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AccountUpdateResponse> {
-    if (isRequestOptions(body)) {
-      return this.update({}, body);
-    }
+    body: AccountUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AccountUpdateResponse> {
     return this._client.put('/sandbox/connections/accounts', { body, ...options });
   }
 }

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

@@ -1,15 +1,16 @@
 // 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 AccountsAPI from "./accounts.js";
+import { APIResource } from '../../../core/resource';
+import * as AccountsAPI from './accounts';
 import {
   AccountCreateParams,
   AccountCreateResponse,
   AccountUpdateParams,
   AccountUpdateResponse,
   Accounts,
-} from "./accounts.js";
+} from './accounts';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Connections extends APIResource {
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
@@ -24,10 +25,7 @@ export class Connections extends APIResource {
    * });
    * ```
    */
-  create(
-    body: ConnectionCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ConnectionCreateResponse> {
+  create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise<ConnectionCreateResponse> {
     return this._client.post('/sandbox/connections', { body, ...options });
   }
 }

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

@@ -6,5 +6,5 @@ export {
   type AccountUpdateResponse,
   type AccountCreateParams,
   type AccountUpdateParams,
-} from "./accounts.js";
-export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from "./connections.js";
+} from './accounts';
+export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections';

package/src/resources/sandbox/connections.ts

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

package/src/resources/sandbox/directory.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
-import * as HRISAPI from "../hris/hris.js";
+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 Directory extends APIResource {
   /**
@@ -11,24 +11,15 @@ export class Directory extends APIResource {
    *
    * @example
    * ```ts
-   * const directories = await client.sandbox.directory.create([
-   *   {},
-   * ]);
+   * const directories = await client.sandbox.directory.create();
    * ```
    */
   create(
-    body?: DirectoryCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<DirectoryCreateResponse>;
-  create(options?: Core.RequestOptions): Core.APIPromise<DirectoryCreateResponse>;
-  create(
-    body?: DirectoryCreateParams | Core.RequestOptions,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<DirectoryCreateResponse> {
-    if (isRequestOptions(body)) {
-      return this.create(undefined, body);
-    }
-    return this._client.post('/sandbox/directory', { body, ...options });
+    params: DirectoryCreateParams | null | undefined = undefined,
+    options?: RequestOptions,
+  ): APIPromise<DirectoryCreateResponse> {
+    const { body } = params ?? {};
+    return this._client.post('/sandbox/directory', { body: body, ...options });
   }
 }
 
@@ -37,7 +28,13 @@ export class Directory extends APIResource {
  */
 export type DirectoryCreateResponse = Array<unknown>;
 
-export type DirectoryCreateParams = Array<DirectoryCreateParams.Body>;
+export interface DirectoryCreateParams {
+  /**
+   * Array of individuals to create. Takes all combined fields from `/individual` and
+   * `/employment` endpoints. All fields are optional.
+   */
+  body?: Array<DirectoryCreateParams.Body>;
+}
 
 export namespace DirectoryCreateParams {
   export interface Body {

package/src/resources/sandbox/employment.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
-import * as HRISAPI from "../hris/hris.js";
+import { APIResource } from '../../core/resource';
+import * as HRISAPI from '../hris/hris';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Employment extends APIResource {
   /**
@@ -17,20 +18,11 @@ export class Employment extends APIResource {
    * ```
    */
   update(
-    individualId: string,
-    body?: EmploymentUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EmploymentUpdateResponse>;
-  update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<EmploymentUpdateResponse>;
-  update(
-    individualId: string,
-    body: EmploymentUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EmploymentUpdateResponse> {
-    if (isRequestOptions(body)) {
-      return this.update(individualId, {}, body);
-    }
-    return this._client.put(`/sandbox/employment/${individualId}`, { body, ...options });
+    individualID: string,
+    body: EmploymentUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EmploymentUpdateResponse> {
+    return this._client.put(path`/sandbox/employment/${individualID}`, { body, ...options });
   }
 }
 

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.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";
+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';

package/src/resources/sandbox/individual.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
-import * as HRISAPI from "../hris/hris.js";
+import { APIResource } from '../../core/resource';
+import * as HRISAPI from '../hris/hris';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Individual extends APIResource {
   /**
@@ -17,20 +18,11 @@ export class Individual extends APIResource {
    * ```
    */
   update(
-    individualId: string,
-    body?: IndividualUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<IndividualUpdateResponse>;
-  update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<IndividualUpdateResponse>;
-  update(
-    individualId: string,
-    body: IndividualUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<IndividualUpdateResponse> {
-    if (isRequestOptions(body)) {
-      return this.update(individualId, {}, body);
-    }
-    return this._client.put(`/sandbox/individual/${individualId}`, { body, ...options });
+    individualID: string,
+    body: IndividualUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<IndividualUpdateResponse> {
+    return this._client.put(path`/sandbox/individual/${individualID}`, { body, ...options });
   }
 }
 

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

@@ -1,7 +1,8 @@
 // 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 { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Configuration extends APIResource {
   /**
@@ -13,7 +14,7 @@ export class Configuration extends APIResource {
    *   await client.sandbox.jobs.configuration.retrieve();
    * ```
    */
-  retrieve(options?: Core.RequestOptions): Core.APIPromise<ConfigurationRetrieveResponse> {
+  retrieve(options?: RequestOptions): APIPromise<ConfigurationRetrieveResponse> {
     return this._client.get('/sandbox/jobs/configuration', options);
   }
 
@@ -29,10 +30,7 @@ export class Configuration extends APIResource {
    *   });
    * ```
    */
-  update(
-    body: ConfigurationUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<SandboxJobConfiguration> {
+  update(body: ConfigurationUpdateParams, options?: RequestOptions): APIPromise<SandboxJobConfiguration> {
     return this._client.put('/sandbox/jobs/configuration', { body, ...options });
   }
 }

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

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

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

@@ -1,14 +1,15 @@
 // 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 ConfigurationAPI from "./configuration.js";
+import { APIResource } from '../../../core/resource';
+import * as ConfigurationAPI from './configuration';
 import {
   Configuration,
   ConfigurationRetrieveResponse,
   ConfigurationUpdateParams,
   SandboxJobConfiguration,
-} from "./configuration.js";
+} from './configuration';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Jobs extends APIResource {
   configuration: ConfigurationAPI.Configuration = new ConfigurationAPI.Configuration(this._client);
@@ -23,7 +24,7 @@ export class Jobs extends APIResource {
    * });
    * ```
    */
-  create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<JobCreateResponse> {
+  create(body: JobCreateParams, options?: RequestOptions): 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.js";
+export * from './jobs/index';