@wix/auto_sdk_intake-forms_intake-forms 1.0.0

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

@@ -0,0 +1,474 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface IntakeForm {
+    /**
+     * Intake form ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Expiration period in months. If not set, submissions don't expire.
+     * @min 1
+     * @max 60
+     */
+    expirationPeriodInMonths?: number | null;
+    /**
+     * Whether the intake form is archived and disabled from accepting new submissions.
+     * @readonly
+     */
+    archived?: boolean | null;
+    /**
+     * Intake form name.
+     * @minLength 1
+     * @maxLength 100
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * Date and time the intake form was created in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the intake form was updated in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the intake form is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the intake form.
+     * @readonly
+     */
+    revision?: string | null;
+}
+interface QueryIntakeFormsRequest {
+    /**
+     * Filter object.
+     * See @API Query Language
+     * for more information.
+     *
+     * For a detailed list of supported filters, see
+     * @Supported Filters.
+     */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryIntakeFormsResponse {
+    /** Retrieved intake forms. */
+    intakeForms?: IntakeForm[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface UpdateIntakeFormExpirationPeriodRequest {
+    /**
+     * Intake form ID.
+     * @format GUID
+     */
+    intakeFormId: string | null;
+    /**
+     * New expiration period in months. If not set, submissions don't expire.
+     * @min 1
+     * @max 60
+     */
+    expirationPeriodInMonths?: number | null;
+    /**
+     * Revision number, which increments by 1 each time the intake form is updated.
+     * To prevent conflicting changes, you must specify the current revision when updating the intake form.
+     */
+    formRevision: string | null;
+}
+interface UpdateIntakeFormExpirationPeriodResponse {
+    /** Updated intake form. */
+    intakeForm?: IntakeForm;
+}
+interface CreateCustomerSubmissionLinkRequest {
+    /**
+     * Intake form ID.
+     * @format GUID
+     */
+    intakeFormId: string | null;
+    /**
+     * [Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction) ID to personalize and pre-fill the submission with the contact's information.
+     * @format GUID
+     */
+    contactId?: string | null;
+}
+interface CreateCustomerSubmissionLinkResponse {
+    /**
+     * Generated link URL for the intake form submission.
+     * @minLength 1
+     * @maxLength 2048
+     */
+    intakeFormUrl?: string | null;
+    /**
+     * Encrypted token containing contact details. Available only if you specified `contactId` in request.
+     * @maxLength 2048
+     */
+    token?: string | null;
+}
+interface DeleteIntakeFormRequest {
+    /**
+     * Intake form ID.
+     * @format GUID
+     */
+    intakeFormId: string | null;
+}
+interface DeleteIntakeFormResponse {
+}
+interface ArchiveIntakeFormRequest {
+    /**
+     * Intake form ID.
+     * @format GUID
+     */
+    intakeFormId: string | null;
+    /**
+     * Revision number, which increments by 1 each time the intake form is updated.
+     * To prevent conflicting changes, you must specify the current revision when updating the intake form.
+     */
+    formRevision: string | null;
+}
+interface ArchiveIntakeFormResponse {
+    /** Archived intake form. */
+    intakeForm?: IntakeForm;
+}
+interface UnarchiveIntakeFormRequest {
+    /**
+     * Intake form ID.
+     * @format GUID
+     */
+    intakeFormId: string | null;
+    /**
+     * Revision number, which increments by 1 each time the intake form is updated.
+     * To prevent conflicting changes, you must specify the current revision when updating the intake form.
+     */
+    formRevision: string | null;
+}
+interface UnarchiveIntakeFormResponse {
+    /** Unarchived intake form. */
+    intakeForm?: IntakeForm;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface DecryptContactDetailsFromTokenRequest {
+    /**
+     * Encrypted token containing contact details and creation timestamp.
+     * Generated by [Create Customer Submission Link](TODO) when a `contactId` is provided.
+     * @minLength 1
+     * @maxLength 2048
+     */
+    token?: string;
+}
+interface DecryptContactDetailsFromTokenResponse {
+    /** Contact details extracted from the token. */
+    contactDetails?: ContactDetails;
+}
+interface ContactDetails {
+    /**
+     * Contact email address. Always present.
+     * @format EMAIL
+     */
+    email?: string;
+    /**
+     * Contact first name. Present when the contact record has a first name.
+     * @maxLength 200
+     */
+    firstName?: string | null;
+    /**
+     * Contact last name. Present when the contact record has a last name.
+     * @maxLength 200
+     */
+    lastName?: string | null;
+}
+/** @docsIgnore */
+type CreateCustomerSubmissionLinkApplicationErrors = {
+    code?: 'MISSING_SITE_URL';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Retrieves a list of intake forms, with the specified paging, filtering, and sorting.
+ *
+ *
+ * QueryIntakeForms runs with these defaults, which you can override:
+ *
+ * - `createdDate` is sorted in `DESC` order.
+ * - `paging.limit` is `50`.
+ * - `paging.offset` is `0`.
+ *
+ * For field support for filters and sorting, see [Supported Filters and Sorting](TODO: Add link).
+ *
+ * Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId INTAKE_FORM.INTAKE_FORM_READ
+ * @fqn wix.intakeforms.v1.IntakeFormsService.QueryIntakeForms
+ */
+declare function queryIntakeForms(options?: QueryIntakeFormsOptions): Promise<NonNullablePaths<QueryIntakeFormsResponse, `intakeForms`, 2>>;
+interface QueryIntakeFormsOptions {
+    /**
+     * Filter object.
+     * See
+     * @API Query Language
+     * for more information.
+     *
+     * For a detailed list of supported filters, see
+     * @Supported Filters.
+     */
+    query?: CursorQuery;
+}
+/**
+ * Updates the expiration period of a specific intake form.
+ *
+ *
+ * Each time the intake form is updated, `revision` increments by 1.
+ * You must specify the current `revision` when updating the intake form.
+ * This ensures you're working with the latest intake form and prevents unintended overwrites.
+ * @param intakeFormId - Intake form ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField intakeFormId
+ * @requiredField options.formRevision
+ * @permissionId INTAKE_FORM.INTAKE_FORM_UPDATE
+ * @fqn wix.intakeforms.v1.IntakeFormsService.UpdateIntakeFormExpirationPeriod
+ */
+declare function updateIntakeFormExpirationPeriod(intakeFormId: string, options?: NonNullablePaths<UpdateIntakeFormExpirationPeriodOptions, `formRevision`, 2>): Promise<UpdateIntakeFormExpirationPeriodResponse>;
+interface UpdateIntakeFormExpirationPeriodOptions {
+    /**
+     * New expiration period in months. If not set, submissions don't expire.
+     * @min 1
+     * @max 60
+     */
+    expirationPeriodInMonths?: number | null;
+    /**
+     * Revision number, which increments by 1 each time the intake form is updated.
+     * To prevent conflicting changes, you must specify the current revision when updating the intake form.
+     */
+    formRevision: string | null;
+}
+/**
+ * Creates a shareable link for customers to submit an intake form.
+ *
+ *
+ * The link allows customers to submit their intake form submission.
+ *
+ * If you specify `contactId`, the link is personalized and pre-fills the submission with the [contact's](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction) information.
+ * @param intakeFormId - Intake form ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField intakeFormId
+ * @permissionId INTAKE_FORMS.CUSTOMER_SUBMISSION_LINK_CREATE
+ * @fqn wix.intakeforms.v1.IntakeFormsService.CreateCustomerSubmissionLink
+ */
+declare function createCustomerSubmissionLink(intakeFormId: string, options?: CreateCustomerSubmissionLinkOptions): Promise<CreateCustomerSubmissionLinkResponse & {
+    __applicationErrorsType?: CreateCustomerSubmissionLinkApplicationErrors;
+}>;
+interface CreateCustomerSubmissionLinkOptions {
+    /**
+     * [Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction) ID to personalize and pre-fill the submission with the contact's information.
+     * @format GUID
+     */
+    contactId?: string | null;
+}
+/**
+ * Deletes an intake form.
+ *
+ *
+ * Also deletes the underlying [Wix form](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction).
+ *
+ * Existing [submissions](TODO) for the intake form aren't automatically deleted but become orphaned.
+ * When [querying submissions](TODO), orphaned submissions aren't returned.
+ * @param intakeFormId - Intake form ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField intakeFormId
+ * @permissionId INTAKE_FORM.INTAKE_FORM_DELETE
+ * @fqn wix.intakeforms.v1.IntakeFormsService.DeleteIntakeForm
+ */
+declare function deleteIntakeForm(intakeFormId: string): Promise<void>;
+/**
+ * Archives an intake form, disabling it from accepting new submissions.
+ *
+ *
+ * Each time the intake form is updated, `revision` increments by 1.
+ * You must specify the current `revision` when updating the intake form.
+ * This ensures you're working with the latest intake form and prevents unintended overwrites.
+ *
+ * You can [unarchive](TODO) the form later to resume accepting submissions.
+ * @param intakeFormId - Intake form ID.
+ * @param formRevision - Revision number, which increments by 1 each time the intake form is updated.
+ * To prevent conflicting changes, you must specify the current revision when updating the intake form.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formRevision
+ * @requiredField intakeFormId
+ * @permissionId INTAKE_FORM.INTAKE_FORM_UPDATE
+ * @fqn wix.intakeforms.v1.IntakeFormsService.ArchiveIntakeForm
+ */
+declare function archiveIntakeForm(intakeFormId: string, formRevision: string): Promise<ArchiveIntakeFormResponse>;
+/**
+ * Unarchives an intake form, enabling it to accept new submissions.
+ *
+ *
+ * Each time the intake form is updated, `revision` increments by 1.
+ * You must specify the current `revision` when updating the intake form.
+ * This ensures you're working with the latest intake form and prevents unintended overwrites.
+ * @param intakeFormId - Intake form ID.
+ * @param formRevision - Revision number, which increments by 1 each time the intake form is updated.
+ * To prevent conflicting changes, you must specify the current revision when updating the intake form.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formRevision
+ * @requiredField intakeFormId
+ * @permissionId INTAKE_FORM.INTAKE_FORM_UPDATE
+ * @fqn wix.intakeforms.v1.IntakeFormsService.UnarchiveIntakeForm
+ */
+declare function unarchiveIntakeForm(intakeFormId: string, formRevision: string): Promise<UnarchiveIntakeFormResponse>;
+
+export { type ActionEvent, type ArchiveIntakeFormRequest, type ArchiveIntakeFormResponse, type ContactDetails, type CreateCustomerSubmissionLinkApplicationErrors, type CreateCustomerSubmissionLinkOptions, type CreateCustomerSubmissionLinkRequest, type CreateCustomerSubmissionLinkResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DecryptContactDetailsFromTokenRequest, type DecryptContactDetailsFromTokenResponse, type DeleteIntakeFormRequest, type DeleteIntakeFormResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IntakeForm, type QueryIntakeFormsOptions, type QueryIntakeFormsRequest, type QueryIntakeFormsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type UnarchiveIntakeFormRequest, type UnarchiveIntakeFormResponse, type UpdateIntakeFormExpirationPeriodOptions, type UpdateIntakeFormExpirationPeriodRequest, type UpdateIntakeFormExpirationPeriodResponse, archiveIntakeForm, createCustomerSubmissionLink, deleteIntakeForm, queryIntakeForms, unarchiveIntakeForm, updateIntakeFormExpirationPeriod };