com.squareup.square.api

Class DefaultVendorsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultVendorsApi

All Implemented Interfaces:

VendorsApi

public final class DefaultVendorsApi
extends BaseApi
implements VendorsApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultVendorsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultVendorsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
BulkCreateVendorsResponse	bulkCreateVendors(BulkCreateVendorsRequest body) Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to a seller.
CompletableFuture<BulkCreateVendorsResponse>	bulkCreateVendorsAsync(BulkCreateVendorsRequest body) Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to a seller.
BulkRetrieveVendorsResponse	bulkRetrieveVendors(BulkRetrieveVendorsRequest body) Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.
CompletableFuture<BulkRetrieveVendorsResponse>	bulkRetrieveVendorsAsync(BulkRetrieveVendorsRequest body) Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.
BulkUpdateVendorsResponse	bulkUpdateVendors(BulkUpdateVendorsRequest body) Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.
CompletableFuture<BulkUpdateVendorsResponse>	bulkUpdateVendorsAsync(BulkUpdateVendorsRequest body) Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.
CreateVendorResponse	createVendor(CreateVendorRequest body) Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.
CompletableFuture<CreateVendorResponse>	createVendorAsync(CreateVendorRequest body) Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.
RetrieveVendorResponse	retrieveVendor(String vendorId) Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
CompletableFuture<RetrieveVendorResponse>	retrieveVendorAsync(String vendorId) Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
SearchVendorsResponse	searchVendors(SearchVendorsRequest body) Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a supported sorter.
CompletableFuture<SearchVendorsResponse>	searchVendorsAsync(SearchVendorsRequest body) Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a supported sorter.
UpdateVendorResponse	updateVendor(UpdateVendorRequest body, String vendorId) Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.
CompletableFuture<UpdateVendorResponse>	updateVendorAsync(UpdateVendorRequest body, String vendorId) Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVendorsApi

public DefaultVendorsApi(Configuration config,
                         HttpClient httpClient,
                         Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultVendorsApi

public DefaultVendorsApi(Configuration config,
                         HttpClient httpClient,
                         Map<String,AuthManager> authManagers,
                         HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

bulkCreateVendors

public BulkCreateVendorsResponse bulkCreateVendors(BulkCreateVendorsRequest body)
                                            throws ApiException,
                                                   IOException

Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to a seller.

Specified by:

bulkCreateVendors in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkCreateVendorsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkCreateVendorsAsync

public CompletableFuture<BulkCreateVendorsResponse> bulkCreateVendorsAsync(BulkCreateVendorsRequest body)

Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to a seller.

Specified by:

bulkCreateVendorsAsync in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkCreateVendorsResponse response from the API call

bulkRetrieveVendors

public BulkRetrieveVendorsResponse bulkRetrieveVendors(BulkRetrieveVendorsRequest body)
                                                throws ApiException,
                                                       IOException

Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.

Specified by:

bulkRetrieveVendors in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkRetrieveVendorsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkRetrieveVendorsAsync

public CompletableFuture<BulkRetrieveVendorsResponse> bulkRetrieveVendorsAsync(BulkRetrieveVendorsRequest body)

Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.

Specified by:

bulkRetrieveVendorsAsync in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkRetrieveVendorsResponse response from the API call

bulkUpdateVendors

public BulkUpdateVendorsResponse bulkUpdateVendors(BulkUpdateVendorsRequest body)
                                            throws ApiException,
                                                   IOException

Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.

Specified by:

bulkUpdateVendors in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpdateVendorsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkUpdateVendorsAsync

public CompletableFuture<BulkUpdateVendorsResponse> bulkUpdateVendorsAsync(BulkUpdateVendorsRequest body)

Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.

Specified by:

bulkUpdateVendorsAsync in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpdateVendorsResponse response from the API call

createVendor

public CreateVendorResponse createVendor(CreateVendorRequest body)
                                  throws ApiException,
                                         IOException

Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.

Specified by:

createVendor in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateVendorResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createVendorAsync

public CompletableFuture<CreateVendorResponse> createVendorAsync(CreateVendorRequest body)

Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.

Specified by:

createVendorAsync in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateVendorResponse response from the API call

searchVendors

public SearchVendorsResponse searchVendors(SearchVendorsRequest body)
                                    throws ApiException,
                                           IOException

Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a supported sorter.

Specified by:

searchVendors in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchVendorsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchVendorsAsync

public CompletableFuture<SearchVendorsResponse> searchVendorsAsync(SearchVendorsRequest body)

Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a supported sorter.

Specified by:

searchVendorsAsync in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchVendorsResponse response from the API call

retrieveVendor

public RetrieveVendorResponse retrieveVendor(String vendorId)
                                      throws ApiException,
                                             IOException

Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.

Specified by:

retrieveVendor in interface VendorsApi

Parameters:

vendorId - Required parameter: ID of the [Vendor]($m/Vendor) to retrieve.

Returns:

Returns the RetrieveVendorResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveVendorAsync

public CompletableFuture<RetrieveVendorResponse> retrieveVendorAsync(String vendorId)

Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.

Specified by:

retrieveVendorAsync in interface VendorsApi

Parameters:

vendorId - Required parameter: ID of the [Vendor]($m/Vendor) to retrieve.

Returns:

Returns the RetrieveVendorResponse response from the API call

updateVendor

public UpdateVendorResponse updateVendor(UpdateVendorRequest body,
                                         String vendorId)
                                  throws ApiException,
                                         IOException

Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.

Specified by:

updateVendor in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

vendorId - Required parameter: Example:

Returns:

Returns the UpdateVendorResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateVendorAsync

public CompletableFuture<UpdateVendorResponse> updateVendorAsync(UpdateVendorRequest body,
                                                                 String vendorId)

Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.

Specified by:

updateVendorAsync in interface VendorsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

vendorId - Required parameter: Example:

Returns:

Returns the UpdateVendorResponse response from the API call