@wix/auto_sdk_standalone-forms_standalone-forms 1.0.1 → 1.0.2

package/build/cjs/index.d.ts

@@ -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;