@rippling/rippling-sdk 0.2.0-alpha.82 → 0.2.0-alpha.83

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 field type
+   * The data type configuration for the field.
    */
-  data_type: unknown;
+  data_type: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * whether the history is enable for the field
@@ -144,16 +313,32 @@ 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.
@@ -173,7 +358,7 @@ export interface FieldCreateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: unknown;
+  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
 
   /**
    * Whether field values must be unique.
@@ -193,19 +378,35 @@ export interface FieldCreateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: unknown;
+  rql_definition?: CustomObjectFieldRqlDefinition;
+
+  /**
+   * The section identifier or section configuration for the field.
+   */
+  section?: CustomObjectFieldSection;
+}
 
+export namespace FieldCreateParams {
   /**
-   * The section configuration for the field.
+   * The data type configuration for the field.
    */
-  section?: unknown;
+  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.update(...)`. */
 export interface FieldUpdateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: unknown;
+  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
 
   /**
    * The formula for derived fields.
@@ -225,7 +426,7 @@ export interface FieldUpdateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: unknown;
+  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
 
   /**
    * Whether field values must be unique.
@@ -240,7 +441,7 @@ export interface FieldUpdateParams {
   /**
    * Configuration for name field display.
    */
-  name_field_details?: unknown;
+  name_field_details?: CustomObjectNameFieldDetails;
 
   /**
    * Whether this field is required.
@@ -250,16 +451,40 @@ export interface FieldUpdateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: unknown;
+  rql_definition?: CustomObjectFieldRqlDefinition;
+
+  /**
+   * The section identifier or section configuration for the field.
+   */
+  section?: CustomObjectFieldSection;
+}
 
+export namespace FieldUpdateParams {
   /**
-   * The section configuration for the field.
+   * The data type configuration for the field.
    */
-  section?: unknown;
+  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;
+  }
 }
 
 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/index.ts

@@ -352,7 +352,9 @@ export {
   type Level,
   type LevelRetrieveResponse,
   type LevelListParams,
+  type LevelCreateParams,
   type LevelRetrieveParams,
+  type LevelUpdateParams,
   type LevelsPageCursorURL,
 } from './levels';
 export {
@@ -505,6 +507,8 @@ export {
   type Track,
   type TrackRetrieveResponse,
   type TrackListParams,
+  type TrackCreateParams,
+  type TrackUpdateParams,
   type TracksPageCursorURL,
 } from './tracks';
 export {