@epilot/sdk 2.3.9 → 2.4.0
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/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/configuration-hub.cjs +8 -8
- package/dist/apis/configuration-hub.d.cts +2 -2
- package/dist/apis/configuration-hub.d.ts +2 -2
- package/dist/apis/configuration-hub.js +2 -2
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +8 -8
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +2 -2
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.d.cts +2 -2
- package/dist/apis/workflow-definition.d.ts +2 -2
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.d.cts +2 -2
- package/dist/apis/workflow.d.ts +2 -2
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-OMNMMMRJ.js → chunk-DAFBUTK6.js} +6 -6
- package/dist/chunk-M6Z6ES3I.js +14 -0
- package/dist/chunk-ONOGGR6Q.js +14 -0
- package/dist/chunk-UBQCDPW6.cjs +14 -0
- package/dist/{chunk-L37V2R32.cjs → chunk-Z33PZNHV.cjs} +6 -6
- package/dist/{chunk-VFCH5IEL.cjs → chunk-ZSONBZIF.cjs} +1 -1
- package/dist/configuration-hub-A3S6ND6R.cjs +7 -0
- package/dist/configuration-hub-PMAW44U5.js +7 -0
- package/dist/{configuration-hub-runtime-TY2X2ECO.cjs → configuration-hub-runtime-I5Y67CXD.cjs} +2 -2
- package/dist/{configuration-hub-runtime-5R6Y4KF7.js → configuration-hub-runtime-L6IOERSP.js} +1 -1
- package/dist/{configuration-hub.d-DZE3wTQE.d.cts → configuration-hub.d-Cqaq2F-W.d.cts} +111 -8
- package/dist/{configuration-hub.d-DZE3wTQE.d.ts → configuration-hub.d-Cqaq2F-W.d.ts} +111 -8
- package/dist/entity-VDUN7SYC.cjs +7 -0
- package/dist/entity-WWM2Z7BU.js +7 -0
- package/dist/entity-runtime-3J5EDLXP.cjs +5 -0
- package/dist/{entity-runtime-D4DV5XRM.js → entity-runtime-LNAZILIN.js} +1 -1
- package/dist/{entity.d-ByufVI16.d.cts → entity.d-B43ezu-V.d.cts} +1336 -9
- package/dist/{entity.d-ByufVI16.d.ts → entity.d-B43ezu-V.d.ts} +1336 -9
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +3 -3
- package/dist/workflow-3WBD74WR.js +7 -0
- package/dist/workflow-WIUZ5TOX.cjs +7 -0
- package/dist/workflow-definition-2VF7S23G.js +7 -0
- package/dist/workflow-definition-U6YXD42W.cjs +7 -0
- package/dist/{workflow-definition.d-ByCJK9_x.d.ts → workflow-definition.d-DOeb0KVV.d.cts} +37 -1
- package/dist/{workflow-definition.d-ByCJK9_x.d.cts → workflow-definition.d-DOeb0KVV.d.ts} +37 -1
- package/dist/{workflow.d-pD8ISOg-.d.ts → workflow.d-CMSKt8oN.d.cts} +22 -1
- package/dist/{workflow.d-pD8ISOg-.d.cts → workflow.d-CMSKt8oN.d.ts} +22 -1
- package/docs/configuration-hub.md +112 -15
- package/docs/entity.md +965 -39
- package/docs/workflow-definition.md +40 -8
- package/docs/workflow.md +57 -11
- package/package.json +1 -1
- package/dist/chunk-AOFZDDXN.js +0 -14
- package/dist/chunk-F7W62NKV.js +0 -14
- package/dist/chunk-QA2OYK7N.cjs +0 -14
- package/dist/configuration-hub-2F636SNK.js +0 -7
- package/dist/configuration-hub-XQGJK2JA.cjs +0 -7
- package/dist/entity-CK76MXVN.js +0 -7
- package/dist/entity-TFMH5VTZ.cjs +0 -7
- package/dist/entity-runtime-DUJTRYLQ.cjs +0 -5
- package/dist/workflow-CQOBZ25C.cjs +0 -7
- package/dist/workflow-G7VFCXY7.js +0 -7
- package/dist/workflow-definition-CVBYKAUY.cjs +0 -7
- package/dist/workflow-definition-GNAKDNG7.js +0 -7
|
@@ -58,7 +58,7 @@ declare namespace Components {
|
|
|
58
58
|
* Cursor for fetching the next page. Absent when no more pages.
|
|
59
59
|
*/
|
|
60
60
|
next_cursor?: string;
|
|
61
|
-
|
|
61
|
+
results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
64
|
* Summary metadata for a single configuration item in the tree
|
|
@@ -90,6 +90,10 @@ declare namespace Components {
|
|
|
90
90
|
* Tags / labels
|
|
91
91
|
*/
|
|
92
92
|
tags?: string[];
|
|
93
|
+
/**
|
|
94
|
+
* Alternative identifiers (short IDs, slugs, variable keys) used in cross-references
|
|
95
|
+
*/
|
|
96
|
+
aliases?: string[];
|
|
93
97
|
/**
|
|
94
98
|
* Business purposes
|
|
95
99
|
*/
|
|
@@ -98,6 +102,12 @@ declare namespace Components {
|
|
|
98
102
|
* Direct link to open this config in epilot
|
|
99
103
|
*/
|
|
100
104
|
link?: string; // uri
|
|
105
|
+
/**
|
|
106
|
+
* Type-specific metadata (e.g., submission count for journeys)
|
|
107
|
+
*/
|
|
108
|
+
metadata?: {
|
|
109
|
+
[name: string]: any;
|
|
110
|
+
};
|
|
101
111
|
}
|
|
102
112
|
/**
|
|
103
113
|
* Static metadata for a config type folder in the tree.
|
|
@@ -150,12 +160,21 @@ declare namespace Components {
|
|
|
150
160
|
build_duration_ms?: number;
|
|
151
161
|
failed_types?: string[];
|
|
152
162
|
}
|
|
163
|
+
/**
|
|
164
|
+
* Current index build state
|
|
165
|
+
*/
|
|
166
|
+
export interface IndexStatusResponse {
|
|
167
|
+
status: "missing" | "building" | "ready" | "failed";
|
|
168
|
+
last_built_at?: string; // date-time
|
|
169
|
+
total_items?: number;
|
|
170
|
+
build_duration_ms?: number;
|
|
171
|
+
}
|
|
153
172
|
/**
|
|
154
173
|
* Configuration resource type identifier.
|
|
155
174
|
* Matches blueprint-manifest-api V3 naming conventions.
|
|
156
175
|
*
|
|
157
176
|
*/
|
|
158
|
-
export type ResourceType = "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "webhook" | "saved_view" | "dashboard" | "kanban" | "role" | "usergroup" | "validation_rule" | "integration" | "app" | "designbuilder" | "notification_template" | "custom_variable" | "environment_variable" | "taxonomy" | "taxonomy_classification" | "entity_mapping" | "portal_config" | "target" | "product_recommendation";
|
|
177
|
+
export type ResourceType = "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "document_template" | "webhook" | "saved_view" | "dashboard" | "kanban" | "role" | "usergroup" | "validation_rule" | "integration" | "app" | "designbuilder" | "notification_template" | "custom_variable" | "environment_variable" | "taxonomy" | "taxonomy_classification" | "entity_mapping" | "portal_config" | "target" | "product_recommendation" | "access_token";
|
|
159
178
|
}
|
|
160
179
|
}
|
|
161
180
|
declare namespace Paths {
|
|
@@ -184,6 +203,29 @@ declare namespace Paths {
|
|
|
184
203
|
export type $404 = Components.Schemas.ErrorResponse;
|
|
185
204
|
}
|
|
186
205
|
}
|
|
206
|
+
namespace GetConfigUsedBy {
|
|
207
|
+
namespace Parameters {
|
|
208
|
+
export type Id = string;
|
|
209
|
+
export type Type = /**
|
|
210
|
+
* Configuration resource type identifier.
|
|
211
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
212
|
+
*
|
|
213
|
+
*/
|
|
214
|
+
Components.Schemas.ResourceType;
|
|
215
|
+
}
|
|
216
|
+
export interface PathParameters {
|
|
217
|
+
type: Parameters.Type;
|
|
218
|
+
id: Parameters.Id;
|
|
219
|
+
}
|
|
220
|
+
namespace Responses {
|
|
221
|
+
export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
namespace GetIndex {
|
|
225
|
+
namespace Responses {
|
|
226
|
+
export type $200 = /* Current index build state */ Components.Schemas.IndexStatusResponse;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
187
229
|
namespace ListConfigTypes {
|
|
188
230
|
namespace Responses {
|
|
189
231
|
export interface $200 {
|
|
@@ -198,10 +240,13 @@ declare namespace Paths {
|
|
|
198
240
|
}
|
|
199
241
|
namespace ListConfigs {
|
|
200
242
|
namespace Parameters {
|
|
243
|
+
export type ActiveOnly = boolean;
|
|
244
|
+
export type BlueprintIds = string;
|
|
201
245
|
export type Cursor = string;
|
|
202
246
|
export type Purposes = string;
|
|
203
247
|
export type Q = string;
|
|
204
248
|
export type Size = number;
|
|
249
|
+
export type Sort = "updated_at" | "usage";
|
|
205
250
|
export type Type = /**
|
|
206
251
|
* Configuration resource type identifier.
|
|
207
252
|
* Matches blueprint-manifest-api V3 naming conventions.
|
|
@@ -221,6 +266,9 @@ declare namespace Paths {
|
|
|
221
266
|
updated_after?: Parameters.UpdatedAfter /* date-time */;
|
|
222
267
|
updated_before?: Parameters.UpdatedBefore /* date-time */;
|
|
223
268
|
purposes?: Parameters.Purposes;
|
|
269
|
+
blueprint_ids?: Parameters.BlueprintIds;
|
|
270
|
+
sort?: Parameters.Sort;
|
|
271
|
+
active_only?: Parameters.ActiveOnly;
|
|
224
272
|
}
|
|
225
273
|
namespace Responses {
|
|
226
274
|
export type $200 = /* Cursor-paginated list of configs for a specific type */ Components.Schemas.ConfigListResponse;
|
|
@@ -279,12 +327,37 @@ interface OperationMethods {
|
|
|
279
327
|
data?: any,
|
|
280
328
|
config?: AxiosRequestConfig
|
|
281
329
|
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
330
|
+
/**
|
|
331
|
+
* getConfigUsedBy - getConfigUsedBy
|
|
332
|
+
*
|
|
333
|
+
* Get configs that reference the given config (reverse dependencies).
|
|
334
|
+
* Scans the indexed config items for references to this config's ID or aliases.
|
|
335
|
+
*
|
|
336
|
+
*/
|
|
337
|
+
'getConfigUsedBy'(
|
|
338
|
+
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
339
|
+
data?: any,
|
|
340
|
+
config?: AxiosRequestConfig
|
|
341
|
+
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
342
|
+
/**
|
|
343
|
+
* getIndex - getIndex
|
|
344
|
+
*
|
|
345
|
+
* Return the current index build state for the caller's organization.
|
|
346
|
+
* Clients poll this to decide whether to show a "building" indicator
|
|
347
|
+
* and when to refetch data.
|
|
348
|
+
*
|
|
349
|
+
*/
|
|
350
|
+
'getIndex'(
|
|
351
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
352
|
+
data?: any,
|
|
353
|
+
config?: AxiosRequestConfig
|
|
354
|
+
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
282
355
|
/**
|
|
283
356
|
* rebuildIndex - rebuildIndex
|
|
284
357
|
*
|
|
285
358
|
* Rebuild the configuration index for the caller's organization.
|
|
286
|
-
*
|
|
287
|
-
*
|
|
359
|
+
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
360
|
+
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
288
361
|
*
|
|
289
362
|
*/
|
|
290
363
|
'rebuildIndex'(
|
|
@@ -344,13 +417,42 @@ interface PathsDictionary {
|
|
|
344
417
|
config?: AxiosRequestConfig
|
|
345
418
|
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
346
419
|
}
|
|
347
|
-
['/v1/
|
|
420
|
+
['/v1/configs/{type}/{id}/used_by']: {
|
|
421
|
+
/**
|
|
422
|
+
* getConfigUsedBy - getConfigUsedBy
|
|
423
|
+
*
|
|
424
|
+
* Get configs that reference the given config (reverse dependencies).
|
|
425
|
+
* Scans the indexed config items for references to this config's ID or aliases.
|
|
426
|
+
*
|
|
427
|
+
*/
|
|
428
|
+
'get'(
|
|
429
|
+
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
430
|
+
data?: any,
|
|
431
|
+
config?: AxiosRequestConfig
|
|
432
|
+
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
433
|
+
}
|
|
434
|
+
['/v1/configs/index']: {
|
|
435
|
+
/**
|
|
436
|
+
* getIndex - getIndex
|
|
437
|
+
*
|
|
438
|
+
* Return the current index build state for the caller's organization.
|
|
439
|
+
* Clients poll this to decide whether to show a "building" indicator
|
|
440
|
+
* and when to refetch data.
|
|
441
|
+
*
|
|
442
|
+
*/
|
|
443
|
+
'get'(
|
|
444
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
445
|
+
data?: any,
|
|
446
|
+
config?: AxiosRequestConfig
|
|
447
|
+
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
448
|
+
}
|
|
449
|
+
['/v1/configs/index:rebuild']: {
|
|
348
450
|
/**
|
|
349
451
|
* rebuildIndex - rebuildIndex
|
|
350
452
|
*
|
|
351
453
|
* Rebuild the configuration index for the caller's organization.
|
|
352
|
-
*
|
|
353
|
-
*
|
|
454
|
+
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
455
|
+
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
354
456
|
*
|
|
355
457
|
*/
|
|
356
458
|
'post'(
|
|
@@ -370,6 +472,7 @@ type ConfigNode = Components.Schemas.ConfigNode;
|
|
|
370
472
|
type ConfigTypeInfo = Components.Schemas.ConfigTypeInfo;
|
|
371
473
|
type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
372
474
|
type IndexRebuildResponse = Components.Schemas.IndexRebuildResponse;
|
|
475
|
+
type IndexStatusResponse = Components.Schemas.IndexStatusResponse;
|
|
373
476
|
type ResourceType = Components.Schemas.ResourceType;
|
|
374
477
|
|
|
375
|
-
export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, Components as a, type PathsDictionary as b, type ConfigDependenciesResponse as c, type ConfigListResponse as d, type ConfigNode as e, type ConfigTypeInfo as f };
|
|
478
|
+
export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, Components as a, type PathsDictionary as b, type ConfigDependenciesResponse as c, type ConfigListResponse as d, type ConfigNode as e, type ConfigTypeInfo as f, type IndexStatusResponse as g };
|
|
@@ -58,7 +58,7 @@ declare namespace Components {
|
|
|
58
58
|
* Cursor for fetching the next page. Absent when no more pages.
|
|
59
59
|
*/
|
|
60
60
|
next_cursor?: string;
|
|
61
|
-
|
|
61
|
+
results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
64
|
* Summary metadata for a single configuration item in the tree
|
|
@@ -90,6 +90,10 @@ declare namespace Components {
|
|
|
90
90
|
* Tags / labels
|
|
91
91
|
*/
|
|
92
92
|
tags?: string[];
|
|
93
|
+
/**
|
|
94
|
+
* Alternative identifiers (short IDs, slugs, variable keys) used in cross-references
|
|
95
|
+
*/
|
|
96
|
+
aliases?: string[];
|
|
93
97
|
/**
|
|
94
98
|
* Business purposes
|
|
95
99
|
*/
|
|
@@ -98,6 +102,12 @@ declare namespace Components {
|
|
|
98
102
|
* Direct link to open this config in epilot
|
|
99
103
|
*/
|
|
100
104
|
link?: string; // uri
|
|
105
|
+
/**
|
|
106
|
+
* Type-specific metadata (e.g., submission count for journeys)
|
|
107
|
+
*/
|
|
108
|
+
metadata?: {
|
|
109
|
+
[name: string]: any;
|
|
110
|
+
};
|
|
101
111
|
}
|
|
102
112
|
/**
|
|
103
113
|
* Static metadata for a config type folder in the tree.
|
|
@@ -150,12 +160,21 @@ declare namespace Components {
|
|
|
150
160
|
build_duration_ms?: number;
|
|
151
161
|
failed_types?: string[];
|
|
152
162
|
}
|
|
163
|
+
/**
|
|
164
|
+
* Current index build state
|
|
165
|
+
*/
|
|
166
|
+
export interface IndexStatusResponse {
|
|
167
|
+
status: "missing" | "building" | "ready" | "failed";
|
|
168
|
+
last_built_at?: string; // date-time
|
|
169
|
+
total_items?: number;
|
|
170
|
+
build_duration_ms?: number;
|
|
171
|
+
}
|
|
153
172
|
/**
|
|
154
173
|
* Configuration resource type identifier.
|
|
155
174
|
* Matches blueprint-manifest-api V3 naming conventions.
|
|
156
175
|
*
|
|
157
176
|
*/
|
|
158
|
-
export type ResourceType = "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "webhook" | "saved_view" | "dashboard" | "kanban" | "role" | "usergroup" | "validation_rule" | "integration" | "app" | "designbuilder" | "notification_template" | "custom_variable" | "environment_variable" | "taxonomy" | "taxonomy_classification" | "entity_mapping" | "portal_config" | "target" | "product_recommendation";
|
|
177
|
+
export type ResourceType = "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "document_template" | "webhook" | "saved_view" | "dashboard" | "kanban" | "role" | "usergroup" | "validation_rule" | "integration" | "app" | "designbuilder" | "notification_template" | "custom_variable" | "environment_variable" | "taxonomy" | "taxonomy_classification" | "entity_mapping" | "portal_config" | "target" | "product_recommendation" | "access_token";
|
|
159
178
|
}
|
|
160
179
|
}
|
|
161
180
|
declare namespace Paths {
|
|
@@ -184,6 +203,29 @@ declare namespace Paths {
|
|
|
184
203
|
export type $404 = Components.Schemas.ErrorResponse;
|
|
185
204
|
}
|
|
186
205
|
}
|
|
206
|
+
namespace GetConfigUsedBy {
|
|
207
|
+
namespace Parameters {
|
|
208
|
+
export type Id = string;
|
|
209
|
+
export type Type = /**
|
|
210
|
+
* Configuration resource type identifier.
|
|
211
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
212
|
+
*
|
|
213
|
+
*/
|
|
214
|
+
Components.Schemas.ResourceType;
|
|
215
|
+
}
|
|
216
|
+
export interface PathParameters {
|
|
217
|
+
type: Parameters.Type;
|
|
218
|
+
id: Parameters.Id;
|
|
219
|
+
}
|
|
220
|
+
namespace Responses {
|
|
221
|
+
export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
namespace GetIndex {
|
|
225
|
+
namespace Responses {
|
|
226
|
+
export type $200 = /* Current index build state */ Components.Schemas.IndexStatusResponse;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
187
229
|
namespace ListConfigTypes {
|
|
188
230
|
namespace Responses {
|
|
189
231
|
export interface $200 {
|
|
@@ -198,10 +240,13 @@ declare namespace Paths {
|
|
|
198
240
|
}
|
|
199
241
|
namespace ListConfigs {
|
|
200
242
|
namespace Parameters {
|
|
243
|
+
export type ActiveOnly = boolean;
|
|
244
|
+
export type BlueprintIds = string;
|
|
201
245
|
export type Cursor = string;
|
|
202
246
|
export type Purposes = string;
|
|
203
247
|
export type Q = string;
|
|
204
248
|
export type Size = number;
|
|
249
|
+
export type Sort = "updated_at" | "usage";
|
|
205
250
|
export type Type = /**
|
|
206
251
|
* Configuration resource type identifier.
|
|
207
252
|
* Matches blueprint-manifest-api V3 naming conventions.
|
|
@@ -221,6 +266,9 @@ declare namespace Paths {
|
|
|
221
266
|
updated_after?: Parameters.UpdatedAfter /* date-time */;
|
|
222
267
|
updated_before?: Parameters.UpdatedBefore /* date-time */;
|
|
223
268
|
purposes?: Parameters.Purposes;
|
|
269
|
+
blueprint_ids?: Parameters.BlueprintIds;
|
|
270
|
+
sort?: Parameters.Sort;
|
|
271
|
+
active_only?: Parameters.ActiveOnly;
|
|
224
272
|
}
|
|
225
273
|
namespace Responses {
|
|
226
274
|
export type $200 = /* Cursor-paginated list of configs for a specific type */ Components.Schemas.ConfigListResponse;
|
|
@@ -279,12 +327,37 @@ interface OperationMethods {
|
|
|
279
327
|
data?: any,
|
|
280
328
|
config?: AxiosRequestConfig
|
|
281
329
|
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
330
|
+
/**
|
|
331
|
+
* getConfigUsedBy - getConfigUsedBy
|
|
332
|
+
*
|
|
333
|
+
* Get configs that reference the given config (reverse dependencies).
|
|
334
|
+
* Scans the indexed config items for references to this config's ID or aliases.
|
|
335
|
+
*
|
|
336
|
+
*/
|
|
337
|
+
'getConfigUsedBy'(
|
|
338
|
+
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
339
|
+
data?: any,
|
|
340
|
+
config?: AxiosRequestConfig
|
|
341
|
+
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
342
|
+
/**
|
|
343
|
+
* getIndex - getIndex
|
|
344
|
+
*
|
|
345
|
+
* Return the current index build state for the caller's organization.
|
|
346
|
+
* Clients poll this to decide whether to show a "building" indicator
|
|
347
|
+
* and when to refetch data.
|
|
348
|
+
*
|
|
349
|
+
*/
|
|
350
|
+
'getIndex'(
|
|
351
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
352
|
+
data?: any,
|
|
353
|
+
config?: AxiosRequestConfig
|
|
354
|
+
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
282
355
|
/**
|
|
283
356
|
* rebuildIndex - rebuildIndex
|
|
284
357
|
*
|
|
285
358
|
* Rebuild the configuration index for the caller's organization.
|
|
286
|
-
*
|
|
287
|
-
*
|
|
359
|
+
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
360
|
+
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
288
361
|
*
|
|
289
362
|
*/
|
|
290
363
|
'rebuildIndex'(
|
|
@@ -344,13 +417,42 @@ interface PathsDictionary {
|
|
|
344
417
|
config?: AxiosRequestConfig
|
|
345
418
|
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
346
419
|
}
|
|
347
|
-
['/v1/
|
|
420
|
+
['/v1/configs/{type}/{id}/used_by']: {
|
|
421
|
+
/**
|
|
422
|
+
* getConfigUsedBy - getConfigUsedBy
|
|
423
|
+
*
|
|
424
|
+
* Get configs that reference the given config (reverse dependencies).
|
|
425
|
+
* Scans the indexed config items for references to this config's ID or aliases.
|
|
426
|
+
*
|
|
427
|
+
*/
|
|
428
|
+
'get'(
|
|
429
|
+
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
430
|
+
data?: any,
|
|
431
|
+
config?: AxiosRequestConfig
|
|
432
|
+
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
433
|
+
}
|
|
434
|
+
['/v1/configs/index']: {
|
|
435
|
+
/**
|
|
436
|
+
* getIndex - getIndex
|
|
437
|
+
*
|
|
438
|
+
* Return the current index build state for the caller's organization.
|
|
439
|
+
* Clients poll this to decide whether to show a "building" indicator
|
|
440
|
+
* and when to refetch data.
|
|
441
|
+
*
|
|
442
|
+
*/
|
|
443
|
+
'get'(
|
|
444
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
445
|
+
data?: any,
|
|
446
|
+
config?: AxiosRequestConfig
|
|
447
|
+
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
448
|
+
}
|
|
449
|
+
['/v1/configs/index:rebuild']: {
|
|
348
450
|
/**
|
|
349
451
|
* rebuildIndex - rebuildIndex
|
|
350
452
|
*
|
|
351
453
|
* Rebuild the configuration index for the caller's organization.
|
|
352
|
-
*
|
|
353
|
-
*
|
|
454
|
+
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
455
|
+
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
354
456
|
*
|
|
355
457
|
*/
|
|
356
458
|
'post'(
|
|
@@ -370,6 +472,7 @@ type ConfigNode = Components.Schemas.ConfigNode;
|
|
|
370
472
|
type ConfigTypeInfo = Components.Schemas.ConfigTypeInfo;
|
|
371
473
|
type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
372
474
|
type IndexRebuildResponse = Components.Schemas.IndexRebuildResponse;
|
|
475
|
+
type IndexStatusResponse = Components.Schemas.IndexStatusResponse;
|
|
373
476
|
type ResourceType = Components.Schemas.ResourceType;
|
|
374
477
|
|
|
375
|
-
export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, Components as a, type PathsDictionary as b, type ConfigDependenciesResponse as c, type ConfigListResponse as d, type ConfigNode as e, type ConfigTypeInfo as f };
|
|
478
|
+
export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, Components as a, type PathsDictionary as b, type ConfigDependenciesResponse as c, type ConfigListResponse as d, type ConfigNode as e, type ConfigTypeInfo as f, type IndexStatusResponse as g };
|