Constructor Detail

Method Detail

• body

   final OAuthTokenCreateParams.Builder body(OAuthTokenCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • grantType

  • clientId

  • clientSecret

  • code

  • productionToken

  • etc.

• grantType

   final OAuthTokenCreateParams.Builder grantType(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.

• grantType

   final OAuthTokenCreateParams.Builder grantType(JsonField<OAuthTokenCreateParams.GrantType> grantType)

  Sets Builder.grantType to an arbitrary JSON value.

  You should usually call Builder.grantType with a well-typed GrantType value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• clientId

   final OAuthTokenCreateParams.Builder clientId(String clientId)

  The public identifier for your application.

• clientId

   final OAuthTokenCreateParams.Builder clientId(JsonField<String> clientId)

  Sets Builder.clientId to an arbitrary JSON value.

  You should usually call Builder.clientId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• clientSecret

   final OAuthTokenCreateParams.Builder clientSecret(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.

• clientSecret

   final OAuthTokenCreateParams.Builder clientSecret(JsonField<String> clientSecret)

  Sets Builder.clientSecret to an arbitrary JSON value.

  You should usually call Builder.clientSecret with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• code

   final OAuthTokenCreateParams.Builder code(String code)

  The authorization code generated by the user and given to you as a query parameter.

• code

   final OAuthTokenCreateParams.Builder code(JsonField<String> code)

  Sets Builder.code to an arbitrary JSON value.

  You should usually call Builder.code with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• productionToken

   final OAuthTokenCreateParams.Builder productionToken(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.

• productionToken

   final OAuthTokenCreateParams.Builder productionToken(JsonField<String> productionToken)

  Sets Builder.productionToken to an arbitrary JSON value.

  You should usually call Builder.productionToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final OAuthTokenCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final OAuthTokenCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final OAuthTokenCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final OAuthTokenCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final OAuthTokenCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final OAuthTokenCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final OAuthTokenCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final OAuthTokenCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final OAuthTokenCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final OAuthTokenCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final OAuthTokenCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final OAuthTokenCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final OAuthTokenCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final OAuthTokenCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final OAuthTokenCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final OAuthTokenCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final OAuthTokenCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final OAuthTokenCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final OAuthTokenCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final OAuthTokenCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final OAuthTokenCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final OAuthTokenCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final OAuthTokenCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final OAuthTokenCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final OAuthTokenCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final OAuthTokenCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final OAuthTokenCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final OAuthTokenCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final OAuthTokenCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final OAuthTokenCreateParams build()

  Returns an immutable instance of OAuthTokenCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .grantType()