Package com.adyen.service.management

Class SplitConfigurationMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.SplitConfigurationMerchantLevelApi

public class SplitConfigurationMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
SplitConfigurationMerchantLevelApi(Client client)	Split configuration - merchant level constructor in package.
SplitConfigurationMerchantLevelApi(Client client, String baseURL)	Split configuration - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
SplitConfiguration	createRule(String merchantId, String splitConfigurationId, SplitConfigurationRule splitConfigurationRule)	Create a rule
SplitConfiguration	createRule(String merchantId, String splitConfigurationId, SplitConfigurationRule splitConfigurationRule, RequestOptions requestOptions)	Create a rule
SplitConfiguration	createSplitConfiguration(String merchantId, SplitConfiguration splitConfiguration)	Create a split configuration
SplitConfiguration	createSplitConfiguration(String merchantId, SplitConfiguration splitConfiguration, RequestOptions requestOptions)	Create a split configuration
SplitConfiguration	deleteSplitConfiguration(String merchantId, String splitConfigurationId)	Delete a split configuration
SplitConfiguration	deleteSplitConfiguration(String merchantId, String splitConfigurationId, RequestOptions requestOptions)	Delete a split configuration
SplitConfiguration	deleteSplitConfigurationRule(String merchantId, String splitConfigurationId, String ruleId)	Delete a split configuration rule
SplitConfiguration	deleteSplitConfigurationRule(String merchantId, String splitConfigurationId, String ruleId, RequestOptions requestOptions)	Delete a split configuration rule
SplitConfiguration	getSplitConfiguration(String merchantId, String splitConfigurationId)	Get a split configuration
SplitConfiguration	getSplitConfiguration(String merchantId, String splitConfigurationId, RequestOptions requestOptions)	Get a split configuration
SplitConfigurationList	listSplitConfigurations(String merchantId)	Get a list of split configurations
SplitConfigurationList	listSplitConfigurations(String merchantId, RequestOptions requestOptions)	Get a list of split configurations
SplitConfiguration	updateSplitConditions(String merchantId, String splitConfigurationId, String ruleId, UpdateSplitConfigurationRuleRequest updateSplitConfigurationRuleRequest)	Update split conditions
SplitConfiguration	updateSplitConditions(String merchantId, String splitConfigurationId, String ruleId, UpdateSplitConfigurationRuleRequest updateSplitConfigurationRuleRequest, RequestOptions requestOptions)	Update split conditions
SplitConfiguration	updateSplitConfigurationDescription(String merchantId, String splitConfigurationId, UpdateSplitConfigurationRequest updateSplitConfigurationRequest)	Update split configuration description
SplitConfiguration	updateSplitConfigurationDescription(String merchantId, String splitConfigurationId, UpdateSplitConfigurationRequest updateSplitConfigurationRequest, RequestOptions requestOptions)	Update split configuration description
SplitConfiguration	updateSplitLogic(String merchantId, String splitConfigurationId, String ruleId, String splitLogicId, UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest)	Update the split logic
SplitConfiguration	updateSplitLogic(String merchantId, String splitConfigurationId, String ruleId, String splitLogicId, UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest, RequestOptions requestOptions)	Update the split logic

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

SplitConfigurationMerchantLevelApi

public SplitConfigurationMerchantLevelApi(Client client)

Split configuration - merchant level constructor in package.

Parameters:

client - Client (required)

SplitConfigurationMerchantLevelApi

public SplitConfigurationMerchantLevelApi(Client client,
                                          String baseURL)

Split configuration - merchant level constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

createRule

public SplitConfiguration createRule(String merchantId,
                                     String splitConfigurationId,
                                     SplitConfigurationRule splitConfigurationRule)
                              throws ApiException,
                                     IOException

Create a rule

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

