@wix/auto_sdk_standalone-forms_standalone-forms 1.0.1 → 1.0.2

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

@@ -1,28 +1,33 @@
 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.mjs';
 import '@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
      */
@@ -38,10 +43,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
      */
@@ -51,38 +59,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`
      */
@@ -92,7 +100,7 @@ interface DeleteStandaloneFormResponse {
 }
 interface RemoveStandaloneFormFromTrashBinRequest {
     /**
-     * Standalone form id
+     * ID of the standalone form to permanently delete.
      * @maxLength 36
      */
     standaloneFormId: string;
@@ -101,34 +109,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 {
@@ -149,11 +159,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 {
@@ -181,7 +191,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 {
@@ -225,21 +235,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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_standalone-forms_standalone-forms",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.forms.v1.standalone_form"
     }
   },
-  "falconPackageHash": "784af80648753c2da37af55c84da0a49f218e6999d83f40d8fe63309"
+  "falconPackageHash": "cf4d5229f893a177c6eabfe7ac62d09b3e838e39dc60bfa7d8fa1afd"
 }