com.squareup.square.api

Interface VendorsApi

All Known Implementing Classes:

DefaultVendorsApi

public interface VendorsApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

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.

Method Detail

bulkCreateVendors

BulkCreateVendorsResponse bulkCreateVendors(BulkCreateVendorsRequest body)
                                     throws ApiException,
                                            IOException

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

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

CompletableFuture<BulkCreateVendorsResponse> bulkCreateVendorsAsync(BulkCreateVendorsRequest body)

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

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

BulkRetrieveVendorsResponse bulkRetrieveVendors(BulkRetrieveVendorsRequest body)
                                         throws ApiException,
                                                IOException

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

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

CompletableFuture<BulkRetrieveVendorsResponse> bulkRetrieveVendorsAsync(BulkRetrieveVendorsRequest body)

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

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

BulkUpdateVendorsResponse bulkUpdateVendors(BulkUpdateVendorsRequest body)
                                     throws ApiException,
                                            IOException

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

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

CompletableFuture<BulkUpdateVendorsResponse> bulkUpdateVendorsAsync(BulkUpdateVendorsRequest body)

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

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

CreateVendorResponse createVendor(CreateVendorRequest body)
                           throws ApiException,
                                  IOException

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

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

CompletableFuture<CreateVendorResponse> createVendorAsync(CreateVendorRequest body)

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

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

SearchVendorsResponse searchVendors(SearchVendorsRequest body)
                             throws ApiException,
                                    IOException

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

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

CompletableFuture<SearchVendorsResponse> searchVendorsAsync(SearchVendorsRequest body)

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

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

RetrieveVendorResponse retrieveVendor(String vendorId)
                               throws ApiException,
                                      IOException

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

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

CompletableFuture<RetrieveVendorResponse> retrieveVendorAsync(String vendorId)

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

Parameters:

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

Returns:

Returns the RetrieveVendorResponse response from the API call

updateVendor

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

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

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

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

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

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