splitConfigurationRule - SplitConfigurationRule (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

createRule

public SplitConfiguration createRule(String merchantId,
                                     String splitConfigurationId,
                                     SplitConfigurationRule splitConfigurationRule,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Create a rule

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

splitConfigurationRule - SplitConfigurationRule (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

createSplitConfiguration

public SplitConfiguration createSplitConfiguration(String merchantId,
                                                   SplitConfiguration splitConfiguration)
                                            throws ApiException,
                                                   IOException

Create a split configuration

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfiguration - SplitConfiguration (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

createSplitConfiguration

public SplitConfiguration createSplitConfiguration(String merchantId,
                                                   SplitConfiguration splitConfiguration,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Create a split configuration

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfiguration - SplitConfiguration (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

deleteSplitConfiguration

public SplitConfiguration deleteSplitConfiguration(String merchantId,
                                                   String splitConfigurationId)
                                            throws ApiException,
                                                   IOException

Delete a split configuration

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

deleteSplitConfiguration

public SplitConfiguration deleteSplitConfiguration(String merchantId,
                                                   String splitConfigurationId,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Delete a split configuration

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

deleteSplitConfigurationRule

public SplitConfiguration deleteSplitConfigurationRule(String merchantId,
                                                       String splitConfigurationId,
                                                       String ruleId)
                                                throws ApiException,
                                                       IOException

Delete a split configuration rule

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

ruleId - String (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

deleteSplitConfigurationRule

public SplitConfiguration deleteSplitConfigurationRule(String merchantId,
                                                       String splitConfigurationId,
                                                       String ruleId,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Delete a split configuration rule

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

ruleId - String (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

getSplitConfiguration

public SplitConfiguration getSplitConfiguration(String merchantId,
                                                String splitConfigurationId)
                                         throws ApiException,
                                                IOException

Get a split configuration

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

getSplitConfiguration

public SplitConfiguration getSplitConfiguration(String merchantId,
                                                String splitConfigurationId,
                                                RequestOptions requestOptions)
                                         throws ApiException,
                                                IOException

Get a split configuration

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

listSplitConfigurations

public SplitConfigurationList listSplitConfigurations(String merchantId)
                                               throws ApiException,
                                                      IOException

Get a list of split configurations

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

SplitConfigurationList

Throws:

ApiException - if fails to make API call

IOException

listSplitConfigurations

public SplitConfigurationList listSplitConfigurations(String merchantId,
                                                      RequestOptions requestOptions)
                                               throws ApiException,
                                                      IOException

Get a list of split configurations

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfigurationList

Throws:

ApiException - if fails to make API call

IOException

updateSplitConditions

public SplitConfiguration updateSplitConditions(String merchantId,
                                                String splitConfigurationId,
                                                String ruleId,
                                                UpdateSplitConfigurationRuleRequest updateSplitConfigurationRuleRequest)
                                         throws ApiException,
                                                IOException

Update split conditions

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The identifier of the split configuration. (required)

ruleId - String The unique identifier of the split configuration rule. (required)

updateSplitConfigurationRuleRequest - UpdateSplitConfigurationRuleRequest (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

updateSplitConditions

public SplitConfiguration updateSplitConditions(String merchantId,
                                                String splitConfigurationId,
                                                String ruleId,
                                                UpdateSplitConfigurationRuleRequest updateSplitConfigurationRuleRequest,
                                                RequestOptions requestOptions)
                                         throws ApiException,
                                                IOException

Update split conditions

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The identifier of the split configuration. (required)

ruleId - String The unique identifier of the split configuration rule. (required)

updateSplitConfigurationRuleRequest - UpdateSplitConfigurationRuleRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

updateSplitConfigurationDescription

public SplitConfiguration updateSplitConfigurationDescription(String merchantId,
                                                              String splitConfigurationId,
                                                              UpdateSplitConfigurationRequest updateSplitConfigurationRequest)
                                                       throws ApiException,
                                                              IOException

Update split configuration description

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

updateSplitConfigurationRequest - UpdateSplitConfigurationRequest (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

updateSplitConfigurationDescription

public SplitConfiguration updateSplitConfigurationDescription(String merchantId,
                                                              String splitConfigurationId,
                                                              UpdateSplitConfigurationRequest updateSplitConfigurationRequest,
                                                              RequestOptions requestOptions)
                                                       throws ApiException,
                                                              IOException

Update split configuration description

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

updateSplitConfigurationRequest - UpdateSplitConfigurationRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

updateSplitLogic

public SplitConfiguration updateSplitLogic(String merchantId,
                                           String splitConfigurationId,
                                           String ruleId,
                                           String splitLogicId,
                                           UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest)
                                    throws ApiException,
                                           IOException

Update the split logic

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

ruleId - String The unique identifier of the split configuration rule. (required)

splitLogicId - String The unique identifier of the split configuration split. (required)

updateSplitConfigurationLogicRequest - UpdateSplitConfigurationLogicRequest (required)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException

updateSplitLogic

public SplitConfiguration updateSplitLogic(String merchantId,
                                           String splitConfigurationId,
                                           String ruleId,
                                           String splitLogicId,
                                           UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Update the split logic

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

splitConfigurationId - String The unique identifier of the split configuration. (required)

ruleId - String The unique identifier of the split configuration rule. (required)

splitLogicId - String The unique identifier of the split configuration split. (required)

updateSplitConfigurationLogicRequest - UpdateSplitConfigurationLogicRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

SplitConfiguration

Throws:

ApiException - if fails to make API call

IOException