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

package/resources/metadata/deployment-runs.d.ts

@@ -0,0 +1,275 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Custom objects defined by the company
+ */
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+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 declare namespace DeploymentRunCreateV2Params {
+    /**
+     * A metadata component config. The `type` field selects the concrete component
+     * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+     */
+    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 declare namespace DeploymentRunCreateParams {
+    /**
+     * A metadata component config. The `type` field selects the concrete component
+     * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+     */
+    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, };
+}
+//# sourceMappingURL=deployment-runs.d.ts.map

package/resources/metadata/deployment-runs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployment-runs.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/deployment-runs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CACN,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAY5C;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAY1C;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IAEhF;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,YAAY,GAAG,YAAY,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IAEhF;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,YAAY,GAAG,YAAY,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IAEhF;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,YAAY,GAAG,YAAY,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IAEhF;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,YAAY,GAAG,YAAY,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE1C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAEzD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;IAEvD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/metadata/deployment-runs.js

@@ -0,0 +1,133 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeploymentRuns = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Custom objects defined by the company
+ */
+class DeploymentRuns extends resource_1.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, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/metadata/v2/deployment-runs/', {
+            body,
+            ...options,
+            headers: (0, headers_1.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, options) {
+        return this._client.get((0, path_1.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, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/metadata/deployment-runs/', {
+            body,
+            ...options,
+            headers: (0, headers_1.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, options) {
+        return this._client.get((0, path_1.path) `/metadata/deployment-runs/${runID}/`, options);
+    }
+}
+exports.DeploymentRuns = DeploymentRuns;
+//# sourceMappingURL=deployment-runs.js.map

package/resources/metadata/deployment-runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployment-runs.js","sourceRoot":"","sources":["../../src/resources/metadata/deployment-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CACN,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,KAAa,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,KAAK,GAAG,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAa,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,6BAA6B,KAAK,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAjID,wCAiIC"}

package/resources/metadata/deployment-runs.mjs

@@ -0,0 +1,129 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * 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, options) {
+        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, options) {
+        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, options) {
+        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, options) {
+        return this._client.get(path `/metadata/deployment-runs/${runID}/`, options);
+    }
+}
+//# sourceMappingURL=deployment-runs.mjs.map

package/resources/metadata/deployment-runs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployment-runs.mjs","sourceRoot":"","sources":["../../src/resources/metadata/deployment-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CACN,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,KAAa,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,KAAK,GAAG,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAa,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,6BAA6B,KAAK,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/resources/metadata/index.d.mts

@@ -0,0 +1,9 @@
+export { ComponentSchemas, type ComponentSchemaGetResponse, type ComponentSchemaGetParams, } from "./component-schemas.mjs";
+export { ComponentTypes, type ComponentTypeListResponse } from "./component-types.mjs";
+export { Components, type ComponentExtractResponse, type ComponentValidateV2Response, type ComponentValidateResponse, type ComponentDeployResponse, type ComponentExtractParams, type ComponentValidateV2Params, type ComponentValidateParams, type ComponentDeployParams, } from "./components.mjs";
+export { DeploymentRuns, type DeploymentRunCreateV2Response, type DeploymentRunGetV2Response, type DeploymentRunCreateResponse, type DeploymentRunGetResponse, type DeploymentRunCreateV2Params, type DeploymentRunCreateParams, } from "./deployment-runs.mjs";
+export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from "./metadata.mjs";
+export { Schema, type SchemaGetResponse, type SchemaGetParams } from "./schema.mjs";
+export { Types, type TypeListResponse } from "./types.mjs";
+export { ValidationRuns, type ValidationRunCreateV2Response, type ValidationRunGetV2Response, type ValidationRunCreateResponse, type ValidationRunGetResponse, type ValidationRunCreateV2Params, type ValidationRunCreateParams, } from "./validation-runs.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/metadata/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gBAAgB,EAChB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,GAC9B,gCAA4B;AAC7B,OAAO,EAAE,cAAc,EAAE,KAAK,yBAAyB,EAAE,8BAA0B;AACnF,OAAO,EACL,UAAU,EACV,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,yBAAqB;AACtB,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,8BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAAE,KAAK,uBAAuB,EAAE,KAAK,qBAAqB,EAAE,uBAAmB;AAChG,OAAO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,qBAAiB;AAChF,OAAO,EAAE,KAAK,EAAE,KAAK,gBAAgB,EAAE,oBAAgB;AACvD,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,8BAA0B"}

package/resources/metadata/index.d.ts

