Constructor Detail

Method Detail

• individualId

   final SandboxEmploymentUpdateParams.Builder individualId(String individualId)

• body

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

  • classCode

  • customFields

  • department

  • employment

  • employmentStatus

  • etc.

• classCode

   final SandboxEmploymentUpdateParams.Builder classCode(String classCode)

  Worker's compensation classification code for this employee

• classCode

   final SandboxEmploymentUpdateParams.Builder classCode(Optional<String> classCode)

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

• classCode

   final SandboxEmploymentUpdateParams.Builder classCode(JsonField<String> classCode)

  Sets Builder.classCode to an arbitrary JSON value.

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

• customFields

   final SandboxEmploymentUpdateParams.Builder customFields(List<SandboxEmploymentUpdateParams.CustomField> customFields)

  Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.

• customFields

   final SandboxEmploymentUpdateParams.Builder customFields(JsonField<List<SandboxEmploymentUpdateParams.CustomField>> customFields)

  Sets Builder.customFields to an arbitrary JSON value.

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

• addCustomField

   final SandboxEmploymentUpdateParams.Builder addCustomField(SandboxEmploymentUpdateParams.CustomField customField)

  Adds a single CustomField to customFields.

• department

   final SandboxEmploymentUpdateParams.Builder department(SandboxEmploymentUpdateParams.Department department)

  The department object.

• department

   final SandboxEmploymentUpdateParams.Builder department(Optional<SandboxEmploymentUpdateParams.Department> department)

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

• department

   final SandboxEmploymentUpdateParams.Builder department(JsonField<SandboxEmploymentUpdateParams.Department> department)

  Sets Builder.department to an arbitrary JSON value.

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

• employment

   final SandboxEmploymentUpdateParams.Builder employment(SandboxEmploymentUpdateParams.Employment employment)

  The employment object.

• employment

   final SandboxEmploymentUpdateParams.Builder employment(Optional<SandboxEmploymentUpdateParams.Employment> employment)

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

• employment

   final SandboxEmploymentUpdateParams.Builder employment(JsonField<SandboxEmploymentUpdateParams.Employment> employment)

  Sets Builder.employment to an arbitrary JSON value.

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

• employmentStatus

   final SandboxEmploymentUpdateParams.Builder employmentStatus(SandboxEmploymentUpdateParams.EmploymentStatus employmentStatus)

  The detailed employment status of the individual.

• employmentStatus

   final SandboxEmploymentUpdateParams.Builder employmentStatus(Optional<SandboxEmploymentUpdateParams.EmploymentStatus> employmentStatus)

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

• employmentStatus

   final SandboxEmploymentUpdateParams.Builder employmentStatus(JsonField<SandboxEmploymentUpdateParams.EmploymentStatus> employmentStatus)

  Sets Builder.employmentStatus to an arbitrary JSON value.

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

• endDate

   final SandboxEmploymentUpdateParams.Builder endDate(String endDate)

• endDate

   final SandboxEmploymentUpdateParams.Builder endDate(Optional<String> endDate)

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

• endDate

   final SandboxEmploymentUpdateParams.Builder endDate(JsonField<String> endDate)

  Sets Builder.endDate to an arbitrary JSON value.

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

• firstName

   final SandboxEmploymentUpdateParams.Builder firstName(String firstName)

  The legal first name of the individual.

• firstName

   final SandboxEmploymentUpdateParams.Builder firstName(Optional<String> firstName)

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

• firstName

   final SandboxEmploymentUpdateParams.Builder firstName(JsonField<String> firstName)

  Sets Builder.firstName to an arbitrary JSON value.

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

• income

   final SandboxEmploymentUpdateParams.Builder income(Income income)

  The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.

• income

   final SandboxEmploymentUpdateParams.Builder income(Optional<Income> income)

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

• income

   final SandboxEmploymentUpdateParams.Builder income(JsonField<Income> income)

  Sets Builder.income to an arbitrary JSON value.

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

• incomeHistory

   final SandboxEmploymentUpdateParams.Builder incomeHistory(List<Income> incomeHistory)

  The array of income history.

• incomeHistory

   final SandboxEmploymentUpdateParams.Builder incomeHistory(Optional<List<Income>> incomeHistory)

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

• incomeHistory

   final SandboxEmploymentUpdateParams.Builder incomeHistory(JsonField<List<Income>> incomeHistory)

  Sets Builder.incomeHistory to an arbitrary JSON value.

  You should usually call Builder.incomeHistory with a well-typed List<Income?> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addIncomeHistory

   final SandboxEmploymentUpdateParams.Builder addIncomeHistory(Income incomeHistory)

  Adds a single Income to Builder.incomeHistory.

