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

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

@@ -89,7 +89,6 @@ export class CustomObjects extends APIResource {
 
 export type CustomObjectsPageCursorURL = PageCursorURL<CustomObject>;
 
-/** Public custom-object DTO returned by the REST API. */
 export interface CustomObject {
   /**
    * Identifier field
@@ -152,7 +151,6 @@ export interface CustomObject {
   owner_id?: string;
 }
 
-/** Request payload accepted by `client.customObjects.create(...)`. */
 export interface CustomObjectCreateParams {
   /**
    * The category that this custom object belongs to.
@@ -170,7 +168,6 @@ export interface CustomObjectCreateParams {
   name?: string;
 }
 
-/** Request payload accepted by `client.customObjects.update(...)`. */
 export interface CustomObjectUpdateParams {
   /**
    * The category that this custom object belongs to.
@@ -182,11 +179,6 @@ 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,175 +77,6 @@ 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
@@ -270,7 +101,7 @@ export interface CustomObjectField {
   /**
    * The data type configuration for the field.
    */
-  data_type: CustomObjectFieldDataType | Record<string, unknown>;
+  data_type: unknown;
 
   /**
    * whether the history is enable for the field
@@ -333,12 +164,12 @@ export interface FieldCreateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
+  data_type?: unknown;
 
   /**
    * Configuration for derived aggregated fields.
    */
-  derived_aggregated_field?: CustomObjectFieldDerivedAggregatedField;
+  derived_aggregated_field?: unknown;
 
   /**
    * The formula for derived fields.
@@ -358,7 +189,7 @@ export interface FieldCreateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
+  formula_attr_metas?: unknown;
 
   /**
    * Whether field values must be unique.
@@ -378,12 +209,12 @@ export interface FieldCreateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: CustomObjectFieldRqlDefinition;
+  rql_definition?: unknown;
 
   /**
-   * The section identifier or section configuration for the field.
+   * The section configuration for the field.
    */
-  section?: CustomObjectFieldSection;
+  section?: unknown;
 }
 
 export namespace FieldCreateParams {
@@ -406,7 +237,7 @@ export interface FieldUpdateParams {
   /**
    * The data type configuration for the field.
    */
-  data_type?: CustomObjectFieldDataType | Record<string, unknown>;
+  data_type?: unknown;
 
   /**
    * The formula for derived fields.
@@ -426,7 +257,7 @@ export interface FieldUpdateParams {
   /**
    * Metadata for formula attributes.
    */
-  formula_attr_metas?: CustomObjectFieldFormulaAttrMetas;
+  formula_attr_metas?: unknown;
 
   /**
    * Whether field values must be unique.
@@ -441,7 +272,7 @@ export interface FieldUpdateParams {
   /**
    * Configuration for name field display.
    */
-  name_field_details?: CustomObjectNameFieldDetails;
+  name_field_details?: unknown;
 
   /**
    * Whether this field is required.
@@ -451,12 +282,12 @@ export interface FieldUpdateParams {
   /**
    * The RQL definition for computed fields.
    */
-  rql_definition?: CustomObjectFieldRqlDefinition;
+  rql_definition?: unknown;
 
   /**
-   * The section identifier or section configuration for the field.
+   * The section configuration for the field.
    */
-  section?: CustomObjectFieldSection;
+  section?: unknown;
 }
 
 export namespace FieldUpdateParams {
@@ -476,15 +307,6 @@ export namespace FieldUpdateParams {
 
 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/tsconfig.json

@@ -2,7 +2,7 @@
   // this config is included in the published src directory to prevent TS errors
   // from appearing when users go to source, and VSCode opens the source .ts file
   // via declaration maps
-  "include": ["index.ts", "**/*.d.ts"],
+  "include": ["index.ts"],
   "compilerOptions": {
     "target": "ES2015",
     "lib": ["DOM", "DOM.Iterable", "ES2018"],

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.84'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.85'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.84";
+export declare const VERSION = "0.2.0-alpha.85";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.84";
+export declare const VERSION = "0.2.0-alpha.85";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.84'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.85'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.84'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.85'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/core/platform/custom-objects/category.d.mts

@@ -1,125 +0,0 @@
-import type { RipplingSDK } from "../../../client.mjs";
-import type { ObjectCategory, ObjectCategoryCreateParams, ObjectCategoryUpdateParams } from "../../../resources/object-categories.mjs";
-import type { CategoryApiName, LogicalCategoryName } from "./types.mjs";
-/**
- * Author input accepted by {@link defineCustomObjectCategory}.
- *
- * @typeParam TName - Logical category name supplied by the caller.
- */
-interface CustomObjectCategoryDefinitionInput<TName extends string> {
-    /** Logical unsuffixed snake_case category name. */
-    readonly name: LogicalCategoryName<TName>;
-    /** Human-readable display name applied after creation. */
-    readonly displayName: string;
-    /** Optional category description. */
-    readonly description?: string;
-}
-/** Immutable typed category definition used by provisioning and lifecycle helpers. */
-export interface CustomObjectCategoryDefinition<TName extends LogicalCategoryName = LogicalCategoryName> {
-    /** Logical unsuffixed snake_case category name. */
-    readonly name: TName;
-    /** Compiled wire-level category api name. */
-    readonly apiName: CategoryApiName<TName>;
-    /** Human-readable display name. */
-    readonly displayName: string;
-    /** Optional category description. */
-    readonly description?: string;
-}
-/** Result returned by category provisioning helpers. */
-export interface ProvisionedCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
-    /** Source typed category definition. */
-    readonly definition: CustomObjectCategoryDefinition<TName>;
-    /** Response returned by `client.objectCategories.create(...)`. */
-    readonly createdCategory: ObjectCategory;
-    /** Response returned by `client.objectCategories.update(...)`. */
-    readonly updatedCategory: ObjectCategory;
-}
-/** Lifecycle action emitted by category reconciliation helpers. */
-export type CustomObjectCategoryLifecycleAction = 'created' | 'updated' | 'unchanged';
-/** Result returned by category reconciliation helpers. */
-export interface ReconciledCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
-    /** Source typed category definition. */
-    readonly definition: CustomObjectCategoryDefinition<TName>;
-    /** Whether the remote category was created, updated, or already matched. */
-    readonly action: CustomObjectCategoryLifecycleAction;
-    /** Remote category after reconciliation. */
-    readonly category: ObjectCategory;
-}
-/** Options for category provisioning and reconciliation helpers. */
-export interface CustomObjectCategoryMutationOptions {
-    /** Whether to apply the follow-up display-metadata update. Defaults to `true`. */
-    readonly updateDisplayMetadata?: boolean;
-}
-/**
- * Creates an immutable typed custom-object category definition.
- *
- * @param definition - Logical category metadata to normalize and freeze.
- * @returns Immutable typed category definition with compiled API name.
- * @typeParam TName - Logical category name supplied by the caller.
- */
-export declare function defineCustomObjectCategory<TName extends string>(definition: CustomObjectCategoryDefinitionInput<TName>): Readonly<CustomObjectCategoryDefinition<LogicalCategoryName<TName>>>;
-/**
- * Builds the low-level create payload for an object category.
- *
- * @param definition - Typed category definition to compile.
- * @returns REST create payload using the logical category name.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function buildObjectCategoryCreateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryCreateParams;
-/**
- * Builds the low-level update payload for an object category.
- *
- * @param definition - Typed category definition to compile.
- * @returns REST update payload using human-facing display metadata.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function buildObjectCategoryUpdateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryUpdateParams;
-/**
- * Creates one typed custom-object category through the REST SDK.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definition - Typed category definition to provision.
- * @param options - Provisioning behavior flags for display-metadata updates.
- * @returns Frozen summary of the created and updated backend category DTOs.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function provisionCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
-/**
- * Creates multiple typed custom-object categories through the REST SDK.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definitions - Typed category definitions to provision.
- * @param options - Provisioning behavior flags shared across the batch.
- * @returns Frozen batch of provisioning results in input order.
- */
-export declare function provisionCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
-/**
- * Reconciles one typed category definition against the backend by name.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definition - Typed category definition to reconcile.
- * @param options - Reconciliation behavior flags for display-metadata updates.
- * @returns Frozen reconciliation result describing the final backend category state.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function reconcileCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
-/**
- * Reconciles multiple typed category definitions against the backend by name.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definitions - Typed category definitions to reconcile.
- * @param options - Reconciliation behavior flags shared across the batch.
- * @returns Frozen batch of reconciliation results in input order.
- */
-export declare function reconcileCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
-/**
- * Deletes a category that matches the typed definition's logical or display name.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definition - Typed category definition used to find the category to delete.
- * @returns Whether a matching category existed and was deleted.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function deleteCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>): Promise<boolean>;
-export {};
-//# sourceMappingURL=category.d.mts.map

package/core/platform/custom-objects/category.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"category.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,4BAAwB;AACnD,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,iDAA6C;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAgB;AAIpE;;;;GAIG;AACH,UAAU,mCAAmC,CAAC,KAAK,SAAS,MAAM;IAChE,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,sFAAsF;AACtF,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACzC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACtG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;IACzC,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;CAC1C;AAED,mEAAmE;AACnE,MAAM,MAAM,mCAAmC,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtF,0DAA0D;AAC1D,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,mCAAmC,CAAC;IACrD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED,oEAAoE;AACpE,MAAM,WAAW,mCAAmC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,SAAS,MAAM,EAC7D,UAAU,EAAE,mCAAmC,CAAC,KAAK,CAAC,GACrD,QAAQ,CAAC,8BAA8B,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAQtE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AA4DD;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAQjD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC,CAMrD;AAED;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAyBhD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC,CAMpD;AAED;;;;;;;GAOG;AACH,wBAAsB,oCAAoC,CAAC,KAAK,SAAS,mBAAmB,EAC1F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,CAKlB"}

package/core/platform/custom-objects/category.d.ts

@@ -1,125 +0,0 @@
-import type { RipplingSDK } from "../../../client.js";
-import type { ObjectCategory, ObjectCategoryCreateParams, ObjectCategoryUpdateParams } from "../../../resources/object-categories.js";
-import type { CategoryApiName, LogicalCategoryName } from "./types.js";
-/**
- * Author input accepted by {@link defineCustomObjectCategory}.
- *
- * @typeParam TName - Logical category name supplied by the caller.
- */
-interface CustomObjectCategoryDefinitionInput<TName extends string> {
-    /** Logical unsuffixed snake_case category name. */
-    readonly name: LogicalCategoryName<TName>;
-    /** Human-readable display name applied after creation. */
-    readonly displayName: string;
-    /** Optional category description. */
-    readonly description?: string;
-}
-/** Immutable typed category definition used by provisioning and lifecycle helpers. */
-export interface CustomObjectCategoryDefinition<TName extends LogicalCategoryName = LogicalCategoryName> {
-    /** Logical unsuffixed snake_case category name. */
-    readonly name: TName;
-    /** Compiled wire-level category api name. */
-    readonly apiName: CategoryApiName<TName>;
-    /** Human-readable display name. */
-    readonly displayName: string;
-    /** Optional category description. */
-    readonly description?: string;
-}
-/** Result returned by category provisioning helpers. */
-export interface ProvisionedCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
-    /** Source typed category definition. */
-    readonly definition: CustomObjectCategoryDefinition<TName>;
-    /** Response returned by `client.objectCategories.create(...)`. */
-    readonly createdCategory: ObjectCategory;
-    /** Response returned by `client.objectCategories.update(...)`. */
-    readonly updatedCategory: ObjectCategory;
-}
-/** Lifecycle action emitted by category reconciliation helpers. */
-export type CustomObjectCategoryLifecycleAction = 'created' | 'updated' | 'unchanged';
-/** Result returned by category reconciliation helpers. */
-export interface ReconciledCustomObjectCategory<TName extends LogicalCategoryName = LogicalCategoryName> {
-    /** Source typed category definition. */
-    readonly definition: CustomObjectCategoryDefinition<TName>;
-    /** Whether the remote category was created, updated, or already matched. */
-    readonly action: CustomObjectCategoryLifecycleAction;
-    /** Remote category after reconciliation. */
-    readonly category: ObjectCategory;
-}
-/** Options for category provisioning and reconciliation helpers. */
-export interface CustomObjectCategoryMutationOptions {
-    /** Whether to apply the follow-up display-metadata update. Defaults to `true`. */
-    readonly updateDisplayMetadata?: boolean;
-}
-/**
- * Creates an immutable typed custom-object category definition.
- *
- * @param definition - Logical category metadata to normalize and freeze.
- * @returns Immutable typed category definition with compiled API name.
- * @typeParam TName - Logical category name supplied by the caller.
- */
-export declare function defineCustomObjectCategory<TName extends string>(definition: CustomObjectCategoryDefinitionInput<TName>): Readonly<CustomObjectCategoryDefinition<LogicalCategoryName<TName>>>;
-/**
- * Builds the low-level create payload for an object category.
- *
- * @param definition - Typed category definition to compile.
- * @returns REST create payload using the logical category name.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function buildObjectCategoryCreateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryCreateParams;
-/**
- * Builds the low-level update payload for an object category.
- *
- * @param definition - Typed category definition to compile.
- * @returns REST update payload using human-facing display metadata.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function buildObjectCategoryUpdateParams<TName extends LogicalCategoryName>(definition: CustomObjectCategoryDefinition<TName>): ObjectCategoryUpdateParams;
-/**
- * Creates one typed custom-object category through the REST SDK.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definition - Typed category definition to provision.
- * @param options - Provisioning behavior flags for display-metadata updates.
- * @returns Frozen summary of the created and updated backend category DTOs.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function provisionCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ProvisionedCustomObjectCategory<TName>>;
-/**
- * Creates multiple typed custom-object categories through the REST SDK.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definitions - Typed category definitions to provision.
- * @param options - Provisioning behavior flags shared across the batch.
- * @returns Frozen batch of provisioning results in input order.
- */
-export declare function provisionCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ProvisionedCustomObjectCategory[]>;
-/**
- * Reconciles one typed category definition against the backend by name.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definition - Typed category definition to reconcile.
- * @param options - Reconciliation behavior flags for display-metadata updates.
- * @returns Frozen reconciliation result describing the final backend category state.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function reconcileCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>, options?: CustomObjectCategoryMutationOptions): Promise<ReconciledCustomObjectCategory<TName>>;
-/**
- * Reconciles multiple typed category definitions against the backend by name.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definitions - Typed category definitions to reconcile.
- * @param options - Reconciliation behavior flags shared across the batch.
- * @returns Frozen batch of reconciliation results in input order.
- */
-export declare function reconcileCustomObjectCategoryDefinitions(client: RipplingSDK, definitions: readonly CustomObjectCategoryDefinition[], options?: CustomObjectCategoryMutationOptions): Promise<readonly ReconciledCustomObjectCategory[]>;
-/**
- * Deletes a category that matches the typed definition's logical or display name.
- *
- * @param client - SDK client used to call the category APIs.
- * @param definition - Typed category definition used to find the category to delete.
- * @returns Whether a matching category existed and was deleted.
- * @typeParam TName - Logical category name carried by the definition.
- */
-export declare function deleteCustomObjectCategoryDefinition<TName extends LogicalCategoryName>(client: RipplingSDK, definition: CustomObjectCategoryDefinition<TName>): Promise<boolean>;
-export {};
-//# sourceMappingURL=category.d.ts.map

package/core/platform/custom-objects/category.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/category.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,2BAAwB;AACnD,OAAO,KAAK,EACV,cAAc,EACd,0BAA0B,EAC1B,0BAA0B,EAC3B,gDAA6C;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,mBAAgB;AAIpE;;;;GAIG;AACH,UAAU,mCAAmC,CAAC,KAAK,SAAS,MAAM;IAChE,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,sFAAsF;AACtF,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACzC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACtG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;IACzC,kEAAkE;IAClE,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;CAC1C;AAED,mEAAmE;AACnE,MAAM,MAAM,mCAAmC,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtF,0DAA0D;AAC1D,MAAM,WAAW,8BAA8B,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB;IACrG,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC3D,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,mCAAmC,CAAC;IACrD,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED,oEAAoE;AACpE,MAAM,WAAW,mCAAmC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,SAAS,MAAM,EAC7D,UAAU,EAAE,mCAAmC,CAAC,KAAK,CAAC,GACrD,QAAQ,CAAC,8BAA8B,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAQtE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,SAAS,mBAAmB,EAC/E,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,0BAA0B,CAK5B;AA4DD;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAQjD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,+BAA+B,EAAE,CAAC,CAMrD;AAED;;;;;;;;GAQG;AACH,wBAAsB,uCAAuC,CAAC,KAAK,SAAS,mBAAmB,EAC7F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,EACjD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAyBhD;AAED;;;;;;;GAOG;AACH,wBAAsB,wCAAwC,CAC5D,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,SAAS,8BAA8B,EAAE,EACtD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,SAAS,8BAA8B,EAAE,CAAC,CAMpD;AAED;;;;;;;GAOG;AACH,wBAAsB,oCAAoC,CAAC,KAAK,SAAS,mBAAmB,EAC1F,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,8BAA8B,CAAC,KAAK,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,CAKlB"}