@rippling/rippling-sdk 0.2.0-alpha.94 → 0.2.0-alpha.96
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client.d.mts +72 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +72 -6
- package/client.d.ts.map +1 -1
- package/client.js +66 -0
- package/client.js.map +1 -1
- package/client.mjs +66 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agents/sessions/index.d.mts +1 -0
- package/resources/agents/sessions/index.d.mts.map +1 -1
- package/resources/agents/sessions/index.d.ts +1 -0
- package/resources/agents/sessions/index.d.ts.map +1 -1
- package/resources/agents/sessions/index.js +3 -1
- package/resources/agents/sessions/index.js.map +1 -1
- package/resources/agents/sessions/index.mjs +1 -0
- package/resources/agents/sessions/index.mjs.map +1 -1
- package/resources/agents/sessions/messages.d.mts +24 -0
- package/resources/agents/sessions/messages.d.mts.map +1 -1
- package/resources/agents/sessions/messages.d.ts +24 -0
- package/resources/agents/sessions/messages.d.ts.map +1 -1
- package/resources/agents/sessions/resume-state.d.mts +25 -0
- package/resources/agents/sessions/resume-state.d.mts.map +1 -0
- package/resources/agents/sessions/resume-state.d.ts +25 -0
- package/resources/agents/sessions/resume-state.d.ts.map +1 -0
- package/resources/agents/sessions/resume-state.js +19 -0
- package/resources/agents/sessions/resume-state.js.map +1 -0
- package/resources/agents/sessions/resume-state.mjs +15 -0
- package/resources/agents/sessions/resume-state.mjs.map +1 -0
- package/resources/agents/sessions/sessions.d.mts +91 -0
- package/resources/agents/sessions/sessions.d.mts.map +1 -1
- package/resources/agents/sessions/sessions.d.ts +91 -0
- package/resources/agents/sessions/sessions.d.ts.map +1 -1
- package/resources/agents/sessions/sessions.js +4 -0
- package/resources/agents/sessions/sessions.js.map +1 -1
- package/resources/agents/sessions/sessions.mjs +4 -0
- package/resources/agents/sessions/sessions.mjs.map +1 -1
- package/resources/background-check-candidates.d.mts +337 -0
- package/resources/background-check-candidates.d.mts.map +1 -0
- package/resources/background-check-candidates.d.ts +337 -0
- package/resources/background-check-candidates.d.ts.map +1 -0
- package/resources/background-check-candidates.js +52 -0
- package/resources/background-check-candidates.js.map +1 -0
- package/resources/background-check-candidates.mjs +48 -0
- package/resources/background-check-candidates.mjs.map +1 -0
- package/resources/business-structure-paths.d.mts +54 -1
- package/resources/business-structure-paths.d.mts.map +1 -1
- package/resources/business-structure-paths.d.ts +54 -1
- package/resources/business-structure-paths.d.ts.map +1 -1
- package/resources/business-structure-paths.js +16 -0
- package/resources/business-structure-paths.js.map +1 -1
- package/resources/business-structure-paths.mjs +16 -0
- package/resources/business-structure-paths.mjs.map +1 -1
- package/resources/developer-program-application.d.mts +176 -0
- package/resources/developer-program-application.d.mts.map +1 -0
- package/resources/developer-program-application.d.ts +176 -0
- package/resources/developer-program-application.d.ts.map +1 -0
- package/resources/developer-program-application.js +27 -0
- package/resources/developer-program-application.js.map +1 -0
- package/resources/developer-program-application.mjs +23 -0
- package/resources/developer-program-application.mjs.map +1 -0
- package/resources/developer-users.d.mts +53 -0
- package/resources/developer-users.d.mts.map +1 -0
- package/resources/developer-users.d.ts +53 -0
- package/resources/developer-users.d.ts.map +1 -0
- package/resources/developer-users.js +25 -0
- package/resources/developer-users.js.map +1 -0
- package/resources/developer-users.mjs +21 -0
- package/resources/developer-users.mjs.map +1 -0
- package/resources/earnings-inputs.d.mts +30 -0
- package/resources/earnings-inputs.d.mts.map +1 -1
- package/resources/earnings-inputs.d.ts +30 -0
- package/resources/earnings-inputs.d.ts.map +1 -1
- package/resources/hire-requirements.d.mts +112 -0
- package/resources/hire-requirements.d.mts.map +1 -0
- package/resources/hire-requirements.d.ts +112 -0
- package/resources/hire-requirements.d.ts.map +1 -0
- package/resources/hire-requirements.js +19 -0
- package/resources/hire-requirements.js.map +1 -0
- package/resources/hire-requirements.mjs +15 -0
- package/resources/hire-requirements.mjs.map +1 -0
- package/resources/hires.d.mts +657 -0
- package/resources/hires.d.mts.map +1 -0
- package/resources/hires.d.ts +657 -0
- package/resources/hires.d.ts.map +1 -0
- package/resources/hires.js +25 -0
- package/resources/hires.js.map +1 -0
- package/resources/hires.mjs +21 -0
- package/resources/hires.mjs.map +1 -0
- package/resources/index.d.mts +14 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +14 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +24 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +11 -0
- package/resources/index.mjs.map +1 -1
- package/resources/listing-submissions.d.mts +86 -0
- package/resources/listing-submissions.d.mts.map +1 -0
- package/resources/listing-submissions.d.ts +86 -0
- package/resources/listing-submissions.d.ts.map +1 -0
- package/resources/listing-submissions.js +31 -0
- package/resources/listing-submissions.js.map +1 -0
- package/resources/listing-submissions.mjs +27 -0
- package/resources/listing-submissions.mjs.map +1 -0
- package/resources/listing-transitions.d.mts +59 -0
- package/resources/listing-transitions.d.mts.map +1 -0
- package/resources/listing-transitions.d.ts +59 -0
- package/resources/listing-transitions.d.ts.map +1 -0
- package/resources/listing-transitions.js +24 -0
- package/resources/listing-transitions.js.map +1 -0
- package/resources/listing-transitions.mjs +20 -0
- package/resources/listing-transitions.mjs.map +1 -0
- package/resources/listing.d.mts +1818 -0
- package/resources/listing.d.mts.map +1 -0
- package/resources/listing.d.ts +1818 -0
- package/resources/listing.d.ts.map +1 -0
- package/resources/listing.js +70 -0
- package/resources/listing.js.map +1 -0
- package/resources/listing.mjs +66 -0
- package/resources/listing.mjs.map +1 -0
- package/resources/metadata/components.d.mts +1 -242
- package/resources/metadata/components.d.mts.map +1 -1
- package/resources/metadata/components.d.ts +1 -242
- package/resources/metadata/components.d.ts.map +1 -1
- package/resources/metadata/components.js +0 -51
- package/resources/metadata/components.js.map +1 -1
- package/resources/metadata/components.mjs +0 -51
- package/resources/metadata/components.mjs.map +1 -1
- package/resources/metadata/deployment-runs.d.mts +1 -133
- package/resources/metadata/deployment-runs.d.mts.map +1 -1
- package/resources/metadata/deployment-runs.d.ts +1 -133
- package/resources/metadata/deployment-runs.d.ts.map +1 -1
- package/resources/metadata/deployment-runs.js +0 -60
- package/resources/metadata/deployment-runs.js.map +1 -1
- package/resources/metadata/deployment-runs.mjs +0 -60
- package/resources/metadata/deployment-runs.mjs.map +1 -1
- package/resources/metadata/index.d.mts +3 -5
- package/resources/metadata/index.d.mts.map +1 -1
- package/resources/metadata/index.d.ts +3 -5
- package/resources/metadata/index.d.ts.map +1 -1
- package/resources/metadata/index.js +1 -5
- package/resources/metadata/index.js.map +1 -1
- package/resources/metadata/index.mjs +0 -2
- package/resources/metadata/index.mjs.map +1 -1
- package/resources/metadata/metadata.d.mts +6 -14
- package/resources/metadata/metadata.d.mts.map +1 -1
- package/resources/metadata/metadata.d.ts +6 -14
- package/resources/metadata/metadata.d.ts.map +1 -1
- package/resources/metadata/metadata.js +0 -8
- package/resources/metadata/metadata.js.map +1 -1
- package/resources/metadata/metadata.mjs +0 -8
- package/resources/metadata/metadata.mjs.map +1 -1
- package/resources/metadata/validation-runs.d.mts +1 -133
- package/resources/metadata/validation-runs.d.mts.map +1 -1
- package/resources/metadata/validation-runs.d.ts +1 -133
- package/resources/metadata/validation-runs.d.ts.map +1 -1
- package/resources/metadata/validation-runs.js +0 -60
- package/resources/metadata/validation-runs.js.map +1 -1
- package/resources/metadata/validation-runs.mjs +0 -60
- package/resources/metadata/validation-runs.mjs.map +1 -1
- package/resources/package-sandbox-links.d.mts +150 -0
- package/resources/package-sandbox-links.d.mts.map +1 -0
- package/resources/package-sandbox-links.d.ts +150 -0
- package/resources/package-sandbox-links.d.ts.map +1 -0
- package/resources/package-sandbox-links.js +25 -0
- package/resources/package-sandbox-links.js.map +1 -0
- package/resources/package-sandbox-links.mjs +21 -0
- package/resources/package-sandbox-links.mjs.map +1 -0
- package/resources/package-upgrades.d.mts +140 -0
- package/resources/package-upgrades.d.mts.map +1 -0
- package/resources/package-upgrades.d.ts +140 -0
- package/resources/package-upgrades.d.ts.map +1 -0
- package/resources/package-upgrades.js +25 -0
- package/resources/package-upgrades.js.map +1 -0
- package/resources/package-upgrades.mjs +21 -0
- package/resources/package-upgrades.mjs.map +1 -0
- package/resources/package-versions/index.d.mts +2 -2
- package/resources/package-versions/index.d.mts.map +1 -1
- package/resources/package-versions/index.d.ts +2 -2
- package/resources/package-versions/index.d.ts.map +1 -1
- package/resources/package-versions/index.js +3 -3
- package/resources/package-versions/index.js.map +1 -1
- package/resources/package-versions/index.mjs +1 -1
- package/resources/package-versions/index.mjs.map +1 -1
- package/resources/package-versions/package-versions.d.mts +51 -5
- package/resources/package-versions/package-versions.d.mts.map +1 -1
- package/resources/package-versions/package-versions.d.ts +51 -5
- package/resources/package-versions/package-versions.d.ts.map +1 -1
- package/resources/package-versions/package-versions.js +10 -4
- package/resources/package-versions/package-versions.js.map +1 -1
- package/resources/package-versions/package-versions.mjs +10 -4
- package/resources/package-versions/package-versions.mjs.map +1 -1
- package/resources/package-versions/publish.d.mts +58 -0
- package/resources/package-versions/publish.d.mts.map +1 -0
- package/resources/package-versions/publish.d.ts +58 -0
- package/resources/package-versions/publish.d.ts.map +1 -0
- package/resources/package-versions/publish.js +19 -0
- package/resources/package-versions/publish.js.map +1 -0
- package/resources/package-versions/publish.mjs +15 -0
- package/resources/package-versions/publish.mjs.map +1 -0
- package/resources/packages/available-upgrades.d.mts +33 -0
- package/resources/packages/available-upgrades.d.mts.map +1 -0
- package/resources/packages/available-upgrades.d.ts +33 -0
- package/resources/packages/available-upgrades.d.ts.map +1 -0
- package/resources/packages/available-upgrades.js +20 -0
- package/resources/packages/available-upgrades.js.map +1 -0
- package/resources/packages/available-upgrades.mjs +16 -0
- package/resources/packages/available-upgrades.mjs.map +1 -0
- package/resources/packages/index.d.mts +3 -1
- package/resources/packages/index.d.mts.map +1 -1
- package/resources/packages/index.d.ts +3 -1
- package/resources/packages/index.d.ts.map +1 -1
- package/resources/packages/index.js +5 -1
- package/resources/packages/index.js.map +1 -1
- package/resources/packages/index.mjs +3 -1
- package/resources/packages/index.mjs.map +1 -1
- package/resources/{package-versions → packages}/next-versions.d.mts +3 -3
- package/resources/packages/next-versions.d.mts.map +1 -0
- package/resources/{package-versions → packages}/next-versions.d.ts +3 -3
- package/resources/packages/next-versions.d.ts.map +1 -0
- package/resources/{package-versions → packages}/next-versions.js +4 -4
- package/resources/packages/next-versions.js.map +1 -0
- package/resources/{package-versions → packages}/next-versions.mjs +4 -4
- package/resources/packages/next-versions.mjs.map +1 -0
- package/resources/packages/packages.d.mts +18 -10
- package/resources/packages/packages.d.mts.map +1 -1
- package/resources/packages/packages.d.ts +18 -10
- package/resources/packages/packages.d.ts.map +1 -1
- package/resources/packages/packages.js +19 -11
- package/resources/packages/packages.js.map +1 -1
- package/resources/packages/packages.mjs +20 -12
- package/resources/packages/packages.mjs.map +1 -1
- package/resources/packages/versions.d.mts +57 -2
- package/resources/packages/versions.d.mts.map +1 -1
- package/resources/packages/versions.d.ts +57 -2
- package/resources/packages/versions.d.ts.map +1 -1
- package/resources/packages/versions.js +8 -1
- package/resources/packages/versions.js.map +1 -1
- package/resources/packages/versions.mjs +8 -1
- package/resources/packages/versions.mjs.map +1 -1
- package/resources/sandboxes.d.mts +35 -22
- package/resources/sandboxes.d.mts.map +1 -1
- package/resources/sandboxes.d.ts +35 -22
- package/resources/sandboxes.d.ts.map +1 -1
- package/resources/sandboxes.js +6 -0
- package/resources/sandboxes.js.map +1 -1
- package/resources/sandboxes.mjs +6 -0
- package/resources/sandboxes.mjs.map +1 -1
- package/resources/sites.d.mts +2 -1
- package/resources/sites.d.mts.map +1 -1
- package/resources/sites.d.ts +2 -1
- package/resources/sites.d.ts.map +1 -1
- package/resources/workers.d.mts +41 -0
- package/resources/workers.d.mts.map +1 -1
- package/resources/workers.d.ts +41 -0
- package/resources/workers.d.ts.map +1 -1
- package/resources/workflows.d.mts +768 -0
- package/resources/workflows.d.mts.map +1 -0
- package/resources/workflows.d.ts +768 -0
- package/resources/workflows.d.ts.map +1 -0
- package/resources/workflows.js +48 -0
- package/resources/workflows.js.map +1 -0
- package/resources/workflows.mjs +44 -0
- package/resources/workflows.mjs.map +1 -0
- package/src/client.ts +254 -0
- package/src/resources/agents/sessions/index.ts +1 -0
- package/src/resources/agents/sessions/messages.ts +28 -0
- package/src/resources/agents/sessions/resume-state.ts +32 -0
- package/src/resources/agents/sessions/sessions.ts +107 -0
- package/src/resources/background-check-candidates.ts +434 -0
- package/src/resources/business-structure-paths.ts +78 -0
- package/src/resources/developer-program-application.ts +233 -0
- package/src/resources/developer-users.ts +77 -0
- package/src/resources/earnings-inputs.ts +36 -0
- package/src/resources/hire-requirements.ts +140 -0
- package/src/resources/hires.ts +786 -0
- package/src/resources/index.ts +92 -0
- package/src/resources/listing-submissions.ts +120 -0
- package/src/resources/listing-transitions.ts +84 -0
- package/src/resources/listing.ts +2297 -0
- package/src/resources/metadata/components.ts +0 -281
- package/src/resources/metadata/deployment-runs.ts +0 -170
- package/src/resources/metadata/index.ts +0 -16
- package/src/resources/metadata/metadata.ts +0 -38
- package/src/resources/metadata/validation-runs.ts +0 -170
- package/src/resources/package-sandbox-links.ts +195 -0
- package/src/resources/package-upgrades.ts +183 -0
- package/src/resources/package-versions/index.ts +2 -1
- package/src/resources/package-versions/package-versions.ts +65 -9
- package/src/resources/package-versions/publish.ts +74 -0
- package/src/resources/packages/available-upgrades.ts +51 -0
- package/src/resources/packages/index.ts +14 -1
- package/src/resources/{package-versions → packages}/next-versions.ts +4 -4
- package/src/resources/packages/packages.ts +52 -12
- package/src/resources/packages/versions.ts +83 -1
- package/src/resources/sandboxes.ts +45 -24
- package/src/resources/sites.ts +2 -1
- package/src/resources/workers.ts +46 -0
- package/src/resources/workflows.ts +1434 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/metadata/component-schemas.d.mts +0 -93
- package/resources/metadata/component-schemas.d.mts.map +0 -1
- package/resources/metadata/component-schemas.d.ts +0 -93
- package/resources/metadata/component-schemas.d.ts.map +0 -1
- package/resources/metadata/component-schemas.js +0 -28
- package/resources/metadata/component-schemas.js.map +0 -1
- package/resources/metadata/component-schemas.mjs +0 -24
- package/resources/metadata/component-schemas.mjs.map +0 -1
- package/resources/metadata/component-types.d.mts +0 -47
- package/resources/metadata/component-types.d.mts.map +0 -1
- package/resources/metadata/component-types.d.ts +0 -47
- package/resources/metadata/component-types.d.ts.map +0 -1
- package/resources/metadata/component-types.js +0 -27
- package/resources/metadata/component-types.js.map +0 -1
- package/resources/metadata/component-types.mjs +0 -23
- package/resources/metadata/component-types.mjs.map +0 -1
- package/resources/package-versions/next-versions.d.mts.map +0 -1
- package/resources/package-versions/next-versions.d.ts.map +0 -1
- package/resources/package-versions/next-versions.js.map +0 -1
- package/resources/package-versions/next-versions.mjs.map +0 -1
- package/src/resources/metadata/component-schemas.ts +0 -109
- package/src/resources/metadata/component-types.ts +0 -56
|
@@ -5,53 +5,6 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
5
5
|
* Custom objects defined by the company
|
|
6
6
|
*/
|
|
7
7
|
export declare class Components extends APIResource {
|
|
8
|
-
/**
|
|
9
|
-
* Extract the company's selectable metadata components, optionally filtered by a
|
|
10
|
-
* search query.
|
|
11
|
-
*
|
|
12
|
-
* Requires the Metadata entitlement.
|
|
13
|
-
*
|
|
14
|
-
* @example
|
|
15
|
-
* ```ts
|
|
16
|
-
* const response = await client.metadata.components.extract();
|
|
17
|
-
* ```
|
|
18
|
-
*/
|
|
19
|
-
extract(query?: ComponentExtractParams | null | undefined, options?: RequestOptions): APIPromise<ComponentExtractResponse>;
|
|
20
|
-
/**
|
|
21
|
-
* Validate component schemas and dependencies without installing them. Use the
|
|
22
|
-
* normalized results before deploy.
|
|
23
|
-
*
|
|
24
|
-
* Requires the Metadata entitlement.
|
|
25
|
-
*
|
|
26
|
-
* @example
|
|
27
|
-
* ```ts
|
|
28
|
-
* const response =
|
|
29
|
-
* await client.metadata.components.validateV2({
|
|
30
|
-
* components: [
|
|
31
|
-
* {
|
|
32
|
-
* type: 'CUSTOM_OBJECT',
|
|
33
|
-
* api_name: 'purchase_order__c',
|
|
34
|
-
* name: 'Purchase Order',
|
|
35
|
-
* description: 'Tracks purchase requests',
|
|
36
|
-
* category_api_name: 'procurement__c',
|
|
37
|
-
* },
|
|
38
|
-
* {
|
|
39
|
-
* type: 'CUSTOM_OBJECT_FIELD',
|
|
40
|
-
* custom_object_api_name: 'purchase_order__c',
|
|
41
|
-
* field_api_name: 'amount__c',
|
|
42
|
-
* field_display_name: 'Amount',
|
|
43
|
-
* data_type: {
|
|
44
|
-
* field_type: 'CURRENCY',
|
|
45
|
-
* currency: 'USD',
|
|
46
|
-
* num_of_decimal_places: 2,
|
|
47
|
-
* },
|
|
48
|
-
* is_standard: false,
|
|
49
|
-
* },
|
|
50
|
-
* ],
|
|
51
|
-
* });
|
|
52
|
-
* ```
|
|
53
|
-
*/
|
|
54
|
-
validateV2(body: ComponentValidateV2Params, options?: RequestOptions): APIPromise<ComponentValidateV2Response>;
|
|
55
8
|
/**
|
|
56
9
|
* Validate a complete metadata component package without installing it.
|
|
57
10
|
*
|
|
@@ -120,171 +73,6 @@ export declare class Components extends APIResource {
|
|
|
120
73
|
*/
|
|
121
74
|
deploy(body: ComponentDeployParams, options?: RequestOptions): APIPromise<ComponentDeployResponse>;
|
|
122
75
|
}
|
|
123
|
-
export interface ComponentExtractResponse {
|
|
124
|
-
/**
|
|
125
|
-
* Full component configs needed to recreate the selected roots.
|
|
126
|
-
*/
|
|
127
|
-
component_configs: Array<ComponentExtractResponse.ComponentConfig>;
|
|
128
|
-
/**
|
|
129
|
-
* Serialized dependency graph for the extracted package.
|
|
130
|
-
*/
|
|
131
|
-
dependency_graph: {
|
|
132
|
-
[key: string]: unknown;
|
|
133
|
-
};
|
|
134
|
-
/**
|
|
135
|
-
* Topological install order for the extracted package.
|
|
136
|
-
*/
|
|
137
|
-
install_order: Array<{
|
|
138
|
-
[key: string]: unknown;
|
|
139
|
-
}>;
|
|
140
|
-
/**
|
|
141
|
-
* Components selected as extraction roots.
|
|
142
|
-
*/
|
|
143
|
-
root_components: Array<ComponentExtractResponse.RootComponent>;
|
|
144
|
-
/**
|
|
145
|
-
* For search-backed extraction, whether contextual expansion completed.
|
|
146
|
-
*/
|
|
147
|
-
context_complete?: boolean;
|
|
148
|
-
/**
|
|
149
|
-
* Warnings from search-backed contextual expansion.
|
|
150
|
-
*/
|
|
151
|
-
context_warnings?: Array<string>;
|
|
152
|
-
external_managed_dependencies?: Array<{
|
|
153
|
-
[key: string]: unknown;
|
|
154
|
-
}>;
|
|
155
|
-
[k: string]: unknown;
|
|
156
|
-
}
|
|
157
|
-
export declare namespace ComponentExtractResponse {
|
|
158
|
-
/**
|
|
159
|
-
* A metadata component config. The `type` field selects the concrete component
|
|
160
|
-
* schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
|
|
161
|
-
*/
|
|
162
|
-
interface ComponentConfig {
|
|
163
|
-
/**
|
|
164
|
-
* Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
|
|
165
|
-
*/
|
|
166
|
-
type: string;
|
|
167
|
-
[k: string]: unknown;
|
|
168
|
-
}
|
|
169
|
-
/**
|
|
170
|
-
* Selectable package root returned by metadata extraction.
|
|
171
|
-
*/
|
|
172
|
-
interface RootComponent {
|
|
173
|
-
/**
|
|
174
|
-
* Identifier for the selected component.
|
|
175
|
-
*/
|
|
176
|
-
identifier?: {
|
|
177
|
-
[key: string]: unknown;
|
|
178
|
-
};
|
|
179
|
-
/**
|
|
180
|
-
* Display name for the selectable component.
|
|
181
|
-
*/
|
|
182
|
-
name?: string;
|
|
183
|
-
[k: string]: unknown;
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
export interface ComponentValidateV2Response {
|
|
187
|
-
/**
|
|
188
|
-
* Package-level validation issues.
|
|
189
|
-
*/
|
|
190
|
-
errors: Array<ComponentValidateV2Response.Error>;
|
|
191
|
-
/**
|
|
192
|
-
* Per-component validation results.
|
|
193
|
-
*/
|
|
194
|
-
results: Array<ComponentValidateV2Response.Result>;
|
|
195
|
-
/**
|
|
196
|
-
* True only when every component and dependency check passed.
|
|
197
|
-
*/
|
|
198
|
-
valid: boolean;
|
|
199
|
-
}
|
|
200
|
-
export declare namespace ComponentValidateV2Response {
|
|
201
|
-
/**
|
|
202
|
-
* A validation, dependency, permission, or deployment issue.
|
|
203
|
-
*/
|
|
204
|
-
interface Error {
|
|
205
|
-
/**
|
|
206
|
-
* Stable machine-readable issue code.
|
|
207
|
-
*/
|
|
208
|
-
code: string;
|
|
209
|
-
/**
|
|
210
|
-
* Human-readable remediation message.
|
|
211
|
-
*/
|
|
212
|
-
message: string;
|
|
213
|
-
/**
|
|
214
|
-
* Lower-level cause associated with the issue, when available.
|
|
215
|
-
*/
|
|
216
|
-
cause?: string | null;
|
|
217
|
-
/**
|
|
218
|
-
* Component type associated with the issue, when available.
|
|
219
|
-
*/
|
|
220
|
-
component_type?: string | null;
|
|
221
|
-
[k: string]: unknown;
|
|
222
|
-
}
|
|
223
|
-
interface Result {
|
|
224
|
-
/**
|
|
225
|
-
* Metadata component type.
|
|
226
|
-
*/
|
|
227
|
-
type: string;
|
|
228
|
-
/**
|
|
229
|
-
* Whether this component passed validation.
|
|
230
|
-
*/
|
|
231
|
-
valid: boolean;
|
|
232
|
-
errors?: Array<Result.Error>;
|
|
233
|
-
/**
|
|
234
|
-
* Existing component config matched by the identifier, when available.
|
|
235
|
-
*/
|
|
236
|
-
existing?: {
|
|
237
|
-
[key: string]: unknown;
|
|
238
|
-
};
|
|
239
|
-
/**
|
|
240
|
-
* Resolved component identifier.
|
|
241
|
-
*/
|
|
242
|
-
identifier?: {
|
|
243
|
-
[key: string]: unknown;
|
|
244
|
-
};
|
|
245
|
-
/**
|
|
246
|
-
* Merged target state for updates, when available.
|
|
247
|
-
*/
|
|
248
|
-
merged?: {
|
|
249
|
-
[key: string]: unknown;
|
|
250
|
-
};
|
|
251
|
-
/**
|
|
252
|
-
* Schema-normalized component config.
|
|
253
|
-
*/
|
|
254
|
-
normalized?: {
|
|
255
|
-
[key: string]: unknown;
|
|
256
|
-
};
|
|
257
|
-
/**
|
|
258
|
-
* Upsert classification computed during validation.
|
|
259
|
-
*/
|
|
260
|
-
outcome?: 'CREATE' | 'NO_OP' | 'UPDATE' | 'UNSUPPORTED_UPDATE' | null;
|
|
261
|
-
[k: string]: unknown;
|
|
262
|
-
}
|
|
263
|
-
namespace Result {
|
|
264
|
-
/**
|
|
265
|
-
* A validation, dependency, permission, or deployment issue.
|
|
266
|
-
*/
|
|
267
|
-
interface Error {
|
|
268
|
-
/**
|
|
269
|
-
* Stable machine-readable issue code.
|
|
270
|
-
*/
|
|
271
|
-
code: string;
|
|
272
|
-
/**
|
|
273
|
-
* Human-readable remediation message.
|
|
274
|
-
*/
|
|
275
|
-
message: string;
|
|
276
|
-
/**
|
|
277
|
-
* Lower-level cause associated with the issue, when available.
|
|
278
|
-
*/
|
|
279
|
-
cause?: string | null;
|
|
280
|
-
/**
|
|
281
|
-
* Component type associated with the issue, when available.
|
|
282
|
-
*/
|
|
283
|
-
component_type?: string | null;
|
|
284
|
-
[k: string]: unknown;
|
|
285
|
-
}
|
|
286
|
-
}
|
|
287
|
-
}
|
|
288
76
|
export interface ComponentValidateResponse {
|
|
289
77
|
/**
|
|
290
78
|
* Package-level validation issues.
|
|
@@ -471,35 +259,6 @@ export declare namespace ComponentDeployResponse {
|
|
|
471
259
|
[k: string]: unknown;
|
|
472
260
|
}
|
|
473
261
|
}
|
|
474
|
-
export interface ComponentExtractParams {
|
|
475
|
-
/**
|
|
476
|
-
* Maximum search results to return when q is provided.
|
|
477
|
-
*/
|
|
478
|
-
limit?: number;
|
|
479
|
-
/**
|
|
480
|
-
* Optional text search over selectable components.
|
|
481
|
-
*/
|
|
482
|
-
q?: string;
|
|
483
|
-
}
|
|
484
|
-
export interface ComponentValidateV2Params {
|
|
485
|
-
/**
|
|
486
|
-
* Complete package of metadata components, including dependencies.
|
|
487
|
-
*/
|
|
488
|
-
components: Array<ComponentValidateV2Params.Component>;
|
|
489
|
-
}
|
|
490
|
-
export declare namespace ComponentValidateV2Params {
|
|
491
|
-
/**
|
|
492
|
-
* A metadata component config. The `type` field selects the concrete component
|
|
493
|
-
* schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
|
|
494
|
-
*/
|
|
495
|
-
interface Component {
|
|
496
|
-
/**
|
|
497
|
-
* Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
|
|
498
|
-
*/
|
|
499
|
-
type: string;
|
|
500
|
-
[k: string]: unknown;
|
|
501
|
-
}
|
|
502
|
-
}
|
|
503
262
|
export interface ComponentValidateParams {
|
|
504
263
|
/**
|
|
505
264
|
* Complete package of metadata components, including dependencies.
|
|
@@ -539,6 +298,6 @@ export declare namespace ComponentDeployParams {
|
|
|
539
298
|
}
|
|
540
299
|
}
|
|
541
300
|
export declare namespace Components {
|
|
542
|
-
export { type
|
|
301
|
+
export { type ComponentValidateResponse as ComponentValidateResponse, type ComponentDeployResponse as ComponentDeployResponse, type ComponentValidateParams as ComponentValidateParams, type ComponentDeployParams as ComponentDeployParams, };
|
|
543
302
|
}
|
|
544
303
|
//# sourceMappingURL=components.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/components.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/components.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGnG;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAE/C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAEjD;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE7B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,oBAAoB,GAAG,IAAI,CAAC;QAEtE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;IAE3D;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,uBAAuB,CAAC,KAAK,CAAC;CACvC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;WAEG;QACH,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvC;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,wBAAwB,GAAG,SAAS,GAAG,oBAAoB,CAAC;QAE3F;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,iBAAiB,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAEzD;;WAEG;QACH,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEpC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,gBAAgB;YAC/B;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;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,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -7,57 +7,6 @@ const resource_1 = require("../../core/resource.js");
|
|
|
7
7
|
* Custom objects defined by the company
|
|
8
8
|
*/
|
|
9
9
|
class Components extends resource_1.APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* Extract the company's selectable metadata components, optionally filtered by a
|
|
12
|
-
* search query.
|
|
13
|
-
*
|
|
14
|
-
* Requires the Metadata entitlement.
|
|
15
|
-
*
|
|
16
|
-
* @example
|
|
17
|
-
* ```ts
|
|
18
|
-
* const response = await client.metadata.components.extract();
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
21
|
-
extract(query = {}, options) {
|
|
22
|
-
return this._client.get('/metadata/v2/extract/', { query, ...options });
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Validate component schemas and dependencies without installing them. Use the
|
|
26
|
-
* normalized results before deploy.
|
|
27
|
-
*
|
|
28
|
-
* Requires the Metadata entitlement.
|
|
29
|
-
*
|
|
30
|
-
* @example
|
|
31
|
-
* ```ts
|
|
32
|
-
* const response =
|
|
33
|
-
* await client.metadata.components.validateV2({
|
|
34
|
-
* components: [
|
|
35
|
-
* {
|
|
36
|
-
* type: 'CUSTOM_OBJECT',
|
|
37
|
-
* api_name: 'purchase_order__c',
|
|
38
|
-
* name: 'Purchase Order',
|
|
39
|
-
* description: 'Tracks purchase requests',
|
|
40
|
-
* category_api_name: 'procurement__c',
|
|
41
|
-
* },
|
|
42
|
-
* {
|
|
43
|
-
* type: 'CUSTOM_OBJECT_FIELD',
|
|
44
|
-
* custom_object_api_name: 'purchase_order__c',
|
|
45
|
-
* field_api_name: 'amount__c',
|
|
46
|
-
* field_display_name: 'Amount',
|
|
47
|
-
* data_type: {
|
|
48
|
-
* field_type: 'CURRENCY',
|
|
49
|
-
* currency: 'USD',
|
|
50
|
-
* num_of_decimal_places: 2,
|
|
51
|
-
* },
|
|
52
|
-
* is_standard: false,
|
|
53
|
-
* },
|
|
54
|
-
* ],
|
|
55
|
-
* });
|
|
56
|
-
* ```
|
|
57
|
-
*/
|
|
58
|
-
validateV2(body, options) {
|
|
59
|
-
return this._client.post('/metadata/v2/validate/', { body, ...options });
|
|
60
|
-
}
|
|
61
10
|
/**
|
|
62
11
|
* Validate a complete metadata component package without installing it.
|
|
63
12
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/resources/metadata/components.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC
|
|
1
|
+
{"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/resources/metadata/components.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;AAzED,gCAyEC"}
|
|
@@ -4,57 +4,6 @@ import { APIResource } from "../../core/resource.mjs";
|
|
|
4
4
|
* Custom objects defined by the company
|
|
5
5
|
*/
|
|
6
6
|
export class Components extends APIResource {
|
|
7
|
-
/**
|
|
8
|
-
* Extract the company's selectable metadata components, optionally filtered by a
|
|
9
|
-
* search query.
|
|
10
|
-
*
|
|
11
|
-
* Requires the Metadata entitlement.
|
|
12
|
-
*
|
|
13
|
-
* @example
|
|
14
|
-
* ```ts
|
|
15
|
-
* const response = await client.metadata.components.extract();
|
|
16
|
-
* ```
|
|
17
|
-
*/
|
|
18
|
-
extract(query = {}, options) {
|
|
19
|
-
return this._client.get('/metadata/v2/extract/', { query, ...options });
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Validate component schemas and dependencies without installing them. Use the
|
|
23
|
-
* normalized results before deploy.
|
|
24
|
-
*
|
|
25
|
-
* Requires the Metadata entitlement.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* ```ts
|
|
29
|
-
* const response =
|
|
30
|
-
* await client.metadata.components.validateV2({
|
|
31
|
-
* components: [
|
|
32
|
-
* {
|
|
33
|
-
* type: 'CUSTOM_OBJECT',
|
|
34
|
-
* api_name: 'purchase_order__c',
|
|
35
|
-
* name: 'Purchase Order',
|
|
36
|
-
* description: 'Tracks purchase requests',
|
|
37
|
-
* category_api_name: 'procurement__c',
|
|
38
|
-
* },
|
|
39
|
-
* {
|
|
40
|
-
* type: 'CUSTOM_OBJECT_FIELD',
|
|
41
|
-
* custom_object_api_name: 'purchase_order__c',
|
|
42
|
-
* field_api_name: 'amount__c',
|
|
43
|
-
* field_display_name: 'Amount',
|
|
44
|
-
* data_type: {
|
|
45
|
-
* field_type: 'CURRENCY',
|
|
46
|
-
* currency: 'USD',
|
|
47
|
-
* num_of_decimal_places: 2,
|
|
48
|
-
* },
|
|
49
|
-
* is_standard: false,
|
|
50
|
-
* },
|
|
51
|
-
* ],
|
|
52
|
-
* });
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
validateV2(body, options) {
|
|
56
|
-
return this._client.post('/metadata/v2/validate/', { body, ...options });
|
|
57
|
-
}
|
|
58
7
|
/**
|
|
59
8
|
* Validate a complete metadata component package without installing it.
|
|
60
9
|
*
|
|
@@ -1 +1 @@
|
|
|
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
|
|
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
|
|
@@ -5,54 +5,6 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
5
5
|
* Custom objects defined by the company
|
|
6
6
|
*/
|
|
7
7
|
export declare class DeploymentRuns extends APIResource {
|
|
8
|
-
/**
|
|
9
|
-
* Queue deployment for a metadata component package and return a run id for
|
|
10
|
-
* polling.
|
|
11
|
-
*
|
|
12
|
-
* Requires the Metadata entitlement.
|
|
13
|
-
*
|
|
14
|
-
* @example
|
|
15
|
-
* ```ts
|
|
16
|
-
* const response =
|
|
17
|
-
* await client.metadata.deploymentRuns.createV2({
|
|
18
|
-
* components: [
|
|
19
|
-
* {
|
|
20
|
-
* type: 'CUSTOM_OBJECT',
|
|
21
|
-
* api_name: 'purchase_order__c',
|
|
22
|
-
* name: 'Purchase Order',
|
|
23
|
-
* description: 'Tracks purchase requests',
|
|
24
|
-
* category_api_name: 'procurement__c',
|
|
25
|
-
* },
|
|
26
|
-
* {
|
|
27
|
-
* type: 'CUSTOM_OBJECT_FIELD',
|
|
28
|
-
* custom_object_api_name: 'purchase_order__c',
|
|
29
|
-
* field_api_name: 'amount__c',
|
|
30
|
-
* field_display_name: 'Amount',
|
|
31
|
-
* data_type: {
|
|
32
|
-
* field_type: 'CURRENCY',
|
|
33
|
-
* currency: 'USD',
|
|
34
|
-
* num_of_decimal_places: 2,
|
|
35
|
-
* },
|
|
36
|
-
* is_standard: false,
|
|
37
|
-
* },
|
|
38
|
-
* ],
|
|
39
|
-
* });
|
|
40
|
-
* ```
|
|
41
|
-
*/
|
|
42
|
-
createV2(params: DeploymentRunCreateV2Params, options?: RequestOptions): APIPromise<DeploymentRunCreateV2Response>;
|
|
43
|
-
/**
|
|
44
|
-
* Poll a metadata deployment run until the terminal field is true.
|
|
45
|
-
*
|
|
46
|
-
* Requires the Metadata entitlement.
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```ts
|
|
50
|
-
* const response = await client.metadata.deploymentRuns.getV2(
|
|
51
|
-
* 'run_id',
|
|
52
|
-
* );
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
getV2(runID: string, options?: RequestOptions): APIPromise<DeploymentRunGetV2Response>;
|
|
56
8
|
/**
|
|
57
9
|
* Queue deployment for a metadata component package and return a run id for
|
|
58
10
|
* polling.
|
|
@@ -101,66 +53,6 @@ export declare class DeploymentRuns extends APIResource {
|
|
|
101
53
|
*/
|
|
102
54
|
get(runID: string, options?: RequestOptions): APIPromise<DeploymentRunGetResponse>;
|
|
103
55
|
}
|
|
104
|
-
export interface DeploymentRunCreateV2Response {
|
|
105
|
-
/**
|
|
106
|
-
* Metadata run id.
|
|
107
|
-
*/
|
|
108
|
-
id: string;
|
|
109
|
-
progress: {
|
|
110
|
-
[key: string]: unknown;
|
|
111
|
-
};
|
|
112
|
-
/**
|
|
113
|
-
* Suggested client polling delay in milliseconds.
|
|
114
|
-
*/
|
|
115
|
-
retry_after_ms: number;
|
|
116
|
-
status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
|
|
117
|
-
/**
|
|
118
|
-
* Whether the run has reached a terminal status.
|
|
119
|
-
*/
|
|
120
|
-
terminal: boolean;
|
|
121
|
-
type: 'validation' | 'deployment';
|
|
122
|
-
created_at?: string | null;
|
|
123
|
-
error?: {
|
|
124
|
-
[key: string]: unknown;
|
|
125
|
-
} | null;
|
|
126
|
-
expires_at?: string | null;
|
|
127
|
-
finished_at?: string | null;
|
|
128
|
-
result?: {
|
|
129
|
-
[key: string]: unknown;
|
|
130
|
-
} | null;
|
|
131
|
-
started_at?: string | null;
|
|
132
|
-
updated_at?: string | null;
|
|
133
|
-
}
|
|
134
|
-
export interface DeploymentRunGetV2Response {
|
|
135
|
-
/**
|
|
136
|
-
* Metadata run id.
|
|
137
|
-
*/
|
|
138
|
-
id: string;
|
|
139
|
-
progress: {
|
|
140
|
-
[key: string]: unknown;
|
|
141
|
-
};
|
|
142
|
-
/**
|
|
143
|
-
* Suggested client polling delay in milliseconds.
|
|
144
|
-
*/
|
|
145
|
-
retry_after_ms: number;
|
|
146
|
-
status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
|
|
147
|
-
/**
|
|
148
|
-
* Whether the run has reached a terminal status.
|
|
149
|
-
*/
|
|
150
|
-
terminal: boolean;
|
|
151
|
-
type: 'validation' | 'deployment';
|
|
152
|
-
created_at?: string | null;
|
|
153
|
-
error?: {
|
|
154
|
-
[key: string]: unknown;
|
|
155
|
-
} | null;
|
|
156
|
-
expires_at?: string | null;
|
|
157
|
-
finished_at?: string | null;
|
|
158
|
-
result?: {
|
|
159
|
-
[key: string]: unknown;
|
|
160
|
-
} | null;
|
|
161
|
-
started_at?: string | null;
|
|
162
|
-
updated_at?: string | null;
|
|
163
|
-
}
|
|
164
56
|
export interface DeploymentRunCreateResponse {
|
|
165
57
|
/**
|
|
166
58
|
* Metadata run id.
|
|
@@ -221,30 +113,6 @@ export interface DeploymentRunGetResponse {
|
|
|
221
113
|
started_at?: string | null;
|
|
222
114
|
updated_at?: string | null;
|
|
223
115
|
}
|
|
224
|
-
export interface DeploymentRunCreateV2Params {
|
|
225
|
-
/**
|
|
226
|
-
* Body param: Complete package of metadata components, including dependencies.
|
|
227
|
-
*/
|
|
228
|
-
components: Array<DeploymentRunCreateV2Params.Component>;
|
|
229
|
-
/**
|
|
230
|
-
* Header param: Optional idempotency key used to deduplicate retried create
|
|
231
|
-
* requests.
|
|
232
|
-
*/
|
|
233
|
-
'Idempotency-Key'?: string;
|
|
234
|
-
}
|
|
235
|
-
export declare namespace DeploymentRunCreateV2Params {
|
|
236
|
-
/**
|
|
237
|
-
* A metadata component config. The `type` field selects the concrete component
|
|
238
|
-
* schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
|
|
239
|
-
*/
|
|
240
|
-
interface Component {
|
|
241
|
-
/**
|
|
242
|
-
* Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
|
|
243
|
-
*/
|
|
244
|
-
type: string;
|
|
245
|
-
[k: string]: unknown;
|
|
246
|
-
}
|
|
247
|
-
}
|
|
248
116
|
export interface DeploymentRunCreateParams {
|
|
249
117
|
/**
|
|
250
118
|
* Body param: Complete package of metadata components, including dependencies.
|
|
@@ -270,6 +138,6 @@ export declare namespace DeploymentRunCreateParams {
|
|
|
270
138
|
}
|
|
271
139
|
}
|
|
272
140
|
export declare namespace DeploymentRuns {
|
|
273
|
-
export { type
|
|
141
|
+
export { type DeploymentRunCreateResponse as DeploymentRunCreateResponse, type DeploymentRunGetResponse as DeploymentRunGetResponse, type DeploymentRunCreateParams as DeploymentRunCreateParams, };
|
|
274
142
|
}
|
|
275
143
|
//# sourceMappingURL=deployment-runs.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,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,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,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,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|