square-connect
Advanced tools
Changelog
Version 4.20200812.2 (2020-08-12T00:00)
SUBSCRIPTION_PLAN type. For more information, see Set Up and Manage a Subscription Plan.Readme
This Square Connect SDK will enter a security maintenance phase in Q4 2020 and will be RETIRED (EOL) in Q2 2021. In the security maintenance phase, this SDK will continue to receive support and security patches but will no longer receive bug fixes or product updates. Once it is retired, support and security patches will no longer be available. A new SDK, more bespoke to the language, will be available once this SDK enters its security maintenance phase. The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our Square API Lifecycle documentation.
| Security Maintenance | New SDK Release | Retired (EOL) |
|---|---|---|
| Q4, 2020 | Q4, 2020 | Q2, 2021 |
If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new slack community for Square Developers
Node.js 6.0 or later
To install the SDK:
npm install square-connect --save
Please follow the installation instruction and execute the following JS code:
var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";
var api = new SquareConnect.LocationsApi();
api.listLocations().then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data, 0, 1));
}, function(error) {
console.error(error);
});
var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;
// Set sandbox url
defaultClient.basePath = 'https://connect.squareupsandbox.com';
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
// Set sandbox access token
oauth2.accessToken = "YOUR SANDBOX ACCESS TOKEN";
// Pass client to API
var api = new SquareConnect.LocationsApi();
All URIs are relative to https://connect.squareup.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| SquareConnect.ApplePayApi | registerDomain | POST /v2/apple-pay/domains | RegisterDomain |
| SquareConnect.BankAccountsApi | getBankAccount | GET /v2/bank-accounts/{bank_account_id} | GetBankAccount |
| SquareConnect.BankAccountsApi | getBankAccountByV1Id | GET /v2/bank-accounts/by-v1-id/{v1_bank_account_id} | GetBankAccountByV1Id |
| SquareConnect.BankAccountsApi | listBankAccounts | GET /v2/bank-accounts | ListBankAccounts |
| SquareConnect.CashDrawersApi | listCashDrawerShiftEvents | GET /v2/cash-drawers/shifts/{shift_id}/events | ListCashDrawerShiftEvents |
| SquareConnect.CashDrawersApi | listCashDrawerShifts | GET /v2/cash-drawers/shifts | ListCashDrawerShifts |
| SquareConnect.CashDrawersApi | retrieveCashDrawerShift | GET /v2/cash-drawers/shifts/{shift_id} | RetrieveCashDrawerShift |
| SquareConnect.CatalogApi | batchDeleteCatalogObjects | POST /v2/catalog/batch-delete | BatchDeleteCatalogObjects |
| SquareConnect.CatalogApi | batchRetrieveCatalogObjects | POST /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects |
| SquareConnect.CatalogApi | batchUpsertCatalogObjects | POST /v2/catalog/batch-upsert | BatchUpsertCatalogObjects |
| SquareConnect.CatalogApi | catalogInfo | GET /v2/catalog/info | CatalogInfo |
| SquareConnect.CatalogApi | deleteCatalogObject | DELETE /v2/catalog/object/{object_id} | DeleteCatalogObject |
| SquareConnect.CatalogApi | listCatalog | GET /v2/catalog/list | ListCatalog |
| SquareConnect.CatalogApi | retrieveCatalogObject | GET /v2/catalog/object/{object_id} | RetrieveCatalogObject |
| SquareConnect.CatalogApi | searchCatalogItems | POST /v2/catalog/search-catalog-items | SearchCatalogItems |
| SquareConnect.CatalogApi | searchCatalogObjects | POST /v2/catalog/search | SearchCatalogObjects |
| SquareConnect.CatalogApi | updateItemModifierLists | POST /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists |
| SquareConnect.CatalogApi | updateItemTaxes | POST /v2/catalog/update-item-taxes | UpdateItemTaxes |
| SquareConnect.CatalogApi | upsertCatalogObject | POST /v2/catalog/object | UpsertCatalogObject |
| SquareConnect.CheckoutApi | createCheckout | POST /v2/locations/{location_id}/checkouts | CreateCheckout |
| SquareConnect.CustomerGroupsApi | createCustomerGroup | POST /v2/customers/groups | CreateCustomerGroup |
| SquareConnect.CustomerGroupsApi | deleteCustomerGroup | DELETE /v2/customers/groups/{group_id} | DeleteCustomerGroup |
| SquareConnect.CustomerGroupsApi | listCustomerGroups | GET /v2/customers/groups | ListCustomerGroups |
| SquareConnect.CustomerGroupsApi | retrieveCustomerGroup | GET /v2/customers/groups/{group_id} | RetrieveCustomerGroup |
| SquareConnect.CustomerGroupsApi | updateCustomerGroup | PUT /v2/customers/groups/{group_id} | UpdateCustomerGroup |
| SquareConnect.CustomerSegmentsApi | listCustomerSegments | GET /v2/customers/segments | ListCustomerSegments |
| SquareConnect.CustomerSegmentsApi | retrieveCustomerSegment | GET /v2/customers/segments/{segment_id} | RetrieveCustomerSegment |
| SquareConnect.CustomersApi | addGroupToCustomer | PUT /v2/customers/{customer_id}/groups/{group_id} | AddGroupToCustomer |
| SquareConnect.CustomersApi | createCustomer | POST /v2/customers | CreateCustomer |
| SquareConnect.CustomersApi | createCustomerCard | POST /v2/customers/{customer_id}/cards | CreateCustomerCard |
| SquareConnect.CustomersApi | deleteCustomer | DELETE /v2/customers/{customer_id} | DeleteCustomer |
| SquareConnect.CustomersApi | deleteCustomerCard | DELETE /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard |
| SquareConnect.CustomersApi | listCustomers | GET /v2/customers | ListCustomers |
| SquareConnect.CustomersApi | removeGroupFromCustomer | DELETE /v2/customers/{customer_id}/groups/{group_id} | RemoveGroupFromCustomer |
| SquareConnect.CustomersApi | retrieveCustomer | GET /v2/customers/{customer_id} | RetrieveCustomer |
| SquareConnect.CustomersApi | searchCustomers | POST /v2/customers/search | SearchCustomers |
| SquareConnect.CustomersApi | updateCustomer | PUT /v2/customers/{customer_id} | UpdateCustomer |
| SquareConnect.DevicesApi | createDeviceCode | POST /v2/devices/codes | CreateDeviceCode |
| SquareConnect.DevicesApi | getDeviceCode | GET /v2/devices/codes/{id} | GetDeviceCode |
| SquareConnect.DevicesApi | listDeviceCodes | GET /v2/devices/codes | ListDeviceCodes |
| SquareConnect.DisputesApi | acceptDispute | POST /v2/disputes/{dispute_id}/accept | AcceptDispute |
| SquareConnect.DisputesApi | createDisputeEvidenceText | POST /v2/disputes/{dispute_id}/evidence_text | CreateDisputeEvidenceText |
| SquareConnect.DisputesApi | listDisputeEvidence | GET /v2/disputes/{dispute_id}/evidence | ListDisputeEvidence |
| SquareConnect.DisputesApi | listDisputes | GET /v2/disputes | ListDisputes |
| SquareConnect.DisputesApi | removeDisputeEvidence | DELETE /v2/disputes/{dispute_id}/evidence/{evidence_id} | RemoveDisputeEvidence |
| SquareConnect.DisputesApi | retrieveDispute | GET /v2/disputes/{dispute_id} | RetrieveDispute |
| SquareConnect.DisputesApi | retrieveDisputeEvidence | GET /v2/disputes/{dispute_id}/evidence/{evidence_id} | RetrieveDisputeEvidence |
| SquareConnect.DisputesApi | submitEvidence | POST /v2/disputes/{dispute_id}/submit-evidence | SubmitEvidence |
| SquareConnect.EmployeesApi | listEmployees | GET /v2/employees | ListEmployees |
| SquareConnect.EmployeesApi | retrieveEmployee | GET /v2/employees/{id} | RetrieveEmployee |
| SquareConnect.InventoryApi | batchChangeInventory | POST /v2/inventory/batch-change | BatchChangeInventory |
| SquareConnect.InventoryApi | batchRetrieveInventoryChanges | POST /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges |
| SquareConnect.InventoryApi | batchRetrieveInventoryCounts | POST /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts |
| SquareConnect.InventoryApi | retrieveInventoryAdjustment | GET /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment |
| SquareConnect.InventoryApi | retrieveInventoryChanges | GET /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges |
| SquareConnect.InventoryApi | retrieveInventoryCount | GET /v2/inventory/{catalog_object_id} | RetrieveInventoryCount |
| SquareConnect.InventoryApi | retrieveInventoryPhysicalCount | GET /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount |
| SquareConnect.InvoicesApi | cancelInvoice | POST /v2/invoices/{invoice_id}/cancel | CancelInvoice |
| SquareConnect.InvoicesApi | createInvoice | POST /v2/invoices | CreateInvoice |
| SquareConnect.InvoicesApi | deleteInvoice | DELETE /v2/invoices/{invoice_id} | DeleteInvoice |
| SquareConnect.InvoicesApi | getInvoice | GET /v2/invoices/{invoice_id} | GetInvoice |
| SquareConnect.InvoicesApi | listInvoices | GET /v2/invoices | ListInvoices |
| SquareConnect.InvoicesApi | publishInvoice | POST /v2/invoices/{invoice_id}/publish | PublishInvoice |
| SquareConnect.InvoicesApi | searchInvoices | POST /v2/invoices/search | SearchInvoices |
| SquareConnect.InvoicesApi | updateInvoice | PUT /v2/invoices/{invoice_id} | UpdateInvoice |
| SquareConnect.LaborApi | createBreakType | POST /v2/labor/break-types | CreateBreakType |
| SquareConnect.LaborApi | createShift | POST /v2/labor/shifts | CreateShift |
| SquareConnect.LaborApi | deleteBreakType | DELETE /v2/labor/break-types/{id} | DeleteBreakType |
| SquareConnect.LaborApi | deleteShift | DELETE /v2/labor/shifts/{id} | DeleteShift |
| SquareConnect.LaborApi | getBreakType | GET /v2/labor/break-types/{id} | GetBreakType |
| SquareConnect.LaborApi | getEmployeeWage | GET /v2/labor/employee-wages/{id} | GetEmployeeWage |
| SquareConnect.LaborApi | getShift | GET /v2/labor/shifts/{id} | GetShift |
| SquareConnect.LaborApi | listBreakTypes | GET /v2/labor/break-types | ListBreakTypes |
| SquareConnect.LaborApi | listEmployeeWages | GET /v2/labor/employee-wages | ListEmployeeWages |
| SquareConnect.LaborApi | listWorkweekConfigs | GET /v2/labor/workweek-configs | ListWorkweekConfigs |
| SquareConnect.LaborApi | searchShifts | POST /v2/labor/shifts/search | SearchShifts |
| SquareConnect.LaborApi | updateBreakType | PUT /v2/labor/break-types/{id} | UpdateBreakType |
| SquareConnect.LaborApi | updateShift | PUT /v2/labor/shifts/{id} | UpdateShift |
| SquareConnect.LaborApi | updateWorkweekConfig | PUT /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig |
| SquareConnect.LocationsApi | createLocation | POST /v2/locations | CreateLocation |
| SquareConnect.LocationsApi | listLocations | GET /v2/locations | ListLocations |
| SquareConnect.LocationsApi | retrieveLocation | GET /v2/locations/{location_id} | RetrieveLocation |
| SquareConnect.LocationsApi | updateLocation | PUT /v2/locations/{location_id} | UpdateLocation |
| SquareConnect.LoyaltyApi | accumulateLoyaltyPoints | POST /v2/loyalty/accounts/{account_id}/accumulate | AccumulateLoyaltyPoints |
| SquareConnect.LoyaltyApi | adjustLoyaltyPoints | POST /v2/loyalty/accounts/{account_id}/adjust | AdjustLoyaltyPoints |
| SquareConnect.LoyaltyApi | calculateLoyaltyPoints | POST /v2/loyalty/programs/{program_id}/calculate | CalculateLoyaltyPoints |
| SquareConnect.LoyaltyApi | createLoyaltyAccount | POST /v2/loyalty/accounts | CreateLoyaltyAccount |
| SquareConnect.LoyaltyApi | createLoyaltyReward | POST /v2/loyalty/rewards | CreateLoyaltyReward |
| SquareConnect.LoyaltyApi | deleteLoyaltyReward | DELETE /v2/loyalty/rewards/{reward_id} | DeleteLoyaltyReward |
| SquareConnect.LoyaltyApi | listLoyaltyPrograms | GET /v2/loyalty/programs | ListLoyaltyPrograms |
| SquareConnect.LoyaltyApi | redeemLoyaltyReward | POST /v2/loyalty/rewards/{reward_id}/redeem | RedeemLoyaltyReward |
| SquareConnect.LoyaltyApi | retrieveLoyaltyAccount | GET /v2/loyalty/accounts/{account_id} | RetrieveLoyaltyAccount |
| SquareConnect.LoyaltyApi | retrieveLoyaltyReward | GET /v2/loyalty/rewards/{reward_id} | RetrieveLoyaltyReward |
| SquareConnect.LoyaltyApi | searchLoyaltyAccounts | POST /v2/loyalty/accounts/search | SearchLoyaltyAccounts |
| SquareConnect.LoyaltyApi | searchLoyaltyEvents | POST /v2/loyalty/events/search | SearchLoyaltyEvents |
| SquareConnect.LoyaltyApi | searchLoyaltyRewards | POST /v2/loyalty/rewards/search | SearchLoyaltyRewards |
| SquareConnect.MerchantsApi | listMerchants | GET /v2/merchants | ListMerchants |
| SquareConnect.MerchantsApi | retrieveMerchant | GET /v2/merchants/{merchant_id} | RetrieveMerchant |
| SquareConnect.MobileAuthorizationApi | createMobileAuthorizationCode | POST /mobile/authorization-code | CreateMobileAuthorizationCode |
| SquareConnect.OAuthApi | obtainToken | POST /oauth2/token | ObtainToken |
| SquareConnect.OAuthApi | renewToken | POST /oauth2/clients/{client_id}/access-token/renew | RenewToken |
| SquareConnect.OAuthApi | revokeToken | POST /oauth2/revoke | RevokeToken |
| SquareConnect.OrdersApi | batchRetrieveOrders | POST /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders |
| SquareConnect.OrdersApi | calculateOrder | POST /v2/orders/calculate | CalculateOrder |
| SquareConnect.OrdersApi | createOrder | POST /v2/locations/{location_id}/orders | CreateOrder |
| SquareConnect.OrdersApi | payOrder | POST /v2/orders/{order_id}/pay | PayOrder |
| SquareConnect.OrdersApi | searchOrders | POST /v2/orders/search | SearchOrders |
| SquareConnect.OrdersApi | updateOrder | PUT /v2/locations/{location_id}/orders/{order_id} | UpdateOrder |
| SquareConnect.PaymentsApi | cancelPayment | POST /v2/payments/{payment_id}/cancel | CancelPayment |
| SquareConnect.PaymentsApi | cancelPaymentByIdempotencyKey | POST /v2/payments/cancel | CancelPaymentByIdempotencyKey |
| SquareConnect.PaymentsApi | completePayment | POST /v2/payments/{payment_id}/complete | CompletePayment |
| SquareConnect.PaymentsApi | createPayment | POST /v2/payments | CreatePayment |
| SquareConnect.PaymentsApi | getPayment | GET /v2/payments/{payment_id} | GetPayment |
| SquareConnect.PaymentsApi | listPayments | GET /v2/payments | ListPayments |
| SquareConnect.RefundsApi | getPaymentRefund | GET /v2/refunds/{refund_id} | GetPaymentRefund |
| SquareConnect.RefundsApi | listPaymentRefunds | GET /v2/refunds | ListPaymentRefunds |
| SquareConnect.RefundsApi | refundPayment | POST /v2/refunds | RefundPayment |
| SquareConnect.ReportingApi | listAdditionalRecipientReceivableRefunds | GET /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds |
| SquareConnect.ReportingApi | listAdditionalRecipientReceivables | GET /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables |
| SquareConnect.SubscriptionsApi | cancelSubscription | POST /v2/subscriptions/{subscription_id}/cancel | CancelSubscription |
| SquareConnect.SubscriptionsApi | createSubscription | POST /v2/subscriptions | CreateSubscription |
| SquareConnect.SubscriptionsApi | listSubscriptionEvents | GET /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents |
| SquareConnect.SubscriptionsApi | retrieveSubscription | GET /v2/subscriptions/{subscription_id} | RetrieveSubscription |
| SquareConnect.SubscriptionsApi | searchSubscriptions | POST /v2/subscriptions/search | SearchSubscriptions |
| SquareConnect.SubscriptionsApi | updateSubscription | PUT /v2/subscriptions/{subscription_id} | UpdateSubscription |
| SquareConnect.TeamApi | bulkCreateTeamMembers | POST /v2/team-members/bulk-create | BulkCreateTeamMembers |
| SquareConnect.TeamApi | bulkUpdateTeamMembers | POST /v2/team-members/bulk-update | BulkUpdateTeamMembers |
| SquareConnect.TeamApi | createTeamMember | POST /v2/team-members | CreateTeamMember |
| SquareConnect.TeamApi | retrieveTeamMember | GET /v2/team-members/{team_member_id} | RetrieveTeamMember |
| SquareConnect.TeamApi | retrieveWageSetting | GET /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting |
| SquareConnect.TeamApi | searchTeamMembers | POST /v2/team-members/search | SearchTeamMembers |
| SquareConnect.TeamApi | updateTeamMember | PUT /v2/team-members/{team_member_id} | UpdateTeamMember |
| SquareConnect.TeamApi | updateWageSetting | PUT /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting |
| SquareConnect.TerminalApi | cancelTerminalCheckout | POST /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout |
| SquareConnect.TerminalApi | createTerminalCheckout | POST /v2/terminals/checkouts | CreateTerminalCheckout |
| SquareConnect.TerminalApi | getTerminalCheckout | GET /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout |
| SquareConnect.TerminalApi | searchTerminalCheckouts | POST /v2/terminals/checkouts/search | SearchTerminalCheckouts |
| SquareConnect.TransactionsApi | captureTransaction | POST /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction |
| SquareConnect.TransactionsApi | charge | POST /v2/locations/{location_id}/transactions | Charge |
| SquareConnect.TransactionsApi | createRefund | POST /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund |
| SquareConnect.TransactionsApi | listRefunds | GET /v2/locations/{location_id}/refunds | ListRefunds |
| SquareConnect.TransactionsApi | listTransactions | GET /v2/locations/{location_id}/transactions | ListTransactions |
| SquareConnect.TransactionsApi | retrieveTransaction | GET /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction |
| SquareConnect.TransactionsApi | voidTransaction | POST /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction |
| SquareConnect.V1EmployeesApi | createEmployee | POST /v1/me/employees | CreateEmployee |
| SquareConnect.V1EmployeesApi | createEmployeeRole | POST /v1/me/roles | CreateEmployeeRole |
| SquareConnect.V1EmployeesApi | createTimecard | POST /v1/me/timecards | CreateTimecard |
| SquareConnect.V1EmployeesApi | deleteTimecard | DELETE /v1/me/timecards/{timecard_id} | DeleteTimecard |
| SquareConnect.V1EmployeesApi | listCashDrawerShifts | GET /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts |
| SquareConnect.V1EmployeesApi | listEmployeeRoles | GET /v1/me/roles | ListEmployeeRoles |
| SquareConnect.V1EmployeesApi | listEmployees | GET /v1/me/employees | ListEmployees |
| SquareConnect.V1EmployeesApi | listTimecardEvents | GET /v1/me/timecards/{timecard_id}/events | ListTimecardEvents |
| SquareConnect.V1EmployeesApi | listTimecards | GET /v1/me/timecards | ListTimecards |
| SquareConnect.V1EmployeesApi | retrieveCashDrawerShift | GET /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift |
| SquareConnect.V1EmployeesApi | retrieveEmployee | GET /v1/me/employees/{employee_id} | RetrieveEmployee |
| SquareConnect.V1EmployeesApi | retrieveEmployeeRole | GET /v1/me/roles/{role_id} | RetrieveEmployeeRole |
| SquareConnect.V1EmployeesApi | retrieveTimecard | GET /v1/me/timecards/{timecard_id} | RetrieveTimecard |
| SquareConnect.V1EmployeesApi | updateEmployee | PUT /v1/me/employees/{employee_id} | UpdateEmployee |
| SquareConnect.V1EmployeesApi | updateEmployeeRole | PUT /v1/me/roles/{role_id} | UpdateEmployeeRole |
| SquareConnect.V1EmployeesApi | updateTimecard | PUT /v1/me/timecards/{timecard_id} | UpdateTimecard |
| SquareConnect.V1ItemsApi | adjustInventory | POST /v1/{location_id}/inventory/{variation_id} | AdjustInventory |
| SquareConnect.V1ItemsApi | applyFee | PUT /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee |
| SquareConnect.V1ItemsApi | applyModifierList | PUT /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList |
| SquareConnect.V1ItemsApi | createCategory | POST /v1/{location_id}/categories | CreateCategory |
| SquareConnect.V1ItemsApi | createDiscount | POST /v1/{location_id}/discounts | CreateDiscount |
| SquareConnect.V1ItemsApi | createFee | POST /v1/{location_id}/fees | CreateFee |
| SquareConnect.V1ItemsApi | createItem | POST /v1/{location_id}/items | CreateItem |
| SquareConnect.V1ItemsApi | createModifierList | POST /v1/{location_id}/modifier-lists | CreateModifierList |
| SquareConnect.V1ItemsApi | createModifierOption | POST /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption |
| SquareConnect.V1ItemsApi | createPage | POST /v1/{location_id}/pages | CreatePage |
| SquareConnect.V1ItemsApi | createVariation | POST /v1/{location_id}/items/{item_id}/variations | CreateVariation |
| SquareConnect.V1ItemsApi | deleteCategory | DELETE /v1/{location_id}/categories/{category_id} | DeleteCategory |
| SquareConnect.V1ItemsApi | deleteDiscount | DELETE /v1/{location_id}/discounts/{discount_id} | DeleteDiscount |
| SquareConnect.V1ItemsApi | deleteFee | DELETE /v1/{location_id}/fees/{fee_id} | DeleteFee |
| SquareConnect.V1ItemsApi | deleteItem | DELETE /v1/{location_id}/items/{item_id} | DeleteItem |
| SquareConnect.V1ItemsApi | deleteModifierList | DELETE /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList |
| SquareConnect.V1ItemsApi | deleteModifierOption | DELETE /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption |
| SquareConnect.V1ItemsApi | deletePage | DELETE /v1/{location_id}/pages/{page_id} | DeletePage |
| SquareConnect.V1ItemsApi | deletePageCell | DELETE /v1/{location_id}/pages/{page_id}/cells | DeletePageCell |
| SquareConnect.V1ItemsApi | deleteVariation | DELETE /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation |
| SquareConnect.V1ItemsApi | listCategories | GET /v1/{location_id}/categories | ListCategories |
| SquareConnect.V1ItemsApi | listDiscounts | GET /v1/{location_id}/discounts | ListDiscounts |
| SquareConnect.V1ItemsApi | listFees | GET /v1/{location_id}/fees | ListFees |
| SquareConnect.V1ItemsApi | listInventory | GET /v1/{location_id}/inventory | ListInventory |
| SquareConnect.V1ItemsApi | listItems | GET /v1/{location_id}/items | ListItems |
| SquareConnect.V1ItemsApi | listModifierLists | GET /v1/{location_id}/modifier-lists | ListModifierLists |
| SquareConnect.V1ItemsApi | listPages | GET /v1/{location_id}/pages | ListPages |
| SquareConnect.V1ItemsApi | removeFee | DELETE /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee |
| SquareConnect.V1ItemsApi | removeModifierList | DELETE /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList |
| SquareConnect.V1ItemsApi | retrieveItem | GET /v1/{location_id}/items/{item_id} | RetrieveItem |
| SquareConnect.V1ItemsApi | retrieveModifierList | GET /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList |
| SquareConnect.V1ItemsApi | updateCategory | PUT /v1/{location_id}/categories/{category_id} | UpdateCategory |
| SquareConnect.V1ItemsApi | updateDiscount | PUT /v1/{location_id}/discounts/{discount_id} | UpdateDiscount |
| SquareConnect.V1ItemsApi | updateFee | PUT /v1/{location_id}/fees/{fee_id} | UpdateFee |
| SquareConnect.V1ItemsApi | updateItem | PUT /v1/{location_id}/items/{item_id} | UpdateItem |
| SquareConnect.V1ItemsApi | updateModifierList | PUT /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList |
| SquareConnect.V1ItemsApi | updateModifierOption | PUT /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption |
| SquareConnect.V1ItemsApi | updatePage | PUT /v1/{location_id}/pages/{page_id} | UpdatePage |
| SquareConnect.V1ItemsApi | updatePageCell | PUT /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell |
| SquareConnect.V1ItemsApi | updateVariation | PUT /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation |
| SquareConnect.V1LocationsApi | listLocations | GET /v1/me/locations | ListLocations |
| SquareConnect.V1LocationsApi | retrieveBusiness | GET /v1/me | RetrieveBusiness |
| SquareConnect.V1TransactionsApi | createRefund | POST /v1/{location_id}/refunds | CreateRefund |
| SquareConnect.V1TransactionsApi | listBankAccounts | GET /v1/{location_id}/bank-accounts | ListBankAccounts |
| SquareConnect.V1TransactionsApi | listOrders | GET /v1/{location_id}/orders | ListOrders |
| SquareConnect.V1TransactionsApi | listPayments | GET /v1/{location_id}/payments | ListPayments |
| SquareConnect.V1TransactionsApi | listRefunds | GET /v1/{location_id}/refunds | ListRefunds |
| SquareConnect.V1TransactionsApi | listSettlements | GET /v1/{location_id}/settlements | ListSettlements |
| SquareConnect.V1TransactionsApi | retrieveBankAccount | GET /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount |
| SquareConnect.V1TransactionsApi | retrieveOrder | GET /v1/{location_id}/orders/{order_id} | RetrieveOrder |
| SquareConnect.V1TransactionsApi | retrievePayment | GET /v1/{location_id}/payments/{payment_id} | RetrievePayment |
| SquareConnect.V1TransactionsApi | retrieveSettlement | GET /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement |
| SquareConnect.V1TransactionsApi | updateOrder | PUT /v1/{location_id}/orders/{order_id} | UpdateOrder |
V1 Endpoints return pagination information via HTTP headers. In order to obtain
response headers and extract the batch_token parameter you will need to follow
the following steps:
Use the full information endpoint methods of each API to get the response HTTP
Headers. They are named as their simple counterpart with a WithHttpInfo suffix.
Hence listEmployeeRoles would be called listEmployeeRolesWithHttpInfo. This
method returns a CompleteResponse object with the response data deserialized along
with a helper to retrieve the token if present.
Use var batchToken = completeResponse.batch_token;
to extract the token and proceed to get the following page if a token is present.
var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";
var api = new SquareConnect.V1EmployeesApi();
var opts = {
order: "order_example",
limit: 56,
batch_token: null
}
function getAllEmployeeRoles(batch_token){
if (batch_token) {
api.listEmployeeRolesWithHttpInfo(opts).then(function(resp) {
var batch_token = resp.batch_token;
opts['batch_token'] = batch_token;
getAllEmployeeRoles(token);
}, function(error) {
console.error(error);
});
}
}
getAllEmployeeRoles(true);
Send bug reports, feature requests, and code contributions to the API specifications repository, as this repository contains only the generated SDK code.
Copyright 2017 Square, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
FAQs
JavaScript client library for the Square Connect v2 API
We found that square-connect demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.