com.squareup.square.api

Interface SnippetsApi

All Known Implementing Classes:

DefaultSnippetsApi

public interface SnippetsApi

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
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.

Method Detail

deleteSnippet

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).

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

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).

Parameters:

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

Returns:

Returns the DeleteSnippetResponse response from the API call

retrieveSnippet

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).

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

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).

Parameters:

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

Returns:

Returns the RetrieveSnippetResponse response from the API call

upsertSnippet

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).

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

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).

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