@wix/auto_sdk_standalone-forms_standalone-forms 1.0.1 → 1.0.2

package/build/internal/es/index.d.mts

@@ -5,13 +5,16 @@ export { AccountInfo, ActionEvent, Address, AddressHint, Asset, BusinessSchedule
 declare function createStandaloneForm$1(httpClient: HttpClient): CreateStandaloneFormSignature;
 interface CreateStandaloneFormSignature {
     /**
-     * Marks an existing form as standalone by creating a standalone form record that binds the form
-     * to the meta site that owns it.
+     * Creates a standalone form, which marks a form as standalone so responders can reach it at its own public URL.
      *
-     * The form referenced by `formId` must already exist. The owning meta site is taken from the
-     * calling context. A given form can be marked standalone by only one record per meta site.
-     * @param - Standalone form
-     * @returns Standalone form
+     * 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
+     * the site your request is authorized for. Each form can be marked standalone once per site.
+     *
+     * The response includes the `id` and `accountSlug` that make up the standalone form's public URL.
+     *
+     * 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).
+     * @param - Standalone form to create.
+     * @returns Created standalone form.
      */
     (standaloneForm: NonNullablePaths<StandaloneForm, `formId`, 0>): Promise<StandaloneForm & {
         __applicationErrorsType?: CreateStandaloneFormApplicationErrors;
@@ -20,69 +23,93 @@ interface CreateStandaloneFormSignature {
 declare function getStandaloneForm$1(httpClient: HttpClient): GetStandaloneFormSignature;
 interface GetStandaloneFormSignature {
     /**
-     * Retrieves a standalone form by ID.
-     * @param - Standalone form id
-     * @returns Standalone form
+     * Retrieves a standalone form.
+     *
+     * 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).
+     * @param - ID of the standalone form to retrieve.
+     * @returns Retrieved standalone form.
      */
     (standaloneFormId: string): Promise<StandaloneForm>;
 }
 declare function deleteStandaloneForm$1(httpClient: HttpClient): DeleteStandaloneFormSignature;
 interface DeleteStandaloneFormSignature {
     /**
-     * Deletes a standalone form record
+     * Deletes a standalone form.
      *
-     * By default the record is moved to the trash bin. Set `permanent` to `true` to delete it permanently.
-     * @param - Standalone form id
+     * Deleting a standalone form means the form is no longer standalone. The form itself isn't deleted.
+     *
+     * By default, the standalone form is moved to the trash bin. From there, you can restore it with
+     * [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
+     * [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
+     * `permanent` to `true`.
+     * @param - ID of the standalone form to delete.
      */
     (standaloneFormId: string, options?: DeleteStandaloneFormOptions): Promise<void>;
 }
 declare function removeStandaloneFormFromTrashBin$1(httpClient: HttpClient): RemoveStandaloneFormFromTrashBinSignature;
 interface RemoveStandaloneFormFromTrashBinSignature {
     /**
-     * Permanently deletes a standalone form record that is in the trash bin.
-     * @param - Standalone form id
+     * Permanently deletes a standalone form from the trash bin.
+     *
+     * 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).
+     * @param - ID of the standalone form to permanently delete.
      */
     (standaloneFormId: string): Promise<void>;
 }
 declare function restoreStandaloneFormFromTrashBin$1(httpClient: HttpClient): RestoreStandaloneFormFromTrashBinSignature;
 interface RestoreStandaloneFormFromTrashBinSignature {
     /**
-     * Restores a standalone form record from the trash bin.
-     * @param - Standalone form id
+     * Restores a standalone form from the trash bin.
+     *
+     * The restored standalone form keeps its `id` and `accountSlug`, so its public URL works again.
+     * @param - ID of the standalone form to restore.
      */
     (standaloneFormId: string): Promise<RestoreStandaloneFormFromTrashBinResponse>;
 }
 declare function getDeletedStandaloneForm$1(httpClient: HttpClient): GetDeletedStandaloneFormSignature;
 interface GetDeletedStandaloneFormSignature {
     /**
-     * Retrieves a standalone form record from the trash bin by ID.
-     * @param - Standalone form id
+     * Retrieves a standalone form from the trash bin.
+     * @param - ID of the standalone form to retrieve from the trash bin.
      */
     (standaloneFormId: string): Promise<GetDeletedStandaloneFormResponse>;
 }
 declare function listDeletedStandaloneForms$1(httpClient: HttpClient): ListDeletedStandaloneFormsSignature;
 interface ListDeletedStandaloneFormsSignature {
     /**
-     * Retrieves a list of standalone form records that are in the trash bin.
+     * Retrieves a list of standalone forms in the trash bin.
+     *
+     * To retrieve specific standalone forms, specify their IDs in `standaloneFormIds`.
      */
     (options?: ListDeletedStandaloneFormsOptions): Promise<NonNullablePaths<ListDeletedStandaloneFormsResponse, `standaloneForms`, 0>>;
 }
 declare function queryStandaloneForms$1(httpClient: HttpClient): QueryStandaloneFormsSignature;
 interface QueryStandaloneFormsSignature {
     /**
-     * Retrieves a list of standalone forms, given the provided filtering, sorting, and paging.
+     * Retrieves a list of up to 100 standalone forms, given the provided paging, filtering, and sorting.
+     *
+     * Query Standalone Forms runs with these defaults, which you can override:
+     *
+     * - `createdDate` is sorted in `DESC` order
+     * - `cursorPaging.limit` is `50`
+     *
+     * Supported properties for filtering and sorting: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
      *
-     * Supported filterable and sortable fields: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
-     * @param - WQL expression.
+     * To learn about working with Query methods, see
+     * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
+     * [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging),
+     * and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
+     * @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.
      */
     (query: CursorQuery): Promise<NonNullablePaths<QueryStandaloneFormsResponse, `standaloneForms`, 0>>;
 }
 declare function getSiteProperties$1(httpClient: HttpClient): GetSitePropertiesSignature;
 interface GetSitePropertiesSignature {
     /**
-     * Gets site properties (currency and locale) for the caller's standalone meta site.
+     * Retrieves the currency and locale of the site your request is authorized for.
      *
-     * Results may be cached and are not guaranteed to reflect real-time changes.
+     * Use these values to display prices and labels correctly when you render a standalone form. Results may be cached,
+     * so recent changes to the site's settings might not appear right away.
      */
     (): Promise<NonNullablePaths<GetSitePropertiesResponse, `siteProperties.localeLanguageCode` | `siteProperties.localeCountry`, 1> & {
         __applicationErrorsType?: GetSitePropertiesApplicationErrors;

package/build/internal/es/index.typings.d.mts

@@ -1,27 +1,32 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
+/**
+ * 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
+ * instead of on a Wix site.
+ *
+ * A form doesn't indicate whether it's standalone. A standalone form that references the form is what makes it
+ * standalone.
+ */
 interface StandaloneForm {
     /**
-     * Standalone form ID. Automatically generated when the standalone form is created.
+     * Standalone form ID.
      *
-     * Together with `accountSlug`, this ID forms part of the standalone form's public URL.
+     * Used in the standalone form's public URL. See `accountSlug` for the URL format.
      * @maxLength 36
      * @readonly
      */
     _id?: string | null;
     /**
-     * ID of the form, managed through the Wix Forms API, that this record marks as standalone.
+     * ID of the [form](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction) that the standalone form marks as standalone.
      *
-     * A form doesn't itself indicate whether it's standalone. The existence of a standalone form
-     * record that references it is what makes the form standalone.
+     * The form must exist before you create the standalone form.
      * @format GUID
      */
     formId?: string | null;
     /**
-     * ID of the meta site that owns the standalone form.
+     * ID of the site that owns the standalone form.
      *
-     * The meta site owns the form. Because this service doesn't use meta site tenancy, the owning
-     * meta site is stored explicitly in this field. Set from the calling context when the form is created.
+     * Set to the site your request is authorized for when the standalone form is created.
      * @format GUID
      * @readonly
      */
@@ -37,10 +42,13 @@ interface StandaloneForm {
      */
     _updatedDate?: Date | null;
     /**
-     * Account slug of the site owner, captured when the standalone form was created.
+     * Account slug of the site owner, used in the standalone form's public URL.
      *
-     * Together with `id`, the slug forms part of the standalone form's public URL. May be empty
-     * if it couldn't be resolved at creation time.
+     * The standalone form's public URL is:
+     * - `https://{accountSlug}.wixforms.com/f/{id}` when `accountSlug` is set.
+     * - `https://www.wixforms.com/f/{id}` when `accountSlug` is empty.
+     *
+     * Set when the standalone form is created and doesn't change afterward.
      * @maxLength 50
      * @readonly
      */
@@ -50,38 +58,38 @@ interface GetOrCreateFormStandaloneMetaSiteRequest {
 }
 interface GetOrCreateFormStandaloneMetaSiteResponse {
     /**
-     * MetaSiteId
+     * Meta site ID.
      * @format GUID
      */
     metaSiteId?: string;
 }
 interface CreateStandaloneFormRequest {
-    /** Standalone form */
+    /** Standalone form to create. */
     standaloneForm: StandaloneForm;
 }
 interface CreateStandaloneFormResponse {
-    /** Standalone form */
+    /** Created standalone form. */
     standaloneForm?: StandaloneForm;
 }
 interface GetStandaloneFormRequest {
     /**
-     * Standalone form id
+     * ID of the standalone form to retrieve.
      * @maxLength 36
      */
     standaloneFormId: string;
 }
 interface GetStandaloneFormResponse {
-    /** Standalone form */
+    /** Retrieved standalone form. */
     standaloneForm?: StandaloneForm;
 }
 interface DeleteStandaloneFormRequest {
     /**
-     * Standalone form id
+     * ID of the standalone form to delete.
      * @maxLength 36
      */
     standaloneFormId: string;
     /**
-     * Whether to permanently delete a standalone form bypassing the trash bin.
+     * Whether to permanently delete the standalone form instead of moving it to the trash bin.
      *
      * Default: `false`
      */
@@ -91,7 +99,7 @@ interface DeleteStandaloneFormResponse {
 }
 interface RemoveStandaloneFormFromTrashBinRequest {
     /**
-     * Standalone form id
+     * ID of the standalone form to permanently delete.
      * @maxLength 36
      */
     standaloneFormId: string;
@@ -100,34 +108,36 @@ interface RemoveStandaloneFormFromTrashBinResponse {
 }
 interface RestoreStandaloneFormFromTrashBinRequest {
     /**
-     * Standalone form id
+     * ID of the standalone form to restore.
      * @maxLength 36
      */
     standaloneFormId: string;
 }
 interface RestoreStandaloneFormFromTrashBinResponse {
-    /** Standalone form */
+    /** Restored standalone form. */
     standaloneForm?: StandaloneForm;
 }
 interface GetDeletedStandaloneFormRequest {
     /**
-     * Standalone form id
+     * ID of the standalone form to retrieve from the trash bin.
      * @maxLength 36
      */
     standaloneFormId: string;
 }
 interface GetDeletedStandaloneFormResponse {
-    /** Standalone form */
+    /** Retrieved standalone form. */
     standaloneForm?: StandaloneForm;
 }
 interface ListDeletedStandaloneFormsRequest {
     /**
-     * Standalone Form ids.
+     * IDs of the standalone forms to retrieve from the trash bin.
+     *
+     * Default: All standalone forms in the trash bin.
      * @maxSize 100
      * @maxLength 36
      */
     standaloneFormIds?: string[];
-    /** Cursor token pointing to a page of results. Not used in the first request. */
+    /** Cursor paging options. */
     paging?: CursorPaging;
 }
 interface CursorPaging {
@@ -148,11 +158,11 @@ interface CursorPaging {
 }
 interface ListDeletedStandaloneFormsResponse {
     /**
-     * The retrieved standalone forms
+     * Retrieved standalone forms.
      * @maxSize 100
      */
     standaloneForms?: StandaloneForm[];
-    /** Details on the paged set of results returned. */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -180,7 +190,7 @@ interface Cursors {
     prev?: string | null;
 }
 interface QueryStandaloneFormsRequest {
-    /** WQL expression. */
+    /** 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. */
     query: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -224,21 +234,26 @@ declare enum SortOrder {
 type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
 interface QueryStandaloneFormsResponse {
     /**
-     * The retrieved standalone forms
+     * Retrieved standalone forms.
      * @maxSize 100
      */
     standaloneForms?: StandaloneForm[];
-    /** Details on the paged set of results returned. */
+    /** Paging metadata. */
     metadata?: CursorPagingMetadata;
 }
 interface GetSitePropertiesRequest {
 }
 interface GetSitePropertiesResponse {
-    /** Standalone MetaSite properties */
+    /** Site's currency and locale. */
     siteProperties?: StandaloneMetaSiteProperties;
 }
+/** Currency and locale settings of a site. */
 interface StandaloneMetaSiteProperties {
-    /** Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    /**
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     *
+     * Empty if the site's payment currency isn't set.
+     */
     paymentCurrency?: string | null;
     /**
      * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
@@ -1264,41 +1279,51 @@ type GetSitePropertiesApplicationErrors = {
     data?: Record<string, any>;
 };
 /**
- * Marks an existing form as standalone by creating a standalone form record that binds the form
- * to the meta site that owns it.
+ * Creates a standalone form, which marks a form as standalone so responders can reach it at its own public URL.
+ *
+ * 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
+ * the site your request is authorized for. Each form can be marked standalone once per site.
  *
- * The form referenced by `formId` must already exist. The owning meta site is taken from the
- * calling context. A given form can be marked standalone by only one record per meta site.
- * @param standaloneForm - Standalone form
+ * The response includes the `id` and `accountSlug` that make up the standalone form's public URL.
+ *
+ * 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).
+ * @param standaloneForm - Standalone form to create.
  * @public
  * @documentationMaturity preview
  * @requiredField standaloneForm
  * @requiredField standaloneForm.formId
  * @permissionId WIX_FORMS.STANDALONE_FORM_CREATE
  * @applicableIdentity APP
- * @returns Standalone form
+ * @returns Created standalone form.
  * @fqn wix.forms.v1.FormStandaloneService.CreateStandaloneForm
  */
 declare function createStandaloneForm(standaloneForm: NonNullablePaths<StandaloneForm, `formId`, 0>): Promise<StandaloneForm & {
     __applicationErrorsType?: CreateStandaloneFormApplicationErrors;
 }>;
 /**
- * Retrieves a standalone form by ID.
- * @param standaloneFormId - Standalone form id
+ * Retrieves a standalone form.
+ *
+ * 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).
+ * @param standaloneFormId - ID of the standalone form to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField standaloneFormId
  * @permissionId WIX_FORMS.STANDALONE_FORM_READ
  * @applicableIdentity APP
- * @returns Standalone form
+ * @returns Retrieved standalone form.
  * @fqn wix.forms.v1.FormStandaloneService.GetStandaloneForm
  */
 declare function getStandaloneForm(standaloneFormId: string): Promise<StandaloneForm>;
 /**
- * Deletes a standalone form record
+ * Deletes a standalone form.
+ *
+ * Deleting a standalone form means the form is no longer standalone. The form itself isn't deleted.
  *
- * By default the record is moved to the trash bin. Set `permanent` to `true` to delete it permanently.
- * @param standaloneFormId - Standalone form id
+ * By default, the standalone form is moved to the trash bin. From there, you can restore it with
+ * [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
+ * [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
+ * `permanent` to `true`.
+ * @param standaloneFormId - ID of the standalone form to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField standaloneFormId
@@ -1309,15 +1334,17 @@ declare function getStandaloneForm(standaloneFormId: string): Promise<Standalone
 declare function deleteStandaloneForm(standaloneFormId: string, options?: DeleteStandaloneFormOptions): Promise<void>;
 interface DeleteStandaloneFormOptions {
     /**
-     * Whether to permanently delete a standalone form bypassing the trash bin.
+     * Whether to permanently delete the standalone form instead of moving it to the trash bin.
      *
      * Default: `false`
      */
     permanent?: boolean;
 }
 /**
- * Permanently deletes a standalone form record that is in the trash bin.
- * @param standaloneFormId - Standalone form id
+ * Permanently deletes a standalone form from the trash bin.
+ *
+ * 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).
+ * @param standaloneFormId - ID of the standalone form to permanently delete.
  * @public
  * @documentationMaturity preview
  * @requiredField standaloneFormId
@@ -1327,8 +1354,10 @@ interface DeleteStandaloneFormOptions {
  */
 declare function removeStandaloneFormFromTrashBin(standaloneFormId: string): Promise<void>;
 /**
- * Restores a standalone form record from the trash bin.
- * @param standaloneFormId - Standalone form id
+ * Restores a standalone form from the trash bin.
+ *
+ * The restored standalone form keeps its `id` and `accountSlug`, so its public URL works again.
+ * @param standaloneFormId - ID of the standalone form to restore.
  * @public
  * @documentationMaturity preview
  * @requiredField standaloneFormId
@@ -1338,8 +1367,8 @@ declare function removeStandaloneFormFromTrashBin(standaloneFormId: string): Pro
  */
 declare function restoreStandaloneFormFromTrashBin(standaloneFormId: string): Promise<RestoreStandaloneFormFromTrashBinResponse>;
 /**
- * Retrieves a standalone form record from the trash bin by ID.
- * @param standaloneFormId - Standalone form id
+ * Retrieves a standalone form from the trash bin.
+ * @param standaloneFormId - ID of the standalone form to retrieve from the trash bin.
  * @public
  * @documentationMaturity preview
  * @requiredField standaloneFormId
@@ -1349,7 +1378,9 @@ declare function restoreStandaloneFormFromTrashBin(standaloneFormId: string): Pr
  */
 declare function getDeletedStandaloneForm(standaloneFormId: string): Promise<GetDeletedStandaloneFormResponse>;
 /**
- * Retrieves a list of standalone form records that are in the trash bin.
+ * Retrieves a list of standalone forms in the trash bin.
+ *
+ * To retrieve specific standalone forms, specify their IDs in `standaloneFormIds`.
  * @public
  * @documentationMaturity preview
  * @permissionId WIX_FORMS.STANDALONE_FORM_READ
@@ -1359,19 +1390,31 @@ declare function getDeletedStandaloneForm(standaloneFormId: string): Promise<Get
 declare function listDeletedStandaloneForms(options?: ListDeletedStandaloneFormsOptions): Promise<NonNullablePaths<ListDeletedStandaloneFormsResponse, `standaloneForms`, 0>>;
 interface ListDeletedStandaloneFormsOptions {
     /**
-     * Standalone Form ids.
+     * IDs of the standalone forms to retrieve from the trash bin.
+     *
+     * Default: All standalone forms in the trash bin.
      * @maxSize 100
      * @maxLength 36
      */
     standaloneFormIds?: string[];
-    /** Cursor token pointing to a page of results. Not used in the first request. */
+    /** Cursor paging options. */
     paging?: CursorPaging;
 }
 /**
- * Retrieves a list of standalone forms, given the provided filtering, sorting, and paging.
+ * Retrieves a list of up to 100 standalone forms, given the provided paging, filtering, and sorting.
+ *
+ * Query Standalone Forms runs with these defaults, which you can override:
+ *
+ * - `createdDate` is sorted in `DESC` order
+ * - `cursorPaging.limit` is `50`
+ *
+ * Supported properties for filtering and sorting: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
  *
- * Supported filterable and sortable fields: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
- * @param query - WQL expression.
+ * To learn about working with Query methods, see
+ * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
+ * [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging),
+ * and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
+ * @param query - 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.
  * @public
  * @documentationMaturity preview
  * @requiredField query
@@ -1381,9 +1424,10 @@ interface ListDeletedStandaloneFormsOptions {
  */
 declare function queryStandaloneForms(query: CursorQuery): Promise<NonNullablePaths<QueryStandaloneFormsResponse, `standaloneForms`, 0>>;
 /**
- * Gets site properties (currency and locale) for the caller's standalone meta site.
+ * Retrieves the currency and locale of the site your request is authorized for.
  *
- * Results may be cached and are not guaranteed to reflect real-time changes.
+ * Use these values to display prices and labels correctly when you render a standalone form. Results may be cached,
+ * so recent changes to the site's settings might not appear right away.
  * @public
  * @documentationMaturity preview
  * @permissionId WIX_FORMS.STANDALONE_FORM_READ