Package com.courier.models.bulk
Class BulkAddUsersParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class BulkAddUsersParams implements Params
Ingest user data into a Bulk Job.
Important: For email-based bulk jobs, each user must include
profile.emailfor provider routing to work correctly. Theto.emailfield is not sufficient for email provider routing.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBulkAddUsersParams.BuilderA builder for BulkAddUsersParams.
public final classBulkAddUsersParams.Body
-
Method Summary
Modifier and Type Method Description final Optional<String>jobId()final List<InboundBulkMessageUser>users()final JsonField<List<InboundBulkMessageUser>>_users()Returns the raw JSON value of users. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final BulkAddUsersParams.BuildertoBuilder()final BulkAddUsersParams.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 BulkAddUsersParams.Builderbuilder()Returns a mutable builder for constructing an instance of BulkAddUsersParams. -
-
Method Detail
-
users
final List<InboundBulkMessageUser> users()
-
_users
final JsonField<List<InboundBulkMessageUser>> _users()
Returns the raw JSON value of users.
Unlike users, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final BulkAddUsersParams.Builder toBuilder()
-
_body
final BulkAddUsersParams.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 BulkAddUsersParams.Builder builder()
Returns a mutable builder for constructing an instance of BulkAddUsersParams.
The following fields are required:
.users()
-
-
-
-