@rippling/rippling-sdk 0.2.0-alpha.21 → 0.2.0-alpha.22

package/src/resources/draft-hires.ts

@@ -0,0 +1,519 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class DraftHires extends APIResource {
+  /**
+   * Create bulk draft hire
+   */
+  create(body: DraftHireCreateParams, options?: RequestOptions): APIPromise<DraftHireCreateResponse> {
+    return this._client.post('/draft-hires/', { body, ...options });
+  }
+}
+
+/**
+ * Response model for bulk draft hire creation.
+ */
+export interface DraftHireCreateResponse {
+  /**
+   * List of invalid draft hire requests
+   */
+  invalid_items?: Array<DraftHireCreateResponse.InvalidItem>;
+
+  /**
+   * Detailed results for each draft hire item
+   */
+  successful_results?: Array<DraftHireCreateResponse.SuccessfulResult>;
+}
+
+export namespace DraftHireCreateResponse {
+  /**
+   * Result for an individual draft hire creation.
+   */
+  export interface InvalidItem {
+    /**
+     * External reference ID from the request
+     */
+    reference_id: string;
+
+    /**
+     * Status of the creation (success, error, warning)
+     */
+    status: string;
+
+    /**
+     * Generated draft hire ID if successful
+     */
+    draft_hire_id?: string;
+
+    /**
+     * List of validation errors if any
+     */
+    errors?: Array<string>;
+
+    /**
+     * Success or error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Result for an individual draft hire creation.
+   */
+  export interface SuccessfulResult {
+    /**
+     * External reference ID from the request
+     */
+    reference_id: string;
+
+    /**
+     * Status of the creation (success, error, warning)
+     */
+    status: string;
+
+    /**
+     * Generated draft hire ID if successful
+     */
+    draft_hire_id?: string;
+
+    /**
+     * List of validation errors if any
+     */
+    errors?: Array<string>;
+
+    /**
+     * Success or error message
+     */
+    message?: string;
+  }
+}
+
+export interface DraftHireCreateParams {
+  /**
+   * List of draft hires
+   */
+  draft_hires: Array<DraftHireCreateParams.DraftHire>;
+}
+
+export namespace DraftHireCreateParams {
+  /**
+   * A draft hire represents a candidate who has been offered a position but hasn't started yet.
+   *
+   *     This class provides Platform API access to draft hire data stored as RoleWithCompany instances
+   *     in a candidate state, allowing external systems to create and manage draft hires.
+   */
+  export interface DraftHire {
+    /**
+     * Employment information for the draft hire position
+     */
+    employment_info: DraftHire.EmploymentInfo;
+
+    /**
+     * Personal information for the draft hire candidate
+     */
+    personal_info: DraftHire.PersonalInfo;
+
+    /**
+     * External reference ID for tracking purposes
+     */
+    reference_id: string;
+
+    /**
+     * Work location information
+     */
+    work_location_info: DraftHire.WorkLocationInfo;
+
+    /**
+     * Custom fields for the draft hire
+     */
+    custom_fields?: Array<DraftHire.CustomField>;
+  }
+
+  export namespace DraftHire {
+    /**
+     * Employment information for the draft hire position
+     */
+    export interface EmploymentInfo {
+      /**
+       * Employment type ID
+       */
+      employment_type_id: string;
+
+      /**
+       * Contract end date
+       */
+      contract_end_date?: string;
+
+      /**
+       * Currency
+       */
+      currency?: string;
+
+      /**
+       * Department ID
+       */
+      department_id?: string;
+
+      /**
+       * Duties
+       */
+      duties?: string;
+
+      /**
+       * Equity number of shares
+       */
+      equity_num_shares?: number;
+
+      /**
+       * Equity value
+       */
+      equity_value?: number;
+
+      /**
+       * Equity vesting schedule
+       */
+      equity_vesting_schedule?: EmploymentInfo.EquityVestingSchedule;
+
+      /**
+       * Job title
+       */
+      job_title?: string;
+
+      /**
+       * Legal entity ID
+       */
+      legal_entity_id?: string;
+
+      /**
+       * Level ID
+       */
+      level_id?: string;
+
+      /**
+       * Manager ID
+       */
+      manager_id?: string;
+
+      /**
+       * Offer expiration date
+       */
+      offer_expiration_date?: string;
+
+      /**
+       * On target commission
+       */
+      on_target_commission?: number;
+
+      /**
+       * Overtime exemption
+       */
+      overtime_exemption?: 'exempt' | 'non-exempt';
+
+      /**
+       * Probation end date
+       */
+      probation_end_date?: string;
+
+      /**
+       * Relocation reimbursement
+       */
+      relocation_reimbursement?: number;
+
+      /**
+       * Salary per unit
+       */
+      salary_per_unit?: number;
+
+      /**
+       * Salary unit
+       */
+      salary_unit?: string;
+
+      /**
+       * Signing bonus
+       */
+      signing_bonus?: number;
+
+      /**
+       * Start date
+       */
+      start_date?: string;
+
+      /**
+       * Target annual bonus
+       */
+      target_annual_bonus?: number;
+
+      /**
+       * Teams IDs
+       */
+      teams_ids?: Array<string>;
+
+      /**
+       * Title
+       */
+      title?: string;
+
+      /**
+       * Weekly hours
+       */
+      weekly_hours?: number;
+
+      /**
+       * Work email
+       */
+      work_email?: string;
+    }
+
+    export namespace EmploymentInfo {
+      /**
+       * Equity vesting schedule
+       */
+      export interface EquityVestingSchedule {
+        /**
+         * Required company ID for the vesting schedule
+         */
+        company_id: string;
+
+        /**
+         * Name of the vesting schedule
+         */
+        _name?: string;
+
+        /**
+         * Number of cliff months before vesting begins
+         */
+        cliffMonths?: number;
+
+        /**
+         * Number of continuous vesting months
+         */
+        continuousVestingMonths?: number;
+
+        /**
+         * Percentage of initial vesting as decimal
+         */
+        percentageInitialVesting?: number;
+
+        /**
+         * Spoke ID for the vesting schedule
+         */
+        spokeId?: string;
+
+        /**
+         * Total number of vesting months
+         */
+        totalVestingMonths?: number;
+
+        /**
+         * Total number of vesting years
+         */
+        totalVestingYears?: number;
+
+        /**
+         * Type of vesting schedule
+         */
+        vestingType?: string;
+      }
+    }
+
+    /**
+     * Personal information for the draft hire candidate
+     */
+    export interface PersonalInfo {
+      /**
+       * Invite email of the candidate
+       */
+      invite_email: string;
+
+      /**
+       * Name of the candidate
+       */
+      name: PersonalInfo.Name;
+
+      /**
+       * Citizenship of the candidate
+       */
+      citizenship?: string;
+
+      /**
+       * Date of birth
+       */
+      date_of_birth?: string;
+
+      /**
+       * Emergency contact name
+       */
+      emergency_contact_name?: string;
+
+      /**
+       * Emergency contact phone
+       */
+      emergency_contact_phone?: PersonalInfo.EmergencyContactPhone;
+
+      /**
+       * Ethnicity of the candidate
+       */
+      ethnicity?: string;
+
+      /**
+       * Gender of the candidate
+       */
+      gender?: string;
+
+      /**
+       * Home address of the candidate
+       */
+      home_address?: Shared.Address;
+
+      /**
+       * Locale of the candidate
+       */
+      locale?: PersonalInfo.Locale;
+
+      /**
+       * Race of the candidate
+       */
+      race?: string;
+
+      /**
+       * Social security number of the candidate
+       */
+      ssn?: string;
+    }
+
+    export namespace PersonalInfo {
+      /**
+       * Name of the candidate
+       */
+      export interface Name {
+        /**
+         * First name or given name
+         */
+        first?: string;
+
+        /**
+         * Last name or family name
+         */
+        last?: string;
+
+        /**
+         * Middle name(s)
+         */
+        middle?: string;
+
+        /**
+         * Preferred nickname or informal name
+         */
+        nickname?: string;
+
+        /**
+         * Name suffix (e.g., Jr., Sr., III)
+         */
+        suffix?: string;
+
+        /**
+         * Title or honorific (e.g., Mr., Ms., Dr.)
+         */
+        title?: string;
+      }
+
+      /**
+       * Emergency contact phone
+       */
+      export interface EmergencyContactPhone {
+        /**
+         * Country code for the phone number
+         */
+        country_code?: string;
+
+        /**
+         * Phone number extension
+         */
+        extension?: string;
+
+        /**
+         * National phone number without country code
+         */
+        national_number?: string;
+      }
+
+      /**
+       * Locale of the candidate
+       */
+      export interface Locale {
+        /**
+         * The primary language code
+         */
+        language_code?: string;
+
+        /**
+         * Additional language inspection data
+         */
+        language_inspection?: Array<string>;
+
+        /**
+         * The locale code for formatting
+         */
+        locale_code?: string;
+
+        /**
+         * The region code
+         */
+        region_code?: string;
+
+        /**
+         * The user's timezone
+         */
+        timezone?: string;
+      }
+    }
+
+    /**
+     * Work location information
+     */
+    export interface WorkLocationInfo {
+      /**
+       * Country code of the work location
+       */
+      country_code?: string;
+
+      /**
+       * Whether the work location is remote
+       */
+      is_remote?: boolean;
+
+      /**
+       * Work location ID
+       */
+      location_id?: string;
+    }
+
+    /**
+     * Custom field information for a draft hire.
+     *
+     *     Custom fields are associated with RoleWithCompany model.
+     */
+    export interface CustomField {
+      /**
+       * Name of the custom field
+       */
+      field_name: string;
+
+      /**
+       * Value of the custom field
+       */
+      field_value: unknown;
+    }
+  }
+}
+
+export declare namespace DraftHires {
+  export {
+    type DraftHireCreateResponse as DraftHireCreateResponse,
+    type DraftHireCreateParams as DraftHireCreateParams,
+  };
+}

package/src/resources/employment-types.ts

@@ -8,13 +8,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class EmploymentTypes extends APIResource {
-  /**
-   * Retrieve a specific employment type
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<EmploymentTypeRetrieveResponse> {
-    return this._client.get(path`/employment-types/${id}`, options);
-  }
-
   /**
    * A List of employment types
    *
@@ -30,6 +23,13 @@ export class EmploymentTypes extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a specific employment type
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EmploymentTypeRetrieveResponse> {
+    return this._client.get(path`/employment-types/${id}`, options);
+  }
 }
 
 export type CompanyEmploymentTypesPageCursorURL = PageCursorURL<CompanyEmploymentType>;

package/src/resources/functions/deployments.ts

@@ -6,6 +6,15 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Deployments extends APIResource {
+  /**
+   * A List of function deployments
+   *
+   * - Requires: `API Tier 2`
+   */
+  list(functionAPIName: string, options?: RequestOptions): APIPromise<DeploymentListResponse> {
+    return this._client.get(path`/functions/${functionAPIName}/deployments/`, options);
+  }
+
   /**
    * Create a new function deployment
    */
@@ -29,19 +38,10 @@ export class Deployments extends APIResource {
     return this._client.get(path`/functions/${function_api_name}/deployments/${deploymentID}/`, options);
   }
 
-  /**
-   * A List of function deployments
-   *
-   * - Requires: `Functions API`
-   */
-  list(functionAPIName: string, options?: RequestOptions): APIPromise<DeploymentListResponse> {
-    return this._client.get(path`/functions/${functionAPIName}/deployments/`, options);
-  }
-
   /**
    * A List of function deployment logs
    *
-   * - Requires: `Functions API`
+   * - Requires: `API Tier 2`
    */
   listLogs(
     deploymentID: string,

package/src/resources/functions/executions.ts

@@ -7,6 +7,24 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Executions extends APIResource {
+  /**
+   * A List of function executions
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    functionAPIName: string,
+    query: ExecutionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ExecutionListResponsesPageCursorURL, ExecutionListResponse> {
+    return this._client.getAPIList(
+      path`/functions/${functionAPIName}/executions/`,
+      PageCursorURL<ExecutionListResponse>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Create a new function execution
    */
@@ -30,28 +48,10 @@ export class Executions extends APIResource {
     return this._client.get(path`/functions/${function_api_name}/executions/${executionID}/`, options);
   }
 
-  /**
-   * A List of function executions
-   *
-   * - Requires: `Functions API`
-   * - Sortable fields: `id`, `created_at`, `updated_at`
-   */
-  list(
-    functionAPIName: string,
-    query: ExecutionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ExecutionListResponsesPageCursorURL, ExecutionListResponse> {
-    return this._client.getAPIList(
-      path`/functions/${functionAPIName}/executions/`,
-      PageCursorURL<ExecutionListResponse>,
-      { query, ...options },
-    );
-  }
-
   /**
    * A List of function execution logs
    *
-   * - Requires: `Functions API`
+   * - Requires: `API Tier 2`
    */
   listLogs(
     executionID: string,
@@ -65,7 +65,7 @@ export class Executions extends APIResource {
 
 export type ExecutionListResponsesPageCursorURL = PageCursorURL<ExecutionListResponse>;
 
-export interface ExecutionCreateResponse {
+export interface ExecutionListResponse {
   /**
    * Identifier field
    */
@@ -112,7 +112,7 @@ export interface ExecutionCreateResponse {
   status?: string;
 }
 
-export interface ExecutionRetrieveResponse {
+export interface ExecutionCreateResponse {
   /**
    * Identifier field
    */
@@ -159,7 +159,7 @@ export interface ExecutionRetrieveResponse {
   status?: string;
 }
 
-export interface ExecutionListResponse {
+export interface ExecutionRetrieveResponse {
   /**
    * Identifier field
    */
@@ -239,6 +239,10 @@ export namespace ExecutionListLogsResponse {
   }
 }
 
+export interface ExecutionListParams {
+  order_by?: string;
+}
+
 export interface ExecutionCreateParams {
   /**
    * The inputs of the execution
@@ -250,24 +254,20 @@ export interface ExecutionRetrieveParams {
   function_api_name: string;
 }
 
-export interface ExecutionListParams {
-  order_by?: string;
-}
-
 export interface ExecutionListLogsParams {
   function_api_name: string;
 }
 
 export declare namespace Executions {
   export {
+    type ExecutionListResponse as ExecutionListResponse,
     type ExecutionCreateResponse as ExecutionCreateResponse,
     type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
-    type ExecutionListResponse as ExecutionListResponse,
     type ExecutionListLogsResponse as ExecutionListLogsResponse,
     type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type ExecutionListParams as ExecutionListParams,
     type ExecutionCreateParams as ExecutionCreateParams,
     type ExecutionRetrieveParams as ExecutionRetrieveParams,
-    type ExecutionListParams as ExecutionListParams,
     type ExecutionListLogsParams as ExecutionListLogsParams,
   };
 }