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

package/resources/metadata/components.mjs

@@ -0,0 +1,130 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+/**
+ * Custom objects defined by the company
+ */
+export class Components extends APIResource {
+    /**
+     * Extract the company's selectable metadata components, optionally filtered by a
+     * search query.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.components.extract();
+     * ```
+     */
+    extract(query = {}, options) {
+        return this._client.get('/metadata/v2/extract/', { query, ...options });
+    }
+    /**
+     * Validate component schemas and dependencies without installing them. Use the
+     * normalized results before deploy.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.metadata.components.validateV2({
+     *     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,
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    validateV2(body, options) {
+        return this._client.post('/metadata/v2/validate/', { body, ...options });
+    }
+    /**
+     * Validate a complete metadata component package without installing it.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.components.validate({
+     *   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,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    validate(body, options) {
+        return this._client.post('/metadata/validate/', { body, ...options });
+    }
+    /**
+     * Create or update the supplied metadata components as one package. Call
+     * validation first and deploy only valid input.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.components.deploy({
+     *   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,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    deploy(body, options) {
+        return this._client.post('/metadata/deploy/', { body, ...options });
+    }
+}
+//# sourceMappingURL=components.mjs.map

package/resources/metadata/components.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"components.mjs","sourceRoot":"","sources":["../../src/resources/metadata/components.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;OAUG;IACH,OAAO,CACL,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,UAAU,CACR,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,IAA6B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}

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

@@ -0,0 +1,275 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * 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.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deployment-runs.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/deployment-runs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;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.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