@tryfinch/finch-api 6.27.0 → 6.28.0

package/resources/sandbox/payment.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"payment.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/payment.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAK3B,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAMtC,MAAM,CACJ,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"payment.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/payment.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAK3B,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAyBtC,MAAM,CACJ,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}

package/resources/shared.d.ts

@@ -53,12 +53,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;
 }
 //# sourceMappingURL=shared.d.ts.map

package/resources/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,YAAY,GACZ,WAAW,GACX,wBAAwB,GACxB,mBAAmB,GACnB,QAAQ,CAAC;AAEb;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,wBAAwB,GACxB,2BAA2B,GAC3B,oBAAoB,CAAC;AAEzB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,YAAY,GACZ,WAAW,GACX,wBAAwB,GACxB,mBAAmB,GACnB,QAAQ,CAAC;AAEb;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,wBAAwB,GACxB,2BAA2B,GAC3B,oBAAoB,CAAC;AAEzB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/src/resources/access-tokens.ts

@@ -6,6 +6,14 @@ import * as Core from '../core';
 export class AccessTokens extends APIResource {
   /**
    * Exchange the authorization code for an access token
+   *
+   * @example
+   * ```ts
+   * const createAccessTokenResponse =
+   *   await client.accessTokens.create({
+   *     code: '<your_authorization_code>',
+   *   });
+   * ```
    */
   create(
     body: AccessTokenCreateParams,

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

@@ -25,6 +25,12 @@ export class Benefits extends APIResource {
   /**
    * Creates a new company-wide deduction or contribution. Please use the
    * `/providers` endpoint to view available types for each provider.
+   *
+   * @example
+   * ```ts
+   * const createCompanyBenefitsResponse =
+   *   await client.hris.benefits.create();
+   * ```
    */
   create(
     body?: BenefitCreateParams,
@@ -43,6 +49,13 @@ export class Benefits extends APIResource {
 
   /**
    * Lists deductions and contributions information for a given item
+   *
+   * @example
+   * ```ts
+   * const companyBenefit = await client.hris.benefits.retrieve(
+   *   'benefit_id',
+   * );
+   * ```
    */
   retrieve(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<CompanyBenefit> {
     return this._client.get(`/employer/benefits/${benefitId}`, options);
@@ -50,6 +63,12 @@ export class Benefits extends APIResource {
 
   /**
    * Updates an existing company-wide deduction or contribution
+   *
+   * @example
+   * ```ts
+   * const updateCompanyBenefitResponse =
+   *   await client.hris.benefits.update('benefit_id');
+   * ```
    */
   update(
     benefitId: string,
@@ -70,6 +89,14 @@ export class Benefits extends APIResource {
 
   /**
    * List all company-wide deductions and contributions.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const companyBenefit of client.hris.benefits.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage, CompanyBenefit> {
     return this._client.getAPIList('/employer/benefits', CompanyBenefitsSinglePage, options);
@@ -77,6 +104,14 @@ export class Benefits extends APIResource {
 
   /**
    * Get deductions metadata
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const benefitListSupportedBenefitsResponse of client.hris.benefits.listSupportedBenefits()) {
+   *   // ...
+   * }
+   * ```
    */
   listSupportedBenefits(
     options?: Core.RequestOptions,
@@ -219,6 +254,11 @@ export interface CompanyBenefit {
    */
   benefit_id: string;
 
+  /**
+   * The company match for this benefit.
+   */
+  company_contribution: CompanyBenefit.CompanyContribution | null;
+
   description: string | null;
 
   /**
@@ -232,6 +272,25 @@ export interface CompanyBenefit {
   type: BenefitType | null;
 }
 
+export namespace CompanyBenefit {
+  /**
+   * The company match for this benefit.
+   */
+  export interface CompanyContribution {
+    tiers?: Array<CompanyContribution.Tier>;
+
+    type?: 'match';
+  }
+
+  export namespace CompanyContribution {
+    export interface Tier {
+      match?: number;
+
+      threshold?: number;
+    }
+  }
+}
+
 export interface CreateCompanyBenefitsResponse {
   /**
    * The id of the benefit.
@@ -338,6 +397,11 @@ export interface BenefitListSupportedBenefitsResponse {
 export type BenfitContribution = BenefitContribution | null;
 
 export interface BenefitCreateParams {
+  /**
+   * The company match for this benefit.
+   */
+  company_contribution?: BenefitCreateParams.CompanyContribution | null;
+
   /**
    * Name of the benefit as it appears in the provider and pay statements. Recommend
    * limiting this to <30 characters due to limitations in specific providers (e.g.
@@ -356,6 +420,25 @@ export interface BenefitCreateParams {
   type?: BenefitType | null;
 }
 
+export namespace BenefitCreateParams {
+  /**
+   * The company match for this benefit.
+   */
+  export interface CompanyContribution {
+    tiers?: Array<CompanyContribution.Tier>;
+
+    type?: 'match';
+  }
+
+  export namespace CompanyContribution {
+    export interface Tier {
+      match?: number;
+
+      threshold?: number;
+    }
+  }
+}
+
 export interface BenefitUpdateParams {
   /**
    * Updated name or description.

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

@@ -12,6 +12,15 @@ export class Individuals extends APIResource {
    * operation. If the employee is already enrolled, the enrollment amounts will be
    * adjusted. Making the same request multiple times will not create new
    * enrollments, but will continue to set the state of the existing enrollment.
+   *
+   * @example
+   * ```ts
+   * const enrolledIndividualBenefitResponse =
+   *   await client.hris.benefits.individuals.enrollMany(
+   *     'benefit_id',
+   *     [{}],
+   *   );
+   * ```
    */
   enrollMany(
     benefitId: string,
@@ -35,6 +44,14 @@ export class Individuals extends APIResource {
 
   /**
    * Lists individuals currently enrolled in a given deduction.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.hris.benefits.individuals.enrolledIds(
+   *     'benefit_id',
+   *   );
+   * ```
    */
   enrolledIds(
     benefitId: string,
@@ -45,6 +62,16 @@ export class Individuals extends APIResource {
 
   /**
    * Get enrollment information for the given individuals.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(
+   *   'benefit_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   retrieveManyBenefits(
     benefitId: string,
@@ -72,6 +99,14 @@ export class Individuals extends APIResource {
 
   /**
    * Unenroll individuals from a deduction or contribution
+   *
+   * @example
+   * ```ts
+   * const unenrolledIndividualBenefitResponse =
+   *   await client.hris.benefits.individuals.unenrollMany(
+   *     'benefit_id',
+   *   );
+   * ```
    */
   unenrollMany(
     benefitId: string,

package/src/resources/hris/company/company.ts

@@ -18,6 +18,11 @@ export class CompanyResource extends APIResource {
 
   /**
    * Read basic company data
+   *
+   * @example
+   * ```ts
+   * const company = await client.hris.company.retrieve();
+   * ```
    */
   retrieve(options?: Core.RequestOptions): Core.APIPromise<Company> {
     return this._client.get('/employer/company', options);
@@ -74,40 +79,40 @@ export namespace Company {
     /**
      * The name of the bank associated in the payroll/HRIS system.
      */
-    account_name?: string | null;
+    account_name: string | null;
 
     /**
      * 10-12 digit number to specify the bank account
      */
-    account_number?: string | null;
+    account_number: string | null;
 
     /**
      * The type of bank account.
      */
-    account_type?: 'checking' | 'savings' | null;
+    account_type: 'checking' | 'savings' | null;
 
     /**
      * Name of the banking institution.
      */
-    institution_name?: string | null;
+    institution_name: string | null;
 
     /**
      * A nine-digit code that's based on the U.S. Bank location where your account was
      * opened.
      */
-    routing_number?: string | null;
+    routing_number: string | null;
   }
 
   export interface Department {
     /**
      * The department name.
      */
-    name?: string | null;
+    name: string | null;
 
     /**
      * The parent department, if present.
      */
-    parent?: Department.Parent | null;
+    parent: Department.Parent | null;
   }
 
   export namespace Department {
@@ -118,7 +123,7 @@ export namespace Company {
       /**
        * The parent department's name.
        */
-      name?: string | null;
+      name: string | null;
     }
   }
 
@@ -129,12 +134,12 @@ export namespace Company {
     /**
      * The tax payer subtype of the company.
      */
-    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
+    subtype: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
 
     /**
      * The tax payer type of the company.
      */
-    type?:
+    type:
       | 'llc'
       | 'lp'
       | 'corporation'

package/src/resources/hris/company/pay-statement-item/pay-statement-item.ts

@@ -23,6 +23,14 @@ export class PayStatementItem extends APIResource {
    * **Beta:** this endpoint currently serves employers onboarded after March 4th and
    * historical support will be added soon Retrieve a list of detailed pay statement
    * items for the access token's connection account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: PayStatementItemListParams,

package/src/resources/hris/company/pay-statement-item/rules.ts

@@ -13,6 +13,12 @@ export class Rules extends APIResource {
    * example, pay statement items that meet certain conditions can be labeled as a
    * pre-tax 401k. This metadata can be retrieved where pay statement item
    * information is available.
+   *
+   * @example
+   * ```ts
+   * const rule =
+   *   await client.hris.company.payStatementItem.rules.create();
+   * ```
    */
   create(body?: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
   create(options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
@@ -29,6 +35,14 @@ export class Rules extends APIResource {
   /**
    * **Beta:** this endpoint currently serves employers onboarded after March 4th and
    * historical support will be added soon Update a rule for a pay statement item.
+   *
+   * @example
+   * ```ts
+   * const rule =
+   *   await client.hris.company.payStatementItem.rules.update(
+   *     'rule_id',
+   *   );
+   * ```
    */
   update(
     ruleId: string,
@@ -50,6 +64,14 @@ export class Rules extends APIResource {
   /**
    * **Beta:** this endpoint currently serves employers onboarded after March 4th and
    * historical support will be added soon List all rules of a connection account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(options?: Core.RequestOptions): Core.PagePromise<RuleListResponsesPage, RuleListResponse> {
     return this._client.getAPIList('/employer/pay-statement-item/rule', RuleListResponsesPage, options);
@@ -58,6 +80,14 @@ export class Rules extends APIResource {
   /**
    * **Beta:** this endpoint currently serves employers onboarded after March 4th and
    * historical support will be added soon Delete a rule for a pay statement item.
+   *
+   * @example
+   * ```ts
+   * const rule =
+   *   await client.hris.company.payStatementItem.rules.delete(
+   *     'rule_id',
+   *   );
+   * ```
    */
   delete(ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse> {
     return this._client.delete(`/employer/pay-statement-item/rule/${ruleId}`, options);

package/src/resources/hris/directory.ts

@@ -8,6 +8,14 @@ import { IndividualsPage, type IndividualsPageParams } from '../../pagination';
 export class Directory extends APIResource {
   /**
    * Read company directory and organization structure
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const individualInDirectory of client.hris.directory.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: DirectoryListParams,
@@ -34,37 +42,37 @@ export interface IndividualInDirectory {
   /**
    * A stable Finch `id` (UUID v4) for an individual in the company.
    */
-  id?: string;
+  id: string;
 
   /**
    * The department object.
    */
-  department?: IndividualInDirectory.Department | null;
+  department: IndividualInDirectory.Department | null;
 
   /**
    * The legal first name of the individual.
    */
-  first_name?: string | null;
+  first_name: string | null;
 
   /**
    * `true` if the individual is an active employee or contractor at the company.
    */
-  is_active?: boolean | null;
+  is_active: boolean | null;
 
   /**
    * The legal last name of the individual.
    */
-  last_name?: string | null;
+  last_name: string | null;
 
   /**
    * The manager object.
    */
-  manager?: IndividualInDirectory.Manager | null;
+  manager: IndividualInDirectory.Manager | null;
 
   /**
    * The legal middle name of the individual.
    */
-  middle_name?: string | null;
+  middle_name: string | null;
 }
 
 export namespace IndividualInDirectory {
@@ -85,7 +93,7 @@ export namespace IndividualInDirectory {
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      */
-    id?: string;
+    id: string;
   }
 }
 

package/src/resources/hris/documents.ts

@@ -9,6 +9,11 @@ export class Documents extends APIResource {
   /**
    * **Beta:** This endpoint is in beta and may change. Retrieve a list of
    * company-wide documents.
+   *
+   * @example
+   * ```ts
+   * const documents = await client.hris.documents.list();
+   * ```
    */
   list(query?: DocumentListParams, options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
@@ -25,6 +30,13 @@ export class Documents extends APIResource {
   /**
    * **Beta:** This endpoint is in beta and may change. Retrieve details of a
    * specific document by its ID.
+   *
+   * @example
+   * ```ts
+   * const response = await client.hris.documents.retreive(
+   *   'document_id',
+   * );
+   * ```
    */
   retreive(documentId: string, options?: Core.RequestOptions): Core.APIPromise<DocumentRetreiveResponse> {
     return this._client.get(`/employer/documents/${documentId}`, options);