@tryfinch/finch-api 6.18.0 → 6.19.0

package/resources.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/index.js"), exports);
+//# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAkC"}

package/resources.mjs

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.mjs.map

package/resources.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/src/core.ts

@@ -48,8 +48,8 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   }
 
   const contentType = response.headers.get('content-type');
-  const isJSON =
-    contentType?.includes('application/json') || contentType?.includes('application/vnd.api+json');
+  const mediaType = contentType?.split(';')[0]?.trim();
+  const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
     const json = await response.json();
 
@@ -395,7 +395,7 @@ export abstract class APIClient {
       !headers ? {}
       : Symbol.iterator in headers ?
         Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
-      : { ...headers }
+      : { ...(headers as any as Record<string, string>) }
     );
   }
 

package/src/resources/connect.ts

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

package/src/resources/hris/benefits/benefits.ts

@@ -207,11 +207,6 @@ export interface BenefitsSupport {
   [k: string]: BenefitFeaturesAndOperations | null | undefined;
 }
 
-/**
- * @deprecated use `BenefitContribution` instead
- */
-export type BenfitContribution = BenefitContribution | null;
-
 export interface CompanyBenefit {
   benefit_id: string;
 
@@ -282,6 +277,11 @@ export interface UpdateCompanyBenefitResponse {
   benefit_id: string;
 }
 
+/**
+ * @deprecated use `BenefitContribution` instead
+ */
+export type BenfitContribution = BenefitContribution | null;
+
 export interface BenefitCreateParams {
   /**
    * Name of the benefit as it appears in the provider and pay statements. Recommend
@@ -319,12 +319,12 @@ export declare namespace Benefits {
     type BenefitFrequency as BenefitFrequency,
     type BenefitType as BenefitType,
     type BenefitsSupport as BenefitsSupport,
-    type BenfitContribution as BenfitContribution,
     type CompanyBenefit as CompanyBenefit,
     type CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse,
     type SupportPerBenefitType as SupportPerBenefitType,
     type SupportedBenefit as SupportedBenefit,
     type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
+    type BenfitContribution as BenfitContribution,
     CompanyBenefitsSinglePage as CompanyBenefitsSinglePage,
     SupportedBenefitsSinglePage as SupportedBenefitsSinglePage,
     type BenefitCreateParams as BenefitCreateParams,

package/src/resources/hris/benefits/index.ts

@@ -9,12 +9,12 @@ export {
   type BenefitFrequency,
   type BenefitType,
   type BenefitsSupport,
-  type BenfitContribution,
   type CompanyBenefit,
   type CreateCompanyBenefitsResponse,
   type SupportPerBenefitType,
   type SupportedBenefit,
   type UpdateCompanyBenefitResponse,
+  type BenfitContribution,
   type BenefitCreateParams,
   type BenefitUpdateParams,
 } from './benefits';

package/src/resources/hris/benefits.ts

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

package/src/resources/hris/documents.ts

@@ -7,8 +7,8 @@ import * as Shared from '../shared';
 
 export class Documents extends APIResource {
   /**
-   * **Beta:** This endpoint is in beta and may change.
-   * Retrieve a list of company-wide documents.
+   * **Beta:** This endpoint is in beta and may change. Retrieve a list of
+   * company-wide documents.
    */
   list(query?: DocumentListParams, options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
@@ -23,8 +23,8 @@ export class Documents extends APIResource {
   }
 
   /**
-   * **Beta:** This endpoint is in beta and may change.
-   * Retrieve details of a specific document by its ID.
+   * **Beta:** This endpoint is in beta and may change. Retrieve details of a
+   * specific document by its ID.
    */
   retreive(documentId: string, options?: Core.RequestOptions): Core.APIPromise<DocumentRetreiveResponse> {
     return this._client.get(`/employer/documents/${documentId}`, options);
@@ -99,7 +99,7 @@ export namespace W42005 {
     /**
      * The individual's filing status for tax purposes.
      */
-    filing_status?: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single';
+    filing_status?: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single' | null;
 
     /**
      * The unique identifier for the individual associated with this 2005 W4 form.

package/src/resources/hris/hris.ts

@@ -237,12 +237,12 @@ export declare namespace HRIS {
     type BenefitFrequency as BenefitFrequency,
     type BenefitType as BenefitType,
     type BenefitsSupport as BenefitsSupport,
-    type BenfitContribution as BenfitContribution,
     type CompanyBenefit as CompanyBenefit,
     type CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse,
     type SupportPerBenefitType as SupportPerBenefitType,
     type SupportedBenefit as SupportedBenefit,
     type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
+    type BenfitContribution as BenfitContribution,
     CompanyBenefitsSinglePage as CompanyBenefitsSinglePage,
     SupportedBenefitsSinglePage as SupportedBenefitsSinglePage,
     type BenefitCreateParams as BenefitCreateParams,

package/src/resources/hris/index.ts

@@ -9,12 +9,12 @@ export {
   type BenefitFrequency,
   type BenefitType,
   type BenefitsSupport,
-  type BenfitContribution,
   type CompanyBenefit,
   type CreateCompanyBenefitsResponse,
   type SupportPerBenefitType,
   type SupportedBenefit,
   type UpdateCompanyBenefitResponse,
+  type BenfitContribution,
   type BenefitCreateParams,
   type BenefitUpdateParams,
 } from './benefits/index';

package/src/resources/hris.ts

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

package/src/resources/jobs/automated.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import { Page, type PageParams } from '../../pagination';
 
 export class Automated extends APIResource {
   /**
@@ -41,24 +40,19 @@ export class Automated extends APIResource {
    * jobs are sorted in descending order by submission time. For scheduled jobs such
    * as data syncs, only the next scheduled job is shown.
    */
-  list(
-    query?: AutomatedListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<AutomatedAsyncJobsPage, AutomatedAsyncJob>;
-  list(options?: Core.RequestOptions): Core.PagePromise<AutomatedAsyncJobsPage, AutomatedAsyncJob>;
+  list(query?: AutomatedListParams, options?: Core.RequestOptions): Core.APIPromise<AutomatedListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<AutomatedListResponse>;
   list(
     query: AutomatedListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AutomatedAsyncJobsPage, AutomatedAsyncJob> {
+  ): Core.APIPromise<AutomatedListResponse> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this._client.getAPIList('/jobs/automated', AutomatedAsyncJobsPage, { query, ...options });
+    return this._client.get('/jobs/automated', { query, ...options });
   }
 }
 
-export class AutomatedAsyncJobsPage extends Page<AutomatedAsyncJob> {}
-
 export interface AutomatedAsyncJob {
   /**
    * The datetime the job completed.
@@ -141,6 +135,44 @@ export interface AutomatedCreateResponse {
   remaining_refreshes: number;
 }
 
+export interface AutomatedListResponse {
+  data: Array<AutomatedAsyncJob>;
+
+  meta: AutomatedListResponse.Meta;
+}
+
+export namespace AutomatedListResponse {
+  export interface Meta {
+    /**
+     * Information about remaining quotas for this connection. Only applicable for
+     * customers opted in to use Finch's Data Sync Refresh endpoint
+     * (`POST /jobs/automated`). Please contact a Finch representative for more
+     * details.
+     */
+    quotas?: Meta.Quotas;
+  }
+
+  export namespace Meta {
+    /**
+     * Information about remaining quotas for this connection. Only applicable for
+     * customers opted in to use Finch's Data Sync Refresh endpoint
+     * (`POST /jobs/automated`). Please contact a Finch representative for more
+     * details.
+     */
+    export interface Quotas {
+      data_sync_all?: Quotas.DataSyncAll;
+    }
+
+    export namespace Quotas {
+      export interface DataSyncAll {
+        allowed_refreshes?: number;
+
+        remaining_refreshes?: number;
+      }
+    }
+  }
+}
+
 export type AutomatedCreateParams =
   | AutomatedCreateParams.DataSyncAll
   | AutomatedCreateParams.W4FormEmployeeSync;
@@ -172,15 +204,23 @@ export declare namespace AutomatedCreateParams {
   }
 }
 
-export interface AutomatedListParams extends PageParams {}
+export interface AutomatedListParams {
+  /**
+   * Number of items to return
+   */
+  limit?: number;
 
-Automated.AutomatedAsyncJobsPage = AutomatedAsyncJobsPage;
+  /**
+   * Index to start from (defaults to 0)
+   */
+  offset?: number;
+}
 
 export declare namespace Automated {
   export {
     type AutomatedAsyncJob as AutomatedAsyncJob,
     type AutomatedCreateResponse as AutomatedCreateResponse,
-    AutomatedAsyncJobsPage as AutomatedAsyncJobsPage,
+    type AutomatedListResponse as AutomatedListResponse,
     type AutomatedCreateParams as AutomatedCreateParams,
     type AutomatedListParams as AutomatedListParams,
   };

package/src/resources/jobs/index.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  AutomatedAsyncJobsPage,
   Automated,
   type AutomatedAsyncJob,
   type AutomatedCreateResponse,
+  type AutomatedListResponse,
   type AutomatedCreateParams,
   type AutomatedListParams,
 } from './automated';

package/src/resources/jobs/jobs.ts

@@ -5,10 +5,10 @@ import * as AutomatedAPI from './automated';
 import {
   Automated,
   AutomatedAsyncJob,
-  AutomatedAsyncJobsPage,
   AutomatedCreateParams,
   AutomatedCreateResponse,
   AutomatedListParams,
+  AutomatedListResponse,
 } from './automated';
 import * as ManualAPI from './manual';
 import { Manual, ManualAsyncJob } from './manual';
@@ -19,7 +19,6 @@ export class Jobs extends APIResource {
 }
 
 Jobs.Automated = Automated;
-Jobs.AutomatedAsyncJobsPage = AutomatedAsyncJobsPage;
 Jobs.Manual = Manual;
 
 export declare namespace Jobs {
@@ -27,7 +26,7 @@ export declare namespace Jobs {
     Automated as Automated,
     type AutomatedAsyncJob as AutomatedAsyncJob,
     type AutomatedCreateResponse as AutomatedCreateResponse,
-    AutomatedAsyncJobsPage as AutomatedAsyncJobsPage,
+    type AutomatedListResponse as AutomatedListResponse,
     type AutomatedCreateParams as AutomatedCreateParams,
     type AutomatedListParams as AutomatedListParams,
   };

package/src/resources/jobs.ts

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

package/src/resources/payroll.ts

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

package/src/resources/sandbox/connections.ts

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

package/src/resources/sandbox/jobs.ts

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

package/src/resources/sandbox.ts

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

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.18.0'; // x-release-please-version
+export const VERSION = '6.19.0'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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