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

package/src/resources/metadata/schema.ts

@@ -0,0 +1,105 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Schema extends APIResource {
+  /**
+   * Return the JSON schema for one supported metadata component type.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const schema = await client.metadata.schema.get({
+   *   type: 'type',
+   * });
+   * ```
+   */
+  get(query: SchemaGetParams, options?: RequestOptions): APIPromise<SchemaGetResponse> {
+    return this._client.get('/metadata/schema/', { query, ...options });
+  }
+}
+
+export interface SchemaGetResponse {
+  /**
+   * JSON Schema for a full deployable component config.
+   */
+  config_schema: { [key: string]: unknown };
+
+  /**
+   * JSON Schema for identifying an existing component.
+   */
+  identifier_schema: { [key: string]: unknown };
+
+  /**
+   * Metadata component type.
+   */
+  type: string;
+
+  /**
+   * Type-specific implementation guidance.
+   */
+  best_practices?: string;
+
+  /**
+   * Common invalid inputs and their corrections.
+   */
+  common_mistakes?: Array<SchemaGetResponse.CommonMistake>;
+
+  /**
+   * Short description of the component type.
+   */
+  description?: string;
+
+  /**
+   * Human-readable component type name.
+   */
+  display_name?: string;
+
+  /**
+   * Valid example configs for this component type.
+   */
+  examples?: Array<{ [key: string]: unknown }>;
+
+  /**
+   * Type-specific authoring guidance.
+   */
+  usage_guide?: string;
+
+  [k: string]: unknown;
+}
+
+export namespace SchemaGetResponse {
+  export interface CommonMistake {
+    /**
+     * Explanation of the correction.
+     */
+    message: string;
+
+    /**
+     * Corrected example.
+     */
+    right: string;
+
+    /**
+     * Invalid or discouraged example.
+     */
+    wrong: string;
+  }
+}
+
+export interface SchemaGetParams {
+  /**
+   * Component type returned by list-metadata-types.
+   */
+  type: string;
+}
+
+export declare namespace Schema {
+  export { type SchemaGetResponse as SchemaGetResponse, type SchemaGetParams as SchemaGetParams };
+}

package/src/resources/metadata/types.ts

@@ -0,0 +1,55 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Types extends APIResource {
+  /**
+   * List component types that can be described, validated, and deployed by metadata
+   * composer.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const types = await client.metadata.types.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<TypeListResponse> {
+    return this._client.get('/metadata/types/', options);
+  }
+}
+
+export interface TypeListResponse {
+  /**
+   * Composer-enabled metadata component types.
+   */
+  types: Array<TypeListResponse.Type>;
+}
+
+export namespace TypeListResponse {
+  export interface Type {
+    /**
+     * Short description of the component type.
+     */
+    description: string;
+
+    /**
+     * Human-readable component type name.
+     */
+    display_name: string;
+
+    /**
+     * Metadata component type.
+     */
+    type: string;
+  }
+}
+
+export declare namespace Types {
+  export { type TypeListResponse as TypeListResponse };
+}

package/src/resources/metadata/validation-runs.ts

