@rippling/rippling-sdk 0.2.0-alpha.57 → 0.2.0-alpha.59

package/src/resources/break-policies.ts

@@ -0,0 +1,126 @@
+// 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';
+
+/**
+ * Break types configured by the company for time tracking
+ */
+export class BreakPolicies extends APIResource {
+  /**
+   * A list of break policies.
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: BreakPolicyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BreakPolicyListResponsesPageCursorURL, BreakPolicyListResponse> {
+    return this._client.getAPIList('/break-policies/', PageCursorURL<BreakPolicyListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific break policy
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BreakPolicyRetrieveResponse> {
+    return this._client.get(path`/break-policies/${id}/`, options);
+  }
+}
+
+export type BreakPolicyListResponsesPageCursorURL = PageCursorURL<BreakPolicyListResponse>;
+
+export interface BreakPolicyListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the break policy. For default policies this is the
+   * system-generated label (e.g. 'Default Break policy: All Workers | California');
+   * for custom policies this is the admin-provided description.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
+   */
+  country_code?: string;
+
+  /**
+   * Whether this is a system-seeded default policy (true) or a custom policy created
+   * by an admin (false).
+   */
+  is_default?: boolean;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface BreakPolicyRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the break policy. For default policies this is the
+   * system-generated label (e.g. 'Default Break policy: All Workers | California');
+   * for custom policies this is the admin-provided description.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
+   */
+  country_code?: string;
+
+  /**
+   * Whether this is a system-seeded default policy (true) or a custom policy created
+   * by an admin (false).
+   */
+  is_default?: boolean;
+}
+
+export interface BreakPolicyListParams {
+  cursor?: string;
+
+  order_by?: string;
+}
+
+export declare namespace BreakPolicies {
+  export {
+    type BreakPolicyListResponse as BreakPolicyListResponse,
+    type BreakPolicyRetrieveResponse as BreakPolicyRetrieveResponse,
+    type BreakPolicyListResponsesPageCursorURL as BreakPolicyListResponsesPageCursorURL,
+    type BreakPolicyListParams as BreakPolicyListParams,
+  };
+}

package/src/resources/break-types.ts

@@ -15,6 +15,8 @@ export class BreakTypes extends APIResource {
    * A list of break types.
    *
    * - Requires: `API Tier 2`
+   * - Filterable fields: `policy_id`
+   * - Expandable fields: `policy`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
@@ -30,8 +32,12 @@ export class BreakTypes extends APIResource {
   /**
    * Retrieve a specific break type
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse> {
-    return this._client.get(path`/break-types/${id}/`, options);
+  retrieve(
+    id: string,
+    query: BreakTypeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BreakTypeRetrieveResponse> {
+    return this._client.get(path`/break-types/${id}/`, { query, ...options });
   }
 }
 
@@ -67,6 +73,62 @@ export interface BreakTypeListResponse {
    * Whether this is a paid break (true) or unpaid (false).
    */
   is_paid?: boolean;
+
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  policy?: BreakTypeListResponse.Policy;
+
+  /**
+   * The ID of the break policy this break type belongs to.
+   */
+  policy_id?: string;
+}
+
+export namespace BreakTypeListResponse {
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  export interface Policy {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * The display name of the break policy. For default policies this is the
+     * system-generated label (e.g. 'Default Break policy: All Workers | California');
+     * for custom policies this is the admin-provided description.
+     */
+    name: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
+     */
+    country_code?: string;
+
+    /**
+     * Whether this is a system-seeded default policy (true) or a custom policy created
+     * by an admin (false).
+     */
+    is_default?: boolean;
+  }
 }
 
 /**
@@ -102,19 +164,84 @@ export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
    * Whether this is a paid break (true) or unpaid (false).
    */
   is_paid?: boolean;
+
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  policy?: BreakTypeRetrieveResponse.Policy;
+
+  /**
+   * The ID of the break policy this break type belongs to.
+   */
+  policy_id?: string;
+}
+
+export namespace BreakTypeRetrieveResponse {
+  /**
+   * The break policy this break type belongs to. Use ?expand=policy to inline the
+   * full policy object.
+   *
+   * Expandable field
+   */
+  export interface Policy {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * The display name of the break policy. For default policies this is the
+     * system-generated label (e.g. 'Default Break policy: All Workers | California');
+     * for custom policies this is the admin-provided description.
+     */
+    name: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
+     */
+    country_code?: string;
+
+    /**
+     * Whether this is a system-seeded default policy (true) or a custom policy created
+     * by an admin (false).
+     */
+    is_default?: boolean;
+  }
 }
 
 export interface BreakTypeListParams {
   cursor?: string;
 
+  expand?: string;
+
+  filter?: string;
+
   order_by?: string;
 }
 
