@tryfinch/finch-api 6.26.0 → 6.28.0

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

@@ -3,10 +3,25 @@ import * as Core from "../../../core.js";
 export declare class Configuration extends APIResource {
     /**
      * Get configurations for sandbox jobs
+     *
+     * @example
+     * ```ts
+     * const sandboxJobConfigurations =
+     *   await client.sandbox.jobs.configuration.retrieve();
+     * ```
      */
     retrieve(options?: Core.RequestOptions): Core.APIPromise<ConfigurationRetrieveResponse>;
     /**
      * Update configurations for sandbox jobs
+     *
+     * @example
+     * ```ts
+     * const sandboxJobConfiguration =
+     *   await client.sandbox.jobs.configuration.update({
+     *     completion_status: 'complete',
+     *     type: 'data_sync_all',
+     *   });
+     * ```
      */
     update(body: ConfigurationUpdateParams, options?: Core.RequestOptions): Core.APIPromise<SandboxJobConfiguration>;
 }

package/resources/sandbox/jobs/configuration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/configuration.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAIvF;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG5C;AAED,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,mBAAmB,GAAG,OAAO,CAAC;IAE/E,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAE3E,MAAM,WAAW,yBAAyB;IACxC,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,mBAAmB,GAAG,OAAO,CAAC;IAE/E,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/configuration.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAIvF;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG5C;AAED,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,mBAAmB,GAAG,OAAO,CAAC;IAE/E,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAE3E,MAAM,WAAW,yBAAyB;IACxC,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,mBAAmB,GAAG,OAAO,CAAC;IAE/E,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/sandbox/jobs/configuration.js