@@ -0,0 +1,356 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Custom objects defined by the company
+ */
+export class ValidationRuns extends APIResource {
+  /**
+   * Queue validation for a metadata component package and return a run id for
+   * polling.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.metadata.validationRuns.createV2({
+   *     components: [
+   *       {
+   *         type: 'CUSTOM_OBJECT',
+   *         api_name: 'purchase_order__c',
+   *         name: 'Purchase Order',
+   *         description: 'Tracks purchase requests',
+   *         category_api_name: 'procurement__c',
+   *       },
+   *       {
+   *         type: 'CUSTOM_OBJECT_FIELD',
+   *         custom_object_api_name: 'purchase_order__c',
+   *         field_api_name: 'amount__c',
+   *         field_display_name: 'Amount',
+   *         data_type: {
+   *           field_type: 'CURRENCY',
+   *           currency: 'USD',
+   *           num_of_decimal_places: 2,
+   *         },
+   *         is_standard: false,
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  createV2(
+    params: ValidationRunCreateV2Params,
+    options?: RequestOptions,
+  ): APIPromise<ValidationRunCreateV2Response> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post('/metadata/v2/validation-runs/', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Poll a metadata validation run until the terminal field is true.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metadata.validationRuns.getV2(
+   *   'run_id',
+   * );
+   * ```
+   */
+  getV2(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetV2Response> {
+    return this._client.get(path`/metadata/v2/validation-runs/${runID}/`, options);
+  }
+
+  /**
+   * Queue validation for a metadata component package and return a run id for
+   * polling.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const validationRun =
+   *   await client.metadata.validationRuns.create({
+   *     components: [
+   *       {
+   *         type: 'CUSTOM_OBJECT',
+   *         api_name: 'purchase_order__c',
+   *         name: 'Purchase Order',
+   *         description: 'Tracks purchase requests',
+   *         category_api_name: 'procurement__c',
+   *       },
+   *       {
+   *         type: 'CUSTOM_OBJECT_FIELD',
+   *         custom_object_api_name: 'purchase_order__c',
+   *         field_api_name: 'amount__c',
+   *         field_display_name: 'Amount',
+   *         data_type: {
+   *           field_type: 'CURRENCY',
+   *           currency: 'USD',
+   *           num_of_decimal_places: 2,
+   *         },
+   *         is_standard: false,
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  create(
+    params: ValidationRunCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ValidationRunCreateResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post('/metadata/validation-runs/', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Poll a metadata validation run until the terminal field is true.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const validationRun =
+   *   await client.metadata.validationRuns.get('run_id');
+   * ```
+   */
+  get(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetResponse> {
+    return this._client.get(path`/metadata/validation-runs/${runID}/`, options);
+  }
+}
+
+export interface ValidationRunCreateV2Response {
+  /**
+   * Metadata run id.
+   */
+  id: string;
+
+  progress: { [key: string]: unknown };
+
+  /**
+   * Suggested client polling delay in milliseconds.
+   */
+  retry_after_ms: number;
+
+  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
+
+  /**
+   * Whether the run has reached a terminal status.
+   */
+  terminal: boolean;
+
+  type: 'validation' | 'deployment';
+
+  created_at?: string | null;
+
+  error?: { [key: string]: unknown } | null;
+
+  expires_at?: string | null;
+
+  finished_at?: string | null;
+
+  result?: { [key: string]: unknown } | null;
+
+  started_at?: string | null;
+
+  updated_at?: string | null;
+}
+
+export interface ValidationRunGetV2Response {
+  /**
+   * Metadata run id.
+   */
+  id: string;
+
+  progress: { [key: string]: unknown };
+
+  /**
+   * Suggested client polling delay in milliseconds.
+   */
+  retry_after_ms: number;
+
+  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
+
+  /**
+   * Whether the run has reached a terminal status.
+   */
+  terminal: boolean;
+
+  type: 'validation' | 'deployment';
+
+  created_at?: string | null;
+
+  error?: { [key: string]: unknown } | null;
+
+  expires_at?: string | null;
+
+  finished_at?: string | null;
+
+  result?: { [key: string]: unknown } | null;
+
+  started_at?: string | null;
+
+  updated_at?: string | null;
+}
+
+export interface ValidationRunCreateResponse {
+  /**
+   * Metadata run id.
+   */
+  id: string;
+
+  progress: { [key: string]: unknown };
+
+  /**
+   * Suggested client polling delay in milliseconds.
+   */
+  retry_after_ms: number;
+
+  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
+
+  /**
+   * Whether the run has reached a terminal status.
+   */
+  terminal: boolean;
+
+  type: 'validation' | 'deployment';
+
+  created_at?: string | null;
+
+  error?: { [key: string]: unknown } | null;
+
+  expires_at?: string | null;
+
+  finished_at?: string | null;
+
+  result?: { [key: string]: unknown } | null;
+
+  started_at?: string | null;
+
+  updated_at?: string | null;
+}
+
+export interface ValidationRunGetResponse {
+  /**
+   * Metadata run id.
+   */
+  id: string;
+
+  progress: { [key: string]: unknown };
+
+  /**
+   * Suggested client polling delay in milliseconds.
+   */
+  retry_after_ms: number;
+
+  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
+
+  /**
+   * Whether the run has reached a terminal status.
+   */
+  terminal: boolean;
+
+  type: 'validation' | 'deployment';
+
+  created_at?: string | null;
+
+  error?: { [key: string]: unknown } | null;
+
+  expires_at?: string | null;
+
+  finished_at?: string | null;
+
+  result?: { [key: string]: unknown } | null;
+
+  started_at?: string | null;
+
+  updated_at?: string | null;
+}
+
+export interface ValidationRunCreateV2Params {
+  /**
+   * Body param: Complete package of metadata components, including dependencies.
+   */
+  components: Array<ValidationRunCreateV2Params.Component>;
+
+  /**
+   * Header param: Optional idempotency key used to deduplicate retried create
+   * requests.
+   */
+  'Idempotency-Key'?: string;
+}
+
+export namespace ValidationRunCreateV2Params {
+  /**
+   * A metadata component config. The `type` field selects the concrete component
+   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+   */
+  export interface Component {
+    /**
+     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+}
+
+export interface ValidationRunCreateParams {
+  /**
+   * Body param: Complete package of metadata components, including dependencies.
+   */
+  components: Array<ValidationRunCreateParams.Component>;
+
+  /**
+   * Header param: Optional idempotency key used to deduplicate retried create
+   * requests.
+   */
+  'Idempotency-Key'?: string;
+}
+
+export namespace ValidationRunCreateParams {
+  /**
+   * A metadata component config. The `type` field selects the concrete component
+   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+   */
+  export interface Component {
+    /**
+     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+}
+
+export declare namespace ValidationRuns {
+  export {
+    type ValidationRunCreateV2Response as ValidationRunCreateV2Response,
+    type ValidationRunGetV2Response as ValidationRunGetV2Response,
+    type ValidationRunCreateResponse as ValidationRunCreateResponse,
+    type ValidationRunGetResponse as ValidationRunGetResponse,
+    type ValidationRunCreateV2Params as ValidationRunCreateV2Params,
+    type ValidationRunCreateParams as ValidationRunCreateParams,
+  };
+}

package/src/resources/metadata.ts

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

package/src/resources/object-categories.ts

@@ -16,8 +16,14 @@ export class ObjectCategories extends APIResource {
    *
    * - Requires: `API Tier 1`
    */
-  list(options?: RequestOptions): PagePromise<ObjectCategoriesPageCursorURL, ObjectCategory> {
-    return this._client.getAPIList('/object-categories/', PageCursorURL<ObjectCategory>, options);
+  list(
+    query: ObjectCategoryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ObjectCategoriesPageCursorURL, ObjectCategory> {
+    return this._client.getAPIList('/object-categories/', PageCursorURL<ObjectCategory>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -88,6 +94,15 @@ export interface ObjectCategory {
   description?: string;
 }
 
+export interface ObjectCategoryListParams {
+  cursor?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+}
+
 export interface ObjectCategoryCreateParams {
   /**
    * A description of the category.
@@ -116,6 +131,7 @@ export declare namespace ObjectCategories {
   export {
     type ObjectCategory as ObjectCategory,
     type ObjectCategoriesPageCursorURL as ObjectCategoriesPageCursorURL,
+    type ObjectCategoryListParams as ObjectCategoryListParams,
     type ObjectCategoryCreateParams as ObjectCategoryCreateParams,
     type ObjectCategoryUpdateParams as ObjectCategoryUpdateParams,
   };

package/src/resources/package-installs.ts

@@ -0,0 +1,143 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class PackageInstalls extends APIResource {
+  /**
+   * Start installing a published package version asynchronously.
+   */
+  create(
+    body: PackageInstallCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageInstallCreateResponse> {
+    return this._client.post('/package-installs/', { body, ...options });
+  }
+
+  /**
+   * Retrieve the status of a package installation.
+   */
+  retrieve(trackerID: string, options?: RequestOptions): APIPromise<PackageInstallRetrieveResponse> {
+    return this._client.get(path`/package-installs/${trackerID}/`, options);
+  }
+}
+
+/**
+ * Async package installation tracker for subscriber companies.
+ */
+export interface PackageInstallCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when installation failed
+   */
+  error_message?: string;
+
+  /**
+   * Installation record ID when installation completes
+   */
+  installation_record_id?: string;
+
+  /**
+   * The package version being installed
+   */
+  package_version_id?: string;
+
+  /**
+   * Component to open after installation completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * Installation progress entries
+   */
+  progress?: Array<unknown>;
+
+  /**
+   * Installation status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+}
+
+/**
+ * Async package installation tracker for subscriber companies.
+ */
+export interface PackageInstallRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when installation failed
+   */
+  error_message?: string;
+
+  /**
+   * Installation record ID when installation completes
+   */
+  installation_record_id?: string;
+
+  /**
+   * The package version being installed
+   */
+  package_version_id?: string;
+
+  /**
+   * Component to open after installation completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * Installation progress entries
+   */
+  progress?: Array<unknown>;
+
+  /**
+   * Installation status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+}
+
+export interface PackageInstallCreateParams {
+  /**
+   * The published package version to install.
+   */
+  version_id: string;
+}
+
+export declare namespace PackageInstalls {
+  export {
+    type PackageInstallCreateResponse as PackageInstallCreateResponse,
+    type PackageInstallRetrieveResponse as PackageInstallRetrieveResponse,
+    type PackageInstallCreateParams as PackageInstallCreateParams,
+  };
+}