Package com.merge.api.resources.hris.types

Class AccountIntegration.Builder

java.lang.Object

com.merge.api.resources.hris.types.AccountIntegration.Builder

All Implemented Interfaces:

AccountIntegration._FinalStage, AccountIntegration.NameStage

Enclosing class:

AccountIntegration

public static final class AccountIntegration.Builder
extends java.lang.Object
implements AccountIntegration.NameStage, AccountIntegration._FinalStage

Method Summary

Modifier and Type	Method	Description
AccountIntegration._FinalStage	abbreviatedName(java.lang.String abbreviatedName)	Optional.
AccountIntegration._FinalStage	abbreviatedName(java.util.Optional<java.lang.String> abbreviatedName)
AccountIntegration._FinalStage	apiEndpointsToDocumentationUrls(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> apiEndpointsToDocumentationUrls)	Mapping of API endpoints to documentation urls for support.
AccountIntegration._FinalStage	apiEndpointsToDocumentationUrls(java.util.Optional<java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>> apiEndpointsToDocumentationUrls)
AccountIntegration	build()
AccountIntegration._FinalStage	categories(java.util.List<CategoriesEnum> categories)	Category or categories this integration belongs to.
AccountIntegration._FinalStage	categories(java.util.Optional<java.util.List<CategoriesEnum>> categories)
AccountIntegration._FinalStage	categoryBetaStatus(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> categoryBetaStatus)	Category or categories this integration is in beta status for.
AccountIntegration._FinalStage	categoryBetaStatus(java.util.Optional<java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>> categoryBetaStatus)
AccountIntegration._FinalStage	color(java.lang.String color)	The color of this integration used for buttons and text throughout the app and landing pages.
AccountIntegration._FinalStage	color(java.util.Optional<java.lang.String> color)
AccountIntegration.Builder	from(AccountIntegration other)
AccountIntegration._FinalStage	image(java.lang.String image)	Company logo in rectangular shape.
AccountIntegration._FinalStage	image(java.util.Optional<java.lang.String> image)
AccountIntegration._FinalStage	name(java.lang.String name)	Company name.
AccountIntegration._FinalStage	slug(java.lang.String slug)
AccountIntegration._FinalStage	slug(java.util.Optional<java.lang.String> slug)
AccountIntegration._FinalStage	squareImage(java.lang.String squareImage)	Company logo in square shape.
AccountIntegration._FinalStage	squareImage(java.util.Optional<java.lang.String> squareImage)
AccountIntegration._FinalStage	webhookSetupGuideUrl(java.lang.String webhookSetupGuideUrl)	Setup guide URL for third party webhook creation.
AccountIntegration._FinalStage	webhookSetupGuideUrl(java.util.Optional<java.lang.String> webhookSetupGuideUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public AccountIntegration.Builder from(AccountIntegration other)

Specified by:

from in interface AccountIntegration.NameStage

name

public AccountIntegration._FinalStage name(java.lang.String name)

Company name.

Specified by:

name in interface AccountIntegration.NameStage

Returns:

Reference to this so that method calls can be chained together.

categoryBetaStatus

public AccountIntegration._FinalStage categoryBetaStatus(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> categoryBetaStatus)

Category or categories this integration is in beta status for.

Specified by:

categoryBetaStatus in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

categoryBetaStatus

public AccountIntegration._FinalStage categoryBetaStatus(java.util.Optional<java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>> categoryBetaStatus)

Specified by:

categoryBetaStatus in interface AccountIntegration._FinalStage

webhookSetupGuideUrl

public AccountIntegration._FinalStage webhookSetupGuideUrl(java.lang.String webhookSetupGuideUrl)

Setup guide URL for third party webhook creation. Exposed in Merge Docs.

Specified by:

webhookSetupGuideUrl in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

webhookSetupGuideUrl

public AccountIntegration._FinalStage webhookSetupGuideUrl(java.util.Optional<java.lang.String> webhookSetupGuideUrl)

Specified by:

webhookSetupGuideUrl in interface AccountIntegration._FinalStage

apiEndpointsToDocumentationUrls

public AccountIntegration._FinalStage apiEndpointsToDocumentationUrls(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> apiEndpointsToDocumentationUrls)

Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}

Specified by:

apiEndpointsToDocumentationUrls in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

apiEndpointsToDocumentationUrls

public AccountIntegration._FinalStage apiEndpointsToDocumentationUrls(java.util.Optional<java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>> apiEndpointsToDocumentationUrls)

Specified by:

apiEndpointsToDocumentationUrls in interface AccountIntegration._FinalStage

slug

public AccountIntegration._FinalStage slug(java.lang.String slug)

Specified by:

slug in interface AccountIntegration._FinalStage

slug

public AccountIntegration._FinalStage slug(java.util.Optional<java.lang.String> slug)

Specified by:

slug in interface AccountIntegration._FinalStage

color

public AccountIntegration._FinalStage color(java.lang.String color)

The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b>

Specified by:

color in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

color

public AccountIntegration._FinalStage color(java.util.Optional<java.lang.String> color)

Specified by:

color in interface AccountIntegration._FinalStage

squareImage

public AccountIntegration._FinalStage squareImage(java.lang.String squareImage)

Company logo in square shape.

Specified by:

squareImage in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

squareImage

public AccountIntegration._FinalStage squareImage(java.util.Optional<java.lang.String> squareImage)

Specified by:

squareImage in interface AccountIntegration._FinalStage

image

public AccountIntegration._FinalStage image(java.lang.String image)

Company logo in rectangular shape.

Specified by:

image in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

image

public AccountIntegration._FinalStage image(java.util.Optional<java.lang.String> image)

Specified by:

image in interface AccountIntegration._FinalStage

categories

public AccountIntegration._FinalStage categories(java.util.List<CategoriesEnum> categories)

Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].

Specified by:

categories in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

categories

public AccountIntegration._FinalStage categories(java.util.Optional<java.util.List<CategoriesEnum>> categories)

Specified by:

categories in interface AccountIntegration._FinalStage

abbreviatedName

public AccountIntegration._FinalStage abbreviatedName(java.lang.String abbreviatedName)

Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).<br><br>Example: <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)</i>

Specified by:

abbreviatedName in interface AccountIntegration._FinalStage

Returns:

Reference to this so that method calls can be chained together.

abbreviatedName

public AccountIntegration._FinalStage abbreviatedName(java.util.Optional<java.lang.String> abbreviatedName)

Specified by:

abbreviatedName in interface AccountIntegration._FinalStage

build

public AccountIntegration build()

Specified by:

build in interface AccountIntegration._FinalStage