@wix/auto_sdk_restaurants_operation-groups 1.0.0

package/build/es/src/restaurants-v1-operation-group-operation-groups.types.d.ts

@@ -0,0 +1,588 @@
+/**
+ * An operation group is a aggregation of operations that each one of them point to a different location.
+ * Each operation group has different ordering page.
+ */
+export interface OperationGroup {
+    /**
+     * OperationsGroup ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the OperationsGroup is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the OperationsGroup.
+     *
+     * Ignored when creating a OperationsGroup.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the OperationsGroup was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the OperationsGroup was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * The name of the operations group
+     * @minLength 1
+     * @maxLength 500
+     */
+    name?: string | null;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+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>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+export interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+export interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+export interface CreateOperationGroupRequest {
+    /** OperationGroup to be created. */
+    operationGroup: OperationGroup;
+}
+export interface CreateOperationGroupResponse {
+    /** The created OperationGroup. */
+    operationGroup?: OperationGroup;
+}
+export interface GetOperationGroupRequest {
+    /**
+     * ID of the OperationGroup to retrieve.
+     * @format GUID
+     */
+    operationGroupId: string;
+}
+export interface GetOperationGroupResponse {
+    /** The requested OperationGroup. */
+    operationGroup?: OperationGroup;
+}
+export interface UpdateOperationGroupRequest {
+    /** OperationGroup to be updated, may be partial. */
+    operationGroup: OperationGroup;
+}
+export interface UpdateOperationGroupResponse {
+    /** Updated OperationGroup. */
+    operationGroup?: OperationGroup;
+}
+export interface DeleteOperationGroupRequest {
+    /**
+     * Id of the OperationGroup to delete.
+     * @format GUID
+     */
+    operationGroupId: string;
+}
+export interface DeleteOperationGroupResponse {
+}
+export interface QueryOperationGroupsRequest {
+    /** 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"}
+     * }`
+     * 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"}]`
+     * @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 QueryOperationGroupsResponse {
+    /** List of OperationGroups. */
+    operationGroups?: OperationGroup[];
+    /** 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 OperationGroup. */
+    operationGroup?: OperationGroup;
+}
+export interface BulkCreateOperationGroupsRequest {
+    /**
+     * List of OperationGroups to be created
+     * @minSize 1
+     * @maxSize 100
+     */
+    operationGroups: OperationGroup[];
+    /** set to `true` if you wish to receive back the created OperationGroups in the response */
+    returnEntity?: boolean;
+}
+export interface BulkCreateOperationGroupsResponse {
+    /**
+     * List of the bulk create operation results including the OperationGroups and metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkOperationGroupResult[];
+    /** Metadata regarding the bulk create operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkOperationGroupResult {
+    /** Metadata regarding the specific single create operation */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: OperationGroup;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface BulkUpdateOperationGroupsRequest {
+    /**
+     * List of OperationGroups to be updated.
+     * @minSize 1
+     * @maxSize 100
+     */
+    operationGroups: MaskedOperationGroup[];
+    /** set to `true` if you wish to receive back the updated OperationGroups in the response */
+    returnEntity?: boolean;
+}
+export interface MaskedOperationGroup {
+    /** OperationGroup to be updated, may be partial */
+    operationGroup?: OperationGroup;
+}
+export interface BulkUpdateOperationGroupsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateOperationGroupsResponseBulkOperationGroupResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateOperationGroupsResponseBulkOperationGroupResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: OperationGroup;
+}
+export interface BulkDeleteOperationGroupsRequest {
+    /**
+     * OperationGroup ids to be deleted
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    operationGroupIds: string[];
+}
+export interface BulkDeleteOperationGroupsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeleteOperationGroupsResponseBulkOperationGroupResult[];
+    /** Metadata regarding the bulk delete operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteOperationGroupsResponseBulkOperationGroupResult {
+    /** Metadata regarding the specific single delete operation */
+    itemMetadata?: ItemMetadata;
+}
+export interface BulkUpdateOperationGroupTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    ids: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateOperationGroupTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateOperationGroupTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateOperationGroupTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+export interface BulkUpdateOperationGroupTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateOperationGroupTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+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 TagListNonNullableFields {
+    tagIds: string[];
+}
+interface TagsNonNullableFields {
+    privateTags?: TagListNonNullableFields;
+    tags?: TagListNonNullableFields;
+}
+interface OperationGroupNonNullableFields {
+    tags?: TagsNonNullableFields;
+}
+export interface CreateOperationGroupResponseNonNullableFields {
+    operationGroup?: OperationGroupNonNullableFields;
+}
+export interface GetOperationGroupResponseNonNullableFields {
+    operationGroup?: OperationGroupNonNullableFields;
+}
+export interface UpdateOperationGroupResponseNonNullableFields {
+    operationGroup?: OperationGroupNonNullableFields;
+}
+export interface QueryOperationGroupsResponseNonNullableFields {
+    operationGroups: OperationGroupNonNullableFields[];
+}
+export interface UpdateExtendedFieldsResponseNonNullableFields {
+    operationGroup?: OperationGroupNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkOperationGroupResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: OperationGroupNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateOperationGroupsResponseNonNullableFields {
+    results: BulkOperationGroupResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkUpdateOperationGroupsResponseBulkOperationGroupResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: OperationGroupNonNullableFields;
+}
+export interface BulkUpdateOperationGroupsResponseNonNullableFields {
+    results: BulkUpdateOperationGroupsResponseBulkOperationGroupResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkDeleteOperationGroupsResponseBulkOperationGroupResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+export interface BulkDeleteOperationGroupsResponseNonNullableFields {
+    results: BulkDeleteOperationGroupsResponseBulkOperationGroupResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkUpdateOperationGroupTagsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+export interface BulkUpdateOperationGroupTagsResponseNonNullableFields {
+    results: BulkUpdateOperationGroupTagsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkUpdateOperationGroupTagsByFilterResponseNonNullableFields {
+    jobId: string;
+}
+export {};

package/build/es/src/restaurants-v1-operation-group-operation-groups.types.js

@@ -0,0 +1,14 @@
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=restaurants-v1-operation-group-operation-groups.types.js.map

package/build/es/src/restaurants-v1-operation-group-operation-groups.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restaurants-v1-operation-group-operation-groups.types.js","sourceRoot":"","sources":["../../../src/restaurants-v1-operation-group-operation-groups.types.ts"],"names":[],"mappings":"AAgLA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AA2XD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}