• isActive

   final SandboxEmploymentUpdateParams.Builder isActive(Boolean isActive)

  true if the individual an an active employee or contractor at the company.

• isActive

   final SandboxEmploymentUpdateParams.Builder isActive(Boolean isActive)

  Alias for Builder.isActive.

  This unboxed primitive overload exists for backwards compatibility.

• isActive

   final SandboxEmploymentUpdateParams.Builder isActive(Optional<Boolean> isActive)

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

• isActive

   final SandboxEmploymentUpdateParams.Builder isActive(JsonField<Boolean> isActive)

  Sets Builder.isActive to an arbitrary JSON value.

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

• lastName

   final SandboxEmploymentUpdateParams.Builder lastName(String lastName)

  The legal last name of the individual.

• lastName

   final SandboxEmploymentUpdateParams.Builder lastName(Optional<String> lastName)

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

• lastName

   final SandboxEmploymentUpdateParams.Builder lastName(JsonField<String> lastName)

  Sets Builder.lastName to an arbitrary JSON value.

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

• latestRehireDate

   final SandboxEmploymentUpdateParams.Builder latestRehireDate(String latestRehireDate)

• latestRehireDate

   final SandboxEmploymentUpdateParams.Builder latestRehireDate(Optional<String> latestRehireDate)

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

• latestRehireDate

   final SandboxEmploymentUpdateParams.Builder latestRehireDate(JsonField<String> latestRehireDate)

  Sets Builder.latestRehireDate to an arbitrary JSON value.

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

• location

   final SandboxEmploymentUpdateParams.Builder location(Location location)

• location

   final SandboxEmploymentUpdateParams.Builder location(Optional<Location> location)

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

• location

   final SandboxEmploymentUpdateParams.Builder location(JsonField<Location> location)

  Sets Builder.location to an arbitrary JSON value.

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

• manager

   final SandboxEmploymentUpdateParams.Builder manager(SandboxEmploymentUpdateParams.Manager manager)

  The manager object representing the manager of the individual within the org.

• manager

   final SandboxEmploymentUpdateParams.Builder manager(Optional<SandboxEmploymentUpdateParams.Manager> manager)

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

• manager

   final SandboxEmploymentUpdateParams.Builder manager(JsonField<SandboxEmploymentUpdateParams.Manager> manager)

  Sets Builder.manager to an arbitrary JSON value.

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

• middleName

   final SandboxEmploymentUpdateParams.Builder middleName(String middleName)

  The legal middle name of the individual.

• middleName

   final SandboxEmploymentUpdateParams.Builder middleName(Optional<String> middleName)

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

• middleName

   final SandboxEmploymentUpdateParams.Builder middleName(JsonField<String> middleName)

  Sets Builder.middleName to an arbitrary JSON value.

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

• sourceId

   final SandboxEmploymentUpdateParams.Builder sourceId(String sourceId)

  The source system's unique employment identifier for this individual

• sourceId

   final SandboxEmploymentUpdateParams.Builder sourceId(JsonField<String> sourceId)

  Sets Builder.sourceId to an arbitrary JSON value.

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

• startDate

   final SandboxEmploymentUpdateParams.Builder startDate(String startDate)

• startDate

   final SandboxEmploymentUpdateParams.Builder startDate(Optional<String> startDate)

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

• startDate

   final SandboxEmploymentUpdateParams.Builder startDate(JsonField<String> startDate)

  Sets Builder.startDate to an arbitrary JSON value.

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

• title

   final SandboxEmploymentUpdateParams.Builder title(String title)

  The current title of the individual.

• title

   final SandboxEmploymentUpdateParams.Builder title(Optional<String> title)

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

• title

   final SandboxEmploymentUpdateParams.Builder title(JsonField<String> title)

  Sets Builder.title to an arbitrary JSON value.

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final SandboxEmploymentUpdateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final SandboxEmploymentUpdateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final SandboxEmploymentUpdateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final SandboxEmploymentUpdateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final SandboxEmploymentUpdateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final SandboxEmploymentUpdateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final SandboxEmploymentUpdateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final SandboxEmploymentUpdateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final SandboxEmploymentUpdateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final SandboxEmploymentUpdateParams build()

  Returns an immutable instance of SandboxEmploymentUpdateParams.

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

  The following fields are required:

  .individualId()