Constructor Detail

Method Detail

• body

   final AuthIssueTokenParams.Builder body(AuthIssueTokenParams.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:

  • expiresIn

  • scope

• expiresIn

   final AuthIssueTokenParams.Builder expiresIn(String expiresIn)

  Duration for token expiration. Accepts various time formats:

  • "2 hours" - 2 hours from now

  • "1d" - 1 day

  • "3 days" - 3 days

  • "10h" - 10 hours

  • "2.5 hrs" - 2.5 hours

  • "1m" - 1 minute

  • "5s" - 5 seconds

  • "1y" - 1 year

• expiresIn

   final AuthIssueTokenParams.Builder expiresIn(JsonField<String> expiresIn)

  Sets Builder.expiresIn to an arbitrary JSON value.

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

• scope

   final AuthIssueTokenParams.Builder scope(String scope)

  Available scopes:

  • user_id:<user-id> - Defines which user the token will be scoped to. Multiple can be listed if needed. Ex user_id:pigeon user_id:bluebird.

  • read:messages - Read messages.

  • read:user-tokens - Read user push tokens.

  • write:user-tokens - Write user push tokens.

  • read:brands[:<brand_id>] - Read brands, optionally restricted to a specific brand_id. Examples read:brands, read:brands:my_brand.

  • write:brands[:<brand_id>] - Write brands, optionally restricted to a specific brand_id. Examples write:brands, write:brands:my_brand.

  • inbox:read:messages - Read inbox messages.

  • inbox:write:events - Write inbox events, such as mark message as read.

  • read:preferences - Read user preferences.

  • write:preferences - Write user preferences. Example: user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands

• scope

   final AuthIssueTokenParams.Builder scope(JsonField<String> scope)

  Sets Builder.scope to an arbitrary JSON value.

  You should usually call Builder.scope 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 AuthIssueTokenParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final AuthIssueTokenParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final AuthIssueTokenParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final AuthIssueTokenParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final AuthIssueTokenParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final AuthIssueTokenParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final AuthIssueTokenParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final AuthIssueTokenParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final AuthIssueTokenParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final AuthIssueTokenParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final AuthIssueTokenParams build()

  Returns an immutable instance of AuthIssueTokenParams.

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

  The following fields are required:

  .expiresIn()
  .scope()