Package com.adyen.service.management

Class AccountStoreLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.AccountStoreLevelApi

public class AccountStoreLevelApi
extends Service

Field Summary

Fields inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
AccountStoreLevelApi(Client client)

Method Summary

Modifier and Type	Method	Description
Store	createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest)	Create a store
Store	createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest, RequestOptions requestOptions)	Create a store
Store	createStoreByMerchantId(String merchantId, StoreCreationRequest storeCreationRequest)	Create a store
Store	createStoreByMerchantId(String merchantId, StoreCreationRequest storeCreationRequest, RequestOptions requestOptions)	Create a store
Store	getStore(String merchantId, String storeId)	Get a store
Store	getStore(String merchantId, String storeId, RequestOptions requestOptions)	Get a store
Store	getStoreById(String storeId)	Get a store
Store	getStoreById(String storeId, RequestOptions requestOptions)	Get a store
ListStoresResponse	listStores()	Get a list of stores
ListStoresResponse	listStores(Integer pageNumber, Integer pageSize, String reference, String merchantId, RequestOptions requestOptions)	Get a list of stores
ListStoresResponse	listStoresByMerchantId(String merchantId)	Get a list of stores
ListStoresResponse	listStoresByMerchantId(String merchantId, Integer pageNumber, Integer pageSize, String reference, RequestOptions requestOptions)	Get a list of stores
Store	updateStore(String merchantId, String storeId, UpdateStoreRequest updateStoreRequest)	Update a store
Store	updateStore(String merchantId, String storeId, UpdateStoreRequest updateStoreRequest, RequestOptions requestOptions)	Update a store
Store	updateStoreById(String storeId, UpdateStoreRequest updateStoreRequest)	Update a store
Store	updateStoreById(String storeId, UpdateStoreRequest updateStoreRequest, RequestOptions requestOptions)	Update a store

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

Constructor Detail

AccountStoreLevelApi

public AccountStoreLevelApi(Client client)

Method Detail

listStoresByMerchantId

public ListStoresResponse listStoresByMerchantId(String merchantId)
                                          throws ApiException,
                                                 IOException

Get a list of stores

Parameters:

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

Returns:

ListStoresResponse

Throws:

ApiException - if fails to make API call

IOException

listStoresByMerchantId

public ListStoresResponse listStoresByMerchantId(String merchantId,
                                                 Integer pageNumber,
                                                 Integer pageSize,
                                                 String reference,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Get a list of stores

Parameters:

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

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

reference - String Query: The reference of the store. (optional)

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

Returns:

ListStoresResponse

Throws:

ApiException - if fails to make API call

IOException

getStore

public Store getStore(String merchantId,
                      String storeId)
               throws ApiException,
                      IOException

Get a store

Parameters:

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

storeId - String The unique identifier of the store. (required)

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

getStore

public Store getStore(String merchantId,
                      String storeId,
                      RequestOptions requestOptions)
               throws ApiException,
                      IOException

Get a store

Parameters:

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

storeId - String The unique identifier of the store. (required)

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

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

listStores

public ListStoresResponse listStores()
                              throws ApiException,
                                     IOException

Get a list of stores

Returns:

ListStoresResponse

Throws:

ApiException - if fails to make API call

IOException

listStores

public ListStoresResponse listStores(Integer pageNumber,
                                     Integer pageSize,
                                     String reference,
                                     String merchantId,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Get a list of stores

Parameters:

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

reference - String Query: The reference of the store. (optional)

merchantId - String Query: The unique identifier of the merchant account. (optional)

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

Returns:

ListStoresResponse

Throws:

ApiException - if fails to make API call

IOException

getStoreById

public Store getStoreById(String storeId)
                   throws ApiException,
                          IOException

Get a store

Parameters:

storeId - String The unique identifier of the store. (required)

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

getStoreById

public Store getStoreById(String storeId,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Get a store

Parameters:

storeId - String The unique identifier of the store. (required)

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

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

updateStore

public Store updateStore(String merchantId,
                         String storeId,
                         UpdateStoreRequest updateStoreRequest)
                  throws ApiException,
                         IOException

Update a store

Parameters:

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

storeId - String The unique identifier of the store. (required)

updateStoreRequest - UpdateStoreRequest (required)

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

updateStore

public Store updateStore(String merchantId,
                         String storeId,
                         UpdateStoreRequest updateStoreRequest,
                         RequestOptions requestOptions)
                  throws ApiException,
                         IOException

Update a store

Parameters:

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

storeId - String The unique identifier of the store. (required)

updateStoreRequest - UpdateStoreRequest (required)

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

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

updateStoreById

public Store updateStoreById(String storeId,
                             UpdateStoreRequest updateStoreRequest)
                      throws ApiException,
                             IOException

Update a store

Parameters:

storeId - String The unique identifier of the store. (required)

updateStoreRequest - UpdateStoreRequest (required)

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

updateStoreById

public Store updateStoreById(String storeId,
                             UpdateStoreRequest updateStoreRequest,
                             RequestOptions requestOptions)
                      throws ApiException,
                             IOException

Update a store

Parameters:

storeId - String The unique identifier of the store. (required)

updateStoreRequest - UpdateStoreRequest (required)

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

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

createStoreByMerchantId

public Store createStoreByMerchantId(String merchantId,
                                     StoreCreationRequest storeCreationRequest)
                              throws ApiException,
                                     IOException

Create a store

Parameters:

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

storeCreationRequest - StoreCreationRequest (required)

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

createStoreByMerchantId

public Store createStoreByMerchantId(String merchantId,
                                     StoreCreationRequest storeCreationRequest,
                                     RequestOptions requestOptions)
                              throws ApiException,
                                     IOException

Create a store

Parameters:

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

storeCreationRequest - StoreCreationRequest (required)

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

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

createStore

public Store createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest)
                  throws ApiException,
                         IOException

Create a store

Parameters:

storeCreationWithMerchantCodeRequest - StoreCreationWithMerchantCodeRequest (required)

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException

createStore

public Store createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest,
                         RequestOptions requestOptions)
                  throws ApiException,
                         IOException

Create a store

Parameters:

storeCreationWithMerchantCodeRequest - StoreCreationWithMerchantCodeRequest (required)

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

Returns:

Store

Throws:

ApiException - if fails to make API call

IOException