@wix/auto_sdk_loyalty_rewards 1.0.7 → 1.0.8

package/build/internal/cjs/src/loyalty-v1-reward-rewards.universal.d.ts

@@ -1,926 +0,0 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-/**
- * A loyalty reward is an object a customer can redeem with loyalty points.
- * Redeeming a reward then creates a loyalty coupon that the customer can use.
- */
-export interface Reward extends RewardTypeDetailsOneOf {
-    /** Discount details. */
-    discountAmount?: DiscountAmount;
-    /** Coupon details. */
-    couponReward?: CouponReward;
-    /**
-     * Reward ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Reward name.
-     * @minLength 1
-     * @maxLength 50
-     */
-    name?: string;
-    /** Whether the reward is active. Default: `FALSE` */
-    active?: boolean;
-    /** Reward type. */
-    type?: RewardTypeWithLiterals;
-    /**
-     * Revision number, which increments by 1 each time the loyalty reward is updated.
-     *
-     * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the reward was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the reward was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-}
-/** @oneof */
-export interface RewardTypeDetailsOneOf {
-    /** Discount details. */
-    discountAmount?: DiscountAmount;
-    /** Coupon details. */
-    couponReward?: CouponReward;
-}
-/** Available reward types. */
-export declare enum RewardType {
-    /** Undefined reward type. */
-    UNDEFINED = "UNDEFINED",
-    /** Discount reward. Special flexible reward type used in checkout. */
-    DISCOUNT_AMOUNT = "DISCOUNT_AMOUNT",
-    /** Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards) */
-    COUPON_REWARD = "COUPON_REWARD",
-    /** For internal use. */
-    SPI_DISCOUNT_AMOUNT = "SPI_DISCOUNT_AMOUNT"
-}
-/** @enumType */
-export type RewardTypeWithLiterals = RewardType | 'UNDEFINED' | 'DISCOUNT_AMOUNT' | 'COUPON_REWARD' | 'SPI_DISCOUNT_AMOUNT';
-export interface DiscountAmount {
-    /**
-     * Discount details for each tier.
-     * @maxSize 21
-     */
-    configsByTier?: DiscountAmountConfig[];
-}
-export interface DiscountAmountConfig {
-    /**
-     * Discount amount. Must be a positive value.
-     * @format DECIMAL_VALUE
-     * @decimalValue options { gt:0, maxScale:2 }
-     */
-    amount?: string;
-    /**
-     * Tier ID, or empty if config applies to the base tier.
-     * @format GUID
-     */
-    tierId?: string | null;
-    /**
-     * Amount of points required to redeem the reward.
-     * @min 1
-     * @max 9999999
-     */
-    costInPoints?: number;
-}
-export interface CouponReward extends CouponRewardDiscountTypeOneOf, CouponRewardScopeOrMinSubtotalOneOf {
-    /** Discount as a fixed amount. */
-    fixedAmount?: FixedAmountDiscount;
-    /** Discount as a percentage. */
-    percentage?: PercentageDiscount;
-    /** Free shipping. */
-    freeShipping?: FreeShippingDiscount;
-    /** Limit the coupon to carts with a subtotal greater than this number. */
-    minimumSubtotal?: number;
-    /**
-     * Specifies the type of line items this coupon will apply to.
-     *
-     * For more information, see the Coupons API.
-     */
-    scope?: CouponScope;
-    /** Whether the coupon is limited to one item. */
-    limitedToOneItem?: boolean | null;
-    /**
-     * Whether the coupon applies to subscription products.
-     *
-     * If set to `true`, the discount will apply to all billing cycles.
-     */
-    appliesToSubscriptions?: boolean | null;
-    /**
-     * Reserved for internal use.
-     * @min 1
-     * @max 999
-     */
-    discountedCycleCount?: number | null;
-}
-/** @oneof */
-export interface CouponRewardDiscountTypeOneOf {
-    /** Discount as a fixed amount. */
-    fixedAmount?: FixedAmountDiscount;
-    /** Discount as a percentage. */
-    percentage?: PercentageDiscount;
-    /** Free shipping. */
-    freeShipping?: FreeShippingDiscount;
-}
-/** @oneof */
-export interface CouponRewardScopeOrMinSubtotalOneOf {
-    /** Limit the coupon to carts with a subtotal greater than this number. */
-    minimumSubtotal?: number;
-    /**
-     * Specifies the type of line items this coupon will apply to.
-     *
-     * For more information, see the Coupons API.
-     */
-    scope?: CouponScope;
-}
-export interface FixedAmountDiscount {
-    /**
-     * Discount details for each tier.
-     * @minSize 1
-     * @maxSize 21
-     */
-    configsByTier?: FixedAmountDiscountConfig[];
-}
-export interface FixedAmountDiscountConfig {
-    /**
-     * Tier ID, or empty if config applies to the base tier.
-     * @format GUID
-     */
-    tierId?: string | null;
-    /**
-     * Amount of points required to redeem the reward.
-     * @min 1
-     * @max 9999999
-     */
-    costInPoints?: number;
-    /** Discount amount. */
-    amount?: number;
-}
-export interface PercentageDiscount {
-    /**
-     * Discount details for each tier.
-     * @minSize 1
-     * @maxSize 21
-     */
-    configsByTier?: PercentageDiscountConfig[];
-}
-export interface PercentageDiscountConfig {
-    /**
-     * Tier ID, or empty if config applies to the base tier.
-     * @format GUID
-     */
-    tierId?: string | null;
-    /**
-     * Amount of points required to redeem the reward.
-     * @min 1
-     * @max 9999999
-     */
-    costInPoints?: number;
-    /** Percentage discount. */
-    percentage?: number;
-}
-export interface FreeShippingDiscount {
-    /**
-     * Discount details for each tier.
-     * @minSize 1
-     * @maxSize 21
-     */
-    configsByTier?: FreeShippingDiscountConfig[];
-}
-export interface FreeShippingDiscountConfig {
-    /**
-     * Tier ID, or empty if config applies to the base tier.
-     * @format GUID
-     */
-    tierId?: string | null;
-    /**
-     * Amount of points required to redeem the reward.
-     * @min 1
-     * @max 9999999
-     */
-    costInPoints?: number;
-}
-export interface CouponScope {
-    /**
-     * Scope namespace.
-     *
-     * See the Coupons API for valid namespaces.
-     */
-    namespace?: string;
-    /**
-     * Coupon scope's applied group.
-     *
-     * See the Coupons API for valid groups.
-     */
-    group?: Group;
-}
-export interface Group {
-    /**
-     * Name of coupon scope's group.
-     *
-     * See the Coupons API for valid groups.
-     */
-    name?: string;
-    /** Entity ID, if the coupon scope is limited to just one item. */
-    entityId?: string | null;
-}
-export interface SpiDiscountAmount {
-    /**
-     * Discount details for each tier.
-     * @maxSize 21
-     */
-    configsByTier?: DiscountAmountConfig[];
-    /**
-     * Description of the SPI discount amount reward. Taken from user input in the SPI config.
-     * @maxLength 200
-     */
-    description?: string;
-}
-export interface RewardDisabled {
-}
-export interface CreateRewardRequest {
-    /** Reward to create. */
-    reward: Reward;
-}
-export interface CreateRewardResponse {
-    /** Created reward. */
-    reward?: Reward;
-}
-export interface BulkCreateRewardsRequest {
-    /**
-     * Rewards to create.
-     * @minSize 1
-     * @maxSize 10
-     */
-    rewards: Reward[];
-}
-export interface BulkCreateRewardsResponse {
-    /** Created rewards. */
-    results?: BulkRewardResult[];
-    /** Total successes and failures of the bulk create rewards action. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkRewardResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Created reward. */
-    item?: Reward;
-}
-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 GetRewardRequest {
-    /**
-     * ID of the reward to retrieve.
-     * @format GUID
-     */
-    _id: string;
-}
-export interface GetRewardResponse {
-    /** Retrieved reward. */
-    reward?: Reward;
-}
-export interface BulkGetRewardsRequest {
-}
-export interface BulkGetRewardsResponse {
-    /** Found rewards per site. */
-    rewardsInSite?: RewardsInSite[];
-}
-export interface RewardsInSite {
-    /**
-     * Metasite id.
-     * @format GUID
-     */
-    metaSiteId?: string;
-    /** Rewards. */
-    rewards?: Reward[];
-}
-export interface QueryRewardsRequest {
-    /** Query parameters. */
-    query: CursorQuery;
-}
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /**
-     * Cursor paging options.
-     *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
-     */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object.
-     *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object.
-     *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-export interface CursorQueryPagingMethodOneOf {
-    /**
-     * Cursor paging options.
-     *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
-     */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /**
-     * Name of the field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | '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 QueryRewardsResponse {
-    /** Retrieved loyalty rewards. */
-    rewards?: Reward[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: CursorPagingMetadata;
-}
-export interface CursorPagingMetadata {
-    /** Number of items returned in current page. */
-    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 UpdateRewardRequest {
-    /** Reward information to update. */
-    reward: Reward;
-}
-export interface UpdateRewardResponse {
-    /** Updated reward. */
-    reward?: Reward;
-}
-export interface DeleteRewardRequest {
-    /**
-     * ID of the reward to delete.
-     * @format GUID
-     */
-    _id: string;
-    /**
-     * Revision number, which increments by 1 each time the reward is updated.
-     *
-     * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.
-     */
-    revision?: string;
-}
-export interface DeleteRewardResponse {
-}
-export interface ListRewardsRequest {
-    /** Pagination options. */
-    cursorPaging?: CursorPaging;
-}
-export interface ListRewardsResponse {
-    /** Retrieved loyalty rewards. */
-    rewards?: Reward[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export interface ListRewardsInTierRequest {
-    /**
-     * Tier id.
-     * @format GUID
-     * @readonly
-     */
-    tierId?: string | null;
-    /** Pagination options. */
-    cursorPaging?: CursorPaging;
-}
-export interface ListRewardsInTierResponse {
-    /** Retrieved loyalty rewards. */
-    rewards?: Reward[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: PagingMetadataV2;
-}
-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 {
-    entity?: string;
-}
-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.
-     */
-    currentEntity?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
-    deletedEntity?: string | null;
-}
-export interface ActionEvent {
-    body?: string;
-}
-export interface Empty {
-}
-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?: WebhookIdentityTypeWithLiterals;
-}
-/** @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"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-export interface EventMetadata extends BaseEventMetadata {
-    /**
-     * 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;
-}
-export interface RewardCreatedEnvelope {
-    entity: Reward;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when a reward is created.
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionId LOYALTY.READ_REWARDS
- * @webhook
- * @eventType wix.loyalty.v1.reward_created
- * @serviceIdentifier com.wixpress.loyalty.reward.LoyaltyRewards
- * @slug created
- */
-export declare function onRewardCreated(handler: (event: RewardCreatedEnvelope) => void | Promise<void>): void;
-export interface RewardDeletedEnvelope {
-    metadata: EventMetadata;
-}
-/**
- * Triggered when a reward is deleted.
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionId LOYALTY.READ_REWARDS
- * @webhook
- * @eventType wix.loyalty.v1.reward_deleted
- * @serviceIdentifier com.wixpress.loyalty.reward.LoyaltyRewards
- * @slug deleted
- */
-export declare function onRewardDeleted(handler: (event: RewardDeletedEnvelope) => void | Promise<void>): void;
-export interface RewardUpdatedEnvelope {
-    entity: Reward;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when a reward is updated.
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionId LOYALTY.READ_REWARDS
- * @webhook
- * @eventType wix.loyalty.v1.reward_updated
- * @serviceIdentifier com.wixpress.loyalty.reward.LoyaltyRewards
- * @slug updated
- */
-export declare function onRewardUpdated(handler: (event: RewardUpdatedEnvelope) => void | Promise<void>): void;
-type RewardNonNullablePaths = `discountAmount.configsByTier` | `discountAmount.configsByTier.${number}.amount` | `discountAmount.configsByTier.${number}.costInPoints` | `couponReward.fixedAmount.configsByTier` | `couponReward.fixedAmount.configsByTier.${number}.costInPoints` | `couponReward.fixedAmount.configsByTier.${number}.amount` | `couponReward.percentage.configsByTier` | `couponReward.percentage.configsByTier.${number}.costInPoints` | `couponReward.percentage.configsByTier.${number}.percentage` | `couponReward.freeShipping.configsByTier` | `couponReward.freeShipping.configsByTier.${number}.costInPoints` | `couponReward.minimumSubtotal` | `couponReward.scope.namespace` | `couponReward.scope.group.name` | `name` | `active` | `type`;
-/**
- * Creates a reward that can be redeemed with loyalty points.
- *
- * When a customer redeems a reward, a loyalty coupon is created
- * based on the specifications detailed in either the `discountAmount` or `couponReward` fields. This coupon can
- * then be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
- * no coupon is actually created until a reward is redeemed with points.
- * See the Coupons API for more information about coupons.
- *
- * A reward's `active` status defaults to `false`. To make the reward available to customers,
- * either set the `active` field to `true` during creation or call [`updateReward()`](#updatereward)
- * to change the status.
- *
- * To customize a reward for each loyalty tier, use the `configsByTier` parameter.
- * This allows you to specify the amount of the earned discount, the cost in loyalty points
- * to redeem the reward, and the tier to which this configuration applies. Each tier requires its own
- * `configsByTier` configuration. To create a reward that is available to loyalty accounts in the base tier,
- * leave the `tierId` field empty. See the Loyalty Tiers API for more information on tiers.
- * @param reward - Reward to create.
- * @public
- * @requiredField reward
- * @requiredField reward.name
- * @requiredField reward.typeDetails
- * @permissionId LOYALTY.MANAGE_REWARDS
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @returns Created reward.
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.CreateReward
- */
-export declare function createReward(reward: NonNullablePaths<Reward, `name`>): Promise<NonNullablePaths<Reward, RewardNonNullablePaths>>;
-/**
- * Creates multiple rewards.
- * @param rewards - Rewards to create.
- * @public
- * @requiredField rewards
- * @requiredField rewards.name
- * @requiredField rewards.typeDetails
- * @permissionId LOYALTY.MANAGE_REWARDS
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.BulkCreateRewards
- */
-export declare function bulkCreateRewards(rewards: NonNullablePaths<Reward, `name`>[]): Promise<NonNullablePaths<BulkCreateRewardsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in RewardNonNullablePaths]: `results.${number}.item.${P}`;
-}[RewardNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
-/**
- * Retrieves a reward.
- * @param _id - ID of the reward to retrieve.
- * @public
- * @requiredField _id
- * @permissionId LOYALTY.READ_REWARDS
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @returns Retrieved reward.
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.GetReward
- */
-export declare function getReward(_id: string): Promise<NonNullablePaths<Reward, RewardNonNullablePaths>>;
-/**
- * Retrieves rewards from all metasites that the caller is the member of.
- *
- * Must be called with user identity.
- * @public
- * @documentationMaturity preview
- * @permissionId LOYALTY.REWARD_BULK_READ
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.BulkGetRewards
- */
-export declare function bulkGetRewards(): Promise<NonNullablePaths<BulkGetRewardsResponse, `rewardsInSite` | `rewardsInSite.${number}.metaSiteId` | {
-    [P in RewardNonNullablePaths]: `rewardsInSite.${number}.rewards.${number}.${P}`;
-}[RewardNonNullablePaths]>>;
-/**
- * Retrieves a list of rewards, given the provided paging, filtering, and sorting.
- *
- * Query Rewards runs with these defaults, which you can override: `cursorPaging.limit` is `50`.
- *
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
- * @param query - Query parameters.
- * @public
- * @requiredField query
- * @permissionId LOYALTY.READ_REWARDS
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.QueryRewards
- */
-export declare function queryRewards(query: CursorQuery): Promise<NonNullablePaths<QueryRewardsResponse, {
-    [P in RewardNonNullablePaths]: `rewards.${number}.${P}`;
-}[RewardNonNullablePaths]>>;
-/**
- * Updates a loyalty reward.
- *
- * Use this endpoint to update details of a reward, such as the name, whether or not a reward is active,
- * or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.
- *
- * You may not change the `type` of a reward. That is set upon creation and cannot be updated.
- * @param _id - Reward ID.
- * @public
- * @requiredField _id
- * @requiredField reward
- * @requiredField reward.name
- * @requiredField reward.revision
- * @requiredField reward.typeDetails
- * @param reward - Reward info to update.
- * @permissionId LOYALTY.MANAGE_REWARDS
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.UpdateReward
- */
-export declare function updateReward(_id: string, reward: NonNullablePaths<UpdateReward, `name` | `revision`>): Promise<NonNullablePaths<UpdateRewardResponse, {
-    [P in RewardNonNullablePaths]: `reward.${P}`;
-}[RewardNonNullablePaths]>>;
-export interface UpdateReward {
-    /** Discount details. */
-    discountAmount?: DiscountAmount;
-    /** Coupon details. */
-    couponReward?: CouponReward;
-    /**
-     * Reward ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Reward name.
-     * @minLength 1
-     * @maxLength 50
-     */
-    name?: string;
-    /** Whether the reward is active. Default: `FALSE` */
-    active?: boolean;
-    /** Reward type. */
-    type?: RewardTypeWithLiterals;
-    /**
-     * Revision number, which increments by 1 each time the loyalty reward is updated.
-     *
-     * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the reward was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the reward was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-}
-/**
- * Deletes a reward.
- * @param _id - ID of the reward to delete.
- * @param revision - Revision number, which increments by 1 each time the reward is updated.
- *
- * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.
- * @public
- * @requiredField _id
- * @requiredField revision
- * @permissionId LOYALTY.MANAGE_REWARDS
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.DeleteReward
- */
-export declare function deleteReward(_id: string, revision: string): Promise<void>;
-/**
- * Retrieves a list of rewards.
- *
- * The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.
- * @public
- * @param options - List options.
- * @permissionId LOYALTY.READ_REWARDS
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.ListRewards
- */
-export declare function listRewards(options?: ListRewardsOptions): Promise<NonNullablePaths<ListRewardsResponse, {
-    [P in RewardNonNullablePaths]: `rewards.${number}.${P}`;
-}[RewardNonNullablePaths]>>;
-export interface ListRewardsOptions {
-    /** Pagination options. */
-    cursorPaging?: CursorPaging;
-}
-export {};