@@ -6,12 +6,27 @@ const resource_1 = require("../../../resource.js");
 class Configuration extends resource_1.APIResource {
     /**
      * Get configurations for sandbox jobs
+     *
+     * @example
+     * ```ts
+     * const sandboxJobConfigurations =
+     *   await client.sandbox.jobs.configuration.retrieve();
+     * ```
      */
     retrieve(options) {
         return this._client.get('/sandbox/jobs/configuration', options);
     }
     /**
      * Update configurations for sandbox jobs
+     *
+     * @example
+     * ```ts
+     * const sandboxJobConfiguration =
+     *   await client.sandbox.jobs.configuration.update({
+     *     completion_status: 'complete',
+     *     type: 'data_sync_all',
+     *   });
+     * ```
      */
     update(body, options) {
         return this._client.put('/sandbox/jobs/configuration', { body, ...options });

package/resources/sandbox/jobs/configuration.js.map

@@ -1 +1 @@
-{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/configuration.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAjBD,sCAiBC"}
+{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/configuration.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAhCD,sCAgCC"}

package/resources/sandbox/jobs/configuration.mjs

@@ -3,12 +3,27 @@ import { APIResource } from "../../../resource.mjs";
 export class Configuration extends APIResource {
     /**
      * Get configurations for sandbox jobs
+     *
+     * @example
+     * ```ts
+     * const sandboxJobConfigurations =
+     *   await client.sandbox.jobs.configuration.retrieve();
+     * ```
      */
     retrieve(options) {
         return this._client.get('/sandbox/jobs/configuration', options);
     }
     /**
      * Update configurations for sandbox jobs
+     *
+     * @example
+     * ```ts
+     * const sandboxJobConfiguration =
+     *   await client.sandbox.jobs.configuration.update({
+     *     completion_status: 'complete',
+     *     type: 'data_sync_all',
+     *   });
+     * ```
      */
     update(body, options) {
         return this._client.put('/sandbox/jobs/configuration', { body, ...options });

package/resources/sandbox/jobs/configuration.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"configuration.mjs","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/configuration.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}
+{"version":3,"file":"configuration.mjs","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/configuration.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}

package/resources/sandbox/jobs/jobs.d.ts

@@ -6,6 +6,13 @@ export declare class Jobs extends APIResource {
     configuration: ConfigurationAPI.Configuration;
     /**
      * Enqueue a new sandbox job
+     *
+     * @example
+     * ```ts
+     * const job = await client.sandbox.jobs.create({
+     *   type: 'data_sync_all',
+     * });
+     * ```
      */
     create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<JobCreateResponse>;
 }

package/resources/sandbox/jobs/jobs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/jobs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,gBAAgB,MAAM,iBAAiB,CAAC;AACpD,OAAO,EACL,aAAa,EACb,6BAA6B,EAC7B,yBAAyB,EACzB,uBAAuB,EACxB,MAAM,iBAAiB,CAAC;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAGjG;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;IAEhG,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/jobs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,gBAAgB,MAAM,iBAAiB,CAAC;AACpD,OAAO,EACL,aAAa,EACb,6BAA6B,EAC7B,yBAAyB,EACzB,uBAAuB,EACxB,MAAM,iBAAiB,CAAC;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAGjG;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;IAEhG,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/sandbox/jobs/jobs.js

@@ -35,6 +35,13 @@ class Jobs extends resource_1.APIResource {
     }
     /**
      * Enqueue a new sandbox job
+     *
+     * @example
+     * ```ts
+     * const job = await client.sandbox.jobs.create({
+     *   type: 'data_sync_all',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/sandbox/jobs', { body, ...options });

package/resources/sandbox/jobs/jobs.js.map

@@ -1 +1 @@
-{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/jobs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAEhD,qEAAoD;AACpD,sDAKyB;AAEzB,MAAa,IAAK,SAAQ,sBAAW;IAArC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAQnG,CAAC;IANC;;OAEG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AATD,oBASC;AA+BD,IAAI,CAAC,aAAa,GAAG,6BAAa,CAAC"}
+{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/jobs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAEhD,qEAAoD;AACpD,sDAKyB;AAEzB,MAAa,IAAK,SAAQ,sBAAW;IAArC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAenG,CAAC;IAbC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAhBD,oBAgBC;AA+BD,IAAI,CAAC,aAAa,GAAG,6BAAa,CAAC"}

package/resources/sandbox/jobs/jobs.mjs

@@ -9,6 +9,13 @@ export class Jobs extends APIResource {
     }
     /**
      * Enqueue a new sandbox job
+     *
+     * @example
+     * ```ts
+     * const job = await client.sandbox.jobs.create({
+     *   type: 'data_sync_all',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/sandbox/jobs', { body, ...options });

package/resources/sandbox/jobs/jobs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"jobs.mjs","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/jobs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,gBAAgB;OACrB,EACL,aAAa,GAId;AAED,MAAM,OAAO,IAAK,SAAQ,WAAW;IAArC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAQnG,CAAC;IANC;;OAEG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA+BD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC"}
+{"version":3,"file":"jobs.mjs","sourceRoot":"","sources":["../../../src/resources/sandbox/jobs/jobs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,gBAAgB;OACrB,EACL,aAAa,GAId;AAED,MAAM,OAAO,IAAK,SAAQ,WAAW;IAArC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAenG,CAAC;IAbC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA+BD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC"}

package/resources/sandbox/payment.d.ts

@@ -5,6 +5,25 @@ import * as BenefitsAPI from "../hris/benefits/benefits.js";
 export declare class Payment extends APIResource {
     /**
      * Add a new sandbox payment
+     *
+     * @example
+     * ```ts
+     * const payment = await client.sandbox.payment.create({
+     *   pay_statements: [
+     *     {
+     *       individual_id: 'b2338cfb-472f-4f72-9faa-e028c083144a',
+     *       employee_deductions: [
+     *         {
+     *           name: '401k test',
+     *           type: '401k',
+     *           amount: 2000,
+     *           currency: 'usd',
+     *         },
+     *       ],
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(body?: PaymentCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentCreateResponse>;
     create(options?: Core.RequestOptions): Core.APIPromise<PaymentCreateResponse>;

package/resources/sandbox/payment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/payment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,WAAW,MAAM,2BAA2B,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IACzG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;CAU9E;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAEzD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,YAAY;QAC3B;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAErD;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;QAEnD;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;KAC5E;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;YAEvC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;SACV;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;QAED,UAAiB,iBAAiB;YAChC;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;YAEjD;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,iBAAiB,CAAC;YACjC,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;QAED,UAAiB,oBAAoB;YACnC;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;YAEpD;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,oBAAoB,CAAC;YACpC,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;QAED,UAAiB,GAAG;YAClB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;SACtD;QAED,UAAiB,GAAG,CAAC;YACnB,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/payment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,WAAW,MAAM,2BAA2B,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IACzG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;CAU9E;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAEzD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,YAAY;QAC3B;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAErD;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;QAEnD;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;KAC5E;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;YAEvC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;SACV;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;QAED,UAAiB,iBAAiB;YAChC;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;YAEjD;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,iBAAiB,CAAC;YACjC,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;QAED,UAAiB,oBAAoB;YACnC;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;YAEpD;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,oBAAoB,CAAC;YACpC,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;QAED,UAAiB,GAAG;YAClB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;SACtD;QAED,UAAiB,GAAG,CAAC;YACnB,UAAiB,UAAU;gBACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;aAChC;YAED,UAAiB,UAAU,CAAC;gBAC1B,UAAiB,QAAQ;oBACvB;;;;uBAIG;oBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACpC;aACF;SACF;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/sandbox/payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/resources/sandbox/payment.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAK9C,MAAa,OAAQ,SAAQ,sBAAW;IAMtC,MAAM,CACJ,OAAkD,EAAE,EACpD,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,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAfD,0BAeC"}
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/resources/sandbox/payment.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAK9C,MAAa,OAAQ,SAAQ,sBAAW;IAyBtC,MAAM,CACJ,OAAkD,EAAE,EACpD,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,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAlCD,0BAkCC"}

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,
@@ -79,7 +87,7 @@ export 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

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);