@tryfinch/finch-api 6.26.0 → 6.28.0

package/resources/hris/company/company.js

@@ -35,6 +35,11 @@ class CompanyResource extends resource_1.APIResource {
     }
     /**
      * Read basic company data
+     *
+     * @example
+     * ```ts
+     * const company = await client.hris.company.retrieve();
+     * ```
      */
     retrieve(options) {
         return this._client.get('/employer/company', options);

package/resources/hris/company/company.js.map

@@ -1 +1 @@
-{"version":3,"file":"company.js","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAGhD,gGAA+E;AAC/E,mFAKiD;AAEjD,MAAa,eAAgB,SAAQ,sBAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAQJ,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AAXD,0CAWC;AA4HD,eAAe,CAAC,gBAAgB,GAAG,qCAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,sDAAiC,CAAC"}
+{"version":3,"file":"company.js","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAGhD,gGAA+E;AAC/E,mFAKiD;AAEjD,MAAa,eAAgB,SAAQ,sBAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAaJ,CAAC;IAXC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AAhBD,0CAgBC;AA4HD,eAAe,CAAC,gBAAgB,GAAG,qCAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,sDAAiC,CAAC"}

package/resources/hris/company/company.mjs

@@ -9,6 +9,11 @@ export class CompanyResource extends APIResource {
     }
     /**
      * Read basic company data
+     *
+     * @example
+     * ```ts
+     * const company = await client.hris.company.retrieve();
+     * ```
      */
     retrieve(options) {
         return this._client.get('/employer/company', options);

package/resources/hris/company/company.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"company.mjs","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,mBAAmB;OACxB,EACL,gBAAgB,EAGhB,iCAAiC,GAClC;AAED,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAQJ,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA4HD,eAAe,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,iCAAiC,CAAC"}
+{"version":3,"file":"company.mjs","sourceRoot":"","sources":["../../../src/resources/hris/company/company.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,mBAAmB;OACxB,EACL,gBAAgB,EAGhB,iCAAiC,GAClC;AAED,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAAhD;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAaJ,CAAC;IAXC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA4HD,eAAe,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACpD,eAAe,CAAC,iCAAiC,GAAG,iCAAiC,CAAC"}

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

@@ -9,6 +9,14 @@ export declare 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, options?: Core.RequestOptions): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse>;
     list(options?: Core.RequestOptions): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse>;
@@ -43,7 +51,7 @@ export declare namespace PayStatementItemListResponse {
          * The metadata of the pay statement item derived by the rules engine if available.
          * Each attribute will be a key-value pair defined by a rule.
          */
-        metadata?: unknown | null;
+        metadata?: Record<string, unknown> | null;
         /**
          * `true` if the pay statement item is pre-tax. This field is only available for
          * employee deductions.

package/resources/hris/company/pay-statement-item/pay-statement-item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pay-statement-item.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;OAIG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;IACpF,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;CAarF;AAED,qBAAa,iCAAkC,SAAQ,aAAa,CAAC,4BAA4B,CAAC;CAAG;AAErG,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC;IAEnF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC,CAAC;IAE5F;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,iCAAiC,IAAI,iCAAiC,EACtE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"pay-statement-item.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;IACpF,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;CAarF;AAED,qBAAa,iCAAkC,SAAQ,aAAa,CAAC,4BAA4B,CAAC;CAAG;AAErG,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC,UAAU,CAAC;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC;IAEnF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAE1C;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,OAAO,GAAG,qBAAqB,GAAG,wBAAwB,CAAC,CAAC;IAE5F;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,iCAAiC,IAAI,iCAAiC,EACtE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/hris/company/pay-statement-item/pay-statement-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"pay-statement-item.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,qDAAoC;AACpC,sCASiB;AACjB,0DAAuD;AAEvD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0B3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,4CA2BC;AAED,MAAa,iCAAkC,SAAQ,0BAA2C;CAAG;AAArG,8EAAqG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,aAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,6BAAqB,CAAC"}
+{"version":3,"file":"pay-statement-item.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,qDAAoC;AACpC,sCASiB;AACjB,0DAAuD;AAEvD,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkC3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,4CAmCC;AAED,MAAa,iCAAkC,SAAQ,0BAA2C;CAAG;AAArG,8EAAqG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,aAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,6BAAqB,CAAC"}

package/resources/hris/company/pay-statement-item/pay-statement-item.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"pay-statement-item.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,QAAQ;OACb,EAKL,qBAAqB,EAGrB,KAAK,GACN;OACM,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0B3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,iCAAkC,SAAQ,aAA2C;CAAG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
+{"version":3,"file":"pay-statement-item.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/pay-statement-item.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,QAAQ;OACb,EAKL,qBAAqB,EAGrB,KAAK,GACN;OACM,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkC3D,CAAC;IAZC,IAAI,CACF,QAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,iCAAiC,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,iCAAkC,SAAQ,aAA2C;CAAG;AA+ErG,gBAAgB,CAAC,iCAAiC,GAAG,iCAAiC,CAAC;AACvF,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;AAC/B,gBAAgB,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}

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

@@ -9,23 +9,53 @@ export declare 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>;
     /**
      * **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, body?: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
     update(ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
     /**
      * **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>;
     /**
      * **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>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACnG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAW1E;;;OAGG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACtC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAY1F;;;OAGG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAI9F;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAG3F;AAED,qBAAa,qBAAsB,SAAQ,aAAa,CAAC,gBAAgB,CAAC;CAAG;AAE7E,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;CACpC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACnG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAW1E;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACtC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAY1F;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAG3F;AAED,qBAAa,qBAAsB,SAAQ,aAAa,CAAC,gBAAgB,CAAC;CAAG;AAE7E,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE3C,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAEzC,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;CACpC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,qBAAqB,IAAI,qBAAqB,EAC9C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/hris/company/pay-statement-item/rules.js

@@ -21,6 +21,14 @@ class Rules extends resource_1.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) {
         return this._client.getAPIList('/employer/pay-statement-item/rule', RuleListResponsesPage, options);
@@ -28,6 +36,14 @@ class Rules extends resource_1.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, options) {
         return this._client.delete(`/employer/pay-statement-item/rule/${ruleId}`, options);

package/resources/hris/company/pay-statement-item/rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,0DAAuD;AAEvD,MAAa,KAAM,SAAQ,sBAAW;IAWpC,MAAM,CACJ,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAYD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAzDD,sBAyDC;AAED,MAAa,qBAAsB,SAAQ,0BAA+B;CAAG;AAA7E,sDAA6E;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAEpD,0DAAuD;AAEvD,MAAa,KAAM,SAAQ,sBAAW;IAiBpC,MAAM,CACJ,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAoBD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAvFD,sBAuFC;AAED,MAAa,qBAAsB,SAAQ,0BAA+B;CAAG;AAA7E,sDAA6E;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}

package/resources/hris/company/pay-statement-item/rules.mjs

@@ -18,6 +18,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) {
         return this._client.getAPIList('/employer/pay-statement-item/rule', RuleListResponsesPage, options);
@@ -25,6 +33,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, options) {
         return this._client.delete(`/employer/pay-statement-item/rule/${ruleId}`, options);

package/resources/hris/company/pay-statement-item/rules.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"rules.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAWpC,MAAM,CACJ,OAA+C,EAAE,EACjD,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,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAYD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,aAA+B;CAAG;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}
+{"version":3,"file":"rules.mjs","sourceRoot":"","sources":["../../../../src/resources/hris/company/pay-statement-item/rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAiBpC,MAAM,CACJ,OAA+C,EAAE,EACjD,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,mCAAmC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAoBD,MAAM,CACJ,MAAc,EACd,OAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mCAAmC,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qCAAqC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,aAA+B;CAAG;AAyW7E,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}

package/resources/hris/directory.d.ts

@@ -4,6 +4,14 @@ import { IndividualsPage, type IndividualsPageParams } from "../../pagination.js
 export declare 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, options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
     list(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
@@ -19,31 +27,31 @@ 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 declare namespace IndividualInDirectory {
     /**
@@ -62,7 +70,7 @@ export declare namespace IndividualInDirectory {
         /**
          * A stable Finch `id` (UUID v4) for an individual in the company.
          */
-        id?: string;
+        id: string;
     }
 }
 export interface DirectoryListParams extends IndividualsPageParams {

package/resources/hris/directory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAW7F;;OAEG;IACH,eAAe;iBAjBL,mBAAmB,YACjB,KAAK,cAAc,GAC5B,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;mBAC5C,KAAK,cAAc,GAAG,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;MAcjE;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,UAAU,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;CAAG;AAEhF,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAW7F;;OAEG;IACH,eAAe;iBAjBL,mBAAmB,YACjB,KAAK,cAAc,GAC5B,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;mBAC5C,KAAK,cAAc,GAAG,KAAK,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC;MAcjE;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;CAAG;AAEhF,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/hris/directory.js.map

@@ -1 +1 @@
-{"version":3,"file":"directory.js","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAA+E;AAE/E,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QAmBE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,4BAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF;AAvBD,8BAuBC"}
+{"version":3,"file":"directory.js","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAA+E;AAE/E,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QA2BE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,4BAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF;AA/BD,8BA+BC"}

package/resources/hris/directory.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"directory.mjs","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,eAAe,EAA8B;AAEtD,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QAmBE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF"}
+{"version":3,"file":"directory.mjs","sourceRoot":"","sources":["../../src/resources/hris/directory.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,eAAe,EAA8B;AAEtD,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QA2BE;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAdC,IAAI,CACF,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CAMF"}

package/resources/hris/documents.d.ts

@@ -5,12 +5,24 @@ export declare 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>;
     /**
      * **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>;
 }

package/resources/hris/documents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IACtG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAW1E;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAGvG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE7B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,SAAS,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;QAEpC;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,GAAG,4CAA4C,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE3F;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5C;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EACV,mBAAmB,GACnB,uDAAuD,GACvD,qCAAqC,GACrC,IAAI,CAAC;QAET;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEnC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IACtG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAW1E;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAGvG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAE7B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,SAAS,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;QAEpC;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,GAAG,4CAA4C,GAAG,QAAQ,GAAG,IAAI,CAAC;QAE3F;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5C;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,aAAa,CAAC,EACV,mBAAmB,GACnB,uDAAuD,GACvD,qCAAqC,GACrC,IAAI,CAAC;QAET;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,uCAAuC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEnC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/hris/documents.js

@@ -14,6 +14,13 @@ class Documents extends resource_1.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, options) {
         return this._client.get(`/employer/documents/${documentId}`, options);

package/resources/hris/documents.js.map

@@ -1 +1 @@
-{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,SAAU,SAAQ,sBAAW;IAOxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AAxBD,8BAwBC"}
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,SAAU,SAAQ,sBAAW;IAYxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AApCD,8BAoCC"}

package/resources/hris/documents.mjs

@@ -11,6 +11,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, options) {
         return this._client.get(`/employer/documents/${documentId}`, options);

package/resources/hris/documents.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"documents.mjs","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,SAAU,SAAQ,WAAW;IAOxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF"}
+{"version":3,"file":"documents.mjs","sourceRoot":"","sources":["../../src/resources/hris/documents.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,SAAU,SAAQ,WAAW;IAYxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF"}