@connectedxm/admin-sdk 11.7.0 → 11.8.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.7.0
+ * The version of the OpenAPI document: 11.8.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5291,6 +5291,18 @@ export interface EventPass {
     'attributes': Array<BasePassAttribute>;
     'badgeColor': string | null;
 }
+export interface EventPassChange {
+    'id': string;
+    'alternateId': number;
+    'type': PassChangeLogType;
+    'description': string;
+    'subjectId': string | null;
+    'oldValue': string | null;
+    'newValue': string | null;
+    'occurredAt': string;
+    'passId': string;
+    'createdAt': string;
+}
 export interface EventPassCreateInputs {
     'status'?: PurchaseStatus | null;
     'location'?: string | null;
@@ -7606,6 +7618,14 @@ export interface GetEventPassChangeWebhooks200Response {
 export declare enum GetEventPassChangeWebhooks200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetEventPassChanges200Response {
+    'status': GetEventPassChanges200ResponseStatusEnum;
+    'message': string;
+    'data': Array<EventPassChange>;
+}
+export declare enum GetEventPassChanges200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetEventPassMatches200Response {
     'status': GetEventPassMatches200ResponseStatusEnum;
     'message': string;
@@ -10998,6 +11018,16 @@ export interface PassAttributesUpdateInputsValuesInner {
     'attributeId': string;
     'value': string;
 }
+export declare enum PassChangeLogType {
+    Status = "status",
+    PassType = "passType",
+    Response = "response",
+    AddOn = "addOn",
+    Session = "session",
+    Registration = "registration",
+    Email = "email",
+    InternalRefId = "internalRefId"
+}
 export interface PassExchange {
     'id': string;
     'accountId': string;
@@ -38097,9 +38127,9 @@ export declare class EventsPagesTranslationsApi extends BaseAPI {
     updateEventPageTranslation(requestParameters: EventsPagesTranslationsApiUpdateEventPageTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}, any>>;
 }
 /**
- * EventsPasschangewebhooksApi - axios parameter creator
+ * EventsPasschangesApi - axios parameter creator
  */
-export declare const EventsPasschangewebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
+export declare const EventsPasschangesApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
      * @summary Connect a webhook to an event\'s pass change log
@@ -38121,6 +38151,17 @@ export declare const EventsPasschangewebhooksApiAxiosParamCreator: (configuratio
      * @throws {RequiredError}
      */
     getEventPassChangeWebhooks: (eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
+     * @summary Poll an event\'s pass changes
+     * @param {string} eventId The event identifier
+     * @param {string} [subjectId] Filter by subjectId
+     * @param {PassChangeLogType} [type] Filter by type
+     * @param {string} [passId] Filter by passId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventPassChanges: (eventId: string, subjectId?: string, type?: PassChangeLogType, passId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
      * @summary Disconnect a webhook from an event\'s pass change log
@@ -38132,9 +38173,9 @@ export declare const EventsPasschangewebhooksApiAxiosParamCreator: (configuratio
     removeEventPassChangeWebhook: (eventId: string, webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
- * EventsPasschangewebhooksApi - functional programming interface
+ * EventsPasschangesApi - functional programming interface
  */
-export declare const EventsPasschangewebhooksApiFp: (configuration?: Configuration) => {
+export declare const EventsPasschangesApiFp: (configuration?: Configuration) => {
     /**
      * Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
      * @summary Connect a webhook to an event\'s pass change log
@@ -38156,6 +38197,17 @@ export declare const EventsPasschangewebhooksApiFp: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getEventPassChangeWebhooks(eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassChangeWebhooks200Response>>;
+    /**
+     * Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
+     * @summary Poll an event\'s pass changes
+     * @param {string} eventId The event identifier
+     * @param {string} [subjectId] Filter by subjectId
+     * @param {PassChangeLogType} [type] Filter by type
+     * @param {string} [passId] Filter by passId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventPassChanges(eventId: string, subjectId?: string, type?: PassChangeLogType, passId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassChanges200Response>>;
     /**
      * Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
      * @summary Disconnect a webhook from an event\'s pass change log
@@ -38167,38 +38219,46 @@ export declare const EventsPasschangewebhooksApiFp: (configuration?: Configurati
     removeEventPassChangeWebhook(eventId: string, webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
 };
 /**
- * EventsPasschangewebhooksApi - factory interface
+ * EventsPasschangesApi - factory interface
  */
-export declare const EventsPasschangewebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+export declare const EventsPasschangesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      * Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
      * @summary Connect a webhook to an event\'s pass change log
-     * @param {EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
+     * @param {EventsPasschangesApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addEventPassChangeWebhook(requestParameters: EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddEventPassChangeWebhook200Response>;
+    addEventPassChangeWebhook(requestParameters: EventsPasschangesApiAddEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddEventPassChangeWebhook200Response>;
     /**
      * Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
      * @summary List an event\'s pass change log webhooks
-     * @param {EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
+     * @param {EventsPasschangesApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventPassChangeWebhooks(requestParameters: EventsPasschangesApiGetEventPassChangeWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChangeWebhooks200Response>;
+    /**
+     * Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
+     * @summary Poll an event\'s pass changes
+     * @param {EventsPasschangesApiGetEventPassChangesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEventPassChangeWebhooks(requestParameters: EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChangeWebhooks200Response>;
+    getEventPassChanges(requestParameters: EventsPasschangesApiGetEventPassChangesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChanges200Response>;
     /**
      * Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
      * @summary Disconnect a webhook from an event\'s pass change log
-     * @param {EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
+     * @param {EventsPasschangesApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeEventPassChangeWebhook(requestParameters: EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
+    removeEventPassChangeWebhook(requestParameters: EventsPasschangesApiRemoveEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
 };
 /**
- * Request parameters for addEventPassChangeWebhook operation in EventsPasschangewebhooksApi.
+ * Request parameters for addEventPassChangeWebhook operation in EventsPasschangesApi.
  */
-export interface EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest {
+export interface EventsPasschangesApiAddEventPassChangeWebhookRequest {
     /**
      * The event identifier
      */
@@ -38209,9 +38269,9 @@ export interface EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest {
     readonly webhookId: string;
 }
 /**
- * Request parameters for getEventPassChangeWebhooks operation in EventsPasschangewebhooksApi.
+ * Request parameters for getEventPassChangeWebhooks operation in EventsPasschangesApi.
  */
-export interface EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest {
+export interface EventsPasschangesApiGetEventPassChangeWebhooksRequest {
     /**
      * The event identifier
      */
@@ -38234,9 +38294,30 @@ export interface EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest {
     readonly search?: string;
 }
 /**
- * Request parameters for removeEventPassChangeWebhook operation in EventsPasschangewebhooksApi.
+ * Request parameters for getEventPassChanges operation in EventsPasschangesApi.
+ */
+export interface EventsPasschangesApiGetEventPassChangesRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: string;
+    /**
+     * Filter by subjectId
+     */
+    readonly subjectId?: string;
+    /**
+     * Filter by type
+     */
+    readonly type?: PassChangeLogType;
+    /**
+     * Filter by passId
+     */
+    readonly passId?: string;
+}
+/**
+ * Request parameters for removeEventPassChangeWebhook operation in EventsPasschangesApi.
  */
-export interface EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest {
+export interface EventsPasschangesApiRemoveEventPassChangeWebhookRequest {
     /**
      * The event identifier
      */
@@ -38247,33 +38328,41 @@ export interface EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest
     readonly webhookId: string;
 }
 /**
- * EventsPasschangewebhooksApi - object-oriented interface
+ * EventsPasschangesApi - object-oriented interface
  */
-export declare class EventsPasschangewebhooksApi extends BaseAPI {
+export declare class EventsPasschangesApi extends BaseAPI {
     /**
      * Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
      * @summary Connect a webhook to an event\'s pass change log
-     * @param {EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
+     * @param {EventsPasschangesApiAddEventPassChangeWebhookRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    addEventPassChangeWebhook(requestParameters: EventsPasschangewebhooksApiAddEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddEventPassChangeWebhook200Response, any, {}, any>>;
+    addEventPassChangeWebhook(requestParameters: EventsPasschangesApiAddEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddEventPassChangeWebhook200Response, any, {}, any>>;
     /**
      * Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
      * @summary List an event\'s pass change log webhooks
-     * @param {EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
+     * @param {EventsPasschangesApiGetEventPassChangeWebhooksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventPassChangeWebhooks(requestParameters: EventsPasschangesApiGetEventPassChangeWebhooksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassChangeWebhooks200Response, any, {}, any>>;
+    /**
+     * Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
+     * @summary Poll an event\'s pass changes
+     * @param {EventsPasschangesApiGetEventPassChangesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEventPassChangeWebhooks(requestParameters: EventsPasschangewebhooksApiGetEventPassChangeWebhooksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassChangeWebhooks200Response, any, {}, any>>;
+    getEventPassChanges(requestParameters: EventsPasschangesApiGetEventPassChangesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassChanges200Response, any, {}, any>>;
     /**
      * Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
      * @summary Disconnect a webhook from an event\'s pass change log
-     * @param {EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
+     * @param {EventsPasschangesApiRemoveEventPassChangeWebhookRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    removeEventPassChangeWebhook(requestParameters: EventsPasschangewebhooksApiRemoveEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
+    removeEventPassChangeWebhook(requestParameters: EventsPasschangesApiRemoveEventPassChangeWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
 }
 /**
  * EventsPassesApi - axios parameter creator