+export interface BreakTypeRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace BreakTypes {
   export {
     type BreakTypeListResponse as BreakTypeListResponse,
     type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse,
     type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL,
     type BreakTypeListParams as BreakTypeListParams,
+    type BreakTypeRetrieveParams as BreakTypeRetrieveParams,
   };
 }

package/src/resources/business-structure-paths.ts

@@ -0,0 +1,157 @@
+// 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 * as JobCodesAPI from './job-codes';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Business structure used for defining hierarchy of company's org attributes
+ */
+export class BusinessStructurePaths extends APIResource {
+  /**
+   * A list of business-structure-paths.
+   *
+   * - Requires: `API Tier 2`
+   * - Expandable fields: `parent`, `job_codes`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: BusinessStructurePathListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BusinessStructurePathListResponsesPageCursorURL, BusinessStructurePathListResponse> {
+    return this._client.getAPIList(
+      '/business-structure-paths/',
+      PageCursorURL<BusinessStructurePathListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieve a specific business-structure-path
+   */
+  retrieve(
+    id: string,
+    query: BusinessStructurePathRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BusinessStructurePathRetrieveResponse> {
+    return this._client.get(path`/business-structure-paths/${id}/`, { query, ...options });
+  }
+}
+
+export type BusinessStructurePathListResponsesPageCursorURL =
+  PageCursorURL<BusinessStructurePathListResponse>;
+
+export interface BusinessStructurePathListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Ordered list of full JobCode objects for each job in the path, top to bottom.
+   * Populate via ?expand=job_codes. Requires both business-structure-paths.read and
+   * job-codes.read scopes.
+   *
+   * Expandable field
+   */
+  job_codes?: Array<JobCodesAPI.JobCode>;
+
+  /**
+   * Ordered list of Job code IDs from top to bottom.
+   */
+  job_codes_id?: Array<string>;
+
+  /**
+   * Name of the path (e.g. 'SF Office > Coffee > Barista').
+   */
+  name?: string;
+
+  parent?: unknown;
+
+  /**
+   * Id of the parent BusinessStructurePath. None for root path.
+   */
+  parent_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface BusinessStructurePathRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Ordered list of full JobCode objects for each job in the path, top to bottom.
+   * Populate via ?expand=job_codes. Requires both business-structure-paths.read and
+   * job-codes.read scopes.
+   *
+   * Expandable field
+   */
+  job_codes?: Array<JobCodesAPI.JobCode>;
+
+  /**
+   * Ordered list of Job code IDs from top to bottom.
+   */
+  job_codes_id?: Array<string>;
+
+  /**
+   * Name of the path (e.g. 'SF Office > Coffee > Barista').
+   */
+  name?: string;
+
+  parent?: unknown;
+
+  /**
+   * Id of the parent BusinessStructurePath. None for root path.
+   */
+  parent_id?: string;
+}
+
+export interface BusinessStructurePathListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  order_by?: string;
+}
+
+export interface BusinessStructurePathRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace BusinessStructurePaths {
+  export {
+    type BusinessStructurePathListResponse as BusinessStructurePathListResponse,
+    type BusinessStructurePathRetrieveResponse as BusinessStructurePathRetrieveResponse,
+    type BusinessStructurePathListResponsesPageCursorURL as BusinessStructurePathListResponsesPageCursorURL,
+    type BusinessStructurePathListParams as BusinessStructurePathListParams,
+    type BusinessStructurePathRetrieveParams as BusinessStructurePathRetrieveParams,
+  };
+}

