@wix/forms 1.0.0

package/build/es/src/forms-v4-submission.types.d.ts

@@ -0,0 +1,412 @@
+export interface FormSubmission {
+    /**
+     * Submission id.
+     * @readonly
+     */
+    id?: string | null;
+    /** Id of a form to which submission belongs. */
+    formId?: string;
+    /**
+     * Form namespace to which submissions belong.
+     * @readonly
+     */
+    namespace?: string;
+    /** Status of the submission. */
+    status?: SubmissionStatus;
+    /** Submission values where key is a target of a form field and value is a submissions for the given field. */
+    submissions?: Record<string, any>;
+    /**
+     * Date of creation.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date of last update.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Identification of submission creator
+     * @readonly
+     */
+    submitter?: Submitter;
+    /** Flag identifying if submission was read by user */
+    seen?: boolean;
+}
+export declare enum SubmissionStatus {
+    UNDEFINED = "UNDEFINED",
+    PENDING = "PENDING",
+    CONFIRMED = "CONFIRMED"
+}
+export interface Owner extends OwnerOwnerOneOf {
+    /** Member ID. */
+    memberId?: string | null;
+    /** Visitor ID. */
+    visitorId?: string | null;
+    /** Service ID. */
+    serviceId?: string | null;
+    /** User ID. */
+    userId?: string | null;
+    /** External app id */
+    externalAppId?: string | null;
+}
+/** @oneof */
+export interface OwnerOwnerOneOf {
+    /** Member ID. */
+    memberId?: string | null;
+    /** Visitor ID. */
+    visitorId?: string | null;
+    /** Service ID. */
+    serviceId?: string | null;
+    /** User ID. */
+    userId?: string | null;
+    /** External app id */
+    externalAppId?: string | null;
+}
+export interface Submitter extends SubmitterSubmitterOneOf {
+    /** Member ID. */
+    memberId?: string | null;
+    /** Visitor ID. */
+    visitorId?: string | null;
+    /** Service ID. */
+    serviceId?: string | null;
+    /** User ID. */
+    userId?: string | null;
+    /** External app id */
+    externalAppId?: string | null;
+}
+/** @oneof */
+export interface SubmitterSubmitterOneOf {
+    /** Member ID. */
+    memberId?: string | null;
+    /** Visitor ID. */
+    visitorId?: string | null;
+    /** Service ID. */
+    serviceId?: string | null;
+    /** User ID. */
+    userId?: string | null;
+    /** External app id */
+    externalAppId?: string | null;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+    /** random GUID so clients can tell if event was already handled */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /**
+     * Assuming that all messages including Actions have id
+     * Example: The id of the specific order, the id of a specific campaign
+     */
+    entityId?: string;
+    /** The time of the event. Useful if there was a delay in dispatching */
+    eventTime?: Date;
+    /**
+     * A field that should be set if this event was triggered by an anonymize request.
+     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
+     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export 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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface ExtendedFieldsUpdatedEvent {
+    currentEntityAsJson?: string;
+}
+export interface Empty {
+}
+export interface UpsertContactFromSubmissionRequest {
+    /** Submission from which contact needs to be upserted. */
+    submissionId?: string;
+    /** Optional contact id to which submission should be mapped. */
+    contactId?: string | null;
+    /** Indicates contact has verified primary email. */
+    emailVerified?: boolean;
+}
+export interface UpsertContactFromSubmissionResponse {
+    /** Submit contact response. */
+    submitContactResponse?: SubmitContactResponse;
+}
+export interface SubmitContactResponse {
+    /** ID of the contact that was found or created. */
+    contactId?: string;
+    /**
+     * Identity type of the returned contact.
+     *
+     * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
+     * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
+     * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
+     */
+    identityType?: IdentityType;
+    /**
+     * Indicates whether the contact was just created or already existed.
+     *
+     * If the contact was just created, returns `true`.
+     * If it already existed, returns `false`.
+     */
+    newContact?: boolean;
+}
+export declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    /** Existing or new contact */
+    CONTACT = "CONTACT",
+    /** Member is logged in, matching logic skipped */
+    MEMBER = "MEMBER",
+    /** Matching contact is a member, Merge logic won't be applied */
+    NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
+}
+export interface SubmissionContactMapped {
+    /**
+     * Mapped upserted contact ID.
+     * @readonly
+     */
+    contactId?: string;
+    /**
+     * Mapped contact emails.
+     * @readonly
+     */
+    emails?: string[];
+    /** Identifies the namespace that the submission's form belongs to. */
+    namespace?: string;
+}
+export interface CreateSubmissionRequest {
+    /** Submission to be created. */
+    submission: FormSubmission;
+    /** Captcha token */
+    captchaToken?: string | null;
+}
+export interface CreateSubmissionResponse {
+    /** The created submission. */
+    submission?: FormSubmission;
+}
+export interface CreateSubmissionByOwnerRequest {
+    /** Submission to be created. */
+    submission?: FormSubmission;
+}
+export interface CreateSubmissionByOwnerResponse {
+    /** The created submission. */
+    submission?: FormSubmission;
+}
+export interface GetSubmissionRequest {
+    /** Id of the submission to retrieve. */
+    submissionId: string;
+}
+export interface GetSubmissionResponse {
+    /** The retrieved submission. */
+    submission?: FormSubmission;
+}
+export interface UpdateSubmissionRequest {
+    /** Submission to be updated, may be partial. */
+    submission: FormSubmission;
+}
+export interface UpdateSubmissionResponse {
+    /** The updated submission. */
+    submission?: FormSubmission;
+}
+export interface ConfirmSubmissionRequest {
+    /** Submission id. */
+    submissionId: string;
+}
+export interface ConfirmSubmissionResponse {
+    /** Confirmed submission. */
+    submission?: FormSubmission;
+}
+export interface DeleteSubmissionRequest {
+    /** Id of the submission to delete. */
+    submissionId: string;
+}
+export interface DeleteSubmissionResponse {
+}
+export interface QuerySubmissionRequest {
+    /** WQL expression. */
+    query: CursorQuery;
+    /** Return only own submissions. */
+    onlyYourOwn?: boolean;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QuerySubmissionResponse {
+    /** The retrieved Submissions. */
+    submissions?: FormSubmission[];
+    /** Paging metadata. */
+    metadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface CountSubmissionsRequest {
+    /** Form IDs. */
+    formIds: string[];
+    /** Identifies the namespace that the forms belong to. */
+    namespace: string;
+}
+export interface CountSubmissionsResponse {
+    /** Forms submissions count. */
+    formsSubmissionsCount?: FormSubmissionsCount[];
+}
+export interface FormSubmissionsCount {
+    /** Form ID. */
+    formId?: string;
+    /** Total form submissions count. */
+    totalCount?: number;
+    /** Unseen form submissions count. */
+    unseenCount?: number;
+}
+export interface GetMediaUploadURLRequest {
+    /** Form id. */
+    formId: string;
+    /** Name of file to upload. */
+    filename: string;
+    /** Mime type of file to upload. */
+    mimeType: string;
+}
+export interface GetMediaUploadURLResponse {
+    /** Url to upload file. */
+    uploadUrl?: string;
+}
+export interface BulkMarkSubmissionsAsSeenRequest {
+    /** Submission ids to mark as seen. */
+    ids: string[];
+    /** Submissions form id. */
+    formId: string;
+}
+export interface BulkMarkSubmissionsAsSeenResponse {
+}
+export interface Task {
+    key?: TaskKey;
+    executeAt?: Date;
+    payload?: string | null;
+}
+export interface TaskKey {
+    appId?: string;
+    instanceId?: string;
+    subjectId?: string | null;
+}
+export interface TaskAction extends TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+/** @oneof */
+export interface TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+export interface Complete {
+}
+export interface Cancel {
+}
+export interface Reschedule {
+    executeAt?: Date;
+    payload?: string | null;
+}

package/build/es/src/forms-v4-submission.types.js

@@ -0,0 +1,22 @@
+export var SubmissionStatus;
+(function (SubmissionStatus) {
+    SubmissionStatus["UNDEFINED"] = "UNDEFINED";
+    SubmissionStatus["PENDING"] = "PENDING";
+    SubmissionStatus["CONFIRMED"] = "CONFIRMED";
+})(SubmissionStatus || (SubmissionStatus = {}));
+export var IdentityType;
+(function (IdentityType) {
+    IdentityType["UNKNOWN"] = "UNKNOWN";
+    /** Existing or new contact */
+    IdentityType["CONTACT"] = "CONTACT";
+    /** Member is logged in, matching logic skipped */
+    IdentityType["MEMBER"] = "MEMBER";
+    /** Matching contact is a member, Merge logic won't be applied */
+    IdentityType["NOT_AUTHENTICATED_MEMBER"] = "NOT_AUTHENTICATED_MEMBER";
+})(IdentityType || (IdentityType = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+//# sourceMappingURL=forms-v4-submission.types.js.map

package/build/es/src/forms-v4-submission.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forms-v4-submission.types.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.types.ts"],"names":[],"mappings":"AAyCA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;AACzB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAyKD,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,kDAAkD;IAClD,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qEAAqD,CAAA;AACvD,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AAmHD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}