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

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

@@ -0,0 +1,702 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Compensation associated with workers
+ */
+export class VariableCompensationPayouts extends APIResource {
+  /**
+   * A list of variable compensation payouts.
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    query: VariableCompensationPayoutListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<
+    VariableCompensationPayoutListResponsesPageCursorURL,
+    VariableCompensationPayoutListResponse
+  > {
+    return this._client.getAPIList(
+      '/variable-compensation-payouts/',
+      PageCursorURL<VariableCompensationPayoutListResponse>,
+      { 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: VariableCompensationPayoutCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<VariableCompensationPayoutCreateResponse> {
+    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: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutRetrieveResponse> {
+    return this._client.get(path`/variable-compensation-payouts/${id}/`, options);
+  }
+}
+
+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 namespace VariableCompensationPayoutListResponse {
+  /**
+   * Payout amount in the worker's base currency.
+   */
+  export interface AmountBase {
+    /**
+     * Three-letter currency code.
+     */
+    currency_type: string;
+
+    /**
+     * Decimal amount encoded as a string.
+     */
+    value: string;
+  }
+
+  /**
+   * Payout amount converted to USD.
+   */
+  export 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 namespace VariableCompensationPayoutCreateResponse {
+  /**
+   * Payout amount in the worker's base currency.
+   */
+  export interface AmountBase {
+    /**
+     * Three-letter currency code.
+     */
+    currency_type: string;
+
+    /**
+     * Decimal amount encoded as a string.
+     */
+    value: string;
+  }
+
+  /**
+   * Payout amount converted to USD.
+   */
+  export 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 namespace VariableCompensationPayoutRetrieveResponse {
+  /**
+   * Payout amount in the worker's base currency.
+   */
+  export interface AmountBase {
+    /**
+     * Three-letter currency code.
+     */
+    currency_type: string;
+
+    /**
+     * Decimal amount encoded as a string.
+     */
+    value: string;
+  }
+
+  /**
+   * Payout amount converted to USD.
+   */
+  export 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 namespace VariableCompensationPayoutCreateParams {
+  /**
+   * Payout amount in the worker's base currency.
+   */
+  export interface AmountBase {
+    /**
+     * Three-letter currency code.
+     */
+    currency_type: string;
+
+    /**
+     * Decimal amount encoded as a string.
+     */
+    value: string;
+  }
+
+  /**
+   * Payout amount converted to USD.
+   */
+  export 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,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.97'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.98'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.97";
+export declare const VERSION = "0.2.0-alpha.98";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.97";
+export declare const VERSION = "0.2.0-alpha.98";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.97'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.98'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.97'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.98'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map