@wix/auto_sdk_app-management_apps 1.0.4 → 1.0.6
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 +11 -30
- package/build/cjs/index.js +6 -131
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +32 -49
- package/build/cjs/index.typings.js +6 -113
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +18 -18
- package/build/cjs/meta.js +6 -95
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +11 -30
- package/build/es/index.mjs +6 -129
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +32 -49
- package/build/es/index.typings.mjs +6 -111
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +18 -18
- package/build/es/meta.mjs +6 -93
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -30
- package/build/internal/cjs/index.typings.d.ts +38 -50
- package/build/internal/cjs/meta.d.ts +24 -19
- package/build/internal/es/index.d.mts +11 -30
- package/build/internal/es/index.typings.d.mts +38 -50
- package/build/internal/es/meta.d.mts +24 -19
- package/package.json +4 -4
|
@@ -13,6 +13,7 @@ interface V1App {
|
|
|
13
13
|
_id?: string | null;
|
|
14
14
|
/**
|
|
15
15
|
* The display name shown to users and in App Market after publication, separate from the namespace, slug, and code identifier.
|
|
16
|
+
* Apps intended for publication in the Wix App Market should have a name of no more than 30 characters.
|
|
16
17
|
* On creation and update, `<`, `>`, double quotes, and apostrophes are escaped as
|
|
17
18
|
* `<`, `>`, `"`, and `'`. Responses contain the escaped value, which can be longer than the submitted name.
|
|
18
19
|
* @maxLength 50
|
|
@@ -80,7 +81,11 @@ interface V1App {
|
|
|
80
81
|
* @targetRemovalDate 2025-11-01
|
|
81
82
|
*/
|
|
82
83
|
privateApp?: boolean;
|
|
83
|
-
/**
|
|
84
|
+
/**
|
|
85
|
+
* URL settings for Advanced OAuth and post-installation navigation.
|
|
86
|
+
* Using Advanced OAuth through `appUri` and `redirectUris` is highly discouraged.
|
|
87
|
+
* See [Advanced OAuth](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/use-advanced-oauth).
|
|
88
|
+
*/
|
|
84
89
|
appUrls?: AppUrls;
|
|
85
90
|
/**
|
|
86
91
|
* Identity and creation channel of the user or app that created the app, including its source template when applicable.
|
|
@@ -101,7 +106,7 @@ interface V1App {
|
|
|
101
106
|
* @readonly
|
|
102
107
|
*/
|
|
103
108
|
_updatedDate?: Date | null;
|
|
104
|
-
/**
|
|
109
|
+
/** Automatically calculated, event-based tracking of unreleased changes, grouped by type. Updates asynchronously; see each flag for its tracking scope. */
|
|
105
110
|
unreleasedChanges?: UnreleasedChanges;
|
|
106
111
|
/**
|
|
107
112
|
* The ownership tag of the application
|
|
@@ -232,27 +237,30 @@ declare enum AppType {
|
|
|
232
237
|
type AppTypeWithLiterals = AppType | 'SITE_APP' | 'API_KEY' | 'VELO_APP' | 'HEADLESS' | 'FUNCTION_ACTIVATION_APP';
|
|
233
238
|
interface AppUrls {
|
|
234
239
|
/**
|
|
235
|
-
* App URL used to initiate
|
|
240
|
+
* App URL used to initiate Advanced OAuth, whose use is highly discouraged.
|
|
236
241
|
* @format WEB_URL
|
|
237
242
|
*/
|
|
238
243
|
appUri?: string | null;
|
|
239
244
|
/**
|
|
240
|
-
* Allowed redirect URLs for
|
|
245
|
+
* Allowed redirect URLs for Advanced OAuth, whose use is highly discouraged.
|
|
241
246
|
* @format WEB_URL
|
|
242
247
|
* @maxSize 100
|
|
243
248
|
*/
|
|
244
249
|
redirectUris?: string[];
|
|
245
250
|
/**
|
|
246
251
|
* Allowed post-installation URLs, where Wix redirects the user after installing the app from an external install link.
|
|
247
|
-
*
|
|
252
|
+
* The `postInstallationUrl` must match an entry, unless it is a Wix-managed destination allowed separately.
|
|
253
|
+
* URLs are compared after normalizing whitespace and ignoring query strings and fragments.
|
|
254
|
+
* To replace this list without changing other URL settings, use Update App with
|
|
255
|
+
* `appUrls.postInstallationUrls` in the field mask.
|
|
248
256
|
* @format WEB_URL
|
|
249
257
|
* @maxSize 100
|
|
250
258
|
*/
|
|
251
259
|
postInstallationUrls?: string[];
|
|
252
260
|
/**
|
|
253
|
-
*
|
|
261
|
+
* Legacy transition flag. Post-installation URL validation is now always enabled.
|
|
254
262
|
* @internal
|
|
255
|
-
* @deprecated
|
|
263
|
+
* @deprecated Legacy transition flag. Post-installation URL validation is now always enabled.
|
|
256
264
|
* @targetRemovalDate 2026-12-01
|
|
257
265
|
*/
|
|
258
266
|
validatePostInstallationUrl?: boolean | null;
|
|
@@ -644,7 +652,10 @@ interface GetAppRequest {
|
|
|
644
652
|
* @deprecated
|
|
645
653
|
*/
|
|
646
654
|
withSecrets?: boolean;
|
|
647
|
-
/**
|
|
655
|
+
/**
|
|
656
|
+
* Whether to use a consistent read to retrieve the latest stored app data. Default: `false`.
|
|
657
|
+
* @internal
|
|
658
|
+
*/
|
|
648
659
|
consistent?: boolean;
|
|
649
660
|
/**
|
|
650
661
|
* Additional fields to include in the response. Include `APP_SECRETS` to return `app.appSecrets`, which is omitted by default.
|
|
@@ -1156,7 +1167,7 @@ interface CreateSecondarySecretRequest {
|
|
|
1156
1167
|
* App ID.
|
|
1157
1168
|
* @format GUID
|
|
1158
1169
|
*/
|
|
1159
|
-
appId
|
|
1170
|
+
appId?: string;
|
|
1160
1171
|
/** Latest app revision, available from Get App. An outdated revision is rejected. */
|
|
1161
1172
|
revision?: string;
|
|
1162
1173
|
}
|
|
@@ -1202,9 +1213,9 @@ interface RevokeSecretRequest {
|
|
|
1202
1213
|
* App ID.
|
|
1203
1214
|
* @format GUID
|
|
1204
1215
|
*/
|
|
1205
|
-
appId
|
|
1216
|
+
appId?: string;
|
|
1206
1217
|
/** Credential to revoke. The app must have both a previous and a replacement secret. */
|
|
1207
|
-
secretToRevoke
|
|
1218
|
+
secretToRevoke?: SecretToRevokeWithLiterals;
|
|
1208
1219
|
}
|
|
1209
1220
|
/** Credential to revoke during app-secret rotation. */
|
|
1210
1221
|
declare enum SecretToRevoke {
|
|
@@ -1454,8 +1465,6 @@ declare function createApp(app: V1App): Promise<NonNullablePaths<V1App, `name` |
|
|
|
1454
1465
|
*/
|
|
1455
1466
|
declare function getApp(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>>;
|
|
1456
1467
|
interface GetAppOptions {
|
|
1457
|
-
/** Whether to use a consistent read to retrieve the latest stored app data. Default: `false`. */
|
|
1458
|
-
consistent?: boolean;
|
|
1459
1468
|
/**
|
|
1460
1469
|
* Additional fields to include in the response. Include `APP_SECRETS` to return `app.appSecrets`, which is omitted by default.
|
|
1461
1470
|
* Retrieving secrets requires authorization to access the app's secrets.
|
|
@@ -1470,11 +1479,17 @@ interface GetAppOptions {
|
|
|
1470
1479
|
* when updating the app. This ensures you're working with the latest app and prevents unintended overwrites.
|
|
1471
1480
|
* Supports partial updates; specify the app's ID and the fields to change.
|
|
1472
1481
|
*
|
|
1482
|
+
* In REST requests, explicitly set `mask.paths` to only the fields to
|
|
1483
|
+
* change, such as `["name"]`, excluding `id` and `revision`. Supply the app ID in the URL
|
|
1484
|
+
* and the current revision in the request body.
|
|
1485
|
+
* The published SDK's `apps.updateApp()` does not expose a field-mask argument. Use the
|
|
1486
|
+
* SDK-authenticated REST workaround shown in this method's SDK example, which sends an
|
|
1487
|
+
* explicit mask with `fetchWithAuth` from `@wix/sdk/context`.
|
|
1488
|
+
*
|
|
1473
1489
|
* This method cannot update `appSecrets`, `accountId`, `namespace`, `slug`, `createdBy`,
|
|
1474
1490
|
* `companionApp`, or `codeIdentifier`. Including any of these fields or their nested fields in the
|
|
1475
1491
|
* request causes the entire request to fail; they aren't silently ignored.
|
|
1476
|
-
* Use Set Namespace to assign a namespace and Generate Slug to generate a slug.
|
|
1477
|
-
* secrets, use Create Secondary Secret and Revoke Secret. This method does not support changing
|
|
1492
|
+
* Use Set Namespace to assign a namespace and Generate Slug to generate a slug. This method does not support changing
|
|
1478
1493
|
* the owning account, creator, companion-app designation, or code identifier.
|
|
1479
1494
|
*
|
|
1480
1495
|
* Changing `status` requires additional status-change authorization beyond permission to update other fields.
|
|
@@ -1499,6 +1514,7 @@ interface UpdateApp {
|
|
|
1499
1514
|
_id?: string | null;
|
|
1500
1515
|
/**
|
|
1501
1516
|
* The display name shown to users and in App Market after publication, separate from the namespace, slug, and code identifier.
|
|
1517
|
+
* Apps intended for publication in the Wix App Market should have a name of no more than 30 characters.
|
|
1502
1518
|
* On creation and update, `<`, `>`, double quotes, and apostrophes are escaped as
|
|
1503
1519
|
* `<`, `>`, `"`, and `'`. Responses contain the escaped value, which can be longer than the submitted name.
|
|
1504
1520
|
* @maxLength 50
|
|
@@ -1566,7 +1582,11 @@ interface UpdateApp {
|
|
|
1566
1582
|
* @targetRemovalDate 2025-11-01
|
|
1567
1583
|
*/
|
|
1568
1584
|
privateApp?: boolean;
|
|
1569
|
-
/**
|
|
1585
|
+
/**
|
|
1586
|
+
* URL settings for Advanced OAuth and post-installation navigation.
|
|
1587
|
+
* Using Advanced OAuth through `appUri` and `redirectUris` is highly discouraged.
|
|
1588
|
+
* See [Advanced OAuth](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/use-advanced-oauth).
|
|
1589
|
+
*/
|
|
1570
1590
|
appUrls?: AppUrls;
|
|
1571
1591
|
/**
|
|
1572
1592
|
* Identity and creation channel of the user or app that created the app, including its source template when applicable.
|
|
@@ -1587,7 +1607,7 @@ interface UpdateApp {
|
|
|
1587
1607
|
* @readonly
|
|
1588
1608
|
*/
|
|
1589
1609
|
_updatedDate?: Date | null;
|
|
1590
|
-
/**
|
|
1610
|
+
/** Automatically calculated, event-based tracking of unreleased changes, grouped by type. Updates asynchronously; see each flag for its tracking scope. */
|
|
1591
1611
|
unreleasedChanges?: UnreleasedChanges;
|
|
1592
1612
|
/**
|
|
1593
1613
|
* The ownership tag of the application
|
|
@@ -1726,37 +1746,5 @@ interface SetNamespaceOptions {
|
|
|
1726
1746
|
/** Whether to derive the namespace from the owning account or company. Default: `ACCOUNT`. */
|
|
1727
1747
|
type?: NamespaceTypeWithLiterals;
|
|
1728
1748
|
}
|
|
1729
|
-
/**
|
|
1730
|
-
* Shares WIX_DEVELOPERS.MODIFY_APP with the sibling app-write RPCs, which declare no audience
|
|
1731
|
-
* (adding one here would break consistent-audience-for-shared-permission across all of them).
|
|
1732
|
-
* Renaming the permission would change who is actually authorized, so it stays as-is —
|
|
1733
|
-
* the real check is the MANUAL validateUpdateAppPermission(...) in code.
|
|
1734
|
-
* @param appId - App ID.
|
|
1735
|
-
* @public
|
|
1736
|
-
* @documentationMaturity preview
|
|
1737
|
-
* @requiredField appId
|
|
1738
|
-
* @permissionId WIX_DEVELOPERS.MODIFY_APP
|
|
1739
|
-
* @fqn wix.devcenter.apps.v1.AppsService.CreateSecondarySecret
|
|
1740
|
-
*/
|
|
1741
|
-
declare function createSecondarySecret(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>>;
|
|
1742
|
-
interface CreateSecondarySecretOptions {
|
|
1743
|
-
/** Latest app revision, available from Get App. An outdated revision is rejected. */
|
|
1744
|
-
revision?: string;
|
|
1745
|
-
}
|
|
1746
|
-
/**
|
|
1747
|
-
* Shares WIX_DEVELOPERS.MODIFY_APP with the sibling app-write RPCs, which declare no audience
|
|
1748
|
-
* (adding one here would break consistent-audience-for-shared-permission across all of them).
|
|
1749
|
-
* Renaming the permission would change who is actually authorized, so it stays as-is —
|
|
1750
|
-
* the real check is the MANUAL validateUpdateAppPermission(...) in code.
|
|
1751
|
-
* @param appId - App ID.
|
|
1752
|
-
* @param secretToRevoke - Credential to revoke. The app must have both a previous and a replacement secret.
|
|
1753
|
-
* @public
|
|
1754
|
-
* @documentationMaturity preview
|
|
1755
|
-
* @requiredField appId
|
|
1756
|
-
* @requiredField secretToRevoke
|
|
1757
|
-
* @permissionId WIX_DEVELOPERS.MODIFY_APP
|
|
1758
|
-
* @fqn wix.devcenter.apps.v1.AppsService.RevokeSecret
|
|
1759
|
-
*/
|
|
1760
|
-
declare function revokeSecret(appId: string, secretToRevoke: SecretToRevokeWithLiterals): Promise<RevokeSecretResponse>;
|
|
1761
1749
|
|
|
1762
|
-
export { type AccountInfo, Action, type ActionEvent, type ActionWithLiterals, type ActivateSecondarySecretRequest, type ActivateSecondarySecretResponse, type AddressLocation, type App, type AppChangedEvent, type AppComponentMetadata, type AppOwnerChangedEvent, type AppSecrets, type AppSlugChanged, AppType, type AppTypeWithLiterals, type AppUriMessage, type AppUrls, type AppUrlsChangedInOldServiceEvent, type AppUrlsChangedInOldServiceEventChangedUrlOneOf, type AppVersionApproved, type AppVersionArchived, type AppVersionCreated, type AppVersionDeclined, type AppVersionDraftChanged, type AppVersionPublished, type AppVersionReleased, type AppVersionStateChanged, type AppVersionStateChangedStateOneOf, type AppVersionSubmitted, type AssociateServiceAppRequest, type AssociateServiceAppResponse, type CompanionAppOptions, type ConsentOptions, type ContactEmails, type CreateAppRequest, type CreateAppResponse, type
|
|
1750
|
+
export { type AccountInfo, Action, type ActionEvent, type ActionWithLiterals, type ActivateSecondarySecretRequest, type ActivateSecondarySecretResponse, type AddressLocation, type App, type AppChangedEvent, type AppComponentMetadata, type AppOwnerChangedEvent, type AppSecrets, type AppSlugChanged, AppType, type AppTypeWithLiterals, type AppUriMessage, type AppUrls, type AppUrlsChangedInOldServiceEvent, type AppUrlsChangedInOldServiceEventChangedUrlOneOf, type AppVersionApproved, type AppVersionArchived, type AppVersionCreated, type AppVersionDeclined, type AppVersionDraftChanged, type AppVersionPublished, type AppVersionReleased, type AppVersionStateChanged, type AppVersionStateChangedStateOneOf, type AppVersionSubmitted, type AssociateServiceAppRequest, type AssociateServiceAppResponse, type CompanionAppOptions, type ConsentOptions, type ContactEmails, type CreateAppRequest, type CreateAppResponse, type CreateSecondarySecretRequest, type CreateSecondarySecretResponse, type CreateServiceAppRequest, type CreateServiceAppResponse, type CreatedBy, CreatedByType, type CreatedByTypeWithLiterals, type CursorPaging, type Cursors, type DeleteAppRequest, type DeleteAppResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ForceCascadeDeleteAppDecision, type ForceCascadeDeleteAppDecisionWithLiterals, type ForceCascadeDeleteAppRequest, type ForceCascadeDeleteAppResponse, type GenerateSlugRequest, type GenerateSlugResponse, type GetAppOptions, type GetAppRequest, type GetAppResponse, type GetNamespaceSuggestionByNameOptions, type GetNamespaceSuggestionByNameRequest, type GetNamespaceSuggestionByNameResponse, type GetNamespaceSuggestionOptions, type GetNamespaceSuggestionRequest, type GetNamespaceSuggestionResponse, type HostAppConfig, type IdentificationData, type IdentificationDataIdOneOf, type InstallationPreferences, type InstallationPreferencesOpenButtonOptionsOneOf, LoginPolicy, type LoginPolicyWithLiterals, type MessageEnvelope, NamespaceType, type NamespaceTypeWithLiterals, OpenButtonAction, type OpenButtonActionWithLiterals, type OpenComponentId, type Paging, type PagingMetadataV2, type PartialVersionOptions, PermissionLevel, type PermissionLevelWithLiterals, type QueryAppRequest, type QueryAppResponse, type QueryV2, type QueryV2PagingMethodOneOf, RedirectTarget, type RedirectTargetWithLiterals, type RedirectUrlMessage, type RenameCodeIdentifierRequest, type RenameCodeIdentifierResponse, type RenameSlugRequest, type RenameSlugResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RevokeSecretRequest, type RevokeSecretResponse, type RollbackSecretRequest, type RollbackSecretResponse, type RotateSecretRequest, type RotateSecretResponse, SecretToRevoke, type SecretToRevokeWithLiterals, type SetAppOwnerRequest, type SetAppOwnerResponse, type SetCacheableAppRequest, type SetCacheableAppResponse, type SetCodeIdentifierRequest, type SetCodeIdentifierResponse, type SetCompanionAppOptionsRequest, type SetCompanionAppOptionsResponse, type SetComponentsMetadataRequest, type SetComponentsMetadataResponse, type SetExceededSizeRequest, type SetExceededSizeResponse, type SetHipaaCompliantRequest, type SetHipaaCompliantResponse, type SetNamespaceOptions, type SetNamespaceRequest, type SetNamespaceResponse, type SetOwnershipTagRequest, type SetOwnershipTagResponse, type SetPrivateAppRequest, type SetPrivateAppResponse, ShowConsentBehaviour, type ShowConsentBehaviourWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type SuggestCodeIdentifierRequest, type SuggestCodeIdentifierResponse, TenantType, type TenantTypeWithLiterals, UninstallActions, type UninstallActionsWithLiterals, type UnreleasedChanges, type UpdateApp, type UpdateAppRequest, type UpdateAppResponse, type UpdateHostAppConfigRequest, type UpdateHostAppConfigResponse, type V1App, VersionStatus, type VersionStatusWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createApp, generateSlug, getApp, getNamespaceSuggestion, getNamespaceSuggestionByName, setNamespace, updateApp };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CreateAppRequest as CreateAppRequest$1, CreateAppResponse as CreateAppResponse$1, GetAppRequest as GetAppRequest$1, GetAppResponse as GetAppResponse$1, UpdateAppRequest as UpdateAppRequest$1, UpdateAppResponse as UpdateAppResponse$1, GenerateSlugRequest as GenerateSlugRequest$1, GenerateSlugResponse as GenerateSlugResponse$1, GetNamespaceSuggestionRequest as GetNamespaceSuggestionRequest$1, GetNamespaceSuggestionResponse as GetNamespaceSuggestionResponse$1, GetNamespaceSuggestionByNameRequest as GetNamespaceSuggestionByNameRequest$1, GetNamespaceSuggestionByNameResponse as GetNamespaceSuggestionByNameResponse$1, SetNamespaceRequest as SetNamespaceRequest$1, SetNamespaceResponse as SetNamespaceResponse$1
|
|
1
|
+
import { CreateAppRequest as CreateAppRequest$1, CreateAppResponse as CreateAppResponse$1, GetAppRequest as GetAppRequest$1, GetAppResponse as GetAppResponse$1, UpdateAppRequest as UpdateAppRequest$1, UpdateAppResponse as UpdateAppResponse$1, GenerateSlugRequest as GenerateSlugRequest$1, GenerateSlugResponse as GenerateSlugResponse$1, GetNamespaceSuggestionRequest as GetNamespaceSuggestionRequest$1, GetNamespaceSuggestionResponse as GetNamespaceSuggestionResponse$1, GetNamespaceSuggestionByNameRequest as GetNamespaceSuggestionByNameRequest$1, GetNamespaceSuggestionByNameResponse as GetNamespaceSuggestionByNameResponse$1, SetNamespaceRequest as SetNamespaceRequest$1, SetNamespaceResponse as SetNamespaceResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -14,6 +14,7 @@ interface V1App {
|
|
|
14
14
|
id?: string | null;
|
|
15
15
|
/**
|
|
16
16
|
* The display name shown to users and in App Market after publication, separate from the namespace, slug, and code identifier.
|
|
17
|
+
* Apps intended for publication in the Wix App Market should have a name of no more than 30 characters.
|
|
17
18
|
* On creation and update, `<`, `>`, double quotes, and apostrophes are escaped as
|
|
18
19
|
* `<`, `>`, `"`, and `'`. Responses contain the escaped value, which can be longer than the submitted name.
|
|
19
20
|
* @maxLength 50
|
|
@@ -81,7 +82,11 @@ interface V1App {
|
|
|
81
82
|
* @targetRemovalDate 2025-11-01
|
|
82
83
|
*/
|
|
83
84
|
privateApp?: boolean;
|
|
84
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* URL settings for Advanced OAuth and post-installation navigation.
|
|
87
|
+
* Using Advanced OAuth through `appUri` and `redirectUris` is highly discouraged.
|
|
88
|
+
* See [Advanced OAuth](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/use-advanced-oauth).
|
|
89
|
+
*/
|
|
85
90
|
appUrls?: AppUrls;
|
|
86
91
|
/**
|
|
87
92
|
* Identity and creation channel of the user or app that created the app, including its source template when applicable.
|
|
@@ -102,7 +107,7 @@ interface V1App {
|
|
|
102
107
|
* @readonly
|
|
103
108
|
*/
|
|
104
109
|
updatedDate?: Date | null;
|
|
105
|
-
/**
|
|
110
|
+
/** Automatically calculated, event-based tracking of unreleased changes, grouped by type. Updates asynchronously; see each flag for its tracking scope. */
|
|
106
111
|
unreleasedChanges?: UnreleasedChanges;
|
|
107
112
|
/**
|
|
108
113
|
* The ownership tag of the application
|
|
@@ -233,27 +238,30 @@ declare enum AppType {
|
|
|
233
238
|
type AppTypeWithLiterals = AppType | 'SITE_APP' | 'API_KEY' | 'VELO_APP' | 'HEADLESS' | 'FUNCTION_ACTIVATION_APP';
|
|
234
239
|
interface AppUrls {
|
|
235
240
|
/**
|
|
236
|
-
* App URL used to initiate
|
|
241
|
+
* App URL used to initiate Advanced OAuth, whose use is highly discouraged.
|
|
237
242
|
* @format WEB_URL
|
|
238
243
|
*/
|
|
239
244
|
appUri?: string | null;
|
|
240
245
|
/**
|
|
241
|
-
* Allowed redirect URLs for
|
|
246
|
+
* Allowed redirect URLs for Advanced OAuth, whose use is highly discouraged.
|
|
242
247
|
* @format WEB_URL
|
|
243
248
|
* @maxSize 100
|
|
244
249
|
*/
|
|
245
250
|
redirectUris?: string[];
|
|
246
251
|
/**
|
|
247
252
|
* Allowed post-installation URLs, where Wix redirects the user after installing the app from an external install link.
|
|
248
|
-
*
|
|
253
|
+
* The `postInstallationUrl` must match an entry, unless it is a Wix-managed destination allowed separately.
|
|
254
|
+
* URLs are compared after normalizing whitespace and ignoring query strings and fragments.
|
|
255
|
+
* To replace this list without changing other URL settings, use Update App with
|
|
256
|
+
* `appUrls.postInstallationUrls` in the field mask.
|
|
249
257
|
* @format WEB_URL
|
|
250
258
|
* @maxSize 100
|
|
251
259
|
*/
|
|
252
260
|
postInstallationUrls?: string[];
|
|
253
261
|
/**
|
|
254
|
-
*
|
|
262
|
+
* Legacy transition flag. Post-installation URL validation is now always enabled.
|
|
255
263
|
* @internal
|
|
256
|
-
* @deprecated
|
|
264
|
+
* @deprecated Legacy transition flag. Post-installation URL validation is now always enabled.
|
|
257
265
|
* @targetRemovalDate 2026-12-01
|
|
258
266
|
*/
|
|
259
267
|
validatePostInstallationUrl?: boolean | null;
|
|
@@ -689,7 +697,10 @@ interface GetAppRequest {
|
|
|
689
697
|
* @deprecated
|
|
690
698
|
*/
|
|
691
699
|
withSecrets?: boolean;
|
|
692
|
-
/**
|
|
700
|
+
/**
|
|
701
|
+
* Whether to use a consistent read to retrieve the latest stored app data. Default: `false`.
|
|
702
|
+
* @internal
|
|
703
|
+
*/
|
|
693
704
|
consistent?: boolean;
|
|
694
705
|
/**
|
|
695
706
|
* Additional fields to include in the response. Include `APP_SECRETS` to return `app.appSecrets`, which is omitted by default.
|
|
@@ -1201,7 +1212,7 @@ interface CreateSecondarySecretRequest {
|
|
|
1201
1212
|
* App ID.
|
|
1202
1213
|
* @format GUID
|
|
1203
1214
|
*/
|
|
1204
|
-
appId
|
|
1215
|
+
appId?: string;
|
|
1205
1216
|
/** Latest app revision, available from Get App. An outdated revision is rejected. */
|
|
1206
1217
|
revision?: string;
|
|
1207
1218
|
}
|
|
@@ -1247,9 +1258,9 @@ interface RevokeSecretRequest {
|
|
|
1247
1258
|
* App ID.
|
|
1248
1259
|
* @format GUID
|
|
1249
1260
|
*/
|
|
1250
|
-
appId
|
|
1261
|
+
appId?: string;
|
|
1251
1262
|
/** Credential to revoke. The app must have both a previous and a replacement secret. */
|
|
1252
|
-
secretToRevoke
|
|
1263
|
+
secretToRevoke?: SecretToRevokeWithLiterals;
|
|
1253
1264
|
}
|
|
1254
1265
|
/** Credential to revoke during app-secret rotation. */
|
|
1255
1266
|
declare enum SecretToRevoke {
|
|
@@ -1495,11 +1506,5 @@ declare function getNamespaceSuggestionByName(): __PublicMethodMetaInfo<'GET', {
|
|
|
1495
1506
|
declare function setNamespace(): __PublicMethodMetaInfo<'PATCH', {
|
|
1496
1507
|
appId: string;
|
|
1497
1508
|
}, SetNamespaceRequest$1, SetNamespaceRequest, SetNamespaceResponse$1, SetNamespaceResponse>;
|
|
1498
|
-
declare function createSecondarySecret(): __PublicMethodMetaInfo<'POST', {
|
|
1499
|
-
appId: string;
|
|
1500
|
-
}, CreateSecondarySecretRequest$1, CreateSecondarySecretRequest, CreateSecondarySecretResponse$1, CreateSecondarySecretResponse>;
|
|
1501
|
-
declare function revokeSecret(): __PublicMethodMetaInfo<'POST', {
|
|
1502
|
-
appId: string;
|
|
1503
|
-
}, RevokeSecretRequest$1, RevokeSecretRequest, RevokeSecretResponse$1, RevokeSecretResponse>;
|
|
1504
1509
|
|
|
1505
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, type ActivateSecondarySecretRequest as ActivateSecondarySecretRequestOriginal, type ActivateSecondarySecretResponse as ActivateSecondarySecretResponseOriginal, type AddressLocation as AddressLocationOriginal, type AppChangedEvent as AppChangedEventOriginal, type AppComponentMetadata as AppComponentMetadataOriginal, type App as AppOriginal, type AppOwnerChangedEvent as AppOwnerChangedEventOriginal, type AppSecrets as AppSecretsOriginal, type AppSlugChanged as AppSlugChangedOriginal, AppType as AppTypeOriginal, type AppTypeWithLiterals as AppTypeWithLiteralsOriginal, type AppUriMessage as AppUriMessageOriginal, type AppUrlsChangedInOldServiceEventChangedUrlOneOf as AppUrlsChangedInOldServiceEventChangedUrlOneOfOriginal, type AppUrlsChangedInOldServiceEvent as AppUrlsChangedInOldServiceEventOriginal, type AppUrls as AppUrlsOriginal, type AppVersionApproved as AppVersionApprovedOriginal, type AppVersionArchived as AppVersionArchivedOriginal, type AppVersionCreated as AppVersionCreatedOriginal, type AppVersionDeclined as AppVersionDeclinedOriginal, type AppVersionDraftChanged as AppVersionDraftChangedOriginal, type AppVersionPublished as AppVersionPublishedOriginal, type AppVersionReleased as AppVersionReleasedOriginal, type AppVersionStateChanged as AppVersionStateChangedOriginal, type AppVersionStateChangedStateOneOf as AppVersionStateChangedStateOneOfOriginal, type AppVersionSubmitted as AppVersionSubmittedOriginal, type AssociateServiceAppRequest as AssociateServiceAppRequestOriginal, type AssociateServiceAppResponse as AssociateServiceAppResponseOriginal, type CompanionAppOptions as CompanionAppOptionsOriginal, type ConsentOptions as ConsentOptionsOriginal, type ContactEmails as ContactEmailsOriginal, type CreateAppRequest as CreateAppRequestOriginal, type CreateAppResponse as CreateAppResponseOriginal, type CreateSecondarySecretRequest as CreateSecondarySecretRequestOriginal, type CreateSecondarySecretResponse as CreateSecondarySecretResponseOriginal, type CreateServiceAppRequest as CreateServiceAppRequestOriginal, type CreateServiceAppResponse as CreateServiceAppResponseOriginal, type CreatedBy as CreatedByOriginal, CreatedByType as CreatedByTypeOriginal, type CreatedByTypeWithLiterals as CreatedByTypeWithLiteralsOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteAppRequest as DeleteAppRequestOriginal, type DeleteAppResponse as DeleteAppResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, ForceCascadeDeleteAppDecision as ForceCascadeDeleteAppDecisionOriginal, type ForceCascadeDeleteAppDecisionWithLiterals as ForceCascadeDeleteAppDecisionWithLiteralsOriginal, type ForceCascadeDeleteAppRequest as ForceCascadeDeleteAppRequestOriginal, type ForceCascadeDeleteAppResponse as ForceCascadeDeleteAppResponseOriginal, type GenerateSlugRequest as GenerateSlugRequestOriginal, type GenerateSlugResponse as GenerateSlugResponseOriginal, type GetAppRequest as GetAppRequestOriginal, type GetAppResponse as GetAppResponseOriginal, type GetNamespaceSuggestionByNameRequest as GetNamespaceSuggestionByNameRequestOriginal, type GetNamespaceSuggestionByNameResponse as GetNamespaceSuggestionByNameResponseOriginal, type GetNamespaceSuggestionRequest as GetNamespaceSuggestionRequestOriginal, type GetNamespaceSuggestionResponse as GetNamespaceSuggestionResponseOriginal, type HostAppConfig as HostAppConfigOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InstallationPreferencesOpenButtonOptionsOneOf as InstallationPreferencesOpenButtonOptionsOneOfOriginal, type InstallationPreferences as InstallationPreferencesOriginal, LoginPolicy as LoginPolicyOriginal, type LoginPolicyWithLiterals as LoginPolicyWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, NamespaceType as NamespaceTypeOriginal, type NamespaceTypeWithLiterals as NamespaceTypeWithLiteralsOriginal, OpenButtonAction as OpenButtonActionOriginal, type OpenButtonActionWithLiterals as OpenButtonActionWithLiteralsOriginal, type OpenComponentId as OpenComponentIdOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PartialVersionOptions as PartialVersionOptionsOriginal, PermissionLevel as PermissionLevelOriginal, type PermissionLevelWithLiterals as PermissionLevelWithLiteralsOriginal, type QueryAppRequest as QueryAppRequestOriginal, type QueryAppResponse as QueryAppResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, RedirectTarget as RedirectTargetOriginal, type RedirectTargetWithLiterals as RedirectTargetWithLiteralsOriginal, type RedirectUrlMessage as RedirectUrlMessageOriginal, type RenameCodeIdentifierRequest as RenameCodeIdentifierRequestOriginal, type RenameCodeIdentifierResponse as RenameCodeIdentifierResponseOriginal, type RenameSlugRequest as RenameSlugRequestOriginal, type RenameSlugResponse as RenameSlugResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RevokeSecretRequest as RevokeSecretRequestOriginal, type RevokeSecretResponse as RevokeSecretResponseOriginal, type RollbackSecretRequest as RollbackSecretRequestOriginal, type RollbackSecretResponse as RollbackSecretResponseOriginal, type RotateSecretRequest as RotateSecretRequestOriginal, type RotateSecretResponse as RotateSecretResponseOriginal, SecretToRevoke as SecretToRevokeOriginal, type SecretToRevokeWithLiterals as SecretToRevokeWithLiteralsOriginal, type SetAppOwnerRequest as SetAppOwnerRequestOriginal, type SetAppOwnerResponse as SetAppOwnerResponseOriginal, type SetCacheableAppRequest as SetCacheableAppRequestOriginal, type SetCacheableAppResponse as SetCacheableAppResponseOriginal, type SetCodeIdentifierRequest as SetCodeIdentifierRequestOriginal, type SetCodeIdentifierResponse as SetCodeIdentifierResponseOriginal, type SetCompanionAppOptionsRequest as SetCompanionAppOptionsRequestOriginal, type SetCompanionAppOptionsResponse as SetCompanionAppOptionsResponseOriginal, type SetComponentsMetadataRequest as SetComponentsMetadataRequestOriginal, type SetComponentsMetadataResponse as SetComponentsMetadataResponseOriginal, type SetExceededSizeRequest as SetExceededSizeRequestOriginal, type SetExceededSizeResponse as SetExceededSizeResponseOriginal, type SetHipaaCompliantRequest as SetHipaaCompliantRequestOriginal, type SetHipaaCompliantResponse as SetHipaaCompliantResponseOriginal, type SetNamespaceRequest as SetNamespaceRequestOriginal, type SetNamespaceResponse as SetNamespaceResponseOriginal, type SetOwnershipTagRequest as SetOwnershipTagRequestOriginal, type SetOwnershipTagResponse as SetOwnershipTagResponseOriginal, type SetPrivateAppRequest as SetPrivateAppRequestOriginal, type SetPrivateAppResponse as SetPrivateAppResponseOriginal, ShowConsentBehaviour as ShowConsentBehaviourOriginal, type ShowConsentBehaviourWithLiterals as ShowConsentBehaviourWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type SuggestCodeIdentifierRequest as SuggestCodeIdentifierRequestOriginal, type SuggestCodeIdentifierResponse as SuggestCodeIdentifierResponseOriginal, TenantType as TenantTypeOriginal, type TenantTypeWithLiterals as TenantTypeWithLiteralsOriginal, UninstallActions as UninstallActionsOriginal, type UninstallActionsWithLiterals as UninstallActionsWithLiteralsOriginal, type UnreleasedChanges as UnreleasedChangesOriginal, type UpdateAppRequest as UpdateAppRequestOriginal, type UpdateAppResponse as UpdateAppResponseOriginal, type UpdateHostAppConfigRequest as UpdateHostAppConfigRequestOriginal, type UpdateHostAppConfigResponse as UpdateHostAppConfigResponseOriginal, type V1App as V1AppOriginal, VersionStatus as VersionStatusOriginal, type VersionStatusWithLiterals as VersionStatusWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createApp,
|
|
1510
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, type ActivateSecondarySecretRequest as ActivateSecondarySecretRequestOriginal, type ActivateSecondarySecretResponse as ActivateSecondarySecretResponseOriginal, type AddressLocation as AddressLocationOriginal, type AppChangedEvent as AppChangedEventOriginal, type AppComponentMetadata as AppComponentMetadataOriginal, type App as AppOriginal, type AppOwnerChangedEvent as AppOwnerChangedEventOriginal, type AppSecrets as AppSecretsOriginal, type AppSlugChanged as AppSlugChangedOriginal, AppType as AppTypeOriginal, type AppTypeWithLiterals as AppTypeWithLiteralsOriginal, type AppUriMessage as AppUriMessageOriginal, type AppUrlsChangedInOldServiceEventChangedUrlOneOf as AppUrlsChangedInOldServiceEventChangedUrlOneOfOriginal, type AppUrlsChangedInOldServiceEvent as AppUrlsChangedInOldServiceEventOriginal, type AppUrls as AppUrlsOriginal, type AppVersionApproved as AppVersionApprovedOriginal, type AppVersionArchived as AppVersionArchivedOriginal, type AppVersionCreated as AppVersionCreatedOriginal, type AppVersionDeclined as AppVersionDeclinedOriginal, type AppVersionDraftChanged as AppVersionDraftChangedOriginal, type AppVersionPublished as AppVersionPublishedOriginal, type AppVersionReleased as AppVersionReleasedOriginal, type AppVersionStateChanged as AppVersionStateChangedOriginal, type AppVersionStateChangedStateOneOf as AppVersionStateChangedStateOneOfOriginal, type AppVersionSubmitted as AppVersionSubmittedOriginal, type AssociateServiceAppRequest as AssociateServiceAppRequestOriginal, type AssociateServiceAppResponse as AssociateServiceAppResponseOriginal, type CompanionAppOptions as CompanionAppOptionsOriginal, type ConsentOptions as ConsentOptionsOriginal, type ContactEmails as ContactEmailsOriginal, type CreateAppRequest as CreateAppRequestOriginal, type CreateAppResponse as CreateAppResponseOriginal, type CreateSecondarySecretRequest as CreateSecondarySecretRequestOriginal, type CreateSecondarySecretResponse as CreateSecondarySecretResponseOriginal, type CreateServiceAppRequest as CreateServiceAppRequestOriginal, type CreateServiceAppResponse as CreateServiceAppResponseOriginal, type CreatedBy as CreatedByOriginal, CreatedByType as CreatedByTypeOriginal, type CreatedByTypeWithLiterals as CreatedByTypeWithLiteralsOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteAppRequest as DeleteAppRequestOriginal, type DeleteAppResponse as DeleteAppResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, ForceCascadeDeleteAppDecision as ForceCascadeDeleteAppDecisionOriginal, type ForceCascadeDeleteAppDecisionWithLiterals as ForceCascadeDeleteAppDecisionWithLiteralsOriginal, type ForceCascadeDeleteAppRequest as ForceCascadeDeleteAppRequestOriginal, type ForceCascadeDeleteAppResponse as ForceCascadeDeleteAppResponseOriginal, type GenerateSlugRequest as GenerateSlugRequestOriginal, type GenerateSlugResponse as GenerateSlugResponseOriginal, type GetAppRequest as GetAppRequestOriginal, type GetAppResponse as GetAppResponseOriginal, type GetNamespaceSuggestionByNameRequest as GetNamespaceSuggestionByNameRequestOriginal, type GetNamespaceSuggestionByNameResponse as GetNamespaceSuggestionByNameResponseOriginal, type GetNamespaceSuggestionRequest as GetNamespaceSuggestionRequestOriginal, type GetNamespaceSuggestionResponse as GetNamespaceSuggestionResponseOriginal, type HostAppConfig as HostAppConfigOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InstallationPreferencesOpenButtonOptionsOneOf as InstallationPreferencesOpenButtonOptionsOneOfOriginal, type InstallationPreferences as InstallationPreferencesOriginal, LoginPolicy as LoginPolicyOriginal, type LoginPolicyWithLiterals as LoginPolicyWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, NamespaceType as NamespaceTypeOriginal, type NamespaceTypeWithLiterals as NamespaceTypeWithLiteralsOriginal, OpenButtonAction as OpenButtonActionOriginal, type OpenButtonActionWithLiterals as OpenButtonActionWithLiteralsOriginal, type OpenComponentId as OpenComponentIdOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PartialVersionOptions as PartialVersionOptionsOriginal, PermissionLevel as PermissionLevelOriginal, type PermissionLevelWithLiterals as PermissionLevelWithLiteralsOriginal, type QueryAppRequest as QueryAppRequestOriginal, type QueryAppResponse as QueryAppResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, RedirectTarget as RedirectTargetOriginal, type RedirectTargetWithLiterals as RedirectTargetWithLiteralsOriginal, type RedirectUrlMessage as RedirectUrlMessageOriginal, type RenameCodeIdentifierRequest as RenameCodeIdentifierRequestOriginal, type RenameCodeIdentifierResponse as RenameCodeIdentifierResponseOriginal, type RenameSlugRequest as RenameSlugRequestOriginal, type RenameSlugResponse as RenameSlugResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RevokeSecretRequest as RevokeSecretRequestOriginal, type RevokeSecretResponse as RevokeSecretResponseOriginal, type RollbackSecretRequest as RollbackSecretRequestOriginal, type RollbackSecretResponse as RollbackSecretResponseOriginal, type RotateSecretRequest as RotateSecretRequestOriginal, type RotateSecretResponse as RotateSecretResponseOriginal, SecretToRevoke as SecretToRevokeOriginal, type SecretToRevokeWithLiterals as SecretToRevokeWithLiteralsOriginal, type SetAppOwnerRequest as SetAppOwnerRequestOriginal, type SetAppOwnerResponse as SetAppOwnerResponseOriginal, type SetCacheableAppRequest as SetCacheableAppRequestOriginal, type SetCacheableAppResponse as SetCacheableAppResponseOriginal, type SetCodeIdentifierRequest as SetCodeIdentifierRequestOriginal, type SetCodeIdentifierResponse as SetCodeIdentifierResponseOriginal, type SetCompanionAppOptionsRequest as SetCompanionAppOptionsRequestOriginal, type SetCompanionAppOptionsResponse as SetCompanionAppOptionsResponseOriginal, type SetComponentsMetadataRequest as SetComponentsMetadataRequestOriginal, type SetComponentsMetadataResponse as SetComponentsMetadataResponseOriginal, type SetExceededSizeRequest as SetExceededSizeRequestOriginal, type SetExceededSizeResponse as SetExceededSizeResponseOriginal, type SetHipaaCompliantRequest as SetHipaaCompliantRequestOriginal, type SetHipaaCompliantResponse as SetHipaaCompliantResponseOriginal, type SetNamespaceRequest as SetNamespaceRequestOriginal, type SetNamespaceResponse as SetNamespaceResponseOriginal, type SetOwnershipTagRequest as SetOwnershipTagRequestOriginal, type SetOwnershipTagResponse as SetOwnershipTagResponseOriginal, type SetPrivateAppRequest as SetPrivateAppRequestOriginal, type SetPrivateAppResponse as SetPrivateAppResponseOriginal, ShowConsentBehaviour as ShowConsentBehaviourOriginal, type ShowConsentBehaviourWithLiterals as ShowConsentBehaviourWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type SuggestCodeIdentifierRequest as SuggestCodeIdentifierRequestOriginal, type SuggestCodeIdentifierResponse as SuggestCodeIdentifierResponseOriginal, TenantType as TenantTypeOriginal, type TenantTypeWithLiterals as TenantTypeWithLiteralsOriginal, UninstallActions as UninstallActionsOriginal, type UninstallActionsWithLiterals as UninstallActionsWithLiteralsOriginal, type UnreleasedChanges as UnreleasedChangesOriginal, type UpdateAppRequest as UpdateAppRequestOriginal, type UpdateAppResponse as UpdateAppResponseOriginal, type UpdateHostAppConfigRequest as UpdateHostAppConfigRequestOriginal, type UpdateHostAppConfigResponse as UpdateHostAppConfigResponseOriginal, type V1App as V1AppOriginal, VersionStatus as VersionStatusOriginal, type VersionStatusWithLiterals as VersionStatusWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createApp, generateSlug, getApp, getNamespaceSuggestion, getNamespaceSuggestionByName, setNamespace, updateApp };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { V1App, GetAppOptions, UpdateApp, GenerateSlugResponse, GetNamespaceSuggestionOptions, GetNamespaceSuggestionResponse, GetNamespaceSuggestionByNameOptions, GetNamespaceSuggestionByNameResponse, SetNamespaceOptions, SetNamespaceResponse
|
|
3
|
-
export { AccountInfo, Action, ActionEvent, ActionWithLiterals, ActivateSecondarySecretRequest, ActivateSecondarySecretResponse, AddressLocation, App, AppChangedEvent, AppComponentMetadata, AppOwnerChangedEvent, AppSecrets, AppSlugChanged, AppType, AppTypeWithLiterals, AppUriMessage, AppUrls, AppUrlsChangedInOldServiceEvent, AppUrlsChangedInOldServiceEventChangedUrlOneOf, AppVersionApproved, AppVersionArchived, AppVersionCreated, AppVersionDeclined, AppVersionDraftChanged, AppVersionPublished, AppVersionReleased, AppVersionStateChanged, AppVersionStateChangedStateOneOf, AppVersionSubmitted, AssociateServiceAppRequest, AssociateServiceAppResponse, CompanionAppOptions, ConsentOptions, ContactEmails, CreateAppRequest, CreateAppResponse, CreateSecondarySecretRequest, CreateServiceAppRequest, CreateServiceAppResponse, CreatedBy, CreatedByType, CreatedByTypeWithLiterals, CursorPaging, Cursors, DeleteAppRequest, DeleteAppResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ForceCascadeDeleteAppDecision, ForceCascadeDeleteAppDecisionWithLiterals, ForceCascadeDeleteAppRequest, ForceCascadeDeleteAppResponse, GenerateSlugRequest, GetAppRequest, GetAppResponse, GetNamespaceSuggestionByNameRequest, GetNamespaceSuggestionRequest, HostAppConfig, IdentificationData, IdentificationDataIdOneOf, InstallationPreferences, InstallationPreferencesOpenButtonOptionsOneOf, LoginPolicy, LoginPolicyWithLiterals, MessageEnvelope, NamespaceType, NamespaceTypeWithLiterals, OpenButtonAction, OpenButtonActionWithLiterals, OpenComponentId, Paging, PagingMetadataV2, PartialVersionOptions, PermissionLevel, PermissionLevelWithLiterals, QueryAppRequest, QueryAppResponse, QueryV2, QueryV2PagingMethodOneOf, RedirectTarget, RedirectTargetWithLiterals, RedirectUrlMessage, RenameCodeIdentifierRequest, RenameCodeIdentifierResponse, RenameSlugRequest, RenameSlugResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RevokeSecretRequest, RollbackSecretRequest, RollbackSecretResponse, RotateSecretRequest, RotateSecretResponse, SecretToRevoke, SetAppOwnerRequest, SetAppOwnerResponse, SetCacheableAppRequest, SetCacheableAppResponse, SetCodeIdentifierRequest, SetCodeIdentifierResponse, SetCompanionAppOptionsRequest, SetCompanionAppOptionsResponse, SetComponentsMetadataRequest, SetComponentsMetadataResponse, SetExceededSizeRequest, SetExceededSizeResponse, SetHipaaCompliantRequest, SetHipaaCompliantResponse, SetNamespaceRequest, SetOwnershipTagRequest, SetOwnershipTagResponse, SetPrivateAppRequest, SetPrivateAppResponse, ShowConsentBehaviour, ShowConsentBehaviourWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, SuggestCodeIdentifierRequest, SuggestCodeIdentifierResponse, TenantType, TenantTypeWithLiterals, UninstallActions, UninstallActionsWithLiterals, UnreleasedChanges, UpdateAppRequest, UpdateAppResponse, UpdateHostAppConfigRequest, UpdateHostAppConfigResponse, VersionStatus, VersionStatusWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
|
|
2
|
+
import { V1App, GetAppOptions, UpdateApp, GenerateSlugResponse, GetNamespaceSuggestionOptions, GetNamespaceSuggestionResponse, GetNamespaceSuggestionByNameOptions, GetNamespaceSuggestionByNameResponse, SetNamespaceOptions, SetNamespaceResponse } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, Action, ActionEvent, ActionWithLiterals, ActivateSecondarySecretRequest, ActivateSecondarySecretResponse, AddressLocation, App, AppChangedEvent, AppComponentMetadata, AppOwnerChangedEvent, AppSecrets, AppSlugChanged, AppType, AppTypeWithLiterals, AppUriMessage, AppUrls, AppUrlsChangedInOldServiceEvent, AppUrlsChangedInOldServiceEventChangedUrlOneOf, AppVersionApproved, AppVersionArchived, AppVersionCreated, AppVersionDeclined, AppVersionDraftChanged, AppVersionPublished, AppVersionReleased, AppVersionStateChanged, AppVersionStateChangedStateOneOf, AppVersionSubmitted, AssociateServiceAppRequest, AssociateServiceAppResponse, CompanionAppOptions, ConsentOptions, ContactEmails, CreateAppRequest, CreateAppResponse, CreateSecondarySecretRequest, CreateSecondarySecretResponse, CreateServiceAppRequest, CreateServiceAppResponse, CreatedBy, CreatedByType, CreatedByTypeWithLiterals, CursorPaging, Cursors, DeleteAppRequest, DeleteAppResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ForceCascadeDeleteAppDecision, ForceCascadeDeleteAppDecisionWithLiterals, ForceCascadeDeleteAppRequest, ForceCascadeDeleteAppResponse, GenerateSlugRequest, GetAppRequest, GetAppResponse, GetNamespaceSuggestionByNameRequest, GetNamespaceSuggestionRequest, HostAppConfig, IdentificationData, IdentificationDataIdOneOf, InstallationPreferences, InstallationPreferencesOpenButtonOptionsOneOf, LoginPolicy, LoginPolicyWithLiterals, MessageEnvelope, NamespaceType, NamespaceTypeWithLiterals, OpenButtonAction, OpenButtonActionWithLiterals, OpenComponentId, Paging, PagingMetadataV2, PartialVersionOptions, PermissionLevel, PermissionLevelWithLiterals, QueryAppRequest, QueryAppResponse, QueryV2, QueryV2PagingMethodOneOf, RedirectTarget, RedirectTargetWithLiterals, RedirectUrlMessage, RenameCodeIdentifierRequest, RenameCodeIdentifierResponse, RenameSlugRequest, RenameSlugResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RevokeSecretRequest, RevokeSecretResponse, RollbackSecretRequest, RollbackSecretResponse, RotateSecretRequest, RotateSecretResponse, SecretToRevoke, SecretToRevokeWithLiterals, SetAppOwnerRequest, SetAppOwnerResponse, SetCacheableAppRequest, SetCacheableAppResponse, SetCodeIdentifierRequest, SetCodeIdentifierResponse, SetCompanionAppOptionsRequest, SetCompanionAppOptionsResponse, SetComponentsMetadataRequest, SetComponentsMetadataResponse, SetExceededSizeRequest, SetExceededSizeResponse, SetHipaaCompliantRequest, SetHipaaCompliantResponse, SetNamespaceRequest, SetOwnershipTagRequest, SetOwnershipTagResponse, SetPrivateAppRequest, SetPrivateAppResponse, ShowConsentBehaviour, ShowConsentBehaviourWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, SuggestCodeIdentifierRequest, SuggestCodeIdentifierResponse, TenantType, TenantTypeWithLiterals, UninstallActions, UninstallActionsWithLiterals, UnreleasedChanges, UpdateAppRequest, UpdateAppResponse, UpdateHostAppConfigRequest, UpdateHostAppConfigResponse, VersionStatus, VersionStatusWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createApp$1(httpClient: HttpClient): CreateAppSignature;
|
|
6
6
|
interface CreateAppSignature {
|
|
@@ -36,11 +36,17 @@ interface UpdateAppSignature {
|
|
|
36
36
|
* when updating the app. This ensures you're working with the latest app and prevents unintended overwrites.
|
|
37
37
|
* Supports partial updates; specify the app's ID and the fields to change.
|
|
38
38
|
*
|
|
39
|
+
* In REST requests, explicitly set `mask.paths` to only the fields to
|
|
40
|
+
* change, such as `["name"]`, excluding `id` and `revision`. Supply the app ID in the URL
|
|
41
|
+
* and the current revision in the request body.
|
|
42
|
+
* The published SDK's `apps.updateApp()` does not expose a field-mask argument. Use the
|
|
43
|
+
* SDK-authenticated REST workaround shown in this method's SDK example, which sends an
|
|
44
|
+
* explicit mask with `fetchWithAuth` from `@wix/sdk/context`.
|
|
45
|
+
*
|
|
39
46
|
* This method cannot update `appSecrets`, `accountId`, `namespace`, `slug`, `createdBy`,
|
|
40
47
|
* `companionApp`, or `codeIdentifier`. Including any of these fields or their nested fields in the
|
|
41
48
|
* request causes the entire request to fail; they aren't silently ignored.
|
|
42
|
-
* Use Set Namespace to assign a namespace and Generate Slug to generate a slug.
|
|
43
|
-
* secrets, use Create Secondary Secret and Revoke Secret. This method does not support changing
|
|
49
|
+
* Use Set Namespace to assign a namespace and Generate Slug to generate a slug. This method does not support changing
|
|
44
50
|
* the owning account, creator, companion-app designation, or code identifier.
|
|
45
51
|
*
|
|
46
52
|
* Changing `status` requires additional status-change authorization beyond permission to update other fields.
|
|
@@ -105,29 +111,6 @@ interface SetNamespaceSignature {
|
|
|
105
111
|
*/
|
|
106
112
|
(appId: string, appName: string, options?: SetNamespaceOptions): Promise<NonNullablePaths<SetNamespaceResponse, `namespace`, 0>>;
|
|
107
113
|
}
|
|
108
|
-
declare function createSecondarySecret$1(httpClient: HttpClient): CreateSecondarySecretSignature;
|
|
109
|
-
interface CreateSecondarySecretSignature {
|
|
110
|
-
/**
|
|
111
|
-
* Shares WIX_DEVELOPERS.MODIFY_APP with the sibling app-write RPCs, which declare no audience
|
|
112
|
-
* (adding one here would break consistent-audience-for-shared-permission across all of them).
|
|
113
|
-
* Renaming the permission would change who is actually authorized, so it stays as-is —
|
|
114
|
-
* the real check is the MANUAL validateUpdateAppPermission(...) in code.
|
|
115
|
-
* @param - App ID.
|
|
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.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
|
-
}
|
|
119
|
-
declare function revokeSecret$1(httpClient: HttpClient): RevokeSecretSignature;
|
|
120
|
-
interface RevokeSecretSignature {
|
|
121
|
-
/**
|
|
122
|
-
* Shares WIX_DEVELOPERS.MODIFY_APP with the sibling app-write RPCs, which declare no audience
|
|
123
|
-
* (adding one here would break consistent-audience-for-shared-permission across all of them).
|
|
124
|
-
* Renaming the permission would change who is actually authorized, so it stays as-is —
|
|
125
|
-
* the real check is the MANUAL validateUpdateAppPermission(...) in code.
|
|
126
|
-
* @param - App ID.
|
|
127
|
-
* @param - Credential to revoke. The app must have both a previous and a replacement secret.
|
|
128
|
-
*/
|
|
129
|
-
(appId: string, secretToRevoke: SecretToRevokeWithLiterals): Promise<RevokeSecretResponse>;
|
|
130
|
-
}
|
|
131
114
|
|
|
132
115
|
declare const createApp: MaybeContext<BuildRESTFunction<typeof createApp$1> & typeof createApp$1>;
|
|
133
116
|
declare const getApp: MaybeContext<BuildRESTFunction<typeof getApp$1> & typeof getApp$1>;
|
|
@@ -136,7 +119,5 @@ declare const generateSlug: MaybeContext<BuildRESTFunction<typeof generateSlug$1
|
|
|
136
119
|
declare const getNamespaceSuggestion: MaybeContext<BuildRESTFunction<typeof getNamespaceSuggestion$1> & typeof getNamespaceSuggestion$1>;
|
|
137
120
|
declare const getNamespaceSuggestionByName: MaybeContext<BuildRESTFunction<typeof getNamespaceSuggestionByName$1> & typeof getNamespaceSuggestionByName$1>;
|
|
138
121
|
declare const setNamespace: MaybeContext<BuildRESTFunction<typeof setNamespace$1> & typeof setNamespace$1>;
|
|
139
|
-
declare const createSecondarySecret: MaybeContext<BuildRESTFunction<typeof createSecondarySecret$1> & typeof createSecondarySecret$1>;
|
|
140
|
-
declare const revokeSecret: MaybeContext<BuildRESTFunction<typeof revokeSecret$1> & typeof revokeSecret$1>;
|
|
141
122
|
|
|
142
|
-
export {
|
|
123
|
+
export { GenerateSlugResponse, GetAppOptions, GetNamespaceSuggestionByNameOptions, GetNamespaceSuggestionByNameResponse, GetNamespaceSuggestionOptions, GetNamespaceSuggestionResponse, SetNamespaceOptions, SetNamespaceResponse, UpdateApp, V1App, createApp, generateSlug, getApp, getNamespaceSuggestion, getNamespaceSuggestionByName, setNamespace, updateApp };
|