@gradientedge/commercetools-utils 5.36.0 → 6.1.0

package/dist/mjs/types/models/subscription.d.ts

@@ -12,7 +12,7 @@ export declare enum AwsAuthenticationModeValues {
     Credentials = "Credentials",
     Iam = "IAM"
 }
-export type AwsAuthenticationMode = 'Credentials' | 'IAM' | string;
+export type AwsAuthenticationMode = 'Credentials' | 'IAM' | (string & {});
 /**
  *	Notification about changes to a resource. The payload format differs for resource [creation](ctp:api:type:ResourceCreatedDeliveryPayload),
  *	[update](ctp:api:type:ResourceUpdatedDeliveryPayload),
@@ -71,7 +71,7 @@ export declare enum ChangeSubscriptionResourceTypeIdValues {
     Type = "type",
     Zone = "zone"
 }
-export type ChangeSubscriptionResourceTypeId = 'approval-flow' | 'approval-rule' | 'associate-role' | 'attribute-group' | 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-selection' | 'product-tailoring' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone' | string;
+export type ChangeSubscriptionResourceTypeId = 'approval-flow' | 'approval-rule' | 'associate-role' | 'attribute-group' | 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-selection' | 'product-tailoring' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone' | (string & {});
 /**
  *	The [CloudEventsFormat](ctp:api:type:CloudEventsFormat) represents event data in a way that conforms to a common specification. The payload can be found inside the `data` field.
  *
@@ -133,7 +133,7 @@ export interface CloudEventsPayload {
      */
     readonly dataref?: string;
     /**
-     *	[MessageDeliveryPayload](ctp:api:type:MessageDeliveryPayload), [ResourceCreatedDeliveryPayload](ctp:api:type:ResourceCreatedDeliveryPayload), [ResourceUpdatedDeliveryPayload](ctp:api:type:ResourceUpdatedDeliveryPayload), or [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload).
+     *	[MessageDeliveryPayload](ctp:api:type:MessageDeliveryPayload), [ResourceCreatedDeliveryPayload](ctp:api:type:ResourceCreatedDeliveryPayload), [ResourceUpdatedDeliveryPayload](ctp:api:type:ResourceUpdatedDeliveryPayload), or [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload), [EventDeliveryPayload](ctp:api:type:EventDeliveryPayload).
      *
      *
      */
@@ -157,38 +157,6 @@ export interface CloudEventsFormat extends IDeliveryFormat {
      */
     readonly cloudEventsVersion: string;
 }
