@epilot/sdk 2.11.4 → 2.11.5
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/definitions/snapshot-runtime.json +1 -1
- package/definitions/snapshot.json +214 -46
- 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/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- 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 +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/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/snapshot.cjs +8 -8
- package/dist/apis/snapshot.d.cts +2 -2
- package/dist/apis/snapshot.d.ts +2 -2
- package/dist/apis/snapshot.js +2 -2
- 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/{chunk-O4C7IU7J.cjs → chunk-6CTW57LR.cjs} +2 -2
- package/dist/{chunk-PCK46M32.js → chunk-IINIFIYG.js} +2 -2
- package/dist/{chunk-54QNWEPZ.js → chunk-UXY7SWNP.js} +1 -1
- package/dist/{chunk-YXJ4PBFQ.cjs → chunk-VDMPIKAN.cjs} +1 -1
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/snapshot-5XHTEB2U.js +7 -0
- package/dist/snapshot-NKK6BNQB.cjs +7 -0
- package/dist/{snapshot-runtime-6DV42FVY.cjs → snapshot-runtime-AQJSSXRV.cjs} +2 -2
- package/dist/{snapshot-runtime-IW57MINC.js → snapshot-runtime-AY7YYSFQ.js} +1 -1
- package/dist/{snapshot.d-CqefmvuB.d.cts → snapshot.d-DT0zg2CS.d.cts} +258 -39
- package/dist/{snapshot.d-CqefmvuB.d.ts → snapshot.d-DT0zg2CS.d.ts} +258 -39
- package/docs/snapshot.md +179 -21
- package/package.json +1 -1
- package/dist/snapshot-2HFERXRQ.js +0 -7
- package/dist/snapshot-UHCQAT4R.cjs +0 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkVDMPIKANcjs = require('./chunk-VDMPIKAN.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkVDMPIKANcjs.require_snapshot_runtime.call(void 0, );
|
|
@@ -8,13 +8,6 @@ declare namespace Components {
|
|
|
8
8
|
export type BadRequest = Schemas.Error;
|
|
9
9
|
export type NotFound = Schemas.Error;
|
|
10
10
|
export type Unauthorized = Schemas.Error;
|
|
11
|
-
export type UnprocessableEntity = /**
|
|
12
|
-
* Returned (422) when the org inventory contains no capturable resources
|
|
13
|
-
* after filtering out sensitive, unsupported, and excluded types. The
|
|
14
|
-
* `skipped_types` array explains why every type was dropped.
|
|
15
|
-
*
|
|
16
|
-
*/
|
|
17
|
-
Schemas.EmptyInventoryError;
|
|
18
11
|
}
|
|
19
12
|
namespace Schemas {
|
|
20
13
|
export interface CallerIdentity {
|
|
@@ -83,23 +76,6 @@ declare namespace Components {
|
|
|
83
76
|
status: "creating";
|
|
84
77
|
created_at: string; // date-time
|
|
85
78
|
}
|
|
86
|
-
/**
|
|
87
|
-
* Returned (422) when the org inventory contains no capturable resources
|
|
88
|
-
* after filtering out sensitive, unsupported, and excluded types. The
|
|
89
|
-
* `skipped_types` array explains why every type was dropped.
|
|
90
|
-
*
|
|
91
|
-
*/
|
|
92
|
-
export interface EmptyInventoryError {
|
|
93
|
-
/**
|
|
94
|
-
* example:
|
|
95
|
-
* No capturable resources in the org inventory
|
|
96
|
-
*/
|
|
97
|
-
message: string;
|
|
98
|
-
skipped_types: {
|
|
99
|
-
type: string;
|
|
100
|
-
reason: string;
|
|
101
|
-
}[];
|
|
102
|
-
}
|
|
103
79
|
export interface Error {
|
|
104
80
|
status: number;
|
|
105
81
|
error: string;
|
|
@@ -118,6 +94,89 @@ declare namespace Components {
|
|
|
118
94
|
error?: string;
|
|
119
95
|
triggered_by: CallerIdentity;
|
|
120
96
|
}
|
|
97
|
+
/**
|
|
98
|
+
* Enrollment record for a scheduled org snapshot. One row per org.
|
|
99
|
+
* This table — not EventBridge — is the source of truth; the EventBridge
|
|
100
|
+
* schedule entry is the materialization of this row (reconciled on write
|
|
101
|
+
* by Task 6).
|
|
102
|
+
*
|
|
103
|
+
*/
|
|
104
|
+
export interface OrgSnapshotSchedule {
|
|
105
|
+
org_id: string;
|
|
106
|
+
enabled: boolean;
|
|
107
|
+
/**
|
|
108
|
+
* Validated 6-field EventBridge cron. Default `cron(0 2 * * ? *)`.
|
|
109
|
+
* example:
|
|
110
|
+
* cron(0 2 * * ? *)
|
|
111
|
+
*/
|
|
112
|
+
cron_expression: string;
|
|
113
|
+
/**
|
|
114
|
+
* IANA timezone. Default `Europe/Berlin`.
|
|
115
|
+
*/
|
|
116
|
+
timezone: string;
|
|
117
|
+
retention: /**
|
|
118
|
+
* Flat retention window for a scheduled snapshot.
|
|
119
|
+
* Converted to a `ttl` epoch at capture time. Capped at ~24 months.
|
|
120
|
+
*
|
|
121
|
+
*/
|
|
122
|
+
RetentionConfig;
|
|
123
|
+
excluded_types?: string[];
|
|
124
|
+
/**
|
|
125
|
+
* Name of the EventBridge Scheduler entry this row owns.
|
|
126
|
+
* Set at enrollment time as `org-snapshot-{orgId}`.
|
|
127
|
+
*
|
|
128
|
+
*/
|
|
129
|
+
schedule_name: string;
|
|
130
|
+
last_started_at?: string; // date-time
|
|
131
|
+
last_completed_at?: string; // date-time
|
|
132
|
+
last_status?: "completed" | "partial" | "failed";
|
|
133
|
+
created_by: string;
|
|
134
|
+
created_at: string; // date-time
|
|
135
|
+
updated_at: string; // date-time
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* Body for `putOrgSnapshotSchedule`. All fields optional; unset fields
|
|
139
|
+
* receive defaults on first create and are left unchanged on updates
|
|
140
|
+
* (except `updated_at`).
|
|
141
|
+
*
|
|
142
|
+
*/
|
|
143
|
+
export interface PutOrgSnapshotScheduleRequest {
|
|
144
|
+
/**
|
|
145
|
+
* Whether the schedule is active.
|
|
146
|
+
*/
|
|
147
|
+
enabled?: boolean;
|
|
148
|
+
/**
|
|
149
|
+
* 6-field EventBridge cron expression, e.g. `cron(0 2 * * ? *)`.
|
|
150
|
+
* Validated server-side: minute + hour must be concrete single integers
|
|
151
|
+
* (no `*`, lists, ranges, or steps) to cap cadence at ≤ once/day.
|
|
152
|
+
* Exactly one of day-of-month / day-of-week must be `?`.
|
|
153
|
+
*
|
|
154
|
+
* example:
|
|
155
|
+
* cron(0 2 * * ? *)
|
|
156
|
+
*/
|
|
157
|
+
cron_expression?: string;
|
|
158
|
+
/**
|
|
159
|
+
* IANA timezone string passed to EventBridge `ScheduleExpressionTimezone`,
|
|
160
|
+
* e.g. `Europe/Berlin`. AWS handles DST natively.
|
|
161
|
+
*
|
|
162
|
+
* example:
|
|
163
|
+
* Europe/Berlin
|
|
164
|
+
*/
|
|
165
|
+
timezone?: string;
|
|
166
|
+
retention?: /**
|
|
167
|
+
* Flat retention window for a scheduled snapshot.
|
|
168
|
+
* Converted to a `ttl` epoch at capture time. Capped at ~24 months.
|
|
169
|
+
*
|
|
170
|
+
*/
|
|
171
|
+
RetentionConfig;
|
|
172
|
+
/**
|
|
173
|
+
* Resource types to exclude from the scheduled capture, in addition
|
|
174
|
+
* to the always-excluded sensitive types (`access_token`,
|
|
175
|
+
* `environment_variable`).
|
|
176
|
+
*
|
|
177
|
+
*/
|
|
178
|
+
excluded_types?: string[];
|
|
179
|
+
}
|
|
121
180
|
export interface ResourceRef {
|
|
122
181
|
/**
|
|
123
182
|
* Resource type (e.g., custom_variable, journey, automation_flow)
|
|
@@ -146,6 +205,18 @@ declare namespace Components {
|
|
|
146
205
|
id: string;
|
|
147
206
|
status: "restoring";
|
|
148
207
|
}
|
|
208
|
+
/**
|
|
209
|
+
* Flat retention window for a scheduled snapshot.
|
|
210
|
+
* Converted to a `ttl` epoch at capture time. Capped at ~24 months.
|
|
211
|
+
*
|
|
212
|
+
*/
|
|
213
|
+
export interface RetentionConfig {
|
|
214
|
+
/**
|
|
215
|
+
* Numeric quantity of retention (e.g. 90 for "90 days").
|
|
216
|
+
*/
|
|
217
|
+
value: number;
|
|
218
|
+
unit: "days" | "weeks" | "months";
|
|
219
|
+
}
|
|
149
220
|
export interface Snapshot {
|
|
150
221
|
id: string;
|
|
151
222
|
org_id: string;
|
|
@@ -284,7 +355,6 @@ declare namespace Paths {
|
|
|
284
355
|
namespace Responses {
|
|
285
356
|
export type $202 = Components.Schemas.CreateSnapshotResponse;
|
|
286
357
|
export type $401 = Components.Responses.Unauthorized;
|
|
287
|
-
export type $422 = Components.Responses.UnprocessableEntity;
|
|
288
358
|
}
|
|
289
359
|
}
|
|
290
360
|
namespace CreateSnapshot {
|
|
@@ -295,6 +365,14 @@ declare namespace Paths {
|
|
|
295
365
|
export type $401 = Components.Responses.Unauthorized;
|
|
296
366
|
}
|
|
297
367
|
}
|
|
368
|
+
namespace DeleteOrgSnapshotSchedule {
|
|
369
|
+
namespace Responses {
|
|
370
|
+
export interface $204 {
|
|
371
|
+
}
|
|
372
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
373
|
+
export type $404 = Components.Responses.NotFound;
|
|
374
|
+
}
|
|
375
|
+
}
|
|
298
376
|
namespace DeleteSnapshot {
|
|
299
377
|
namespace Responses {
|
|
300
378
|
export interface $204 {
|
|
@@ -303,6 +381,20 @@ declare namespace Paths {
|
|
|
303
381
|
export type $404 = Components.Responses.NotFound;
|
|
304
382
|
}
|
|
305
383
|
}
|
|
384
|
+
namespace GetOrgSnapshotSchedule {
|
|
385
|
+
namespace Responses {
|
|
386
|
+
export type $200 = /**
|
|
387
|
+
* Enrollment record for a scheduled org snapshot. One row per org.
|
|
388
|
+
* This table — not EventBridge — is the source of truth; the EventBridge
|
|
389
|
+
* schedule entry is the materialization of this row (reconciled on write
|
|
390
|
+
* by Task 6).
|
|
391
|
+
*
|
|
392
|
+
*/
|
|
393
|
+
Components.Schemas.OrgSnapshotSchedule;
|
|
394
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
395
|
+
export type $404 = Components.Responses.NotFound;
|
|
396
|
+
}
|
|
397
|
+
}
|
|
306
398
|
namespace GetSnapshot {
|
|
307
399
|
namespace Responses {
|
|
308
400
|
export type $200 = Components.Schemas.Snapshot;
|
|
@@ -370,6 +462,27 @@ declare namespace Paths {
|
|
|
370
462
|
export type $401 = Components.Responses.Unauthorized;
|
|
371
463
|
}
|
|
372
464
|
}
|
|
465
|
+
namespace PutOrgSnapshotSchedule {
|
|
466
|
+
export type RequestBody = /**
|
|
467
|
+
* Body for `putOrgSnapshotSchedule`. All fields optional; unset fields
|
|
468
|
+
* receive defaults on first create and are left unchanged on updates
|
|
469
|
+
* (except `updated_at`).
|
|
470
|
+
*
|
|
471
|
+
*/
|
|
472
|
+
Components.Schemas.PutOrgSnapshotScheduleRequest;
|
|
473
|
+
namespace Responses {
|
|
474
|
+
export type $200 = /**
|
|
475
|
+
* Enrollment record for a scheduled org snapshot. One row per org.
|
|
476
|
+
* This table — not EventBridge — is the source of truth; the EventBridge
|
|
477
|
+
* schedule entry is the materialization of this row (reconciled on write
|
|
478
|
+
* by Task 6).
|
|
479
|
+
*
|
|
480
|
+
*/
|
|
481
|
+
Components.Schemas.OrgSnapshotSchedule;
|
|
482
|
+
export type $400 = Components.Responses.BadRequest;
|
|
483
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
484
|
+
}
|
|
485
|
+
}
|
|
373
486
|
namespace RestoreSnapshot {
|
|
374
487
|
export type RequestBody = /**
|
|
375
488
|
* Apply a captured snapshot to its source org. snapshot-api applies the
|
|
@@ -457,12 +570,14 @@ interface OperationMethods {
|
|
|
457
570
|
/**
|
|
458
571
|
* captureOrgSnapshot - captureOrgSnapshot
|
|
459
572
|
*
|
|
460
|
-
* Snapshot the caller's whole organization now.
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
* `
|
|
573
|
+
* Snapshot the caller's whole organization now. Creates a `scope: "org"`
|
|
574
|
+
* snapshot row and starts a chunked capture Step Function, then returns
|
|
575
|
+
* immediately. The capture asynchronously fetches a fresh inventory of the
|
|
576
|
+
* org's configuration resources from configuration-hub-api, persists it as
|
|
577
|
+
* an inventory artifact, and captures each resource. Client polls
|
|
578
|
+
* `getSnapshot` and watches `capture_summary` fill in until `create.status`
|
|
579
|
+
* moves from `in_progress` to `completed` or `failed`. An org with no
|
|
580
|
+
* capturable resources finalizes as a completed 0-resource snapshot.
|
|
466
581
|
*
|
|
467
582
|
* Sensitive types (`access_token`, `environment_variable`), types with no
|
|
468
583
|
* engine adapter, and any `excluded_types` are dropped from the capture and
|
|
@@ -539,6 +654,55 @@ interface OperationMethods {
|
|
|
539
654
|
data?: any,
|
|
540
655
|
config?: AxiosRequestConfig
|
|
541
656
|
): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
|
|
657
|
+
/**
|
|
658
|
+
* getOrgSnapshotSchedule - getOrgSnapshotSchedule
|
|
659
|
+
*
|
|
660
|
+
* Return the scheduled-snapshot enrollment config for the caller's org.
|
|
661
|
+
* Returns 404 when the org has not yet enrolled.
|
|
662
|
+
*
|
|
663
|
+
*/
|
|
664
|
+
'getOrgSnapshotSchedule'(
|
|
665
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
666
|
+
data?: any,
|
|
667
|
+
config?: AxiosRequestConfig
|
|
668
|
+
): OperationResponse<Paths.GetOrgSnapshotSchedule.Responses.$200>
|
|
669
|
+
/**
|
|
670
|
+
* putOrgSnapshotSchedule - putOrgSnapshotSchedule
|
|
671
|
+
*
|
|
672
|
+
* Create or update the scheduled-snapshot enrollment config for the
|
|
673
|
+
* caller's org (upsert). The cron expression and retention window are
|
|
674
|
+
* validated server-side; invalid values are rejected with 400.
|
|
675
|
+
*
|
|
676
|
+
* Defaults applied when a field is omitted on first create:
|
|
677
|
+
* - `cron_expression`: `cron(0 2 * * ? *)` (daily at 02:00)
|
|
678
|
+
* - `timezone`: `Europe/Berlin`
|
|
679
|
+
* - `retention`: `{ value: 90, unit: "days" }`
|
|
680
|
+
* - `enabled`: `true`
|
|
681
|
+
*
|
|
682
|
+
* **Note:** this call persists the row only. EventBridge schedule
|
|
683
|
+
* materialization is performed by a subsequent reconcile step (Task 6).
|
|
684
|
+
* The row is the authoritative source of truth for the UI.
|
|
685
|
+
*
|
|
686
|
+
*/
|
|
687
|
+
'putOrgSnapshotSchedule'(
|
|
688
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
689
|
+
data?: Paths.PutOrgSnapshotSchedule.RequestBody,
|
|
690
|
+
config?: AxiosRequestConfig
|
|
691
|
+
): OperationResponse<Paths.PutOrgSnapshotSchedule.Responses.$200>
|
|
692
|
+
/**
|
|
693
|
+
* deleteOrgSnapshotSchedule - deleteOrgSnapshotSchedule
|
|
694
|
+
*
|
|
695
|
+
* Remove the scheduled-snapshot enrollment for the caller's org.
|
|
696
|
+
* Returns 404 when no schedule exists.
|
|
697
|
+
* The corresponding EventBridge schedule is removed by a reconcile
|
|
698
|
+
* step (Task 6).
|
|
699
|
+
*
|
|
700
|
+
*/
|
|
701
|
+
'deleteOrgSnapshotSchedule'(
|
|
702
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
703
|
+
data?: any,
|
|
704
|
+
config?: AxiosRequestConfig
|
|
705
|
+
): OperationResponse<Paths.DeleteOrgSnapshotSchedule.Responses.$204>
|
|
542
706
|
/**
|
|
543
707
|
* listDependencies - listDependencies
|
|
544
708
|
*
|
|
@@ -593,12 +757,14 @@ interface PathsDictionary {
|
|
|
593
757
|
/**
|
|
594
758
|
* captureOrgSnapshot - captureOrgSnapshot
|
|
595
759
|
*
|
|
596
|
-
* Snapshot the caller's whole organization now.
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
* `
|
|
760
|
+
* Snapshot the caller's whole organization now. Creates a `scope: "org"`
|
|
761
|
+
* snapshot row and starts a chunked capture Step Function, then returns
|
|
762
|
+
* immediately. The capture asynchronously fetches a fresh inventory of the
|
|
763
|
+
* org's configuration resources from configuration-hub-api, persists it as
|
|
764
|
+
* an inventory artifact, and captures each resource. Client polls
|
|
765
|
+
* `getSnapshot` and watches `capture_summary` fill in until `create.status`
|
|
766
|
+
* moves from `in_progress` to `completed` or `failed`. An org with no
|
|
767
|
+
* capturable resources finalizes as a completed 0-resource snapshot.
|
|
602
768
|
*
|
|
603
769
|
* Sensitive types (`access_token`, `environment_variable`), types with no
|
|
604
770
|
* engine adapter, and any `excluded_types` are dropped from the capture and
|
|
@@ -684,6 +850,57 @@ interface PathsDictionary {
|
|
|
684
850
|
config?: AxiosRequestConfig
|
|
685
851
|
): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
|
|
686
852
|
}
|
|
853
|
+
['/v1/org-snapshot-schedule']: {
|
|
854
|
+
/**
|
|
855
|
+
* getOrgSnapshotSchedule - getOrgSnapshotSchedule
|
|
856
|
+
*
|
|
857
|
+
* Return the scheduled-snapshot enrollment config for the caller's org.
|
|
858
|
+
* Returns 404 when the org has not yet enrolled.
|
|
859
|
+
*
|
|
860
|
+
*/
|
|
861
|
+
'get'(
|
|
862
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
863
|
+
data?: any,
|
|
864
|
+
config?: AxiosRequestConfig
|
|
865
|
+
): OperationResponse<Paths.GetOrgSnapshotSchedule.Responses.$200>
|
|
866
|
+
/**
|
|
867
|
+
* putOrgSnapshotSchedule - putOrgSnapshotSchedule
|
|
868
|
+
*
|
|
869
|
+
* Create or update the scheduled-snapshot enrollment config for the
|
|
870
|
+
* caller's org (upsert). The cron expression and retention window are
|
|
871
|
+
* validated server-side; invalid values are rejected with 400.
|
|
872
|
+
*
|
|
873
|
+
* Defaults applied when a field is omitted on first create:
|
|
874
|
+
* - `cron_expression`: `cron(0 2 * * ? *)` (daily at 02:00)
|
|
875
|
+
* - `timezone`: `Europe/Berlin`
|
|
876
|
+
* - `retention`: `{ value: 90, unit: "days" }`
|
|
877
|
+
* - `enabled`: `true`
|
|
878
|
+
*
|
|
879
|
+
* **Note:** this call persists the row only. EventBridge schedule
|
|
880
|
+
* materialization is performed by a subsequent reconcile step (Task 6).
|
|
881
|
+
* The row is the authoritative source of truth for the UI.
|
|
882
|
+
*
|
|
883
|
+
*/
|
|
884
|
+
'put'(
|
|
885
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
886
|
+
data?: Paths.PutOrgSnapshotSchedule.RequestBody,
|
|
887
|
+
config?: AxiosRequestConfig
|
|
888
|
+
): OperationResponse<Paths.PutOrgSnapshotSchedule.Responses.$200>
|
|
889
|
+
/**
|
|
890
|
+
* deleteOrgSnapshotSchedule - deleteOrgSnapshotSchedule
|
|
891
|
+
*
|
|
892
|
+
* Remove the scheduled-snapshot enrollment for the caller's org.
|
|
893
|
+
* Returns 404 when no schedule exists.
|
|
894
|
+
* The corresponding EventBridge schedule is removed by a reconcile
|
|
895
|
+
* step (Task 6).
|
|
896
|
+
*
|
|
897
|
+
*/
|
|
898
|
+
'delete'(
|
|
899
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
900
|
+
data?: any,
|
|
901
|
+
config?: AxiosRequestConfig
|
|
902
|
+
): OperationResponse<Paths.DeleteOrgSnapshotSchedule.Responses.$204>
|
|
903
|
+
}
|
|
687
904
|
['/v1/snapshots:list-dependencies']: {
|
|
688
905
|
/**
|
|
689
906
|
* listDependencies - listDependencies
|
|
@@ -710,15 +927,17 @@ type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
|
710
927
|
type CreateOrgSnapshotRequest = Components.Schemas.CreateOrgSnapshotRequest;
|
|
711
928
|
type CreateSnapshotRequest = Components.Schemas.CreateSnapshotRequest;
|
|
712
929
|
type CreateSnapshotResponse = Components.Schemas.CreateSnapshotResponse;
|
|
713
|
-
type EmptyInventoryError = Components.Schemas.EmptyInventoryError;
|
|
714
930
|
type Error = Components.Schemas.Error;
|
|
715
931
|
type Operation = Components.Schemas.Operation;
|
|
932
|
+
type OrgSnapshotSchedule = Components.Schemas.OrgSnapshotSchedule;
|
|
933
|
+
type PutOrgSnapshotScheduleRequest = Components.Schemas.PutOrgSnapshotScheduleRequest;
|
|
716
934
|
type ResourceRef = Components.Schemas.ResourceRef;
|
|
717
935
|
type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
|
|
718
936
|
type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
|
|
937
|
+
type RetentionConfig = Components.Schemas.RetentionConfig;
|
|
719
938
|
type Snapshot = Components.Schemas.Snapshot;
|
|
720
939
|
type SnapshotResourceDetail = Components.Schemas.SnapshotResourceDetail;
|
|
721
940
|
type SnapshotResourceList = Components.Schemas.SnapshotResourceList;
|
|
722
941
|
type SnapshotResourceSummary = Components.Schemas.SnapshotResourceSummary;
|
|
723
942
|
|
|
724
|
-
export { type Client as C, type
|
|
943
|
+
export { type Client as C, type Error as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type Snapshot as S, Components as a, type PathsDictionary as b, type CallerIdentity as c, type CreateOrgSnapshotRequest as d, type CreateSnapshotRequest as e, type CreateSnapshotResponse as f, type Operation as g, type OrgSnapshotSchedule as h, type PutOrgSnapshotScheduleRequest as i, type RestoreSnapshotRequest as j, type RestoreSnapshotResponse as k, type RetentionConfig as l, type SnapshotResourceDetail as m, type SnapshotResourceList as n, type SnapshotResourceSummary as o };
|