@wix/auto_sdk_benefit-programs_program-definitions 1.0.0

package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts

@@ -0,0 +1,528 @@
+export interface ProgramDefinition {
+    /**
+     * Program definition ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the program definition is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the program definition.
+     *
+     * Ignored when creating a program definition.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the program definition was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the program definition was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
+    displayName?: string | null;
+    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    namespace?: string | null;
+    /**
+     * Custom field data for the program 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;
+    /** External program definition ID designated by the app owner. */
+    externalId?: 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 CreateProgramDefinitionRequest {
+    /** Program definition to create. */
+    programDefinition: ProgramDefinition;
+}
+export interface CreateProgramDefinitionResponse {
+    /** Created program definition. */
+    programDefinition?: ProgramDefinition;
+}
+export interface UpdateProgramDefinitionRequest {
+    /** Program definition to updated. */
+    programDefinition: ProgramDefinition;
+}
+export interface UpdateProgramDefinitionResponse {
+    /** Updated program definition. */
+    programDefinition?: ProgramDefinition;
+}
+export interface DeleteProgramDefinitionRequest {
+    /** ID of the ProgramDefinition to delete. */
+    programDefinitionId: string;
+    /**
+     * Specifies the timing of ending the active benefit pools associated with this program definition.
+     * Determines how and when changes are applied to benefit pools.
+     */
+    cascadeType?: Cascade;
+}
+export declare enum Cascade {
+    /** Unknown cascade. */
+    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
+    /**
+     * Updates the associated benefit pools to reflect the new or modified pool definition. The benefits will appear in existing programs at the beginning of their next renewal cycle.
+     *
+     * Existing programs will be updated in their next renewal cycle.
+     */
+    NEXT_RENEWAL = "NEXT_RENEWAL",
+    /**
+     * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
+     *
+     * Existing programs will be updated immediately.
+     */
+    IMMEDIATELY = "IMMEDIATELY",
+    /**
+     * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
+     *
+     * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
+     */
+    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
+}
+export interface DeleteProgramDefinitionResponse {
+}
+export interface GetProgramDefinitionRequest {
+    /** ID of the program definition to retrieve. */
+    programDefinitionId: string;
+}
+export interface GetProgramDefinitionResponse {
+    /** Retrieved program definition. */
+    programDefinition?: ProgramDefinition;
+}
+export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
+    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    namespace: string;
+    /** External program definition ID. */
+    externalId: string;
+}
+export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
+    /** The retrieved program definition. */
+    programDefinition?: ProgramDefinition;
+}
+export interface QueryProgramDefinitionsRequest {
+    /** Query to select program definitions. */
+    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 {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+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 QueryProgramDefinitionsResponse {
+    /** List of program definitions. */
+    programDefinitions?: ProgramDefinition[];
+    /** Metadata for the 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 UpsertProgramDefinitionRequest {
+    /** Program definition to be created or updated. */
+    programDefinition?: ProgramDefinition;
+}
+export interface UpsertProgramDefinitionResponse {
+    /** Created or updated program definition. */
+    programDefinition?: ProgramDefinition;
+}
+export interface GetOrCreateProgramDefinitionRequest {
+    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    namespace?: string;
+    /** External program definition ID. */
+    externalId?: string;
+}
+export interface GetOrCreateProgramDefinitionResponse {
+    /** The created or updated program definition. */
+    programDefinition?: ProgramDefinition;
+}
+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 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"
+}
+/**
+ * Creates a new program definition.
+ * @param programDefinition - Program definition to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programDefinition
+ * @requiredField programDefinition.externalId
+ * @requiredField programDefinition.namespace
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_CREATE
+ * @returns Created program definition.
+ * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.CreateProgramDefinition
+ */
+export declare function createProgramDefinition(programDefinition: ProgramDefinition): Promise<ProgramDefinition>;
+/**
+ * Updates a program definition.
+ *
+ * Each time the program definition is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the program definition.
+ * This ensures you're working with the latest program definition
+ * and prevents unintended overwrites.
+ * @param _id - Program definition ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField programDefinition
+ * @requiredField programDefinition.revision
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_UPDATE
+ * @returns Updated program definition.
+ * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.UpdateProgramDefinition
+ */
+export declare function updateProgramDefinition(_id: string | null, programDefinition: UpdateProgramDefinition): Promise<ProgramDefinition>;
+export interface UpdateProgramDefinition {
+    /**
+     * Program definition ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the program definition is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the program definition.
+     *
+     * Ignored when creating a program definition.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the program definition was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the program definition was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
+    displayName?: string | null;
+    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    namespace?: string | null;
+    /**
+     * Custom field data for the program 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;
+    /** External program definition ID designated by the app owner. */
+    externalId?: string | null;
+}
+/**
+ * Deletes a program definition.
+ * @param programDefinitionId - ID of the ProgramDefinition to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_DELETE
+ * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.DeleteProgramDefinition
+ */
+export declare function deleteProgramDefinition(programDefinitionId: string, options?: DeleteProgramDefinitionOptions): Promise<void>;
+export interface DeleteProgramDefinitionOptions {
+    /**
+     * Specifies the timing of ending the active benefit pools associated with this program definition.
+     * Determines how and when changes are applied to benefit pools.
+     */
+    cascadeType?: Cascade;
+}
+/**
+ * Retrieves a program definition.
+ * @param programDefinitionId - ID of the program definition to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programDefinitionId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @applicableIdentity VISITOR
+ * @returns Retrieved program definition.
+ * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinition
+ */
+export declare function getProgramDefinition(programDefinitionId: string): Promise<ProgramDefinition>;
+/**
+ * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
+ *
+ * Use this method when you need to retrieve a program definition without its program definition ID.
+ * @param namespace - Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.externalId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @applicableIdentity VISITOR
+ * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinitionByExternalIdAndNamespace
+ */
+export declare function getProgramDefinitionByExternalIdAndNamespace(namespace: string, options: GetProgramDefinitionByExternalIdAndNamespaceOptions): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
+export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
+    /** External program definition ID. */
+    externalId: string;
+}
+/**
+ * Creates a query to retrieve a list of program definitions.
+ *
+ * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/program-definitions/program-definitions-query-builder/find) function.
+ *
+ * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProgramDefinitions()` returns.
+ *
+ * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @applicableIdentity VISITOR
+ * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.QueryProgramDefinitions
+ */
+export declare function queryProgramDefinitions(): ProgramDefinitionsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface ProgramDefinitionsQueryResult extends QueryCursorResult {
+    items: ProgramDefinition[];
+    query: ProgramDefinitionsQueryBuilder;
+    next: () => Promise<ProgramDefinitionsQueryResult>;
+    prev: () => Promise<ProgramDefinitionsQueryResult>;
+}
+export interface ProgramDefinitionsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'namespace' | 'externalId', value: string) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any[]) => ProgramDefinitionsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any) => ProgramDefinitionsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: boolean) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'namespace' | 'externalId'>) => ProgramDefinitionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'namespace' | 'externalId'>) => ProgramDefinitionsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ProgramDefinitionsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ProgramDefinitionsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ProgramDefinitionsQueryResult>;
+}
+export {};