@rippling/rippling-sdk 0.2.0-alpha.20

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

@@ -0,0 +1,206 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FieldsAPI from './fields';
+import {
+  CustomObjectField,
+  CustomObjectFieldsPageCursorURL,
+  FieldCreateParams,
+  FieldUpdateParams,
+  Fields,
+} from './fields';
+import * as RecordsAPI from './records';
+import {
+  CustomObjectDataRow,
+  CustomObjectDataRowsPageCursorURL,
+  RecordBulkCreateParams,
+  RecordBulkCreateResponse,
+  RecordBulkDeleteParams,
+  RecordBulkUpdateParams,
+  RecordBulkUpdateResponse,
+  RecordCreateParams,
+  RecordCreateResponse,
+  RecordQueryParams,
+  RecordQueryResponse,
+  RecordUpdateParams,
+  RecordUpdateResponse,
+  Records,
+} from './records';
+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 CustomObjects extends APIResource {
+  fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
+  records: RecordsAPI.Records = new RecordsAPI.Records(this._client);
+
+  /**
+   * Create a new custom object
+   */
+  create(
+    body: CustomObjectCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomObject> {
+    return this._client.post('/custom-objects/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific custom object
+   */
+  retrieve(customObjectAPIName: string, options?: RequestOptions): APIPromise<CustomObject> {
+    return this._client.get(path`/custom-objects/${customObjectAPIName}/`, options);
+  }
+
+  /**
+   * Updated a specific custom object
+   */
+  update(
+    customObjectAPIName: string,
+    body: CustomObjectUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomObject> {
+    return this._client.patch(path`/custom-objects/${customObjectAPIName}/`, { body, ...options });
+  }
+
+  /**
+   * A List of custom objects
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<CustomObjectsPageCursorURL, CustomObject> {
+    return this._client.getAPIList('/custom-objects/', PageCursorURL<CustomObject>, options);
+  }
+
+  /**
+   * Delete a custom object
+   */
+  delete(customObjectAPIName: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-objects/${customObjectAPIName}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomObjectsPageCursorURL = PageCursorURL<CustomObject>;
+
+export interface CustomObject {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The category of the custom object
+   */
+  category_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Whether to record the history of the custom object
+   */
+  enable_history: boolean;
+
+  /**
+   * The name of the custom object
+   */
+  name: string;
+
+  /**
+   * The plural label of the custom object
+   */
+  plural_label: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The api name of the custom object
+   */
+  api_name?: string;
+
+  /**
+   * The description of the custom object
+   */
+  description?: string;
+
+  /**
+   * The id of the package which the custom object belongs to
+   */
+  managed_package_install_id?: string;
+
+  /**
+   * The native category of the custom object if belongs to
+   */
+  native_category_id?: string;
+
+  /**
+   * The id of the owner for the custom object
+   */
+  owner_id?: string;
+}
+
+export interface CustomObjectCreateParams {
+  category?: string;
+
+  description?: string;
+
+  name?: string;
+}
+
+export interface CustomObjectUpdateParams {
+  category?: string;
+
+  description?: string;
+
+  name?: string;
+
+  owner_role?: string;
+
+  plural_label?: string;
+}
+
+CustomObjects.Fields = Fields;
+CustomObjects.Records = Records;
+
+export declare namespace CustomObjects {
+  export {
+    type CustomObject as CustomObject,
+    type CustomObjectsPageCursorURL as CustomObjectsPageCursorURL,
+    type CustomObjectCreateParams as CustomObjectCreateParams,
+    type CustomObjectUpdateParams as CustomObjectUpdateParams,
+  };
+
+  export {
+    Fields as Fields,
+    type CustomObjectField as CustomObjectField,
+    type CustomObjectFieldsPageCursorURL as CustomObjectFieldsPageCursorURL,
+    type FieldCreateParams as FieldCreateParams,
+    type FieldUpdateParams as FieldUpdateParams,
+  };
+
+  export {
+    Records as Records,
+    type CustomObjectDataRow as CustomObjectDataRow,
+    type RecordCreateResponse as RecordCreateResponse,
+    type RecordUpdateResponse as RecordUpdateResponse,
+    type RecordBulkCreateResponse as RecordBulkCreateResponse,
+    type RecordBulkUpdateResponse as RecordBulkUpdateResponse,
+    type RecordQueryResponse as RecordQueryResponse,
+    type CustomObjectDataRowsPageCursorURL as CustomObjectDataRowsPageCursorURL,
+    type RecordCreateParams as RecordCreateParams,
+    type RecordUpdateParams as RecordUpdateParams,
+    type RecordBulkCreateParams as RecordBulkCreateParams,
+    type RecordBulkDeleteParams as RecordBulkDeleteParams,
+    type RecordBulkUpdateParams as RecordBulkUpdateParams,
+    type RecordQueryParams as RecordQueryParams,
+  };
+}

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

@@ -0,0 +1,199 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+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 Fields extends APIResource {
+  /**
+   * Create a new custom object field
+   */
+  create(
+    customObjectAPIName: string,
+    body: FieldCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomObjectField> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/fields/`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific custom object field
+   */
+  retrieve(
+    customObjectAPIName: string,
+    fieldAPIName: string,
+    options?: RequestOptions,
+  ): APIPromise<CustomObjectField> {
+    return this._client.get(path`/custom-objects/${customObjectAPIName}/fields/${fieldAPIName}/`, options);
+  }
+
+  /**
+   * Updated a specific custom object field
+   */
+  update(
+    customObjectAPIName: string,
+    fieldAPIName: string,
+    body: FieldUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomObjectField> {
+    return this._client.patch(path`/custom-objects/${customObjectAPIName}/fields/${fieldAPIName}/`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * A List of custom object fields
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    customObjectAPIName: string,
+    options?: RequestOptions,
+  ): PagePromise<CustomObjectFieldsPageCursorURL, CustomObjectField> {
+    return this._client.getAPIList(
+      path`/custom-objects/${customObjectAPIName}/fields/`,
+      PageCursorURL<CustomObjectField>,
+      options,
+    );
+  }
+
+  /**
+   * Delete a custom object field
+   */
+  delete(customObjectAPIName: string, fieldAPIName: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-objects/${customObjectAPIName}/fields/${fieldAPIName}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomObjectFieldsPageCursorURL = PageCursorURL<CustomObjectField>;
+
+export interface CustomObjectField {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The api name of the custom object field
+   */
+  api_name: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The custom object which the field belongs to
+   */
+  custom_object: string;
+
+  /**
+   * The field type
+   */
+  data_type: unknown;
+
+  /**
+   * whether the history is enable for the field
+   */
+  enable_history: boolean;
+
+  /**
+   * whether the field is imuatable
+   */
+  is_immutable: boolean;
+
+  /**
+   * whether the field is standard field
+   */
+  is_standard: boolean;
+
+  /**
+   * This field specifies whether a particular column value has unique values
+   */
+  is_unique: boolean;
+
+  /**
+   * The name of the custom object field
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the custom object field
+   */
+  description?: string;
+
+  /**
+   * The id of the package which the custom object field belongs to
+   */
+  managed_package_install_id?: string;
+}
+
+export interface FieldCreateParams {
+  data_type?: unknown;
+
+  derived_aggregated_field?: unknown;
+
+  derived_field_formula?: string;
+
+  description?: string;
+
+  enable_history?: boolean;
+
+  formula_attr_metas?: unknown;
+
+  is_unique?: boolean;
+
+  name?: string;
+
+  required?: boolean;
+
+  rql_definition?: unknown;
+
+  section?: unknown;
+}
+
+export interface FieldUpdateParams {
+  data_type?: unknown;
+
+  derived_field_formula?: string;
+
+  description?: string;
+
+  enable_history?: boolean;
+
+  formula_attr_metas?: unknown;
+
+  is_unique?: boolean;
+
+  name?: string;
+
+  name_field_details?: unknown;
+
+  required?: boolean;
+
+  rql_definition?: unknown;
+
+  section?: unknown;
+}
+
+export declare namespace Fields {
+  export {
+    type CustomObjectField as CustomObjectField,
+    type CustomObjectFieldsPageCursorURL as CustomObjectFieldsPageCursorURL,
+    type FieldCreateParams as FieldCreateParams,
+    type FieldUpdateParams as FieldUpdateParams,
+  };
+}

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

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  CustomObjects,
+  type CustomObject,
+  type CustomObjectCreateParams,
+  type CustomObjectUpdateParams,
+  type CustomObjectsPageCursorURL,
+} from './custom-objects';
+export {
+  Fields,
+  type CustomObjectField,
+  type FieldCreateParams,
+  type FieldUpdateParams,
+  type CustomObjectFieldsPageCursorURL,
+} from './fields';
+export {
+  Records,
+  type CustomObjectDataRow,
+  type RecordCreateResponse,
+  type RecordUpdateResponse,
+  type RecordBulkCreateResponse,
+  type RecordBulkUpdateResponse,
+  type RecordQueryResponse,
+  type RecordCreateParams,
+  type RecordUpdateParams,
+  type RecordBulkCreateParams,
+  type RecordBulkDeleteParams,
+  type RecordBulkUpdateParams,
+  type RecordQueryParams,
+  type CustomObjectDataRowsPageCursorURL,
+} from './records';

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

@@ -0,0 +1,282 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+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 Records extends APIResource {
+  /**
+   * Create a new custom object record
+   */
+  create(
+    customObjectAPIName: string,
+    body: RecordCreateParams | null | undefined = undefined,
+    options?: RequestOptions,
+  ): APIPromise<RecordCreateResponse> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific custom object record
+   */
+  retrieve(
+    customObjectAPIName: string,
+    codrID: string,
+    options?: RequestOptions,
+  ): APIPromise<CustomObjectDataRow> {
+    return this._client.get(path`/custom-objects/${customObjectAPIName}/records/${codrID}/`, options);
+  }
+
+  /**
+   * Updated a specific custom object record
+   */
+  update(
+    customObjectAPIName: string,
+    codrID: string,
+    body: RecordUpdateParams | null | undefined = undefined,
+    options?: RequestOptions,
+  ): APIPromise<RecordUpdateResponse> {
+    return this._client.patch(path`/custom-objects/${customObjectAPIName}/records/${codrID}/`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * A List of custom object records
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    customObjectAPIName: string,
+    options?: RequestOptions,
+  ): PagePromise<CustomObjectDataRowsPageCursorURL, CustomObjectDataRow> {
+    return this._client.getAPIList(
+      path`/custom-objects/${customObjectAPIName}/records/`,
+      PageCursorURL<CustomObjectDataRow>,
+      options,
+    );
+  }
+
+  /**
+   * Delete a custom object record
+   */
+  delete(customObjectAPIName: string, codrID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-objects/${customObjectAPIName}/records/${codrID}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * bulk create new custom object records
+   */
+  bulkCreate(
+    customObjectAPIName: string,
+    body: RecordBulkCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RecordBulkCreateResponse> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/bulk/`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Bulk Delete custom object records
+   */
+  bulkDelete(
+    customObjectAPIName: string,
+    body: RecordBulkDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/bulk-delete/`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Bulk Updated a specific custom object records
+   */
+  bulkUpdate(
+    customObjectAPIName: string,
+    body: RecordBulkUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RecordBulkUpdateResponse> {
+    return this._client.patch(path`/custom-objects/${customObjectAPIName}/records/bulk/`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * A List of custom object records filtered by querying
+   */
+  query(
+    customObjectAPIName: string,
+    body: RecordQueryParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RecordQueryResponse> {
+    return this._client.post(path`/custom-objects/${customObjectAPIName}/records/query/`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific custom object record by its external_id
+   */
+  retrieveByExternalID(
+    customObjectAPIName: string,
+    externalID: string,
+    options?: RequestOptions,
+  ): APIPromise<CustomObjectDataRow> {
+    return this._client.get(
+      path`/custom-objects/${customObjectAPIName}/records/external_id/${externalID}/`,
+      options,
+    );
+  }
+}
+
+export type CustomObjectDataRowsPageCursorURL = PageCursorURL<CustomObjectDataRow>;
+
+export interface CustomObjectDataRow {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the custom object datarow
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  created_by?: CustomObjectDataRow.CreatedBy;
+
+  /**
+   * The external id of the custom object datarow
+   */
+  external_id?: string;
+
+  last_modified_by?: CustomObjectDataRow.LastModifiedBy;
+
+  owner_role?: CustomObjectDataRow.OwnerRole;
+
+  system_updated_at?: string;
+
+  [k: string]: unknown;
+}
+
+export namespace CustomObjectDataRow {
+  export interface CreatedBy {
+    id?: string;
+
+    display_value?: string;
+
+    image?: string;
+  }
+
+  export interface LastModifiedBy {
+    id?: string;
+
+    display_value?: string;
+
+    image?: string;
+  }
+
+  export interface OwnerRole {
+    id?: string;
+
+    display_value?: string;
+
+    image?: string;
+  }
+}
+
+export interface RecordCreateResponse {
+  data?: CustomObjectDataRow;
+}
+
+export interface RecordUpdateResponse {
+  data?: CustomObjectDataRow;
+}
+
+export interface RecordBulkCreateResponse {
+  data?: Array<CustomObjectDataRow>;
+}
+
+export interface RecordBulkUpdateResponse {
+  data?: Array<CustomObjectDataRow>;
+}
+
+export interface RecordQueryResponse {
+  cursor?: string;
+
+  results?: Array<CustomObjectDataRow>;
+}
+
+export type RecordCreateParams = { [key: string]: unknown };
+
+export type RecordUpdateParams = { [key: string]: unknown };
+
+export interface RecordBulkCreateParams {
+  all_or_nothing?: boolean;
+
+  rows_to_write?: Array<{ [key: string]: unknown }>;
+}
+
+export interface RecordBulkDeleteParams {
+  all_or_nothing?: boolean;
+
+  /**
+   * a list of ids, e.g. [id_1, id_2].
+   */
+  rows_to_delete?: Array<string>;
+}
+
+export interface RecordBulkUpdateParams {
+  all_or_nothing?: boolean;
+
+  rows_to_update?: Array<{ [key: string]: unknown }>;
+}
+
+export interface RecordQueryParams {
+  cursor?: string;
+
+  limit?: number;
+
+  query?: string;
+}
+
+export declare namespace Records {
+  export {
+    type CustomObjectDataRow as CustomObjectDataRow,
+    type RecordCreateResponse as RecordCreateResponse,
+    type RecordUpdateResponse as RecordUpdateResponse,
+    type RecordBulkCreateResponse as RecordBulkCreateResponse,
+    type RecordBulkUpdateResponse as RecordBulkUpdateResponse,
+    type RecordQueryResponse as RecordQueryResponse,
+    type CustomObjectDataRowsPageCursorURL as CustomObjectDataRowsPageCursorURL,
+    type RecordCreateParams as RecordCreateParams,
+    type RecordUpdateParams as RecordUpdateParams,
+    type RecordBulkCreateParams as RecordBulkCreateParams,
+    type RecordBulkDeleteParams as RecordBulkDeleteParams,
+    type RecordBulkUpdateParams as RecordBulkUpdateParams,
+    type RecordQueryParams as RecordQueryParams,
+  };
+}

package/src/resources/custom-objects.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './custom-objects/index';