Constructor Detail

Method Detail

• body

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

  • companyContribution

  • description

  • frequency

  • type

• companyContribution

   final HrisBenefitCreateParams.Builder companyContribution(HrisBenefitCreateParams.BenefitCompanyMatchContribution companyContribution)

  The company match for this benefit.

• companyContribution

   final HrisBenefitCreateParams.Builder companyContribution(Optional<HrisBenefitCreateParams.BenefitCompanyMatchContribution> companyContribution)

  Alias for calling Builder.companyContribution with companyContribution.orElse(null).

• companyContribution

   final HrisBenefitCreateParams.Builder companyContribution(JsonField<HrisBenefitCreateParams.BenefitCompanyMatchContribution> companyContribution)

  Sets Builder.companyContribution to an arbitrary JSON value.

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

• description

   final HrisBenefitCreateParams.Builder description(String description)

  Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).

• description

   final HrisBenefitCreateParams.Builder description(JsonField<String> description)

  Sets Builder.description to an arbitrary JSON value.

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

• frequency

   final HrisBenefitCreateParams.Builder frequency(BenefitFrequency frequency)

  The frequency of the benefit deduction/contribution.

• frequency

   final HrisBenefitCreateParams.Builder frequency(Optional<BenefitFrequency> frequency)

  Alias for calling Builder.frequency with frequency.orElse(null).

• frequency

   final HrisBenefitCreateParams.Builder frequency(JsonField<BenefitFrequency> frequency)

  Sets Builder.frequency to an arbitrary JSON value.

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

• type

   final HrisBenefitCreateParams.Builder type(BenefitType type)

  Type of benefit.

• type

   final HrisBenefitCreateParams.Builder type(Optional<BenefitType> type)

  Alias for calling Builder.type with type.orElse(null).

• type

   final HrisBenefitCreateParams.Builder type(JsonField<BenefitType> type)

  Sets Builder.type to an arbitrary JSON value.

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final HrisBenefitCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final HrisBenefitCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final HrisBenefitCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final HrisBenefitCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final HrisBenefitCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final HrisBenefitCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final HrisBenefitCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final HrisBenefitCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final HrisBenefitCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final HrisBenefitCreateParams build()

  Returns an immutable instance of HrisBenefitCreateParams.

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