@@ -0,0 +1,9 @@
+export { ComponentSchemas, type ComponentSchemaGetResponse, type ComponentSchemaGetParams, } from "./component-schemas.js";
+export { ComponentTypes, type ComponentTypeListResponse } from "./component-types.js";
+export { Components, type ComponentExtractResponse, type ComponentValidateV2Response, type ComponentValidateResponse, type ComponentDeployResponse, type ComponentExtractParams, type ComponentValidateV2Params, type ComponentValidateParams, type ComponentDeployParams, } from "./components.js";
+export { DeploymentRuns, type DeploymentRunCreateV2Response, type DeploymentRunGetV2Response, type DeploymentRunCreateResponse, type DeploymentRunGetResponse, type DeploymentRunCreateV2Params, type DeploymentRunCreateParams, } from "./deployment-runs.js";
+export { Metadata, type MetadataExtractResponse, type MetadataExtractParams } from "./metadata.js";
+export { Schema, type SchemaGetResponse, type SchemaGetParams } from "./schema.js";
+export { Types, type TypeListResponse } from "./types.js";
+export { ValidationRuns, type ValidationRunCreateV2Response, type ValidationRunGetV2Response, type ValidationRunCreateResponse, type ValidationRunGetResponse, type ValidationRunCreateV2Params, type ValidationRunCreateParams, } from "./validation-runs.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/metadata/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gBAAgB,EAChB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,GAC9B,+BAA4B;AAC7B,OAAO,EAAE,cAAc,EAAE,KAAK,yBAAyB,EAAE,6BAA0B;AACnF,OAAO,EACL,UAAU,EACV,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,wBAAqB;AACtB,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,6BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAAE,KAAK,uBAAuB,EAAE,KAAK,qBAAqB,EAAE,sBAAmB;AAChG,OAAO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,oBAAiB;AAChF,OAAO,EAAE,KAAK,EAAE,KAAK,gBAAgB,EAAE,mBAAgB;AACvD,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,6BAA0B"}

package/resources/metadata/index.js

@@ -0,0 +1,21 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationRuns = exports.Types = exports.Schema = exports.Metadata = exports.DeploymentRuns = exports.Components = exports.ComponentTypes = exports.ComponentSchemas = void 0;
+var component_schemas_1 = require("./component-schemas.js");
+Object.defineProperty(exports, "ComponentSchemas", { enumerable: true, get: function () { return component_schemas_1.ComponentSchemas; } });
+var component_types_1 = require("./component-types.js");
+Object.defineProperty(exports, "ComponentTypes", { enumerable: true, get: function () { return component_types_1.ComponentTypes; } });
+var components_1 = require("./components.js");
+Object.defineProperty(exports, "Components", { enumerable: true, get: function () { return components_1.Components; } });
+var deployment_runs_1 = require("./deployment-runs.js");
+Object.defineProperty(exports, "DeploymentRuns", { enumerable: true, get: function () { return deployment_runs_1.DeploymentRuns; } });
+var metadata_1 = require("./metadata.js");
+Object.defineProperty(exports, "Metadata", { enumerable: true, get: function () { return metadata_1.Metadata; } });
+var schema_1 = require("./schema.js");
+Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return schema_1.Schema; } });
+var types_1 = require("./types.js");
+Object.defineProperty(exports, "Types", { enumerable: true, get: function () { return types_1.Types; } });
+var validation_runs_1 = require("./validation-runs.js");
+Object.defineProperty(exports, "ValidationRuns", { enumerable: true, get: function () { return validation_runs_1.ValidationRuns; } });
+//# sourceMappingURL=index.js.map

package/resources/metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/metadata/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAI6B;AAH3B,qHAAA,gBAAgB,OAAA;AAIlB,wDAAmF;AAA1E,iHAAA,cAAc,OAAA;AACvB,8CAUsB;AATpB,wGAAA,UAAU,OAAA;AAUZ,wDAQ2B;AAPzB,iHAAA,cAAc,OAAA;AAQhB,0CAAgG;AAAvF,oGAAA,QAAQ,OAAA;AACjB,sCAAgF;AAAvE,gGAAA,MAAM,OAAA;AACf,oCAAuD;AAA9C,8FAAA,KAAK,OAAA;AACd,wDAQ2B;AAPzB,iHAAA,cAAc,OAAA"}

package/resources/metadata/index.mjs

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { ComponentSchemas, } from "./component-schemas.mjs";
+export { ComponentTypes } from "./component-types.mjs";
+export { Components, } from "./components.mjs";
+export { DeploymentRuns, } from "./deployment-runs.mjs";
+export { Metadata } from "./metadata.mjs";
+export { Schema } from "./schema.mjs";
+export { Types } from "./types.mjs";
+export { ValidationRuns, } from "./validation-runs.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/metadata/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/metadata/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,gBAAgB,GAGjB,gCAA4B;AAC7B,OAAO,EAAE,cAAc,EAAkC,8BAA0B;AACnF,OAAO,EACL,UAAU,GASX,yBAAqB;AACtB,OAAO,EACL,cAAc,GAOf,8BAA0B;AAC3B,OAAO,EAAE,QAAQ,EAA4D,uBAAmB;AAChG,OAAO,EAAE,MAAM,EAAgD,qBAAiB;AAChF,OAAO,EAAE,KAAK,EAAyB,oBAAgB;AACvD,OAAO,EACL,cAAc,GAOf,8BAA0B"}