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

package/src/resources/metadata/deployment-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 DeploymentRuns extends APIResource {
+  /**
+   * Queue deployment for a metadata component package and return a run id for
+   * polling.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.metadata.deploymentRuns.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: DeploymentRunCreateV2Params,
+    options?: RequestOptions,
+  ): APIPromise<DeploymentRunCreateV2Response> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post('/metadata/v2/deployment-runs/', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Poll a metadata deployment run until the terminal field is true.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metadata.deploymentRuns.getV2(
+   *   'run_id',
+   * );
+   * ```
+   */
+  getV2(runID: string, options?: RequestOptions): APIPromise<DeploymentRunGetV2Response> {
+    return this._client.get(path`/metadata/v2/deployment-runs/${runID}/`, options);
+  }
+
+  /**
+   * Queue deployment for a metadata component package and return a run id for
+   * polling.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const deploymentRun =
+   *   await client.metadata.deploymentRuns.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: DeploymentRunCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<DeploymentRunCreateResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post('/metadata/deployment-runs/', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Poll a metadata deployment run until the terminal field is true.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const deploymentRun =
+   *   await client.metadata.deploymentRuns.get('run_id');
+   * ```
+   */
+  get(runID: string, options?: RequestOptions): APIPromise<DeploymentRunGetResponse> {
+    return this._client.get(path`/metadata/deployment-runs/${runID}/`, options);
+  }
+}
+
+export interface DeploymentRunCreateV2Response {
+  /**
+   * 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 DeploymentRunGetV2Response {
+  /**
+   * 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 DeploymentRunCreateResponse {
+  /**
+   * 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 DeploymentRunGetResponse {
+  /**
+   * 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 DeploymentRunCreateV2Params {
+  /**
+   * Body param: Complete package of metadata components, including dependencies.
+   */
+  components: Array<DeploymentRunCreateV2Params.Component>;
+
+  /**
+   * Header param: Optional idempotency key used to deduplicate retried create
+   * requests.
+   */
+  'Idempotency-Key'?: string;
+}
+
+export namespace DeploymentRunCreateV2Params {
+  /**
+   * 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 DeploymentRunCreateParams {
+  /**
+   * Body param: Complete package of metadata components, including dependencies.
+   */
+  components: Array<DeploymentRunCreateParams.Component>;
+
+  /**
+   * Header param: Optional idempotency key used to deduplicate retried create
+   * requests.
+   */
+  'Idempotency-Key'?: string;
+}
+
+export namespace DeploymentRunCreateParams {
+  /**
+   * 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 DeploymentRuns {
+  export {
+    type DeploymentRunCreateV2Response as DeploymentRunCreateV2Response,
+    type DeploymentRunGetV2Response as DeploymentRunGetV2Response,
+    type DeploymentRunCreateResponse as DeploymentRunCreateResponse,
+    type DeploymentRunGetResponse as DeploymentRunGetResponse,
+    type DeploymentRunCreateV2Params as DeploymentRunCreateV2Params,
+    type DeploymentRunCreateParams as DeploymentRunCreateParams,
+  };
+}

package/src/resources/metadata/index.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ComponentSchemas,
+  type ComponentSchemaGetResponse,
+  type ComponentSchemaGetParams,
+} from './component-schemas';
+export { ComponentTypes, type ComponentTypeListResponse } from './component-types';
+export {
+  Components,
+  type ComponentExtractResponse,
+  type ComponentValidateV2Response,
+  type ComponentValidateResponse,
+  type ComponentDeployResponse,
+  type ComponentExtractParams,
+  type ComponentValidateV2Params,
+  type ComponentValidateParams,
+  type ComponentDeployParams,
+} from './components';
+export {
+  DeploymentRuns,
+  type DeploymentRunCreateV2Response,
+  type DeploymentRunGetV2Response,
+  type DeploymentRunCreateResponse,
+  type DeploymentRunGetResponse,
+  type DeploymentRunCreateV2Params,
+  type DeploymentRunCreateParams,
+} from './deployment-runs';
+export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from './metadata';
+export { Schema, type SchemaGetResponse, type SchemaGetParams } from './schema';
+export { Types, type TypeListResponse } from './types';
+export {
+  ValidationRuns,
+  type ValidationRunCreateV2Response,
+  type ValidationRunGetV2Response,
+  type ValidationRunCreateResponse,
+  type ValidationRunGetResponse,
+  type ValidationRunCreateV2Params,
+  type ValidationRunCreateParams,
+} from './validation-runs';

package/src/resources/metadata/metadata.ts

@@ -0,0 +1,221 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ComponentSchemasAPI from './component-schemas';
+import { ComponentSchemaGetParams, ComponentSchemaGetResponse, ComponentSchemas } from './component-schemas';
+import * as ComponentTypesAPI from './component-types';
+import { ComponentTypeListResponse, ComponentTypes } from './component-types';
+import * as ComponentsAPI from './components';
+import {
+  ComponentDeployParams,
+  ComponentDeployResponse,
+  ComponentExtractParams,
+  ComponentExtractResponse,
+  ComponentValidateParams,
+  ComponentValidateResponse,
+  ComponentValidateV2Params,
+  ComponentValidateV2Response,
+  Components,
+} from './components';
+import * as DeploymentRunsAPI from './deployment-runs';
+import {
+  DeploymentRunCreateParams,
+  DeploymentRunCreateResponse,
+  DeploymentRunCreateV2Params,
+  DeploymentRunCreateV2Response,
+  DeploymentRunGetResponse,
+  DeploymentRunGetV2Response,
+  DeploymentRuns,
+} from './deployment-runs';
+import * as SchemaAPI from './schema';
+import { Schema, SchemaGetParams, SchemaGetResponse } from './schema';
+import * as TypesAPI from './types';
+import { TypeListResponse, Types } from './types';
+import * as ValidationRunsAPI from './validation-runs';
+import {
+  ValidationRunCreateParams,
+  ValidationRunCreateResponse,
+  ValidationRunCreateV2Params,
+  ValidationRunCreateV2Response,
+  ValidationRunGetResponse,
+  ValidationRunGetV2Response,
+  ValidationRuns,
+} from './validation-runs';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Metadata extends APIResource {
+  types: TypesAPI.Types = new TypesAPI.Types(this._client);
+  schema: SchemaAPI.Schema = new SchemaAPI.Schema(this._client);
+  componentTypes: ComponentTypesAPI.ComponentTypes = new ComponentTypesAPI.ComponentTypes(this._client);
+  componentSchemas: ComponentSchemasAPI.ComponentSchemas = new ComponentSchemasAPI.ComponentSchemas(
+    this._client,
+  );
+  components: ComponentsAPI.Components = new ComponentsAPI.Components(this._client);
+  validationRuns: ValidationRunsAPI.ValidationRuns = new ValidationRunsAPI.ValidationRuns(this._client);
+  deploymentRuns: DeploymentRunsAPI.DeploymentRuns = new DeploymentRunsAPI.DeploymentRuns(this._client);
+
+  /**
+   * Extract the company's selectable metadata components, optionally filtered by a
+   * search query.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metadata.extract();
+   * ```
+   */
+  extract(
+    query: MetadataExtractParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MetadataExtractResponse> {
+    return this._client.get('/metadata/extract/', { query, ...options });
+  }
+}
+
+export interface MetadataExtractResponse {
+  /**
+   * Full component configs needed to recreate the selected roots.
+   */
+  component_configs: Array<MetadataExtractResponse.ComponentConfig>;
+
+  /**
+   * Serialized dependency graph for the extracted package.
+   */
+  dependency_graph: { [key: string]: unknown };
+
+  /**
+   * Topological install order for the extracted package.
+   */
+  install_order: Array<{ [key: string]: unknown }>;
+
+  /**
+   * Components selected as extraction roots.
+   */
+  root_components: Array<MetadataExtractResponse.RootComponent>;
+
+  /**
+   * For search-backed extraction, whether contextual expansion completed.
+   */
+  context_complete?: boolean;
+
+  /**
+   * Warnings from search-backed contextual expansion.
+   */
+  context_warnings?: Array<string>;
+
+  external_managed_dependencies?: Array<{ [key: string]: unknown }>;
+
+  [k: string]: unknown;
+}
+
+export namespace MetadataExtractResponse {
+  /**
+   * A metadata component config. The `type` field selects the concrete component
+   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+   */
+  export interface ComponentConfig {
+    /**
+     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+
+  /**
+   * Selectable package root returned by metadata extraction.
+   */
+  export interface RootComponent {
+    /**
+     * Identifier for the selected component.
+     */
+    identifier?: { [key: string]: unknown };
+
+    /**
+     * Display name for the selectable component.
+     */
+    name?: string;
+
+    [k: string]: unknown;
+  }
+}
+
+export interface MetadataExtractParams {
+  /**
+   * Maximum search results to return when q is provided.
+   */
+  limit?: number;
+
+  /**
+   * Optional text search over selectable components.
+   */
+  q?: string;
+}
+
+Metadata.Types = Types;
+Metadata.Schema = Schema;
+Metadata.ComponentTypes = ComponentTypes;
+Metadata.ComponentSchemas = ComponentSchemas;
+Metadata.Components = Components;
+Metadata.ValidationRuns = ValidationRuns;
+Metadata.DeploymentRuns = DeploymentRuns;
+
+export declare namespace Metadata {
+  export {
+    type MetadataExtractResponse as MetadataExtractResponse,
+    type MetadataExtractParams as MetadataExtractParams,
+  };
+
+  export { Types as Types, type TypeListResponse as TypeListResponse };
+
+  export {
+    Schema as Schema,
+    type SchemaGetResponse as SchemaGetResponse,
+    type SchemaGetParams as SchemaGetParams,
+  };
+
+  export { ComponentTypes as ComponentTypes, type ComponentTypeListResponse as ComponentTypeListResponse };
+
+  export {
+    ComponentSchemas as ComponentSchemas,
+    type ComponentSchemaGetResponse as ComponentSchemaGetResponse,
+    type ComponentSchemaGetParams as ComponentSchemaGetParams,
+  };
+
+  export {
+    Components as Components,
+    type ComponentExtractResponse as ComponentExtractResponse,
+    type ComponentValidateV2Response as ComponentValidateV2Response,
+    type ComponentValidateResponse as ComponentValidateResponse,
+    type ComponentDeployResponse as ComponentDeployResponse,
+    type ComponentExtractParams as ComponentExtractParams,
+    type ComponentValidateV2Params as ComponentValidateV2Params,
+    type ComponentValidateParams as ComponentValidateParams,
+    type ComponentDeployParams as ComponentDeployParams,
+  };
+
+  export {
+    ValidationRuns as ValidationRuns,
+    type ValidationRunCreateV2Response as ValidationRunCreateV2Response,
+    type ValidationRunGetV2Response as ValidationRunGetV2Response,
+    type ValidationRunCreateResponse as ValidationRunCreateResponse,
+    type ValidationRunGetResponse as ValidationRunGetResponse,
+    type ValidationRunCreateV2Params as ValidationRunCreateV2Params,
+    type ValidationRunCreateParams as ValidationRunCreateParams,
+  };
+
+  export {
+    DeploymentRuns as DeploymentRuns,
+    type DeploymentRunCreateV2Response as DeploymentRunCreateV2Response,
+    type DeploymentRunGetV2Response as DeploymentRunGetV2Response,
+    type DeploymentRunCreateResponse as DeploymentRunCreateResponse,
+    type DeploymentRunGetResponse as DeploymentRunGetResponse,
+    type DeploymentRunCreateV2Params as DeploymentRunCreateV2Params,
+    type DeploymentRunCreateParams as DeploymentRunCreateParams,
+  };
+}