@wix/riseevent 1.0.14 → 1.0.15

package/type-bundles/meta.bundle.d.ts

@@ -1,441 +0,0 @@
-/** Event is the main entity of EventService */
-interface Event$1 {
-    /**
-     * 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 | null;
-    /**
-     * Represents the time this Event was last updated
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /** Wallet ID */
-    walletId?: string;
-    /** Represents the time when the event's amount will be added to the account */
-    startDate?: Date | null;
-    /** Represents the time when the unused balance will be deducted from the account */
-    expiresAt?: Date | null;
-    /** Represents the time when the event was manually disabled */
-    disabledAt?: Date | null;
-    /** The amount to be added to the customer */
-    amount?: string;
-    /** Free text comment regarding the Event context */
-    note?: string | null;
-    /** Indicates the kind of the specific event */
-    type?: EventType$1;
-    /**
-     * The transactionId that added the event's amount;
-     * @readonly
-     */
-    eventAddedTransactionId?: string | null;
-    /**
-     * The transactionId that removed the remaining event's balance;
-     * @readonly
-     */
-    eventRemovedTransactionId?: string | null;
-    status?: EventStatus$1;
-}
-declare enum EventType$1 {
-    UNKNOWN = "UNKNOWN",
-    REWARD = "REWARD",
-    REFUND = "REFUND"
-}
-declare enum EventStatus$1 {
-    PENDING = "PENDING",
-    ACTIVE = "ACTIVE",
-    DISABLED = "DISABLED",
-    EXPIRED = "EXPIRED"
-}
-interface CreateEventRequest$1 {
-    /** Event to be created */
-    event: Event$1;
-}
-interface CreateEventResponse$1 {
-    /** The created Event */
-    event?: Event$1;
-}
-interface GetEventRequest$1 {
-    /** ID of the Event to retrieve */
-    eventId: string;
-}
-interface GetEventResponse$1 {
-    /** The retrieved Event */
-    event?: Event$1;
-}
-interface UpdateEventRequest$1 {
-    /** Event to be updated, may be partial */
-    event: Event$1;
-}
-interface UpdateEventResponse$1 {
-    /** The updated Event */
-    event?: Event$1;
-}
-interface DisableEventRequest$1 {
-    /** ID of the Event to delete */
-    eventId: string;
-    /** The revision of the Event */
-    revision: string;
-}
-interface DisableEventResponse$1 {
-    /** The expired Event */
-    event?: Event$1;
-}
-interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging$1;
-    /** 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$1;
-    /**
-     * 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).
-     */
-    sort?: Sorting$1[];
-    /** 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 */
-interface QueryV2PagingMethodOneOf$1 {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging$1;
-    /** 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$1;
-}
-interface Sorting$1 {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder$1;
-}
-declare enum SortOrder$1 {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-interface Paging$1 {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-interface CursorPaging$1 {
-    /** 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;
-}
-interface PagingMetadataV2$1 {
-    /** 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$1;
-}
-interface Cursors$1 {
-    /** 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;
-}
-interface QueryEventBalancesRequest$1 {
-    /** WQL expression */
-    query: QueryV2$1;
-}
-interface QueryEventBalancesResponse$1 {
-    /** The retrieved Events with their balance */
-    events?: EventWithBalance$1[];
-    pagingMetadata?: PagingMetadataV2$1;
-}
-interface EventWithBalance$1 {
-    /** Event */
-    event?: Event$1;
-    /** Event balance */
-    balance?: string | null;
-}
-interface EventNonNullableFields$1 {
-    walletId: string;
-    amount: string;
-    type: EventType$1;
-    status: EventStatus$1;
-}
-interface CreateEventResponseNonNullableFields$1 {
-    event?: EventNonNullableFields$1;
-}
-interface GetEventResponseNonNullableFields$1 {
-    event?: EventNonNullableFields$1;
-}
-interface UpdateEventResponseNonNullableFields$1 {
-    event?: EventNonNullableFields$1;
-}
-interface DisableEventResponseNonNullableFields$1 {
-    event?: EventNonNullableFields$1;
-}
-interface EventWithBalanceNonNullableFields$1 {
-    event?: EventNonNullableFields$1;
-}
-interface QueryEventBalancesResponseNonNullableFields$1 {
-    events: EventWithBalanceNonNullableFields$1[];
-}
-
-/** Event is the main entity of EventService */
-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 | null;
-    /**
-     * Represents the time this Event was last updated
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /** Wallet ID */
-    walletId?: string;
-    /** Represents the time when the event's amount will be added to the account */
-    startDate?: Date | null;
-    /** Represents the time when the unused balance will be deducted from the account */
-    expiresAt?: Date | null;
-    /** Represents the time when the event was manually disabled */
-    disabledAt?: Date | null;
-    /** The amount to be added to the customer */
-    amount?: string;
-    /** Free text comment regarding the Event context */
-    note?: string | null;
-    /** Indicates the kind of the specific event */
-    type?: EventType;
-    /**
-     * The transactionId that added the event's amount;
-     * @readonly
-     */
-    eventAddedTransactionId?: string | null;
-    /**
-     * The transactionId that removed the remaining event's balance;
-     * @readonly
-     */
-    eventRemovedTransactionId?: string | null;
-    status?: EventStatus;
-}
-declare enum EventType {
-    UNKNOWN = "UNKNOWN",
-    REWARD = "REWARD",
-    REFUND = "REFUND"
-}
-declare enum EventStatus {
-    PENDING = "PENDING",
-    ACTIVE = "ACTIVE",
-    DISABLED = "DISABLED",
-    EXPIRED = "EXPIRED"
-}
-interface CreateEventRequest {
-    /** Event to be created */
-    event: Event;
-}
-interface CreateEventResponse {
-    /** The created Event */
-    event?: Event;
-}
-interface GetEventRequest {
-    /** ID of the Event to retrieve */
-    eventId: string;
-}
-interface GetEventResponse {
-    /** The retrieved Event */
-    event?: Event;
-}
-interface UpdateEventRequest {
-    /** Event to be updated, may be partial */
-    event: Event;
-}
-interface UpdateEventResponse {
-    /** The updated Event */
-    event?: Event;
-}
-interface DisableEventRequest {
-    /** ID of the Event to delete */
-    eventId: string;
-    /** The revision of the Event */
-    revision: string;
-}
-interface DisableEventResponse {
-    /** The expired Event */
-    event?: Event;
-}
-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.
-     *
-     * 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).
-     */
-    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 */
-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;
-}
-interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-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;
-}
-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;
-}
-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;
-}
-interface QueryEventBalancesRequest {
-    /** WQL expression */
-    query: QueryV2;
-}
-interface QueryEventBalancesResponse {
-    /** The retrieved Events with their balance */
-    events?: EventWithBalance[];
-    pagingMetadata?: PagingMetadataV2;
-}
-interface EventWithBalance {
-    /** Event */
-    event?: Event;
-    /** Event balance */
-    balance?: string | null;
-}
-interface EventNonNullableFields {
-    walletId: string;
-    amount: string;
-    type: EventType;
-    status: EventStatus;
-}
-interface CreateEventResponseNonNullableFields {
-    event?: EventNonNullableFields;
-}
-interface GetEventResponseNonNullableFields {
-    event?: EventNonNullableFields;
-}
-interface UpdateEventResponseNonNullableFields {
-    event?: EventNonNullableFields;
-}
-interface DisableEventResponseNonNullableFields {
-    event?: EventNonNullableFields;
-}
-interface EventWithBalanceNonNullableFields {
-    event?: EventNonNullableFields;
-}
-interface QueryEventBalancesResponseNonNullableFields {
-    events: EventWithBalanceNonNullableFields[];
-}
-
-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 createEvent(): __PublicMethodMetaInfo<'POST', {}, CreateEventRequest, CreateEventRequest$1, CreateEventResponse & CreateEventResponseNonNullableFields, CreateEventResponse$1 & CreateEventResponseNonNullableFields$1>;
-declare function getEvent(): __PublicMethodMetaInfo<'GET', {
-    eventId: string;
-}, GetEventRequest, GetEventRequest$1, GetEventResponse & GetEventResponseNonNullableFields, GetEventResponse$1 & GetEventResponseNonNullableFields$1>;
-declare function updateEvent(): __PublicMethodMetaInfo<'PATCH', {
-    eventId: string;
-}, UpdateEventRequest, UpdateEventRequest$1, UpdateEventResponse & UpdateEventResponseNonNullableFields, UpdateEventResponse$1 & UpdateEventResponseNonNullableFields$1>;
-declare function disableEvent(): __PublicMethodMetaInfo<'POST', {
-    eventId: string;
-}, DisableEventRequest, DisableEventRequest$1, DisableEventResponse & DisableEventResponseNonNullableFields, DisableEventResponse$1 & DisableEventResponseNonNullableFields$1>;
-declare function queryEventBalances(): __PublicMethodMetaInfo<'POST', {}, QueryEventBalancesRequest, QueryEventBalancesRequest$1, QueryEventBalancesResponse & QueryEventBalancesResponseNonNullableFields, QueryEventBalancesResponse$1 & QueryEventBalancesResponseNonNullableFields$1>;
-
-type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
-declare const meta_createEvent: typeof createEvent;
-declare const meta_disableEvent: typeof disableEvent;
-declare const meta_getEvent: typeof getEvent;
-declare const meta_queryEventBalances: typeof queryEventBalances;
-declare const meta_updateEvent: typeof updateEvent;
-declare namespace meta {
-  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createEvent as createEvent, meta_disableEvent as disableEvent, meta_getEvent as getEvent, meta_queryEventBalances as queryEventBalances, meta_updateEvent as updateEvent };
-}
-
-export { meta as event };