All Implemented Interfaces:: com.increase.api.core.Params


public final class OAuthTokenCreateParams
 implements Params

Create an OAuth Token

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`OAuthTokenCreateParams.Builder`	A builder for OAuthTokenCreateParams.
`public final class`	`OAuthTokenCreateParams.Body`
`public final class`	`OAuthTokenCreateParams.GrantType`	The credential you request in exchange for the code. In Production, this is always `authorization_code`. In Sandbox, you can pass either enum value.

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 OAuthTokenCreateParams.GrantType`	`grantType()`	The credential you request in exchange for the code.
`final Optional<String>`	`clientId()`	The public identifier for your application.
`final Optional<String>`	`clientSecret()`	The secret that confirms you own the application.
`final Optional<String>`	`code()`	The authorization code generated by the user and given to you as a query parameter.
`final Optional<String>`	`productionToken()`	The production token you want to exchange for a sandbox token.
`final JsonField<OAuthTokenCreateParams.GrantType>`	`_grantType()`	Returns the raw JSON value of grantType.
`final JsonField<String>`	`_clientId()`	Returns the raw JSON value of clientId.
`final JsonField<String>`	`_clientSecret()`	Returns the raw JSON value of clientSecret.
`final JsonField<String>`	`_code()`	Returns the raw JSON value of code.
`final JsonField<String>`	`_productionToken()`	Returns the raw JSON value of productionToken.
`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 OAuthTokenCreateParams.Builder`	`toBuilder()`
`final OAuthTokenCreateParams.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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static OAuthTokenCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of OAuthTokenCreateParams.

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

- Constructor Detail
- Method Detail
  - grantType
```
 final OAuthTokenCreateParams.GrantType grantType()
```
    The credential you request in exchange for the code. In Production, this is always authorization_code. In Sandbox, you can pass either enum value.
  - clientId
```
 final Optional<String> clientId()
```
    The public identifier for your application.
  - clientSecret
```
 final Optional<String> clientSecret()
```
    The secret that confirms you own the application. This is redundant given that the request is made with your API key but it's a required component of OAuth 2.0.
  - code
```
 final Optional<String> code()
```
    The authorization code generated by the user and given to you as a query parameter.
  - productionToken
```
 final Optional<String> productionToken()
```
    The production token you want to exchange for a sandbox token. This is only available in Sandbox. Set grant_type to production_token to use this parameter.
  - _grantType
```
 final JsonField<OAuthTokenCreateParams.GrantType> _grantType()
```
    Returns the raw JSON value of grantType.
    Unlike grantType, this method doesn't throw if the JSON field has an unexpected type.
  - _clientId
```
 final JsonField<String> _clientId()
```
    Returns the raw JSON value of clientId.
    Unlike clientId, this method doesn't throw if the JSON field has an unexpected type.
  - _clientSecret
```
 final JsonField<String> _clientSecret()
```
    Returns the raw JSON value of clientSecret.
    Unlike clientSecret, this method doesn't throw if the JSON field has an unexpected type.
  - _code
```
 final JsonField<String> _code()
```
    Returns the raw JSON value of code.
    Unlike code, this method doesn't throw if the JSON field has an unexpected type.
  - _productionToken
```
 final JsonField<String> _productionToken()
```
    Returns the raw JSON value of productionToken.
    Unlike productionToken, 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 OAuthTokenCreateParams.Builder toBuilder()
```
  - _body
```
 final OAuthTokenCreateParams.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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static OAuthTokenCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of OAuthTokenCreateParams.
    The following fields are required:
    .grantType()

Class OAuthTokenCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

grantType

clientId

clientSecret

code

productionToken

_grantType

_clientId

_clientSecret

_code

_productionToken

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder