@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,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 ValidationRuns extends APIResource {
|
|
8
|
-
/**
|
|
9
|
-
* Queue validation 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.validationRuns.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: ValidationRunCreateV2Params, options?: RequestOptions): APIPromise<ValidationRunCreateV2Response>;
|
|
43
|
-
/**
|
|
44
|
-
* Poll a metadata validation run until the terminal field is true.
|
|
45
|
-
*
|
|
46
|
-
* Requires the Metadata entitlement.
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```ts
|
|
50
|
-
* const response = await client.metadata.validationRuns.getV2(
|
|
51
|
-
* 'run_id',
|
|
52
|
-
* );
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
getV2(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetV2Response>;
|
|
56
8
|
/**
|
|
57
9
|
* Queue validation for a metadata component package and return a run id for
|
|
58
10
|
* polling.
|
|
@@ -101,66 +53,6 @@ export declare class ValidationRuns extends APIResource {
|
|
|
101
53
|
*/
|
|
102
54
|
get(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetResponse>;
|
|
103
55
|
}
|
|
104
|
-
export interface ValidationRunCreateV2Response {
|
|
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 ValidationRunGetV2Response {
|
|
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 ValidationRunCreateResponse {
|
|
165
57
|
/**
|
|
166
58
|
* Metadata run id.
|
|
@@ -221,30 +113,6 @@ export interface ValidationRunGetResponse {
|
|
|
221
113
|
started_at?: string | null;
|
|
222
114
|
updated_at?: string | null;
|
|
223
115
|
}
|
|
224
|
-
export interface ValidationRunCreateV2Params {
|
|
225
|
-
/**
|
|
226
|
-
* Body param: Complete package of metadata components, including dependencies.
|
|
227
|
-
*/
|
|
228
|
-
components: Array<ValidationRunCreateV2Params.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 ValidationRunCreateV2Params {
|
|
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 ValidationRunCreateParams {
|
|
249
117
|
/**
|
|
250
118
|
* Body param: Complete package of metadata components, including dependencies.
|
|
@@ -270,6 +138,6 @@ export declare namespace ValidationRunCreateParams {
|
|
|
270
138
|
}
|
|
271
139
|
}
|
|
272
140
|
export declare namespace ValidationRuns {
|
|
273
|
-
export { type
|
|
141
|
+
export { type ValidationRunCreateResponse as ValidationRunCreateResponse, type ValidationRunGetResponse as ValidationRunGetResponse, type ValidationRunCreateParams as ValidationRunCreateParams, };
|
|
274
142
|
}
|
|
275
143
|
//# sourceMappingURL=validation-runs.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validation-runs.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/validation-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":"validation-runs.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/validation-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"}
|
|
@@ -5,54 +5,6 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
5
5
|
* Custom objects defined by the company
|
|
6
6
|
*/
|
|
7
7
|
export declare class ValidationRuns extends APIResource {
|
|
8
|
-
/**
|
|
9
|
-
* Queue validation 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.validationRuns.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: ValidationRunCreateV2Params, options?: RequestOptions): APIPromise<ValidationRunCreateV2Response>;
|
|
43
|
-
/**
|
|
44
|
-
* Poll a metadata validation run until the terminal field is true.
|
|
45
|
-
*
|
|
46
|
-
* Requires the Metadata entitlement.
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```ts
|
|
50
|
-
* const response = await client.metadata.validationRuns.getV2(
|
|
51
|
-
* 'run_id',
|
|
52
|
-
* );
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
getV2(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetV2Response>;
|
|
56
8
|
/**
|
|
57
9
|
* Queue validation for a metadata component package and return a run id for
|
|
58
10
|
* polling.
|
|
@@ -101,66 +53,6 @@ export declare class ValidationRuns extends APIResource {
|
|
|
101
53
|
*/
|
|
102
54
|
get(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetResponse>;
|
|
103
55
|
}
|
|
104
|
-
export interface ValidationRunCreateV2Response {
|
|
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 ValidationRunGetV2Response {
|
|
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 ValidationRunCreateResponse {
|
|
165
57
|
/**
|
|
166
58
|
* Metadata run id.
|
|
@@ -221,30 +113,6 @@ export interface ValidationRunGetResponse {
|
|
|
221
113
|
started_at?: string | null;
|
|
222
114
|
updated_at?: string | null;
|
|
223
115
|
}
|
|
224
|
-
export interface ValidationRunCreateV2Params {
|
|
225
|
-
/**
|
|
226
|
-
* Body param: Complete package of metadata components, including dependencies.
|
|
227
|
-
*/
|
|
228
|
-
components: Array<ValidationRunCreateV2Params.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 ValidationRunCreateV2Params {
|
|
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 ValidationRunCreateParams {
|
|
249
117
|
/**
|
|
250
118
|
* Body param: Complete package of metadata components, including dependencies.
|
|
@@ -270,6 +138,6 @@ export declare namespace ValidationRunCreateParams {
|
|
|
270
138
|
}
|
|
271
139
|
}
|
|
272
140
|
export declare namespace ValidationRuns {
|
|
273
|
-
export { type
|
|
141
|
+
export { type ValidationRunCreateResponse as ValidationRunCreateResponse, type ValidationRunGetResponse as ValidationRunGetResponse, type ValidationRunCreateParams as ValidationRunCreateParams, };
|
|
274
142
|
}
|
|
275
143
|
//# sourceMappingURL=validation-runs.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validation-runs.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/validation-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,
|
|
1
|
+
{"version":3,"file":"validation-runs.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/validation-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,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"}
|
|
@@ -9,66 +9,6 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
9
9
|
* Custom objects defined by the company
|
|
10
10
|
*/
|
|
11
11
|
class ValidationRuns extends resource_1.APIResource {
|
|
12
|
-
/**
|
|
13
|
-
* Queue validation for a metadata component package and return a run id for
|
|
14
|
-
* polling.
|
|
15
|
-
*
|
|
16
|
-
* Requires the Metadata entitlement.
|
|
17
|
-
*
|
|
18
|
-
* @example
|
|
19
|
-
* ```ts
|
|
20
|
-
* const response =
|
|
21
|
-
* await client.metadata.validationRuns.createV2({
|
|
22
|
-
* components: [
|
|
23
|
-
* {
|
|
24
|
-
* type: 'CUSTOM_OBJECT',
|
|
25
|
-
* api_name: 'purchase_order__c',
|
|
26
|
-
* name: 'Purchase Order',
|
|
27
|
-
* description: 'Tracks purchase requests',
|
|
28
|
-
* category_api_name: 'procurement__c',
|
|
29
|
-
* },
|
|
30
|
-
* {
|
|
31
|
-
* type: 'CUSTOM_OBJECT_FIELD',
|
|
32
|
-
* custom_object_api_name: 'purchase_order__c',
|
|
33
|
-
* field_api_name: 'amount__c',
|
|
34
|
-
* field_display_name: 'Amount',
|
|
35
|
-
* data_type: {
|
|
36
|
-
* field_type: 'CURRENCY',
|
|
37
|
-
* currency: 'USD',
|
|
38
|
-
* num_of_decimal_places: 2,
|
|
39
|
-
* },
|
|
40
|
-
* is_standard: false,
|
|
41
|
-
* },
|
|
42
|
-
* ],
|
|
43
|
-
* });
|
|
44
|
-
* ```
|
|
45
|
-
*/
|
|
46
|
-
createV2(params, options) {
|
|
47
|
-
const { 'Idempotency-Key': idempotencyKey, ...body } = params;
|
|
48
|
-
return this._client.post('/metadata/v2/validation-runs/', {
|
|
49
|
-
body,
|
|
50
|
-
...options,
|
|
51
|
-
headers: (0, headers_1.buildHeaders)([
|
|
52
|
-
{ ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
|
|
53
|
-
options?.headers,
|
|
54
|
-
]),
|
|
55
|
-
});
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* Poll a metadata validation run until the terminal field is true.
|
|
59
|
-
*
|
|
60
|
-
* Requires the Metadata entitlement.
|
|
61
|
-
*
|
|
62
|
-
* @example
|
|
63
|
-
* ```ts
|
|
64
|
-
* const response = await client.metadata.validationRuns.getV2(
|
|
65
|
-
* 'run_id',
|
|
66
|
-
* );
|
|
67
|
-
* ```
|
|
68
|
-
*/
|
|
69
|
-
getV2(runID, options) {
|
|
70
|
-
return this._client.get((0, path_1.path) `/metadata/v2/validation-runs/${runID}/`, options);
|
|
71
|
-
}
|
|
72
12
|
/**
|
|
73
13
|
* Queue validation for a metadata component package and return a run id for
|
|
74
14
|
* polling.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validation-runs.js","sourceRoot":"","sources":["../../src/resources/metadata/validation-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,
|
|
1
|
+
{"version":3,"file":"validation-runs.js","sourceRoot":"","sources":["../../src/resources/metadata/validation-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;AAhED,wCAgEC"}
|
|
@@ -6,66 +6,6 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
6
6
|
* Custom objects defined by the company
|
|
7
7
|
*/
|
|
8
8
|
export class ValidationRuns extends APIResource {
|
|
9
|
-
/**
|
|
10
|
-
* Queue validation for a metadata component package and return a run id for
|
|
11
|
-
* polling.
|
|
12
|
-
*
|
|
13
|
-
* Requires the Metadata entitlement.
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```ts
|
|
17
|
-
* const response =
|
|
18
|
-
* await client.metadata.validationRuns.createV2({
|
|
19
|
-
* components: [
|
|
20
|
-
* {
|
|
21
|
-
* type: 'CUSTOM_OBJECT',
|
|
22
|
-
* api_name: 'purchase_order__c',
|
|
23
|
-
* name: 'Purchase Order',
|
|
24
|
-
* description: 'Tracks purchase requests',
|
|
25
|
-
* category_api_name: 'procurement__c',
|
|
26
|
-
* },
|
|
27
|
-
* {
|
|
28
|
-
* type: 'CUSTOM_OBJECT_FIELD',
|
|
29
|
-
* custom_object_api_name: 'purchase_order__c',
|
|
30
|
-
* field_api_name: 'amount__c',
|
|
31
|
-
* field_display_name: 'Amount',
|
|
32
|
-
* data_type: {
|
|
33
|
-
* field_type: 'CURRENCY',
|
|
34
|
-
* currency: 'USD',
|
|
35
|
-
* num_of_decimal_places: 2,
|
|
36
|
-
* },
|
|
37
|
-
* is_standard: false,
|
|
38
|
-
* },
|
|
39
|
-
* ],
|
|
40
|
-
* });
|
|
41
|
-
* ```
|
|
42
|
-
*/
|
|
43
|
-
createV2(params, options) {
|
|
44
|
-
const { 'Idempotency-Key': idempotencyKey, ...body } = params;
|
|
45
|
-
return this._client.post('/metadata/v2/validation-runs/', {
|
|
46
|
-
body,
|
|
47
|
-
...options,
|
|
48
|
-
headers: buildHeaders([
|
|
49
|
-
{ ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
|
|
50
|
-
options?.headers,
|
|
51
|
-
]),
|
|
52
|
-
});
|
|
53
|
-
}
|
|
54
|
-
/**
|
|
55
|
-
* Poll a metadata validation run until the terminal field is true.
|
|
56
|
-
*
|
|
57
|
-
* Requires the Metadata entitlement.
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* ```ts
|
|
61
|
-
* const response = await client.metadata.validationRuns.getV2(
|
|
62
|
-
* 'run_id',
|
|
63
|
-
* );
|
|
64
|
-
* ```
|
|
65
|
-
*/
|
|
66
|
-
getV2(runID, options) {
|
|
67
|
-
return this._client.get(path `/metadata/v2/validation-runs/${runID}/`, options);
|
|
68
|
-
}
|
|
69
9
|
/**
|
|
70
10
|
* Queue validation for a metadata component package and return a run id for
|
|
71
11
|
* polling.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validation-runs.mjs","sourceRoot":"","sources":["../../src/resources/metadata/validation-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,
|
|
1
|
+
{"version":3,"file":"validation-runs.mjs","sourceRoot":"","sources":["../../src/resources/metadata/validation-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,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"}
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Author, publish, and install Unity Packages V2 packages
|
|
6
|
+
*/
|
|
7
|
+
export declare class PackageSandboxLinks extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Link a package to a sandbox in EDIT or INSTALL mode.
|
|
10
|
+
*/
|
|
11
|
+
create(body: PackageSandboxLinkCreateParams, options?: RequestOptions): APIPromise<PackageSandboxLinkCreateResponse>;
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve the status of a package sandbox link.
|
|
14
|
+
*/
|
|
15
|
+
retrieve(trackerID: string, options?: RequestOptions): APIPromise<PackageSandboxLinkRetrieveResponse>;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Request to link a package to a sandbox, or poll an EDIT-mode installation
|
|
19
|
+
* tracker.
|
|
20
|
+
*/
|
|
21
|
+
export interface PackageSandboxLinkCreateResponse {
|
|
22
|
+
/**
|
|
23
|
+
* Identifier field
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
* Record creation date
|
|
28
|
+
*/
|
|
29
|
+
created_at: string;
|
|
30
|
+
/**
|
|
31
|
+
* How the sandbox is linked to the package (INSTALL or EDIT)
|
|
32
|
+
*/
|
|
33
|
+
mode: string;
|
|
34
|
+
/**
|
|
35
|
+
* The package key to link into the sandbox
|
|
36
|
+
*/
|
|
37
|
+
package_key: string;
|
|
38
|
+
/**
|
|
39
|
+
* The company receiving the sandbox package installation
|
|
40
|
+
*/
|
|
41
|
+
sandbox_company_id: string;
|
|
42
|
+
/**
|
|
43
|
+
* Record update date
|
|
44
|
+
*/
|
|
45
|
+
updated_at: string;
|
|
46
|
+
/**
|
|
47
|
+
* Error message when EDIT-mode linking failed
|
|
48
|
+
*/
|
|
49
|
+
error_message?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Installation record ID when EDIT-mode linking completes
|
|
52
|
+
*/
|
|
53
|
+
installation_record_id?: string;
|
|
54
|
+
/**
|
|
55
|
+
* The internal sandbox installation tracker ID
|
|
56
|
+
*/
|
|
57
|
+
installation_tracker_id?: string;
|
|
58
|
+
/**
|
|
59
|
+
* The package version being linked in EDIT mode
|
|
60
|
+
*/
|
|
61
|
+
package_version_id?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Component to open after EDIT-mode linking completes
|
|
64
|
+
*/
|
|
65
|
+
post_install_landing_component?: unknown;
|
|
66
|
+
/**
|
|
67
|
+
* EDIT-mode installation progress entries
|
|
68
|
+
*/
|
|
69
|
+
progress?: Array<unknown>;
|
|
70
|
+
/**
|
|
71
|
+
* INSTALL completion status, or EDIT installation tracker status
|
|
72
|
+
*/
|
|
73
|
+
status?: string;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Request to link a package to a sandbox, or poll an EDIT-mode installation
|
|
77
|
+
* tracker.
|
|
78
|
+
*/
|
|
79
|
+
export interface PackageSandboxLinkRetrieveResponse {
|
|
80
|
+
/**
|
|
81
|
+
* Identifier field
|
|
82
|
+
*/
|
|
83
|
+
id: string;
|
|
84
|
+
/**
|
|
85
|
+
* Record creation date
|
|
86
|
+
*/
|
|
87
|
+
created_at: string;
|
|
88
|
+
/**
|
|
89
|
+
* How the sandbox is linked to the package (INSTALL or EDIT)
|
|
90
|
+
*/
|
|
91
|
+
mode: string;
|
|
92
|
+
/**
|
|
93
|
+
* The package key to link into the sandbox
|
|
94
|
+
*/
|
|
95
|
+
package_key: string;
|
|
96
|
+
/**
|
|
97
|
+
* The company receiving the sandbox package installation
|
|
98
|
+
*/
|
|
99
|
+
sandbox_company_id: string;
|
|
100
|
+
/**
|
|
101
|
+
* Record update date
|
|
102
|
+
*/
|
|
103
|
+
updated_at: string;
|
|
104
|
+
/**
|
|
105
|
+
* Error message when EDIT-mode linking failed
|
|
106
|
+
*/
|
|
107
|
+
error_message?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Installation record ID when EDIT-mode linking completes
|
|
110
|
+
*/
|
|
111
|
+
installation_record_id?: string;
|
|
112
|
+
/**
|
|
113
|
+
* The internal sandbox installation tracker ID
|
|
114
|
+
*/
|
|
115
|
+
installation_tracker_id?: string;
|
|
116
|
+
/**
|
|
117
|
+
* The package version being linked in EDIT mode
|
|
118
|
+
*/
|
|
119
|
+
package_version_id?: string;
|
|
120
|
+
/**
|
|
121
|
+
* Component to open after EDIT-mode linking completes
|
|
122
|
+
*/
|
|
123
|
+
post_install_landing_component?: unknown;
|
|
124
|
+
/**
|
|
125
|
+
* EDIT-mode installation progress entries
|
|
126
|
+
*/
|
|
127
|
+
progress?: Array<unknown>;
|
|
128
|
+
/**
|
|
129
|
+
* INSTALL completion status, or EDIT installation tracker status
|
|
130
|
+
*/
|
|
131
|
+
status?: string;
|
|
132
|
+
}
|
|
133
|
+
export interface PackageSandboxLinkCreateParams {
|
|
134
|
+
/**
|
|
135
|
+
* How the sandbox is linked to the package (INSTALL or EDIT)
|
|
136
|
+
*/
|
|
137
|
+
mode: string;
|
|
138
|
+
/**
|
|
139
|
+
* The package key to link into the sandbox
|
|
140
|
+
*/
|
|
141
|
+
package_key: string;
|
|
142
|
+
/**
|
|
143
|
+
* The company receiving the sandbox package installation
|
|
144
|
+
*/
|
|
145
|
+
sandbox_company_id: string;
|
|
146
|
+
}
|
|
147
|
+
export declare namespace PackageSandboxLinks {
|
|
148
|
+
export { type PackageSandboxLinkCreateResponse as PackageSandboxLinkCreateResponse, type PackageSandboxLinkRetrieveResponse as PackageSandboxLinkRetrieveResponse, type PackageSandboxLinkCreateParams as PackageSandboxLinkCreateParams, };
|
|
149
|
+
}
|
|
150
|
+
//# sourceMappingURL=package-sandbox-links.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"package-sandbox-links.d.mts","sourceRoot":"","sources":["../src/resources/package-sandbox-links.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;CAGtG;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
|