@rippling/rippling-sdk 0.2.0-alpha.100

package/resources/payroll-runs/worker-payroll-records.d.ts

@@ -0,0 +1,204 @@
+import { APIResource } from "../../core/resource.js";
+import { PageCursorURL, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Payroll runs for the company
+ */
+export declare class WorkerPayrollRecords extends APIResource {
+    /**
+     * A list of worker-payroll-records for a payroll run. Supports filtering by worker
+     * via `filter=worker_id in ('<id1>', '<id2>')`.
+     *
+     * - Requires: `Global Payroll`
+     */
+    list(runID: string, query?: WorkerPayrollRecordListParams | null | undefined, options?: RequestOptions): PagePromise<WorkerPayrollRecordListResponsesPageCursorURL, WorkerPayrollRecordListResponse>;
+}
+export type WorkerPayrollRecordListResponsesPageCursorURL = PageCursorURL<WorkerPayrollRecordListResponse>;
+/**
+ * V2 DTO representing earnings, deductions, taxes, and garnishments
+ *     for a single worker in a payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/{run_id}/worker-payroll-records/      (list)
+ *       - GET /payroll-runs/{run_id}/worker-payroll-records/{id}   (retrieve)
+ */
+export interface WorkerPayrollRecordListResponse {
+    /**
+     * Unique identifier for this payroll record (PRE version ID).
+     */
+    id?: string;
+    /**
+     * ISO country code where this payroll record applies.
+     */
+    country_code?: string;
+    /**
+     * ISO currency code for monetary amounts in this record.
+     */
+    currency?: string;
+    /**
+     * List of deduction line items.
+     */
+    deductions?: Array<WorkerPayrollRecordListResponse.Deduction>;
+    /**
+     * List of earning line items.
+     */
+    earnings?: Array<WorkerPayrollRecordListResponse.Earning>;
+    /**
+     * List of garnishment line items.
+     */
+    garnishments?: Array<WorkerPayrollRecordListResponse.Garnishment>;
+    /**
+     * Gross pay amount for the current period.
+     */
+    gross_pay?: string;
+    /**
+     * Net pay amount for the current period.
+     */
+    net_pay?: string;
+    /**
+     * Identifier of the payroll run this record belongs to.
+     */
+    run_id?: string;
+    /**
+     * Aggregate totals for taxes, deductions, and garnishments.
+     */
+    summary?: WorkerPayrollRecordListResponse.Summary;
+    /**
+     * List of tax line items.
+     */
+    taxes?: Array<WorkerPayrollRecordListResponse.Tax>;
+    /**
+     * Identifier of the worker (role ID).
+     */
+    worker_id?: string;
+}
+export declare namespace WorkerPayrollRecordListResponse {
+    /**
+     * A single deduction line item on a worker's payroll record.
+     */
+    interface Deduction {
+        /**
+         * Code identifying the deduction type.
+         */
+        deduction_code?: string;
+        /**
+         * Human-readable name of the deduction.
+         */
+        display_name?: string;
+        /**
+         * Employee contribution amount for the current period.
+         */
+        employee_amount?: string;
+        /**
+         * Employer contribution amount for the current period.
+         */
+        employer_amount?: string;
+    }
+    /**
+     * A single earning line item on a worker's payroll record.
+     */
+    interface Earning {
+        /**
+         * Earning amount for the current period.
+         */
+        amount?: string;
+        /**
+         * Human-readable name of the earning.
+         */
+        display_name?: string;
+        /**
+         * Category of the earning (e.g. SALARY, HOURLY).
+         */
+        earning_category?: string;
+        /**
+         * Code identifying the earning type (e.g. regular_salary).
+         */
+        earning_code?: string;
+        /**
+         * Hours worked for this earning in the current period.
+         */
+        hours?: string;
+        /**
+         * Hourly rate applied to this earning.
+         */
+        rate?: string;
+        /**
+         * Time tracking labels associated with this earning.
+         */
+        time_labels?: Array<string>;
+    }
+    /**
+     * A single garnishment line item on a worker's payroll record.
+     */
+    interface Garnishment {
+        /**
+         * Garnishment amount for the current period.
+         */
+        amount?: string;
+        /**
+         * Code identifying the garnishment.
+         */
+        garnishment_code?: string;
+    }
+    /**
+     * Aggregate totals for taxes, deductions, and garnishments.
+     */
+    interface Summary {
+        /**
+         * Total employee deductions.
+         */
+        employee_deductions?: string;
+        /**
+         * Total employee-paid taxes.
+         */
+        employee_taxes?: string;
+        /**
+         * Total employer contributions (e.g. retirement matching).
+         */
+        employer_contributions?: string;
+        /**
+         * Total employer-paid taxes.
+         */
+        employer_taxes?: string;
+        /**
+         * Total garnishments withheld.
+         */
+        total_garnishments?: string;
+    }
+    /**
+     * A single tax line item on a worker's payroll record.
+     */
+    interface Tax {
+        /**
+         * Tax amount for the current period.
+         */
+        amount?: string;
+        /**
+         * Human-readable name of the tax.
+         */
+        display_name?: string;
+        /**
+         * Who pays this tax: EMPLOYER or EMPLOYEE.
+         */
+        paid_by?: string;
+        /**
+         * Unique code identifying the tax.
+         */
+        tax_code?: string;
+    }
+}
+export interface WorkerPayrollRecordListParams {
+    cursor?: string;
+    /**
+     * OData-style filter. Only `worker_id in ('<id1>', '<id2>', ...)` is supported.
+     */
+    filter?: string;
+    /**
+     * The maximum number of results to return. Defaults to 50. Maximum is 100.
+     */
+    limit?: number;
+}
+export declare namespace WorkerPayrollRecords {
+    export { type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse, type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL, type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams, };
+}
+//# sourceMappingURL=worker-payroll-records.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"worker-payroll-records.d.ts","sourceRoot":"","sources":["../../src/resources/payroll-runs/worker-payroll-records.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;OAKG;IACH,IAAI,CACF,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,+BAA+B,CAAC;CAO/F;AAED,MAAM,MAAM,6CAA6C,GAAG,aAAa,CAAC,+BAA+B,CAAC,CAAC;AAE3G;;;;;;;GAOG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,SAAS,CAAC,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IAE1D;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;IAElE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,+BAA+B,CAAC,OAAO,CAAC;IAElD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,GAAG,CAAC,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAEhC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;IAED;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/payroll-runs/worker-payroll-records.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerPayrollRecords = 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 WorkerPayrollRecords extends resource_1.APIResource {
+    /**
+     * A list of worker-payroll-records for a payroll run. Supports filtering by worker
+     * via `filter=worker_id in ('<id1>', '<id2>')`.
+     *
+     * - Requires: `Global Payroll`
+     */
+    list(runID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/payroll-runs/${runID}/worker-payroll-records/`, (pagination_1.PageCursorURL), { query, ...options });
+    }
+}
+exports.WorkerPayrollRecords = WorkerPayrollRecords;
+//# sourceMappingURL=worker-payroll-records.js.map

package/resources/payroll-runs/worker-payroll-records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-payroll-records.js","sourceRoot":"","sources":["../../src/resources/payroll-runs/worker-payroll-records.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAClD,yDAAmE;AAEnE,uDAAiD;AAEjD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;OAKG;IACH,IAAI,CACF,KAAa,EACb,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,iBAAiB,KAAK,0BAA0B,EACpD,CAAA,0BAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAlBD,oDAkBC"}

package/resources/payroll-runs/worker-payroll-records.mjs

@@ -0,0 +1,19 @@
+// 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 WorkerPayrollRecords extends APIResource {
+    /**
+     * A list of worker-payroll-records for a payroll run. Supports filtering by worker
+     * via `filter=worker_id in ('<id1>', '<id2>')`.
+     *
+     * - Requires: `Global Payroll`
+     */
+    list(runID, query = {}, options) {
+        return this._client.getAPIList(path `/payroll-runs/${runID}/worker-payroll-records/`, (PageCursorURL), { query, ...options });
+    }
+}
+//# sourceMappingURL=worker-payroll-records.mjs.map

package/resources/payroll-runs/worker-payroll-records.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-payroll-records.mjs","sourceRoot":"","sources":["../../src/resources/payroll-runs/worker-payroll-records.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,aAAa,EAAe,kCAA8B;AAEnE,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;OAKG;IACH,IAAI,CACF,KAAa,EACb,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,iBAAiB,KAAK,0BAA0B,EACpD,CAAA,aAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}

package/resources/payroll-runs.d.mts

@@ -0,0 +1,2 @@
+export * from "./payroll-runs/index.mjs";
+//# 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":"AAEA,yCAAqC"}

package/resources/payroll-runs.d.ts

@@ -0,0 +1,2 @@
+export * from "./payroll-runs/index.js";
+//# 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":"AAEA,wCAAqC"}

package/resources/payroll-runs.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./payroll-runs/index.js"), exports);
+//# 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,kEAAqC"}

package/resources/payroll-runs.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./payroll-runs/index.mjs";
+//# 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;AAEtF,yCAAqC"}

package/resources/platform-capabilities.d.mts

@@ -0,0 +1,25 @@
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Custom objects defined by the company
+ */
+export declare class PlatformCapabilities extends APIResource {
+    /**
+     * A list of platform capabilities.
+     *
+     * - Requires: `Platform Capabilities API`
+     */
+    list(options?: RequestOptions): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse>;
+}
+export type PlatformCapabilityListResponsesPageCursorURL = PageCursorURL<PlatformCapabilityListResponse>;
+export interface PlatformCapabilityListResponse {
+    /**
+     * Schema version
+     */
+    version: string;
+}
+export declare namespace PlatformCapabilities {
+    export { type PlatformCapabilityListResponse as PlatformCapabilityListResponse, type PlatformCapabilityListResponsesPageCursorURL as PlatformCapabilityListResponsesPageCursorURL, };
+}
+//# sourceMappingURL=platform-capabilities.d.mts.map

package/resources/platform-capabilities.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-capabilities.d.mts","sourceRoot":"","sources":["../src/resources/platform-capabilities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;OAIG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4CAA4C,EAAE,8BAA8B,CAAC;CAO7F;AAED,MAAM,MAAM,4CAA4C,GAAG,aAAa,CAAC,8BAA8B,CAAC,CAAC;AAEzG,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4CAA4C,IAAI,4CAA4C,GAClG,CAAC;CACH"}

package/resources/platform-capabilities.d.ts

@@ -0,0 +1,25 @@
+import { APIResource } from "../core/resource.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Custom objects defined by the company
+ */
+export declare class PlatformCapabilities extends APIResource {
+    /**
+     * A list of platform capabilities.
+     *
+     * - Requires: `Platform Capabilities API`
+     */
+    list(options?: RequestOptions): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse>;
+}
+export type PlatformCapabilityListResponsesPageCursorURL = PageCursorURL<PlatformCapabilityListResponse>;
+export interface PlatformCapabilityListResponse {
+    /**
+     * Schema version
+     */
+    version: string;
+}
+export declare namespace PlatformCapabilities {
+    export { type PlatformCapabilityListResponse as PlatformCapabilityListResponse, type PlatformCapabilityListResponsesPageCursorURL as PlatformCapabilityListResponsesPageCursorURL, };
+}
+//# sourceMappingURL=platform-capabilities.d.ts.map

package/resources/platform-capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-capabilities.d.ts","sourceRoot":"","sources":["../src/resources/platform-capabilities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;OAIG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4CAA4C,EAAE,8BAA8B,CAAC;CAO7F;AAED,MAAM,MAAM,4CAA4C,GAAG,aAAa,CAAC,8BAA8B,CAAC,CAAC;AAEzG,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4CAA4C,IAAI,4CAA4C,GAClG,CAAC;CACH"}

package/resources/platform-capabilities.js

@@ -0,0 +1,21 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformCapabilities = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+/**
+ * Custom objects defined by the company
+ */
+class PlatformCapabilities extends resource_1.APIResource {
+    /**
+     * A list of platform capabilities.
+     *
+     * - Requires: `Platform Capabilities API`
+     */
+    list(options) {
+        return this._client.getAPIList('/platform-capabilities/', (pagination_1.PageCursorURL), options);
+    }
+}
+exports.PlatformCapabilities = PlatformCapabilities;
+//# sourceMappingURL=platform-capabilities.js.map

package/resources/platform-capabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-capabilities.js","sourceRoot":"","sources":["../src/resources/platform-capabilities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE;;GAEG;AACH,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;OAIG;IACH,IAAI,CACF,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,CAAA,0BAA6C,CAAA,EAC7C,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAfD,oDAeC"}

package/resources/platform-capabilities.mjs

@@ -0,0 +1,17 @@
+// 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";
+/**
+ * Custom objects defined by the company
+ */
+export class PlatformCapabilities extends APIResource {
+    /**
+     * A list of platform capabilities.
+     *
+     * - Requires: `Platform Capabilities API`
+     */
+    list(options) {
+        return this._client.getAPIList('/platform-capabilities/', (PageCursorURL), options);
+    }
+}
+//# sourceMappingURL=platform-capabilities.mjs.map

package/resources/platform-capabilities.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-capabilities.mjs","sourceRoot":"","sources":["../src/resources/platform-capabilities.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAGhE;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;OAIG;IACH,IAAI,CACF,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,CAAA,aAA6C,CAAA,EAC7C,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/resources/report-runs.d.mts

@@ -0,0 +1,218 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Report data for company
+ */
+export declare class ReportRuns extends APIResource {
+    /**
+     * Trigger a new report run
+     */
+    create(body: ReportRunCreateParams, options?: RequestOptions): APIPromise<ReportRunCreateResponse>;
+    /**
+     * Retrieve the status and data for a specific report run
+     */
+    retrieve(runID: string, options?: RequestOptions): APIPromise<ReportRunRetrieveResponse>;
+}
+export interface ReportRunCreateResponse {
+    /**
+     * The ID of this run
+     */
+    id: string;
+    /**
+     * The ID of the report associated with this run
+     */
+    report_id: string;
+    /**
+     * Report run status
+     */
+    status: 'IN_PROGRESS' | 'SUCCESS' | 'FAILURE';
+    /**
+     * Report data, available once the run is complete
+     */
+    result?: ReportRunCreateResponse.Result;
+}
+export declare namespace ReportRunCreateResponse {
+    /**
+     * Report data, available once the run is complete
+     */
+    interface Result {
+        /**
+         * The expiry time of the execution
+         */
+        expires_at: string;
+        /**
+         * The presigned file url
+         */
+        file_url: string;
+        /**
+         * The type of the output file
+         */
+        output_type: 'JSON' | 'CSV';
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface ReportRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * The ID of this run
+     */
+    id: string;
+    /**
+     * The ID of the report associated with this run
+     */
+    report_id: string;
+    /**
+     * Report run status
+     */
+    status: 'IN_PROGRESS' | 'SUCCESS' | 'FAILURE';
+    /**
+     * Report data, available once the run is complete
+     */
+    result?: ReportRunRetrieveResponse.Result;
+}
+export declare namespace ReportRunRetrieveResponse {
+    /**
+     * Report data, available once the run is complete
+     */
+    interface Result {
+        /**
+         * The expiry time of the execution
+         */
+        expires_at: string;
+        /**
+         * The presigned file url
+         */
+        file_url: string;
+        /**
+         * The type of the output file
+         */
+        output_type: 'JSON' | 'CSV';
+    }
+}
+export interface ReportRunCreateParams {
+    /**
+     * The ID of the report to run
+     */
+    report_id: string;
+    /**
+     * Optional list of filters to apply when running the report
+     */
+    filters?: Array<ReportRunCreateParams.Filter> | null;
+    /**
+     * Formatting options for currency fields
+     */
+    format_currency_fields?: ReportRunCreateParams.FormatCurrencyFields | null;
+    /**
+     * Formatting options for date fields
+     */
+    format_date_fields?: ReportRunCreateParams.FormatDateFields | null;
+    /**
+     * Whether to include object IDs in the report output
+     */
+    include_object_ids?: boolean;
+    /**
+     * Whether to include total row count in the report output
+     */
+    include_total_rows?: boolean;
+    /**
+     * Output format for the report data
+     */
+    output_type?: 'JSON' | 'CSV';
+    /**
+     * Controls whose permissions are used when running the report. VIEWER (default)
+     * uses the API token owner's own permissions. OWNER uses the report owner's
+     * permissions (requires owner-level access to the report).
+     */
+    view_as?: 'VIEWER' | 'OWNER';
+}
+export declare namespace ReportRunCreateParams {
+    /**
+     * A single filter to apply when running a report. The expected shape of 'value'
+     * depends on the operator — see the FilterOperator description for details.
+     */
+    interface Filter {
+        /**
+         * The ID of the report field to filter on
+         */
+        field_id: string;
+        /**
+         * Comparison operator for the filter. Single-value operators (EQ, NE, GT, GTE, LT,
+         * LTE, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, BEFORE, AFTER) require a
+         * scalar value. List operators (IN, NOT_IN) require a non-empty array. Range
+         * operators (BETWEEN, NOT_BETWEEN) require an object with 'from' and 'to' keys.
+         * No-value operators (IS_EMPTY, IS_NOT_EMPTY) do not require a value. Rolling-date
+         * operators (LAST_N, NEXT_N) require an object with 'unit' (DAY, WEEK, MONTH,
+         * YEAR) and 'n' (integer). Calendar-date operators (CURRENT_CALENDAR,
+         * PREVIOUS_CALENDAR) require a unit string (DAY, WEEK, MONTH, QUARTER, YEAR).
+         */
+        operator: 'EQ' | 'NE' | 'IN' | 'NOT_IN' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'NOT_CONTAINS' | 'GT' | 'GTE' | 'LT' | 'LTE' | 'BETWEEN' | 'NOT_BETWEEN' | 'IS_EMPTY' | 'IS_NOT_EMPTY' | 'BEFORE' | 'AFTER' | 'LAST_N' | 'NEXT_N' | 'CURRENT_CALENDAR' | 'PREVIOUS_CALENDAR';
+        /**
+         * The filter value. Shape depends on the operator: scalar for single-value
+         * operators; array for list operators; RangeValue object ({from, to}) for range
+         * operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit
+         * string for calendar-date operators; omitted or null for IS_EMPTY/IS_NOT_EMPTY.
+         */
+        value?: string | number | boolean | Array<unknown> | Filter.RangeValue | Filter.RollingDateValue | null;
+    }
+    namespace Filter {
+        /**
+         * Range bounds for 'between' and 'not_between' operators
+         */
+        interface RangeValue {
+            /**
+             * Lower bound of the range (inclusive)
+             */
+            from: number | string;
+            /**
+             * Upper bound of the range (inclusive)
+             */
+            to: number | string;
+        }
+        /**
+         * Rolling date window for 'last_n' and 'next_n' operators
+         */
+        interface RollingDateValue {
+            /**
+             * Number of units
+             */
+            n: number;
+            /**
+             * Unit of time for rolling/calendar date filters
+             */
+            unit: 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
+        }
+    }
+    /**
+     * Formatting options for currency fields
+     */
+    interface FormatCurrencyFields {
+        /**
+         * Currency column format for currency fields
+         */
+        columns: 'TYPE_AND_AMOUNT' | 'VALUE_ONLY';
+        /**
+         * Currency type (e.g., 'USD')
+         */
+        currency_type?: string | null;
+    }
+    /**
+     * Formatting options for date fields
+     */
+    interface FormatDateFields {
+        /**
+         * Date format for date fields in the report output
+         */
+        date_format: 'ISO_8601' | 'APPLY_VISUALIZATION_SETTINGS';
+        /**
+         * Timezone for datetime fields (e.g., 'America/Los_Angeles')
+         */
+        datetime_timezone?: string | null;
+    }
+}
+export declare namespace ReportRuns {
+    export { type ReportRunCreateResponse as ReportRunCreateResponse, type ReportRunRetrieveResponse as ReportRunRetrieveResponse, type ReportRunCreateParams as ReportRunCreateParams, };
+}
+//# sourceMappingURL=report-runs.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"report-runs.d.mts","sourceRoot":"","sources":["../src/resources/report-runs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIlG;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGzF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,CAAC;IAE9C;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,CAAC,MAAM,CAAC;CACzC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,KAAK,CAAC;KAC7B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB,CAAC,IAAI;IACzE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,CAAC;IAE9C;;OAEG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC;CAC3C;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,KAAK,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,sBAAsB,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,kBAAkB,CAAC,EAAE,qBAAqB,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;CAC9B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;;;;;;WASG;QACH,QAAQ,EACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,QAAQ,GACR,aAAa,GACb,WAAW,GACX,UAAU,GACV,cAAc,GACd,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,SAAS,GACT,aAAa,GACb,UAAU,GACV,cAAc,GACd,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,kBAAkB,GAClB,mBAAmB,CAAC;QAExB;;;;;WAKG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC;KACzG;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;YAEtB;;eAEG;YACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;SACrB;QAED;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,CAAC,EAAE,MAAM,CAAC;YAEV;;eAEG;YACH,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;SACrD;KACF;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,OAAO,EAAE,iBAAiB,GAAG,YAAY,CAAC;QAE1C;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,WAAW,EAAE,UAAU,GAAG,8BAA8B,CAAC;QAEzD;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}