Package app.knock.api.models.objects
See: Description
-
Class Summary Class Description Builder A builder for InlineObjectRequest. InlineObjectRequest A custom /concepts/objects entity which belongs to a collection. Builder A builder for Object. Object A custom /concepts/objects entity which belongs to a collection. Builder A builder for ObjectAddSubscriptionsParams. Builder A builder for Body. Body A request to upsert subscriptions for a set of recipients. Builder A builder for Properties. Properties The custom properties associated with the subscription relationship. ObjectAddSubscriptionsParams Add subscriptions for an object. Builder A builder for ObjectDeleteParams. ObjectDeleteParams Permanently removes an object from the specified collection. Builder A builder for ObjectDeleteSubscriptionsParams. Builder A builder for Body. Body A request to delete subscriptions for a set of recipients. ObjectDeleteSubscriptionsParams Delete subscriptions for the specified recipients from an object. Builder A builder for ObjectGetChannelDataParams. ObjectGetChannelDataParams Returns the channel data for the specified object and channel. Builder A builder for ObjectGetParams. ObjectGetParams Retrieves a specific object by its ID from the specified collection. Builder A builder for ObjectGetPreferencesParams. ObjectGetPreferencesParams Returns the preference set for the specified object and preference set id.Builder A builder for ObjectListMessagesPage. AutoPager ObjectListMessagesPage Builder A builder for ObjectListMessagesPageAsync. AutoPager ObjectListMessagesPageAsync Builder A builder for ObjectListMessagesPageResponse. ObjectListMessagesPageResponse A paginated list of messages. Builder A builder for ObjectListMessagesParams. EngagementStatus Builder A builder for InsertedAt. InsertedAt Status ObjectListMessagesParams Returns a paginated list of messages for a specific object in the given collection. Builder A builder for ObjectListPage. AutoPager ObjectListPage Builder A builder for ObjectListPageAsync. AutoPager ObjectListPageAsync Builder A builder for ObjectListPageResponse. ObjectListPageResponse A paginated list of objects in a collection. Builder A builder for ObjectListParams. Include ObjectListParams Returns a paginated list of objects from the specified collection. Builder A builder for ObjectListPreferencesParams. ObjectListPreferencesParams Returns a paginated list of preference sets for the specified object. Builder A builder for ObjectListSchedulesPage. AutoPager ObjectListSchedulesPage Builder A builder for ObjectListSchedulesPageAsync. AutoPager ObjectListSchedulesPageAsync Builder A builder for ObjectListSchedulesPageResponse. ObjectListSchedulesPageResponse A response containing a list of schedules. Builder A builder for ObjectListSchedulesParams. ObjectListSchedulesParams Returns a paginated list of schedules for an object. Builder A builder for ObjectListSubscriptionsPage. AutoPager ObjectListSubscriptionsPage Builder A builder for ObjectListSubscriptionsPageAsync. AutoPager ObjectListSubscriptionsPageAsync Builder A builder for ObjectListSubscriptionsPageResponse. ObjectListSubscriptionsPageResponse A response containing a list of subscriptions. Builder A builder for ObjectListSubscriptionsParams. Include Mode Mode of the request. Builder A builder for Object. Object A reference to a recipient object. ObjectListSubscriptionsParams List subscriptions for an object. Builder A builder for ObjectSetChannelDataParams. ObjectSetChannelDataParams Sets the channel data for the specified object and channel. Builder A builder for ObjectSetParams. Builder A builder for Body. Body A set of parameters to set an object with. ObjectSetParams Creates a new object or updates an existing one in the specified collection. Builder A builder for ObjectSetPreferencesParams. ObjectSetPreferencesParams Sets preferences within the given preference set. Builder A builder for ObjectUnsetChannelDataParams. ObjectUnsetChannelDataParams Unsets the channel data for the specified object and channel. -
Enum Summary Enum Description Known An enum containing EngagementStatus's known values. Value An enum containing EngagementStatus's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Include's known values. Value An enum containing Include's known values, as well as an _UNKNOWN member. Known An enum containing Include's known values. Value An enum containing Include's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member.