@wix/auto_sdk_benefit-programs_items 1.0.0

package/build/internal/cjs/src/benefit-programs-v1-item-items.types.d.ts

@@ -0,0 +1,592 @@
+export interface Item {
+    /**
+     * Benefit item ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the benefit item is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the item.
+     *
+     * Ignored when creating an item.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the item was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * External item ID assigned by the provider of the items.
+     *
+     * For example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system.
+     */
+    externalId?: string;
+    /** Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups. */
+    category?: string | null;
+    /**
+     * ID that is a shared reference between a benefit pool and a specific item.
+     *
+     * This ID is returned when calling the Create Pool Definition method in the Pool Definitions API.
+     *
+     * It is used to link the specific benefit item to its corresponding location within the benefit pool.
+     */
+    itemSetId?: string;
+    /** Display name of the item. For example, a concert ticket or an exercise session with a personal trainer. */
+    displayName?: string | null;
+    /**
+     * ID of the application providing the benefit item.
+     *
+     * ID of the external application supplying the items. Each item's external ID is unique to its respective provider's application.
+     */
+    providerAppId?: string | null;
+    /**
+     * Custom field data for the item object.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+    /**
+     * Module name of the item provider's application that originated the items.
+     *
+     * For example, `store-inventory` or `fitness-resources`.
+     */
+    namespace?: string | null;
+}
+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 ItemsCloned {
+    /** ID of the pool that had its items provisioned */
+    itemSetId?: string;
+}
+export interface CreateItemRequest {
+    /** Item to create. */
+    item: Item;
+}
+export interface CreateItemResponse {
+    /** Created item. */
+    item?: Item;
+}
+export interface BulkCreateItemsRequest {
+    /** Items to be created. */
+    items: Item[];
+    /**
+     * Whether to return the full item entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface BulkCreateItemsResponse {
+    /**
+     * List of results for each item.
+     *
+     * Includes the item and whether the operation was successful.
+     */
+    results?: BulkItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkItemResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Item. */
+    item?: Item;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    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 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 DeleteItemRequest {
+    /** Item ID. */
+    itemId: string;
+}
+export interface DeleteItemResponse {
+}
+export interface BulkDeleteItemsRequest {
+    /** ID of the items to delete. */
+    itemIds: string[];
+}
+export interface BulkDeleteItemsResponse {
+    /**
+     * List of results for each item.
+     *
+     * Includes the item and whether the deletion was successful.
+     */
+    results?: BulkItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteItemsByFilterRequest {
+    /** Sub-module name of the item provider's application that originated the items. */
+    namespace: string;
+    /** Filter options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
+    filter?: Record<string, any> | null;
+}
+export interface BulkDeleteItemsByFilterResponse {
+    /**
+     * Job ID. Use the Async Job API to retrieve bulk delete results.
+     *
+     * Specify this job ID in the Get Async Job method to retrieve job details and metadata.
+     */
+    jobId?: string;
+}
+export interface UpdateItemRequest {
+    /** Item to be updated. */
+    item: Item;
+}
+export interface UpdateItemResponse {
+    /** Updated item. */
+    item?: Item;
+}
+export interface BulkUpdateItemsRequest {
+    /** Items to update. */
+    items?: MaskedItem[];
+    /**
+     * Whether to return the full item entities.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface MaskedItem {
+    /** Item to update. */
+    item?: Item;
+    /** Explicit list of fields to update. */
+    fieldMask?: string[];
+}
+export interface BulkUpdateItemsResponse {
+    /** Items that were updated. */
+    results?: BulkItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface GetItemRequest {
+    /** ID of the item to retrieve. */
+    itemId: string;
+}
+export interface GetItemResponse {
+    /** Retrieved item. */
+    item?: Item;
+}
+export interface ListItemsRequest {
+    /** Filter. */
+    filter?: Filter;
+    /** Cursor paging */
+    cursorPaging?: CursorPaging;
+}
+export declare enum Type {
+    /** Unknown filter type. */
+    UNKNOWN_FILTER = "UNKNOWN_FILTER",
+    /**
+     * Filter the list by `itemSetId` and a reference to the item.
+     *
+     * Retrieve a list of a benefit item in a specific benefit pool.
+     *
+     * The items must be referenced by their `providerAppId`.
+     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
+     */
+    BY_ITEM_SET_ID_AND_REFERENCE = "BY_ITEM_SET_ID_AND_REFERENCE",
+    /**
+     * Filter the list by reference to the item.
+     *
+     * Retrieve a list of a benefit item in all benefit pools.
+     */
+    BY_REFERENCE = "BY_REFERENCE"
+}
+export interface ByItemSetIdAndReference {
+    /** Filter list. */
+    filters?: ByItemSetIdAndReferenceFilter[];
+}
+export interface ByItemSetIdAndReferenceFilter {
+    /** ID that is a shared reference between a benefit pool and a specific item. */
+    itemSetId?: string;
+    /** External item ID assigned by the provider of the items. */
+    externalId?: string;
+    /** Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups. */
+    category?: string;
+    /** ID of the external application supplying the items. */
+    providerAppId?: string;
+}
+export interface ByReference {
+    /** Filter list. */
+    filters?: ByReferenceFilter[];
+}
+export interface ByReferenceFilter {
+    /** External item ID assigned by the provider of the items. */
+    externalId?: string;
+    /** Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups. */
+    category?: string;
+    /** ID of the external application supplying the items. */
+    providerAppId?: string;
+}
+export interface Filter extends FilterFilterOneOf {
+    /**
+     * Filter the list by `itemSetId` and a reference to the item.
+     *
+     * Retrieve a list of benefit items in a specific benefit pool.
+     *
+     * The items must be referenced by their `providerAppId`.
+     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
+     */
+    byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
+    /**
+     * Filter the list by reference to the item.
+     *
+     * Retrieve a list of a benefit item in all benefit pools.
+     */
+    byReferenceOptions?: ByReference;
+    /** Filter type. */
+    type?: Type;
+    /** Filter items by the item's namespace. */
+    namespace?: string;
+}
+/** @oneof */
+export interface FilterFilterOneOf {
+    /**
+     * Filter the list by `itemSetId` and a reference to the item.
+     *
+     * Retrieve a list of benefit items in a specific benefit pool.
+     *
+     * The items must be referenced by their `providerAppId`.
+     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
+     */
+    byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
+    /**
+     * Filter the list by reference to the item.
+     *
+     * Retrieve a list of a benefit item in all benefit pools.
+     */
+    byReferenceOptions?: ByReference;
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface ListItemsResponse {
+    /** Items. */
+    items?: Item[];
+    /** Metadata for paginated results. */
+    metadata?: 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. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface QueryItemsRequest {
+    /** Query to select benefit items. */
+    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"}]`
+     */
+    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 QueryItemsResponse {
+    /** List of items. */
+    items?: Item[];
+    /** Metadata for paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+export interface CountItemsRequest {
+    /**
+     * Items to count.
+     *
+     * Filter options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+     */
+    filter?: Record<string, any> | null;
+}
+export interface CountItemsResponse {
+    /** Number of items. */
+    count?: number;
+}
+export interface CloneItemsRequest {
+    /** Id of the item set to be cloned */
+    itemSetId?: string;
+}
+export interface CloneItemsResponse {
+    /** Id of the item set that these items were added to */
+    clonedItemSetId?: string;
+    /** Id of the job that is cloning the item set */
+    cloneJobId?: string;
+}
+export interface BulkCloneItemSetsRequest {
+    /** Id of the item sets to be cloned */
+    itemSetIds?: string[];
+}
+export interface BulkCloneItemSetsResponse {
+    /** Results */
+    results?: BulkCloneItemSetsResult[];
+    /** Bulk action metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+    /** Id of the job that is cloning the item set */
+    jobId?: string;
+}
+export interface BulkCloneItemSetsResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /** Id of the item set that these items were added to */
+    clonedItemSetId?: string;
+}
+export interface AllocateItemSetsRequest {
+    /** Number of sets to allocate */
+    numberOfSets?: number;
+}
+export interface AllocateItemSetsResponse {
+    /** ID that is a shared reference between a benefit pool and a specific item. */
+    itemSetIds?: 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. */
+    instanceId?: string | null;
+    /** Event type. */
+    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. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface ItemNonNullableFields {
+    externalId: string;
+    itemSetId: string;
+}
+export interface CreateItemResponseNonNullableFields {
+    item?: ItemNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkItemResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: ItemNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateItemsResponseNonNullableFields {
+    results: BulkItemResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkDeleteItemsResponseNonNullableFields {
+    results: BulkItemResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkDeleteItemsByFilterResponseNonNullableFields {
+    jobId: string;
+}
+export interface UpdateItemResponseNonNullableFields {
+    item?: ItemNonNullableFields;
+}
+export interface BulkUpdateItemsResponseNonNullableFields {
+    results: BulkItemResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface GetItemResponseNonNullableFields {
+    item?: ItemNonNullableFields;
+}
+export interface ListItemsResponseNonNullableFields {
+    items: ItemNonNullableFields[];
+}
+export interface QueryItemsResponseNonNullableFields {
+    items: ItemNonNullableFields[];
+}
+export interface CountItemsResponseNonNullableFields {
+    count: number;
+}
+export {};

package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.SortOrder = exports.Type = void 0;
+var Type;
+(function (Type) {
+    /** Unknown filter type. */
+    Type["UNKNOWN_FILTER"] = "UNKNOWN_FILTER";
+    /**
+     * Filter the list by `itemSetId` and a reference to the item.
+     *
+     * Retrieve a list of a benefit item in a specific benefit pool.
+     *
+     * The items must be referenced by their `providerAppId`.
+     * The `externalId` can be included for additional specificity of an item, but can only be used with its corresponding `providerAppId`.
+     */
+    Type["BY_ITEM_SET_ID_AND_REFERENCE"] = "BY_ITEM_SET_ID_AND_REFERENCE";
+    /**
+     * Filter the list by reference to the item.
+     *
+     * Retrieve a list of a benefit item in all benefit pools.
+     */
+    Type["BY_REFERENCE"] = "BY_REFERENCE";
+})(Type || (exports.Type = Type = {}));
+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=benefit-programs-v1-item-items.types.js.map

package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"benefit-programs-v1-item-items.types.js","sourceRoot":"","sources":["../../../../src/benefit-programs-v1-item-items.types.ts"],"names":[],"mappings":";;;AA6OA,IAAY,IAkBX;AAlBD,WAAY,IAAI;IACd,2BAA2B;IAC3B,yCAAiC,CAAA;IACjC;;;;;;;OAOG;IACH,qEAA6D,CAAA;IAC7D;;;;OAIG;IACH,qCAA6B,CAAA;AAC/B,CAAC,EAlBW,IAAI,oBAAJ,IAAI,QAkBf;AAsJD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAqLD,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"}