com.squareup.square.api

Class DefaultSnippetsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultSnippetsApi

All Implemented Interfaces:

SnippetsApi

public final class DefaultSnippetsApi
extends BaseApi
implements SnippetsApi

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
DefaultSnippetsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultSnippetsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
DeleteSnippetResponse	deleteSnippet(String siteId) Removes your snippet from a Square Online site.
CompletableFuture<DeleteSnippetResponse>	deleteSnippetAsync(String siteId) Removes your snippet from a Square Online site.
RetrieveSnippetResponse	retrieveSnippet(String siteId) Retrieves your snippet from a Square Online site.
CompletableFuture<RetrieveSnippetResponse>	retrieveSnippetAsync(String siteId) Retrieves your snippet from a Square Online site.
UpsertSnippetResponse	upsertSnippet(String siteId, UpsertSnippetRequest body) Adds a snippet to a Square Online site or updates the existing snippet on the site.
CompletableFuture<UpsertSnippetResponse>	upsertSnippetAsync(String siteId, UpsertSnippetRequest body) Adds a snippet to a Square Online site or updates the existing snippet on the site.

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

DefaultSnippetsApi

public DefaultSnippetsApi(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.

DefaultSnippetsApi

public DefaultSnippetsApi(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

deleteSnippet

public DeleteSnippetResponse deleteSnippet(String siteId)
                                    throws ApiException,
                                           IOException

Removes your snippet from a Square Online site. You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

deleteSnippet in interface SnippetsApi

Parameters:

siteId - Required parameter: The ID of the site that contains the snippet.

Returns:

Returns the DeleteSnippetResponse 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.

deleteSnippetAsync

public CompletableFuture<DeleteSnippetResponse> deleteSnippetAsync(String siteId)

Removes your snippet from a Square Online site. You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

deleteSnippetAsync in interface SnippetsApi

Parameters:

siteId - Required parameter: The ID of the site that contains the snippet.

Returns:

Returns the DeleteSnippetResponse response from the API call

retrieveSnippet

public RetrieveSnippetResponse retrieveSnippet(String siteId)
                                        throws ApiException,
                                               IOException

Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

retrieveSnippet in interface SnippetsApi

Parameters:

siteId - Required parameter: The ID of the site that contains the snippet.

Returns:

Returns the RetrieveSnippetResponse 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.

retrieveSnippetAsync

public CompletableFuture<RetrieveSnippetResponse> retrieveSnippetAsync(String siteId)

Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application. You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

retrieveSnippetAsync in interface SnippetsApi

Parameters:

siteId - Required parameter: The ID of the site that contains the snippet.

Returns:

Returns the RetrieveSnippetResponse response from the API call

upsertSnippet

public UpsertSnippetResponse upsertSnippet(String siteId,
                                           UpsertSnippetRequest body)
                                    throws ApiException,
                                           IOException

Adds a snippet to a Square Online site or updates the existing snippet on the site. The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

upsertSnippet in interface SnippetsApi

Parameters:

siteId - Required parameter: The ID of the site where you want to add or update the snippet.

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

Returns:

Returns the UpsertSnippetResponse 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.

upsertSnippetAsync

public CompletableFuture<UpsertSnippetResponse> upsertSnippetAsync(String siteId,
                                                                   UpsertSnippetRequest body)

Adds a snippet to a Square Online site or updates the existing snippet on the site. The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site. You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

upsertSnippetAsync in interface SnippetsApi

Parameters:

siteId - Required parameter: The ID of the site where you want to add or update the snippet.

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

Returns:

Returns the UpsertSnippetResponse response from the API call