@rippling/rippling-sdk 0.2.0-alpha.24 → 0.2.0-alpha.26

package/src/resources/custom-settings.ts

@@ -0,0 +1,371 @@
+// 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';
+
+export class CustomSettings extends APIResource {
+  /**
+   * A List of Setting
+   *
+   * - Requires: `Functions API`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: CustomSettingListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
+    return this._client.getAPIList('/custom-settings', PageCursorURL<CustomSettingListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Create a new Setting
+   */
+  create(
+    body: CustomSettingCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomSettingCreateResponse> {
+    return this._client.post('/custom-settings', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific Setting
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CustomSettingRetrieveResponse> {
+    return this._client.get(path`/custom-settings/${id}`, options);
+  }
+
+  /**
+   * Updated a specific Setting
+   */
+  update(
+    id: string,
+    body: CustomSettingUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomSettingUpdateResponse> {
+    return this._client.patch(path`/custom-settings/${id}`, { body, ...options });
+  }
+
+  /**
+   * Delete a Setting
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-settings/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomSettingListResponsesPageCursorURL = PageCursorURL<CustomSettingListResponse>;
+
+export interface CustomSettingListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CustomSettingRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingListParams {
+  cursor?: string;
+
+  order_by?: string;
+}
+
+export interface CustomSettingCreateParams {
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export interface CustomSettingUpdateParams {
+  /**
+   * The unique api name of the setting
+   */
+  api_name?: string;
+
+  /**
+   * Boolean value of the setting, if it has boolean data type
+   */
+  boolean_value?: boolean;
+
+  /**
+   * Data type of the setting
+   */
+  data_type?: string;
+
+  /**
+   * The display name of setting
+   */
+  display_name?: string;
+
+  /**
+   * Number value of the setting, if it has number data type
+   */
+  number_value?: number;
+
+  /**
+   * Secret value of the setting, if it has secret data type
+   */
+  secret_value?: string;
+
+  /**
+   * String value of the setting, if it has string data type
+   */
+  string_value?: string;
+}
+
+export declare namespace CustomSettings {
+  export {
+    type CustomSettingListResponse as CustomSettingListResponse,
+    type CustomSettingCreateResponse as CustomSettingCreateResponse,
+    type CustomSettingRetrieveResponse as CustomSettingRetrieveResponse,
+    type CustomSettingUpdateResponse as CustomSettingUpdateResponse,
+    type CustomSettingListResponsesPageCursorURL as CustomSettingListResponsesPageCursorURL,
+    type CustomSettingListParams as CustomSettingListParams,
+    type CustomSettingCreateParams as CustomSettingCreateParams,
+    type CustomSettingUpdateParams as CustomSettingUpdateParams,
+  };
+}

package/src/resources/departments.ts

@@ -22,6 +22,13 @@ export class Departments extends APIResource {
     return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
   }
 
+  /**
+   * Create a new department
+   */
+  create(body: DepartmentCreateParams, options?: RequestOptions): APIPromise<Department> {
+    return this._client.post('/departments', { body, ...options });
+  }
+
   /**
    * Retrieve a specific department
    */
@@ -32,6 +39,13 @@ export class Departments extends APIResource {
   ): APIPromise<DepartmentRetrieveResponse> {
     return this._client.get(path`/departments/${id}`, { query, ...options });
   }
+
+  /**
+   * Updated a specific department
+   */
+  update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
+    return this._client.patch(path`/departments/${id}`, { body, ...options });
+  }
 }
 
 export type DepartmentsPageCursorURL = PageCursorURL<Department>;
@@ -102,16 +116,52 @@ export interface DepartmentListParams {
   order_by?: string;
 }
 
+export interface DepartmentCreateParams {
+  /**
+   * The name of the department.
+   */
+  name: string;
+
+  /**
+   * The parent department.
+   */
+  parent_id?: string;
+
+  /**
+   * Reference code of the department.
+   */
+  reference_code?: string;
+}
+
 export interface DepartmentRetrieveParams {
   expand?: string;
 }
 
+export interface DepartmentUpdateParams {
+  /**
+   * The name of the department.
+   */
+  name: string;
+
+  /**
+   * The parent department.
+   */
+  parent_id?: string;
+
+  /**
+   * Reference code of the department.
+   */
+  reference_code?: string;
+}
+
 export declare namespace Departments {
   export {
     type Department as Department,
     type DepartmentRetrieveResponse as DepartmentRetrieveResponse,
     type DepartmentsPageCursorURL as DepartmentsPageCursorURL,
     type DepartmentListParams as DepartmentListParams,
+    type DepartmentCreateParams as DepartmentCreateParams,
     type DepartmentRetrieveParams as DepartmentRetrieveParams,
+    type DepartmentUpdateParams as DepartmentUpdateParams,
   };
 }

package/src/resources/draft-hires.ts

@@ -152,6 +152,13 @@ export namespace DraftHireCreateParams {
        */
       duties?: string;
 
+      /**
+       * EEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS,
+       * SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS,
+       * SERVICE_WORKERS)
+       */
+      eeoc_job_classification?: string;
+
       /**
        * Equity number of shares
        */
@@ -359,6 +366,11 @@ export namespace DraftHireCreateParams {
        */
       locale?: PersonalInfo.Locale;
 
+      /**
+       * Personal phone number
+       */
+      personal_phone?: PersonalInfo.PersonalPhone;
+
       /**
        * Race of the candidate
        */
@@ -455,6 +467,26 @@ export namespace DraftHireCreateParams {
          */
         timezone?: string;
       }
+
+      /**
+       * Personal phone number
+       */
+      export interface PersonalPhone {
+        /**
+         * Country code for the phone number
+         */
+        country_code?: string;
+
+        /**
+         * Phone number extension
+         */
+        extension?: string;
+
+        /**
+         * National phone number without country code
+         */
+        national_number?: string;
+      }
     }
 
     /**

package/src/resources/functions/executions.ts

@@ -17,10 +17,10 @@ export class Executions extends APIResource {
     functionAPIName: string,
     query: ExecutionListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ExecutionListResponsesPageCursorURL, ExecutionListResponse> {
+  ): PagePromise<FunctionExecutionsPageCursorURL, FunctionExecution> {
     return this._client.getAPIList(
       path`/functions/${functionAPIName}/executions/`,
-      PageCursorURL<ExecutionListResponse>,
+      PageCursorURL<FunctionExecution>,
       { query, ...options },
     );
   }
@@ -32,7 +32,7 @@ export class Executions extends APIResource {
     functionAPIName: string,
     body: ExecutionCreateParams,
     options?: RequestOptions,
-  ): APIPromise<ExecutionCreateResponse> {
+  ): APIPromise<FunctionExecution> {
     return this._client.post(path`/functions/${functionAPIName}/executions/`, { body, ...options });
   }
 
@@ -43,7 +43,7 @@ export class Executions extends APIResource {
     executionID: string,
     params: ExecutionRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<ExecutionRetrieveResponse> {
+  ): APIPromise<FunctionExecution> {
     const { function_api_name } = params;
     return this._client.get(path`/functions/${function_api_name}/executions/${executionID}/`, options);
   }
@@ -63,103 +63,9 @@ export class Executions extends APIResource {
   }
 }
 
-export type ExecutionListResponsesPageCursorURL = PageCursorURL<ExecutionListResponse>;
+export type FunctionExecutionsPageCursorURL = PageCursorURL<FunctionExecution>;
 
-export interface ExecutionListResponse {
-  /**
-   * Identifier field
-   */
-  id: string;
-
-  /**
-   * Record creation date
-   */
-  created_at: string;
-
-  /**
-   * The ID of the function this execution belongs to
-   */
-  function_id: string;
-
-  /**
-   * The inputs of the execution
-   */
-  inputs: unknown;
-
-  /**
-   * Record update date
-   */
-  updated_at: string;
-
-  /**
-   * The end time of the execution
-   */
-  finished_at?: string;
-
-  /**
-   * The outputs of the execution
-   */
-  outputs?: unknown;
-
-  /**
-   * The start time of the execution
-   */
-  started_at?: string;
-
-  /**
-   * The status of the execution
-   */
-  status?: string;
-}
-
-export interface ExecutionCreateResponse {
-  /**
-   * Identifier field
-   */
-  id: string;
-
-  /**
-   * Record creation date
-   */
-  created_at: string;
-
-  /**
-   * The ID of the function this execution belongs to
-   */
-  function_id: string;
-
-  /**
-   * The inputs of the execution
-   */
-  inputs: unknown;
-
-  /**
-   * Record update date
-   */
-  updated_at: string;
-
-  /**
-   * The end time of the execution
-   */
-  finished_at?: string;
-
-  /**
-   * The outputs of the execution
-   */
-  outputs?: unknown;
-
-  /**
-   * The start time of the execution
-   */
-  started_at?: string;
-
-  /**
-   * The status of the execution
-   */
-  status?: string;
-}
-
-export interface ExecutionRetrieveResponse {
+export interface FunctionExecution {
   /**
    * Identifier field
    */
@@ -260,11 +166,9 @@ export interface ExecutionListLogsParams {
 
 export declare namespace Executions {
   export {
-    type ExecutionListResponse as ExecutionListResponse,
-    type ExecutionCreateResponse as ExecutionCreateResponse,
-    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
+    type FunctionExecution as FunctionExecution,
     type ExecutionListLogsResponse as ExecutionListLogsResponse,
-    type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type FunctionExecutionsPageCursorURL as FunctionExecutionsPageCursorURL,
     type ExecutionListParams as ExecutionListParams,
     type ExecutionCreateParams as ExecutionCreateParams,
     type ExecutionRetrieveParams as ExecutionRetrieveParams,

package/src/resources/functions/functions.ts

@@ -14,15 +14,13 @@ import {
 import * as ExecutionsAPI from './executions';
 import {
   ExecutionCreateParams,
-  ExecutionCreateResponse,
   ExecutionListLogsParams,
   ExecutionListLogsResponse,
   ExecutionListParams,
-  ExecutionListResponse,
-  ExecutionListResponsesPageCursorURL,
   ExecutionRetrieveParams,
-  ExecutionRetrieveResponse,
   Executions,
+  FunctionExecution,
+  FunctionExecutionsPageCursorURL,
 } from './executions';
 import { APIPromise } from '../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
@@ -216,11 +214,9 @@ export declare namespace Functions {
 
   export {
     Executions as Executions,
-    type ExecutionListResponse as ExecutionListResponse,
-    type ExecutionCreateResponse as ExecutionCreateResponse,
-    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
+    type FunctionExecution as FunctionExecution,
     type ExecutionListLogsResponse as ExecutionListLogsResponse,
-    type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type FunctionExecutionsPageCursorURL as FunctionExecutionsPageCursorURL,
     type ExecutionListParams as ExecutionListParams,
     type ExecutionCreateParams as ExecutionCreateParams,
     type ExecutionRetrieveParams as ExecutionRetrieveParams,

package/src/resources/functions/index.ts

@@ -11,15 +11,13 @@ export {
 } from './deployments';
 export {
   Executions,
-  type ExecutionListResponse,
-  type ExecutionCreateResponse,
-  type ExecutionRetrieveResponse,
+  type FunctionExecution,
   type ExecutionListLogsResponse,
   type ExecutionListParams,
   type ExecutionCreateParams,
   type ExecutionRetrieveParams,
   type ExecutionListLogsParams,
-  type ExecutionListResponsesPageCursorURL,
+  type FunctionExecutionsPageCursorURL,
 } from './executions';
 export {
   Functions,