package/src/resources/candidate-applications.ts

@@ -17,7 +17,7 @@ export class CandidateApplications extends APIResource {
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
-    query: CandidateApplicationListParams | null | undefined = {},
+    query: CandidateApplicationListParams,
     options?: RequestOptions,
   ): PagePromise<CandidateApplicationListResponsesPageCursorURL, CandidateApplicationListResponse> {
     return this._client.getAPIList(
@@ -80,6 +80,11 @@ export interface CandidateApplicationListResponse {
 }
 
 export interface CandidateApplicationListParams {
+  /**
+   * The unique identifier of the candidate whose applications to list.
+   */
+  candidate_id: string;
+
   cursor?: string;
 
   expand?: string;

package/src/resources/employee-documents.ts

@@ -34,7 +34,8 @@ export interface EmployeeDocumentCreateResponse {
   created_at: string;
 
   /**
-   * List of role/document items to process. Max 1 per request.
+   * List of role/document items to process. No limit on number of items; total
+   * documents across all items must not exceed 250.
    */
   items: Array<EmployeeDocumentCreateResponse.Item>;
 
@@ -50,7 +51,7 @@ export namespace EmployeeDocumentCreateResponse {
    */
   export interface Item {
     /**
-     * Documents to attach to the role. Max 50 per role item. Each entry references a
+     * Documents to attach to the role. At least one required. Each entry references a
      * FileUploadTracker by file_id.
      */
     documents: Array<Item.Document>;
@@ -59,6 +60,26 @@ export namespace EmployeeDocumentCreateResponse {
      * Id of the worker to attach documents to.
      */
     worker_id: string;
+
+    /**
+     * Optional destination folder for documents. Accepts either: (1) an ObjectId
+     * string for custom folders, or (2) a default folder identifier ('root',
+     * 'confidential_documents', 'notices', 'work_authorization'). When omitted,
+     * documents land at the root of the worker's profile (current default behavior).
+     * When supplied, the folder must exist, be in an active state, be provisioned for
+     * the target worker, and the caller must have UPLOAD permission on it — otherwise
+     * behavior is governed by `on_invalid_folder`.
+     */
+    folder_id?: string;
+
+    /**
+     * Fallback behavior when `folder_id` is supplied but inaccessible. 'fail'
+     * (default) rejects each affected document with FOLDER_ACCESS_ERROR.
+     * 'fallback_to_root' uploads to the worker's root profile instead and attaches a
+     * FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is
+     * omitted.
+     */
+    on_invalid_folder?: 'fail' | 'fallback_to_root';
   }
 
   export namespace Item {
@@ -87,7 +108,8 @@ export namespace EmployeeDocumentCreateResponse {
 
 export interface EmployeeDocumentCreateParams {
   /**
-   * List of role/document items to process. Max 1 per request.
+   * List of role/document items to process. No limit on number of items; total
+   * documents across all items must not exceed 250.
    */
   items: Array<EmployeeDocumentCreateParams.Item>;
 }
@@ -98,7 +120,7 @@ export namespace EmployeeDocumentCreateParams {
    */
   export interface Item {
     /**
-     * Documents to attach to the role. Max 50 per role item. Each entry references a
+     * Documents to attach to the role. At least one required. Each entry references a
      * FileUploadTracker by file_id.
      */
     documents: Array<Item.Document>;
@@ -107,6 +129,26 @@ export namespace EmployeeDocumentCreateParams {
      * Id of the worker to attach documents to.
      */
     worker_id: string;
+
+    /**
+     * Optional destination folder for documents. Accepts either: (1) an ObjectId
+     * string for custom folders, or (2) a default folder identifier ('root',
+     * 'confidential_documents', 'notices', 'work_authorization'). When omitted,
+     * documents land at the root of the worker's profile (current default behavior).
+     * When supplied, the folder must exist, be in an active state, be provisioned for
+     * the target worker, and the caller must have UPLOAD permission on it — otherwise
+     * behavior is governed by `on_invalid_folder`.
+     */
+    folder_id?: string;
+
+    /**
+     * Fallback behavior when `folder_id` is supplied but inaccessible. 'fail'
+     * (default) rejects each affected document with FOLDER_ACCESS_ERROR.
+     * 'fallback_to_root' uploads to the worker's root profile instead and attaches a
+     * FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is
+     * omitted.
+     */
+    on_invalid_folder?: 'fail' | 'fallback_to_root';
   }
 
   export namespace Item {

package/src/resources/index.ts

@@ -1,11 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  BreakPolicies,
+  type BreakPolicyListResponse,
+  type BreakPolicyRetrieveResponse,
+  type BreakPolicyListParams,
+  type BreakPolicyListResponsesPageCursorURL,
+} from './break-policies';
 export {
   BreakTypes,
   type BreakTypeListResponse,
   type BreakTypeRetrieveResponse,
   type BreakTypeListParams,
+  type BreakTypeRetrieveParams,
   type BreakTypeListResponsesPageCursorURL,
 } from './break-types';
 export {
@@ -27,6 +35,14 @@ export {
   type BusinessPartnerRetrieveParams,
   type BusinessPartnersPageCursorURL,
 } from './business-partners';
+export {
+  BusinessStructurePaths,
+  type BusinessStructurePathListResponse,
+  type BusinessStructurePathRetrieveResponse,
+  type BusinessStructurePathListParams,
+  type BusinessStructurePathRetrieveParams,
+  type BusinessStructurePathListResponsesPageCursorURL,
+} from './business-structure-paths';
 export {
   CandidateApplications,
   type CandidateApplicationListResponse,
@@ -189,6 +205,7 @@ export {
   type JobAssignmentCreateParams,
   type JobAssignmentRetrieveParams,
   type JobAssignmentUpdateParams,
+  type JobAssignmentDeleteParams,
   type JobAssignmentListChangeLogParams,
   type AttributeChangeDetailsPageCursorURL,
   type JobAssignmentsPageCursorURL,
@@ -316,11 +333,6 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
-export {
-  Metadata,
-  type MetadataListResponse,
-  type MetadataListResponsesPageCursorURL,
-} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,

package/src/resources/job-assignments.ts

@@ -58,8 +58,13 @@ export class JobAssignments extends APIResource {
   /**
    * Delete a job assignment
    */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
+  delete(
+    id: string,
+    body: JobAssignmentDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
     return this._client.delete(path`/job-assignments/${id}/`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -321,6 +326,20 @@ export interface JobAssignmentUpdateParams {
   job_pay_rate_effective_from?: string;
 }
 
+export interface JobAssignmentDeleteParams {
+  /**
+   * Reason recorded on the scheduled unassignment.
+   */
+  change_reason?: string;
+
+  /**
+   * Date and time the unassignment becomes effective (ISO 8601 format, e.g.,
+   * 2025-11-07T17:00:00.000+00:00). When provided, schedules a future unassignment
+   * instead of deleting the job assignment immediately.
+   */
+  effective_from?: string;
+}
+
 export interface JobAssignmentListChangeLogParams {
   cursor?: string;
 
@@ -340,6 +359,7 @@ export declare namespace JobAssignments {
     type JobAssignmentCreateParams as JobAssignmentCreateParams,
     type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
     type JobAssignmentUpdateParams as JobAssignmentUpdateParams,
+    type JobAssignmentDeleteParams as JobAssignmentDeleteParams,
     type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
   };
 }