@rippling/rippling-sdk 0.2.0-alpha.28 → 0.2.0-alpha.30

package/resources/object-categories.d.ts

@@ -7,25 +7,25 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class ObjectCategories extends APIResource {
     /**
-     * A List of object categories
+     * A list of object categories.
      *
      * - Requires: `API Tier 1`
      */
     list(options?: RequestOptions): PagePromise<ObjectCategoriesPageCursorURL, ObjectCategory>;
     /**
-     * Create a new object category
+     * Create a new object category.
      */
     create(body?: ObjectCategoryCreateParams | null | undefined, options?: RequestOptions): APIPromise<ObjectCategory>;
     /**
-     * Retrieve a specific object category
+     * Retrieve a specific object category.
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<ObjectCategory>;
     /**
-     * Updated a specific object category
+     * Update a specific object category.
      */
     update(id: string, body?: ObjectCategoryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<ObjectCategory>;
     /**
-     * Delete a object category
+     * Delete a object category.
      */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
 }
@@ -53,11 +53,23 @@ export interface ObjectCategory {
     description?: string;
 }
 export interface ObjectCategoryCreateParams {
+    /**
+     * A description of the category.
+     */
     description?: string;
+    /**
+     * The name of the category.
+     */
     name?: string;
 }
 export interface ObjectCategoryUpdateParams {
+    /**
+     * A description of the category.
+     */
     description?: string;
+    /**
+     * The name of the category.
+     */
     name?: string;
 }
 export declare namespace ObjectCategories {

package/resources/object-categories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object-categories.d.ts","sourceRoot":"","sources":["../src/resources/object-categories.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAE9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,6BAA6B,EAAE,cAAc,CAAC;IAI1F;;OAEG;IACH,MAAM,CACJ,IAAI,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI1E;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;AAE1E,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
+{"version":3,"file":"object-categories.d.ts","sourceRoot":"","sources":["../src/resources/object-categories.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAE9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,6BAA6B,EAAE,cAAc,CAAC;IAI1F;;OAEG;IACH,MAAM,CACJ,IAAI,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI1E;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;AAE1E,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/object-categories.js

@@ -11,7 +11,7 @@ const path_1 = require("../internal/utils/path.js");
  */
 class ObjectCategories extends resource_1.APIResource {
     /**
-     * A List of object categories
+     * A list of object categories.
      *
      * - Requires: `API Tier 1`
      */
@@ -19,25 +19,25 @@ class ObjectCategories extends resource_1.APIResource {
         return this._client.getAPIList('/object-categories/', (pagination_1.PageCursorURL), options);
     }
     /**
-     * Create a new object category
+     * Create a new object category.
      */
     create(body = {}, options) {
         return this._client.post('/object-categories/', { body, ...options });
     }
     /**
-     * Retrieve a specific object category
+     * Retrieve a specific object category.
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/object-categories/${id}/`, options);
     }
     /**
-     * Updated a specific object category
+     * Update a specific object category.
      */
     update(id, body = {}, options) {
         return this._client.patch((0, path_1.path) `/object-categories/${id}/`, { body, ...options });
     }
     /**
-     * Delete a object category
+     * Delete a object category.
      */
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/object-categories/${id}/`, {

package/resources/object-categories.mjs

@@ -8,7 +8,7 @@ import { path } from "../internal/utils/path.mjs";
  */
 export class ObjectCategories extends APIResource {
     /**
-     * A List of object categories
+     * A list of object categories.
      *
      * - Requires: `API Tier 1`
      */
@@ -16,25 +16,25 @@ export class ObjectCategories extends APIResource {
         return this._client.getAPIList('/object-categories/', (PageCursorURL), options);
     }
     /**
-     * Create a new object category
+     * Create a new object category.
      */
     create(body = {}, options) {
         return this._client.post('/object-categories/', { body, ...options });
     }
     /**
-     * Retrieve a specific object category
+     * Retrieve a specific object category.
      */
     retrieve(id, options) {
         return this._client.get(path `/object-categories/${id}/`, options);
     }
     /**
-     * Updated a specific object category
+     * Update a specific object category.
      */
     update(id, body = {}, options) {
         return this._client.patch(path `/object-categories/${id}/`, { body, ...options });
     }
     /**
-     * Delete a object category
+     * Delete a object category.
      */
     delete(id, options) {
         return this._client.delete(path `/object-categories/${id}/`, {

package/resources/payroll-runs.d.mts

@@ -0,0 +1,195 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Payroll runs for the company
+ */
+export declare class PayrollRuns extends APIResource {
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Payroll API`
+     * - Sortable fields: `check_date`
+     */
+    list(query?: PayrollRunListParams | null | undefined, options?: RequestOptions): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse>;
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse>;
+}
+export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
+/**
+ * V2 DTO representing a single payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/      (list)
+ *       - GET /payroll-runs/{id}  (retrieve)
+ */
+export interface PayrollRunListResponse {
+    /**
+     * Unique identifier for the payroll run.
+     */
+    id?: string;
+    /**
+     * Deadline for approving the payroll run.
+     */
+    approval_deadline?: string;
+    /**
+     * Timestamp when the run was approved.
+     */
+    approved_at?: string;
+    /**
+     * Date the paycheck is issued.
+     */
+    check_date?: string;
+    /**
+     * Identifier linking this payroll run to the company's legal entity in the HRIS
+     * system.
+     */
+    company_entity_id?: string;
+    /**
+     * ISO country code where the payroll run applies.
+     */
+    country_code?: string;
+    /**
+     * Date funds are debited from the company's account.
+     */
+    debit_date?: string;
+    /**
+     * Deadline after which the run is locked for changes.
+     */
+    lock_deadline?: string;
+    /**
+     * Timestamp when the run was marked as paid.
+     */
+    paid_at?: string;
+    /**
+     * Pay period details for this run.
+     */
+    pay_period?: PayrollRunListResponse.PayPeriod;
+    /**
+     * Payment method used (e.g. WIRE, ACH).
+     */
+    payment_type?: string;
+    /**
+     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+     */
+    run_state?: string;
+    /**
+     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+     */
+    run_type?: string;
+    /**
+     * Human-readable title of the payroll run.
+     */
+    title?: string;
+}
+export declare namespace PayrollRunListResponse {
+    /**
+     * Pay period details for this run.
+     */
+    interface PayPeriod {
+        /**
+         * End date of the pay period.
+         */
+        end_date?: string;
+        /**
+         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+         */
+        pay_frequency?: string;
+        /**
+         * Start date of the pay period.
+         */
+        start_date?: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Unique identifier for the payroll run.
+     */
+    id?: string;
+    /**
+     * Deadline for approving the payroll run.
+     */
+    approval_deadline?: string;
+    /**
+     * Timestamp when the run was approved.
+     */
+    approved_at?: string;
+    /**
+     * Date the paycheck is issued.
+     */
+    check_date?: string;
+    /**
+     * Identifier linking this payroll run to the company's legal entity in the HRIS
+     * system.
+     */
+    company_entity_id?: string;
+    /**
+     * ISO country code where the payroll run applies.
+     */
+    country_code?: string;
+    /**
+     * Date funds are debited from the company's account.
+     */
+    debit_date?: string;
+    /**
+     * Deadline after which the run is locked for changes.
+     */
+    lock_deadline?: string;
+    /**
+     * Timestamp when the run was marked as paid.
+     */
+    paid_at?: string;
+    /**
+     * Pay period details for this run.
+     */
+    pay_period?: PayrollRunRetrieveResponse.PayPeriod;
+    /**
+     * Payment method used (e.g. WIRE, ACH).
+     */
+    payment_type?: string;
+    /**
+     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+     */
+    run_state?: string;
+    /**
+     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+     */
+    run_type?: string;
+    /**
+     * Human-readable title of the payroll run.
+     */
+    title?: string;
+}
+export declare namespace PayrollRunRetrieveResponse {
+    /**
+     * Pay period details for this run.
+     */
+    interface PayPeriod {
+        /**
+         * End date of the pay period.
+         */
+        end_date?: string;
+        /**
+         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+         */
+        pay_frequency?: string;
+        /**
+         * Start date of the pay period.
+         */
+        start_date?: string;
+    }
+}
+export interface PayrollRunListParams {
+    order_by?: string;
+}
+export declare namespace PayrollRuns {
+    export { type PayrollRunListResponse as PayrollRunListResponse, type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse, type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL, type PayrollRunListParams as PayrollRunListParams, };
+}
+//# sourceMappingURL=payroll-runs.d.mts.map

package/resources/payroll-runs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.d.mts","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,sBAAsB,CAAC;IAO5E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGvF;AAED,MAAM,MAAM,oCAAoC,GAAG,aAAa,CAAC,sBAAsB,CAAC,CAAC;AAEzF;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB,CAAC,IAAI;IAC1E;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC,SAAS,CAAC;IAElD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/payroll-runs.d.ts

@@ -0,0 +1,195 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Payroll runs for the company
+ */
+export declare class PayrollRuns extends APIResource {
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Payroll API`
+     * - Sortable fields: `check_date`
+     */
+    list(query?: PayrollRunListParams | null | undefined, options?: RequestOptions): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse>;
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse>;
+}
+export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
+/**
+ * V2 DTO representing a single payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/      (list)
+ *       - GET /payroll-runs/{id}  (retrieve)
+ */
+export interface PayrollRunListResponse {
+    /**
+     * Unique identifier for the payroll run.
+     */
+    id?: string;
+    /**
+     * Deadline for approving the payroll run.
+     */
+    approval_deadline?: string;
+    /**
+     * Timestamp when the run was approved.
+     */
+    approved_at?: string;
+    /**
+     * Date the paycheck is issued.
+     */
+    check_date?: string;
+    /**
+     * Identifier linking this payroll run to the company's legal entity in the HRIS
+     * system.
+     */
+    company_entity_id?: string;
+    /**
+     * ISO country code where the payroll run applies.
+     */
+    country_code?: string;
+    /**
+     * Date funds are debited from the company's account.
+     */
+    debit_date?: string;
+    /**
+     * Deadline after which the run is locked for changes.
+     */
+    lock_deadline?: string;
+    /**
+     * Timestamp when the run was marked as paid.
+     */
+    paid_at?: string;
+    /**
+     * Pay period details for this run.
+     */
+    pay_period?: PayrollRunListResponse.PayPeriod;
+    /**
+     * Payment method used (e.g. WIRE, ACH).
+     */
+    payment_type?: string;
+    /**
+     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+     */
+    run_state?: string;
+    /**
+     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+     */
+    run_type?: string;
+    /**
+     * Human-readable title of the payroll run.
+     */
+    title?: string;
+}
+export declare namespace PayrollRunListResponse {
+    /**
+     * Pay period details for this run.
+     */
+    interface PayPeriod {
+        /**
+         * End date of the pay period.
+         */
+        end_date?: string;
+        /**
+         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+         */
+        pay_frequency?: string;
+        /**
+         * Start date of the pay period.
+         */
+        start_date?: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Unique identifier for the payroll run.
+     */
+    id?: string;
+    /**
+     * Deadline for approving the payroll run.
+     */
+    approval_deadline?: string;
+    /**
+     * Timestamp when the run was approved.
+     */
+    approved_at?: string;
+    /**
+     * Date the paycheck is issued.
+     */
+    check_date?: string;
+    /**
+     * Identifier linking this payroll run to the company's legal entity in the HRIS
+     * system.
+     */
+    company_entity_id?: string;
+    /**
+     * ISO country code where the payroll run applies.
+     */
+    country_code?: string;
+    /**
+     * Date funds are debited from the company's account.
+     */
+    debit_date?: string;
+    /**
+     * Deadline after which the run is locked for changes.
+     */
+    lock_deadline?: string;
+    /**
+     * Timestamp when the run was marked as paid.
+     */
+    paid_at?: string;
+    /**
+     * Pay period details for this run.
+     */
+    pay_period?: PayrollRunRetrieveResponse.PayPeriod;
+    /**
+     * Payment method used (e.g. WIRE, ACH).
+     */
+    payment_type?: string;
+    /**
+     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+     */
+    run_state?: string;
+    /**
+     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+     */
+    run_type?: string;
+    /**
+     * Human-readable title of the payroll run.
+     */
+    title?: string;
+}
+export declare namespace PayrollRunRetrieveResponse {
+    /**
+     * Pay period details for this run.
+     */
+    interface PayPeriod {
+        /**
+         * End date of the pay period.
+         */
+        end_date?: string;
+        /**
+         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+         */
+        pay_frequency?: string;
+        /**
+         * Start date of the pay period.
+         */
+        start_date?: string;
+    }
+}
+export interface PayrollRunListParams {
+    order_by?: string;
+}
+export declare namespace PayrollRuns {
+    export { type PayrollRunListResponse as PayrollRunListResponse, type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse, type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL, type PayrollRunListParams as PayrollRunListParams, };
+}
+//# sourceMappingURL=payroll-runs.d.ts.map

package/resources/payroll-runs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.d.ts","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,sBAAsB,CAAC;IAO5E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGvF;AAED,MAAM,MAAM,oCAAoC,GAAG,aAAa,CAAC,sBAAsB,CAAC,CAAC;AAEzF;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB,CAAC,IAAI;IAC1E;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC,SAAS,CAAC;IAElD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/payroll-runs.js

@@ -0,0 +1,32 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayrollRuns = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Payroll runs for the company
+ */
+class PayrollRuns extends resource_1.APIResource {
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Payroll API`
+     * - Sortable fields: `check_date`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/payroll-runs/', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/payroll-runs/${id}/`, options);
+    }
+}
+exports.PayrollRuns = PayrollRuns;
+//# sourceMappingURL=payroll-runs.js.map

package/resources/payroll-runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.js","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;OAKG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,0BAAqC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAvBD,kCAuBC"}

package/resources/payroll-runs.mjs

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Payroll runs for the company
+ */
+export class PayrollRuns extends APIResource {
+    /**
+     * A list of payroll-runs.
+     *
+     * - Requires: `Payroll API`
+     * - Sortable fields: `check_date`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/payroll-runs/', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve a specific payroll-run
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/payroll-runs/${id}/`, options);
+    }
+}
+//# sourceMappingURL=payroll-runs.mjs.map

package/resources/payroll-runs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"payroll-runs.mjs","sourceRoot":"","sources":["../src/resources/payroll-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAe;OAE9B,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;OAKG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,aAAqC,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}

package/resources/platform-capabilities.d.mts

@@ -6,9 +6,9 @@ import { RequestOptions } from "../internal/request-options.mjs";
  */
 export declare class PlatformCapabilities extends APIResource {
     /**
-     * A List of platform capabilities
+     * A list of platform capabilities.
      *
-     * - Requires: `API Tier 1`
+     * - Requires: `Platform Capabilities API`
      */
     list(options?: RequestOptions): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse>;
 }

package/resources/platform-capabilities.d.ts

@@ -6,9 +6,9 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class PlatformCapabilities extends APIResource {
     /**
-     * A List of platform capabilities
+     * A list of platform capabilities.
      *
-     * - Requires: `API Tier 1`
+     * - Requires: `Platform Capabilities API`
      */
     list(options?: RequestOptions): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse>;
 }

package/resources/platform-capabilities.js

@@ -9,9 +9,9 @@ const pagination_1 = require("../core/pagination.js");
  */
 class PlatformCapabilities extends resource_1.APIResource {
     /**
-     * A List of platform capabilities
+     * A list of platform capabilities.
      *
-     * - Requires: `API Tier 1`
+     * - Requires: `Platform Capabilities API`
      */
     list(options) {
         return this._client.getAPIList('/platform-capabilities/', (pagination_1.PageCursorURL), options);

package/resources/platform-capabilities.mjs

@@ -6,9 +6,9 @@ import { PageCursorURL } from "../core/pagination.mjs";
  */
 export class PlatformCapabilities extends APIResource {
     /**
-     * A List of platform capabilities
+     * A list of platform capabilities.
      *
-     * - Requires: `API Tier 1`
+     * - Requires: `Platform Capabilities API`
      */
     list(options) {
         return this._client.getAPIList('/platform-capabilities/', (PageCursorURL), options);