CatalogListParams

All Implemented Interfaces:

com.courier.core.Params
```
public final class CatalogListParams
 implements Params
                    
```
Returns the catalog of available provider types with their display names, descriptions, and configuration schema fields (snake_case, with type and required). Providers with no configurable schema return only provider, name, and description.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CatalogListParams.Builder`	A builder for CatalogListParams.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`channel()`	Exact match (case-insensitive) against the provider channel taxonomy (e.g.
`final Optional<String>`	`keys()`	Comma-separated provider keys to filter by (e.g.
`final Optional<String>`	`name()`	Case-insensitive substring match against the provider display name.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final CatalogListParams.Builder`	`toBuilder()`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CatalogListParams`	`none()`
`final static CatalogListParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of CatalogListParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - channel
```
 final Optional<String> channel()
```
    Exact match (case-insensitive) against the provider channel taxonomy (e.g. email, sms, push).
  - keys
```
 final Optional<String> keys()
```
    Comma-separated provider keys to filter by (e.g. sendgrid,twilio).
  - name
```
 final Optional<String> name()
```
    Case-insensitive substring match against the provider display name.
  - _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 CatalogListParams.Builder toBuilder()
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static CatalogListParams none()
```
  - builder
```
 final static CatalogListParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of CatalogListParams.