Class ProviderCreateParams.Body
-
- All Implemented Interfaces:
public final class ProviderCreateParams.BodyRequest body for creating a new provider configuration.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classProviderCreateParams.Body.BuilderA builder for Body.
-
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>_additionalProperties()final ProviderCreateParams.Body.BuildertoBuilder()final ProviderCreateParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ProviderCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ProviderCreateParams.Body.Builder toBuilder()
-
validate
final ProviderCreateParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static ProviderCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.provider()
-
-
-
-