@wix/auto_sdk_app-management_apps 1.0.0 → 1.0.2
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/build/cjs/index.d.ts +19 -19
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +173 -82
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +129 -56
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +19 -19
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +173 -82
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +129 -56
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +19 -19
- package/build/internal/cjs/index.typings.d.ts +180 -82
- package/build/internal/cjs/meta.d.ts +136 -56
- package/build/internal/es/index.d.mts +19 -19
- package/build/internal/es/index.typings.d.mts +180 -82
- package/build/internal/es/meta.d.mts +136 -56
- package/package.json +2 -2
|
@@ -13,7 +13,9 @@ interface V1App {
|
|
|
13
13
|
*/
|
|
14
14
|
id?: string | null;
|
|
15
15
|
/**
|
|
16
|
-
* The display name
|
|
16
|
+
* The display name shown to users and in App Market after publication, separate from the namespace, slug, and code identifier.
|
|
17
|
+
* On creation and update, `<`, `>`, double quotes, and apostrophes are escaped as
|
|
18
|
+
* `<`, `>`, `"`, and `'`. Responses contain the escaped value, which can be longer than the submitted name.
|
|
17
19
|
* @maxLength 50
|
|
18
20
|
*/
|
|
19
21
|
name?: string;
|
|
@@ -23,7 +25,11 @@ interface V1App {
|
|
|
23
25
|
* @format GUID
|
|
24
26
|
*/
|
|
25
27
|
accountId?: string | null;
|
|
26
|
-
/**
|
|
28
|
+
/**
|
|
29
|
+
* Secrets for authentication and webhooks. Omitted from Get App responses by default.
|
|
30
|
+
* To retrieve them, include `APP_SECRETS` in Get App's `additionalFields`.
|
|
31
|
+
* Requires authorization to access the app's secrets.
|
|
32
|
+
*/
|
|
27
33
|
appSecrets?: AppSecrets;
|
|
28
34
|
/**
|
|
29
35
|
* Is Wix owned the application
|
|
@@ -31,13 +37,18 @@ interface V1App {
|
|
|
31
37
|
*/
|
|
32
38
|
wixApp?: boolean;
|
|
33
39
|
/**
|
|
34
|
-
* App namespace, combining an account or company identifier with an app-name component.
|
|
40
|
+
* App namespace, combining an account or company identifier with an app-name component.
|
|
41
|
+
* For example, `@example-company/bookings-helper`.
|
|
42
|
+
* Assign it once through Set Namespace after creating the app. Don't supply it to Create App
|
|
43
|
+
* or Update App. Set Namespace fails if the app already has a namespace.
|
|
35
44
|
* @minLength 1
|
|
36
45
|
* @maxLength 150
|
|
37
46
|
*/
|
|
38
47
|
namespace?: string | null;
|
|
39
48
|
/**
|
|
40
|
-
*
|
|
49
|
+
* An identifier for referencing the app in code, separate from its display name, namespace, and slug.
|
|
50
|
+
* Must start with a letter, underscore, or dollar sign; remaining characters can also include digits.
|
|
51
|
+
* JavaScript reserved words aren't rejected. Choose a non-reserved identifier if using this value as a JavaScript variable name.
|
|
41
52
|
* Unique for non-companion apps. Companion apps return the shared value `companionApp`; use `id` to uniquely identify an app.
|
|
42
53
|
* For example, the namespace `@app-builder/my-cool-app` can be represented by the code identifier `AppBuilderMyCoolApp`.
|
|
43
54
|
* @minLength 3
|
|
@@ -51,7 +62,12 @@ interface V1App {
|
|
|
51
62
|
* @internal
|
|
52
63
|
*/
|
|
53
64
|
appType?: AppTypeWithLiterals;
|
|
54
|
-
/**
|
|
65
|
+
/**
|
|
66
|
+
* Revision number, which increments by 1 each time the app is updated.
|
|
67
|
+
* To prevent conflicting changes, supply the current revision when calling Update App.
|
|
68
|
+
* Retrieve the latest revision through Get App before updating.
|
|
69
|
+
* Ignored when creating an app.
|
|
70
|
+
*/
|
|
55
71
|
revision?: string | null;
|
|
56
72
|
/**
|
|
57
73
|
* A human-readable, URL-friendly identifier for the app.
|
|
@@ -68,7 +84,9 @@ interface V1App {
|
|
|
68
84
|
/** URLs used by the app's OAuth flow. */
|
|
69
85
|
appUrls?: AppUrls;
|
|
70
86
|
/**
|
|
71
|
-
* Identity of the user or app that created the app, including its source template when applicable.
|
|
87
|
+
* Identity and creation channel of the user or app that created the app, including its source template when applicable.
|
|
88
|
+
* Create App derives `id` and `type` from the caller's identity, replacing any supplied values.
|
|
89
|
+
* You can supply `sourceTemplateId` during creation. Creator information can't be changed through Update App.
|
|
72
90
|
* @immutable
|
|
73
91
|
*/
|
|
74
92
|
createdBy?: CreatedBy;
|
|
@@ -84,7 +102,7 @@ interface V1App {
|
|
|
84
102
|
* @readonly
|
|
85
103
|
*/
|
|
86
104
|
updatedDate?: Date | null;
|
|
87
|
-
/**
|
|
105
|
+
/** Event-based tracking of unreleased changes, grouped by type. Updates asynchronously; see each flag for its tracking scope. */
|
|
88
106
|
unreleasedChanges?: UnreleasedChanges;
|
|
89
107
|
/**
|
|
90
108
|
* The ownership tag of the application
|
|
@@ -140,6 +158,8 @@ interface V1App {
|
|
|
140
158
|
interface AppSecrets {
|
|
141
159
|
/**
|
|
142
160
|
* App authentication secret. Keep this value in a secure backend secret store.
|
|
161
|
+
* During rotation, this field contains the previous secret while both secrets exist.
|
|
162
|
+
* After the previous secret is retired, this field contains the replacement secret.
|
|
143
163
|
* @readonly
|
|
144
164
|
* @format GUID
|
|
145
165
|
*/
|
|
@@ -151,7 +171,8 @@ interface AppSecrets {
|
|
|
151
171
|
*/
|
|
152
172
|
webhookPublicKey?: string;
|
|
153
173
|
/**
|
|
154
|
-
*
|
|
174
|
+
* Replacement authentication secret used during rotation. Present while the app has two secrets.
|
|
175
|
+
* After the previous secret is retired, this value moves to `appSecret` and this field is cleared.
|
|
155
176
|
* @readonly
|
|
156
177
|
* @format GUID
|
|
157
178
|
*/
|
|
@@ -217,52 +238,88 @@ interface AppUrls {
|
|
|
217
238
|
* @maxSize 100
|
|
218
239
|
*/
|
|
219
240
|
redirectUris?: string[];
|
|
241
|
+
/**
|
|
242
|
+
* Allowed post-installation URLs, where Wix redirects the user after installing the app from an external install link.
|
|
243
|
+
* A `postInstallationUrl` matches an entry when they are equal, ignoring the query string.
|
|
244
|
+
* @format WEB_URL
|
|
245
|
+
* @maxSize 100
|
|
246
|
+
*/
|
|
247
|
+
postInstallationUrls?: string[];
|
|
248
|
+
/**
|
|
249
|
+
* Whether installs fail when the `postInstallationUrl` doesn't match `post_installation_urls`.
|
|
250
|
+
* @internal
|
|
251
|
+
* @deprecated Whether installs fail when the `postInstallationUrl` doesn't match `post_installation_urls`.
|
|
252
|
+
* @targetRemovalDate 2026-12-01
|
|
253
|
+
*/
|
|
254
|
+
validatePostInstallationUrl?: boolean | null;
|
|
220
255
|
}
|
|
221
256
|
interface CreatedBy {
|
|
222
257
|
/**
|
|
223
|
-
* ID
|
|
258
|
+
* Creator ID derived from the caller's identity; a supplied value is replaced during creation.
|
|
259
|
+
* Identifies a user for `USER`, `CODE_GEN`, and `APP_BUILDER_SELF_HOSTED`, or an app for `APP`.
|
|
224
260
|
* @format GUID
|
|
225
261
|
*/
|
|
226
262
|
id?: string;
|
|
227
|
-
/**
|
|
263
|
+
/** Creator identity or creation channel, derived from the caller's identity rather than a supplied value. */
|
|
228
264
|
type?: CreatedByTypeWithLiterals;
|
|
229
265
|
/**
|
|
230
|
-
* ID of the template
|
|
266
|
+
* ID of the source template, when applicable. Can be supplied to Create App.
|
|
231
267
|
* @format GUID
|
|
232
268
|
*/
|
|
233
269
|
sourceTemplateId?: string | null;
|
|
234
270
|
}
|
|
235
271
|
declare enum CreatedByType {
|
|
272
|
+
/** Created by a user; `id` is the user's ID. */
|
|
236
273
|
USER = "USER",
|
|
274
|
+
/** Created by an app; `id` is the app's ID. */
|
|
237
275
|
APP = "APP",
|
|
276
|
+
/** Created through code generation; `id` is the initiating user's ID. */
|
|
238
277
|
CODE_GEN = "CODE_GEN",
|
|
278
|
+
/** Created through the self-hosted app builder; `id` is the initiating user's ID. */
|
|
239
279
|
APP_BUILDER_SELF_HOSTED = "APP_BUILDER_SELF_HOSTED"
|
|
240
280
|
}
|
|
241
281
|
/** @enumType */
|
|
242
282
|
type CreatedByTypeWithLiterals = CreatedByType | 'USER' | 'APP' | 'CODE_GEN' | 'APP_BUILDER_SELF_HOSTED';
|
|
243
283
|
interface InstallationPreferences extends InstallationPreferencesOpenButtonOptionsOneOf {
|
|
244
|
-
/** Component to open when `openButtonAction` is `OPEN_COMPONENT_ID`. */
|
|
284
|
+
/** Component to open. Supply `componentId` when `openButtonAction` is `OPEN_COMPONENT_ID`. */
|
|
245
285
|
openComponentIdOptions?: OpenComponentId;
|
|
246
|
-
/**
|
|
286
|
+
/**
|
|
287
|
+
* Preferred destination after installing an app with both editor and dashboard components.
|
|
288
|
+
* A recognized dashboard page in `postInstallationComponentId` takes precedence over this preference.
|
|
289
|
+
* Otherwise, `DASHBOARD` selects the dashboard and `EDITOR` selects the editor.
|
|
290
|
+
* On sites without an editor, `EDITOR` falls back to the dashboard.
|
|
291
|
+
* `UNKNOWN_REDIRECT_TARGET` leaves the default installation navigation unchanged.
|
|
292
|
+
*/
|
|
247
293
|
overridePostInstallationRedirect?: RedirectTargetWithLiterals;
|
|
248
294
|
/**
|
|
249
|
-
* ID of the
|
|
295
|
+
* Optional ID of the app's dashboard page to open after installation.
|
|
296
|
+
* A recognized dashboard page takes precedence over `overridePostInstallationRedirect`.
|
|
297
|
+
* If omitted or not recognized as a dashboard page, navigation uses the redirect preference
|
|
298
|
+
* or the default installation flow. This field doesn't select an editor component.
|
|
250
299
|
* @format GUID
|
|
251
300
|
*/
|
|
252
301
|
postInstallationComponentId?: string | null;
|
|
253
|
-
/**
|
|
302
|
+
/**
|
|
303
|
+
* Action performed when the user selects the app's Open button after installation.
|
|
304
|
+
* For `OPEN_COMPONENT_ID`, supply `openComponentIdOptions.componentId`.
|
|
305
|
+
* `UNKNOWN_ACTION` means no explicit component-opening action is selected.
|
|
306
|
+
*/
|
|
254
307
|
openButtonAction?: OpenButtonActionWithLiterals;
|
|
255
308
|
/**
|
|
256
309
|
* Indicates the different consent options the app could define post installation
|
|
257
310
|
* @internal
|
|
258
311
|
*/
|
|
259
312
|
consentOptions?: ConsentOptions;
|
|
260
|
-
/**
|
|
313
|
+
/**
|
|
314
|
+
* Custom warning shown when a user tries to uninstall the app.
|
|
315
|
+
* Select `NO_ACTION` for no custom warning; `NONE_ACTION` represents an unspecified preference.
|
|
316
|
+
* The product and shipping values select warning text, rather than performing cleanup.
|
|
317
|
+
*/
|
|
261
318
|
uninstallAction?: UninstallActionsWithLiterals;
|
|
262
319
|
}
|
|
263
320
|
/** @oneof */
|
|
264
321
|
interface InstallationPreferencesOpenButtonOptionsOneOf {
|
|
265
|
-
/** Component to open when `openButtonAction` is `OPEN_COMPONENT_ID`. */
|
|
322
|
+
/** Component to open. Supply `componentId` when `openButtonAction` is `OPEN_COMPONENT_ID`. */
|
|
266
323
|
openComponentIdOptions?: OpenComponentId;
|
|
267
324
|
}
|
|
268
325
|
declare enum ShowConsentBehaviour {
|
|
@@ -273,14 +330,19 @@ declare enum ShowConsentBehaviour {
|
|
|
273
330
|
/** @enumType */
|
|
274
331
|
type ShowConsentBehaviourWithLiterals = ShowConsentBehaviour | 'DEFAULT_BEHAVIOUR' | 'SHOW_CONSENT' | 'SKIP_CONSENT';
|
|
275
332
|
declare enum RedirectTarget {
|
|
333
|
+
/** Use the default installation navigation. */
|
|
276
334
|
UNKNOWN_REDIRECT_TARGET = "UNKNOWN_REDIRECT_TARGET",
|
|
335
|
+
/** Prefer the site dashboard for an app with editor and dashboard components. */
|
|
277
336
|
DASHBOARD = "DASHBOARD",
|
|
337
|
+
/** Prefer the editor; use the dashboard on sites without an editor. */
|
|
278
338
|
EDITOR = "EDITOR"
|
|
279
339
|
}
|
|
280
340
|
/** @enumType */
|
|
281
341
|
type RedirectTargetWithLiterals = RedirectTarget | 'UNKNOWN_REDIRECT_TARGET' | 'DASHBOARD' | 'EDITOR';
|
|
282
342
|
declare enum OpenButtonAction {
|
|
343
|
+
/** No explicit component-opening action is selected. */
|
|
283
344
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
345
|
+
/** Open the component specified by `openComponentIdOptions.componentId`. */
|
|
284
346
|
OPEN_COMPONENT_ID = "OPEN_COMPONENT_ID"
|
|
285
347
|
}
|
|
286
348
|
/** @enumType */
|
|
@@ -297,28 +359,46 @@ interface OpenComponentId {
|
|
|
297
359
|
componentId?: string;
|
|
298
360
|
}
|
|
299
361
|
declare enum UninstallActions {
|
|
362
|
+
/** Unspecified warning preference. Use `NO_ACTION` to explicitly select no custom warning. */
|
|
300
363
|
NONE_ACTION = "NONE_ACTION",
|
|
364
|
+
/** Show the standard uninstall message without a custom warning. Default when no preference is stored. */
|
|
301
365
|
NO_ACTION = "NO_ACTION",
|
|
366
|
+
/** Warn users to remove all products associated with the app from their store. */
|
|
302
367
|
REMOVE_ALL_PRODUCT = "REMOVE_ALL_PRODUCT",
|
|
368
|
+
/** Warn users that shipping to regions served only by the app will be removed from checkout. */
|
|
303
369
|
SHIPPING_RATES_REGION = "SHIPPING_RATES_REGION"
|
|
304
370
|
}
|
|
305
371
|
/** @enumType */
|
|
306
372
|
type UninstallActionsWithLiterals = UninstallActions | 'NONE_ACTION' | 'NO_ACTION' | 'REMOVE_ALL_PRODUCT' | 'SHIPPING_RATES_REGION';
|
|
373
|
+
/**
|
|
374
|
+
* Event-based tracking of changes not yet included in a released app version.
|
|
375
|
+
* Flags update asynchronously and reset when a production app version is created or updated.
|
|
376
|
+
*/
|
|
307
377
|
interface UnreleasedChanges {
|
|
308
|
-
/**
|
|
378
|
+
/** Whether components have unreleased creation, update, or deletion changes. */
|
|
309
379
|
componentsChanges?: boolean;
|
|
310
|
-
/**
|
|
380
|
+
/** Whether app translations have unreleased creation or update changes. */
|
|
311
381
|
appTranslationsChanges?: boolean;
|
|
312
|
-
/**
|
|
382
|
+
/**
|
|
383
|
+
* Whether component translations have unreleased update changes.
|
|
384
|
+
* Component-translation creation events currently aren't reflected in this flag.
|
|
385
|
+
*/
|
|
313
386
|
componentsTranslationChanges?: boolean;
|
|
314
387
|
/**
|
|
315
388
|
* Indicate components experiments changes (create, update, delete)
|
|
316
389
|
* @internal
|
|
317
390
|
*/
|
|
318
391
|
componentsExperimentsChanges?: boolean;
|
|
319
|
-
/**
|
|
392
|
+
/**
|
|
393
|
+
* Whether app permissions have unreleased creation or update changes.
|
|
394
|
+
* Permission-deletion events currently aren't reflected in this flag.
|
|
395
|
+
*/
|
|
320
396
|
appPermissionsChanges?: boolean;
|
|
321
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* Whether app identity fields have unreleased changes, such as `name`, `slug`, `namespace`, and `codeIdentifier`.
|
|
399
|
+
* Doesn't track changes to `appUrls` or `installationPreferences`.
|
|
400
|
+
* Updates asynchronously after the app's update event; the update response may not yet reflect this flag.
|
|
401
|
+
*/
|
|
322
402
|
appEntityChanges?: boolean;
|
|
323
403
|
}
|
|
324
404
|
interface AppComponentMetadata {
|
|
@@ -554,7 +634,7 @@ interface AccountInfo {
|
|
|
554
634
|
}
|
|
555
635
|
interface AppOwnerChangedEvent {
|
|
556
636
|
/**
|
|
557
|
-
*
|
|
637
|
+
* App ID.
|
|
558
638
|
* @format GUID
|
|
559
639
|
*/
|
|
560
640
|
appId?: string;
|
|
@@ -570,16 +650,16 @@ interface AppOwnerChangedEvent {
|
|
|
570
650
|
previousAccountId?: string;
|
|
571
651
|
}
|
|
572
652
|
interface CreateAppRequest {
|
|
573
|
-
/** App to
|
|
653
|
+
/** App to create. */
|
|
574
654
|
app: V1App;
|
|
575
655
|
}
|
|
576
656
|
interface CreateAppResponse {
|
|
577
|
-
/**
|
|
657
|
+
/** Created app. */
|
|
578
658
|
app?: V1App;
|
|
579
659
|
}
|
|
580
660
|
interface GetAppRequest {
|
|
581
661
|
/**
|
|
582
|
-
*
|
|
662
|
+
* App ID.
|
|
583
663
|
* @format GUID
|
|
584
664
|
*/
|
|
585
665
|
appId: string;
|
|
@@ -606,11 +686,11 @@ declare enum RequestedFields {
|
|
|
606
686
|
/** @enumType */
|
|
607
687
|
type RequestedFieldsWithLiterals = RequestedFields | 'APP_SECRETS';
|
|
608
688
|
interface GetAppResponse {
|
|
609
|
-
/**
|
|
689
|
+
/** Retrieved app. */
|
|
610
690
|
app?: V1App;
|
|
611
691
|
}
|
|
612
692
|
interface UpdateAppRequest {
|
|
613
|
-
/** App to
|
|
693
|
+
/** App to update. Specify the app ID, current revision, and fields to change. */
|
|
614
694
|
app: V1App;
|
|
615
695
|
/**
|
|
616
696
|
* Explicit list of fields to update
|
|
@@ -619,23 +699,23 @@ interface UpdateAppRequest {
|
|
|
619
699
|
mask?: string[];
|
|
620
700
|
}
|
|
621
701
|
interface UpdateAppResponse {
|
|
622
|
-
/**
|
|
702
|
+
/** Updated app. */
|
|
623
703
|
app?: V1App;
|
|
624
704
|
}
|
|
625
705
|
interface GenerateSlugRequest {
|
|
626
706
|
/**
|
|
627
|
-
*
|
|
707
|
+
* App ID.
|
|
628
708
|
* @format GUID
|
|
629
709
|
*/
|
|
630
710
|
appId: string;
|
|
631
711
|
}
|
|
632
712
|
interface GenerateSlugResponse {
|
|
633
|
-
/**
|
|
713
|
+
/** App with its generated or existing slug. */
|
|
634
714
|
app?: V1App;
|
|
635
715
|
}
|
|
636
716
|
interface RenameSlugRequest {
|
|
637
717
|
/**
|
|
638
|
-
*
|
|
718
|
+
* App ID.
|
|
639
719
|
* @format GUID
|
|
640
720
|
*/
|
|
641
721
|
appId?: string;
|
|
@@ -647,12 +727,12 @@ interface RenameSlugRequest {
|
|
|
647
727
|
newSlug?: string;
|
|
648
728
|
}
|
|
649
729
|
interface RenameSlugResponse {
|
|
650
|
-
/**
|
|
730
|
+
/** App with its slug updated to the requested `newSlug`. */
|
|
651
731
|
app?: V1App;
|
|
652
732
|
}
|
|
653
733
|
interface RenameCodeIdentifierRequest {
|
|
654
734
|
/**
|
|
655
|
-
*
|
|
735
|
+
* App ID.
|
|
656
736
|
* @format GUID
|
|
657
737
|
*/
|
|
658
738
|
appId?: string;
|
|
@@ -664,12 +744,12 @@ interface RenameCodeIdentifierRequest {
|
|
|
664
744
|
newCodeIdentifier?: string;
|
|
665
745
|
}
|
|
666
746
|
interface RenameCodeIdentifierResponse {
|
|
667
|
-
/**
|
|
747
|
+
/** App with its updated code identifier. */
|
|
668
748
|
app?: V1App;
|
|
669
749
|
}
|
|
670
750
|
interface GetNamespaceSuggestionRequest {
|
|
671
751
|
/**
|
|
672
|
-
*
|
|
752
|
+
* App ID.
|
|
673
753
|
* @format GUID
|
|
674
754
|
*/
|
|
675
755
|
appId: string;
|
|
@@ -685,12 +765,12 @@ declare enum NamespaceType {
|
|
|
685
765
|
/** @enumType */
|
|
686
766
|
type NamespaceTypeWithLiterals = NamespaceType | 'ACCOUNT' | 'COMPANY';
|
|
687
767
|
interface GetNamespaceSuggestionResponse {
|
|
688
|
-
/**
|
|
768
|
+
/** Suggested namespace. */
|
|
689
769
|
namespace?: string;
|
|
690
770
|
}
|
|
691
771
|
interface GetNamespaceSuggestionByNameRequest {
|
|
692
772
|
/**
|
|
693
|
-
*
|
|
773
|
+
* App display name used to derive a namespace suggestion.
|
|
694
774
|
* @maxLength 50
|
|
695
775
|
*/
|
|
696
776
|
name: string;
|
|
@@ -699,7 +779,7 @@ interface GetNamespaceSuggestionByNameRequest {
|
|
|
699
779
|
}
|
|
700
780
|
interface GetNamespaceSuggestionByNameResponse {
|
|
701
781
|
/**
|
|
702
|
-
*
|
|
782
|
+
* Suggested namespace.
|
|
703
783
|
* @minLength 1
|
|
704
784
|
* @maxLength 150
|
|
705
785
|
*/
|
|
@@ -707,12 +787,12 @@ interface GetNamespaceSuggestionByNameResponse {
|
|
|
707
787
|
}
|
|
708
788
|
interface SetNamespaceRequest {
|
|
709
789
|
/**
|
|
710
|
-
*
|
|
790
|
+
* App ID.
|
|
711
791
|
* @format GUID
|
|
712
792
|
*/
|
|
713
793
|
appId: string;
|
|
714
794
|
/**
|
|
715
|
-
* Name used to derive the app's namespace component
|
|
795
|
+
* Name used to derive the app's namespace component.
|
|
716
796
|
* Lowercased; runs of non-alphanumeric characters (including spaces and underscores) become hyphens, with leading/trailing separators removed.
|
|
717
797
|
* For example, `Bookings Helper` and `Bookings_Helper` become `bookings-helper`. If no letters or digits remain, uses `untitled`.
|
|
718
798
|
* Subject to the reserved-name restrictions documented on Set Namespace. For permitted Wix-owned apps, `wix` is removed before normalization.
|
|
@@ -748,7 +828,7 @@ interface SuggestCodeIdentifierResponse {
|
|
|
748
828
|
}
|
|
749
829
|
interface SetCodeIdentifierRequest {
|
|
750
830
|
/**
|
|
751
|
-
*
|
|
831
|
+
* App ID.
|
|
752
832
|
* @format GUID
|
|
753
833
|
*/
|
|
754
834
|
appId?: string;
|
|
@@ -955,7 +1035,7 @@ interface Cursors {
|
|
|
955
1035
|
}
|
|
956
1036
|
interface SetPrivateAppRequest {
|
|
957
1037
|
/**
|
|
958
|
-
*
|
|
1038
|
+
* App ID.
|
|
959
1039
|
* @format GUID
|
|
960
1040
|
*/
|
|
961
1041
|
appId?: string;
|
|
@@ -965,7 +1045,7 @@ interface SetPrivateAppRequest {
|
|
|
965
1045
|
revision?: string;
|
|
966
1046
|
}
|
|
967
1047
|
interface SetPrivateAppResponse {
|
|
968
|
-
/**
|
|
1048
|
+
/** App with its `privateApp` setting updated to the requested value. */
|
|
969
1049
|
app?: V1App;
|
|
970
1050
|
}
|
|
971
1051
|
interface AppChangedEvent {
|
|
@@ -1054,7 +1134,7 @@ interface AppSlugChanged {
|
|
|
1054
1134
|
}
|
|
1055
1135
|
interface SetAppOwnerRequest {
|
|
1056
1136
|
/**
|
|
1057
|
-
*
|
|
1137
|
+
* App ID.
|
|
1058
1138
|
* @format GUID
|
|
1059
1139
|
*/
|
|
1060
1140
|
appId?: string;
|
|
@@ -1067,7 +1147,7 @@ interface SetAppOwnerRequest {
|
|
|
1067
1147
|
revision?: string;
|
|
1068
1148
|
}
|
|
1069
1149
|
interface SetAppOwnerResponse {
|
|
1070
|
-
/**
|
|
1150
|
+
/** App owned by the requested `accountId`. */
|
|
1071
1151
|
app?: V1App;
|
|
1072
1152
|
}
|
|
1073
1153
|
interface AppUrlsChangedInOldServiceEvent extends AppUrlsChangedInOldServiceEventChangedUrlOneOf {
|
|
@@ -1076,7 +1156,7 @@ interface AppUrlsChangedInOldServiceEvent extends AppUrlsChangedInOldServiceEven
|
|
|
1076
1156
|
/** redirect uris */
|
|
1077
1157
|
redirectUriMessage?: RedirectUrlMessage;
|
|
1078
1158
|
/**
|
|
1079
|
-
*
|
|
1159
|
+
* App ID.
|
|
1080
1160
|
* @format GUID
|
|
1081
1161
|
*/
|
|
1082
1162
|
appId?: string;
|
|
@@ -1098,7 +1178,7 @@ interface RedirectUrlMessage {
|
|
|
1098
1178
|
}
|
|
1099
1179
|
interface CreateSecondarySecretRequest {
|
|
1100
1180
|
/**
|
|
1101
|
-
*
|
|
1181
|
+
* App ID.
|
|
1102
1182
|
* @format GUID
|
|
1103
1183
|
*/
|
|
1104
1184
|
appId: string;
|
|
@@ -1122,7 +1202,7 @@ interface ActivateSecondarySecretResponse {
|
|
|
1122
1202
|
}
|
|
1123
1203
|
interface RotateSecretRequest {
|
|
1124
1204
|
/**
|
|
1125
|
-
*
|
|
1205
|
+
* App ID.
|
|
1126
1206
|
* @format GUID
|
|
1127
1207
|
*/
|
|
1128
1208
|
appId?: string;
|
|
@@ -1133,7 +1213,7 @@ interface RotateSecretResponse {
|
|
|
1133
1213
|
}
|
|
1134
1214
|
interface RollbackSecretRequest {
|
|
1135
1215
|
/**
|
|
1136
|
-
*
|
|
1216
|
+
* App ID.
|
|
1137
1217
|
* @format GUID
|
|
1138
1218
|
*/
|
|
1139
1219
|
appId?: string;
|
|
@@ -1144,24 +1224,24 @@ interface RollbackSecretResponse {
|
|
|
1144
1224
|
}
|
|
1145
1225
|
interface RevokeSecretRequest {
|
|
1146
1226
|
/**
|
|
1147
|
-
*
|
|
1227
|
+
* App ID.
|
|
1148
1228
|
* @format GUID
|
|
1149
1229
|
*/
|
|
1150
1230
|
appId: string;
|
|
1151
|
-
/**
|
|
1231
|
+
/** Credential to revoke. The app must have both a previous and a replacement secret. */
|
|
1152
1232
|
secretToRevoke: SecretToRevokeWithLiterals;
|
|
1153
1233
|
}
|
|
1154
|
-
/**
|
|
1234
|
+
/** Credential to revoke during app-secret rotation. */
|
|
1155
1235
|
declare enum SecretToRevoke {
|
|
1156
|
-
/**
|
|
1236
|
+
/** Switch signing to the replacement secret and schedule retirement of the previous secret. */
|
|
1157
1237
|
PREVIOUS_SECRET = "PREVIOUS_SECRET",
|
|
1158
|
-
/**
|
|
1238
|
+
/** Discard the replacement secret and restore signing with the previous secret. */
|
|
1159
1239
|
NEW_SECRET = "NEW_SECRET"
|
|
1160
1240
|
}
|
|
1161
1241
|
/** @enumType */
|
|
1162
1242
|
type SecretToRevokeWithLiterals = SecretToRevoke | 'PREVIOUS_SECRET' | 'NEW_SECRET';
|
|
1163
1243
|
interface RevokeSecretResponse {
|
|
1164
|
-
/** Scheduled retirement time of the previous secret.
|
|
1244
|
+
/** Scheduled retirement time of the previous secret. Returned for `PREVIOUS_SECRET` and omitted for `NEW_SECRET`. Use the latest returned timestamp. */
|
|
1165
1245
|
previousSecretRevokeAt?: Date | null;
|
|
1166
1246
|
}
|
|
1167
1247
|
/** payload for kafka event for this version on app submit */
|
|
@@ -11,10 +11,10 @@ interface CreateAppSignature {
|
|
|
11
11
|
* Setting `companionApp` to `true` is restricted to authorized companion-app provisioning services.
|
|
12
12
|
* A supplied `slug` is ignored except for authorized companion-app provisioning callers; use Generate Slug after creation.
|
|
13
13
|
* A supplied `codeIdentifier` must not contain `wix` (case-insensitive).
|
|
14
|
-
* @param - App to
|
|
15
|
-
* @returns
|
|
14
|
+
* @param - App to create.
|
|
15
|
+
* @returns Created app.
|
|
16
16
|
*/
|
|
17
|
-
(app: V1App): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
|
|
17
|
+
(app: V1App): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `appUrls.postInstallationUrls` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
|
|
18
18
|
}
|
|
19
19
|
declare function getApp$1(httpClient: HttpClient): GetAppSignature;
|
|
20
20
|
interface GetAppSignature {
|
|
@@ -22,10 +22,10 @@ interface GetAppSignature {
|
|
|
22
22
|
* Retrieves an app by ID. App secrets are omitted by default.
|
|
23
23
|
* To include `appSecrets`, add `APP_SECRETS` to `additionalFields`.
|
|
24
24
|
* Retrieving secrets requires authorization to access the app's secrets.
|
|
25
|
-
* @param -
|
|
26
|
-
* @returns
|
|
25
|
+
* @param - App ID.
|
|
26
|
+
* @returns Retrieved app.
|
|
27
27
|
*/
|
|
28
|
-
(appId: string, options?: GetAppOptions): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
|
|
28
|
+
(appId: string, options?: GetAppOptions): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `appUrls.postInstallationUrls` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
|
|
29
29
|
}
|
|
30
30
|
declare function updateApp$1(httpClient: HttpClient): UpdateAppSignature;
|
|
31
31
|
interface UpdateAppSignature {
|
|
@@ -38,16 +38,16 @@ interface UpdateAppSignature {
|
|
|
38
38
|
*
|
|
39
39
|
* This method cannot update `appSecrets`, `accountId`, `namespace`, `slug`, `createdBy`,
|
|
40
40
|
* `companionApp`, or `codeIdentifier`. Including any of these fields or their nested fields in the
|
|
41
|
-
*
|
|
41
|
+
* request causes the entire request to fail; they aren't silently ignored.
|
|
42
42
|
* Use Set Namespace to assign a namespace and Generate Slug to generate a slug. To rotate app
|
|
43
43
|
* secrets, use Create Secondary Secret and Revoke Secret. This method does not support changing
|
|
44
44
|
* the owning account, creator, companion-app designation, or code identifier.
|
|
45
45
|
*
|
|
46
46
|
* Changing `status` requires additional status-change authorization beyond permission to update other fields.
|
|
47
47
|
* @param - App ID.
|
|
48
|
-
* @returns
|
|
48
|
+
* @returns Updated app.
|
|
49
49
|
*/
|
|
50
|
-
(_id: string, app: NonNullablePaths<UpdateApp, `revision`, 0>): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
|
|
50
|
+
(_id: string, app: NonNullablePaths<UpdateApp, `revision`, 0>): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `appUrls.postInstallationUrls` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
|
|
51
51
|
}
|
|
52
52
|
declare function generateSlug$1(httpClient: HttpClient): GenerateSlugSignature;
|
|
53
53
|
interface GenerateSlugSignature {
|
|
@@ -56,9 +56,9 @@ interface GenerateSlugSignature {
|
|
|
56
56
|
* Does not generate a slug for companion apps; a companion app without a slug is returned unchanged.
|
|
57
57
|
* When generating a slug, the stored app name must not contain `wix` for non-Wix apps (case-insensitive).
|
|
58
58
|
* The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
|
|
59
|
-
* @param -
|
|
59
|
+
* @param - App ID.
|
|
60
60
|
*/
|
|
61
|
-
(appId: string): Promise<NonNullablePaths<GenerateSlugResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
|
|
61
|
+
(appId: string): Promise<NonNullablePaths<GenerateSlugResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.appUrls.postInstallationUrls` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
|
|
62
62
|
}
|
|
63
63
|
declare function getNamespaceSuggestion$1(httpClient: HttpClient): GetNamespaceSuggestionSignature;
|
|
64
64
|
interface GetNamespaceSuggestionSignature {
|
|
@@ -69,7 +69,7 @@ interface GetNamespaceSuggestionSignature {
|
|
|
69
69
|
* The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
|
|
70
70
|
* If the base namespace is already used, suggests an alternative with a numeric suffix. Suggestions do not reserve a namespace.
|
|
71
71
|
* Set Namespace derives its own namespace from `appName` without automatically adding a collision suffix. Choose a different `appName` and retry if it conflicts.
|
|
72
|
-
* @param -
|
|
72
|
+
* @param - App ID.
|
|
73
73
|
*/
|
|
74
74
|
(appId: string, options?: GetNamespaceSuggestionOptions): Promise<NonNullablePaths<GetNamespaceSuggestionResponse, `namespace`, 0>>;
|
|
75
75
|
}
|
|
@@ -84,7 +84,7 @@ interface GetNamespaceSuggestionByNameSignature {
|
|
|
84
84
|
* The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
|
|
85
85
|
* If the base namespace is already used, suggests an alternative with a numeric suffix. Suggestions do not reserve a namespace.
|
|
86
86
|
* Set Namespace derives its own namespace from `appName` without automatically adding a collision suffix. Choose a different `appName` and retry if it conflicts.
|
|
87
|
-
* @param -
|
|
87
|
+
* @param - App display name used to derive a namespace suggestion.
|
|
88
88
|
*/
|
|
89
89
|
(name: string, options?: GetNamespaceSuggestionByNameOptions): Promise<NonNullablePaths<GetNamespaceSuggestionByNameResponse, `namespace`, 0>>;
|
|
90
90
|
}
|
|
@@ -97,8 +97,8 @@ interface SetNamespaceSignature {
|
|
|
97
97
|
* The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
|
|
98
98
|
* Unlike namespace suggestions, this method does not automatically add a suffix when the derived namespace is already used.
|
|
99
99
|
* Suggestions are not reservations; on a collision, choose a different `appName` and retry.
|
|
100
|
-
* @param -
|
|
101
|
-
* @param - Name used to derive the app's namespace component
|
|
100
|
+
* @param - App ID.
|
|
101
|
+
* @param - Name used to derive the app's namespace component.
|
|
102
102
|
* Lowercased; runs of non-alphanumeric characters (including spaces and underscores) become hyphens, with leading/trailing separators removed.
|
|
103
103
|
* For example, `Bookings Helper` and `Bookings_Helper` become `bookings-helper`. If no letters or digits remain, uses `untitled`.
|
|
104
104
|
* Subject to the reserved-name restrictions documented on Set Namespace. For permitted Wix-owned apps, `wix` is removed before normalization.
|
|
@@ -112,9 +112,9 @@ interface CreateSecondarySecretSignature {
|
|
|
112
112
|
* (adding one here would break consistent-audience-for-shared-permission across all of them).
|
|
113
113
|
* Renaming the permission would change who is actually authorized, so it stays as-is —
|
|
114
114
|
* the real check is the MANUAL validateUpdateAppPermission(...) in code.
|
|
115
|
-
* @param -
|
|
115
|
+
* @param - App ID.
|
|
116
116
|
*/
|
|
117
|
-
(appId: string, options?: CreateSecondarySecretOptions): Promise<NonNullablePaths<CreateSecondarySecretResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
|
|
117
|
+
(appId: string, options?: CreateSecondarySecretOptions): Promise<NonNullablePaths<CreateSecondarySecretResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.appUrls.postInstallationUrls` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
|
|
118
118
|
}
|
|
119
119
|
declare function revokeSecret$1(httpClient: HttpClient): RevokeSecretSignature;
|
|
120
120
|
interface RevokeSecretSignature {
|
|
@@ -123,8 +123,8 @@ interface RevokeSecretSignature {
|
|
|
123
123
|
* (adding one here would break consistent-audience-for-shared-permission across all of them).
|
|
124
124
|
* Renaming the permission would change who is actually authorized, so it stays as-is —
|
|
125
125
|
* the real check is the MANUAL validateUpdateAppPermission(...) in code.
|
|
126
|
-
* @param -
|
|
127
|
-
* @param -
|
|
126
|
+
* @param - App ID.
|
|
127
|
+
* @param - Credential to revoke. The app must have both a previous and a replacement secret.
|
|
128
128
|
*/
|
|
129
129
|
(appId: string, secretToRevoke: SecretToRevokeWithLiterals): Promise<RevokeSecretResponse>;
|
|
130
130
|
}
|