@wix/auto_sdk_editor-branches_branches 1.0.0

package/build/internal/cjs/src/editor-branches-v1-branch-branches.types.d.ts

@@ -0,0 +1,468 @@
+/**
+ * A branch is a version of draft site content that can be edited independently. Also known as a test site.
+ * Read more about branches in this [article](https://support.wix.com/en/article/about-test-sites).
+ */
+export interface Branch extends BranchSourceOneOf {
+    /** Source branch properties. */
+    sourceBranchProperties?: SourceBranch;
+    /** Source template properties. */
+    sourceTemplateProperties?: SourceTemplate;
+    /**
+     * Branch ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the branch is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the branch.
+     * @readonly
+     */
+    revision?: string | null;
+    /** Branch type. */
+    type?: Type;
+    /**
+     * Branch name.
+     * @maxLength 50
+     */
+    name?: string | null;
+    /** Source type. */
+    sourceType?: SourceType;
+    /**
+     * Date and time the branch was last published, if relevant.
+     * @readonly
+     */
+    lastPublishDate?: string | null;
+    /** Editor type. */
+    editorType?: EditorType;
+    /**
+     * Date and time the branch was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the branch was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Custom field data for the branch.
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+}
+/** @oneof */
+export interface BranchSourceOneOf {
+    /** Source branch properties. */
+    sourceBranchProperties?: SourceBranch;
+    /** Source template properties. */
+    sourceTemplateProperties?: SourceTemplate;
+}
+export declare enum Type {
+    /** Unknown branch type. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** A branch created by a Wix user, that can be accessed for editing and publishing via the editor UI. */
+    USER = "USER",
+    /** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed via the editor UI. */
+    TECHNICAL = "TECHNICAL",
+    /** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. */
+    ORIGINAL_BRANCH = "ORIGINAL_BRANCH"
+}
+export declare enum SourceType {
+    /** Unknown source type. */
+    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
+    /** This branch's source was a branch. */
+    SOURCE_BRANCH = "SOURCE_BRANCH",
+    /** This branch's source was a template. For internal use. */
+    SOURCE_TEMPLATE = "SOURCE_TEMPLATE"
+}
+export declare enum EditorType {
+    /** Unknown editor type */
+    UNKNOWN_EDITOR_TYPE = "UNKNOWN_EDITOR_TYPE",
+    /** STUDIO */
+    STUDIO = "STUDIO",
+    /** CLASSIC */
+    CLASSIC = "CLASSIC"
+}
+export interface SourceBranch {
+    /**
+     * Source branch ID.
+     * @format GUID
+     */
+    branchId?: string;
+    /** Source branch revision. */
+    branchRevision?: string | null;
+}
+export interface SourceTemplate {
+    /**
+     * Source template ID.
+     * @format GUID
+     */
+    templateId?: string;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface CreateBranchRequest {
+    /** Branch to be created. */
+    branch: Branch;
+}
+export interface CreateBranchResponse {
+    /** Created branch. */
+    branch?: Branch;
+}
+export interface GetBranchRequest {
+    /**
+     * ID of branch to retrieve.
+     * @format GUID
+     */
+    branchId: string;
+}
+export interface GetBranchResponse {
+    /** Requested branch. */
+    branch?: Branch;
+}
+export interface UpdateBranchRequest {
+    /** Branch to be updated. */
+    branch: Branch;
+}
+export interface UpdateBranchResponse {
+    /** Updated branch. */
+    branch?: Branch;
+}
+export interface DeleteBranchRequest {
+    /**
+     * ID of branch to delete.
+     * @format GUID
+     */
+    branchId: string;
+}
+export interface DeleteBranchResponse {
+}
+export interface QueryBranchesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+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"}}`.
+     *
+     * Filterable fields:
+     *
+     * `type`
+     * `name`
+     * `updatedDate`
+     * `createdDate`
+     * `lastPublishDate`
+     * `sourceBranchProperties.branchId`
+     * `sourceBranchProperties.branchRevision`
+     *
+     * All operators are valid.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`.
+     *
+     * Sortable fields:
+     *
+     * `updatedDate`
+     * `createdDate`
+     * `lastPublishDate`
+     * @maxSize 5
+     */
+    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.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export 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;
+}
+export interface QueryBranchesResponse {
+    /** List of branches. */
+    branches?: Branch[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    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;
+}
+export 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;
+}
+export interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    id?: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace?: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData?: Record<string, any> | null;
+}
+export interface UpdateExtendedFieldsResponse {
+    /** Updated branch. */
+    branch?: Branch;
+}
+export interface HtmlSitePublished {
+    /**
+     * Application instance ID
+     * @maxLength 50
+     */
+    appInstanceId?: string;
+    /**
+     * Application type
+     * @maxLength 100
+     */
+    appType?: string;
+    /** Revision */
+    revision?: string;
+    /**
+     * MSID
+     * @maxLength 100
+     */
+    metaSiteId?: string | null;
+    /**
+     * optional branch id if publish is done from branch
+     * @format GUID
+     */
+    branchId?: string | null;
+    /** The site's last transactionId */
+    lastTransactionId?: string | null;
+    /** A list of the site's pages */
+    pages?: Page[];
+    /** Site's publish date */
+    publishDate?: string;
+}
+export interface Page {
+    /**
+     * Page's Id
+     * @maxLength 100
+     */
+    id?: string;
+}
+export interface Empty {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    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;
+    /** 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 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;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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 {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface SourceBranchNonNullableFields {
+    branchId: string;
+}
+interface SourceTemplateNonNullableFields {
+    templateId: string;
+}
+interface BranchNonNullableFields {
+    sourceBranchProperties?: SourceBranchNonNullableFields;
+    sourceTemplateProperties?: SourceTemplateNonNullableFields;
+    type: Type;
+    sourceType: SourceType;
+    editorType: EditorType;
+}
+export interface CreateBranchResponseNonNullableFields {
+    branch?: BranchNonNullableFields;
+}
+export interface GetBranchResponseNonNullableFields {
+    branch?: BranchNonNullableFields;
+}
+export interface UpdateBranchResponseNonNullableFields {
+    branch?: BranchNonNullableFields;
+}
+export interface QueryBranchesResponseNonNullableFields {
+    branches: BranchNonNullableFields[];
+}
+export {};

package/build/internal/cjs/src/editor-branches-v1-branch-branches.types.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.SortOrder = exports.EditorType = exports.SourceType = exports.Type = void 0;
+var Type;
+(function (Type) {
+    /** Unknown branch type. */
+    Type["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
+    /** A branch created by a Wix user, that can be accessed for editing and publishing via the editor UI. */
+    Type["USER"] = "USER";
+    /** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed via the editor UI. */
+    Type["TECHNICAL"] = "TECHNICAL";
+    /** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. */
+    Type["ORIGINAL_BRANCH"] = "ORIGINAL_BRANCH";
+})(Type || (exports.Type = Type = {}));
+var SourceType;
+(function (SourceType) {
+    /** Unknown source type. */
+    SourceType["UNKNOWN_SOURCE_TYPE"] = "UNKNOWN_SOURCE_TYPE";
+    /** This branch's source was a branch. */
+    SourceType["SOURCE_BRANCH"] = "SOURCE_BRANCH";
+    /** This branch's source was a template. For internal use. */
+    SourceType["SOURCE_TEMPLATE"] = "SOURCE_TEMPLATE";
+})(SourceType || (exports.SourceType = SourceType = {}));
+var EditorType;
+(function (EditorType) {
+    /** Unknown editor type */
+    EditorType["UNKNOWN_EDITOR_TYPE"] = "UNKNOWN_EDITOR_TYPE";
+    /** STUDIO */
+    EditorType["STUDIO"] = "STUDIO";
+    /** CLASSIC */
+    EditorType["CLASSIC"] = "CLASSIC";
+})(EditorType || (exports.EditorType = EditorType = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=editor-branches-v1-branch-branches.types.js.map

package/build/internal/cjs/src/editor-branches-v1-branch-branches.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor-branches-v1-branch-branches.types.js","sourceRoot":"","sources":["../../../../src/editor-branches-v1-branch-branches.types.ts"],"names":[],"mappings":";;;AA+DA,IAAY,IASX;AATD,WAAY,IAAI;IACd,2BAA2B;IAC3B,qCAA6B,CAAA;IAC7B,yGAAyG;IACzG,qBAAa,CAAA;IACb,iIAAiI;IACjI,+BAAuB,CAAA;IACvB,mIAAmI;IACnI,2CAAmC,CAAA;AACrC,CAAC,EATW,IAAI,oBAAJ,IAAI,QASf;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,yDAA2C,CAAA;IAC3C,yCAAyC;IACzC,6CAA+B,CAAA;IAC/B,6DAA6D;IAC7D,iDAAmC,CAAA;AACrC,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,0BAA0B;IAC1B,yDAA2C,CAAA;IAC3C,aAAa;IACb,+BAAiB,CAAA;IACjB,cAAc;IACd,iCAAmB,CAAA;AACrB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAgID,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA4PD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}