@wix/events 1.0.0

package/build/es/src/events-v2-policy.universal.d.ts

@@ -0,0 +1,465 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** Each event can have up to 3 policies - free-text that define terms & conditions, refunds & exchanges and/or other policies, as relevant. */
+export interface Policy {
+    /**
+     * Policy ID (generated automatically)
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Represents the current state of Policy. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date policy was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date policy was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Policy name. */
+    name?: string;
+    /** Policy body. */
+    body?: string;
+    /** Event ID. */
+    eventId?: string;
+}
+export interface CreatePolicyRequest {
+    /** An Event Policy to be created */
+    policy: Policy;
+}
+export interface CreatePolicyResponse {
+    /** The Event Policy that was created */
+    policy?: Policy;
+}
+export interface UpdatePolicyRequest {
+    /** Event Policy to update */
+    policy: Policy;
+}
+export interface UpdatePolicyResponse {
+    /** The updated Event Policy */
+    policy?: Policy;
+}
+export interface UpdatePolicySortIndexRequest {
+    /** Policy's ID */
+    policyId?: string;
+    /** The revision of the Event Policy */
+    revision?: string;
+    /** the sort index of a policy to set */
+    sortIndex?: number;
+}
+export interface UpdatePolicySortIndexResponse {
+    /** the updated Event Policy */
+    policy?: Policy;
+}
+export interface DeletePolicyRequest {
+    /** Event Policy to delete */
+    policyId: string;
+    /** The revision of the Event Policy */
+    revision?: string;
+}
+export interface DeletePolicyResponse {
+}
+export interface QueryPoliciesRequest {
+    /** WQL expression */
+    query: QueryV2;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /**
+     * 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[];
+    /** 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;
+}
+/** @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 QueryPoliciesResponse {
+    /** Event Policies */
+    policies?: Policy[];
+    /** Query result's metadata */
+    metadata?: 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 Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface ReorderEventPoliciesRequest extends ReorderEventPoliciesRequestReferencePolicyOneOf {
+    /** Event ID */
+    eventId?: string;
+    /** Event Policy ID */
+    policyId?: string;
+    /** Move the Event Policy Id before this Event Policy ID */
+    beforePolicyId?: string;
+    /** Move the Event Policy Id after this Event Policy ID */
+    afterPolicyId?: string;
+}
+/** @oneof */
+export interface ReorderEventPoliciesRequestReferencePolicyOneOf {
+    /** Move the Event Policy Id before this Event Policy ID */
+    beforePolicyId?: string;
+    /** Move the Event Policy Id after this Event Policy ID */
+    afterPolicyId?: string;
+}
+export interface ReorderEventPoliciesResponse {
+    /** Ordered Event Policies */
+    policies?: Policy[];
+}
+export interface GetEventPoliciesRequest {
+    /** Event Id */
+    eventId: string;
+}
+export interface GetEventPoliciesResponse {
+    /** All policies of a particular event */
+    policies?: Policy[];
+}
+export interface EventCopied {
+    /** Event created timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event location. */
+    location?: Location;
+    /** Event schedule configuration. */
+    scheduleConfig?: ScheduleConfig;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+    /** Event status. */
+    status?: EventStatus;
+    /** Instance ID. Indicates the original app instance which current event was derived from. */
+    derivedFromInstanceId?: string | null;
+    /** Event ID. Indicates the original event which current event was derived from. */
+    derivedFromEventId?: string | null;
+    /**
+     * Map of copied ticket definitions from original event.
+     * Key represents ticket def id in the original event.
+     * Value represents ticket def id in the newly created event.
+     */
+    ticketDefinitions?: Record<string, string>;
+}
+export interface Location {
+    /** Location name. */
+    name?: string | null;
+    /** Location map coordinates. */
+    coordinates?: MapCoordinates;
+    /** Single line address representation. */
+    address?: string | null;
+    /** Location type. */
+    type?: LocationType;
+    /**
+     * Full address derived from formatted single line `address`.
+     * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
+     * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
+     *
+     * Migration notes:
+     * - `full_address.formatted_address` is equivalent to `address`.
+     * - `full_address.geocode` is equivalent to `coordinates`.
+     */
+    fullAddress?: Address;
+    /**
+     * Defines event location as TBD (To Be Determined).
+     * When event location is not yet defined, `name` is displayed instead of location address.
+     * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
+     */
+    tbd?: boolean | null;
+}
+export interface MapCoordinates {
+    /** Latitude. */
+    lat?: number;
+    /** Longitude. */
+    lng?: number;
+}
+export declare enum LocationType {
+    VENUE = "VENUE",
+    ONLINE = "ONLINE"
+}
+/** Physical address */
+export interface Address extends AddressStreetOneOf {
+    /** country code */
+    country?: string | null;
+    /** subdivision (usually state or region) code according to ISO 3166-2 */
+    subdivision?: string | null;
+    /** city name */
+    city?: string | null;
+    /** zip/postal code */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
+    addressLine2?: string | null;
+    /** a break down of the street to number and street name */
+    streetAddress?: StreetAddress;
+    /** Main address line (usually street and number) as free text */
+    addressLine1?: string | null;
+}
+/** @oneof */
+export interface AddressStreetOneOf {
+    /** a break down of the street to number and street name */
+    streetAddress?: StreetAddress;
+    /** Main address line (usually street and number) as free text */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** street number */
+    number?: string;
+    /** street name */
+    name?: string;
+}
+export interface AddressLocation {
+    latitude?: number | null;
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** subdivision short code */
+    code?: string;
+    /** subdivision full-name */
+    name?: string;
+}
+export declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+export interface ScheduleConfig {
+    /**
+     * Defines event as TBD (To Be Determined) schedule.
+     * When event time is not yet defined, TBD message is displayed instead of event start and end times.
+     * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
+     */
+    scheduleTbd?: boolean;
+    /** TBD message. */
+    scheduleTbdMessage?: string | null;
+    /** Event start timestamp. */
+    startDate?: Date;
+    /** Event end timestamp. */
+    endDate?: Date;
+    /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
+    timeZoneId?: string | null;
+    /** Whether end date is hidden in the formatted schedule. */
+    endDateHidden?: boolean;
+    /** Whether time zone is displayed in formatted schedule. */
+    showTimeZone?: boolean;
+    /** Event recurrences. */
+    recurrences?: Recurrences;
+}
+export interface Recurrences {
+    /** Event occurrences. */
+    occurrences?: Occurrence[];
+    /**
+     * Recurring event category ID.
+     * @readonly
+     */
+    categoryId?: string | null;
+    /**
+     * Recurrence status.
+     * @readonly
+     */
+    status?: Status;
+}
+export interface Occurrence {
+    /** Event start timestamp. */
+    startDate?: Date;
+    /** Event end timestamp. */
+    endDate?: Date;
+    /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
+    timeZoneId?: string | null;
+    /** Whether time zone is displayed in formatted schedule. */
+    showTimeZone?: boolean;
+}
+export declare enum Status {
+    /** Event occurs only once. */
+    ONE_TIME = "ONE_TIME",
+    /** Event is recurring. */
+    RECURRING = "RECURRING",
+    /** Marks the next upcoming occurrence of the recurring event. */
+    RECURRING_NEXT = "RECURRING_NEXT",
+    /** Marks the most recent ended occurrence of the recurring event. */
+    RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
+    /** Marks the most recent canceled occurrence of the recurring event. */
+    RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
+}
+export declare enum EventStatus {
+    /** Event is public and scheduled to start */
+    SCHEDULED = "SCHEDULED",
+    /** Event has started */
+    STARTED = "STARTED",
+    /** Event has ended */
+    ENDED = "ENDED",
+    /** Event was canceled */
+    CANCELED = "CANCELED",
+    /** Event is not public and needs to be published */
+    DRAFT = "DRAFT"
+}
+export interface Empty {
+}
+/**
+ * Creates a policy for an event.
+ * Each event can have up to 3 policies.
+ * @param policy - An Event Policy to be created
+ * @public
+ * @requiredField policy
+ * @requiredField policy.body
+ * @requiredField policy.eventId
+ * @requiredField policy.name
+ */
+export declare function createPolicy(policy: Policy): Promise<CreatePolicyResponse>;
+/**
+ * Updates a policy.
+ * @param _id - Policy ID (generated automatically)
+ * @public
+ * @requiredField _id
+ * @requiredField policy
+ * @requiredField policy.body
+ * @requiredField policy.eventId
+ * @requiredField policy.name
+ */
+export declare function updatePolicy(_id: string | null, policy: UpdatePolicy): Promise<UpdatePolicyResponse>;
+export interface UpdatePolicy {
+    /**
+     * Policy ID (generated automatically)
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Represents the current state of Policy. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date policy was created
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date policy was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Policy name. */
+    name?: string;
+    /** Policy body. */
+    body?: string;
+    /** Event ID. */
+    eventId?: string;
+}
+/**
+ * Deletes a policy.
+ * @param policyId - Event Policy to delete
+ * @public
+ * @requiredField policyId
+ */
+export declare function deletePolicy(policyId: string, options?: DeletePolicyOptions): Promise<void>;
+export interface DeletePolicyOptions {
+    /** The revision of the Event Policy */
+    revision?: string;
+}
+/**
+ * Retrieves a list of policies, given the provided paging and filter.
+ * @param query - WQL expression
+ * @public
+ * @requiredField query
+ */
+export declare function queryPolicies(query: QueryV2): Promise<QueryPoliciesResponse>;
+/**
+ * Change the order of Event Policies
+ * @public */
+export declare function reorderEventPolicies(options?: ReorderEventPoliciesOptions): Promise<ReorderEventPoliciesResponse>;
+export interface ReorderEventPoliciesOptions {
+    /** Event ID */
+    eventId?: string;
+    /** Event Policy ID */
+    policyId?: string;
+    /** Move the Event Policy Id before this Event Policy ID */
+    beforePolicyId?: string;
+    /** Move the Event Policy Id after this Event Policy ID */
+    afterPolicyId?: string;
+}
+/**
+ * Get all Event Policies of an Event
+ * @param eventId - Event Id
+ * @public
+ * @requiredField eventId
+ */
+export declare function getEventPolicies(eventId: string): Promise<GetEventPoliciesResponse>;