Class ProviderCreateParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class ProviderCreateParams implements Params
Create a new provider configuration. The
providerfield must be a known Courier provider key (see catalog).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classProviderCreateParams.BuilderA builder for ProviderCreateParams.
public final classProviderCreateParams.BodyRequest body for creating a new provider configuration.
public final classProviderCreateParams.SettingsProvider-specific settings (snake_case keys). Defaults to an empty object when omitted. Use the catalog endpoint to discover required fields for a given provider — omitting a required field returns a 400 validation error.
-
Method Summary
Modifier and Type Method Description final Stringprovider()The provider key identifying the type (e.g. final Optional<String>alias()Optional alias for this configuration. final Optional<ProviderCreateParams.Settings>settings()Provider-specific settings (snake_case keys). final Optional<String>title()Optional display title. final JsonField<String>_provider()Returns the raw JSON value of provider. final JsonField<String>_alias()Returns the raw JSON value of alias. final JsonField<ProviderCreateParams.Settings>_settings()Returns the raw JSON value of settings. final JsonField<String>_title()Returns the raw JSON value of title. 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 ProviderCreateParams.BuildertoBuilder()final ProviderCreateParams.Body_body()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 ProviderCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ProviderCreateParams. -
-
Method Detail
-
provider
final String provider()
The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a known Courier provider — see the catalog endpoint for valid keys.
-
settings
final Optional<ProviderCreateParams.Settings> settings()
Provider-specific settings (snake_case keys). Defaults to an empty object when omitted. Use the catalog endpoint to discover required fields for a given provider — omitting a required field returns a 400 validation error.
-
_provider
final JsonField<String> _provider()
Returns the raw JSON value of provider.
Unlike provider, this method doesn't throw if the JSON field has an unexpected type.
-
_alias
final JsonField<String> _alias()
Returns the raw JSON value of alias.
Unlike alias, this method doesn't throw if the JSON field has an unexpected type.
-
_settings
final JsonField<ProviderCreateParams.Settings> _settings()
Returns the raw JSON value of settings.
Unlike settings, this method doesn't throw if the JSON field has an unexpected type.
-
_title
final JsonField<String> _title()
Returns the raw JSON value of title.
Unlike title, 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 ProviderCreateParams.Builder toBuilder()
-
_body
final ProviderCreateParams.Body _body()
-
_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 ProviderCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of ProviderCreateParams.
The following fields are required:
.provider()
-
-
-
-