-/**
- *	All payloads for the [PlatformFormat](ctp:api:type:PlatformFormat) share these common fields.
- *
- */
-export type DeliveryPayload = MessageDeliveryPayload | ResourceCreatedDeliveryPayload | ResourceDeletedDeliveryPayload | ResourceUpdatedDeliveryPayload;
-export interface IDeliveryPayload {
-    /**
-     *	`key` of the [Project](ctp:api:type:Project).
-     *	Useful for processing notifications if the Destination receives them from multiple Projects.
-     *
-     *
-     */
-    readonly projectKey: string;
-    /**
-     *	Identifies the payload.
-     *
-     *
-     */
-    readonly notificationType: string;
-    /**
-     *	Reference to the resource that triggered the notification.
-     *
-     *
-     */
-    readonly resource: Reference;
-    /**
-     *	User-defined unique identifiers of the resource.
-     *
-     *
-     */
-    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
-}
 export type Destination = AzureEventGridDestination | AzureServiceBusDestination | ConfluentCloudDestination | EventBridgeDestination | GoogleCloudPubSubDestination | SnsDestination | SqsDestination;
 export interface IDestination {
     /**
@@ -304,95 +272,67 @@ export interface EventBridgeDestination extends IDestination {
     readonly source: string;
 }
 /**
- *	Destination for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) that can be used
- *	for [Pull subscriptions](https://cloud.google.com/pubsub/docs/pull) as well as for [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
- *	The `topic` must give the `pubsub.topics.publish` permission to the service account `subscriptions@commercetools-platform.iam.gserviceaccount.com`.
- *	If used with the [CloudEventsFormat](#cloudeventsformat), the notification conforms to the [PubSub Protocol Binding](https://github.com/google/knative-gcp/blob/master/docs/spec/pubsub-protocol-binding.md) of the [Structured Content Mode](https://github.com/google/knative-gcp/blob/master/docs/spec/pubsub-protocol-binding.md#32-structured-content-mode).
+ *	For EventSubscription, the format of the payload is custom for each specific notification.
  *
  */
-export interface GoogleCloudPubSubDestination extends IDestination {
-    readonly type: 'GoogleCloudPubSub';
+export interface EventSubscription {
     /**
-     *	ID of the Google Cloud project that contains the Pub/Sub topic.
+     *	Unique identifier for the type of resource, for example, `import-api`.
      *
      *
      */
-    readonly projectId: string;
+    readonly resourceTypeId: EventSubscriptionResourceTypeId;
     /**
-     *	Name of the topic.
+     *	Must contain valid event types for the resource.
+     *	For example, for resource type `import-api` the event type `ImportContainerCreated` is valid.
+     *	If no `types` are given, the Subscription will receive all events for this resource.
      *
      *
      */
-    readonly topic: string;
+    readonly types?: EventType[];
 }
 /**
- *	This payload is sent for a [MessageSubscription](ctp:api:type:MessageSubscription).
+ *	Resource types supported by [EventSubscriptions](ctp:api:type:EventSubscription).
  *
  */
-export interface MessageDeliveryPayload extends IDeliveryPayload {
-    readonly notificationType: 'Message';
-    /**
-     *	`key` of the [Project](ctp:api:type:Project).
-     *	Useful for processing notifications if the Destination receives them from multiple Projects.
-     *
-     *
-     */
-    readonly projectKey: string;
-    /**
-     *	Reference to the resource that triggered the notification.
-     *
-     *
-     */
-    readonly resource: Reference;
-    /**
-     *	User-defined unique identifiers of the resource.
-     *
-     *
-     */
-    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
-    /**
-     *	Unique ID of the message.
-     *
-     *
-     */
-    readonly id: string;
-    /**
-     *	Last seen version of the resource.
-     *
-     *
-     */
-    readonly version: number;
-    /**
-     *	Date and time (UTC) the resource was initially created.
-     *
-     *
-     */
-    readonly createdAt: string;
-    /**
-     *	Date and time (UTC) the resource was last modified.
-     *
-     *
-     */
-    readonly lastModifiedAt: string;
-    /**
-     *	Used to ensure all messages of the resource are processed in correct order.
-     *	The `sequenceNumber` of the next message of the resource is a successor of the `sequenceNumber` of the current message.
-     *
-     *
-     */
-    readonly sequenceNumber: number;
+export declare enum EventSubscriptionResourceTypeIdValues {
+    ImportApi = "import-api"
+}
+export type EventSubscriptionResourceTypeId = 'import-api' | (string & {});
+/**
+ *	Type of events supported by [EventSubscriptions](ctp:api:type:EventSubscription).
+ *
+ */
+export declare enum EventTypeValues {
+    ImportContainerCreated = "ImportContainerCreated",
+    ImportContainerDeleted = "ImportContainerDeleted",
+    ImportOperationRejected = "ImportOperationRejected",
+    ImportUnresolved = "ImportUnresolved",
+    ImportValidationFailed = "ImportValidationFailed",
+    ImportWaitForMasterVariant = "ImportWaitForMasterVariant"
+}
+export type EventType = 'ImportContainerCreated' | 'ImportContainerDeleted' | 'ImportOperationRejected' | 'ImportUnresolved' | 'ImportValidationFailed' | 'ImportWaitForMasterVariant' | (string & {});
+/**
+ *	Destination for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) that can be used
+ *	for [Pull subscriptions](https://cloud.google.com/pubsub/docs/pull) as well as for [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
+ *	The `topic` must give the `pubsub.topics.publish` permission to the service account `subscriptions@commercetools-platform.iam.gserviceaccount.com`.
+ *	If used with the [CloudEventsFormat](#cloudeventsformat), the notification conforms to the [PubSub Protocol Binding](https://github.com/google/knative-gcp/blob/master/docs/spec/pubsub-protocol-binding.md) of the [Structured Content Mode](https://github.com/google/knative-gcp/blob/master/docs/spec/pubsub-protocol-binding.md#32-structured-content-mode).
+ *
+ */
+export interface GoogleCloudPubSubDestination extends IDestination {
+    readonly type: 'GoogleCloudPubSub';
     /**
-     *	Version of the resource on which the update was performed.
+     *	ID of the Google Cloud project that contains the Pub/Sub topic.
      *
      *
      */
-    readonly resourceVersion: number;
+    readonly projectId: string;
     /**
-     *	If the payload does not fit into the size limit or its format is not accepted by the messaging service, the `payloadNotIncluded` field is present.
+     *	Name of the topic.
      *
      *
      */
-    readonly payloadNotIncluded?: PayloadNotIncluded;
+    readonly topic: string;
 }
 /**
  *	Messages will be delivered even if the Messages Query HTTP API [is not enabled](/../api/projects/messages#enable-querying-messages-via-the-api).
@@ -443,7 +383,7 @@ export declare enum MessageSubscriptionResourceTypeIdValues {
     StandalonePrice = "standalone-price",
     Store = "store"
 }
-export type MessageSubscriptionResourceTypeId = 'approval-flow' | 'approval-rule' | 'associate-role' | 'business-unit' | 'category' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'inventory-entry' | 'order' | 'payment' | 'product' | 'product-selection' | 'product-tailoring' | 'quote' | 'quote-request' | 'review' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'store' | string;
+export type MessageSubscriptionResourceTypeId = 'approval-flow' | 'approval-rule' | 'associate-role' | 'business-unit' | 'category' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'inventory-entry' | 'order' | 'payment' | 'product' | 'product-selection' | 'product-tailoring' | 'quote' | 'quote-request' | 'review' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'store' | (string & {});
 export interface PayloadNotIncluded {
     /**
      *	Reason the payload is not included. For example, the payload is too large, or its content is not supported by the Subscription destination.
@@ -465,132 +405,6 @@ export interface PayloadNotIncluded {
 export interface PlatformFormat extends IDeliveryFormat {
     readonly type: 'Platform';
 }
-/**
- *	This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is created.
- *
- */
-export interface ResourceCreatedDeliveryPayload extends IDeliveryPayload {
-    readonly notificationType: 'ResourceCreated';
-    /**
-     *	`key` of the [Project](ctp:api:type:Project).
-     *	Useful for processing notifications if the Destination receives them from multiple Projects.
-     *
-     *
-     */
-    readonly projectKey: string;
-    /**
-     *	Reference to the resource that triggered the notification.
-     *
-     *
-     */
-    readonly resource: Reference;
-    /**
-     *	User-defined unique identifiers of the resource.
-     *
-     *
-     */
-    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
-    /**
-     *	Last seen version of the resource.
-     *
-     *
-     */
-    readonly version: number;
-    /**
-     *	Date and time (UTC) the resource was last modified.
-     *
-     *
-     */
-    readonly modifiedAt: string;
-}
-/**
- *	This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is deleted.
- *
- */
-export interface ResourceDeletedDeliveryPayload extends IDeliveryPayload {
-    readonly notificationType: 'ResourceDeleted';
-    /**
-     *	`key` of the [Project](ctp:api:type:Project).
-     *	Useful for processing notifications if the Destination receives them from multiple Projects.
-     *
-     *
-     */
-    readonly projectKey: string;
-    /**
-     *	Reference to the resource that triggered the notification.
-     *
-     *
-     */
-    readonly resource: Reference;
-    /**
-     *	User-defined unique identifiers of the resource.
-     *
-     *
-     */
-    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
-    /**
-     *	Last seen version of the resource.
-     *
-     *
-     */
-    readonly version: number;
-    /**
-     *	Date and time (UTC) the resource was last deleted.
-     *
-     *
-     */
-    readonly modifiedAt: string;
-    /**
-     *	`true` if the `dataErasure` [parameter](/../api/gdpr#data-erasure-of-personal-data) on the `DELETE` request was set to `true`.
-     *
-     *
-     */
-    readonly dataErasure?: boolean;
-}
-/**
- *	This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is updated. This includes updates by a background process, like a change in product availability.
- *
- */
-export interface ResourceUpdatedDeliveryPayload extends IDeliveryPayload {
-    readonly notificationType: 'ResourceUpdated';
-    /**
-     *	`key` of the [Project](ctp:api:type:Project).
-     *	Useful for processing notifications if the Destination receives them from multiple Projects.
-     *
-     *
-     */
-    readonly projectKey: string;
-    /**
-     *	Reference to the resource that triggered the notification.
-     *
-     *
-     */
-    readonly resource: Reference;
-    /**
-     *	User-defined unique identifiers of the resource.
-     *
-     *
-     */
-    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
-    /**
-     *	Last seen version of the resource.
-     *
-     *
-     */
-    readonly version: number;
-    /**
-     *	Version of the resource before the update.
-     *
-     *
-     */
-    readonly oldVersion: number;
-    /**
-     *	Date and time (UTC) the resource was last updated.
-     *
-     *
-     */
-    readonly modifiedAt: string;
-}
 /**
  *	[AWS SNS](https://aws.amazon.com/sns/) can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues. The SQS queue must be a [Standard](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) queue type.
  *
@@ -726,6 +540,12 @@ export interface Subscription extends BaseResource {
      *
      */
     readonly messages: MessageSubscription[];
+    /**
+     *	Events subscribed to.
+     *
+     *
+     */
+    readonly events: EventSubscription[];
     /**
      *	Format in which the payload is delivered.
      *
@@ -768,6 +588,12 @@ export interface SubscriptionDraft {
      *
      */
     readonly messages?: MessageSubscription[];
+    /**
+     *	Events to be subscribed to.
+     *
+     *
+     */
+    readonly events?: EventSubscription[];
     /**
      *	Format in which the payload is delivered. When not provided, the [PlatformFormat](ctp:api:type:PlatformFormat) is selected by default.
      *
@@ -786,18 +612,295 @@ export declare enum SubscriptionHealthStatusValues {
     ManuallySuspended = "ManuallySuspended",
     TemporaryError = "TemporaryError"
 }
-export type SubscriptionHealthStatus = 'ConfigurationError' | 'ConfigurationErrorDeliveryStopped' | 'Healthy' | 'ManuallySuspended' | 'TemporaryError' | string;
+export type SubscriptionHealthStatus = 'ConfigurationError' | 'ConfigurationErrorDeliveryStopped' | 'Healthy' | 'ManuallySuspended' | 'TemporaryError' | (string & {});
 /**
- *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Subscription](ctp:api:type:Subscription).
+ *	All payloads for the [PlatformFormat](ctp:api:type:PlatformFormat) share these common fields.
  *
  */
-export interface SubscriptionPagedQueryResponse {
+export type SubscriptionNotification = DeliveryPayload | EventDeliveryPayload | MessageDeliveryPayload | ResourceCreatedDeliveryPayload | ResourceDeletedDeliveryPayload | ResourceUpdatedDeliveryPayload;
+export interface ISubscriptionNotification {
     /**
-     *	Number of [results requested](/../api/general-concepts#limit).
+     *	Identifies the payload.
      *
      *
      */
-    readonly limit: number;
+    readonly notificationType: string;
+}
+/**
+ *	All payloads for the [PlatformFormat](ctp:api:type:PlatformFormat) share these common fields.
+ *
+ */
+export type DeliveryPayload = MessageDeliveryPayload | ResourceCreatedDeliveryPayload | ResourceDeletedDeliveryPayload | ResourceUpdatedDeliveryPayload;
+export interface IDeliveryPayload {
+    /**
+     *	Identifies the payload.
+     *
+     *
+     */
+    readonly notificationType: string;
+    /**
+     *	`key` of the [Project](ctp:api:type:Project).
+     *	Useful for processing notifications if the Destination receives them from multiple Projects.
+     *
+     *
+     */
+    readonly projectKey: string;
+    /**
+     *	Reference to the resource that triggered the notification.
+     *
+     *
+     */
+    readonly resource: Reference;
+    /**
+     *	User-defined unique identifiers of the resource.
+     *
+     *
+     */
+    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
+}
+/**
+ *	This payload is sent for an [EventSubscription](ctp:api:type:EventSubscription).
+ *
+ */
+export interface EventDeliveryPayload extends ISubscriptionNotification {
+    readonly notificationType: 'Event';
+    /**
+     *	Unique identifier of the Event.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	The type of Event that has occurred.
+     *
+     *
+     */
+    readonly type: EventType;
+    /**
+     *	The type of resource targeted by the Event.
+     *
+     *
+     */
+    readonly resourceType: string;
+    /**
+     *	The data describing the event that has taken place.
+     *
+     *
+     */
+    readonly data: any;
+    /**
+     *	Date and time (UTC) the resource was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+}
+/**
+ *	This payload is sent for a [MessageSubscription](ctp:api:type:MessageSubscription).
+ *
+ */
+export interface MessageDeliveryPayload extends IDeliveryPayload {
+    readonly notificationType: 'Message';
+    /**
+     *	`key` of the [Project](ctp:api:type:Project).
+     *	Useful for processing notifications if the Destination receives them from multiple Projects.
+     *
+     *
+     */
+    readonly projectKey: string;
+    /**
+     *	Reference to the resource that triggered the notification.
+     *
+     *
+     */
+    readonly resource: Reference;
+    /**
+     *	User-defined unique identifiers of the resource.
+     *
+     *
+     */
+    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
+    /**
+     *	Unique ID of the message.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Last seen version of the resource.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the resource was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the resource was last modified.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	Used to ensure all messages of the resource are processed in correct order.
+     *	The `sequenceNumber` of the next message of the resource is a successor of the `sequenceNumber` of the current message.
+     *
+     *
+     */
+    readonly sequenceNumber: number;
+    /**
+     *	Version of the resource on which the update was performed.
+     *
+     *
+     */
+    readonly resourceVersion: number;
+    /**
+     *	If the payload does not fit into the size limit or its format is not accepted by the messaging service, the `payloadNotIncluded` field is present.
+     *
+     *
+     */
+    readonly payloadNotIncluded?: PayloadNotIncluded;
+}
+/**
+ *	This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is created.
+ *
+ */
+export interface ResourceCreatedDeliveryPayload extends IDeliveryPayload {
+    readonly notificationType: 'ResourceCreated';
+    /**
+     *	`key` of the [Project](ctp:api:type:Project).
+     *	Useful for processing notifications if the Destination receives them from multiple Projects.
+     *
+     *
+     */
+    readonly projectKey: string;
+    /**
+     *	Reference to the resource that triggered the notification.
+     *
+     *
+     */
+    readonly resource: Reference;
+    /**
+     *	User-defined unique identifiers of the resource.
+     *
+     *
+     */
+    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
+    /**
+     *	Last seen version of the resource.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the resource was last modified.
+     *
+     *
+     */
+    readonly modifiedAt: string;
+}
+/**
+ *	This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is deleted.
+ *
+ */
+export interface ResourceDeletedDeliveryPayload extends IDeliveryPayload {
+    readonly notificationType: 'ResourceDeleted';
+    /**
+     *	`key` of the [Project](ctp:api:type:Project).
+     *	Useful for processing notifications if the Destination receives them from multiple Projects.
+     *
+     *
+     */
+    readonly projectKey: string;
+    /**
+     *	Reference to the resource that triggered the notification.
+     *
+     *
+     */
+    readonly resource: Reference;
+    /**
+     *	User-defined unique identifiers of the resource.
+     *
+     *
+     */
+    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
+    /**
+     *	Last seen version of the resource.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the resource was last deleted.
+     *
+     *
+     */
+    readonly modifiedAt: string;
+    /**
+     *	`true` if the `dataErasure` [parameter](/../api/gdpr#data-erasure-of-personal-data) on the `DELETE` request was set to `true`.
+     *
+     *
+     */
+    readonly dataErasure?: boolean;
+}
+/**
+ *	This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is updated. This includes updates by a background process, like a change in product availability.
+ *
+ */
+export interface ResourceUpdatedDeliveryPayload extends IDeliveryPayload {
+    readonly notificationType: 'ResourceUpdated';
+    /**
+     *	`key` of the [Project](ctp:api:type:Project).
+     *	Useful for processing notifications if the Destination receives them from multiple Projects.
+     *
+     *
+     */
+    readonly projectKey: string;
+    /**
+     *	Reference to the resource that triggered the notification.
+     *
+     *
+     */
+    readonly resource: Reference;
+    /**
+     *	User-defined unique identifiers of the resource.
+     *
+     *
+     */
+    readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
+    /**
+     *	Last seen version of the resource.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Version of the resource before the update.
+     *
+     *
+     */
+    readonly oldVersion: number;
+    /**
+     *	Date and time (UTC) the resource was last updated.
+     *
+     *
+     */
+    readonly modifiedAt: string;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Subscription](ctp:api:type:Subscription).
+ *
+ */
+export interface SubscriptionPagedQueryResponse {
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
     /**
      *	Number of [elements skipped](/../api/general-concepts#offset).
      *
@@ -842,7 +945,7 @@ export interface SubscriptionUpdate {
      */
     readonly actions: SubscriptionUpdateAction[];
 }
-export type SubscriptionUpdateAction = SubscriptionChangeDestinationAction | SubscriptionSetChangesAction | SubscriptionSetKeyAction | SubscriptionSetMessagesAction;
+export type SubscriptionUpdateAction = SubscriptionChangeDestinationAction | SubscriptionSetChangesAction | SubscriptionSetEventsAction | SubscriptionSetKeyAction | SubscriptionSetMessagesAction;
 export interface ISubscriptionUpdateAction {
     /**
      *
@@ -865,12 +968,21 @@ export interface SubscriptionChangeDestinationAction extends ISubscriptionUpdate
 export interface SubscriptionSetChangesAction extends ISubscriptionUpdateAction {
     readonly action: 'setChanges';
     /**
-     *	Value to set. Can only be unset if `messages` is set.
+     *	Value to set. Can only be unset if either `messages` or `events` is set.
      *
      *
      */
     readonly changes?: ChangeSubscription[];
 }
+export interface SubscriptionSetEventsAction extends ISubscriptionUpdateAction {
+    readonly action: 'setEvents';
+    /**
+     *	Value to set. Can only be unset if either `messages` or `changes` is set.
+     *
+     *
+     */
+    readonly messages?: EventSubscription[];
+}
 export interface SubscriptionSetKeyAction extends ISubscriptionUpdateAction {
     readonly action: 'setKey';
     /**
@@ -883,7 +995,7 @@ export interface SubscriptionSetKeyAction extends ISubscriptionUpdateAction {
 export interface SubscriptionSetMessagesAction extends ISubscriptionUpdateAction {
     readonly action: 'setMessages';
     /**
-     *	Value to set. Can only be unset if `changes` is set.
+     *	Value to set. Can only be unset if either `changes` or `events` is set.
      *
      *
      */