Skip to content

Latest commit

 

History

History
157 lines (113 loc) · 4.86 KB

snippets.md

File metadata and controls

157 lines (113 loc) · 4.86 KB
Raw

Snippets

const snippetsApi = client.snippetsApi;

Class Name

SnippetsApi

Methods

Delete Snippet

Removes your snippet from a Square Online site.

You can call 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.

async deleteSnippet(
  siteId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<DeleteSnippetResponse>>

Parameters

Parameter Type Tags Description
siteId string Template, Required The ID of the site that contains the snippet.
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

DeleteSnippetResponse

Example Usage

const siteId = 'site_id6';
try {
  const { result, ...httpResponse } = await snippetsApi.deleteSnippet(siteId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Retrieve Snippet

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

async retrieveSnippet(
  siteId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveSnippetResponse>>

Parameters

Parameter Type Tags Description
siteId string Template, Required The ID of the site that contains the snippet.
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

RetrieveSnippetResponse

Example Usage

const siteId = 'site_id6';
try {
  const { result, ...httpResponse } = await snippetsApi.retrieveSnippet(siteId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Upsert Snippet

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

async upsertSnippet(
  siteId: string,
  body: UpsertSnippetRequest,
  requestOptions?: RequestOptions
): Promise<ApiResponse<UpsertSnippetResponse>>

Parameters

Parameter Type Tags Description
siteId string Template, Required The ID of the site where you want to add or update the snippet.
body UpsertSnippetRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

UpsertSnippetResponse

Example Usage

const siteId = 'site_id6';
const contentType = null;
const bodySnippet: Snippet = {
  content: '<script>var js = 1;</script>',
};

const body: UpsertSnippetRequest = {
  snippet: bodySnippet,
};

try {
  const { result, ...httpResponse } = await snippetsApi.upsertSnippet(siteId, body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}