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

package/src/resources/draft-transitions.ts

@@ -0,0 +1,583 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Proposed changes to existing workers that can be reviewed in Rippling
+ */
+export class DraftTransitions extends APIResource {
+  /**
+   * Retrieve a specific draft transition
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DraftTransitionRetrieveResponse> {
+    return this._client.get(path`/draft-transitions/${id}/`, options);
+  }
+
+  /**
+   * Create a new draft transition
+   */
+  create(
+    body: DraftTransitionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<DraftTransitionCreateResponse> {
+    return this._client.post('/draft-transitions/', { body, ...options });
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface DraftTransitionRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Effective timestamp applied to the entire draft transition request.
+   */
+  effective_at: string;
+
+  /**
+   * Draft transition items to accept for asynchronous processing.
+   */
+  items: Array<DraftTransitionRetrieveResponse.Item>;
+
+  /**
+   * IANA timezone used to interpret and display the request's effective timestamp.
+   */
+  timezone: string;
+}
+
+export namespace DraftTransitionRetrieveResponse {
+  export interface Item {
+    /**
+     * Requested role/profile changes for this item.
+     */
+    changes: Item.Changes;
+
+    /**
+     * Target role identifier for this draft transition item.
+     */
+    role_id: string;
+
+    /**
+     * Controls whether this item should append to a compatible existing draft or
+     * create a new draft.
+     */
+    draft_grouping_preference?: 'APPEND_TO_MATCHING_DRAFT' | 'CREATE_NEW_DRAFT';
+  }
+
+  export namespace Item {
+    /**
+     * Requested role/profile changes for this item.
+     */
+    export interface Changes {
+      /**
+       * Country-specific field changes supported by current draft transition flows.
+       */
+      country_specific_info?: unknown;
+
+      /**
+       * Employment information changes for the target role.
+       */
+      employment_info?: Changes.EmploymentInfo;
+
+      /**
+       * Work location changes for the target role.
+       */
+      work_location_info?: Changes.WorkLocationInfo;
+    }
+
+    export namespace Changes {
+      /**
+       * Employment information changes for the target role.
+       */
+      export interface EmploymentInfo {
+        /**
+         * New annual salary equivalent.
+         */
+        annual_salary_equivalent?: number;
+
+        /**
+         * New compensation currency.
+         */
+        currency?: string;
+
+        /**
+         * New department identifier for the target role.
+         */
+        department_id?: string;
+
+        /**
+         * New company employment type identifier for the target role.
+         */
+        employment_type_id?: string;
+
+        /**
+         * New offer letter equity share count.
+         */
+        equity_num_shares?: number;
+
+        /**
+         * New offer letter equity value.
+         */
+        equity_value?: number;
+
+        /**
+         * New equity vesting package identifier.
+         */
+        equity_vesting_package_id?: string;
+
+        /**
+         * New job family identifier for the target role.
+         */
+        job_family_id?: string;
+
+        /**
+         * New level identifier for the target role.
+         */
+        level_id?: string;
+
+        /**
+         * New manager role identifier for the target role.
+         */
+        manager_id?: string;
+
+        /**
+         * New annual on-target commission amount.
+         */
+        on_target_commission?: number;
+
+        /**
+         * New relocation reimbursement amount.
+         */
+        relocation_reimbursement?: number;
+
+        /**
+         * New compensation amount per salary unit.
+         */
+        salary_per_unit?: number;
+
+        /**
+         * New salary unit.
+         */
+        salary_unit?: string;
+
+        /**
+         * New start date for the target role.
+         */
+        start_date?: string;
+
+        /**
+         * New target annual bonus amount.
+         */
+        target_annual_bonus?: number;
+
+        /**
+         * New target annual bonus payment frequency.
+         */
+        target_annual_bonus_payment_frequency_unit?: 'MONTH' | 'QUARTER' | 'YEAR' | 'SEMI_ANNUAL';
+
+        /**
+         * New target annual bonus percentage.
+         */
+        target_annual_bonus_percent?: number;
+
+        /**
+         * New team identifiers for the target role.
+         */
+        teams_ids?: Array<string>;
+
+        /**
+         * New job title for the target role.
+         */
+        title?: string;
+      }
+
+      /**
+       * Work location changes for the target role.
+       */
+      export interface WorkLocationInfo {
+        /**
+         * New work country code for the target role.
+         */
+        country_code?: string;
+
+        /**
+         * New work location identifier for the target role.
+         */
+        location_id?: string;
+      }
+    }
+  }
+}
+
+export interface DraftTransitionCreateResponse {
+  /**
+   * Effective timestamp applied to the entire draft transition request.
+   */
+  effective_at: string;
+
+  /**
+   * Draft transition items to accept for asynchronous processing.
+   */
+  items: Array<DraftTransitionCreateResponse.Item>;
+
+  /**
+   * IANA timezone used to interpret and display the request's effective timestamp.
+   */
+  timezone: string;
+}
+
+export namespace DraftTransitionCreateResponse {
+  export interface Item {
+    /**
+     * Requested role/profile changes for this item.
+     */
+    changes: Item.Changes;
+
+    /**
+     * Target role identifier for this draft transition item.
+     */
+    role_id: string;
+
+    /**
+     * Controls whether this item should append to a compatible existing draft or
+     * create a new draft.
+     */
+    draft_grouping_preference?: 'APPEND_TO_MATCHING_DRAFT' | 'CREATE_NEW_DRAFT';
+  }
+
+  export namespace Item {
+    /**
+     * Requested role/profile changes for this item.
+     */
+    export interface Changes {
+      /**
+       * Country-specific field changes supported by current draft transition flows.
+       */
+      country_specific_info?: unknown;
+
+      /**
+       * Employment information changes for the target role.
+       */
+      employment_info?: Changes.EmploymentInfo;
+
+      /**
+       * Work location changes for the target role.
+       */
+      work_location_info?: Changes.WorkLocationInfo;
+    }
+
+    export namespace Changes {
+      /**
+       * Employment information changes for the target role.
+       */
+      export interface EmploymentInfo {
+        /**
+         * New annual salary equivalent.
+         */
+        annual_salary_equivalent?: number;
+
+        /**
+         * New compensation currency.
+         */
+        currency?: string;
+
+        /**
+         * New department identifier for the target role.
+         */
+        department_id?: string;
+
+        /**
+         * New company employment type identifier for the target role.
+         */
+        employment_type_id?: string;
+
+        /**
+         * New offer letter equity share count.
+         */
+        equity_num_shares?: number;
+
+        /**
+         * New offer letter equity value.
+         */
+        equity_value?: number;
+
+        /**
+         * New equity vesting package identifier.
+         */
+        equity_vesting_package_id?: string;
+
+        /**
+         * New job family identifier for the target role.
+         */
+        job_family_id?: string;
+
+        /**
+         * New level identifier for the target role.
+         */
+        level_id?: string;
+
+        /**
+         * New manager role identifier for the target role.
+         */
+        manager_id?: string;
+
+        /**
+         * New annual on-target commission amount.
+         */
+        on_target_commission?: number;
+
+        /**
+         * New relocation reimbursement amount.
+         */
+        relocation_reimbursement?: number;
+
+        /**
+         * New compensation amount per salary unit.
+         */
+        salary_per_unit?: number;
+
+        /**
+         * New salary unit.
+         */
+        salary_unit?: string;
+
+        /**
+         * New start date for the target role.
+         */
+        start_date?: string;
+
+        /**
+         * New target annual bonus amount.
+         */
+        target_annual_bonus?: number;
+
+        /**
+         * New target annual bonus payment frequency.
+         */
+        target_annual_bonus_payment_frequency_unit?: 'MONTH' | 'QUARTER' | 'YEAR' | 'SEMI_ANNUAL';
+
+        /**
+         * New target annual bonus percentage.
+         */
+        target_annual_bonus_percent?: number;
+
+        /**
+         * New team identifiers for the target role.
+         */
+        teams_ids?: Array<string>;
+
+        /**
+         * New job title for the target role.
+         */
+        title?: string;
+      }
+
+      /**
+       * Work location changes for the target role.
+       */
+      export interface WorkLocationInfo {
+        /**
+         * New work country code for the target role.
+         */
+        country_code?: string;
+
+        /**
+         * New work location identifier for the target role.
+         */
+        location_id?: string;
+      }
+    }
+  }
+}
+
+export interface DraftTransitionCreateParams {
+  /**
+   * Effective timestamp applied to the entire draft transition request.
+   */
+  effective_at: string;
+
+  /**
+   * Draft transition items to accept for asynchronous processing.
+   */
+  items: Array<DraftTransitionCreateParams.Item>;
+
+  /**
+   * IANA timezone used to interpret and display the request's effective timestamp.
+   */
+  timezone: string;
+}
+
+export namespace DraftTransitionCreateParams {
+  export interface Item {
+    /**
+     * Requested role/profile changes for this item.
+     */
+    changes: Item.Changes;
+
+    /**
+     * Target role identifier for this draft transition item.
+     */
+    role_id: string;
+
+    /**
+     * Controls whether this item should append to a compatible existing draft or
+     * create a new draft.
+     */
+    draft_grouping_preference?: 'APPEND_TO_MATCHING_DRAFT' | 'CREATE_NEW_DRAFT';
+  }
+
+  export namespace Item {
+    /**
+     * Requested role/profile changes for this item.
+     */
+    export interface Changes {
+      /**
+       * Country-specific field changes supported by current draft transition flows.
+       */
+      country_specific_info?: unknown;
+
+      /**
+       * Employment information changes for the target role.
+       */
+      employment_info?: Changes.EmploymentInfo;
+
+      /**
+       * Work location changes for the target role.
+       */
+      work_location_info?: Changes.WorkLocationInfo;
+    }
+
+    export namespace Changes {
+      /**
+       * Employment information changes for the target role.
+       */
+      export interface EmploymentInfo {
+        /**
+         * New annual salary equivalent.
+         */
+        annual_salary_equivalent?: number;
+
+        /**
+         * New compensation currency.
+         */
+        currency?: string;
+
+        /**
+         * New department identifier for the target role.
+         */
+        department_id?: string;
+
+        /**
+         * New company employment type identifier for the target role.
+         */
+        employment_type_id?: string;
+
+        /**
+         * New offer letter equity share count.
+         */
+        equity_num_shares?: number;
+
+        /**
+         * New offer letter equity value.
+         */
+        equity_value?: number;
+
+        /**
+         * New equity vesting package identifier.
+         */
+        equity_vesting_package_id?: string;
+
+        /**
+         * New job family identifier for the target role.
+         */
+        job_family_id?: string;
+
+        /**
+         * New level identifier for the target role.
+         */
+        level_id?: string;
+
+        /**
+         * New manager role identifier for the target role.
+         */
+        manager_id?: string;
+
+        /**
+         * New annual on-target commission amount.
+         */
+        on_target_commission?: number;
+
+        /**
+         * New relocation reimbursement amount.
+         */
+        relocation_reimbursement?: number;
+
+        /**
+         * New compensation amount per salary unit.
+         */
+        salary_per_unit?: number;
+
+        /**
+         * New salary unit.
+         */
+        salary_unit?: string;
+
+        /**
+         * New start date for the target role.
+         */
+        start_date?: string;
+
+        /**
+         * New target annual bonus amount.
+         */
+        target_annual_bonus?: number;
+
+        /**
+         * New target annual bonus payment frequency.
+         */
+        target_annual_bonus_payment_frequency_unit?: 'MONTH' | 'QUARTER' | 'YEAR' | 'SEMI_ANNUAL';
+
+        /**
+         * New target annual bonus percentage.
+         */
+        target_annual_bonus_percent?: number;
+
+        /**
+         * New team identifiers for the target role.
+         */
+        teams_ids?: Array<string>;
+
+        /**
+         * New job title for the target role.
+         */
+        title?: string;
+      }
+
+      /**
+       * Work location changes for the target role.
+       */
+      export interface WorkLocationInfo {
+        /**
+         * New work country code for the target role.
+         */
+        country_code?: string;
+
+        /**
+         * New work location identifier for the target role.
+         */
+        location_id?: string;
+      }
+    }
+  }
+}
+
+export declare namespace DraftTransitions {
+  export {
+    type DraftTransitionRetrieveResponse as DraftTransitionRetrieveResponse,
+    type DraftTransitionCreateResponse as DraftTransitionCreateResponse,
+    type DraftTransitionCreateParams as DraftTransitionCreateParams,
+  };
+}

package/src/resources/index.ts

@@ -203,6 +203,12 @@ export {
   type DeviceListResponsesPageCursorURL,
 } from './devices';
 export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
+export {
+  DraftTransitions,
+  type DraftTransitionRetrieveResponse,
+  type DraftTransitionCreateResponse,
+  type DraftTransitionCreateParams,
+} from './draft-transitions';
 export {
   EarningTypes,
   type EarningTypeListResponse,
@@ -444,7 +450,13 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
-export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from './metadata/metadata';
+export {
+  Metadata,
+  type MetadataExtractResponse,
+  type MetadataExtractByIdentifiersResponse,
+  type MetadataExtractParams,
+  type MetadataExtractByIdentifiersParams,
+} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,
@@ -459,6 +471,12 @@ export {
   type PackageInstallRetrieveResponse,
   type PackageInstallCreateParams,
 } from './package-installs';
+export {
+  PackageManagedInstalls,
+  type PackageManagedInstallCreateResponse,
+  type PackageManagedInstallRetrieveResponse,
+  type PackageManagedInstallCreateParams,
+} from './package-managed-installs';
 export {
   PackageSandboxLinks,
   type PackageSandboxLinkCreateResponse,
@@ -524,6 +542,7 @@ export {
   Sandboxes,
   type SandboxListResponse,
   type SandboxCreateResponse,
+  type SandboxRetrieveResponse,
   type SandboxDeveloperSandboxEntryRolesResponse,
   type SandboxListParams,
   type SandboxCreateParams,
@@ -692,11 +711,41 @@ export {
   type UserListParams,
   type UsersPageCursorURL,
 } from './users';
+export {
+  VariableCompensationPayoutLabels,
+  type VariableCompensationPayoutLabelListResponse,
+  type VariableCompensationPayoutLabelCreateResponse,
+  type VariableCompensationPayoutLabelRetrieveResponse,
+  type VariableCompensationPayoutLabelUpdateResponse,
+  type VariableCompensationPayoutLabelListParams,
+  type VariableCompensationPayoutLabelCreateParams,
+  type VariableCompensationPayoutLabelUpdateParams,
+  type VariableCompensationPayoutLabelListResponsesPageCursorURL,
+} from './variable-compensation-payout-labels';
+export {
+  VariableCompensationPayoutTypes,
+  type VariableCompensationPayoutTypeListResponse,
+  type VariableCompensationPayoutTypeCreateResponse,
+  type VariableCompensationPayoutTypeRetrieveResponse,
+  type VariableCompensationPayoutTypeUpdateResponse,
+  type VariableCompensationPayoutTypeCreateParams,
+  type VariableCompensationPayoutTypeUpdateParams,
+  type VariableCompensationPayoutTypeListResponsesPageCursorURL,
+} from './variable-compensation-payout-types';
 export {
   VariableCompensationPayoutWrites,
   type VariableCompensationPayoutWriteCreateResponse,
   type VariableCompensationPayoutWriteCreateParams,
 } from './variable-compensation-payout-writes';
+export {
+  VariableCompensationPayouts,
+  type VariableCompensationPayoutListResponse,
+  type VariableCompensationPayoutCreateResponse,
+  type VariableCompensationPayoutRetrieveResponse,
+  type VariableCompensationPayoutListParams,
+  type VariableCompensationPayoutCreateParams,
+  type VariableCompensationPayoutListResponsesPageCursorURL,
+} from './variable-compensation-payouts';
 export {
   WorkLocations,
   type WorkLocation,

package/src/resources/metadata/index.ts

@@ -13,7 +13,13 @@ export {
   type DeploymentRunGetResponse,
   type DeploymentRunCreateParams,
 } from './deployment-runs';
-export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from './metadata';
+export {
+  Metadata,
+  type MetadataExtractResponse,
+  type MetadataExtractByIdentifiersResponse,
+  type MetadataExtractParams,
+  type MetadataExtractByIdentifiersParams,
+} from './metadata';
 export { Schema, type SchemaGetResponse, type SchemaGetParams } from './schema';
 export { Types, type TypeListResponse } from './types';
 export {