Package app.knock.api.models.objects
Class ObjectDeleteSubscriptionsParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class ObjectDeleteSubscriptionsParams implements Params
Delete subscriptions for the specified recipients from an object. Returns the list of deleted subscriptions.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classObjectDeleteSubscriptionsParams.BuilderA builder for ObjectDeleteSubscriptionsParams.
public final classObjectDeleteSubscriptionsParams.BodyA request to delete subscriptions for a set of recipients.
-
Method Summary
Modifier and Type Method Description final Optional<String>collection()final Optional<String>objectId()final List<RecipientReference>recipients()The recipients of the subscription. final JsonField<List<RecipientReference>>_recipients()Returns the raw JSON value of recipients. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ObjectDeleteSubscriptionsParams.BuildertoBuilder()final ObjectDeleteSubscriptionsParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ObjectDeleteSubscriptionsParams.Builderbuilder()Returns a mutable builder for constructing an instance of ObjectDeleteSubscriptionsParams. -
-
Method Detail
-
collection
final Optional<String> collection()
-
recipients
final List<RecipientReference> recipients()
The recipients of the subscription. You can subscribe up to 100 recipients to an object at a time.
-
_recipients
final JsonField<List<RecipientReference>> _recipients()
Returns the raw JSON value of recipients.
Unlike recipients, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ObjectDeleteSubscriptionsParams.Builder toBuilder()
-
_body
final ObjectDeleteSubscriptionsParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static ObjectDeleteSubscriptionsParams.Builder builder()
Returns a mutable builder for constructing an instance of ObjectDeleteSubscriptionsParams.
The following fields are required:
.recipients()
-
-
-
-