@wix/auto_sdk_benefit-programs_pool-definitions 1.0.19 → 1.0.21

package/build/internal/meta.d.mts

@@ -0,0 +1,494 @@
+import { N as CreatePoolDefinitionRequest$1, O as CreatePoolDefinitionResponse$1, Q as BulkCreatePoolDefinitionsRequest$1, a as BulkCreatePoolDefinitionsResponse$1, _ as UpdatePoolDefinitionRequest$1, $ as UpdatePoolDefinitionResponse$1, a0 as BulkUpdatePoolDefinitionsRequest$1, d as BulkUpdatePoolDefinitionsResponse$1, a2 as DeletePoolDefinitionRequest$1, a3 as DeletePoolDefinitionResponse$1, a4 as BulkDeletePoolDefinitionsRequest$1, f as BulkDeletePoolDefinitionsResponse$1, a5 as GetPoolDefinitionRequest$1, a6 as GetPoolDefinitionResponse$1, a7 as QueryPoolDefinitionsRequest$1, ac as QueryPoolDefinitionsResponse$1, af as AddPoolDefinitionToProgramDefinitionRequest$1, h as AddPoolDefinitionToProgramDefinitionResponse$1, ag as RemovePoolDefinitionFromProgramDefinitionRequest$1, i as RemovePoolDefinitionFromProgramDefinitionResponse$1, ah as FindPoolDefinitionsByProgramDefinitionRequest$1, j as FindPoolDefinitionsByProgramDefinitionResponse$1 } from './benefit-programs-v1-pool-definition-pool-definitions.universal-D9CDI7FG.mjs';
+
+interface PoolDefinition {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pool definition is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the pool definition.
+     *
+     * Ignored when creating a pool definition.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pool definition was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the pool definition was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Pool definition name.
+     * @maxLength 128
+     */
+    displayName?: string;
+    /**
+     * List of program definition IDs that are associated with this pool definition.
+     * @format GUID
+     * @maxSize 100
+     */
+    programDefinitionIds?: string[];
+    /** Pool definition benefits and settings. */
+    details?: Details;
+    /**
+     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     * @immutable
+     * @readonly
+     * @minLength 1
+     * @maxLength 50
+     */
+    namespace?: string | null;
+    /**
+     * Custom field data for the pool definition 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;
+}
+interface Details {
+    /**
+     * List of benefits.
+     * @maxSize 10
+     */
+    benefits?: Benefit[];
+    /**
+     * Credit settings.
+     *
+     * If this object is empty, you can't set a price for the benefit.
+     */
+    creditConfiguration?: CreditConfiguration;
+    /** Additional information relating to this object. */
+    additionalData?: Record<string, any> | null;
+}
+interface Benefit {
+    /**
+     * Unique identifier for this benefit.
+     *
+     * This key is consistent across the pool definition and all associated pools that contain this benefit.
+     * @maxLength 64
+     */
+    benefitKey?: string;
+    /**
+     * ID that is used to associated items with this benefit.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemSetId?: string | null;
+    /**
+     * 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;
+    /** Additional information for this benefit. */
+    additionalData?: Record<string, any> | null;
+    /**
+     * ID of the app providing the benefit items.
+     * @format GUID
+     * @immutable
+     */
+    providerAppId?: string | null;
+    /**
+     * Benefit name.
+     * @maxLength 40
+     */
+    displayName?: string | null;
+    /**
+     * Benefit description.
+     * @maxLength 255
+     */
+    description?: string | null;
+}
+interface CreditConfiguration {
+    /**
+     * Initial available amount for associated balances.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    amount?: string;
+    /** Rollover settings. */
+    rolloverConfiguration?: RolloverConfiguration;
+    /**
+     * Credit unit display name.
+     * @maxLength 32
+     */
+    unitDisplayName?: string | null;
+}
+interface RolloverConfiguration {
+    /** Whether unused credits roll over to a new cycle when a program renews. */
+    enabled?: boolean | null;
+    /**
+     * Maximum number of credits that can roll over to the next cycle when a program renews.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    balanceCap?: string | null;
+}
+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>>;
+}
+declare enum Cascade {
+    /** Unknown cascade. */
+    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
+    /** Changes are applied to existing programs and pools when they are next renewed. */
+    NEXT_RENEWAL = "NEXT_RENEWAL",
+    /** Changes are applied to associated programs and pools immediately. */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
+    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
+}
+/** @enumType */
+type CascadeWithLiterals = Cascade | 'UNKNOWN_CASCADE' | 'NEXT_RENEWAL' | 'IMMEDIATELY' | 'FUTURE_PROVISIONS';
+interface CreatePoolDefinitionRequest {
+    /** Pool definition to create. */
+    poolDefinition: PoolDefinition;
+    /**
+     * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
+     *
+     * Required if the `poolDefinition.programDefinitionIds` parameter is defined.
+     */
+    cascade?: CascadeWithLiterals;
+}
+interface CreatePoolDefinitionResponse {
+    /** Created pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+interface BulkCreatePoolDefinitionsRequest {
+    /**
+     * Pool definitions to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    poolDefinitions: PoolDefinition[];
+    /**
+     * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
+     *
+     * Required if the `poolDefinition.programDefinitionIds` parameter is defined.
+     */
+    cascade?: CascadeWithLiterals;
+    /**
+     * Whether to return the created pool definitions.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkCreatePoolDefinitionsResponse {
+    /**
+     * List of created pool definitions and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkPoolDefinitionResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+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;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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;
+}
+interface UpdatePoolDefinitionRequest {
+    /** Pool definition to update. */
+    poolDefinition: PoolDefinition;
+    /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
+    cascade?: CascadeWithLiterals;
+}
+interface UpdatePoolDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+interface BulkUpdatePoolDefinitionsRequest {
+    /**
+     * Pool definitions to update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    poolDefinitions?: MaskedPoolDefinition[];
+    /** *Required.** Determines when the changes to these pool definitions program definitions containing them will be applied to associated programs and pools. */
+    cascade?: CascadeWithLiterals;
+    /**
+     * Whether to return the updated pool definitions.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface MaskedPoolDefinition {
+    /** Pool definition to update. */
+    poolDefinition?: PoolDefinition;
+    /** Explicit list of fields to update. */
+    fieldMask?: string[];
+}
+interface BulkUpdatePoolDefinitionsResponse {
+    /**
+     * List of updated pool definitions and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface DeletePoolDefinitionRequest {
+    /**
+     * ID of the pool definition to delete.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /** *Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
+    cascade?: CascadeWithLiterals;
+}
+interface DeletePoolDefinitionResponse {
+}
+interface BulkDeletePoolDefinitionsRequest {
+    /**
+     * List of IDs of the pool definitions to delete.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    poolDefinitionIds: string[];
+    /** *Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
+    cascade?: CascadeWithLiterals;
+}
+interface BulkDeletePoolDefinitionsResponse {
+    /**
+     * List of deleted pool definitions and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface GetPoolDefinitionRequest {
+    /**
+     * ID of the pool definition to retrieve.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+}
+interface GetPoolDefinitionResponse {
+    /** Retrieved pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+interface QueryPoolDefinitionsRequest {
+    /** Filter, sort, and paging to apply to the query. */
+    query?: CursorQuery;
+}
+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.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     * @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 {
+    /**
+     * Field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @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;
+}
+interface QueryPoolDefinitionsResponse {
+    /** List of retrieved pool definitions. */
+    poolDefinitions?: PoolDefinition[];
+    /** Metadata for the 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 AddPoolDefinitionToProgramDefinitionRequest {
+    /**
+     * ID of the pool definition to add to the program definition.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * ID of the program definition to add the pool definition to.
+     * @format GUID
+     */
+    programDefinitionId: string;
+    /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
+    cascade: CascadeWithLiterals;
+}
+interface AddPoolDefinitionToProgramDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+interface RemovePoolDefinitionFromProgramDefinitionRequest {
+    /**
+     * ID of the pool definition to remove from the program definition.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * ID of the program definition to remove the pool definition from.
+     * @format GUID
+     */
+    programDefinitionId: string;
+    /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
+    cascade: CascadeWithLiterals;
+}
+interface RemovePoolDefinitionFromProgramDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+interface FindPoolDefinitionsByProgramDefinitionRequest {
+    /**
+     * ID of the program definition to retrieve its pool definitions.
+     * @format GUID
+     */
+    programDefinitionId: string;
+    /**
+     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     * @minLength 1
+     * @maxLength 50
+     */
+    namespace: string;
+}
+interface FindPoolDefinitionsByProgramDefinitionResponse {
+    /** Retrieved pool definitions. */
+    poolDefinitions?: PoolDefinition[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createPoolDefinition(): __PublicMethodMetaInfo<'POST', {}, CreatePoolDefinitionRequest$1, CreatePoolDefinitionRequest, CreatePoolDefinitionResponse$1, CreatePoolDefinitionResponse>;
+declare function bulkCreatePoolDefinitions(): __PublicMethodMetaInfo<'POST', {}, BulkCreatePoolDefinitionsRequest$1, BulkCreatePoolDefinitionsRequest, BulkCreatePoolDefinitionsResponse$1, BulkCreatePoolDefinitionsResponse>;
+declare function updatePoolDefinition(): __PublicMethodMetaInfo<'PATCH', {
+    poolDefinitionId: string;
+}, UpdatePoolDefinitionRequest$1, UpdatePoolDefinitionRequest, UpdatePoolDefinitionResponse$1, UpdatePoolDefinitionResponse>;
+declare function bulkUpdatePoolDefinitions(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePoolDefinitionsRequest$1, BulkUpdatePoolDefinitionsRequest, BulkUpdatePoolDefinitionsResponse$1, BulkUpdatePoolDefinitionsResponse>;
+declare function deletePoolDefinition(): __PublicMethodMetaInfo<'DELETE', {
+    poolDefinitionId: string;
+}, DeletePoolDefinitionRequest$1, DeletePoolDefinitionRequest, DeletePoolDefinitionResponse$1, DeletePoolDefinitionResponse>;
+declare function bulkDeletePoolDefinitions(): __PublicMethodMetaInfo<'POST', {}, BulkDeletePoolDefinitionsRequest$1, BulkDeletePoolDefinitionsRequest, BulkDeletePoolDefinitionsResponse$1, BulkDeletePoolDefinitionsResponse>;
+declare function getPoolDefinition(): __PublicMethodMetaInfo<'GET', {
+    poolDefinitionId: string;
+}, GetPoolDefinitionRequest$1, GetPoolDefinitionRequest, GetPoolDefinitionResponse$1, GetPoolDefinitionResponse>;
+declare function queryPoolDefinitions(): __PublicMethodMetaInfo<'POST', {}, QueryPoolDefinitionsRequest$1, QueryPoolDefinitionsRequest, QueryPoolDefinitionsResponse$1, QueryPoolDefinitionsResponse>;
+declare function addPoolDefinitionToProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, AddPoolDefinitionToProgramDefinitionRequest$1, AddPoolDefinitionToProgramDefinitionRequest, AddPoolDefinitionToProgramDefinitionResponse$1, AddPoolDefinitionToProgramDefinitionResponse>;
+declare function removePoolDefinitionFromProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, RemovePoolDefinitionFromProgramDefinitionRequest$1, RemovePoolDefinitionFromProgramDefinitionRequest, RemovePoolDefinitionFromProgramDefinitionResponse$1, RemovePoolDefinitionFromProgramDefinitionResponse>;
+declare function findPoolDefinitionsByProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, FindPoolDefinitionsByProgramDefinitionRequest$1, FindPoolDefinitionsByProgramDefinitionRequest, FindPoolDefinitionsByProgramDefinitionResponse$1, FindPoolDefinitionsByProgramDefinitionResponse>;
+
+export { type __PublicMethodMetaInfo, addPoolDefinitionToProgramDefinition, bulkCreatePoolDefinitions, bulkDeletePoolDefinitions, bulkUpdatePoolDefinitions, createPoolDefinition, deletePoolDefinition, findPoolDefinitionsByProgramDefinition, getPoolDefinition, queryPoolDefinitions, removePoolDefinitionFromProgramDefinition, updatePoolDefinition };