@wix/riseevent 1.0.0

package/build/es/src/rise-v1-event.universal.d.ts

@@ -0,0 +1,416 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** Event is the main entity of EventService */
+export interface Event {
+    /**
+     * Event ID
+     * @readonly
+     */
+    _id?: string | null;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision */
+    revision?: string | null;
+    /**
+     * Represents the time this Event was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Event was last updated
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Wallet ID */
+    walletId?: string;
+    /** Represents the time when the event's amount will be added to the account */
+    startDate?: Date;
+    /** Represents the time when the unused balance will be deducted from the account */
+    expiresAt?: Date;
+    /** Represents the time when the event was manually disabled */
+    disabledAt?: Date;
+    /** The amount to be added to the customer */
+    amount?: string;
+}
+export interface CreateEventRequest {
+    /** Event to be created */
+    event: Event;
+}
+export interface CreateEventResponse {
+    /** The created Event */
+    event?: Event;
+}
+export interface EventCreationExpirationDateInThePastDetails {
+    /** The date when the event expires. */
+    expiresAt?: Date;
+    /** The date when the event was tried to be created. */
+    currentDate?: Date;
+}
+export interface EventCreationStartLaterThanExpirationDetails {
+    /** The start date of the event. */
+    startDate?: Date;
+    /** The date when the event expires. */
+    expiresAt?: Date;
+}
+export interface EventCreationDisabledAtDateSetDetails {
+    /** Represents the time when the event was disabled. */
+    disabledAt?: Date;
+}
+export interface GetEventRequest {
+    /** ID of the Event to retrieve */
+    eventId: string;
+}
+export interface GetEventResponse {
+    /** The retrieved Event */
+    event?: Event;
+}
+export interface UpdateEventRequest {
+    /** Event to be updated, may be partial */
+    event: Event;
+}
+export interface UpdateEventResponse {
+    /** The updated Event */
+    event?: Event;
+}
+export interface InvalidEventDetails {
+    /** Event ID. */
+    eventId?: string;
+}
+export interface EventUpdateStartDateInThePastDetails {
+    /** Event ID. */
+    eventId?: string;
+    /** The date when the event expires. */
+    newStartDate?: Date;
+    /** The date when the event was tried to be updated. */
+    currentDate?: Date;
+}
+export interface EventUpdateExpirationDateInThePastDetails {
+    /** Event ID. */
+    eventId?: string;
+    /** The date when the event expires. */
+    newExpiresAt?: Date;
+    /** The date when the event was tried to be updated. */
+    currentDate?: Date;
+}
+export interface EventUpdateStartLaterThanExpirationDetails {
+    /** Event ID. */
+    eventId?: string;
+    /** The start date of the event. */
+    startDate?: Date;
+    /** The date when the event expires. */
+    expiresAt?: Date;
+}
+export interface DisableEventRequest {
+    /** ID of the Event to delete */
+    eventId: string;
+    /** The revision of the Event */
+    revision?: string;
+}
+export interface DisableEventResponse {
+    /** The expired Event */
+    event?: Event;
+}
+export interface DeleteEventRequest {
+    /** ID of the Event to delete */
+    eventId?: string;
+    /** The revision of the Event */
+    revision?: string;
+}
+export interface DeleteEventResponse {
+}
+export interface QueryEventRequest {
+    /** WQL expression */
+    query?: QueryV2;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** 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[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get 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 QueryEventResponse {
+    /** The retrieved Events */
+    events?: Event[];
+}
+export interface QueryEventBalancesRequest {
+    /** WQL expression */
+    query: QueryV2;
+}
+export interface QueryEventBalancesResponse {
+    /** The retrieved Events with their balance */
+    events?: EventWithBalance[];
+}
+export interface EventWithBalance {
+    /** Event */
+    event?: Event;
+    /** Event balance */
+    balance?: string | null;
+}
+export interface Task extends TaskTriggerOneOf {
+    /** A trigger which will fire once at a specified timestamp */
+    oneTime?: Date;
+    /**
+     * A recurrent trigger defined by a specified cron expression.
+     *
+     * Cron expression is a string of five space-separated sub-expressions
+     *
+     * * * * * *
+     * | | | | |
+     * minute of hour | | | day of week
+     * hour of day | month of year
+     * day of month
+     *
+     * Field            Accepted values
+     * -----            ---------------
+     * minute of hour   0..59 / * ,
+     * hour of day      0..23 / * ,
+     * day of month     1..31 / * , W L
+     * month of year    1..12 / * ,
+     * day of week      0..7 MON..SUN / * W L #
+     *
+     * Coma separates multiple values:
+     * 0,20,40 * * * * => on 0th, 20th and 40th minute
+     * Slash selects every Nth value:
+     * * /20 * * * * => equivalent to 0,20,40
+     * 5/20 * * * * => on 5th, 25th and 45th minute
+     * W selects working days
+     * 0 2 * * W =>  2am on Mon..Fri
+     * L selects the last day of ...
+     * 0 0 L * *    => last day of each month
+     * 0 0 LW * *   => last working day of each month
+     * 0 0 * * FRIL => midnight of the last Friday of the month
+     * Hash selects Nth day of week
+     * 0 0 * * Mon#1 => midnight of the first Monday of the month
+     *
+     * Following aliases are supported: @hourly, @daily, @weekly, @monthly
+     *
+     * The first execution time will be evaluated based on the client invocation time (approximately the moment the
+     * client call returns).
+     * All executions will be evaluated in UTC.
+     *
+     * Example:
+     * 00:19:59 - client schedules a task with cron = 0/20 * * * * (every 20-th minute of the hour)
+     * 00:20:02 - task reaches Time Capsule database
+     * 00:21:00 - task is executed by Time Capsule, the client is triggered with a ~1 minute delay
+     * 00:40:00 - task is executed by Time Capsule according to the schedule with no delay
+     */
+    cron?: string;
+    /** Task id */
+    _id?: TaskId;
+    /** Task payload */
+    payload?: Record<string, any> | null;
+    /**
+     * A Greyhound topic to which the task will be produced when triggered
+     * @readonly
+     */
+    topic?: string;
+    /**
+     * The time when this task is scheduled to trigger. For reoccurring tasks, this will be hold the next time this task will run and will be updated after every run
+     * @readonly
+     */
+    scheduledFor?: Date;
+}
+/** @oneof */
+export interface TaskTriggerOneOf {
+    /** A trigger which will fire once at a specified timestamp */
+    oneTime?: Date;
+    /**
+     * A recurrent trigger defined by a specified cron expression.
+     *
+     * Cron expression is a string of five space-separated sub-expressions
+     *
+     * * * * * *
+     * | | | | |
+     * minute of hour | | | day of week
+     * hour of day | month of year
+     * day of month
+     *
+     * Field            Accepted values
+     * -----            ---------------
+     * minute of hour   0..59 / * ,
+     * hour of day      0..23 / * ,
+     * day of month     1..31 / * , W L
+     * month of year    1..12 / * ,
+     * day of week      0..7 MON..SUN / * W L #
+     *
+     * Coma separates multiple values:
+     * 0,20,40 * * * * => on 0th, 20th and 40th minute
+     * Slash selects every Nth value:
+     * * /20 * * * * => equivalent to 0,20,40
+     * 5/20 * * * * => on 5th, 25th and 45th minute
+     * W selects working days
+     * 0 2 * * W =>  2am on Mon..Fri
+     * L selects the last day of ...
+     * 0 0 L * *    => last day of each month
+     * 0 0 LW * *   => last working day of each month
+     * 0 0 * * FRIL => midnight of the last Friday of the month
+     * Hash selects Nth day of week
+     * 0 0 * * Mon#1 => midnight of the first Monday of the month
+     *
+     * Following aliases are supported: @hourly, @daily, @weekly, @monthly
+     *
+     * The first execution time will be evaluated based on the client invocation time (approximately the moment the
+     * client call returns).
+     * All executions will be evaluated in UTC.
+     *
+     * Example:
+     * 00:19:59 - client schedules a task with cron = 0/20 * * * * (every 20-th minute of the hour)
+     * 00:20:02 - task reaches Time Capsule database
+     * 00:21:00 - task is executed by Time Capsule, the client is triggered with a ~1 minute delay
+     * 00:40:00 - task is executed by Time Capsule according to the schedule with no delay
+     */
+    cron?: string;
+}
+export interface TaskId {
+    /** A unique identifier of an application or a source that define the task. In most cases this would be the appDefId */
+    namespace?: string;
+    /**
+     * A free-form string distinguishing different families of tasks within a namespace.
+     * For example: "send-promo-email", "ClearTrashBin", "premium expiration reminder"
+     */
+    taskType?: string;
+    /**
+     * A free-form string that together with `namespace` and `task_type` uniquely identifies a task.
+     * When there is an entity involved, setting this to be equal to the ID of an entity related to the task is a good option.
+     */
+    key?: string;
+}
+export interface Empty {
+}
+/**
+ * Creates a new Event
+ * @param event - Event to be created
+ * @public
+ * @documentationMaturity preview
+ * @requiredField event
+ * @requiredField event.amount
+ * @requiredField event.walletId
+ * @returns The created Event
+ */
+export declare function createEvent(event: Event): Promise<Event>;
+/**
+ * Get an Event by ID
+ * @param eventId - ID of the Event to retrieve
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ * @returns The retrieved Event
+ */
+export declare function getEvent(eventId: string): Promise<Event>;
+/**
+ * Update an Event, supports partial update
+ * Pass the latest `revision` for a successful update
+ * @param _id - Event ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField event
+ * @requiredField event.revision
+ * @returns The updated Event
+ */
+export declare function updateEvent(_id: string | null, event: UpdateEvent): Promise<Event>;
+export interface UpdateEvent {
+    /**
+     * Event ID
+     * @readonly
+     */
+    _id?: string | null;
+    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision */
+    revision?: string | null;
+    /**
+     * Represents the time this Event was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Event was last updated
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Wallet ID */
+    walletId?: string;
+    /** Represents the time when the event's amount will be added to the account */
+    startDate?: Date;
+    /** Represents the time when the unused balance will be deducted from the account */
+    expiresAt?: Date;
+    /** Represents the time when the event was manually disabled */
+    disabledAt?: Date;
+    /** The amount to be added to the customer */
+    amount?: string;
+}
+/**
+ * Expire an Event immediately and deducting the remaining balance from the gift card
+ * @param eventId - ID of the Event to delete
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ */
+export declare function disableEvent(eventId: string, options?: DisableEventOptions): Promise<DisableEventResponse>;
+export interface DisableEventOptions {
+    /** The revision of the Event */
+    revision?: string;
+}
+/**
+ * Query Events using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+ * Results will be enriched with calculated balances
+ * @param query - WQL expression
+ * @public
+ * @documentationMaturity preview
+ * @requiredField query
+ */
+export declare function queryEventBalances(query: QueryV2): Promise<QueryEventBalancesResponse>;