@rippling/rippling-sdk 0.2.0-alpha.97 → 0.2.0-alpha.99

package/resources/variable-compensation-payouts.d.ts

@@ -0,0 +1,501 @@
+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";
+/**
+ * Compensation associated with workers
+ */
+export declare class VariableCompensationPayouts extends APIResource {
+    /**
+     * A list of variable compensation payouts.
+     *
+     * - Requires: `API Tier 1`
+     */
+    list(query?: VariableCompensationPayoutListParams | null | undefined, options?: RequestOptions): PagePromise<VariableCompensationPayoutListResponsesPageCursorURL, VariableCompensationPayoutListResponse>;
+    /**
+     * Create or update one payout. Identity is (client, external_id), not id. Same key
+     * and same body replays with 200. Same key and a different body overwrites a
+     * SCHEDULED row when the caller can edit scheduled payouts; otherwise 403.
+     * RELEASED rows return 409. New identities return 201. This writes ledger rows;
+     * POST /variable-compensation-payout-writes/ submits a payout into payroll.
+     * Payroll-sync side effects (paystub_id, outbox) — VC PM / Payroll PM ack required
+     * before GA beyond private scopes.
+     */
+    create(body: VariableCompensationPayoutCreateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutCreateResponse>;
+    /**
+     * Retrieve a specific variable compensation payout. Uses the company admin payout
+     * rowset; callers without admin payout visibility receive NotFound.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutRetrieveResponse>;
+}
+export type VariableCompensationPayoutListResponsesPageCursorURL = PageCursorURL<VariableCompensationPayoutListResponse>;
+export interface VariableCompensationPayoutListResponse {
+    /**
+     * Unique identifier of the payout.
+     */
+    id: string;
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    amount_base: VariableCompensationPayoutListResponse.AmountBase;
+    /**
+     * Payout amount converted to USD.
+     */
+    amount_usd: VariableCompensationPayoutListResponse.AmountUsd;
+    /**
+     * Client system that created the payout.
+     */
+    client: 'VC_PLAN_CYCLE' | 'VC_EVENT_DRIVEN_PLAN' | 'CUSTOM' | 'MANUAL_PAYOUT' | 'HRIS_SIGN_ON' | 'OFFLINE_RECOMMENDATION';
+    /**
+     * When the payout was created.
+     */
+    created_at: string;
+    /**
+     * End date of the covered pay period.
+     */
+    effective_end_date: string;
+    /**
+     * Start date of the covered pay period.
+     */
+    effective_start_date: string;
+    /**
+     * External identifier unique per company and client.
+     */
+    external_id: string;
+    /**
+     * ID of the worker who receives this payout. Expandable payee (Worker DTO +
+     * workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
+     */
+    payee_id: string;
+    /**
+     * Key of the company payout type used for this payout. Expand is deferred from v1;
+     * enumerate valid keys via GET /variable-compensation-payout-types/.
+     */
+    payout_type: string;
+    /**
+     * Date on which the payout is scheduled.
+     */
+    scheduled_date: string;
+    /**
+     * Current payout status.
+     */
+    status: 'DRAFT' | 'STAGING' | 'PENDING_APPROVAL' | 'APPROVAL_REJECTED' | 'SCHEDULED' | 'RELEASED' | 'PAID' | 'FORFEITED' | 'EVALUATION_FAILED' | 'CANCELLED';
+    /**
+     * When the payout was last updated.
+     */
+    updated_at: string;
+    /**
+     * Reason provided when the payout was cancelled.
+     */
+    cancel_reason?: string;
+    /**
+     * Optional payout description.
+     */
+    description?: string;
+    /**
+     * Group label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    group_label_id?: string;
+    /**
+     * Optional payout name.
+     */
+    name?: string;
+    /**
+     * Payroll earning code resolved from the payout type.
+     */
+    pay_classification?: string;
+    /**
+     * Paystub identifier when the payout has been synced to payroll.
+     */
+    paystub_id?: string;
+    /**
+     * Source label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    source_label_id?: string;
+}
+export declare namespace VariableCompensationPayoutListResponse {
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    interface AmountBase {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+    /**
+     * Payout amount converted to USD.
+     */
+    interface AmountUsd {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+}
+export interface VariableCompensationPayoutCreateResponse {
+    /**
+     * Unique identifier of the payout.
+     */
+    id: string;
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    amount_base: VariableCompensationPayoutCreateResponse.AmountBase;
+    /**
+     * Payout amount converted to USD.
+     */
+    amount_usd: VariableCompensationPayoutCreateResponse.AmountUsd;
+    /**
+     * Client system that created the payout.
+     */
+    client: 'VC_PLAN_CYCLE' | 'VC_EVENT_DRIVEN_PLAN' | 'CUSTOM' | 'MANUAL_PAYOUT' | 'HRIS_SIGN_ON' | 'OFFLINE_RECOMMENDATION';
+    /**
+     * When the payout was created.
+     */
+    created_at: string;
+    /**
+     * End date of the covered pay period.
+     */
+    effective_end_date: string;
+    /**
+     * Start date of the covered pay period.
+     */
+    effective_start_date: string;
+    /**
+     * External identifier unique per company and client.
+     */
+    external_id: string;
+    /**
+     * ID of the worker who receives this payout. Expandable payee (Worker DTO +
+     * workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
+     */
+    payee_id: string;
+    /**
+     * Key of the company payout type used for this payout. Expand is deferred from v1;
+     * enumerate valid keys via GET /variable-compensation-payout-types/.
+     */
+    payout_type: string;
+    /**
+     * Date on which the payout is scheduled.
+     */
+    scheduled_date: string;
+    /**
+     * Current payout status.
+     */
+    status: 'DRAFT' | 'STAGING' | 'PENDING_APPROVAL' | 'APPROVAL_REJECTED' | 'SCHEDULED' | 'RELEASED' | 'PAID' | 'FORFEITED' | 'EVALUATION_FAILED' | 'CANCELLED';
+    /**
+     * When the payout was last updated.
+     */
+    updated_at: string;
+    /**
+     * Reason provided when the payout was cancelled.
+     */
+    cancel_reason?: string;
+    /**
+     * Optional payout description.
+     */
+    description?: string;
+    /**
+     * Group label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    group_label_id?: string;
+    /**
+     * Optional payout name.
+     */
+    name?: string;
+    /**
+     * Payroll earning code resolved from the payout type.
+     */
+    pay_classification?: string;
+    /**
+     * Paystub identifier when the payout has been synced to payroll.
+     */
+    paystub_id?: string;
+    /**
+     * Source label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    source_label_id?: string;
+}
+export declare namespace VariableCompensationPayoutCreateResponse {
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    interface AmountBase {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+    /**
+     * Payout amount converted to USD.
+     */
+    interface AmountUsd {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface VariableCompensationPayoutRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Unique identifier of the payout.
+     */
+    id: string;
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    amount_base: VariableCompensationPayoutRetrieveResponse.AmountBase;
+    /**
+     * Payout amount converted to USD.
+     */
+    amount_usd: VariableCompensationPayoutRetrieveResponse.AmountUsd;
+    /**
+     * Client system that created the payout.
+     */
+    client: 'VC_PLAN_CYCLE' | 'VC_EVENT_DRIVEN_PLAN' | 'CUSTOM' | 'MANUAL_PAYOUT' | 'HRIS_SIGN_ON' | 'OFFLINE_RECOMMENDATION';
+    /**
+     * When the payout was created.
+     */
+    created_at: string;
+    /**
+     * End date of the covered pay period.
+     */
+    effective_end_date: string;
+    /**
+     * Start date of the covered pay period.
+     */
+    effective_start_date: string;
+    /**
+     * External identifier unique per company and client.
+     */
+    external_id: string;
+    /**
+     * ID of the worker who receives this payout. Expandable payee (Worker DTO +
+     * workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
+     */
+    payee_id: string;
+    /**
+     * Key of the company payout type used for this payout. Expand is deferred from v1;
+     * enumerate valid keys via GET /variable-compensation-payout-types/.
+     */
+    payout_type: string;
+    /**
+     * Date on which the payout is scheduled.
+     */
+    scheduled_date: string;
+    /**
+     * Current payout status.
+     */
+    status: 'DRAFT' | 'STAGING' | 'PENDING_APPROVAL' | 'APPROVAL_REJECTED' | 'SCHEDULED' | 'RELEASED' | 'PAID' | 'FORFEITED' | 'EVALUATION_FAILED' | 'CANCELLED';
+    /**
+     * When the payout was last updated.
+     */
+    updated_at: string;
+    /**
+     * Reason provided when the payout was cancelled.
+     */
+    cancel_reason?: string;
+    /**
+     * Optional payout description.
+     */
+    description?: string;
+    /**
+     * Group label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    group_label_id?: string;
+    /**
+     * Optional payout name.
+     */
+    name?: string;
+    /**
+     * Payroll earning code resolved from the payout type.
+     */
+    pay_classification?: string;
+    /**
+     * Paystub identifier when the payout has been synced to payroll.
+     */
+    paystub_id?: string;
+    /**
+     * Source label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    source_label_id?: string;
+}
+export declare namespace VariableCompensationPayoutRetrieveResponse {
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    interface AmountBase {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+    /**
+     * Payout amount converted to USD.
+     */
+    interface AmountUsd {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+}
+export interface VariableCompensationPayoutListParams {
+    /**
+     * Client system that created the payout.
+     */
+    client?: 'VC_PLAN_CYCLE' | 'VC_EVENT_DRIVEN_PLAN' | 'CUSTOM' | 'MANUAL_PAYOUT' | 'HRIS_SIGN_ON' | 'OFFLINE_RECOMMENDATION';
+    /**
+     * Opaque pagination cursor from the previous page's next_link.
+     */
+    cursor?: string;
+    /**
+     * External identifier unique per company and client.
+     */
+    external_id?: string;
+    /**
+     * Group label identifier attached to the payout.
+     */
+    group_label_id?: string;
+    /**
+     * Page size. Defaults to 50. Maximum 100.
+     */
+    limit?: number;
+    /**
+     * ID of the worker who receives this payout.
+     */
+    payee_id?: string;
+    /**
+     * Source label identifier attached to the payout.
+     */
+    source_label_id?: string;
+    /**
+     * Current payout status.
+     */
+    status?: 'DRAFT' | 'STAGING' | 'PENDING_APPROVAL' | 'APPROVAL_REJECTED' | 'SCHEDULED' | 'RELEASED' | 'PAID' | 'FORFEITED' | 'EVALUATION_FAILED' | 'CANCELLED';
+}
+export interface VariableCompensationPayoutCreateParams {
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    amount_base: VariableCompensationPayoutCreateParams.AmountBase;
+    /**
+     * Payout amount converted to USD.
+     */
+    amount_usd: VariableCompensationPayoutCreateParams.AmountUsd;
+    /**
+     * Client system that created the payout.
+     */
+    client: 'VC_PLAN_CYCLE' | 'VC_EVENT_DRIVEN_PLAN' | 'CUSTOM' | 'MANUAL_PAYOUT' | 'HRIS_SIGN_ON' | 'OFFLINE_RECOMMENDATION';
+    /**
+     * End date of the covered pay period.
+     */
+    effective_end_date: string;
+    /**
+     * Start date of the covered pay period.
+     */
+    effective_start_date: string;
+    /**
+     * External identifier unique per company and client.
+     */
+    external_id: string;
+    /**
+     * ID of the worker who receives this payout. Expandable payee (Worker DTO +
+     * workers.read) is deferred from v1; use GET /workers/{id}/ when needed.
+     */
+    payee_id: string;
+    /**
+     * Key of the company payout type used for this payout. Expand is deferred from v1;
+     * enumerate valid keys via GET /variable-compensation-payout-types/.
+     */
+    payout_type: string;
+    /**
+     * Date on which the payout is scheduled.
+     */
+    scheduled_date: string;
+    /**
+     * Optional payout description.
+     */
+    description?: string;
+    /**
+     * Group label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    group_label_id?: string;
+    /**
+     * Optional payout name.
+     */
+    name?: string;
+    /**
+     * Source label identifier attached to the payout. Expand is deferred from v1; use
+     * GET /variable-compensation-payout-labels/{id}/ when needed.
+     */
+    source_label_id?: string;
+}
+export declare namespace VariableCompensationPayoutCreateParams {
+    /**
+     * Payout amount in the worker's base currency.
+     */
+    interface AmountBase {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+    /**
+     * Payout amount converted to USD.
+     */
+    interface AmountUsd {
+        /**
+         * Three-letter currency code.
+         */
+        currency_type: string;
+        /**
+         * Decimal amount encoded as a string.
+         */
+        value: string;
+    }
+}
+export declare namespace VariableCompensationPayouts {
+    export { type VariableCompensationPayoutListResponse as VariableCompensationPayoutListResponse, type VariableCompensationPayoutCreateResponse as VariableCompensationPayoutCreateResponse, type VariableCompensationPayoutRetrieveResponse as VariableCompensationPayoutRetrieveResponse, type VariableCompensationPayoutListResponsesPageCursorURL as VariableCompensationPayoutListResponsesPageCursorURL, type VariableCompensationPayoutListParams as VariableCompensationPayoutListParams, type VariableCompensationPayoutCreateParams as VariableCompensationPayoutCreateParams, };
+}
+//# sourceMappingURL=variable-compensation-payouts.d.ts.map

package/resources/variable-compensation-payouts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-compensation-payouts.d.ts","sourceRoot":"","sources":["../src/resources/variable-compensation-payouts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,WAAW;IAC1D;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,oCAAoC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,oDAAoD,EACpD,sCAAsC,CACvC;IAQD;;;;;;;;OAQG;IACH,MAAM,CACJ,IAAI,EAAE,sCAAsC,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wCAAwC,CAAC;IAIvD;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0CAA0C,CAAC;CAGvG;AAED,MAAM,MAAM,oDAAoD,GAC9D,aAAa,CAAC,sCAAsC,CAAC,CAAC;AAExD,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,sCAAsC,CAAC,UAAU,CAAC;IAE/D;;OAEG;IACH,UAAU,EAAE,sCAAsC,CAAC,SAAS,CAAC;IAE7D;;OAEG;IACH,MAAM,EACF,eAAe,GACf,sBAAsB,GACtB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,wBAAwB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EACF,OAAO,GACP,SAAS,GACT,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,UAAU,GACV,MAAM,GACN,WAAW,GACX,mBAAmB,GACnB,WAAW,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,sCAAsC,CAAC;IACtD;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,wCAAwC,CAAC,UAAU,CAAC;IAEjE;;OAEG;IACH,UAAU,EAAE,wCAAwC,CAAC,SAAS,CAAC;IAE/D;;OAEG;IACH,MAAM,EACF,eAAe,GACf,sBAAsB,GACtB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,wBAAwB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EACF,OAAO,GACP,SAAS,GACT,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,UAAU,GACV,MAAM,GACN,WAAW,GACX,mBAAmB,GACnB,WAAW,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0CAA2C,SAAQ,mBAAmB,CAAC,IAAI;IAC1F;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,0CAA0C,CAAC,UAAU,CAAC;IAEnE;;OAEG;IACH,UAAU,EAAE,0CAA0C,CAAC,SAAS,CAAC;IAEjE;;OAEG;IACH,MAAM,EACF,eAAe,GACf,sBAAsB,GACtB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,wBAAwB,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EACF,OAAO,GACP,SAAS,GACT,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,UAAU,GACV,MAAM,GACN,WAAW,GACX,mBAAmB,GACnB,WAAW,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,0CAA0C,CAAC;IAC1D;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,MAAM,CAAC,EACH,eAAe,GACf,sBAAsB,GACtB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,wBAAwB,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EACH,OAAO,GACP,SAAS,GACT,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,UAAU,GACV,MAAM,GACN,WAAW,GACX,mBAAmB,GACnB,WAAW,CAAC;CACjB;AAED,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,WAAW,EAAE,sCAAsC,CAAC,UAAU,CAAC;IAE/D;;OAEG;IACH,UAAU,EAAE,sCAAsC,CAAC,SAAS,CAAC;IAE7D;;OAEG;IACH,MAAM,EACF,eAAe,GACf,sBAAsB,GACtB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,wBAAwB,CAAC;IAE7B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,sCAAsC,CAAC;IACtD;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,2BAA2B,CAAC;IACnD,OAAO,EACL,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,oDAAoD,IAAI,oDAAoD,EACjH,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,GACtF,CAAC;CACH"}

package/resources/variable-compensation-payouts.js

@@ -0,0 +1,41 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariableCompensationPayouts = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Compensation associated with workers
+ */
+class VariableCompensationPayouts extends resource_1.APIResource {
+    /**
+     * A list of variable compensation payouts.
+     *
+     * - Requires: `API Tier 1`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/variable-compensation-payouts/', (pagination_1.PageCursorURL), { query, ...options });
+    }
+    /**
+     * Create or update one payout. Identity is (client, external_id), not id. Same key
+     * and same body replays with 200. Same key and a different body overwrites a
+     * SCHEDULED row when the caller can edit scheduled payouts; otherwise 403.
+     * RELEASED rows return 409. New identities return 201. This writes ledger rows;
+     * POST /variable-compensation-payout-writes/ submits a payout into payroll.
+     * Payroll-sync side effects (paystub_id, outbox) — VC PM / Payroll PM ack required
+     * before GA beyond private scopes.
+     */
+    create(body, options) {
+        return this._client.post('/variable-compensation-payouts/', { body, ...options });
+    }
+    /**
+     * Retrieve a specific variable compensation payout. Uses the company admin payout
+     * rowset; callers without admin payout visibility receive NotFound.
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/variable-compensation-payouts/${id}/`, options);
+    }
+}
+exports.VariableCompensationPayouts = VariableCompensationPayouts;
+//# sourceMappingURL=variable-compensation-payouts.js.map

package/resources/variable-compensation-payouts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-compensation-payouts.js","sourceRoot":"","sources":["../src/resources/variable-compensation-payouts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,2BAA4B,SAAQ,sBAAW;IAC1D;;;;OAIG;IACH,IAAI,CACF,QAAiE,EAAE,EACnE,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iCAAiC,EACjC,CAAA,0BAAqD,CAAA,EACrD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,IAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AA3CD,kEA2CC"}

package/resources/variable-compensation-payouts.mjs

@@ -0,0 +1,37 @@
+// 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";
+/**
+ * Compensation associated with workers
+ */
+export class VariableCompensationPayouts extends APIResource {
+    /**
+     * A list of variable compensation payouts.
+     *
+     * - Requires: `API Tier 1`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/variable-compensation-payouts/', (PageCursorURL), { query, ...options });
+    }
+    /**
+     * Create or update one payout. Identity is (client, external_id), not id. Same key
+     * and same body replays with 200. Same key and a different body overwrites a
+     * SCHEDULED row when the caller can edit scheduled payouts; otherwise 403.
+     * RELEASED rows return 409. New identities return 201. This writes ledger rows;
+     * POST /variable-compensation-payout-writes/ submits a payout into payroll.
+     * Payroll-sync side effects (paystub_id, outbox) — VC PM / Payroll PM ack required
+     * before GA beyond private scopes.
+     */
+    create(body, options) {
+        return this._client.post('/variable-compensation-payouts/', { body, ...options });
+    }
+    /**
+     * Retrieve a specific variable compensation payout. Uses the company admin payout
+     * rowset; callers without admin payout visibility receive NotFound.
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/variable-compensation-payouts/${id}/`, options);
+    }
+}
+//# sourceMappingURL=variable-compensation-payouts.mjs.map

package/resources/variable-compensation-payouts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-compensation-payouts.mjs","sourceRoot":"","sources":["../src/resources/variable-compensation-payouts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,WAAW;IAC1D;;;;OAIG;IACH,IAAI,CACF,QAAiE,EAAE,EACnE,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iCAAiC,EACjC,CAAA,aAAqD,CAAA,EACrD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,IAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kCAAkC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF"}