@rippling/rippling-sdk 0.2.0-alpha.85 → 0.2.0-alpha.87

package/src/resources/custom-objects/custom-objects.ts

@@ -89,6 +89,7 @@ export class CustomObjects extends APIResource {
 
 export type CustomObjectsPageCursorURL = PageCursorURL<CustomObject>;
 
+/** Public custom-object DTO returned by the REST API. */
 export interface CustomObject {
   /**
    * Identifier field
@@ -151,6 +152,7 @@ export interface CustomObject {
   owner_id?: string;
 }
 
+/** Request payload accepted by `client.customObjects.create(...)`. */
 export interface CustomObjectCreateParams {
   /**
    * The category that this custom object belongs to.
@@ -168,6 +170,7 @@ export interface CustomObjectCreateParams {
   name?: string;
 }
 
+/** Request payload accepted by `client.customObjects.update(...)`. */
 export interface CustomObjectUpdateParams {
   /**
    * The category that this custom object belongs to.
@@ -179,6 +182,11 @@ export interface CustomObjectUpdateParams {
    */
   description?: string;
 
+  /**
+   * Whether to record the history of the custom object.
+   */
+  enable_history?: boolean;
+
   /**
    * The name of the custom object.
    */

package/src/resources/custom-objects/fields.ts

@@ -77,6 +77,175 @@ export class Fields extends APIResource {
 
 export type CustomObjectFieldsPageCursorURL = PageCursorURL<CustomObjectField>;
 
+/** Supported wire-level field-type identifiers for custom-object fields. */
+export type CustomObjectFieldType =
+  | 'TEXT'
+  | 'LONG_TEXT'
+  | 'EMAIL'
+  | 'URL'
+  | 'PHONE_NUMBER'
+  | 'NUMBER'
+  | 'CURRENCY'
+  | 'PERCENTAGE'
+  | 'DATE'
+  | 'DATETIME'
+  | 'TIME'
+  | 'SELECT'
+  | 'RADIO'
+  | 'BOOLEAN'
+  | 'FILE'
+  | 'OG_REFERENCE_FIELD';
+
+/** Structured `data_type` payload for text fields. */
+export interface TextCustomObjectFieldDataType {
+  field_type: 'TEXT';
+  max_length?: number;
+}
+
+/** Structured `data_type` payload for long-text fields. */
+export interface LongTextCustomObjectFieldDataType {
+  field_type: 'LONG_TEXT';
+  max_length?: number;
+}
+
+/** Structured `data_type` payload for email fields. */
+export interface EmailCustomObjectFieldDataType {
+  field_type: 'EMAIL';
+}
+
+/** Structured `data_type` payload for URL fields. */
+export interface URLCustomObjectFieldDataType {
+  field_type: 'URL';
+}
+
+/** Structured `data_type` payload for phone-number fields. */
+export interface PhoneNumberCustomObjectFieldDataType {
+  field_type: 'PHONE_NUMBER';
+}
+
+/** Structured `data_type` payload for numeric fields. */
+export interface NumberCustomObjectFieldDataType {
+  field_type: 'NUMBER';
+  num_of_decimal_places?: number;
+}
+
+/** Structured `data_type` payload for currency fields. */
+export interface CurrencyCustomObjectFieldDataType {
+  field_type: 'CURRENCY';
+  currency?: string;
+  num_of_decimal_places?: number;
+}
+
+/** Structured `data_type` payload for percentage fields. */
+export interface PercentageCustomObjectFieldDataType {
+  field_type: 'PERCENTAGE';
+  num_of_decimal_places?: number;
+}
+
+/** Structured `data_type` payload for date fields. */
+export interface DateCustomObjectFieldDataType {
+  field_type: 'DATE';
+}
+
+/** Structured `data_type` payload for date-time fields. */
+export interface DatetimeCustomObjectFieldDataType {
+  field_type: 'DATETIME';
+}
+
+/** Structured `data_type` payload for time-of-day fields. */
+export interface TimeCustomObjectFieldDataType {
+  field_type: 'TIME';
+}
+
+/** Structured `data_type` payload for choice fields. */
+export interface ChoiceCustomObjectFieldDataType {
+  field_type: 'SELECT' | 'RADIO';
+  options_list: string[];
+}
+
+/** Structured `data_type` payload for boolean fields. */
+export interface BooleanCustomObjectFieldDataType {
+  field_type: 'BOOLEAN';
+}
+
+/** Structured `data_type` payload for file fields. */
+export interface FileCustomObjectFieldDataType {
+  field_type: 'FILE';
+  supported_types?: string[];
+}
+
+/** Structured `data_type` payload for relationship fields. */
+export interface ReferenceCustomObjectFieldDataType {
+  field_type: 'OG_REFERENCE_FIELD';
+  og_model_rql_name: string;
+  edge_type?: 'LOOKUP' | 'PARENT_CHILD';
+  related_data_label?: string;
+  lookup_filter_rql_condition?: string;
+  parent_child_type?: 'PRIMARY' | 'SECONDARY';
+  enable_parent_owner_inheritance?: boolean;
+}
+
+/** Typed `data_type` union for custom-object field create/update payloads. */
+export type CustomObjectFieldDataType =
+  | TextCustomObjectFieldDataType
+  | LongTextCustomObjectFieldDataType
+  | EmailCustomObjectFieldDataType
+  | URLCustomObjectFieldDataType
+  | PhoneNumberCustomObjectFieldDataType
+  | NumberCustomObjectFieldDataType
+  | CurrencyCustomObjectFieldDataType
+  | PercentageCustomObjectFieldDataType
+  | DateCustomObjectFieldDataType
+  | DatetimeCustomObjectFieldDataType
+  | TimeCustomObjectFieldDataType
+  | ChoiceCustomObjectFieldDataType
+  | BooleanCustomObjectFieldDataType
+  | FileCustomObjectFieldDataType
+  | ReferenceCustomObjectFieldDataType;
+
+/** Filter entry accepted by derived aggregated field metadata. */
+export interface CustomObjectFieldDerivedAggregationFilter {
+  field_name: string;
+  filter_value: string;
+  operator: string;
+}
+
+/** Structured payload for derived aggregated field metadata. */
+export interface CustomObjectFieldDerivedAggregatedField {
+  aggregation_function?: string;
+  child_model_name?: string;
+  currency_code?: string | null;
+  field_to_aggregate?: string;
+  filters?: CustomObjectFieldDerivedAggregationFilter[];
+  lookup_field_api_name?: string;
+  [key: string]: unknown;
+}
+
+/** Formula attribute metadata accepted by field create/update APIs. */
+export type CustomObjectFieldFormulaAttrMetas = Record<string, unknown>;
+
+/** Computed-field RQL definition metadata accepted by field create/update APIs. */
+export type CustomObjectFieldRqlDefinition = Record<string, unknown>;
+
+/** Legacy object-shaped field-section payload surfaced by the generated schema. */
+export interface CustomObjectFieldSectionConfig {
+  name?: string;
+  section_id?: string;
+  [key: string]: unknown;
+}
+
+/** Field-section value accepted by the custom-object field APIs. */
+export type CustomObjectFieldSection = string | CustomObjectFieldSectionConfig;
+
+/** Name-field display / autonumber metadata accepted by field update APIs. */
+export interface CustomObjectNameFieldDetails {
+  is_autonumber_field?: boolean;
+  autonumber_format?: string;
+  starting_number?: number;
+  [key: string]: unknown;
+}
+
+/** Public custom-object field DTO returned by the REST API. */
 export interface CustomObjectField {
   /**
    * Identifier field
@@ -99,9 +268,9 @@ export interface CustomObjectField {
   custom_object: string;
 
   /**
-   * The data type configuration for the field.
+   * The field type
    */
-  data_type: unknown;
+  data_type: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * whether the history is enable for the field
@@ -144,32 +313,17 @@ export interface CustomObjectField {
   managed_package_install_id?: string;
 }
 
-export namespace CustomObjectField {
-  /**
-   * The data type configuration for the field.
-   */
-  export interface DataType {
-    /**
-     * Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields.
-     * Availability above the legacy per-type limit is capability-gated.
-     */
-    num_of_decimal_places?: number;
-
-    [k: string]: unknown;
-  }
-}
-
 /** Request payload accepted by `client.customObjects.fields.create(...)`. */
 export interface FieldCreateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: unknown;
+  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * Configuration for derived aggregated fields.
    */
-  derived_aggregated_field?: unknown;
+  derived_aggregated_field?: CustomObjectFieldDerivedAggregatedField;
 
   /**
    * The formula for derived fields.
@@ -189,7 +343,7 @@ export interface FieldCreateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: unknown;
+  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
 
   /**
    * Whether field values must be unique.
@@ -209,27 +363,12 @@ export interface FieldCreateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: unknown;
-
-  /**
-   * The section configuration for the field.
-   */
-  section?: unknown;
-}
+  rql_definition?: CustomObjectFieldRqlDefinition;
 
-export namespace FieldCreateParams {
   /**
-   * The data type configuration for the field.
+   * The section identifier or section configuration for the field.
    */
-  export interface DataType {
-    /**
-     * Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields.
-     * Availability above the legacy per-type limit is capability-gated.
-     */
-    num_of_decimal_places?: number;
-
-    [k: string]: unknown;
-  }
+  section?: CustomObjectFieldSection;
 }
 
 /** Request payload accepted by `client.customObjects.fields.update(...)`. */
@@ -237,7 +376,7 @@ export interface FieldUpdateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: unknown;
+  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * The formula for derived fields.
@@ -257,7 +396,7 @@ export interface FieldUpdateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: unknown;
+  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
 
   /**
    * Whether field values must be unique.
@@ -272,7 +411,7 @@ export interface FieldUpdateParams {
   /**
    * Configuration for name field display.
    */
-  name_field_details?: unknown;
+  name_field_details?: CustomObjectNameFieldDetails;
 
   /**
    * Whether this field is required.
@@ -282,31 +421,25 @@ export interface FieldUpdateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: unknown;
-
-  /**
-   * The section configuration for the field.
-   */
-  section?: unknown;
-}
+  rql_definition?: CustomObjectFieldRqlDefinition;
 
-export namespace FieldUpdateParams {
   /**
-   * The data type configuration for the field.
+   * The section identifier or section configuration for the field.
    */
-  export interface DataType {
-    /**
-     * Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields.
-     * Availability above the legacy per-type limit is capability-gated.
-     */
-    num_of_decimal_places?: number;
-
-    [k: string]: unknown;
-  }
+  section?: CustomObjectFieldSection;
 }
 
 export declare namespace Fields {
   export {
+    type CustomObjectFieldType as CustomObjectFieldType,
+    type CustomObjectFieldDataType as CustomObjectFieldDataType,
+    type CustomObjectFieldDerivedAggregationFilter as CustomObjectFieldDerivedAggregationFilter,
+    type CustomObjectFieldDerivedAggregatedField as CustomObjectFieldDerivedAggregatedField,
+    type CustomObjectFieldFormulaAttrMetas as CustomObjectFieldFormulaAttrMetas,
+    type CustomObjectFieldRqlDefinition as CustomObjectFieldRqlDefinition,
+    type CustomObjectFieldSectionConfig as CustomObjectFieldSectionConfig,
+    type CustomObjectFieldSection as CustomObjectFieldSection,
+    type CustomObjectNameFieldDetails as CustomObjectNameFieldDetails,
     type CustomObjectField as CustomObjectField,
     type CustomObjectFieldsPageCursorURL as CustomObjectFieldsPageCursorURL,
     type FieldCreateParams as FieldCreateParams,

package/src/resources/device-orders.ts

@@ -15,7 +15,7 @@ export class DeviceOrders extends APIResource {
   /**
    * A list of device orders.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `status`
    * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/devices.ts

@@ -15,7 +15,7 @@ export class Devices extends APIResource {
   /**
    * A list of devices.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `serial_number`, `lifecycle_state`,
    *   `enrollment_status`
    * - Expandable fields: `worker`, `pending_actions`

package/src/resources/functions/deployments.ts

@@ -12,7 +12,7 @@ export class Deployments extends APIResource {
   /**
    * A list of function deployments.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    */
   list(functionAPIName: string, options?: RequestOptions): APIPromise<DeploymentListResponse> {
     return this._client.get(path`/functions/${functionAPIName}/deployments/`, options);
@@ -44,7 +44,7 @@ export class Deployments extends APIResource {
   /**
    * A list of function deployment logs.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    */
   listLogs(
     deploymentID: string,

package/src/resources/functions/executions.ts

@@ -13,7 +13,7 @@ export class Executions extends APIResource {
   /**
    * A list of function executions.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
@@ -54,7 +54,7 @@ export class Executions extends APIResource {
   /**
    * A list of function execution logs.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    */
   listLogs(
     executionID: string,

package/src/resources/functions/functions.ts

@@ -37,7 +37,7 @@ export class Functions extends APIResource {
   /**
    * A list of functions.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(

package/src/resources/headcount-positions.ts

@@ -21,7 +21,7 @@ export class HeadcountPositions extends APIResource {
   /**
    * A list of headcount positions.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `created_at`, `position_id`, `position_type`,
    *   `position_sub_type`, `department_id`, `work_location_id`, `level_id`,
    *   `teams_id`, `job_requisition_id`, `recruiter_id`, `headcount_owner_id`,

package/src/resources/headcount-priorities.ts

@@ -14,7 +14,7 @@ export class HeadcountPriorities extends APIResource {
   /**
    * A list of headcount priorities.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(

package/src/resources/index.ts

@@ -1,6 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  Agents,
+  type AgentListResponse,
+  type AgentCreateResponse,
+  type AgentRetrieveResponse,
+  type AgentUpdateResponse,
+  type AgentListParams,
+  type AgentCreateParams,
+  type AgentUpdateParams,
+  type AgentListResponsesPageCursorURL,
+} from './agents/agents';
 export {
   AppUsers,
   type AppUserListResponse,
@@ -371,6 +382,17 @@ export {
   type ObjectCategoryUpdateParams,
   type ObjectCategoriesPageCursorURL,
 } from './object-categories';
+export {
+  Packages,
+  type PackageListResponse,
+  type PackageCreateResponse,
+  type PackageRetrieveResponse,
+  type PackageUpdateResponse,
+  type PackageListParams,
+  type PackageCreateParams,
+  type PackageUpdateParams,
+  type PackageListResponsesPageCursorURL,
+} from './packages/packages';
 export {
   PayrollRuns,
   type PayrollRunListResponse,
@@ -440,6 +462,22 @@ export {
   type ShiftassignmentUpdateParams,
   type ShiftassignmentListResponsesPageCursorURL,
 } from './shiftassignments';
+export {
+  Sites,
+  type SiteListResponse,
+  type SiteCreateResponse,
+  type SiteRetrieveResponse,
+  type SiteUpdateResponse,
+  type SiteUploadBatchesResponse,
+  type SiteFilesResponse,
+  type SiteFileOperationsResponse,
+  type SiteCreateParams,
+  type SiteUpdateParams,
+  type SiteUploadBatchesParams,
+  type SiteFilesParams,
+  type SiteFileOperationsParams,
+  type SiteListResponsesPageCursorURL,
+} from './sites';
 export {
   SoftwareDeployments,
   type SoftwareDeploymentListResponse,

package/src/resources/job-assignments.ts

@@ -18,7 +18,7 @@ export class JobAssignments extends APIResource {
   /**
    * A list of job assignments.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `job_code_id`
    * - Expandable fields: `worker`, `job_code`, `job_pay_rate_exceptions`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -73,7 +73,7 @@ export class JobAssignments extends APIResource {
   /**
    * A list of attribute change logs.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `changed_by_worker`
    * - Sortable fields: `id`
    */

package/src/resources/job-codes.ts

@@ -22,7 +22,7 @@ export class JobCodes extends APIResource {
   /**
    * A list of job codes.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `job_dimension_id`, `group_id`
    * - Expandable fields: `job_dimension`, `work_location`, `department`,
    *   `pay_rate_exceptions`
@@ -73,7 +73,7 @@ export class JobCodes extends APIResource {
   /**
    * A list of attribute change logs.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `changed_by_worker`
    * - Sortable fields: `id`
    */

package/src/resources/job-dimensions.ts

@@ -15,7 +15,7 @@ export class JobDimensions extends APIResource {
   /**
    * A list of job dimensions.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `name`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/job-pay-rate-exceptions.ts

@@ -17,7 +17,7 @@ export class JobPayRateExceptions extends APIResource {
   /**
    * A list of job pay rate exceptions.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `job_code_id`
    * - Expandable fields: `job_code`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -46,7 +46,7 @@ export class JobPayRateExceptions extends APIResource {
   /**
    * A list of attribute change logs.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `changed_by_worker`
    * - Sortable fields: `id`
    */

package/src/resources/job-requisitions.ts

@@ -11,7 +11,7 @@ export class JobRequisitions extends APIResource {
   /**
    * A list of job requisitions.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(

package/src/resources/kiosk-badges.ts

@@ -16,7 +16,7 @@ export class KioskBadges extends APIResource {
   /**
    * A list of kiosk badges.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `badge_id`
    * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/leave-accruals.ts

@@ -15,7 +15,7 @@ export class LeaveAccruals extends APIResource {
   /**
    * A list of leave accruals.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `leave_type_id`, `accrual_date`
    * - Expandable fields: `worker`, `grantor`
    * - Sortable fields: `id`, `created_at`, `updated_at`, `accrual_date`,

package/src/resources/leave-balances.ts

@@ -16,7 +16,7 @@ export class LeaveBalances extends APIResource {
   /**
    * A list of leave balances.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `leave_type_id`
    * - Expandable fields: `worker`, `leave_type`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/leave-requests.ts

@@ -16,7 +16,7 @@ export class LeaveRequests extends APIResource {
   /**
    * A list of leave requests.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`,
    *   `leave_policy_id`, `leave_type_id`, `start_date`, `end_date`
    * - Expandable fields: `worker`, `requester`, `leave_type`, `reviewer`

package/src/resources/leave-types.ts

@@ -14,7 +14,7 @@ export class LeaveTypes extends APIResource {
   /**
    * A list of leave types.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `name`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/legal-entities.ts

@@ -16,7 +16,7 @@ export class LegalEntities extends APIResource {
   /**
    * A list of legal entities.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `parent`, `company`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */