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

package/src/resources/variable-compensation-payout-labels.ts

@@ -0,0 +1,227 @@
+// 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 VariableCompensationPayoutLabels extends APIResource {
+  /**
+   * A list of variable compensation payout labels.
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    query: VariableCompensationPayoutLabelListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<
+    VariableCompensationPayoutLabelListResponsesPageCursorURL,
+    VariableCompensationPayoutLabelListResponse
+  > {
+    return this._client.getAPIList(
+      '/variable-compensation-payout-labels/',
+      PageCursorURL<VariableCompensationPayoutLabelListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Get or create a source or group label. Identity is (client, external_id). New
+   * identities return 201; an existing match returns 200.
+   */
+  create(
+    body: VariableCompensationPayoutLabelCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<VariableCompensationPayoutLabelCreateResponse> {
+    return this._client.post('/variable-compensation-payout-labels/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific payout source or group label.
+   */
+  retrieve(
+    id: string,
+    options?: RequestOptions,
+  ): APIPromise<VariableCompensationPayoutLabelRetrieveResponse> {
+    return this._client.get(path`/variable-compensation-payout-labels/${id}/`, options);
+  }
+
+  /**
+   * Update a specific variable compensation payout label.
+   */
+  update(
+    id: string,
+    body: VariableCompensationPayoutLabelUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<VariableCompensationPayoutLabelUpdateResponse> {
+    return this._client.patch(path`/variable-compensation-payout-labels/${id}/`, { body, ...options });
+  }
+}
+
+export type VariableCompensationPayoutLabelListResponsesPageCursorURL =
+  PageCursorURL<VariableCompensationPayoutLabelListResponse>;
+
+export interface VariableCompensationPayoutLabelListResponse {
+  /**
+   * Unique identifier of the payout label.
+   */
+  id: string;
+
+  /**
+   * Client system that created the label.
+   */
+  client: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id: string;
+
+  /**
+   * Display name of the label.
+   */
+  name: string;
+}
+
+export interface VariableCompensationPayoutLabelCreateResponse {
+  /**
+   * Unique identifier of the payout label.
+   */
+  id: string;
+
+  /**
+   * Client system that created the label.
+   */
+  client: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id: string;
+
+  /**
+   * Display name of the label.
+   */
+  name: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface VariableCompensationPayoutLabelRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Unique identifier of the payout label.
+   */
+  id: string;
+
+  /**
+   * Client system that created the label.
+   */
+  client: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id: string;
+
+  /**
+   * Display name of the label.
+   */
+  name: string;
+}
+
+export interface VariableCompensationPayoutLabelUpdateResponse {
+  /**
+   * Unique identifier of the payout label.
+   */
+  id: string;
+
+  /**
+   * Client system that created the label.
+   */
+  client: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id: string;
+
+  /**
+   * Display name of the label.
+   */
+  name: string;
+}
+
+export interface VariableCompensationPayoutLabelListParams {
+  /**
+   * Client system that created the label.
+   */
+  client?: string;
+
+  /**
+   * Opaque pagination cursor from the previous page's next_link.
+   */
+  cursor?: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id?: string;
+
+  /**
+   * Page size. Defaults to 50. Maximum 100.
+   */
+  limit?: number;
+}
+
+export interface VariableCompensationPayoutLabelCreateParams {
+  /**
+   * Client system that created the label.
+   */
+  client: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id: string;
+
+  /**
+   * Display name of the label.
+   */
+  name: string;
+}
+
+export interface VariableCompensationPayoutLabelUpdateParams {
+  /**
+   * Client system that created the label.
+   */
+  client: string;
+
+  /**
+   * External identifier unique per company and client.
+   */
+  external_id: string;
+
+  /**
+   * Display name of the label.
+   */
+  name: string;
+}
+
+export declare namespace VariableCompensationPayoutLabels {
+  export {
+    type VariableCompensationPayoutLabelListResponse as VariableCompensationPayoutLabelListResponse,
+    type VariableCompensationPayoutLabelCreateResponse as VariableCompensationPayoutLabelCreateResponse,
+    type VariableCompensationPayoutLabelRetrieveResponse as VariableCompensationPayoutLabelRetrieveResponse,
+    type VariableCompensationPayoutLabelUpdateResponse as VariableCompensationPayoutLabelUpdateResponse,
+    type VariableCompensationPayoutLabelListResponsesPageCursorURL as VariableCompensationPayoutLabelListResponsesPageCursorURL,
+    type VariableCompensationPayoutLabelListParams as VariableCompensationPayoutLabelListParams,
+    type VariableCompensationPayoutLabelCreateParams as VariableCompensationPayoutLabelCreateParams,
+    type VariableCompensationPayoutLabelUpdateParams as VariableCompensationPayoutLabelUpdateParams,
+  };
+}

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

@@ -0,0 +1,440 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Compensation associated with workers
+ */
+export class VariableCompensationPayoutTypes extends APIResource {
+  /**
+   * A list of variable compensation payout types.
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<
+    VariableCompensationPayoutTypeListResponsesPageCursorURL,
+    VariableCompensationPayoutTypeListResponse
+  > {
+    return this._client.getAPIList(
+      '/variable-compensation-payout-types/',
+      PageCursorURL<VariableCompensationPayoutTypeListResponse>,
+      options,
+    );
+  }
+
+  /**
+   * 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> {
+    return this._client.post('/variable-compensation-payout-types/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific variable compensation payout type by key.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<VariableCompensationPayoutTypeRetrieveResponse> {
+    return this._client.get(path`/variable-compensation-payout-types/${id}/`, options);
+  }
+
+  /**
+   * Update a custom payout type's display name or per-entity earning mappings.
+   */
+  update(
+    id: string,
+    body: VariableCompensationPayoutTypeUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<VariableCompensationPayoutTypeUpdateResponse> {
+    return this._client.patch(path`/variable-compensation-payout-types/${id}/`, { body, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.delete(path`/variable-compensation-payout-types/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+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 namespace VariableCompensationPayoutTypeListResponse {
+  export 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 namespace VariableCompensationPayoutTypeCreateResponse {
+  export 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 namespace VariableCompensationPayoutTypeRetrieveResponse {
+  export 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 namespace VariableCompensationPayoutTypeUpdateResponse {
+  export 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 namespace VariableCompensationPayoutTypeCreateParams {
+  export 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 namespace VariableCompensationPayoutTypeUpdateParams {
+  export 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,
+  };
+}