@wix/auto_sdk_benefit-programs_pool-definition-items 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,543 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface PoolDefinitionItem {
+    /**
+     * Benefit item ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * 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.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    externalId?: string;
+    /**
+     * Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
+     * @maxLength 20
+     * @immutable
+     * @readonly
+     */
+    category?: string;
+    /**
+     * 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.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    providerAppId?: string;
+    /**
+     * Module name of the item provider's application that originated the items.
+     *
+     * For example, `store-inventory` or `fitness-resources`.
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     * @readonly
+     */
+    namespace?: string;
+    /**
+     * Pool definition id
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    poolDefinitionId?: string;
+    /**
+     * Item set ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemSetId?: string;
+    /**
+     * Item set ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemId?: string;
+    /**
+     * Unique identifier for the benefit associated with this item.
+     * @maxLength 64
+     * @immutable
+     * @readonly
+     */
+    benefitKey?: string;
+}
+interface PoolDefinitionInfo {
+    /**
+     * Pool definition name.
+     * @maxLength 64
+     */
+    displayName?: string;
+    /**
+     * Pool definition description.
+     * @maxLength 450
+     */
+    description?: string | null;
+    /**
+     * Credit settings.
+     *
+     * If this object is empty, you can't set a price for the benefit.
+     */
+    creditConfiguration?: CreditConfiguration;
+}
+interface CreditConfiguration {
+    /**
+     * Initial available amount for associated balances.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    amount?: string;
+    /**
+     * Credit unit display name.
+     * @maxLength 32
+     */
+    unitDisplayName?: string | null;
+}
+interface ProgramDefinitionInfo {
+    /**
+     * Program definition id
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Program definition external id
+     * @format GUID
+     */
+    externalId?: string | null;
+    /**
+     * Program definition name
+     * @maxLength 64
+     */
+    displayName?: string | null;
+    /**
+     * Program definition description.
+     * @maxLength 450
+     */
+    description?: string | null;
+}
+interface BenefitInfo {
+    /**
+     * Price of the benefit in credits. The price is the same for all of this benefit's items.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
+    /**
+     * Benefit name.
+     * @maxLength 40
+     */
+    displayName?: string | null;
+    /**
+     * Benefit description.
+     * @maxLength 255
+     */
+    description?: string | null;
+}
+interface ItemInfo {
+    /**
+     * Item display name.
+     * @maxLength 64
+     */
+    displayName?: string | null;
+}
+interface QueryPoolDefinitionItemsRequest {
+    /** Query to select benefit items. */
+    query?: CursorQuery;
+    /**
+     * Fields to be included in the response.
+     * @maxSize 4
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+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 */
+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;
+}
+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 1000
+     */
+    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;
+}
+declare enum RequestedFields {
+    POOL_DEFINITION = "POOL_DEFINITION",
+    PROGRAM_DEFINITION = "PROGRAM_DEFINITION",
+    BENEFIT = "BENEFIT",
+    ITEM = "ITEM"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'POOL_DEFINITION' | 'PROGRAM_DEFINITION' | 'BENEFIT' | 'ITEM';
+interface QueryPoolDefinitionItemsResponse {
+    /** List of items. */
+    poolDefinitionItems?: PoolDefinitionItem[];
+    /** Metadata for paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+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;
+}
+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 InvalidatePoolDefinitionItemsRequest {
+    /**
+     * The pool definition ID whose items are to be invalidated
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * List of item set ids whose items are to be invalidated
+     * @maxSize 10
+     * @format GUID
+     */
+    itemSetIds?: string[];
+}
+interface InvalidatePoolDefinitionItemsResponse {
+}
+interface RemoveItemsFromBenefitRequest {
+    /**
+     * Items to remove from the benefit's item set.
+     * @minSize 1
+     * @maxSize 100
+     */
+    itemReferences: ItemReference[];
+    /**
+     * ID of the pool definition associated with the benefit.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * Key identifying the benefit within the pool definition.
+     * @maxLength 64
+     */
+    benefitKey: string;
+}
+interface ItemReference {
+    /**
+     * External item ID assigned by the provider.
+     * @format GUID
+     */
+    externalId?: string;
+    /**
+     * Item category.
+     * @maxLength 20
+     */
+    category?: string;
+}
+interface RemoveItemsFromBenefitResponse {
+}
+interface AddItemsToBenefitRequest {
+    /**
+     * Items to add to the benefit's item set.
+     * @minSize 1
+     * @maxSize 100
+     */
+    itemReferences: ItemReference[];
+    /**
+     * ID of the pool definition associated with the benefit.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * Key identifying the benefit within the pool definition.
+     * @maxLength 64
+     */
+    benefitKey: string;
+}
+interface AddItemsToBenefitResponse {
+}
+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 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;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+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?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+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;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/**
+ * Removes items from a benefit's item set, resolved by pool definition ID and benefit key.
+ * @param itemReferences - Items to remove from the benefit's item set.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemReferences
+ * @requiredField itemReferences.externalId
+ * @requiredField options
+ * @requiredField options.benefitKey
+ * @requiredField options.poolDefinitionId
+ * @permissionId benefit_programs:v1:pool_definition_item:remove_items_from_benefit
+ * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.RemoveItemsFromBenefit
+ */
+declare function removeItemsFromBenefit(itemReferences: NonNullablePaths<ItemReference, `externalId`, 2>[], options: NonNullablePaths<RemoveItemsFromBenefitOptions, `benefitKey` | `poolDefinitionId`, 2>): Promise<void>;
+interface RemoveItemsFromBenefitOptions {
+    /**
+     * ID of the pool definition associated with the benefit.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * Key identifying the benefit within the pool definition.
+     * @maxLength 64
+     */
+    benefitKey: string;
+}
+/**
+ * Adds items to a benefit's item set, resolved by pool definition ID and benefit key.
+ * @param itemReferences - Items to add to the benefit's item set.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemReferences
+ * @requiredField itemReferences.externalId
+ * @requiredField options
+ * @requiredField options.benefitKey
+ * @requiredField options.poolDefinitionId
+ * @permissionId benefit_programs:v1:pool_definition_item:add_items_to_benefit
+ * @fqn wix.benefit_programs.v1.pool_definition_item.PoolDefinitionItemService.AddItemsToBenefit
+ */
+declare function addItemsToBenefit(itemReferences: NonNullablePaths<ItemReference, `externalId`, 2>[], options: NonNullablePaths<AddItemsToBenefitOptions, `benefitKey` | `poolDefinitionId`, 2>): Promise<void>;
+interface AddItemsToBenefitOptions {
+    /**
+     * ID of the pool definition associated with the benefit.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * Key identifying the benefit within the pool definition.
+     * @maxLength 64
+     */
+    benefitKey: string;
+}
+
+export { type AccountInfo, type ActionEvent, type AddItemsToBenefitOptions, type AddItemsToBenefitRequest, type AddItemsToBenefitResponse, type BenefitInfo, type CreditConfiguration, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type IdentificationData, type IdentificationDataIdOneOf, type InvalidatePoolDefinitionItemsRequest, type InvalidatePoolDefinitionItemsResponse, type ItemInfo, type ItemReference, type MessageEnvelope, type PoolDefinitionInfo, type PoolDefinitionItem, type ProgramDefinitionInfo, type QueryPoolDefinitionItemsRequest, type QueryPoolDefinitionItemsResponse, type RemoveItemsFromBenefitOptions, type RemoveItemsFromBenefitRequest, type RemoveItemsFromBenefitResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addItemsToBenefit, removeItemsFromBenefit };