@wix/auto_sdk_standalone-forms_standalone-forms 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.
@@ -1,28 +1,33 @@
1
- import { GetOrCreateFormStandaloneMetaSiteRequest as GetOrCreateFormStandaloneMetaSiteRequest$1, GetOrCreateFormStandaloneMetaSiteResponse as GetOrCreateFormStandaloneMetaSiteResponse$1, CreateStandaloneFormRequest as CreateStandaloneFormRequest$1, CreateStandaloneFormResponse as CreateStandaloneFormResponse$1, GetStandaloneFormRequest as GetStandaloneFormRequest$1, GetStandaloneFormResponse as GetStandaloneFormResponse$1, DeleteStandaloneFormRequest as DeleteStandaloneFormRequest$1, DeleteStandaloneFormResponse as DeleteStandaloneFormResponse$1, RemoveStandaloneFormFromTrashBinRequest as RemoveStandaloneFormFromTrashBinRequest$1, RemoveStandaloneFormFromTrashBinResponse as RemoveStandaloneFormFromTrashBinResponse$1, RestoreStandaloneFormFromTrashBinRequest as RestoreStandaloneFormFromTrashBinRequest$1, RestoreStandaloneFormFromTrashBinResponse as RestoreStandaloneFormFromTrashBinResponse$1, GetDeletedStandaloneFormRequest as GetDeletedStandaloneFormRequest$1, GetDeletedStandaloneFormResponse as GetDeletedStandaloneFormResponse$1, ListDeletedStandaloneFormsRequest as ListDeletedStandaloneFormsRequest$1, ListDeletedStandaloneFormsResponse as ListDeletedStandaloneFormsResponse$1, QueryStandaloneFormsRequest as QueryStandaloneFormsRequest$1, QueryStandaloneFormsResponse as QueryStandaloneFormsResponse$1, GetSitePropertiesRequest as GetSitePropertiesRequest$1, GetSitePropertiesResponse as GetSitePropertiesResponse$1 } from './index.typings.js';
1
+ import { CreateStandaloneFormRequest as CreateStandaloneFormRequest$1, CreateStandaloneFormResponse as CreateStandaloneFormResponse$1, GetStandaloneFormRequest as GetStandaloneFormRequest$1, GetStandaloneFormResponse as GetStandaloneFormResponse$1, DeleteStandaloneFormRequest as DeleteStandaloneFormRequest$1, DeleteStandaloneFormResponse as DeleteStandaloneFormResponse$1, RemoveStandaloneFormFromTrashBinRequest as RemoveStandaloneFormFromTrashBinRequest$1, RemoveStandaloneFormFromTrashBinResponse as RemoveStandaloneFormFromTrashBinResponse$1, RestoreStandaloneFormFromTrashBinRequest as RestoreStandaloneFormFromTrashBinRequest$1, RestoreStandaloneFormFromTrashBinResponse as RestoreStandaloneFormFromTrashBinResponse$1, GetDeletedStandaloneFormRequest as GetDeletedStandaloneFormRequest$1, GetDeletedStandaloneFormResponse as GetDeletedStandaloneFormResponse$1, ListDeletedStandaloneFormsRequest as ListDeletedStandaloneFormsRequest$1, ListDeletedStandaloneFormsResponse as ListDeletedStandaloneFormsResponse$1, QueryStandaloneFormsRequest as QueryStandaloneFormsRequest$1, QueryStandaloneFormsResponse as QueryStandaloneFormsResponse$1, GetSitePropertiesRequest as GetSitePropertiesRequest$1, GetSitePropertiesResponse as GetSitePropertiesResponse$1 } from './index.typings.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
+ /**
5
+ * A standalone form marks a [form](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction) as standalone, so responders can reach it at its own public URL
6
+ * instead of on a Wix site.
7
+ *
8
+ * A form doesn't indicate whether it's standalone. A standalone form that references the form is what makes it
9
+ * standalone.
10
+ */
4
11
  interface StandaloneForm {
5
12
  /**
6
- * Standalone form ID. Automatically generated when the standalone form is created.
13
+ * Standalone form ID.
7
14
  *
8
- * Together with `accountSlug`, this ID forms part of the standalone form's public URL.
15
+ * Used in the standalone form's public URL. See `accountSlug` for the URL format.
9
16
  * @maxLength 36
10
17
  * @readonly
11
18
  */
12
19
  id?: string | null;
13
20
  /**
14
- * ID of the form, managed through the Wix Forms API, that this record marks as standalone.
21
+ * ID of the [form](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction) that the standalone form marks as standalone.
15
22
  *
16
- * A form doesn't itself indicate whether it's standalone. The existence of a standalone form
17
- * record that references it is what makes the form standalone.
23
+ * The form must exist before you create the standalone form.
18
24
  * @format GUID
19
25
  */
20
26
  formId?: string | null;
21
27
  /**
22
- * ID of the meta site that owns the standalone form.
28
+ * ID of the site that owns the standalone form.
23
29
  *
24
- * The meta site owns the form. Because this service doesn't use meta site tenancy, the owning
25
- * meta site is stored explicitly in this field. Set from the calling context when the form is created.
30
+ * Set to the site your request is authorized for when the standalone form is created.
26
31
  * @format GUID
27
32
  * @readonly
28
33
  */
@@ -38,10 +43,13 @@ interface StandaloneForm {
38
43
  */
39
44
  updatedDate?: Date | null;
40
45
  /**
41
- * Account slug of the site owner, captured when the standalone form was created.
46
+ * Account slug of the site owner, used in the standalone form's public URL.
42
47
  *
43
- * Together with `id`, the slug forms part of the standalone form's public URL. May be empty
44
- * if it couldn't be resolved at creation time.
48
+ * The standalone form's public URL is:
49
+ * - `https://{accountSlug}.wixforms.com/f/{id}` when `accountSlug` is set.
50
+ * - `https://www.wixforms.com/f/{id}` when `accountSlug` is empty.
51
+ *
52
+ * Set when the standalone form is created and doesn't change afterward.
45
53
  * @maxLength 50
46
54
  * @readonly
47
55
  */
@@ -51,38 +59,38 @@ interface GetOrCreateFormStandaloneMetaSiteRequest {
51
59
  }
52
60
  interface GetOrCreateFormStandaloneMetaSiteResponse {
53
61
  /**
54
- * MetaSiteId
62
+ * Meta site ID.
55
63
  * @format GUID
56
64
  */
57
65
  metaSiteId?: string;
58
66
  }
59
67
  interface CreateStandaloneFormRequest {
60
- /** Standalone form */
68
+ /** Standalone form to create. */
61
69
  standaloneForm: StandaloneForm;
62
70
  }
63
71
  interface CreateStandaloneFormResponse {
64
- /** Standalone form */
72
+ /** Created standalone form. */
65
73
  standaloneForm?: StandaloneForm;
66
74
  }
67
75
  interface GetStandaloneFormRequest {
68
76
  /**
69
- * Standalone form id
77
+ * ID of the standalone form to retrieve.
70
78
  * @maxLength 36
71
79
  */
72
80
  standaloneFormId: string;
73
81
  }
74
82
  interface GetStandaloneFormResponse {
75
- /** Standalone form */
83
+ /** Retrieved standalone form. */
76
84
  standaloneForm?: StandaloneForm;
77
85
  }
78
86
  interface DeleteStandaloneFormRequest {
79
87
  /**
80
- * Standalone form id
88
+ * ID of the standalone form to delete.
81
89
  * @maxLength 36
82
90
  */
83
91
  standaloneFormId: string;
84
92
  /**
85
- * Whether to permanently delete a standalone form bypassing the trash bin.
93
+ * Whether to permanently delete the standalone form instead of moving it to the trash bin.
86
94
  *
87
95
  * Default: `false`
88
96
  */
@@ -92,7 +100,7 @@ interface DeleteStandaloneFormResponse {
92
100
  }
93
101
  interface RemoveStandaloneFormFromTrashBinRequest {
94
102
  /**
95
- * Standalone form id
103
+ * ID of the standalone form to permanently delete.
96
104
  * @maxLength 36
97
105
  */
98
106
  standaloneFormId: string;
@@ -101,34 +109,36 @@ interface RemoveStandaloneFormFromTrashBinResponse {
101
109
  }
102
110
  interface RestoreStandaloneFormFromTrashBinRequest {
103
111
  /**
104
- * Standalone form id
112
+ * ID of the standalone form to restore.
105
113
  * @maxLength 36
106
114
  */
107
115
  standaloneFormId: string;
108
116
  }
109
117
  interface RestoreStandaloneFormFromTrashBinResponse {
110
- /** Standalone form */
118
+ /** Restored standalone form. */
111
119
  standaloneForm?: StandaloneForm;
112
120
  }
113
121
  interface GetDeletedStandaloneFormRequest {
114
122
  /**
115
- * Standalone form id
123
+ * ID of the standalone form to retrieve from the trash bin.
116
124
  * @maxLength 36
117
125
  */
118
126
  standaloneFormId: string;
119
127
  }
120
128
  interface GetDeletedStandaloneFormResponse {
121
- /** Standalone form */
129
+ /** Retrieved standalone form. */
122
130
  standaloneForm?: StandaloneForm;
123
131
  }
124
132
  interface ListDeletedStandaloneFormsRequest {
125
133
  /**
126
- * Standalone Form ids.
134
+ * IDs of the standalone forms to retrieve from the trash bin.
135
+ *
136
+ * Default: All standalone forms in the trash bin.
127
137
  * @maxSize 100
128
138
  * @maxLength 36
129
139
  */
130
140
  standaloneFormIds?: string[];
131
- /** Cursor token pointing to a page of results. Not used in the first request. */
141
+ /** Cursor paging options. */
132
142
  paging?: CursorPaging;
133
143
  }
134
144
  interface CursorPaging {
@@ -149,11 +159,11 @@ interface CursorPaging {
149
159
  }
150
160
  interface ListDeletedStandaloneFormsResponse {
151
161
  /**
152
- * The retrieved standalone forms
162
+ * Retrieved standalone forms.
153
163
  * @maxSize 100
154
164
  */
155
165
  standaloneForms?: StandaloneForm[];
156
- /** Details on the paged set of results returned. */
166
+ /** Paging metadata. */
157
167
  pagingMetadata?: CursorPagingMetadata;
158
168
  }
159
169
  interface CursorPagingMetadata {
@@ -181,7 +191,7 @@ interface Cursors {
181
191
  prev?: string | null;
182
192
  }
183
193
  interface QueryStandaloneFormsRequest {
184
- /** WQL expression. */
194
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) for more information. */
185
195
  query: CursorQuery;
186
196
  }
187
197
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -225,21 +235,26 @@ declare enum SortOrder {
225
235
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
226
236
  interface QueryStandaloneFormsResponse {
227
237
  /**
228
- * The retrieved standalone forms
238
+ * Retrieved standalone forms.
229
239
  * @maxSize 100
230
240
  */
231
241
  standaloneForms?: StandaloneForm[];
232
- /** Details on the paged set of results returned. */
242
+ /** Paging metadata. */
233
243
  metadata?: CursorPagingMetadata;
234
244
  }
235
245
  interface GetSitePropertiesRequest {
236
246
  }
237
247
  interface GetSitePropertiesResponse {
238
- /** Standalone MetaSite properties */
248
+ /** Site's currency and locale. */
239
249
  siteProperties?: StandaloneMetaSiteProperties;
240
250
  }
251
+ /** Currency and locale settings of a site. */
241
252
  interface StandaloneMetaSiteProperties {
242
- /** Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
253
+ /**
254
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
255
+ *
256
+ * Empty if the site's payment currency isn't set.
257
+ */
243
258
  paymentCurrency?: string | null;
244
259
  /**
245
260
  * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
@@ -1319,7 +1334,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1319
1334
  __responseType: Q;
1320
1335
  __originalResponseType: R;
1321
1336
  };
1322
- declare function getOrCreateFormStandaloneMetaSite(): __PublicMethodMetaInfo<'GET', {}, GetOrCreateFormStandaloneMetaSiteRequest$1, GetOrCreateFormStandaloneMetaSiteRequest, GetOrCreateFormStandaloneMetaSiteResponse$1, GetOrCreateFormStandaloneMetaSiteResponse>;
1323
1337
  declare function createStandaloneForm(): __PublicMethodMetaInfo<'POST', {}, CreateStandaloneFormRequest$1, CreateStandaloneFormRequest, CreateStandaloneFormResponse$1, CreateStandaloneFormResponse>;
1324
1338
  declare function getStandaloneForm(): __PublicMethodMetaInfo<'GET', {
1325
1339
  standaloneFormId: string;
@@ -1340,4 +1354,4 @@ declare function listDeletedStandaloneForms(): __PublicMethodMetaInfo<'GET', {},
1340
1354
  declare function queryStandaloneForms(): __PublicMethodMetaInfo<'POST', {}, QueryStandaloneFormsRequest$1, QueryStandaloneFormsRequest, QueryStandaloneFormsResponse$1, QueryStandaloneFormsResponse>;
1341
1355
  declare function getSiteProperties(): __PublicMethodMetaInfo<'GET', {}, GetSitePropertiesRequest$1, GetSitePropertiesRequest, GetSitePropertiesResponse$1, GetSitePropertiesResponse>;
1342
1356
 
1343
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type Asset as AssetOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type ChangeContext as ChangeContextOriginal, type ChangeContextPayloadOneOf as ChangeContextPayloadOneOfOriginal, type ConsentPolicy as ConsentPolicyOriginal, type CreateStandaloneFormApplicationErrors as CreateStandaloneFormApplicationErrorsOriginal, type CreateStandaloneFormRequest as CreateStandaloneFormRequestOriginal, type CreateStandaloneFormResponse as CreateStandaloneFormResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteContext as DeleteContextOriginal, type DeleteStandaloneFormRequest as DeleteStandaloneFormRequestOriginal, type DeleteStandaloneFormResponse as DeleteStandaloneFormResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetDeletedStandaloneFormRequest as GetDeletedStandaloneFormRequestOriginal, type GetDeletedStandaloneFormResponse as GetDeletedStandaloneFormResponseOriginal, type GetOrCreateFormStandaloneMetaSiteRequest as GetOrCreateFormStandaloneMetaSiteRequestOriginal, type GetOrCreateFormStandaloneMetaSiteResponse as GetOrCreateFormStandaloneMetaSiteResponseOriginal, type GetSitePropertiesApplicationErrors as GetSitePropertiesApplicationErrorsOriginal, type GetSitePropertiesRequest as GetSitePropertiesRequestOriginal, type GetSitePropertiesResponse as GetSitePropertiesResponseOriginal, type GetStandaloneFormRequest as GetStandaloneFormRequestOriginal, type GetStandaloneFormResponse as GetStandaloneFormResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ListDeletedStandaloneFormsRequest as ListDeletedStandaloneFormsRequestOriginal, type ListDeletedStandaloneFormsResponse as ListDeletedStandaloneFormsResponseOriginal, type Locale as LocaleOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type PropertiesChange as PropertiesChangeOriginal, type Properties as PropertiesOriginal, type QueryStandaloneFormsRequest as QueryStandaloneFormsRequestOriginal, type QueryStandaloneFormsResponse as QueryStandaloneFormsResponseOriginal, type RemoveStandaloneFormFromTrashBinRequest as RemoveStandaloneFormFromTrashBinRequestOriginal, type RemoveStandaloneFormFromTrashBinResponse as RemoveStandaloneFormFromTrashBinResponseOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreStandaloneFormFromTrashBinRequest as RestoreStandaloneFormFromTrashBinRequestOriginal, type RestoreStandaloneFormFromTrashBinResponse as RestoreStandaloneFormFromTrashBinResponseOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SiteCloned as SiteClonedOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesNotification as SitePropertiesNotificationOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, type StandaloneForm as StandaloneFormOriginal, type StandaloneMetaSiteProperties as StandaloneMetaSitePropertiesOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type TimePeriod as TimePeriodOriginal, type Translation as TranslationOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V4SiteCreated as V4SiteCreatedOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getOrCreateFormStandaloneMetaSite, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };
1357
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type Asset as AssetOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type ChangeContext as ChangeContextOriginal, type ChangeContextPayloadOneOf as ChangeContextPayloadOneOfOriginal, type ConsentPolicy as ConsentPolicyOriginal, type CreateStandaloneFormApplicationErrors as CreateStandaloneFormApplicationErrorsOriginal, type CreateStandaloneFormRequest as CreateStandaloneFormRequestOriginal, type CreateStandaloneFormResponse as CreateStandaloneFormResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteContext as DeleteContextOriginal, type DeleteStandaloneFormRequest as DeleteStandaloneFormRequestOriginal, type DeleteStandaloneFormResponse as DeleteStandaloneFormResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetDeletedStandaloneFormRequest as GetDeletedStandaloneFormRequestOriginal, type GetDeletedStandaloneFormResponse as GetDeletedStandaloneFormResponseOriginal, type GetOrCreateFormStandaloneMetaSiteRequest as GetOrCreateFormStandaloneMetaSiteRequestOriginal, type GetOrCreateFormStandaloneMetaSiteResponse as GetOrCreateFormStandaloneMetaSiteResponseOriginal, type GetSitePropertiesApplicationErrors as GetSitePropertiesApplicationErrorsOriginal, type GetSitePropertiesRequest as GetSitePropertiesRequestOriginal, type GetSitePropertiesResponse as GetSitePropertiesResponseOriginal, type GetStandaloneFormRequest as GetStandaloneFormRequestOriginal, type GetStandaloneFormResponse as GetStandaloneFormResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ListDeletedStandaloneFormsRequest as ListDeletedStandaloneFormsRequestOriginal, type ListDeletedStandaloneFormsResponse as ListDeletedStandaloneFormsResponseOriginal, type Locale as LocaleOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type PropertiesChange as PropertiesChangeOriginal, type Properties as PropertiesOriginal, type QueryStandaloneFormsRequest as QueryStandaloneFormsRequestOriginal, type QueryStandaloneFormsResponse as QueryStandaloneFormsResponseOriginal, type RemoveStandaloneFormFromTrashBinRequest as RemoveStandaloneFormFromTrashBinRequestOriginal, type RemoveStandaloneFormFromTrashBinResponse as RemoveStandaloneFormFromTrashBinResponseOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreStandaloneFormFromTrashBinRequest as RestoreStandaloneFormFromTrashBinRequestOriginal, type RestoreStandaloneFormFromTrashBinResponse as RestoreStandaloneFormFromTrashBinResponseOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SiteCloned as SiteClonedOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesNotification as SitePropertiesNotificationOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, type StandaloneForm as StandaloneFormOriginal, type StandaloneMetaSiteProperties as StandaloneMetaSitePropertiesOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type TimePeriod as TimePeriodOriginal, type Translation as TranslationOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V4SiteCreated as V4SiteCreatedOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };
@@ -1,28 +1,20 @@
1
1
  import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { GetOrCreateFormStandaloneMetaSiteResponse, StandaloneForm, CreateStandaloneFormApplicationErrors, DeleteStandaloneFormOptions, RestoreStandaloneFormFromTrashBinResponse, GetDeletedStandaloneFormResponse, ListDeletedStandaloneFormsOptions, ListDeletedStandaloneFormsResponse, CursorQuery, QueryStandaloneFormsResponse, GetSitePropertiesResponse, GetSitePropertiesApplicationErrors } from './index.typings.mjs';
3
- export { AccountInfo, ActionEvent, Address, AddressHint, Asset, BusinessSchedule, Categories, ChangeContext, ChangeContextPayloadOneOf, ConsentPolicy, CreateStandaloneFormRequest, CreateStandaloneFormResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DayOfWeek, DayOfWeekWithLiterals, DeleteContext, DeleteStandaloneFormRequest, DeleteStandaloneFormResponse, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorlessAssigned, EditorlessUnassigned, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GeoCoordinates, GetDeletedStandaloneFormRequest, GetOrCreateFormStandaloneMetaSiteRequest, GetSitePropertiesRequest, GetStandaloneFormRequest, GetStandaloneFormResponse, IdentificationData, IdentificationDataIdOneOf, ListDeletedStandaloneFormsRequest, Locale, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Multilingual, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, PicassoAssigned, PicassoUnassigned, PlacementType, PlacementTypeWithLiterals, Properties, PropertiesChange, QueryStandaloneFormsRequest, RemoveStandaloneFormFromTrashBinRequest, RemoveStandaloneFormFromTrashBinResponse, ResolutionMethod, ResolutionMethodWithLiterals, RestoreInfo, RestoreStandaloneFormFromTrashBinRequest, ServiceProvisioned, ServiceRemoved, SiteCloned, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePropertiesEvent, SitePropertiesNotification, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SpecialHourPeriod, StandaloneMetaSiteProperties, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, SupportedLanguage, TimePeriod, Translation, UserDomainMediaDisabled, UserDomainMediaEnabled, V4SiteCreated, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.mjs';
2
+ import { StandaloneForm, CreateStandaloneFormApplicationErrors, DeleteStandaloneFormOptions, RestoreStandaloneFormFromTrashBinResponse, GetDeletedStandaloneFormResponse, ListDeletedStandaloneFormsOptions, ListDeletedStandaloneFormsResponse, CursorQuery, QueryStandaloneFormsResponse, GetSitePropertiesResponse, GetSitePropertiesApplicationErrors } from './index.typings.mjs';
3
+ export { AccountInfo, ActionEvent, Address, AddressHint, Asset, BusinessSchedule, Categories, ChangeContext, ChangeContextPayloadOneOf, ConsentPolicy, CreateStandaloneFormRequest, CreateStandaloneFormResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DayOfWeek, DayOfWeekWithLiterals, DeleteContext, DeleteStandaloneFormRequest, DeleteStandaloneFormResponse, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorlessAssigned, EditorlessUnassigned, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GeoCoordinates, GetDeletedStandaloneFormRequest, GetOrCreateFormStandaloneMetaSiteRequest, GetOrCreateFormStandaloneMetaSiteResponse, GetSitePropertiesRequest, GetStandaloneFormRequest, GetStandaloneFormResponse, IdentificationData, IdentificationDataIdOneOf, ListDeletedStandaloneFormsRequest, Locale, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Multilingual, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, PicassoAssigned, PicassoUnassigned, PlacementType, PlacementTypeWithLiterals, Properties, PropertiesChange, QueryStandaloneFormsRequest, RemoveStandaloneFormFromTrashBinRequest, RemoveStandaloneFormFromTrashBinResponse, ResolutionMethod, ResolutionMethodWithLiterals, RestoreInfo, RestoreStandaloneFormFromTrashBinRequest, ServiceProvisioned, ServiceRemoved, SiteCloned, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePropertiesEvent, SitePropertiesNotification, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SpecialHourPeriod, StandaloneMetaSiteProperties, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, SupportedLanguage, TimePeriod, Translation, UserDomainMediaDisabled, UserDomainMediaEnabled, V4SiteCreated, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.mjs';
4
4
 
5
- declare function getOrCreateFormStandaloneMetaSite$1(httpClient: HttpClient): GetOrCreateFormStandaloneMetaSiteSignature;
6
- interface GetOrCreateFormStandaloneMetaSiteSignature {
7
- /**
8
- * Returns the standalone meta site owned by the caller's account, provisioning a new siteless
9
- * meta site if one doesn't exist yet.
10
- *
11
- * Use this when the caller doesn't already have a meta site, for example when a form is built
12
- * before the user becomes a Wix user. The returned meta site can then own standalone forms.
13
- */
14
- (): Promise<NonNullablePaths<GetOrCreateFormStandaloneMetaSiteResponse, `metaSiteId`, 0>>;
15
- }
16
5
  declare function createStandaloneForm$1(httpClient: HttpClient): CreateStandaloneFormSignature;
17
6
  interface CreateStandaloneFormSignature {
18
7
  /**
19
- * Marks an existing form as standalone by creating a standalone form record that binds the form
20
- * to the meta site that owns it.
8
+ * Creates a standalone form, which marks a form as standalone so responders can reach it at its own public URL.
21
9
  *
22
- * The form referenced by `formId` must already exist. The owning meta site is taken from the
23
- * calling context. A given form can be marked standalone by only one record per meta site.
24
- * @param - Standalone form
25
- * @returns Standalone form
10
+ * The form must already exist. Create it with [Create Form](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/create-form) first. The standalone form is owned by
11
+ * the site your request is authorized for. Each form can be marked standalone once per site.
12
+ *
13
+ * The response includes the `id` and `accountSlug` that make up the standalone form's public URL.
14
+ *
15
+ * To stop hosting the form as standalone, call [Delete Standalone Form](https://dev.wix.com/docs/api-reference/crm/forms/standalone-form-v1/delete-standalone-form).
16
+ * @param - Standalone form to create.
17
+ * @returns Created standalone form.
26
18
  */
27
19
  (standaloneForm: NonNullablePaths<StandaloneForm, `formId`, 0>): Promise<StandaloneForm & {
28
20
  __applicationErrorsType?: CreateStandaloneFormApplicationErrors;
@@ -31,76 +23,99 @@ interface CreateStandaloneFormSignature {
31
23
  declare function getStandaloneForm$1(httpClient: HttpClient): GetStandaloneFormSignature;
32
24
  interface GetStandaloneFormSignature {
33
25
  /**
34
- * Retrieves a standalone form by ID.
35
- * @param - Standalone form id
36
- * @returns Standalone form
26
+ * Retrieves a standalone form.
27
+ *
28
+ * To retrieve the form's fields and settings, pass the returned `formId` to [Get Form](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/get-form).
29
+ * @param - ID of the standalone form to retrieve.
30
+ * @returns Retrieved standalone form.
37
31
  */
38
32
  (standaloneFormId: string): Promise<StandaloneForm>;
39
33
  }
40
34
  declare function deleteStandaloneForm$1(httpClient: HttpClient): DeleteStandaloneFormSignature;
41
35
  interface DeleteStandaloneFormSignature {
42
36
  /**
43
- * Deletes a standalone form record
37
+ * Deletes a standalone form.
44
38
  *
45
- * By default the record is moved to the trash bin. Set `permanent` to `true` to delete it permanently.
46
- * @param - Standalone form id
39
+ * Deleting a standalone form means the form is no longer standalone. The form itself isn't deleted.
40
+ *
41
+ * By default, the standalone form is moved to the trash bin. From there, you can restore it with
42
+ * [Restore Standalone Form From Trash Bin](https://dev.wix.com/docs/api-reference/crm/forms/standalone-form-v1/restore-standalone-form-from-trash-bin) or permanently delete it with
43
+ * [Remove Standalone Form From Trash Bin](https://dev.wix.com/docs/api-reference/crm/forms/standalone-form-v1/remove-standalone-form-from-trash-bin). To permanently delete the standalone form right away, set
44
+ * `permanent` to `true`.
45
+ * @param - ID of the standalone form to delete.
47
46
  */
48
47
  (standaloneFormId: string, options?: DeleteStandaloneFormOptions): Promise<void>;
49
48
  }
50
49
  declare function removeStandaloneFormFromTrashBin$1(httpClient: HttpClient): RemoveStandaloneFormFromTrashBinSignature;
51
50
  interface RemoveStandaloneFormFromTrashBinSignature {
52
51
  /**
53
- * Permanently deletes a standalone form record that is in the trash bin.
54
- * @param - Standalone form id
52
+ * Permanently deletes a standalone form from the trash bin.
53
+ *
54
+ * To move a standalone form to the trash bin, call [Delete Standalone Form](https://dev.wix.com/docs/api-reference/crm/forms/standalone-form-v1/delete-standalone-form).
55
+ * @param - ID of the standalone form to permanently delete.
55
56
  */
56
57
  (standaloneFormId: string): Promise<void>;
57
58
  }
58
59
  declare function restoreStandaloneFormFromTrashBin$1(httpClient: HttpClient): RestoreStandaloneFormFromTrashBinSignature;
59
60
  interface RestoreStandaloneFormFromTrashBinSignature {
60
61
  /**
61
- * Restores a standalone form record from the trash bin.
62
- * @param - Standalone form id
62
+ * Restores a standalone form from the trash bin.
63
+ *
64
+ * The restored standalone form keeps its `id` and `accountSlug`, so its public URL works again.
65
+ * @param - ID of the standalone form to restore.
63
66
  */
64
67
  (standaloneFormId: string): Promise<RestoreStandaloneFormFromTrashBinResponse>;
65
68
  }
66
69
  declare function getDeletedStandaloneForm$1(httpClient: HttpClient): GetDeletedStandaloneFormSignature;
67
70
  interface GetDeletedStandaloneFormSignature {
68
71
  /**
69
- * Retrieves a standalone form record from the trash bin by ID.
70
- * @param - Standalone form id
72
+ * Retrieves a standalone form from the trash bin.
73
+ * @param - ID of the standalone form to retrieve from the trash bin.
71
74
  */
72
75
  (standaloneFormId: string): Promise<GetDeletedStandaloneFormResponse>;
73
76
  }
74
77
  declare function listDeletedStandaloneForms$1(httpClient: HttpClient): ListDeletedStandaloneFormsSignature;
75
78
  interface ListDeletedStandaloneFormsSignature {
76
79
  /**
77
- * Retrieves a list of standalone form records that are in the trash bin.
80
+ * Retrieves a list of standalone forms in the trash bin.
81
+ *
82
+ * To retrieve specific standalone forms, specify their IDs in `standaloneFormIds`.
78
83
  */
79
84
  (options?: ListDeletedStandaloneFormsOptions): Promise<NonNullablePaths<ListDeletedStandaloneFormsResponse, `standaloneForms`, 0>>;
80
85
  }
81
86
  declare function queryStandaloneForms$1(httpClient: HttpClient): QueryStandaloneFormsSignature;
82
87
  interface QueryStandaloneFormsSignature {
83
88
  /**
84
- * Retrieves a list of standalone forms, given the provided filtering, sorting, and paging.
89
+ * Retrieves a list of up to 100 standalone forms, given the provided paging, filtering, and sorting.
90
+ *
91
+ * Query Standalone Forms runs with these defaults, which you can override:
92
+ *
93
+ * - `createdDate` is sorted in `DESC` order
94
+ * - `cursorPaging.limit` is `50`
95
+ *
96
+ * Supported properties for filtering and sorting: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
85
97
  *
86
- * Supported filterable and sortable fields: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
87
- * @param - WQL expression.
98
+ * To learn about working with Query methods, see
99
+ * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
100
+ * [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging),
101
+ * and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
102
+ * @param - Query options. See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) for more information.
88
103
  */
89
104
  (query: CursorQuery): Promise<NonNullablePaths<QueryStandaloneFormsResponse, `standaloneForms`, 0>>;
90
105
  }
91
106
  declare function getSiteProperties$1(httpClient: HttpClient): GetSitePropertiesSignature;
92
107
  interface GetSitePropertiesSignature {
93
108
  /**
94
- * Gets site properties (currency and locale) for the caller's standalone meta site.
109
+ * Retrieves the currency and locale of the site your request is authorized for.
95
110
  *
96
- * Results may be cached and are not guaranteed to reflect real-time changes.
111
+ * Use these values to display prices and labels correctly when you render a standalone form. Results may be cached,
112
+ * so recent changes to the site's settings might not appear right away.
97
113
  */
98
114
  (): Promise<NonNullablePaths<GetSitePropertiesResponse, `siteProperties.localeLanguageCode` | `siteProperties.localeCountry`, 1> & {
99
115
  __applicationErrorsType?: GetSitePropertiesApplicationErrors;
100
116
  }>;
101
117
  }
102
118
 
103
- declare const getOrCreateFormStandaloneMetaSite: MaybeContext<BuildRESTFunction<typeof getOrCreateFormStandaloneMetaSite$1> & typeof getOrCreateFormStandaloneMetaSite$1>;
104
119
  declare const createStandaloneForm: MaybeContext<BuildRESTFunction<typeof createStandaloneForm$1> & typeof createStandaloneForm$1>;
105
120
  declare const getStandaloneForm: MaybeContext<BuildRESTFunction<typeof getStandaloneForm$1> & typeof getStandaloneForm$1>;
106
121
  declare const deleteStandaloneForm: MaybeContext<BuildRESTFunction<typeof deleteStandaloneForm$1> & typeof deleteStandaloneForm$1>;
@@ -111,4 +126,4 @@ declare const listDeletedStandaloneForms: MaybeContext<BuildRESTFunction<typeof
111
126
  declare const queryStandaloneForms: MaybeContext<BuildRESTFunction<typeof queryStandaloneForms$1> & typeof queryStandaloneForms$1>;
112
127
  declare const getSiteProperties: MaybeContext<BuildRESTFunction<typeof getSiteProperties$1> & typeof getSiteProperties$1>;
113
128
 
114
- export { CreateStandaloneFormApplicationErrors, CursorQuery, DeleteStandaloneFormOptions, GetDeletedStandaloneFormResponse, GetOrCreateFormStandaloneMetaSiteResponse, GetSitePropertiesApplicationErrors, GetSitePropertiesResponse, ListDeletedStandaloneFormsOptions, ListDeletedStandaloneFormsResponse, QueryStandaloneFormsResponse, RestoreStandaloneFormFromTrashBinResponse, StandaloneForm, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getOrCreateFormStandaloneMetaSite, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };
129
+ export { CreateStandaloneFormApplicationErrors, CursorQuery, DeleteStandaloneFormOptions, GetDeletedStandaloneFormResponse, GetSitePropertiesApplicationErrors, GetSitePropertiesResponse, ListDeletedStandaloneFormsOptions, ListDeletedStandaloneFormsResponse, QueryStandaloneFormsResponse, RestoreStandaloneFormFromTrashBinResponse, StandaloneForm, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };