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

package/resources/variable-compensation-payout-types.d.mts

@@ -0,0 +1,334 @@
+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";
+/**
+ * Compensation associated with workers
+ */
+export declare class VariableCompensationPayoutTypes extends APIResource {
+    /**
+     * A list of variable compensation payout types.
+     *
+     * - Requires: `API Tier 1`
+     */
+    list(options?: RequestOptions): PagePromise<VariableCompensationPayoutTypeListResponsesPageCursorURL, VariableCompensationPayoutTypeListResponse>;
+    /**
+     * Create a custom payout type. Omit key; the server assigns one. Use PATCH
+     * /variable-compensation-payout-types/{key}/ to update.
+     */
+    create(body: VariableCompensationPayoutTypeCreateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeCreateResponse>;
+    /**
+     * Retrieve a specific variable compensation payout type by key.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeRetrieveResponse>;
+    /**
+     * Update a custom payout type's display name or per-entity earning mappings.
+     */
+    update(id: string, body: VariableCompensationPayoutTypeUpdateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeUpdateResponse>;
+    /**
+     * Delete a custom payout type. Built-in payout types cannot be deleted. Returns
+     * 200 with a null body.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+export type VariableCompensationPayoutTypeListResponsesPageCursorURL = PageCursorURL<VariableCompensationPayoutTypeListResponse>;
+export interface VariableCompensationPayoutTypeListResponse {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeListResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeListResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeCreateResponse {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeCreateResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeCreateResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface VariableCompensationPayoutTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeRetrieveResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeRetrieveResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeUpdateResponse {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeUpdateResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeUpdateResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeCreateParams {
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeCreateParams.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeCreateParams {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeUpdateParams {
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeUpdateParams.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeUpdateParams {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export declare namespace VariableCompensationPayoutTypes {
+    export { type VariableCompensationPayoutTypeListResponse as VariableCompensationPayoutTypeListResponse, type VariableCompensationPayoutTypeCreateResponse as VariableCompensationPayoutTypeCreateResponse, type VariableCompensationPayoutTypeRetrieveResponse as VariableCompensationPayoutTypeRetrieveResponse, type VariableCompensationPayoutTypeUpdateResponse as VariableCompensationPayoutTypeUpdateResponse, type VariableCompensationPayoutTypeListResponsesPageCursorURL as VariableCompensationPayoutTypeListResponsesPageCursorURL, type VariableCompensationPayoutTypeCreateParams as VariableCompensationPayoutTypeCreateParams, type VariableCompensationPayoutTypeUpdateParams as VariableCompensationPayoutTypeUpdateParams, };
+}
+//# sourceMappingURL=variable-compensation-payout-types.d.mts.map

package/resources/variable-compensation-payout-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-compensation-payout-types.d.mts","sourceRoot":"","sources":["../src/resources/variable-compensation-payout-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,WAAW;IAC9D;;;;OAIG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,wDAAwD,EACxD,0CAA0C,CAC3C;IAQD;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,0CAA0C,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAI3D;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8CAA8C,CAAC;IAI1G;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0CAA0C,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAI3D;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,wDAAwD,GAClE,aAAa,CAAC,0CAA0C,CAAC,CAAC;AAE5D,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8CAA+C,SAAQ,mBAAmB,CAAC,IAAI;IAC9F;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,OAAO,CAAC,CAAC;CAC1E;AAED,yBAAiB,8CAA8C,CAAC;IAC9D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,+BAA+B,CAAC;IACvD,OAAO,EACL,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,wDAAwD,IAAI,wDAAwD,EACzH,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,0CAA0C,IAAI,0CAA0C,GAC9F,CAAC;CACH"}

package/resources/variable-compensation-payout-types.d.ts

@@ -0,0 +1,334 @@
+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 VariableCompensationPayoutTypes extends APIResource {
+    /**
+     * A list of variable compensation payout types.
+     *
+     * - Requires: `API Tier 1`
+     */
+    list(options?: RequestOptions): PagePromise<VariableCompensationPayoutTypeListResponsesPageCursorURL, VariableCompensationPayoutTypeListResponse>;
+    /**
+     * Create a custom payout type. Omit key; the server assigns one. Use PATCH
+     * /variable-compensation-payout-types/{key}/ to update.
+     */
+    create(body: VariableCompensationPayoutTypeCreateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeCreateResponse>;
+    /**
+     * Retrieve a specific variable compensation payout type by key.
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeRetrieveResponse>;
+    /**
+     * Update a custom payout type's display name or per-entity earning mappings.
+     */
+    update(id: string, body: VariableCompensationPayoutTypeUpdateParams, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeUpdateResponse>;
+    /**
+     * Delete a custom payout type. Built-in payout types cannot be deleted. Returns
+     * 200 with a null body.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+export type VariableCompensationPayoutTypeListResponsesPageCursorURL = PageCursorURL<VariableCompensationPayoutTypeListResponse>;
+export interface VariableCompensationPayoutTypeListResponse {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeListResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeListResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeCreateResponse {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeCreateResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeCreateResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface VariableCompensationPayoutTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeRetrieveResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeRetrieveResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeUpdateResponse {
+    /**
+     * Unique identifier of the payout type. Same as key.
+     */
+    id: string;
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Whether this is a built-in payout type.
+     */
+    is_system: boolean;
+    /**
+     * Stable payout type key assigned by the server on create.
+     */
+    key: string;
+    /**
+     * ID of the worker who created this custom payout type.
+     */
+    created_by?: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeUpdateResponse.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeUpdateResponse {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeCreateParams {
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeCreateParams.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeCreateParams {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export interface VariableCompensationPayoutTypeUpdateParams {
+    /**
+     * Display name of the payout type.
+     */
+    display_name: string;
+    /**
+     * Per-entity earning code mappings.
+     */
+    mappings?: Array<VariableCompensationPayoutTypeUpdateParams.Mapping>;
+}
+export declare namespace VariableCompensationPayoutTypeUpdateParams {
+    interface Mapping {
+        /**
+         * ID of the payroll entity this mapping applies to.
+         */
+        entity_id: string;
+        /**
+         * Mapping health status.
+         */
+        health: string;
+        /**
+         * Mapped earning code for the payroll entity.
+         */
+        earning_code?: string;
+        /**
+         * Display name of the mapped earning code at response time. Convenience snapshot
+         * for the mapping matrix; authoritative earning metadata lives in payroll, not
+         * this field.
+         */
+        earning_display_name?: string;
+        /**
+         * Display name of the payroll entity at response time. Convenience snapshot for
+         * the mapping matrix; authoritative entity data lives on payroll entities, not
+         * this field.
+         */
+        entity_name?: string;
+    }
+}
+export declare namespace VariableCompensationPayoutTypes {
+    export { type VariableCompensationPayoutTypeListResponse as VariableCompensationPayoutTypeListResponse, type VariableCompensationPayoutTypeCreateResponse as VariableCompensationPayoutTypeCreateResponse, type VariableCompensationPayoutTypeRetrieveResponse as VariableCompensationPayoutTypeRetrieveResponse, type VariableCompensationPayoutTypeUpdateResponse as VariableCompensationPayoutTypeUpdateResponse, type VariableCompensationPayoutTypeListResponsesPageCursorURL as VariableCompensationPayoutTypeListResponsesPageCursorURL, type VariableCompensationPayoutTypeCreateParams as VariableCompensationPayoutTypeCreateParams, type VariableCompensationPayoutTypeUpdateParams as VariableCompensationPayoutTypeUpdateParams, };
+}
+//# sourceMappingURL=variable-compensation-payout-types.d.ts.map

package/resources/variable-compensation-payout-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-compensation-payout-types.d.ts","sourceRoot":"","sources":["../src/resources/variable-compensation-payout-types.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;AAEhE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,WAAW;IAC9D;;;;OAIG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,wDAAwD,EACxD,0CAA0C,CAC3C;IAQD;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,0CAA0C,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAI3D;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8CAA8C,CAAC;IAI1G;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0CAA0C,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4CAA4C,CAAC;IAI3D;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,wDAAwD,GAClE,aAAa,CAAC,0CAA0C,CAAC,CAAC;AAE5D,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8CAA+C,SAAQ,mBAAmB,CAAC,IAAI;IAC9F;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,OAAO,CAAC,CAAC;CAC1E;AAED,yBAAiB,8CAA8C,CAAC;IAC9D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,4CAA4C,CAAC,OAAO,CAAC,CAAC;CACxE;AAED,yBAAiB,4CAA4C,CAAC;IAC5D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,OAAO,CAAC,CAAC;CACtE;AAED,yBAAiB,0CAA0C,CAAC;IAC1D,UAAiB,OAAO;QACtB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,+BAA+B,CAAC;IACvD,OAAO,EACL,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,wDAAwD,IAAI,wDAAwD,EACzH,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,0CAA0C,IAAI,0CAA0C,GAC9F,CAAC;CACH"}