@epilot/sdk 2.7.1 → 2.8.0-rc.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/README.md +1 -0
- package/definitions/app.json +101 -8
- package/definitions/configuration-hub-runtime.json +1 -1
- package/definitions/configuration-hub.json +623 -0
- package/definitions/customer-portal.json +72 -58
- package/definitions/design-runtime.json +1 -1
- package/definitions/design.json +1 -11
- package/definitions/focus-pocus-runtime.json +1 -0
- package/definitions/focus-pocus.json +757 -0
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +21 -1
- package/dist/README-37TXN4EL.cjs +7 -0
- package/dist/README-Z2WITBOR.js +7 -0
- package/dist/{_index-DB2VV4PQ.cjs → _index-HTUXYSTD.cjs} +4 -1
- package/dist/{_index-5FB6F5YY.js → _index-YTOJUFGD.js} +3 -0
- 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.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- 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/calendar.cjs +6 -6
- package/dist/apis/calendar.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.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- 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 +8 -8
- package/dist/apis/design.js +2 -2
- 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 +6 -6
- package/dist/apis/entity.js +1 -1
- 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/focus-pocus.cjs +38 -0
- package/dist/apis/focus-pocus.d.cts +18 -0
- package/dist/apis/focus-pocus.d.ts +18 -0
- package/dist/apis/focus-pocus.js +38 -0
- 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 +8 -8
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +2 -2
- 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.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
- package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
- package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
- package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
- package/dist/bin/cli.js +1 -1
- package/dist/{chunk-SCMAZ73K.js → chunk-54KWFSCM.js} +30 -19
- package/dist/chunk-A6FYGWQ7.cjs +14 -0
- package/dist/{chunk-R7XDTILZ.cjs → chunk-F5Z6I7TF.cjs} +30 -19
- package/dist/chunk-JOUTFBLN.js +14 -0
- package/dist/chunk-LAWKCWVU.cjs +14 -0
- package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
- package/dist/chunk-P42Q6HOW.js +14 -0
- package/dist/chunk-P4NA7NWG.js +14 -0
- package/dist/chunk-WHXYES2D.cjs +14 -0
- package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
- package/dist/configuration-hub-E7S4JB2T.js +7 -0
- package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
- package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
- package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
- package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
- package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
- package/dist/customer-portal-DR6XFCTQ.js +7 -0
- package/dist/customer-portal-PNFBVIAH.cjs +7 -0
- package/dist/{customer-portal.d-C7ZCbjiY.d.cts → customer-portal.d-CTTCBAZI.d.cts} +217 -61
- package/dist/{customer-portal.d-C7ZCbjiY.d.ts → customer-portal.d-CTTCBAZI.d.ts} +217 -61
- package/dist/data-governance-QYFHBCNB.cjs +7 -0
- package/dist/data-governance-YS2NA6W4.js +7 -0
- package/dist/design-EWZQZ5KX.js +7 -0
- package/dist/design-MUUYXB2J.cjs +7 -0
- package/dist/design-runtime-3RHYNHUV.cjs +5 -0
- package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
- package/dist/focus-pocus-JGXH42OF.cjs +7 -0
- package/dist/focus-pocus-XVDVUYL6.js +7 -0
- package/dist/focus-pocus-runtime-QXBBYVX7.js +5 -0
- package/dist/focus-pocus-runtime-X6GQ3WI4.cjs +5 -0
- package/dist/focus-pocus.d-BRFGe53G.d.cts +489 -0
- package/dist/focus-pocus.d-BRFGe53G.d.ts +489 -0
- package/dist/index.cjs +29 -21
- package/dist/index.d.cts +55 -53
- package/dist/index.d.ts +55 -53
- package/dist/index.js +20 -12
- package/dist/journey-4DIIPRU4.js +7 -0
- package/dist/journey-ATC3Y5AW.cjs +7 -0
- package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
- package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
- package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
- package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/pricing-R5ENSVPQ.cjs +7 -0
- package/dist/pricing-X27CCRI6.js +7 -0
- package/dist/targeting-74BV7F7H.cjs +7 -0
- package/dist/targeting-W5EKJYR2.js +7 -0
- package/docs/app.md +34 -10
- package/docs/configuration-hub.md +660 -0
- package/docs/customer-portal.md +223 -161
- package/docs/data-governance.md +17 -17
- package/docs/design.md +1 -1
- package/docs/focus-pocus.md +460 -0
- package/docs/journey.md +2 -0
- package/docs/pricing.md +1 -1
- package/docs/targeting.md +4 -4
- package/package.json +10 -1
- package/dist/README-46VYEGGW.js +0 -7
- package/dist/README-IVBISSWB.cjs +0 -7
- package/dist/chunk-EIIIKDOJ.cjs +0 -14
- package/dist/chunk-KIWRGUKM.js +0 -14
- package/dist/chunk-MB6NKETA.cjs +0 -14
- package/dist/chunk-VSZEOCIE.js +0 -14
- package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
- package/dist/configuration-hub-PMAW44U5.js +0 -7
- package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
- package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
- package/dist/customer-portal-7HYSBH7H.cjs +0 -7
- package/dist/customer-portal-X4LJX6AU.js +0 -7
- package/dist/data-governance-2U5UU4GM.cjs +0 -7
- package/dist/data-governance-36Y33JVG.js +0 -7
- package/dist/design-DROLIWS3.js +0 -7
- package/dist/design-XZKOZLTR.cjs +0 -7
- package/dist/design-runtime-OXEXKZVG.cjs +0 -5
- package/dist/journey-KDR5EU3W.js +0 -7
- package/dist/journey-REBN4TGQ.cjs +0 -7
- package/dist/pricing-FODHQFCB.cjs +0 -7
- package/dist/pricing-XRIDVZFC.js +0 -7
- package/dist/targeting-EYGYZD6M.cjs +0 -7
- package/dist/targeting-GEJTJN5Z.js +0 -7
|
@@ -0,0 +1,1096 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from configuration-hub-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Parameters {
|
|
8
|
+
export type ConfigId = string;
|
|
9
|
+
export type ConfigType = /**
|
|
10
|
+
* Configuration resource type identifier.
|
|
11
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
Schemas.ResourceType;
|
|
15
|
+
export type CursorParam = string;
|
|
16
|
+
export type SizeParam = number;
|
|
17
|
+
export type SyncJobId = string;
|
|
18
|
+
}
|
|
19
|
+
export interface PathParameters {
|
|
20
|
+
ConfigType?: Parameters.ConfigType;
|
|
21
|
+
ConfigId?: Parameters.ConfigId;
|
|
22
|
+
SyncJobId?: Parameters.SyncJobId;
|
|
23
|
+
}
|
|
24
|
+
export interface QueryParameters {
|
|
25
|
+
CursorParam?: Parameters.CursorParam;
|
|
26
|
+
SizeParam?: Parameters.SizeParam;
|
|
27
|
+
}
|
|
28
|
+
namespace Schemas {
|
|
29
|
+
/**
|
|
30
|
+
* Cursor-paginated list of configs referenced by a given config
|
|
31
|
+
*/
|
|
32
|
+
export interface ConfigDependenciesResponse {
|
|
33
|
+
/**
|
|
34
|
+
* Total number of dependencies found (if known)
|
|
35
|
+
*/
|
|
36
|
+
total?: number;
|
|
37
|
+
/**
|
|
38
|
+
* Cursor for fetching the next page. Absent when no more pages.
|
|
39
|
+
*/
|
|
40
|
+
next_cursor?: string;
|
|
41
|
+
results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Cursor-paginated list of configs for a specific type
|
|
45
|
+
*/
|
|
46
|
+
export interface ConfigListResponse {
|
|
47
|
+
type: /**
|
|
48
|
+
* Configuration resource type identifier.
|
|
49
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
50
|
+
*
|
|
51
|
+
*/
|
|
52
|
+
ResourceType;
|
|
53
|
+
label: string;
|
|
54
|
+
icon: string;
|
|
55
|
+
/**
|
|
56
|
+
* Total number of configs of this type (if known)
|
|
57
|
+
*/
|
|
58
|
+
total?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Cursor for fetching the next page. Absent when no more pages.
|
|
61
|
+
*/
|
|
62
|
+
next_cursor?: string;
|
|
63
|
+
results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Summary metadata for a single configuration item in the tree
|
|
67
|
+
*/
|
|
68
|
+
export interface ConfigNode {
|
|
69
|
+
type: /**
|
|
70
|
+
* Configuration resource type identifier.
|
|
71
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
72
|
+
*
|
|
73
|
+
*/
|
|
74
|
+
ResourceType;
|
|
75
|
+
/**
|
|
76
|
+
* Unique identifier
|
|
77
|
+
*/
|
|
78
|
+
id: string;
|
|
79
|
+
/**
|
|
80
|
+
* Display name
|
|
81
|
+
*/
|
|
82
|
+
title: string;
|
|
83
|
+
/**
|
|
84
|
+
* Last modified timestamp
|
|
85
|
+
*/
|
|
86
|
+
updated_at?: string; // date-time
|
|
87
|
+
/**
|
|
88
|
+
* User who last modified this config
|
|
89
|
+
*/
|
|
90
|
+
updated_by?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Tags / labels
|
|
93
|
+
*/
|
|
94
|
+
tags?: string[];
|
|
95
|
+
/**
|
|
96
|
+
* Alternative identifiers (short IDs, slugs, variable keys) used in cross-references
|
|
97
|
+
*/
|
|
98
|
+
aliases?: string[];
|
|
99
|
+
/**
|
|
100
|
+
* Business purposes
|
|
101
|
+
*/
|
|
102
|
+
purposes?: string[];
|
|
103
|
+
/**
|
|
104
|
+
* Direct link to open this config in epilot
|
|
105
|
+
*/
|
|
106
|
+
link?: string; // uri
|
|
107
|
+
/**
|
|
108
|
+
* Whether this config is currently active/enabled (omitted when not applicable)
|
|
109
|
+
*/
|
|
110
|
+
active?: boolean;
|
|
111
|
+
/**
|
|
112
|
+
* Installed blueprints that produced this config (tagged during the rebuild lineage pass)
|
|
113
|
+
*/
|
|
114
|
+
blueprints?: {
|
|
115
|
+
id: string;
|
|
116
|
+
title: string;
|
|
117
|
+
}[];
|
|
118
|
+
/**
|
|
119
|
+
* Type-specific metadata (e.g., submission count for journeys)
|
|
120
|
+
*/
|
|
121
|
+
metadata?: {
|
|
122
|
+
[name: string]: any;
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Static metadata for a config type folder in the tree.
|
|
127
|
+
* No downstream API calls — just type + label + icon + source API info.
|
|
128
|
+
*
|
|
129
|
+
*/
|
|
130
|
+
export interface ConfigTypeInfo {
|
|
131
|
+
type: /**
|
|
132
|
+
* Configuration resource type identifier.
|
|
133
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
134
|
+
*
|
|
135
|
+
*/
|
|
136
|
+
ResourceType;
|
|
137
|
+
/**
|
|
138
|
+
* Display label
|
|
139
|
+
* example:
|
|
140
|
+
* Journeys
|
|
141
|
+
*/
|
|
142
|
+
label: string;
|
|
143
|
+
/**
|
|
144
|
+
* Frontend icon name
|
|
145
|
+
* example:
|
|
146
|
+
* Route
|
|
147
|
+
*/
|
|
148
|
+
icon: string;
|
|
149
|
+
/**
|
|
150
|
+
* Base URL of the epilot API that owns this resource type
|
|
151
|
+
* example:
|
|
152
|
+
* https://journey.sls.epilot.io
|
|
153
|
+
*/
|
|
154
|
+
source_api: string;
|
|
155
|
+
/**
|
|
156
|
+
* @epilot/sdk subpath for fetching full config payloads
|
|
157
|
+
* example:
|
|
158
|
+
* @epilot/sdk/journey
|
|
159
|
+
*/
|
|
160
|
+
sdk_client: string;
|
|
161
|
+
}
|
|
162
|
+
export interface ErrorResponse {
|
|
163
|
+
status: number;
|
|
164
|
+
error: string;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Result of an index rebuild operation
|
|
168
|
+
*/
|
|
169
|
+
export interface IndexRebuildResponse {
|
|
170
|
+
status: "ready" | "building" | "failed" | "already_building";
|
|
171
|
+
last_built_at?: string; // date-time
|
|
172
|
+
total_items?: number;
|
|
173
|
+
build_duration_ms?: number;
|
|
174
|
+
failed_types?: string[];
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Current index build state
|
|
178
|
+
*/
|
|
179
|
+
export interface IndexStatusResponse {
|
|
180
|
+
status: "missing" | "building" | "ready" | "failed";
|
|
181
|
+
last_built_at?: string; // date-time
|
|
182
|
+
total_items?: number;
|
|
183
|
+
build_duration_ms?: number;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Configuration resource type identifier.
|
|
187
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
188
|
+
*
|
|
189
|
+
*/
|
|
190
|
+
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";
|
|
191
|
+
/**
|
|
192
|
+
* Direction of the sync, derived from the source/target pane selection in the
|
|
193
|
+
* configuration hub UI.
|
|
194
|
+
*
|
|
195
|
+
*/
|
|
196
|
+
export type SyncDirection = "push" | "pull";
|
|
197
|
+
/**
|
|
198
|
+
* Sync job header as surfaced by `getSyncJob` and the create response. The
|
|
199
|
+
* canonical persistence shape is described in `docs/sync/INTERFACES.md`.
|
|
200
|
+
*
|
|
201
|
+
*/
|
|
202
|
+
export interface SyncJob {
|
|
203
|
+
id: string;
|
|
204
|
+
name?: string;
|
|
205
|
+
status: /**
|
|
206
|
+
* Lifecycle status of a sync job. See `docs/sync/INTERFACES.md` for state
|
|
207
|
+
* transitions.
|
|
208
|
+
*
|
|
209
|
+
*/
|
|
210
|
+
SyncJobStatus;
|
|
211
|
+
direction: /**
|
|
212
|
+
* Direction of the sync, derived from the source/target pane selection in the
|
|
213
|
+
* configuration hub UI.
|
|
214
|
+
*
|
|
215
|
+
*/
|
|
216
|
+
SyncDirection;
|
|
217
|
+
source_org_id: string;
|
|
218
|
+
target_org_id: string;
|
|
219
|
+
dry_run: boolean;
|
|
220
|
+
counts: /* Aggregate counters by resource status. */ SyncJobCounts;
|
|
221
|
+
current_phase?: /**
|
|
222
|
+
* Three-phase orchestrator phase. `phase_0` fetches source payloads,
|
|
223
|
+
* `phase_a` creates/matches with topological batches, `phase_a5` resolves
|
|
224
|
+
* derived references, `phase_b` patches with the full ID map, `finalize`
|
|
225
|
+
* runs cycle-breaking finalizers.
|
|
226
|
+
*
|
|
227
|
+
*/
|
|
228
|
+
SyncPhase;
|
|
229
|
+
current_batch?: /* Position within the current topological batch for the active phase. */ SyncJobBatch;
|
|
230
|
+
started_at: string; // date-time
|
|
231
|
+
finished_at?: string; // date-time
|
|
232
|
+
/**
|
|
233
|
+
* Most recent events (capped server-side, typically last 10).
|
|
234
|
+
*/
|
|
235
|
+
events?: /**
|
|
236
|
+
* Activity-log entry surfaced to the frontend. Backed by the op-log rows in
|
|
237
|
+
* the index table (`SYNC#<jobId>#OP#<seq>`).
|
|
238
|
+
*
|
|
239
|
+
*/
|
|
240
|
+
SyncJobEvent[];
|
|
241
|
+
/**
|
|
242
|
+
* Up to 20 sample error messages from failed resources.
|
|
243
|
+
*/
|
|
244
|
+
errors_sample?: [
|
|
245
|
+
{
|
|
246
|
+
type: string;
|
|
247
|
+
source_id: string;
|
|
248
|
+
error: string;
|
|
249
|
+
}?,
|
|
250
|
+
{
|
|
251
|
+
type: string;
|
|
252
|
+
source_id: string;
|
|
253
|
+
error: string;
|
|
254
|
+
}?,
|
|
255
|
+
{
|
|
256
|
+
type: string;
|
|
257
|
+
source_id: string;
|
|
258
|
+
error: string;
|
|
259
|
+
}?,
|
|
260
|
+
{
|
|
261
|
+
type: string;
|
|
262
|
+
source_id: string;
|
|
263
|
+
error: string;
|
|
264
|
+
}?,
|
|
265
|
+
{
|
|
266
|
+
type: string;
|
|
267
|
+
source_id: string;
|
|
268
|
+
error: string;
|
|
269
|
+
}?,
|
|
270
|
+
{
|
|
271
|
+
type: string;
|
|
272
|
+
source_id: string;
|
|
273
|
+
error: string;
|
|
274
|
+
}?,
|
|
275
|
+
{
|
|
276
|
+
type: string;
|
|
277
|
+
source_id: string;
|
|
278
|
+
error: string;
|
|
279
|
+
}?,
|
|
280
|
+
{
|
|
281
|
+
type: string;
|
|
282
|
+
source_id: string;
|
|
283
|
+
error: string;
|
|
284
|
+
}?,
|
|
285
|
+
{
|
|
286
|
+
type: string;
|
|
287
|
+
source_id: string;
|
|
288
|
+
error: string;
|
|
289
|
+
}?,
|
|
290
|
+
{
|
|
291
|
+
type: string;
|
|
292
|
+
source_id: string;
|
|
293
|
+
error: string;
|
|
294
|
+
}?,
|
|
295
|
+
{
|
|
296
|
+
type: string;
|
|
297
|
+
source_id: string;
|
|
298
|
+
error: string;
|
|
299
|
+
}?,
|
|
300
|
+
{
|
|
301
|
+
type: string;
|
|
302
|
+
source_id: string;
|
|
303
|
+
error: string;
|
|
304
|
+
}?,
|
|
305
|
+
{
|
|
306
|
+
type: string;
|
|
307
|
+
source_id: string;
|
|
308
|
+
error: string;
|
|
309
|
+
}?,
|
|
310
|
+
{
|
|
311
|
+
type: string;
|
|
312
|
+
source_id: string;
|
|
313
|
+
error: string;
|
|
314
|
+
}?,
|
|
315
|
+
{
|
|
316
|
+
type: string;
|
|
317
|
+
source_id: string;
|
|
318
|
+
error: string;
|
|
319
|
+
}?,
|
|
320
|
+
{
|
|
321
|
+
type: string;
|
|
322
|
+
source_id: string;
|
|
323
|
+
error: string;
|
|
324
|
+
}?,
|
|
325
|
+
{
|
|
326
|
+
type: string;
|
|
327
|
+
source_id: string;
|
|
328
|
+
error: string;
|
|
329
|
+
}?,
|
|
330
|
+
{
|
|
331
|
+
type: string;
|
|
332
|
+
source_id: string;
|
|
333
|
+
error: string;
|
|
334
|
+
}?,
|
|
335
|
+
{
|
|
336
|
+
type: string;
|
|
337
|
+
source_id: string;
|
|
338
|
+
error: string;
|
|
339
|
+
}?,
|
|
340
|
+
{
|
|
341
|
+
type: string;
|
|
342
|
+
source_id: string;
|
|
343
|
+
error: string;
|
|
344
|
+
}?
|
|
345
|
+
];
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* Position within the current topological batch for the active phase.
|
|
349
|
+
*/
|
|
350
|
+
export interface SyncJobBatch {
|
|
351
|
+
/**
|
|
352
|
+
* Zero-based index of the batch currently executing.
|
|
353
|
+
*/
|
|
354
|
+
index: number;
|
|
355
|
+
/**
|
|
356
|
+
* Total number of batches in the current phase.
|
|
357
|
+
*/
|
|
358
|
+
of: number;
|
|
359
|
+
/**
|
|
360
|
+
* Dependency level (matches `dependencyLevel` from the topological sort).
|
|
361
|
+
*/
|
|
362
|
+
level: number;
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* Aggregate counters by resource status.
|
|
366
|
+
*/
|
|
367
|
+
export interface SyncJobCounts {
|
|
368
|
+
total: number;
|
|
369
|
+
pending: number;
|
|
370
|
+
in_progress: number;
|
|
371
|
+
succeeded: number;
|
|
372
|
+
failed: number;
|
|
373
|
+
skipped_unchanged: number;
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* Activity-log entry surfaced to the frontend. Backed by the op-log rows in
|
|
377
|
+
* the index table (`SYNC#<jobId>#OP#<seq>`).
|
|
378
|
+
*
|
|
379
|
+
*/
|
|
380
|
+
export interface SyncJobEvent {
|
|
381
|
+
/**
|
|
382
|
+
* Monotonic sequence number assigned at write time.
|
|
383
|
+
*/
|
|
384
|
+
seq: number;
|
|
385
|
+
ts: string; // date-time
|
|
386
|
+
phase?: /**
|
|
387
|
+
* Three-phase orchestrator phase. `phase_0` fetches source payloads,
|
|
388
|
+
* `phase_a` creates/matches with topological batches, `phase_a5` resolves
|
|
389
|
+
* derived references, `phase_b` patches with the full ID map, `finalize`
|
|
390
|
+
* runs cycle-breaking finalizers.
|
|
391
|
+
*
|
|
392
|
+
*/
|
|
393
|
+
SyncPhase;
|
|
394
|
+
/**
|
|
395
|
+
* Resource type
|
|
396
|
+
*/
|
|
397
|
+
type?: string;
|
|
398
|
+
source_id?: string;
|
|
399
|
+
target_id?: string;
|
|
400
|
+
status: /**
|
|
401
|
+
* Per-resource status. `would_*` values are produced by dry-run jobs.
|
|
402
|
+
*
|
|
403
|
+
*/
|
|
404
|
+
SyncJobResourceStatus;
|
|
405
|
+
message?: string;
|
|
406
|
+
error?: string;
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
* Cursor-paginated list of sync jobs.
|
|
410
|
+
*/
|
|
411
|
+
export interface SyncJobListResponse {
|
|
412
|
+
next_cursor?: string;
|
|
413
|
+
results: /**
|
|
414
|
+
* Sync job header as surfaced by `getSyncJob` and the create response. The
|
|
415
|
+
* canonical persistence shape is described in `docs/sync/INTERFACES.md`.
|
|
416
|
+
*
|
|
417
|
+
*/
|
|
418
|
+
SyncJob[];
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Request body for `createSyncJob`. `target_auth_token` is the destination
|
|
422
|
+
* org's auth token and MUST NOT be persisted or logged — it is `writeOnly`.
|
|
423
|
+
*
|
|
424
|
+
*/
|
|
425
|
+
export interface SyncJobRequest {
|
|
426
|
+
/**
|
|
427
|
+
* Org ID the resources are sourced from.
|
|
428
|
+
*/
|
|
429
|
+
source_org_id: string;
|
|
430
|
+
/**
|
|
431
|
+
* Org ID the resources are written into.
|
|
432
|
+
*/
|
|
433
|
+
target_org_id: string;
|
|
434
|
+
/**
|
|
435
|
+
* Destination-org auth token forwarded to adapter writes. Never returned
|
|
436
|
+
* in responses and never logged.
|
|
437
|
+
*
|
|
438
|
+
*/
|
|
439
|
+
target_auth_token: string;
|
|
440
|
+
/**
|
|
441
|
+
* Optional human-friendly job name shown in the history list.
|
|
442
|
+
*/
|
|
443
|
+
name?: string;
|
|
444
|
+
/**
|
|
445
|
+
* If true, the orchestrator runs Phase 0 + a planning pass and writes
|
|
446
|
+
* `would_*` resource rows but performs no destination writes.
|
|
447
|
+
*
|
|
448
|
+
*/
|
|
449
|
+
dry_run?: boolean;
|
|
450
|
+
/**
|
|
451
|
+
* If true, the orchestrator expands the resource set by following
|
|
452
|
+
* dependency edges discovered during Phase 0.
|
|
453
|
+
*
|
|
454
|
+
*/
|
|
455
|
+
include_dependencies?: boolean;
|
|
456
|
+
/**
|
|
457
|
+
* Initial resource selection. Dependencies may be added.
|
|
458
|
+
*/
|
|
459
|
+
resources: {
|
|
460
|
+
/**
|
|
461
|
+
* Resource type identifier
|
|
462
|
+
*/
|
|
463
|
+
type: string;
|
|
464
|
+
/**
|
|
465
|
+
* Source-org resource ID
|
|
466
|
+
*/
|
|
467
|
+
id: string;
|
|
468
|
+
}[];
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* Per-resource row backed by `SyncResourcesTable`. See
|
|
472
|
+
* `docs/sync/INTERFACES.md` for the DDB shape.
|
|
473
|
+
*
|
|
474
|
+
*/
|
|
475
|
+
export interface SyncJobResource {
|
|
476
|
+
type: string;
|
|
477
|
+
source_id: string;
|
|
478
|
+
target_id?: string;
|
|
479
|
+
status: /**
|
|
480
|
+
* Per-resource status. `would_*` values are produced by dry-run jobs.
|
|
481
|
+
*
|
|
482
|
+
*/
|
|
483
|
+
SyncJobResourceStatus;
|
|
484
|
+
phase: /**
|
|
485
|
+
* Three-phase orchestrator phase. `phase_0` fetches source payloads,
|
|
486
|
+
* `phase_a` creates/matches with topological batches, `phase_a5` resolves
|
|
487
|
+
* derived references, `phase_b` patches with the full ID map, `finalize`
|
|
488
|
+
* runs cycle-breaking finalizers.
|
|
489
|
+
*
|
|
490
|
+
*/
|
|
491
|
+
SyncPhase;
|
|
492
|
+
attempt: number;
|
|
493
|
+
error?: string;
|
|
494
|
+
updated_at: string; // date-time
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* Cursor-paginated list of sync job resources.
|
|
498
|
+
*/
|
|
499
|
+
export interface SyncJobResourceListResponse {
|
|
500
|
+
next_cursor?: string;
|
|
501
|
+
results: /**
|
|
502
|
+
* Per-resource row backed by `SyncResourcesTable`. See
|
|
503
|
+
* `docs/sync/INTERFACES.md` for the DDB shape.
|
|
504
|
+
*
|
|
505
|
+
*/
|
|
506
|
+
SyncJobResource[];
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* Per-resource status. `would_*` values are produced by dry-run jobs.
|
|
510
|
+
*
|
|
511
|
+
*/
|
|
512
|
+
export type SyncJobResourceStatus = "pending" | "in_progress" | "created" | "patched" | "skipped" | "would_create" | "would_patch" | "would_skip_unchanged" | "would_match_heuristic" | "failed";
|
|
513
|
+
/**
|
|
514
|
+
* Optional body for `retrySyncJob`. Defaults to retrying every failed
|
|
515
|
+
* resource of the original job.
|
|
516
|
+
*
|
|
517
|
+
*/
|
|
518
|
+
export interface SyncJobRetryRequest {
|
|
519
|
+
/**
|
|
520
|
+
* Map of `<type>:<source_id>` → partial payload patch. Applied on top of
|
|
521
|
+
* the originally fetched payload before re-running Phase A.
|
|
522
|
+
*
|
|
523
|
+
*/
|
|
524
|
+
payload_overrides?: {
|
|
525
|
+
[name: string]: any;
|
|
526
|
+
};
|
|
527
|
+
}
|
|
528
|
+
/**
|
|
529
|
+
* Lifecycle status of a sync job. See `docs/sync/INTERFACES.md` for state
|
|
530
|
+
* transitions.
|
|
531
|
+
*
|
|
532
|
+
*/
|
|
533
|
+
export type SyncJobStatus = "pending" | "in_progress" | "succeeded" | "partial" | "failed" | "cancelled";
|
|
534
|
+
/**
|
|
535
|
+
* Three-phase orchestrator phase. `phase_0` fetches source payloads,
|
|
536
|
+
* `phase_a` creates/matches with topological batches, `phase_a5` resolves
|
|
537
|
+
* derived references, `phase_b` patches with the full ID map, `finalize`
|
|
538
|
+
* runs cycle-breaking finalizers.
|
|
539
|
+
*
|
|
540
|
+
*/
|
|
541
|
+
export type SyncPhase = "phase_0" | "phase_a" | "phase_a5" | "phase_b" | "finalize";
|
|
542
|
+
}
|
|
543
|
+
}
|
|
544
|
+
declare namespace Paths {
|
|
545
|
+
namespace CreateSyncJob {
|
|
546
|
+
export type RequestBody = /**
|
|
547
|
+
* Request body for `createSyncJob`. `target_auth_token` is the destination
|
|
548
|
+
* org's auth token and MUST NOT be persisted or logged — it is `writeOnly`.
|
|
549
|
+
*
|
|
550
|
+
*/
|
|
551
|
+
Components.Schemas.SyncJobRequest;
|
|
552
|
+
namespace Responses {
|
|
553
|
+
export type $201 = /**
|
|
554
|
+
* Sync job header as surfaced by `getSyncJob` and the create response. The
|
|
555
|
+
* canonical persistence shape is described in `docs/sync/INTERFACES.md`.
|
|
556
|
+
*
|
|
557
|
+
*/
|
|
558
|
+
Components.Schemas.SyncJob;
|
|
559
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
560
|
+
}
|
|
561
|
+
}
|
|
562
|
+
namespace GetConfigDependencies {
|
|
563
|
+
namespace Parameters {
|
|
564
|
+
export type Cursor = string;
|
|
565
|
+
export type Id = string;
|
|
566
|
+
export type Size = number;
|
|
567
|
+
export type Type = /**
|
|
568
|
+
* Configuration resource type identifier.
|
|
569
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
570
|
+
*
|
|
571
|
+
*/
|
|
572
|
+
Components.Schemas.ResourceType;
|
|
573
|
+
}
|
|
574
|
+
export interface PathParameters {
|
|
575
|
+
type: Parameters.Type;
|
|
576
|
+
id: Parameters.Id;
|
|
577
|
+
}
|
|
578
|
+
export interface QueryParameters {
|
|
579
|
+
cursor?: Parameters.Cursor;
|
|
580
|
+
size?: Parameters.Size;
|
|
581
|
+
}
|
|
582
|
+
namespace Responses {
|
|
583
|
+
export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
|
|
584
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
585
|
+
}
|
|
586
|
+
}
|
|
587
|
+
namespace GetConfigUsedBy {
|
|
588
|
+
namespace Parameters {
|
|
589
|
+
export type Id = string;
|
|
590
|
+
export type Type = /**
|
|
591
|
+
* Configuration resource type identifier.
|
|
592
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
593
|
+
*
|
|
594
|
+
*/
|
|
595
|
+
Components.Schemas.ResourceType;
|
|
596
|
+
}
|
|
597
|
+
export interface PathParameters {
|
|
598
|
+
type: Parameters.Type;
|
|
599
|
+
id: Parameters.Id;
|
|
600
|
+
}
|
|
601
|
+
namespace Responses {
|
|
602
|
+
export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
namespace GetIndex {
|
|
606
|
+
namespace Responses {
|
|
607
|
+
export type $200 = /* Current index build state */ Components.Schemas.IndexStatusResponse;
|
|
608
|
+
}
|
|
609
|
+
}
|
|
610
|
+
namespace GetSyncJob {
|
|
611
|
+
namespace Parameters {
|
|
612
|
+
export type Id = string;
|
|
613
|
+
}
|
|
614
|
+
export interface PathParameters {
|
|
615
|
+
id: Parameters.Id;
|
|
616
|
+
}
|
|
617
|
+
namespace Responses {
|
|
618
|
+
export type $200 = /**
|
|
619
|
+
* Sync job header as surfaced by `getSyncJob` and the create response. The
|
|
620
|
+
* canonical persistence shape is described in `docs/sync/INTERFACES.md`.
|
|
621
|
+
*
|
|
622
|
+
*/
|
|
623
|
+
Components.Schemas.SyncJob;
|
|
624
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
namespace ListConfigTypes {
|
|
628
|
+
namespace Responses {
|
|
629
|
+
export interface $200 {
|
|
630
|
+
results: /**
|
|
631
|
+
* Static metadata for a config type folder in the tree.
|
|
632
|
+
* No downstream API calls — just type + label + icon + source API info.
|
|
633
|
+
*
|
|
634
|
+
*/
|
|
635
|
+
Components.Schemas.ConfigTypeInfo[];
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
namespace ListConfigs {
|
|
640
|
+
namespace Parameters {
|
|
641
|
+
export type ActiveOnly = boolean;
|
|
642
|
+
export type BlueprintIds = string;
|
|
643
|
+
export type Cursor = string;
|
|
644
|
+
export type Purposes = string;
|
|
645
|
+
export type Q = string;
|
|
646
|
+
export type Size = number;
|
|
647
|
+
export type Sort = "updated_at" | "usage";
|
|
648
|
+
export type Type = /**
|
|
649
|
+
* Configuration resource type identifier.
|
|
650
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
651
|
+
*
|
|
652
|
+
*/
|
|
653
|
+
Components.Schemas.ResourceType;
|
|
654
|
+
export type UpdatedAfter = string; // date-time
|
|
655
|
+
export type UpdatedBefore = string; // date-time
|
|
656
|
+
}
|
|
657
|
+
export interface PathParameters {
|
|
658
|
+
type: Parameters.Type;
|
|
659
|
+
}
|
|
660
|
+
export interface QueryParameters {
|
|
661
|
+
cursor?: Parameters.Cursor;
|
|
662
|
+
size?: Parameters.Size;
|
|
663
|
+
q?: Parameters.Q;
|
|
664
|
+
updated_after?: Parameters.UpdatedAfter /* date-time */;
|
|
665
|
+
updated_before?: Parameters.UpdatedBefore /* date-time */;
|
|
666
|
+
purposes?: Parameters.Purposes;
|
|
667
|
+
blueprint_ids?: Parameters.BlueprintIds;
|
|
668
|
+
sort?: Parameters.Sort;
|
|
669
|
+
active_only?: Parameters.ActiveOnly;
|
|
670
|
+
}
|
|
671
|
+
namespace Responses {
|
|
672
|
+
export type $200 = /* Cursor-paginated list of configs for a specific type */ Components.Schemas.ConfigListResponse;
|
|
673
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
674
|
+
}
|
|
675
|
+
}
|
|
676
|
+
namespace ListSyncJobResources {
|
|
677
|
+
namespace Parameters {
|
|
678
|
+
export type Cursor = string;
|
|
679
|
+
export type Id = string;
|
|
680
|
+
export type Size = number;
|
|
681
|
+
export type Status = /**
|
|
682
|
+
* Per-resource status. `would_*` values are produced by dry-run jobs.
|
|
683
|
+
*
|
|
684
|
+
*/
|
|
685
|
+
Components.Schemas.SyncJobResourceStatus;
|
|
686
|
+
}
|
|
687
|
+
export interface PathParameters {
|
|
688
|
+
id: Parameters.Id;
|
|
689
|
+
}
|
|
690
|
+
export interface QueryParameters {
|
|
691
|
+
cursor?: Parameters.Cursor;
|
|
692
|
+
size?: Parameters.Size;
|
|
693
|
+
status?: Parameters.Status;
|
|
694
|
+
}
|
|
695
|
+
namespace Responses {
|
|
696
|
+
export type $200 = /* Cursor-paginated list of sync job resources. */ Components.Schemas.SyncJobResourceListResponse;
|
|
697
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
698
|
+
}
|
|
699
|
+
}
|
|
700
|
+
namespace ListSyncJobs {
|
|
701
|
+
namespace Parameters {
|
|
702
|
+
export type Cursor = string;
|
|
703
|
+
export type Size = number;
|
|
704
|
+
export type Status = /**
|
|
705
|
+
* Lifecycle status of a sync job. See `docs/sync/INTERFACES.md` for state
|
|
706
|
+
* transitions.
|
|
707
|
+
*
|
|
708
|
+
*/
|
|
709
|
+
Components.Schemas.SyncJobStatus;
|
|
710
|
+
}
|
|
711
|
+
export interface QueryParameters {
|
|
712
|
+
cursor?: Parameters.Cursor;
|
|
713
|
+
size?: Parameters.Size;
|
|
714
|
+
status?: Parameters.Status;
|
|
715
|
+
}
|
|
716
|
+
namespace Responses {
|
|
717
|
+
export type $200 = /* Cursor-paginated list of sync jobs. */ Components.Schemas.SyncJobListResponse;
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
namespace RebuildIndex {
|
|
721
|
+
namespace Responses {
|
|
722
|
+
export type $200 = /* Result of an index rebuild operation */ Components.Schemas.IndexRebuildResponse;
|
|
723
|
+
}
|
|
724
|
+
}
|
|
725
|
+
namespace RetrySyncJob {
|
|
726
|
+
namespace Parameters {
|
|
727
|
+
export type Id = string;
|
|
728
|
+
}
|
|
729
|
+
export interface PathParameters {
|
|
730
|
+
id: Parameters.Id;
|
|
731
|
+
}
|
|
732
|
+
export type RequestBody = /**
|
|
733
|
+
* Optional body for `retrySyncJob`. Defaults to retrying every failed
|
|
734
|
+
* resource of the original job.
|
|
735
|
+
*
|
|
736
|
+
*/
|
|
737
|
+
Components.Schemas.SyncJobRetryRequest;
|
|
738
|
+
namespace Responses {
|
|
739
|
+
export type $201 = /**
|
|
740
|
+
* Sync job header as surfaced by `getSyncJob` and the create response. The
|
|
741
|
+
* canonical persistence shape is described in `docs/sync/INTERFACES.md`.
|
|
742
|
+
*
|
|
743
|
+
*/
|
|
744
|
+
Components.Schemas.SyncJob;
|
|
745
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
746
|
+
}
|
|
747
|
+
}
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
interface OperationMethods {
|
|
752
|
+
/**
|
|
753
|
+
* listConfigTypes - listConfigTypes
|
|
754
|
+
*
|
|
755
|
+
* Returns the static list of available configuration types with display metadata.
|
|
756
|
+
* This is a cheap call — no fan-out to downstream APIs. Returns all known types
|
|
757
|
+
* with labels and icons. The frontend should then call `listConfigs` separately
|
|
758
|
+
* for each type it wants to load.
|
|
759
|
+
*
|
|
760
|
+
*/
|
|
761
|
+
'listConfigTypes'(
|
|
762
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
763
|
+
data?: any,
|
|
764
|
+
config?: AxiosRequestConfig
|
|
765
|
+
): OperationResponse<Paths.ListConfigTypes.Responses.$200>
|
|
766
|
+
/**
|
|
767
|
+
* listConfigs - listConfigs
|
|
768
|
+
*
|
|
769
|
+
* List configs of a given type with pagination. Returns summary metadata only
|
|
770
|
+
* (not full payloads). The frontend calls this per type folder when expanding.
|
|
771
|
+
*
|
|
772
|
+
* Supports offset-based pagination via `from` and `size` parameters.
|
|
773
|
+
*
|
|
774
|
+
*/
|
|
775
|
+
'listConfigs'(
|
|
776
|
+
parameters?: Parameters<Paths.ListConfigs.QueryParameters & Paths.ListConfigs.PathParameters> | null,
|
|
777
|
+
data?: any,
|
|
778
|
+
config?: AxiosRequestConfig
|
|
779
|
+
): OperationResponse<Paths.ListConfigs.Responses.$200>
|
|
780
|
+
/**
|
|
781
|
+
* getConfigDependencies - getConfigDependencies
|
|
782
|
+
*
|
|
783
|
+
* Get configs that are referenced by the given config.
|
|
784
|
+
* Used to render children when expanding a config node in the tree.
|
|
785
|
+
*
|
|
786
|
+
* Resolves dependencies by fetching the config payload server-side and scanning
|
|
787
|
+
* for references (UUIDs, source IDs, slug-based references).
|
|
788
|
+
*
|
|
789
|
+
*/
|
|
790
|
+
'getConfigDependencies'(
|
|
791
|
+
parameters?: Parameters<Paths.GetConfigDependencies.QueryParameters & Paths.GetConfigDependencies.PathParameters> | null,
|
|
792
|
+
data?: any,
|
|
793
|
+
config?: AxiosRequestConfig
|
|
794
|
+
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
795
|
+
/**
|
|
796
|
+
* getConfigUsedBy - getConfigUsedBy
|
|
797
|
+
*
|
|
798
|
+
* Get configs that reference the given config (reverse dependencies).
|
|
799
|
+
* Scans the indexed config items for references to this config's ID or aliases.
|
|
800
|
+
*
|
|
801
|
+
*/
|
|
802
|
+
'getConfigUsedBy'(
|
|
803
|
+
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
804
|
+
data?: any,
|
|
805
|
+
config?: AxiosRequestConfig
|
|
806
|
+
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
807
|
+
/**
|
|
808
|
+
* getIndex - getIndex
|
|
809
|
+
*
|
|
810
|
+
* Return the current index build state for the caller's organization.
|
|
811
|
+
* Clients poll this to decide whether to show a "building" indicator
|
|
812
|
+
* and when to refetch data.
|
|
813
|
+
*
|
|
814
|
+
*/
|
|
815
|
+
'getIndex'(
|
|
816
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
817
|
+
data?: any,
|
|
818
|
+
config?: AxiosRequestConfig
|
|
819
|
+
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
820
|
+
/**
|
|
821
|
+
* listSyncJobs - listSyncJobs
|
|
822
|
+
*
|
|
823
|
+
* List sync jobs scoped to the caller's organization, paginated with an opaque
|
|
824
|
+
* cursor. Defaults to most-recent first.
|
|
825
|
+
*
|
|
826
|
+
*/
|
|
827
|
+
'listSyncJobs'(
|
|
828
|
+
parameters?: Parameters<Paths.ListSyncJobs.QueryParameters> | null,
|
|
829
|
+
data?: any,
|
|
830
|
+
config?: AxiosRequestConfig
|
|
831
|
+
): OperationResponse<Paths.ListSyncJobs.Responses.$200>
|
|
832
|
+
/**
|
|
833
|
+
* createSyncJob - createSyncJob
|
|
834
|
+
*
|
|
835
|
+
* Create a new cross-org sync job. The job is enqueued for asynchronous execution
|
|
836
|
+
* by the worker Lambda; the response returns the persisted job header with status
|
|
837
|
+
* `pending`.
|
|
838
|
+
*
|
|
839
|
+
* See `docs/sync/INTERFACES.md` for the locked request/response contract.
|
|
840
|
+
*
|
|
841
|
+
*/
|
|
842
|
+
'createSyncJob'(
|
|
843
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
844
|
+
data?: Paths.CreateSyncJob.RequestBody,
|
|
845
|
+
config?: AxiosRequestConfig
|
|
846
|
+
): OperationResponse<Paths.CreateSyncJob.Responses.$201>
|
|
847
|
+
/**
|
|
848
|
+
* getSyncJob - getSyncJob
|
|
849
|
+
*
|
|
850
|
+
* Fetch a single sync job by ID. Returns the job header, counts summary,
|
|
851
|
+
* current phase pointer, and the latest activity events. Frontend polls this
|
|
852
|
+
* endpoint with a ramping interval.
|
|
853
|
+
*
|
|
854
|
+
*/
|
|
855
|
+
'getSyncJob'(
|
|
856
|
+
parameters?: Parameters<Paths.GetSyncJob.PathParameters> | null,
|
|
857
|
+
data?: any,
|
|
858
|
+
config?: AxiosRequestConfig
|
|
859
|
+
): OperationResponse<Paths.GetSyncJob.Responses.$200>
|
|
860
|
+
/**
|
|
861
|
+
* retrySyncJob - retrySyncJob
|
|
862
|
+
*
|
|
863
|
+
* Retry the failed resources from a prior sync job. Creates a new job whose
|
|
864
|
+
* scope is the failed `(type, source_id)` set of the original job and enqueues
|
|
865
|
+
* it for execution. Optionally accepts inline payload overrides.
|
|
866
|
+
*
|
|
867
|
+
*/
|
|
868
|
+
'retrySyncJob'(
|
|
869
|
+
parameters?: Parameters<Paths.RetrySyncJob.PathParameters> | null,
|
|
870
|
+
data?: Paths.RetrySyncJob.RequestBody,
|
|
871
|
+
config?: AxiosRequestConfig
|
|
872
|
+
): OperationResponse<Paths.RetrySyncJob.Responses.$201>
|
|
873
|
+
/**
|
|
874
|
+
* listSyncJobResources - listSyncJobResources
|
|
875
|
+
*
|
|
876
|
+
* List the per-resource rows for a sync job. Supports filtering by status
|
|
877
|
+
* (e.g. `failed`) and cursor pagination. Used by the failures table and the
|
|
878
|
+
* dry-run plan view in the frontend.
|
|
879
|
+
*
|
|
880
|
+
*/
|
|
881
|
+
'listSyncJobResources'(
|
|
882
|
+
parameters?: Parameters<Paths.ListSyncJobResources.QueryParameters & Paths.ListSyncJobResources.PathParameters> | null,
|
|
883
|
+
data?: any,
|
|
884
|
+
config?: AxiosRequestConfig
|
|
885
|
+
): OperationResponse<Paths.ListSyncJobResources.Responses.$200>
|
|
886
|
+
/**
|
|
887
|
+
* rebuildIndex - rebuildIndex
|
|
888
|
+
*
|
|
889
|
+
* Rebuild the configuration index for the caller's organization.
|
|
890
|
+
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
891
|
+
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
892
|
+
*
|
|
893
|
+
*/
|
|
894
|
+
'rebuildIndex'(
|
|
895
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
896
|
+
data?: any,
|
|
897
|
+
config?: AxiosRequestConfig
|
|
898
|
+
): OperationResponse<Paths.RebuildIndex.Responses.$200>
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
interface PathsDictionary {
|
|
902
|
+
['/v1/configs/types']: {
|
|
903
|
+
/**
|
|
904
|
+
* listConfigTypes - listConfigTypes
|
|
905
|
+
*
|
|
906
|
+
* Returns the static list of available configuration types with display metadata.
|
|
907
|
+
* This is a cheap call — no fan-out to downstream APIs. Returns all known types
|
|
908
|
+
* with labels and icons. The frontend should then call `listConfigs` separately
|
|
909
|
+
* for each type it wants to load.
|
|
910
|
+
*
|
|
911
|
+
*/
|
|
912
|
+
'get'(
|
|
913
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
914
|
+
data?: any,
|
|
915
|
+
config?: AxiosRequestConfig
|
|
916
|
+
): OperationResponse<Paths.ListConfigTypes.Responses.$200>
|
|
917
|
+
}
|
|
918
|
+
['/v1/configs/{type}']: {
|
|
919
|
+
/**
|
|
920
|
+
* listConfigs - listConfigs
|
|
921
|
+
*
|
|
922
|
+
* List configs of a given type with pagination. Returns summary metadata only
|
|
923
|
+
* (not full payloads). The frontend calls this per type folder when expanding.
|
|
924
|
+
*
|
|
925
|
+
* Supports offset-based pagination via `from` and `size` parameters.
|
|
926
|
+
*
|
|
927
|
+
*/
|
|
928
|
+
'get'(
|
|
929
|
+
parameters?: Parameters<Paths.ListConfigs.QueryParameters & Paths.ListConfigs.PathParameters> | null,
|
|
930
|
+
data?: any,
|
|
931
|
+
config?: AxiosRequestConfig
|
|
932
|
+
): OperationResponse<Paths.ListConfigs.Responses.$200>
|
|
933
|
+
}
|
|
934
|
+
['/v1/configs/{type}/{id}/dependencies']: {
|
|
935
|
+
/**
|
|
936
|
+
* getConfigDependencies - getConfigDependencies
|
|
937
|
+
*
|
|
938
|
+
* Get configs that are referenced by the given config.
|
|
939
|
+
* Used to render children when expanding a config node in the tree.
|
|
940
|
+
*
|
|
941
|
+
* Resolves dependencies by fetching the config payload server-side and scanning
|
|
942
|
+
* for references (UUIDs, source IDs, slug-based references).
|
|
943
|
+
*
|
|
944
|
+
*/
|
|
945
|
+
'get'(
|
|
946
|
+
parameters?: Parameters<Paths.GetConfigDependencies.QueryParameters & Paths.GetConfigDependencies.PathParameters> | null,
|
|
947
|
+
data?: any,
|
|
948
|
+
config?: AxiosRequestConfig
|
|
949
|
+
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
950
|
+
}
|
|
951
|
+
['/v1/configs/{type}/{id}/used_by']: {
|
|
952
|
+
/**
|
|
953
|
+
* getConfigUsedBy - getConfigUsedBy
|
|
954
|
+
*
|
|
955
|
+
* Get configs that reference the given config (reverse dependencies).
|
|
956
|
+
* Scans the indexed config items for references to this config's ID or aliases.
|
|
957
|
+
*
|
|
958
|
+
*/
|
|
959
|
+
'get'(
|
|
960
|
+
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
961
|
+
data?: any,
|
|
962
|
+
config?: AxiosRequestConfig
|
|
963
|
+
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
964
|
+
}
|
|
965
|
+
['/v1/configs/index']: {
|
|
966
|
+
/**
|
|
967
|
+
* getIndex - getIndex
|
|
968
|
+
*
|
|
969
|
+
* Return the current index build state for the caller's organization.
|
|
970
|
+
* Clients poll this to decide whether to show a "building" indicator
|
|
971
|
+
* and when to refetch data.
|
|
972
|
+
*
|
|
973
|
+
*/
|
|
974
|
+
'get'(
|
|
975
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
976
|
+
data?: any,
|
|
977
|
+
config?: AxiosRequestConfig
|
|
978
|
+
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
979
|
+
}
|
|
980
|
+
['/v1/configs/sync-jobs']: {
|
|
981
|
+
/**
|
|
982
|
+
* createSyncJob - createSyncJob
|
|
983
|
+
*
|
|
984
|
+
* Create a new cross-org sync job. The job is enqueued for asynchronous execution
|
|
985
|
+
* by the worker Lambda; the response returns the persisted job header with status
|
|
986
|
+
* `pending`.
|
|
987
|
+
*
|
|
988
|
+
* See `docs/sync/INTERFACES.md` for the locked request/response contract.
|
|
989
|
+
*
|
|
990
|
+
*/
|
|
991
|
+
'post'(
|
|
992
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
993
|
+
data?: Paths.CreateSyncJob.RequestBody,
|
|
994
|
+
config?: AxiosRequestConfig
|
|
995
|
+
): OperationResponse<Paths.CreateSyncJob.Responses.$201>
|
|
996
|
+
/**
|
|
997
|
+
* listSyncJobs - listSyncJobs
|
|
998
|
+
*
|
|
999
|
+
* List sync jobs scoped to the caller's organization, paginated with an opaque
|
|
1000
|
+
* cursor. Defaults to most-recent first.
|
|
1001
|
+
*
|
|
1002
|
+
*/
|
|
1003
|
+
'get'(
|
|
1004
|
+
parameters?: Parameters<Paths.ListSyncJobs.QueryParameters> | null,
|
|
1005
|
+
data?: any,
|
|
1006
|
+
config?: AxiosRequestConfig
|
|
1007
|
+
): OperationResponse<Paths.ListSyncJobs.Responses.$200>
|
|
1008
|
+
}
|
|
1009
|
+
['/v1/configs/sync-jobs/{id}']: {
|
|
1010
|
+
/**
|
|
1011
|
+
* getSyncJob - getSyncJob
|
|
1012
|
+
*
|
|
1013
|
+
* Fetch a single sync job by ID. Returns the job header, counts summary,
|
|
1014
|
+
* current phase pointer, and the latest activity events. Frontend polls this
|
|
1015
|
+
* endpoint with a ramping interval.
|
|
1016
|
+
*
|
|
1017
|
+
*/
|
|
1018
|
+
'get'(
|
|
1019
|
+
parameters?: Parameters<Paths.GetSyncJob.PathParameters> | null,
|
|
1020
|
+
data?: any,
|
|
1021
|
+
config?: AxiosRequestConfig
|
|
1022
|
+
): OperationResponse<Paths.GetSyncJob.Responses.$200>
|
|
1023
|
+
}
|
|
1024
|
+
['/v1/configs/sync-jobs/{id}/retry']: {
|
|
1025
|
+
/**
|
|
1026
|
+
* retrySyncJob - retrySyncJob
|
|
1027
|
+
*
|
|
1028
|
+
* Retry the failed resources from a prior sync job. Creates a new job whose
|
|
1029
|
+
* scope is the failed `(type, source_id)` set of the original job and enqueues
|
|
1030
|
+
* it for execution. Optionally accepts inline payload overrides.
|
|
1031
|
+
*
|
|
1032
|
+
*/
|
|
1033
|
+
'post'(
|
|
1034
|
+
parameters?: Parameters<Paths.RetrySyncJob.PathParameters> | null,
|
|
1035
|
+
data?: Paths.RetrySyncJob.RequestBody,
|
|
1036
|
+
config?: AxiosRequestConfig
|
|
1037
|
+
): OperationResponse<Paths.RetrySyncJob.Responses.$201>
|
|
1038
|
+
}
|
|
1039
|
+
['/v1/configs/sync-jobs/{id}/resources']: {
|
|
1040
|
+
/**
|
|
1041
|
+
* listSyncJobResources - listSyncJobResources
|
|
1042
|
+
*
|
|
1043
|
+
* List the per-resource rows for a sync job. Supports filtering by status
|
|
1044
|
+
* (e.g. `failed`) and cursor pagination. Used by the failures table and the
|
|
1045
|
+
* dry-run plan view in the frontend.
|
|
1046
|
+
*
|
|
1047
|
+
*/
|
|
1048
|
+
'get'(
|
|
1049
|
+
parameters?: Parameters<Paths.ListSyncJobResources.QueryParameters & Paths.ListSyncJobResources.PathParameters> | null,
|
|
1050
|
+
data?: any,
|
|
1051
|
+
config?: AxiosRequestConfig
|
|
1052
|
+
): OperationResponse<Paths.ListSyncJobResources.Responses.$200>
|
|
1053
|
+
}
|
|
1054
|
+
['/v1/configs/index:rebuild']: {
|
|
1055
|
+
/**
|
|
1056
|
+
* rebuildIndex - rebuildIndex
|
|
1057
|
+
*
|
|
1058
|
+
* Rebuild the configuration index for the caller's organization.
|
|
1059
|
+
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
1060
|
+
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
1061
|
+
*
|
|
1062
|
+
*/
|
|
1063
|
+
'post'(
|
|
1064
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1065
|
+
data?: any,
|
|
1066
|
+
config?: AxiosRequestConfig
|
|
1067
|
+
): OperationResponse<Paths.RebuildIndex.Responses.$200>
|
|
1068
|
+
}
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
type ConfigDependenciesResponse = Components.Schemas.ConfigDependenciesResponse;
|
|
1075
|
+
type ConfigListResponse = Components.Schemas.ConfigListResponse;
|
|
1076
|
+
type ConfigNode = Components.Schemas.ConfigNode;
|
|
1077
|
+
type ConfigTypeInfo = Components.Schemas.ConfigTypeInfo;
|
|
1078
|
+
type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
1079
|
+
type IndexRebuildResponse = Components.Schemas.IndexRebuildResponse;
|
|
1080
|
+
type IndexStatusResponse = Components.Schemas.IndexStatusResponse;
|
|
1081
|
+
type ResourceType = Components.Schemas.ResourceType;
|
|
1082
|
+
type SyncDirection = Components.Schemas.SyncDirection;
|
|
1083
|
+
type SyncJob = Components.Schemas.SyncJob;
|
|
1084
|
+
type SyncJobBatch = Components.Schemas.SyncJobBatch;
|
|
1085
|
+
type SyncJobCounts = Components.Schemas.SyncJobCounts;
|
|
1086
|
+
type SyncJobEvent = Components.Schemas.SyncJobEvent;
|
|
1087
|
+
type SyncJobListResponse = Components.Schemas.SyncJobListResponse;
|
|
1088
|
+
type SyncJobRequest = Components.Schemas.SyncJobRequest;
|
|
1089
|
+
type SyncJobResource = Components.Schemas.SyncJobResource;
|
|
1090
|
+
type SyncJobResourceListResponse = Components.Schemas.SyncJobResourceListResponse;
|
|
1091
|
+
type SyncJobResourceStatus = Components.Schemas.SyncJobResourceStatus;
|
|
1092
|
+
type SyncJobRetryRequest = Components.Schemas.SyncJobRetryRequest;
|
|
1093
|
+
type SyncJobStatus = Components.Schemas.SyncJobStatus;
|
|
1094
|
+
type SyncPhase = Components.Schemas.SyncPhase;
|
|
1095
|
+
|
|
1096
|
+
export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, type SyncDirection as S, 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, type SyncJob as h, type SyncJobBatch as i, type SyncJobCounts as j, type SyncJobEvent as k, type SyncJobListResponse as l, type SyncJobRequest as m, type SyncJobResource as n, type SyncJobResourceListResponse as o, type SyncJobResourceStatus as p, type SyncJobRetryRequest as q, type SyncJobStatus as r, type SyncPhase as s };
|