Constructor Detail

Method Detail

• expiresIn

   final AuthIssueTokenParams.Body.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.Body.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.Body.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.Body.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.

• additionalProperties

   final AuthIssueTokenParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final AuthIssueTokenParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final AuthIssueTokenParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final AuthIssueTokenParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final AuthIssueTokenParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final AuthIssueTokenParams.Body build()

  Returns an immutable instance of Body.

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

  The following fields are required:

  .expiresIn()
  .scope()