@wix/auto_sdk_standalone-forms_standalone-forms 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,114 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { GetOrCreateFormStandaloneMetaSiteResponse, StandaloneForm, CreateStandaloneFormApplicationErrors, DeleteStandaloneFormOptions, RestoreStandaloneFormFromTrashBinResponse, GetDeletedStandaloneFormResponse, ListDeletedStandaloneFormsOptions, ListDeletedStandaloneFormsResponse, CursorQuery, QueryStandaloneFormsResponse, GetSitePropertiesResponse, GetSitePropertiesApplicationErrors } from './index.typings.js';
+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.js';
+
+declare function getOrCreateFormStandaloneMetaSite$1(httpClient: HttpClient): GetOrCreateFormStandaloneMetaSiteSignature;
+interface GetOrCreateFormStandaloneMetaSiteSignature {
+    /**
+     * Returns the standalone meta site owned by the caller's account, provisioning a new siteless
+     * meta site if one doesn't exist yet.
+     *
+     * Use this when the caller doesn't already have a meta site, for example when a form is built
+     * before the user becomes a Wix user. The returned meta site can then own standalone forms.
+     */
+    (): Promise<NonNullablePaths<GetOrCreateFormStandaloneMetaSiteResponse, `metaSiteId`, 0>>;
+}
+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.
+     *
+     * 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
+     */
+    (standaloneForm: NonNullablePaths<StandaloneForm, `formId`, 0>): Promise<StandaloneForm & {
+        __applicationErrorsType?: CreateStandaloneFormApplicationErrors;
+    }>;
+}
+declare function getStandaloneForm$1(httpClient: HttpClient): GetStandaloneFormSignature;
+interface GetStandaloneFormSignature {
+    /**
+     * Retrieves a standalone form by ID.
+     * @param - Standalone form id
+     * @returns Standalone form
+     */
+    (standaloneFormId: string): Promise<StandaloneForm>;
+}
+declare function deleteStandaloneForm$1(httpClient: HttpClient): DeleteStandaloneFormSignature;
+interface DeleteStandaloneFormSignature {
+    /**
+     * Deletes a standalone form record
+     *
+     * By default the record is moved to the trash bin. Set `permanent` to `true` to delete it permanently.
+     * @param - Standalone form id
+     */
+    (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
+     */
+    (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
+     */
+    (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
+     */
+    (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.
+     */
+    (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.
+     *
+     * Supported filterable and sortable fields: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
+     * @param - WQL expression.
+     */
+    (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.
+     *
+     * Results may be cached and are not guaranteed to reflect real-time changes.
+     */
+    (): Promise<NonNullablePaths<GetSitePropertiesResponse, `siteProperties.localeLanguageCode` | `siteProperties.localeCountry`, 1> & {
+        __applicationErrorsType?: GetSitePropertiesApplicationErrors;
+    }>;
+}
+
+declare const getOrCreateFormStandaloneMetaSite: MaybeContext<BuildRESTFunction<typeof getOrCreateFormStandaloneMetaSite$1> & typeof getOrCreateFormStandaloneMetaSite$1>;
+declare const createStandaloneForm: MaybeContext<BuildRESTFunction<typeof createStandaloneForm$1> & typeof createStandaloneForm$1>;
+declare const getStandaloneForm: MaybeContext<BuildRESTFunction<typeof getStandaloneForm$1> & typeof getStandaloneForm$1>;
+declare const deleteStandaloneForm: MaybeContext<BuildRESTFunction<typeof deleteStandaloneForm$1> & typeof deleteStandaloneForm$1>;
+declare const removeStandaloneFormFromTrashBin: MaybeContext<BuildRESTFunction<typeof removeStandaloneFormFromTrashBin$1> & typeof removeStandaloneFormFromTrashBin$1>;
+declare const restoreStandaloneFormFromTrashBin: MaybeContext<BuildRESTFunction<typeof restoreStandaloneFormFromTrashBin$1> & typeof restoreStandaloneFormFromTrashBin$1>;
+declare const getDeletedStandaloneForm: MaybeContext<BuildRESTFunction<typeof getDeletedStandaloneForm$1> & typeof getDeletedStandaloneForm$1>;
+declare const listDeletedStandaloneForms: MaybeContext<BuildRESTFunction<typeof listDeletedStandaloneForms$1> & typeof listDeletedStandaloneForms$1>;
+declare const queryStandaloneForms: MaybeContext<BuildRESTFunction<typeof queryStandaloneForms$1> & typeof queryStandaloneForms$1>;
+declare const getSiteProperties: MaybeContext<BuildRESTFunction<typeof getSiteProperties$1> & typeof getSiteProperties$1>;
+
+export { CreateStandaloneFormApplicationErrors, CursorQuery, DeleteStandaloneFormOptions, GetDeletedStandaloneFormResponse, GetOrCreateFormStandaloneMetaSiteResponse, GetSitePropertiesApplicationErrors, GetSitePropertiesResponse, ListDeletedStandaloneFormsOptions, ListDeletedStandaloneFormsResponse, QueryStandaloneFormsResponse, RestoreStandaloneFormFromTrashBinResponse, StandaloneForm, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getOrCreateFormStandaloneMetaSite, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };