square_connect 2.20190724.0.325 → 2.20190724.0.330
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +123 -728
- data/docs/README.md +762 -0
- metadata +438 -436
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fdc6478a9c1c8a9999e01ec04884d4932b91c29488963ab16d07065cb6f695ee
|
4
|
+
data.tar.gz: e298dab3784df06b8b175f64fa3f222f91fa0c17a75c5d20b260a89083210bfe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f9f63d15bcf8a00074399d908155dea3d9d2b72a3c16ff53c5179f20d35bb05cc3458156cd209c3e377e23700a1681d2fec64fa302b713238dab4a161676d22
|
7
|
+
data.tar.gz: 7b49aea3dcfad4decc92b5d993f9b544ca029018c9d65a7a3bdfb780a9cb4513aaed60785a84b1ce14ddaa5f03e45500d7d6e566c499c2ec9c043d97ed90be21
|
data/README.md
CHANGED
@@ -1,778 +1,173 @@
|
|
1
|
-
|
1
|
+
![Square logo]
|
2
|
+
|
3
|
+
# Square Connect Ruby SDK - RETIRED
|
4
|
+
|
5
|
+
---
|
6
|
+
|
7
|
+
[![Build Status](https://travis-ci.org/square/connect-ruby-sdk.svg?branch=master)](https://travis-ci.org/square/connect-ruby-sdk)
|
8
|
+
[![Gem Version](https://badge.fury.io/rb/square_connect.svg)](https://badge.fury.io/rb/square_connect)
|
9
|
+
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
|
2
10
|
==================
|
3
11
|
|
4
|
-
|
12
|
+
## NOTICE: Square Connect Ruby SDK retired
|
5
13
|
|
6
|
-
|
7
|
-
|
8
|
-
|
14
|
+
The Square Connect Ruby SDK is retired (EOL) as of 2019-08-15 and will no longer
|
15
|
+
receive bug fixes or product updates. To continue receiving API and SDK
|
16
|
+
improvements, please follow the instructions below to migrate to the new
|
17
|
+
[Square Ruby SDK gem].
|
9
18
|
|
10
|
-
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
11
19
|
|
12
|
-
|
13
|
-
|
14
|
-
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
20
|
+
The old Connect SDK documentation is available under the
|
21
|
+
[`/docs` folder](./docs/README.md).
|
15
22
|
|
16
|
-
|
23
|
+
<br/>
|
17
24
|
|
18
25
|
---
|
19
|
-
## NOTICE: New Beta Ruby SDK Availability
|
20
|
-
Square is pleased to announce early access to the beta release of **square.rb**, the new Square Ruby SDK gem. The new **square.rb** gem lets you take payments and run a business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, Orders, and more. This new gem will eventually replace the square_connect gem and this repo.
|
21
26
|
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
27
|
+
* [Migrate to the Square Ruby SDK](#migrate-to-the-square-ruby-sdk)
|
28
|
+
* [Update your bundle](#update-your-bundle)
|
29
|
+
* [Update your code](#update-your-code)
|
30
|
+
* [Example code migration](#example-code-migration)
|
31
|
+
* [Ask the Community](#ask-the-community)
|
32
|
+
|
26
33
|
---
|
27
34
|
|
28
|
-
|
35
|
+
<br/>
|
29
36
|
|
30
|
-
|
31
|
-
The Ruby SDK is published as a gem. Simply run:
|
37
|
+
## Migrate to the Square Ruby SDK
|
32
38
|
|
33
|
-
|
34
|
-
|
35
|
-
|
39
|
+
Follow the instructions below to migrate your apps from the deprecated
|
40
|
+
`square_connect` gem to the new `square.rb` gem.
|
41
|
+
|
42
|
+
### Update your bundle
|
36
43
|
|
37
|
-
|
44
|
+
1. Find the line in your `Gemfile` starting with `gem: 'square_connect'` and
|
45
|
+
change the entire line to `gem: 'square.rb'`.
|
46
|
+
1. Run `bundle` to update your `Gemfile.lock`.
|
38
47
|
|
48
|
+
### Update your code
|
49
|
+
|
50
|
+
1. Change all instances of `require 'square_connect'` to `require 'square'`.
|
51
|
+
1. Replace models with plain Ruby Hash equivalents.
|
52
|
+
1. Update client instantiation to follow the method outlined below.
|
53
|
+
1. Update code for accessing response data to follow the method outlined below.
|
54
|
+
1. Check `response.success?` or `response.error?` rather than rescuing
|
55
|
+
exceptions for flow control.
|
56
|
+
|
57
|
+
To simplify your code, we also recommend that you use method chaining to access
|
58
|
+
APIs instead of explicitly instantiating multiple clients.
|
59
|
+
|
60
|
+
#### Client instantiation
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
require 'square'
|
64
|
+
|
65
|
+
square = Square::Client.new(access_token: 'YOUR ACCESS TOKEN')
|
66
|
+
|
67
|
+
response = square.API.ENDPOINT(body: BODY)
|
39
68
|
```
|
40
|
-
|
69
|
+
|
70
|
+
#### Accessing response data
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
if response.success?
|
74
|
+
p response.data
|
75
|
+
else
|
76
|
+
warn response.errors
|
77
|
+
end
|
41
78
|
```
|
42
79
|
|
43
|
-
|
80
|
+
<br/>
|
44
81
|
|
45
|
-
|
82
|
+
---
|
46
83
|
|
47
|
-
|
84
|
+
<br/>
|
48
85
|
|
49
|
-
|
86
|
+
## Example code migration
|
50
87
|
|
51
|
-
|
88
|
+
As a specific example, consider the following code for creating a new customer
|
89
|
+
from the following Hash:
|
52
90
|
|
53
|
-
```
|
54
|
-
|
91
|
+
```ruby
|
92
|
+
new_customer = {
|
93
|
+
given_name: 'Ava',
|
94
|
+
address: {
|
95
|
+
address_line_1: '555 Electric Ave',
|
96
|
+
locality: 'Los Angeles',
|
97
|
+
country: 'US'
|
98
|
+
}
|
99
|
+
}
|
55
100
|
```
|
56
101
|
|
57
|
-
|
102
|
+
With the deprecated `square_connect` gem, this is how you instantiate a client
|
103
|
+
for the Customers API, format the request, and call the endpoint:
|
58
104
|
|
59
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
60
105
|
```ruby
|
61
|
-
# Load the gem
|
62
106
|
require 'square_connect'
|
63
107
|
|
64
|
-
#
|
108
|
+
# Instantiate the client
|
65
109
|
SquareConnect.configure do |config|
|
66
|
-
# Configure OAuth2 access token for authorization: oauth2
|
67
110
|
config.access_token = 'YOUR ACCESS TOKEN'
|
68
111
|
end
|
69
112
|
|
70
|
-
|
71
|
-
|
72
|
-
|
113
|
+
api_instance = SquareConnect::CustomersApi.new
|
114
|
+
|
115
|
+
# Create the models
|
116
|
+
address = SquareConnect::Address.new(new_customer[:address])
|
117
|
+
|
118
|
+
body = SquareConnect::CreateCustomerRequest.new(
|
119
|
+
given_name: new_customer[:given_name],
|
120
|
+
address: address
|
121
|
+
)
|
122
|
+
|
73
123
|
begin
|
74
|
-
|
75
|
-
|
76
|
-
|
124
|
+
# Call the endpoint
|
125
|
+
response = api_instance.create_customer(body)
|
126
|
+
|
127
|
+
# Handle the response and warn on errors
|
128
|
+
p response.customer.to_hash
|
129
|
+
rescue SquareConnect::ApiError
|
130
|
+
warn response.errors
|
77
131
|
end
|
78
132
|
```
|
79
133
|
|
80
|
-
|
81
|
-
|
82
|
-
All URIs are relative to *https://connect.squareup.com*
|
83
|
-
|
84
|
-
Class | Method | HTTP request | Description
|
85
|
-
------------ | ------------- | ------------- | -------------
|
86
|
-
*SquareConnect::ApplePayApi* | [**register_domain**](docs/ApplePayApi.md#register_domain) | **POST** /v2/apple-pay/domains | RegisterDomain
|
87
|
-
*SquareConnect::CatalogApi* | [**batch_delete_catalog_objects**](docs/CatalogApi.md#batch_delete_catalog_objects) | **POST** /v2/catalog/batch-delete | BatchDeleteCatalogObjects
|
88
|
-
*SquareConnect::CatalogApi* | [**batch_retrieve_catalog_objects**](docs/CatalogApi.md#batch_retrieve_catalog_objects) | **POST** /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects
|
89
|
-
*SquareConnect::CatalogApi* | [**batch_upsert_catalog_objects**](docs/CatalogApi.md#batch_upsert_catalog_objects) | **POST** /v2/catalog/batch-upsert | BatchUpsertCatalogObjects
|
90
|
-
*SquareConnect::CatalogApi* | [**catalog_info**](docs/CatalogApi.md#catalog_info) | **GET** /v2/catalog/info | CatalogInfo
|
91
|
-
*SquareConnect::CatalogApi* | [**delete_catalog_object**](docs/CatalogApi.md#delete_catalog_object) | **DELETE** /v2/catalog/object/{object_id} | DeleteCatalogObject
|
92
|
-
*SquareConnect::CatalogApi* | [**list_catalog**](docs/CatalogApi.md#list_catalog) | **GET** /v2/catalog/list | ListCatalog
|
93
|
-
*SquareConnect::CatalogApi* | [**retrieve_catalog_object**](docs/CatalogApi.md#retrieve_catalog_object) | **GET** /v2/catalog/object/{object_id} | RetrieveCatalogObject
|
94
|
-
*SquareConnect::CatalogApi* | [**search_catalog_objects**](docs/CatalogApi.md#search_catalog_objects) | **POST** /v2/catalog/search | SearchCatalogObjects
|
95
|
-
*SquareConnect::CatalogApi* | [**update_item_modifier_lists**](docs/CatalogApi.md#update_item_modifier_lists) | **POST** /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists
|
96
|
-
*SquareConnect::CatalogApi* | [**update_item_taxes**](docs/CatalogApi.md#update_item_taxes) | **POST** /v2/catalog/update-item-taxes | UpdateItemTaxes
|
97
|
-
*SquareConnect::CatalogApi* | [**upsert_catalog_object**](docs/CatalogApi.md#upsert_catalog_object) | **POST** /v2/catalog/object | UpsertCatalogObject
|
98
|
-
*SquareConnect::CheckoutApi* | [**create_checkout**](docs/CheckoutApi.md#create_checkout) | **POST** /v2/locations/{location_id}/checkouts | CreateCheckout
|
99
|
-
*SquareConnect::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /v2/customers | CreateCustomer
|
100
|
-
*SquareConnect::CustomersApi* | [**create_customer_card**](docs/CustomersApi.md#create_customer_card) | **POST** /v2/customers/{customer_id}/cards | CreateCustomerCard
|
101
|
-
*SquareConnect::CustomersApi* | [**delete_customer**](docs/CustomersApi.md#delete_customer) | **DELETE** /v2/customers/{customer_id} | DeleteCustomer
|
102
|
-
*SquareConnect::CustomersApi* | [**delete_customer_card**](docs/CustomersApi.md#delete_customer_card) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard
|
103
|
-
*SquareConnect::CustomersApi* | [**list_customers**](docs/CustomersApi.md#list_customers) | **GET** /v2/customers | ListCustomers
|
104
|
-
*SquareConnect::CustomersApi* | [**retrieve_customer**](docs/CustomersApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
|
105
|
-
*SquareConnect::CustomersApi* | [**search_customers**](docs/CustomersApi.md#search_customers) | **POST** /v2/customers/search | SearchCustomers
|
106
|
-
*SquareConnect::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
|
107
|
-
*SquareConnect::EmployeesApi* | [**list_employees**](docs/EmployeesApi.md#list_employees) | **GET** /v2/employees | ListEmployees
|
108
|
-
*SquareConnect::EmployeesApi* | [**retrieve_employee**](docs/EmployeesApi.md#retrieve_employee) | **GET** /v2/employees/{id} | RetrieveEmployee
|
109
|
-
*SquareConnect::InventoryApi* | [**batch_change_inventory**](docs/InventoryApi.md#batch_change_inventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory
|
110
|
-
*SquareConnect::InventoryApi* | [**batch_retrieve_inventory_changes**](docs/InventoryApi.md#batch_retrieve_inventory_changes) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges
|
111
|
-
*SquareConnect::InventoryApi* | [**batch_retrieve_inventory_counts**](docs/InventoryApi.md#batch_retrieve_inventory_counts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts
|
112
|
-
*SquareConnect::InventoryApi* | [**retrieve_inventory_adjustment**](docs/InventoryApi.md#retrieve_inventory_adjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment
|
113
|
-
*SquareConnect::InventoryApi* | [**retrieve_inventory_changes**](docs/InventoryApi.md#retrieve_inventory_changes) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges
|
114
|
-
*SquareConnect::InventoryApi* | [**retrieve_inventory_count**](docs/InventoryApi.md#retrieve_inventory_count) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount
|
115
|
-
*SquareConnect::InventoryApi* | [**retrieve_inventory_physical_count**](docs/InventoryApi.md#retrieve_inventory_physical_count) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount
|
116
|
-
*SquareConnect::LaborApi* | [**create_break_type**](docs/LaborApi.md#create_break_type) | **POST** /v2/labor/break-types | CreateBreakType
|
117
|
-
*SquareConnect::LaborApi* | [**create_shift**](docs/LaborApi.md#create_shift) | **POST** /v2/labor/shifts | CreateShift
|
118
|
-
*SquareConnect::LaborApi* | [**delete_break_type**](docs/LaborApi.md#delete_break_type) | **DELETE** /v2/labor/break-types/{id} | DeleteBreakType
|
119
|
-
*SquareConnect::LaborApi* | [**delete_shift**](docs/LaborApi.md#delete_shift) | **DELETE** /v2/labor/shifts/{id} | DeleteShift
|
120
|
-
*SquareConnect::LaborApi* | [**get_break_type**](docs/LaborApi.md#get_break_type) | **GET** /v2/labor/break-types/{id} | GetBreakType
|
121
|
-
*SquareConnect::LaborApi* | [**get_employee_wage**](docs/LaborApi.md#get_employee_wage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage
|
122
|
-
*SquareConnect::LaborApi* | [**get_shift**](docs/LaborApi.md#get_shift) | **GET** /v2/labor/shifts/{id} | GetShift
|
123
|
-
*SquareConnect::LaborApi* | [**list_break_types**](docs/LaborApi.md#list_break_types) | **GET** /v2/labor/break-types | ListBreakTypes
|
124
|
-
*SquareConnect::LaborApi* | [**list_employee_wages**](docs/LaborApi.md#list_employee_wages) | **GET** /v2/labor/employee-wages | ListEmployeeWages
|
125
|
-
*SquareConnect::LaborApi* | [**list_workweek_configs**](docs/LaborApi.md#list_workweek_configs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs
|
126
|
-
*SquareConnect::LaborApi* | [**search_shifts**](docs/LaborApi.md#search_shifts) | **POST** /v2/labor/shifts/search | SearchShifts
|
127
|
-
*SquareConnect::LaborApi* | [**update_break_type**](docs/LaborApi.md#update_break_type) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType
|
128
|
-
*SquareConnect::LaborApi* | [**update_shift**](docs/LaborApi.md#update_shift) | **PUT** /v2/labor/shifts/{id} | UpdateShift
|
129
|
-
*SquareConnect::LaborApi* | [**update_workweek_config**](docs/LaborApi.md#update_workweek_config) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig
|
130
|
-
*SquareConnect::LocationsApi* | [**list_locations**](docs/LocationsApi.md#list_locations) | **GET** /v2/locations | ListLocations
|
131
|
-
*SquareConnect::MobileAuthorizationApi* | [**create_mobile_authorization_code**](docs/MobileAuthorizationApi.md#create_mobile_authorization_code) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode
|
132
|
-
*SquareConnect::OAuthApi* | [**obtain_token**](docs/OAuthApi.md#obtain_token) | **POST** /oauth2/token | ObtainToken
|
133
|
-
*SquareConnect::OAuthApi* | [**renew_token**](docs/OAuthApi.md#renew_token) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken
|
134
|
-
*SquareConnect::OAuthApi* | [**revoke_token**](docs/OAuthApi.md#revoke_token) | **POST** /oauth2/revoke | RevokeToken
|
135
|
-
*SquareConnect::OrdersApi* | [**batch_retrieve_orders**](docs/OrdersApi.md#batch_retrieve_orders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders
|
136
|
-
*SquareConnect::OrdersApi* | [**create_order**](docs/OrdersApi.md#create_order) | **POST** /v2/locations/{location_id}/orders | CreateOrder
|
137
|
-
*SquareConnect::OrdersApi* | [**search_orders**](docs/OrdersApi.md#search_orders) | **POST** /v2/orders/search | SearchOrders
|
138
|
-
*SquareConnect::ReportingApi* | [**list_additional_recipient_receivable_refunds**](docs/ReportingApi.md#list_additional_recipient_receivable_refunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds
|
139
|
-
*SquareConnect::ReportingApi* | [**list_additional_recipient_receivables**](docs/ReportingApi.md#list_additional_recipient_receivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables
|
140
|
-
*SquareConnect::TransactionsApi* | [**capture_transaction**](docs/TransactionsApi.md#capture_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction
|
141
|
-
*SquareConnect::TransactionsApi* | [**charge**](docs/TransactionsApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge
|
142
|
-
*SquareConnect::TransactionsApi* | [**create_refund**](docs/TransactionsApi.md#create_refund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund
|
143
|
-
*SquareConnect::TransactionsApi* | [**list_refunds**](docs/TransactionsApi.md#list_refunds) | **GET** /v2/locations/{location_id}/refunds | ListRefunds
|
144
|
-
*SquareConnect::TransactionsApi* | [**list_transactions**](docs/TransactionsApi.md#list_transactions) | **GET** /v2/locations/{location_id}/transactions | ListTransactions
|
145
|
-
*SquareConnect::TransactionsApi* | [**retrieve_transaction**](docs/TransactionsApi.md#retrieve_transaction) | **GET** /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction
|
146
|
-
*SquareConnect::TransactionsApi* | [**void_transaction**](docs/TransactionsApi.md#void_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction
|
147
|
-
*SquareConnect::V1EmployeesApi* | [**create_employee**](docs/V1EmployeesApi.md#create_employee) | **POST** /v1/me/employees | CreateEmployee
|
148
|
-
*SquareConnect::V1EmployeesApi* | [**create_employee_role**](docs/V1EmployeesApi.md#create_employee_role) | **POST** /v1/me/roles | CreateEmployeeRole
|
149
|
-
*SquareConnect::V1EmployeesApi* | [**create_timecard**](docs/V1EmployeesApi.md#create_timecard) | **POST** /v1/me/timecards | CreateTimecard
|
150
|
-
*SquareConnect::V1EmployeesApi* | [**delete_timecard**](docs/V1EmployeesApi.md#delete_timecard) | **DELETE** /v1/me/timecards/{timecard_id} | DeleteTimecard
|
151
|
-
*SquareConnect::V1EmployeesApi* | [**list_cash_drawer_shifts**](docs/V1EmployeesApi.md#list_cash_drawer_shifts) | **GET** /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts
|
152
|
-
*SquareConnect::V1EmployeesApi* | [**list_employee_roles**](docs/V1EmployeesApi.md#list_employee_roles) | **GET** /v1/me/roles | ListEmployeeRoles
|
153
|
-
*SquareConnect::V1EmployeesApi* | [**list_employees**](docs/V1EmployeesApi.md#list_employees) | **GET** /v1/me/employees | ListEmployees
|
154
|
-
*SquareConnect::V1EmployeesApi* | [**list_timecard_events**](docs/V1EmployeesApi.md#list_timecard_events) | **GET** /v1/me/timecards/{timecard_id}/events | ListTimecardEvents
|
155
|
-
*SquareConnect::V1EmployeesApi* | [**list_timecards**](docs/V1EmployeesApi.md#list_timecards) | **GET** /v1/me/timecards | ListTimecards
|
156
|
-
*SquareConnect::V1EmployeesApi* | [**retrieve_cash_drawer_shift**](docs/V1EmployeesApi.md#retrieve_cash_drawer_shift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift
|
157
|
-
*SquareConnect::V1EmployeesApi* | [**retrieve_employee**](docs/V1EmployeesApi.md#retrieve_employee) | **GET** /v1/me/employees/{employee_id} | RetrieveEmployee
|
158
|
-
*SquareConnect::V1EmployeesApi* | [**retrieve_employee_role**](docs/V1EmployeesApi.md#retrieve_employee_role) | **GET** /v1/me/roles/{role_id} | RetrieveEmployeeRole
|
159
|
-
*SquareConnect::V1EmployeesApi* | [**retrieve_timecard**](docs/V1EmployeesApi.md#retrieve_timecard) | **GET** /v1/me/timecards/{timecard_id} | RetrieveTimecard
|
160
|
-
*SquareConnect::V1EmployeesApi* | [**update_employee**](docs/V1EmployeesApi.md#update_employee) | **PUT** /v1/me/employees/{employee_id} | UpdateEmployee
|
161
|
-
*SquareConnect::V1EmployeesApi* | [**update_employee_role**](docs/V1EmployeesApi.md#update_employee_role) | **PUT** /v1/me/roles/{role_id} | UpdateEmployeeRole
|
162
|
-
*SquareConnect::V1EmployeesApi* | [**update_timecard**](docs/V1EmployeesApi.md#update_timecard) | **PUT** /v1/me/timecards/{timecard_id} | UpdateTimecard
|
163
|
-
*SquareConnect::V1ItemsApi* | [**adjust_inventory**](docs/V1ItemsApi.md#adjust_inventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory
|
164
|
-
*SquareConnect::V1ItemsApi* | [**apply_fee**](docs/V1ItemsApi.md#apply_fee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee
|
165
|
-
*SquareConnect::V1ItemsApi* | [**apply_modifier_list**](docs/V1ItemsApi.md#apply_modifier_list) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList
|
166
|
-
*SquareConnect::V1ItemsApi* | [**create_category**](docs/V1ItemsApi.md#create_category) | **POST** /v1/{location_id}/categories | CreateCategory
|
167
|
-
*SquareConnect::V1ItemsApi* | [**create_discount**](docs/V1ItemsApi.md#create_discount) | **POST** /v1/{location_id}/discounts | CreateDiscount
|
168
|
-
*SquareConnect::V1ItemsApi* | [**create_fee**](docs/V1ItemsApi.md#create_fee) | **POST** /v1/{location_id}/fees | CreateFee
|
169
|
-
*SquareConnect::V1ItemsApi* | [**create_item**](docs/V1ItemsApi.md#create_item) | **POST** /v1/{location_id}/items | CreateItem
|
170
|
-
*SquareConnect::V1ItemsApi* | [**create_modifier_list**](docs/V1ItemsApi.md#create_modifier_list) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList
|
171
|
-
*SquareConnect::V1ItemsApi* | [**create_modifier_option**](docs/V1ItemsApi.md#create_modifier_option) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption
|
172
|
-
*SquareConnect::V1ItemsApi* | [**create_page**](docs/V1ItemsApi.md#create_page) | **POST** /v1/{location_id}/pages | CreatePage
|
173
|
-
*SquareConnect::V1ItemsApi* | [**create_variation**](docs/V1ItemsApi.md#create_variation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation
|
174
|
-
*SquareConnect::V1ItemsApi* | [**delete_category**](docs/V1ItemsApi.md#delete_category) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory
|
175
|
-
*SquareConnect::V1ItemsApi* | [**delete_discount**](docs/V1ItemsApi.md#delete_discount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount
|
176
|
-
*SquareConnect::V1ItemsApi* | [**delete_fee**](docs/V1ItemsApi.md#delete_fee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee
|
177
|
-
*SquareConnect::V1ItemsApi* | [**delete_item**](docs/V1ItemsApi.md#delete_item) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem
|
178
|
-
*SquareConnect::V1ItemsApi* | [**delete_modifier_list**](docs/V1ItemsApi.md#delete_modifier_list) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList
|
179
|
-
*SquareConnect::V1ItemsApi* | [**delete_modifier_option**](docs/V1ItemsApi.md#delete_modifier_option) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption
|
180
|
-
*SquareConnect::V1ItemsApi* | [**delete_page**](docs/V1ItemsApi.md#delete_page) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage
|
181
|
-
*SquareConnect::V1ItemsApi* | [**delete_page_cell**](docs/V1ItemsApi.md#delete_page_cell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell
|
182
|
-
*SquareConnect::V1ItemsApi* | [**delete_variation**](docs/V1ItemsApi.md#delete_variation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation
|
183
|
-
*SquareConnect::V1ItemsApi* | [**list_categories**](docs/V1ItemsApi.md#list_categories) | **GET** /v1/{location_id}/categories | ListCategories
|
184
|
-
*SquareConnect::V1ItemsApi* | [**list_discounts**](docs/V1ItemsApi.md#list_discounts) | **GET** /v1/{location_id}/discounts | ListDiscounts
|
185
|
-
*SquareConnect::V1ItemsApi* | [**list_fees**](docs/V1ItemsApi.md#list_fees) | **GET** /v1/{location_id}/fees | ListFees
|
186
|
-
*SquareConnect::V1ItemsApi* | [**list_inventory**](docs/V1ItemsApi.md#list_inventory) | **GET** /v1/{location_id}/inventory | ListInventory
|
187
|
-
*SquareConnect::V1ItemsApi* | [**list_items**](docs/V1ItemsApi.md#list_items) | **GET** /v1/{location_id}/items | ListItems
|
188
|
-
*SquareConnect::V1ItemsApi* | [**list_modifier_lists**](docs/V1ItemsApi.md#list_modifier_lists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists
|
189
|
-
*SquareConnect::V1ItemsApi* | [**list_pages**](docs/V1ItemsApi.md#list_pages) | **GET** /v1/{location_id}/pages | ListPages
|
190
|
-
*SquareConnect::V1ItemsApi* | [**remove_fee**](docs/V1ItemsApi.md#remove_fee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee
|
191
|
-
*SquareConnect::V1ItemsApi* | [**remove_modifier_list**](docs/V1ItemsApi.md#remove_modifier_list) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList
|
192
|
-
*SquareConnect::V1ItemsApi* | [**retrieve_item**](docs/V1ItemsApi.md#retrieve_item) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem
|
193
|
-
*SquareConnect::V1ItemsApi* | [**retrieve_modifier_list**](docs/V1ItemsApi.md#retrieve_modifier_list) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList
|
194
|
-
*SquareConnect::V1ItemsApi* | [**update_category**](docs/V1ItemsApi.md#update_category) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory
|
195
|
-
*SquareConnect::V1ItemsApi* | [**update_discount**](docs/V1ItemsApi.md#update_discount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount
|
196
|
-
*SquareConnect::V1ItemsApi* | [**update_fee**](docs/V1ItemsApi.md#update_fee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee
|
197
|
-
*SquareConnect::V1ItemsApi* | [**update_item**](docs/V1ItemsApi.md#update_item) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem
|
198
|
-
*SquareConnect::V1ItemsApi* | [**update_modifier_list**](docs/V1ItemsApi.md#update_modifier_list) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList
|
199
|
-
*SquareConnect::V1ItemsApi* | [**update_modifier_option**](docs/V1ItemsApi.md#update_modifier_option) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption
|
200
|
-
*SquareConnect::V1ItemsApi* | [**update_page**](docs/V1ItemsApi.md#update_page) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage
|
201
|
-
*SquareConnect::V1ItemsApi* | [**update_page_cell**](docs/V1ItemsApi.md#update_page_cell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell
|
202
|
-
*SquareConnect::V1ItemsApi* | [**update_variation**](docs/V1ItemsApi.md#update_variation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation
|
203
|
-
*SquareConnect::V1LocationsApi* | [**list_locations**](docs/V1LocationsApi.md#list_locations) | **GET** /v1/me/locations | ListLocations
|
204
|
-
*SquareConnect::V1LocationsApi* | [**retrieve_business**](docs/V1LocationsApi.md#retrieve_business) | **GET** /v1/me | RetrieveBusiness
|
205
|
-
*SquareConnect::V1TransactionsApi* | [**create_refund**](docs/V1TransactionsApi.md#create_refund) | **POST** /v1/{location_id}/refunds | CreateRefund
|
206
|
-
*SquareConnect::V1TransactionsApi* | [**list_bank_accounts**](docs/V1TransactionsApi.md#list_bank_accounts) | **GET** /v1/{location_id}/bank-accounts | ListBankAccounts
|
207
|
-
*SquareConnect::V1TransactionsApi* | [**list_orders**](docs/V1TransactionsApi.md#list_orders) | **GET** /v1/{location_id}/orders | ListOrders
|
208
|
-
*SquareConnect::V1TransactionsApi* | [**list_payments**](docs/V1TransactionsApi.md#list_payments) | **GET** /v1/{location_id}/payments | ListPayments
|
209
|
-
*SquareConnect::V1TransactionsApi* | [**list_refunds**](docs/V1TransactionsApi.md#list_refunds) | **GET** /v1/{location_id}/refunds | ListRefunds
|
210
|
-
*SquareConnect::V1TransactionsApi* | [**list_settlements**](docs/V1TransactionsApi.md#list_settlements) | **GET** /v1/{location_id}/settlements | ListSettlements
|
211
|
-
*SquareConnect::V1TransactionsApi* | [**retrieve_bank_account**](docs/V1TransactionsApi.md#retrieve_bank_account) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount
|
212
|
-
*SquareConnect::V1TransactionsApi* | [**retrieve_order**](docs/V1TransactionsApi.md#retrieve_order) | **GET** /v1/{location_id}/orders/{order_id} | RetrieveOrder
|
213
|
-
*SquareConnect::V1TransactionsApi* | [**retrieve_payment**](docs/V1TransactionsApi.md#retrieve_payment) | **GET** /v1/{location_id}/payments/{payment_id} | RetrievePayment
|
214
|
-
*SquareConnect::V1TransactionsApi* | [**retrieve_settlement**](docs/V1TransactionsApi.md#retrieve_settlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement
|
215
|
-
*SquareConnect::V1TransactionsApi* | [**update_order**](docs/V1TransactionsApi.md#update_order) | **PUT** /v1/{location_id}/orders/{order_id} | UpdateOrder
|
216
|
-
|
217
|
-
|
218
|
-
## Documentation for Models
|
219
|
-
|
220
|
-
- [SquareConnect::AdditionalRecipient](docs/AdditionalRecipient.md)
|
221
|
-
- [SquareConnect::AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
|
222
|
-
- [SquareConnect::AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
|
223
|
-
- [SquareConnect::Address](docs/Address.md)
|
224
|
-
- [SquareConnect::BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md)
|
225
|
-
- [SquareConnect::BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md)
|
226
|
-
- [SquareConnect::BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
|
227
|
-
- [SquareConnect::BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md)
|
228
|
-
- [SquareConnect::BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md)
|
229
|
-
- [SquareConnect::BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md)
|
230
|
-
- [SquareConnect::BatchRetrieveInventoryChangesRequest](docs/BatchRetrieveInventoryChangesRequest.md)
|
231
|
-
- [SquareConnect::BatchRetrieveInventoryChangesResponse](docs/BatchRetrieveInventoryChangesResponse.md)
|
232
|
-
- [SquareConnect::BatchRetrieveInventoryCountsRequest](docs/BatchRetrieveInventoryCountsRequest.md)
|
233
|
-
- [SquareConnect::BatchRetrieveInventoryCountsResponse](docs/BatchRetrieveInventoryCountsResponse.md)
|
234
|
-
- [SquareConnect::BatchRetrieveOrdersRequest](docs/BatchRetrieveOrdersRequest.md)
|
235
|
-
- [SquareConnect::BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md)
|
236
|
-
- [SquareConnect::BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
|
237
|
-
- [SquareConnect::BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md)
|
238
|
-
- [SquareConnect::BreakType](docs/BreakType.md)
|
239
|
-
- [SquareConnect::BusinessHours](docs/BusinessHours.md)
|
240
|
-
- [SquareConnect::BusinessHoursPeriod](docs/BusinessHoursPeriod.md)
|
241
|
-
- [SquareConnect::CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
|
242
|
-
- [SquareConnect::CaptureTransactionResponse](docs/CaptureTransactionResponse.md)
|
243
|
-
- [SquareConnect::Card](docs/Card.md)
|
244
|
-
- [SquareConnect::CardBrand](docs/CardBrand.md)
|
245
|
-
- [SquareConnect::CatalogCategory](docs/CatalogCategory.md)
|
246
|
-
- [SquareConnect::CatalogDiscount](docs/CatalogDiscount.md)
|
247
|
-
- [SquareConnect::CatalogDiscountType](docs/CatalogDiscountType.md)
|
248
|
-
- [SquareConnect::CatalogIdMapping](docs/CatalogIdMapping.md)
|
249
|
-
- [SquareConnect::CatalogImage](docs/CatalogImage.md)
|
250
|
-
- [SquareConnect::CatalogInfoRequest](docs/CatalogInfoRequest.md)
|
251
|
-
- [SquareConnect::CatalogInfoResponse](docs/CatalogInfoResponse.md)
|
252
|
-
- [SquareConnect::CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md)
|
253
|
-
- [SquareConnect::CatalogItem](docs/CatalogItem.md)
|
254
|
-
- [SquareConnect::CatalogItemModifierListInfo](docs/CatalogItemModifierListInfo.md)
|
255
|
-
- [SquareConnect::CatalogItemOption](docs/CatalogItemOption.md)
|
256
|
-
- [SquareConnect::CatalogItemOptionForItem](docs/CatalogItemOptionForItem.md)
|
257
|
-
- [SquareConnect::CatalogItemOptionValue](docs/CatalogItemOptionValue.md)
|
258
|
-
- [SquareConnect::CatalogItemOptionValueForItemVariation](docs/CatalogItemOptionValueForItemVariation.md)
|
259
|
-
- [SquareConnect::CatalogItemProductType](docs/CatalogItemProductType.md)
|
260
|
-
- [SquareConnect::CatalogItemVariation](docs/CatalogItemVariation.md)
|
261
|
-
- [SquareConnect::CatalogMeasurementUnit](docs/CatalogMeasurementUnit.md)
|
262
|
-
- [SquareConnect::CatalogModifier](docs/CatalogModifier.md)
|
263
|
-
- [SquareConnect::CatalogModifierList](docs/CatalogModifierList.md)
|
264
|
-
- [SquareConnect::CatalogModifierListSelectionType](docs/CatalogModifierListSelectionType.md)
|
265
|
-
- [SquareConnect::CatalogModifierOverride](docs/CatalogModifierOverride.md)
|
266
|
-
- [SquareConnect::CatalogObject](docs/CatalogObject.md)
|
267
|
-
- [SquareConnect::CatalogObjectBatch](docs/CatalogObjectBatch.md)
|
268
|
-
- [SquareConnect::CatalogObjectType](docs/CatalogObjectType.md)
|
269
|
-
- [SquareConnect::CatalogPricingRule](docs/CatalogPricingRule.md)
|
270
|
-
- [SquareConnect::CatalogPricingType](docs/CatalogPricingType.md)
|
271
|
-
- [SquareConnect::CatalogProductSet](docs/CatalogProductSet.md)
|
272
|
-
- [SquareConnect::CatalogQuery](docs/CatalogQuery.md)
|
273
|
-
- [SquareConnect::CatalogQueryExact](docs/CatalogQueryExact.md)
|
274
|
-
- [SquareConnect::CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md)
|
275
|
-
- [SquareConnect::CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md)
|
276
|
-
- [SquareConnect::CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md)
|
277
|
-
- [SquareConnect::CatalogQueryItemsForTax](docs/CatalogQueryItemsForTax.md)
|
278
|
-
- [SquareConnect::CatalogQueryPrefix](docs/CatalogQueryPrefix.md)
|
279
|
-
- [SquareConnect::CatalogQueryRange](docs/CatalogQueryRange.md)
|
280
|
-
- [SquareConnect::CatalogQuerySortedAttribute](docs/CatalogQuerySortedAttribute.md)
|
281
|
-
- [SquareConnect::CatalogQueryText](docs/CatalogQueryText.md)
|
282
|
-
- [SquareConnect::CatalogTax](docs/CatalogTax.md)
|
283
|
-
- [SquareConnect::CatalogTimePeriod](docs/CatalogTimePeriod.md)
|
284
|
-
- [SquareConnect::CatalogV1Id](docs/CatalogV1Id.md)
|
285
|
-
- [SquareConnect::ChargeRequest](docs/ChargeRequest.md)
|
286
|
-
- [SquareConnect::ChargeRequestAdditionalRecipient](docs/ChargeRequestAdditionalRecipient.md)
|
287
|
-
- [SquareConnect::ChargeResponse](docs/ChargeResponse.md)
|
288
|
-
- [SquareConnect::Checkout](docs/Checkout.md)
|
289
|
-
- [SquareConnect::Coordinates](docs/Coordinates.md)
|
290
|
-
- [SquareConnect::Country](docs/Country.md)
|
291
|
-
- [SquareConnect::CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md)
|
292
|
-
- [SquareConnect::CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md)
|
293
|
-
- [SquareConnect::CreateCheckoutRequest](docs/CreateCheckoutRequest.md)
|
294
|
-
- [SquareConnect::CreateCheckoutResponse](docs/CreateCheckoutResponse.md)
|
295
|
-
- [SquareConnect::CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md)
|
296
|
-
- [SquareConnect::CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md)
|
297
|
-
- [SquareConnect::CreateCustomerRequest](docs/CreateCustomerRequest.md)
|
298
|
-
- [SquareConnect::CreateCustomerResponse](docs/CreateCustomerResponse.md)
|
299
|
-
- [SquareConnect::CreateMobileAuthorizationCodeRequest](docs/CreateMobileAuthorizationCodeRequest.md)
|
300
|
-
- [SquareConnect::CreateMobileAuthorizationCodeResponse](docs/CreateMobileAuthorizationCodeResponse.md)
|
301
|
-
- [SquareConnect::CreateOrderRequest](docs/CreateOrderRequest.md)
|
302
|
-
- [SquareConnect::CreateOrderRequestDiscount](docs/CreateOrderRequestDiscount.md)
|
303
|
-
- [SquareConnect::CreateOrderRequestLineItem](docs/CreateOrderRequestLineItem.md)
|
304
|
-
- [SquareConnect::CreateOrderRequestModifier](docs/CreateOrderRequestModifier.md)
|
305
|
-
- [SquareConnect::CreateOrderRequestTax](docs/CreateOrderRequestTax.md)
|
306
|
-
- [SquareConnect::CreateOrderResponse](docs/CreateOrderResponse.md)
|
307
|
-
- [SquareConnect::CreateRefundRequest](docs/CreateRefundRequest.md)
|
308
|
-
- [SquareConnect::CreateRefundResponse](docs/CreateRefundResponse.md)
|
309
|
-
- [SquareConnect::CreateShiftRequest](docs/CreateShiftRequest.md)
|
310
|
-
- [SquareConnect::CreateShiftResponse](docs/CreateShiftResponse.md)
|
311
|
-
- [SquareConnect::Currency](docs/Currency.md)
|
312
|
-
- [SquareConnect::Customer](docs/Customer.md)
|
313
|
-
- [SquareConnect::CustomerCreationSource](docs/CustomerCreationSource.md)
|
314
|
-
- [SquareConnect::CustomerCreationSourceFilter](docs/CustomerCreationSourceFilter.md)
|
315
|
-
- [SquareConnect::CustomerFilter](docs/CustomerFilter.md)
|
316
|
-
- [SquareConnect::CustomerGroupInfo](docs/CustomerGroupInfo.md)
|
317
|
-
- [SquareConnect::CustomerInclusionExclusion](docs/CustomerInclusionExclusion.md)
|
318
|
-
- [SquareConnect::CustomerPreferences](docs/CustomerPreferences.md)
|
319
|
-
- [SquareConnect::CustomerQuery](docs/CustomerQuery.md)
|
320
|
-
- [SquareConnect::CustomerSort](docs/CustomerSort.md)
|
321
|
-
- [SquareConnect::CustomerSortField](docs/CustomerSortField.md)
|
322
|
-
- [SquareConnect::DateRange](docs/DateRange.md)
|
323
|
-
- [SquareConnect::DayOfWeek](docs/DayOfWeek.md)
|
324
|
-
- [SquareConnect::DeleteBreakTypeRequest](docs/DeleteBreakTypeRequest.md)
|
325
|
-
- [SquareConnect::DeleteBreakTypeResponse](docs/DeleteBreakTypeResponse.md)
|
326
|
-
- [SquareConnect::DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md)
|
327
|
-
- [SquareConnect::DeleteCatalogObjectResponse](docs/DeleteCatalogObjectResponse.md)
|
328
|
-
- [SquareConnect::DeleteCustomerCardRequest](docs/DeleteCustomerCardRequest.md)
|
329
|
-
- [SquareConnect::DeleteCustomerCardResponse](docs/DeleteCustomerCardResponse.md)
|
330
|
-
- [SquareConnect::DeleteCustomerRequest](docs/DeleteCustomerRequest.md)
|
331
|
-
- [SquareConnect::DeleteCustomerResponse](docs/DeleteCustomerResponse.md)
|
332
|
-
- [SquareConnect::DeleteShiftRequest](docs/DeleteShiftRequest.md)
|
333
|
-
- [SquareConnect::DeleteShiftResponse](docs/DeleteShiftResponse.md)
|
334
|
-
- [SquareConnect::Device](docs/Device.md)
|
335
|
-
- [SquareConnect::Employee](docs/Employee.md)
|
336
|
-
- [SquareConnect::EmployeeStatus](docs/EmployeeStatus.md)
|
337
|
-
- [SquareConnect::EmployeeWage](docs/EmployeeWage.md)
|
338
|
-
- [SquareConnect::Error](docs/Error.md)
|
339
|
-
- [SquareConnect::ErrorCategory](docs/ErrorCategory.md)
|
340
|
-
- [SquareConnect::ErrorCode](docs/ErrorCode.md)
|
341
|
-
- [SquareConnect::GetBreakTypeRequest](docs/GetBreakTypeRequest.md)
|
342
|
-
- [SquareConnect::GetBreakTypeResponse](docs/GetBreakTypeResponse.md)
|
343
|
-
- [SquareConnect::GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md)
|
344
|
-
- [SquareConnect::GetEmployeeWageResponse](docs/GetEmployeeWageResponse.md)
|
345
|
-
- [SquareConnect::GetShiftRequest](docs/GetShiftRequest.md)
|
346
|
-
- [SquareConnect::GetShiftResponse](docs/GetShiftResponse.md)
|
347
|
-
- [SquareConnect::InventoryAdjustment](docs/InventoryAdjustment.md)
|
348
|
-
- [SquareConnect::InventoryAlertType](docs/InventoryAlertType.md)
|
349
|
-
- [SquareConnect::InventoryChange](docs/InventoryChange.md)
|
350
|
-
- [SquareConnect::InventoryChangeType](docs/InventoryChangeType.md)
|
351
|
-
- [SquareConnect::InventoryCount](docs/InventoryCount.md)
|
352
|
-
- [SquareConnect::InventoryPhysicalCount](docs/InventoryPhysicalCount.md)
|
353
|
-
- [SquareConnect::InventoryState](docs/InventoryState.md)
|
354
|
-
- [SquareConnect::InventoryTransfer](docs/InventoryTransfer.md)
|
355
|
-
- [SquareConnect::ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
|
356
|
-
- [SquareConnect::ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md)
|
357
|
-
- [SquareConnect::ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md)
|
358
|
-
- [SquareConnect::ListAdditionalRecipientReceivablesRequest](docs/ListAdditionalRecipientReceivablesRequest.md)
|
359
|
-
- [SquareConnect::ListAdditionalRecipientReceivablesResponse](docs/ListAdditionalRecipientReceivablesResponse.md)
|
360
|
-
- [SquareConnect::ListBreakTypesRequest](docs/ListBreakTypesRequest.md)
|
361
|
-
- [SquareConnect::ListBreakTypesResponse](docs/ListBreakTypesResponse.md)
|
362
|
-
- [SquareConnect::ListCatalogRequest](docs/ListCatalogRequest.md)
|
363
|
-
- [SquareConnect::ListCatalogResponse](docs/ListCatalogResponse.md)
|
364
|
-
- [SquareConnect::ListCustomersRequest](docs/ListCustomersRequest.md)
|
365
|
-
- [SquareConnect::ListCustomersResponse](docs/ListCustomersResponse.md)
|
366
|
-
- [SquareConnect::ListEmployeeWagesRequest](docs/ListEmployeeWagesRequest.md)
|
367
|
-
- [SquareConnect::ListEmployeeWagesResponse](docs/ListEmployeeWagesResponse.md)
|
368
|
-
- [SquareConnect::ListEmployeesRequest](docs/ListEmployeesRequest.md)
|
369
|
-
- [SquareConnect::ListEmployeesResponse](docs/ListEmployeesResponse.md)
|
370
|
-
- [SquareConnect::ListLocationsRequest](docs/ListLocationsRequest.md)
|
371
|
-
- [SquareConnect::ListLocationsResponse](docs/ListLocationsResponse.md)
|
372
|
-
- [SquareConnect::ListRefundsRequest](docs/ListRefundsRequest.md)
|
373
|
-
- [SquareConnect::ListRefundsResponse](docs/ListRefundsResponse.md)
|
374
|
-
- [SquareConnect::ListTransactionsRequest](docs/ListTransactionsRequest.md)
|
375
|
-
- [SquareConnect::ListTransactionsResponse](docs/ListTransactionsResponse.md)
|
376
|
-
- [SquareConnect::ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md)
|
377
|
-
- [SquareConnect::ListWorkweekConfigsResponse](docs/ListWorkweekConfigsResponse.md)
|
378
|
-
- [SquareConnect::Location](docs/Location.md)
|
379
|
-
- [SquareConnect::LocationCapability](docs/LocationCapability.md)
|
380
|
-
- [SquareConnect::LocationStatus](docs/LocationStatus.md)
|
381
|
-
- [SquareConnect::LocationType](docs/LocationType.md)
|
382
|
-
- [SquareConnect::MeasurementUnit](docs/MeasurementUnit.md)
|
383
|
-
- [SquareConnect::MeasurementUnitArea](docs/MeasurementUnitArea.md)
|
384
|
-
- [SquareConnect::MeasurementUnitCustom](docs/MeasurementUnitCustom.md)
|
385
|
-
- [SquareConnect::MeasurementUnitGeneric](docs/MeasurementUnitGeneric.md)
|
386
|
-
- [SquareConnect::MeasurementUnitLength](docs/MeasurementUnitLength.md)
|
387
|
-
- [SquareConnect::MeasurementUnitVolume](docs/MeasurementUnitVolume.md)
|
388
|
-
- [SquareConnect::MeasurementUnitWeight](docs/MeasurementUnitWeight.md)
|
389
|
-
- [SquareConnect::ModelBreak](docs/ModelBreak.md)
|
390
|
-
- [SquareConnect::Money](docs/Money.md)
|
391
|
-
- [SquareConnect::ObtainTokenRequest](docs/ObtainTokenRequest.md)
|
392
|
-
- [SquareConnect::ObtainTokenResponse](docs/ObtainTokenResponse.md)
|
393
|
-
- [SquareConnect::Order](docs/Order.md)
|
394
|
-
- [SquareConnect::OrderEntry](docs/OrderEntry.md)
|
395
|
-
- [SquareConnect::OrderFulfillment](docs/OrderFulfillment.md)
|
396
|
-
- [SquareConnect::OrderFulfillmentPickupDetails](docs/OrderFulfillmentPickupDetails.md)
|
397
|
-
- [SquareConnect::OrderFulfillmentPickupDetailsScheduleType](docs/OrderFulfillmentPickupDetailsScheduleType.md)
|
398
|
-
- [SquareConnect::OrderFulfillmentRecipient](docs/OrderFulfillmentRecipient.md)
|
399
|
-
- [SquareConnect::OrderFulfillmentState](docs/OrderFulfillmentState.md)
|
400
|
-
- [SquareConnect::OrderFulfillmentType](docs/OrderFulfillmentType.md)
|
401
|
-
- [SquareConnect::OrderLineItem](docs/OrderLineItem.md)
|
402
|
-
- [SquareConnect::OrderLineItemDiscount](docs/OrderLineItemDiscount.md)
|
403
|
-
- [SquareConnect::OrderLineItemDiscountScope](docs/OrderLineItemDiscountScope.md)
|
404
|
-
- [SquareConnect::OrderLineItemDiscountType](docs/OrderLineItemDiscountType.md)
|
405
|
-
- [SquareConnect::OrderLineItemModifier](docs/OrderLineItemModifier.md)
|
406
|
-
- [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
|
407
|
-
- [SquareConnect::OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md)
|
408
|
-
- [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
|
409
|
-
- [SquareConnect::OrderMoneyAmounts](docs/OrderMoneyAmounts.md)
|
410
|
-
- [SquareConnect::OrderQuantityUnit](docs/OrderQuantityUnit.md)
|
411
|
-
- [SquareConnect::OrderReturn](docs/OrderReturn.md)
|
412
|
-
- [SquareConnect::OrderReturnDiscount](docs/OrderReturnDiscount.md)
|
413
|
-
- [SquareConnect::OrderReturnLineItem](docs/OrderReturnLineItem.md)
|
414
|
-
- [SquareConnect::OrderReturnLineItemModifier](docs/OrderReturnLineItemModifier.md)
|
415
|
-
- [SquareConnect::OrderReturnServiceCharge](docs/OrderReturnServiceCharge.md)
|
416
|
-
- [SquareConnect::OrderReturnTax](docs/OrderReturnTax.md)
|
417
|
-
- [SquareConnect::OrderRoundingAdjustment](docs/OrderRoundingAdjustment.md)
|
418
|
-
- [SquareConnect::OrderServiceCharge](docs/OrderServiceCharge.md)
|
419
|
-
- [SquareConnect::OrderServiceChargeCalculationPhase](docs/OrderServiceChargeCalculationPhase.md)
|
420
|
-
- [SquareConnect::OrderSource](docs/OrderSource.md)
|
421
|
-
- [SquareConnect::OrderState](docs/OrderState.md)
|
422
|
-
- [SquareConnect::Product](docs/Product.md)
|
423
|
-
- [SquareConnect::Refund](docs/Refund.md)
|
424
|
-
- [SquareConnect::RefundStatus](docs/RefundStatus.md)
|
425
|
-
- [SquareConnect::RegisterDomainRequest](docs/RegisterDomainRequest.md)
|
426
|
-
- [SquareConnect::RegisterDomainResponse](docs/RegisterDomainResponse.md)
|
427
|
-
- [SquareConnect::RegisterDomainResponseStatus](docs/RegisterDomainResponseStatus.md)
|
428
|
-
- [SquareConnect::RenewTokenRequest](docs/RenewTokenRequest.md)
|
429
|
-
- [SquareConnect::RenewTokenResponse](docs/RenewTokenResponse.md)
|
430
|
-
- [SquareConnect::RetrieveCatalogObjectRequest](docs/RetrieveCatalogObjectRequest.md)
|
431
|
-
- [SquareConnect::RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md)
|
432
|
-
- [SquareConnect::RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md)
|
433
|
-
- [SquareConnect::RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md)
|
434
|
-
- [SquareConnect::RetrieveEmployeeRequest](docs/RetrieveEmployeeRequest.md)
|
435
|
-
- [SquareConnect::RetrieveEmployeeResponse](docs/RetrieveEmployeeResponse.md)
|
436
|
-
- [SquareConnect::RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md)
|
437
|
-
- [SquareConnect::RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md)
|
438
|
-
- [SquareConnect::RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md)
|
439
|
-
- [SquareConnect::RetrieveInventoryChangesResponse](docs/RetrieveInventoryChangesResponse.md)
|
440
|
-
- [SquareConnect::RetrieveInventoryCountRequest](docs/RetrieveInventoryCountRequest.md)
|
441
|
-
- [SquareConnect::RetrieveInventoryCountResponse](docs/RetrieveInventoryCountResponse.md)
|
442
|
-
- [SquareConnect::RetrieveInventoryPhysicalCountRequest](docs/RetrieveInventoryPhysicalCountRequest.md)
|
443
|
-
- [SquareConnect::RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md)
|
444
|
-
- [SquareConnect::RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
|
445
|
-
- [SquareConnect::RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
|
446
|
-
- [SquareConnect::RevokeTokenRequest](docs/RevokeTokenRequest.md)
|
447
|
-
- [SquareConnect::RevokeTokenResponse](docs/RevokeTokenResponse.md)
|
448
|
-
- [SquareConnect::SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md)
|
449
|
-
- [SquareConnect::SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md)
|
450
|
-
- [SquareConnect::SearchCustomersRequest](docs/SearchCustomersRequest.md)
|
451
|
-
- [SquareConnect::SearchCustomersResponse](docs/SearchCustomersResponse.md)
|
452
|
-
- [SquareConnect::SearchOrdersCustomerFilter](docs/SearchOrdersCustomerFilter.md)
|
453
|
-
- [SquareConnect::SearchOrdersDateTimeFilter](docs/SearchOrdersDateTimeFilter.md)
|
454
|
-
- [SquareConnect::SearchOrdersFilter](docs/SearchOrdersFilter.md)
|
455
|
-
- [SquareConnect::SearchOrdersFulfillmentFilter](docs/SearchOrdersFulfillmentFilter.md)
|
456
|
-
- [SquareConnect::SearchOrdersQuery](docs/SearchOrdersQuery.md)
|
457
|
-
- [SquareConnect::SearchOrdersRequest](docs/SearchOrdersRequest.md)
|
458
|
-
- [SquareConnect::SearchOrdersResponse](docs/SearchOrdersResponse.md)
|
459
|
-
- [SquareConnect::SearchOrdersSort](docs/SearchOrdersSort.md)
|
460
|
-
- [SquareConnect::SearchOrdersSortField](docs/SearchOrdersSortField.md)
|
461
|
-
- [SquareConnect::SearchOrdersSourceFilter](docs/SearchOrdersSourceFilter.md)
|
462
|
-
- [SquareConnect::SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md)
|
463
|
-
- [SquareConnect::SearchShiftsRequest](docs/SearchShiftsRequest.md)
|
464
|
-
- [SquareConnect::SearchShiftsResponse](docs/SearchShiftsResponse.md)
|
465
|
-
- [SquareConnect::Shift](docs/Shift.md)
|
466
|
-
- [SquareConnect::ShiftFilter](docs/ShiftFilter.md)
|
467
|
-
- [SquareConnect::ShiftFilterStatus](docs/ShiftFilterStatus.md)
|
468
|
-
- [SquareConnect::ShiftQuery](docs/ShiftQuery.md)
|
469
|
-
- [SquareConnect::ShiftSort](docs/ShiftSort.md)
|
470
|
-
- [SquareConnect::ShiftSortField](docs/ShiftSortField.md)
|
471
|
-
- [SquareConnect::ShiftStatus](docs/ShiftStatus.md)
|
472
|
-
- [SquareConnect::ShiftWage](docs/ShiftWage.md)
|
473
|
-
- [SquareConnect::ShiftWorkday](docs/ShiftWorkday.md)
|
474
|
-
- [SquareConnect::ShiftWorkdayMatcher](docs/ShiftWorkdayMatcher.md)
|
475
|
-
- [SquareConnect::SortOrder](docs/SortOrder.md)
|
476
|
-
- [SquareConnect::SourceApplication](docs/SourceApplication.md)
|
477
|
-
- [SquareConnect::StandardUnitDescription](docs/StandardUnitDescription.md)
|
478
|
-
- [SquareConnect::StandardUnitDescriptionGroup](docs/StandardUnitDescriptionGroup.md)
|
479
|
-
- [SquareConnect::TaxCalculationPhase](docs/TaxCalculationPhase.md)
|
480
|
-
- [SquareConnect::TaxInclusionType](docs/TaxInclusionType.md)
|
481
|
-
- [SquareConnect::Tender](docs/Tender.md)
|
482
|
-
- [SquareConnect::TenderCardDetails](docs/TenderCardDetails.md)
|
483
|
-
- [SquareConnect::TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md)
|
484
|
-
- [SquareConnect::TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md)
|
485
|
-
- [SquareConnect::TenderCashDetails](docs/TenderCashDetails.md)
|
486
|
-
- [SquareConnect::TenderType](docs/TenderType.md)
|
487
|
-
- [SquareConnect::TimeRange](docs/TimeRange.md)
|
488
|
-
- [SquareConnect::Transaction](docs/Transaction.md)
|
489
|
-
- [SquareConnect::TransactionProduct](docs/TransactionProduct.md)
|
490
|
-
- [SquareConnect::UpdateBreakTypeRequest](docs/UpdateBreakTypeRequest.md)
|
491
|
-
- [SquareConnect::UpdateBreakTypeResponse](docs/UpdateBreakTypeResponse.md)
|
492
|
-
- [SquareConnect::UpdateCustomerRequest](docs/UpdateCustomerRequest.md)
|
493
|
-
- [SquareConnect::UpdateCustomerResponse](docs/UpdateCustomerResponse.md)
|
494
|
-
- [SquareConnect::UpdateItemModifierListsRequest](docs/UpdateItemModifierListsRequest.md)
|
495
|
-
- [SquareConnect::UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md)
|
496
|
-
- [SquareConnect::UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md)
|
497
|
-
- [SquareConnect::UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md)
|
498
|
-
- [SquareConnect::UpdateShiftRequest](docs/UpdateShiftRequest.md)
|
499
|
-
- [SquareConnect::UpdateShiftResponse](docs/UpdateShiftResponse.md)
|
500
|
-
- [SquareConnect::UpdateWorkweekConfigRequest](docs/UpdateWorkweekConfigRequest.md)
|
501
|
-
- [SquareConnect::UpdateWorkweekConfigResponse](docs/UpdateWorkweekConfigResponse.md)
|
502
|
-
- [SquareConnect::UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md)
|
503
|
-
- [SquareConnect::UpsertCatalogObjectResponse](docs/UpsertCatalogObjectResponse.md)
|
504
|
-
- [SquareConnect::V1AdjustInventoryRequest](docs/V1AdjustInventoryRequest.md)
|
505
|
-
- [SquareConnect::V1AdjustInventoryRequestAdjustmentType](docs/V1AdjustInventoryRequestAdjustmentType.md)
|
506
|
-
- [SquareConnect::V1ApplyFeeRequest](docs/V1ApplyFeeRequest.md)
|
507
|
-
- [SquareConnect::V1ApplyModifierListRequest](docs/V1ApplyModifierListRequest.md)
|
508
|
-
- [SquareConnect::V1BankAccount](docs/V1BankAccount.md)
|
509
|
-
- [SquareConnect::V1BankAccountType](docs/V1BankAccountType.md)
|
510
|
-
- [SquareConnect::V1CashDrawerEvent](docs/V1CashDrawerEvent.md)
|
511
|
-
- [SquareConnect::V1CashDrawerEventEventType](docs/V1CashDrawerEventEventType.md)
|
512
|
-
- [SquareConnect::V1CashDrawerShift](docs/V1CashDrawerShift.md)
|
513
|
-
- [SquareConnect::V1CashDrawerShiftEventType](docs/V1CashDrawerShiftEventType.md)
|
514
|
-
- [SquareConnect::V1Category](docs/V1Category.md)
|
515
|
-
- [SquareConnect::V1CreateCategoryRequest](docs/V1CreateCategoryRequest.md)
|
516
|
-
- [SquareConnect::V1CreateDiscountRequest](docs/V1CreateDiscountRequest.md)
|
517
|
-
- [SquareConnect::V1CreateEmployeeRoleRequest](docs/V1CreateEmployeeRoleRequest.md)
|
518
|
-
- [SquareConnect::V1CreateFeeRequest](docs/V1CreateFeeRequest.md)
|
519
|
-
- [SquareConnect::V1CreateItemRequest](docs/V1CreateItemRequest.md)
|
520
|
-
- [SquareConnect::V1CreateModifierListRequest](docs/V1CreateModifierListRequest.md)
|
521
|
-
- [SquareConnect::V1CreateModifierOptionRequest](docs/V1CreateModifierOptionRequest.md)
|
522
|
-
- [SquareConnect::V1CreatePageRequest](docs/V1CreatePageRequest.md)
|
523
|
-
- [SquareConnect::V1CreateRefundRequest](docs/V1CreateRefundRequest.md)
|
524
|
-
- [SquareConnect::V1CreateRefundRequestType](docs/V1CreateRefundRequestType.md)
|
525
|
-
- [SquareConnect::V1CreateVariationRequest](docs/V1CreateVariationRequest.md)
|
526
|
-
- [SquareConnect::V1DeleteCategoryRequest](docs/V1DeleteCategoryRequest.md)
|
527
|
-
- [SquareConnect::V1DeleteDiscountRequest](docs/V1DeleteDiscountRequest.md)
|
528
|
-
- [SquareConnect::V1DeleteFeeRequest](docs/V1DeleteFeeRequest.md)
|
529
|
-
- [SquareConnect::V1DeleteItemRequest](docs/V1DeleteItemRequest.md)
|
530
|
-
- [SquareConnect::V1DeleteModifierListRequest](docs/V1DeleteModifierListRequest.md)
|
531
|
-
- [SquareConnect::V1DeleteModifierOptionRequest](docs/V1DeleteModifierOptionRequest.md)
|
532
|
-
- [SquareConnect::V1DeletePageCellRequest](docs/V1DeletePageCellRequest.md)
|
533
|
-
- [SquareConnect::V1DeletePageRequest](docs/V1DeletePageRequest.md)
|
534
|
-
- [SquareConnect::V1DeleteTimecardRequest](docs/V1DeleteTimecardRequest.md)
|
535
|
-
- [SquareConnect::V1DeleteTimecardResponse](docs/V1DeleteTimecardResponse.md)
|
536
|
-
- [SquareConnect::V1DeleteVariationRequest](docs/V1DeleteVariationRequest.md)
|
537
|
-
- [SquareConnect::V1Discount](docs/V1Discount.md)
|
538
|
-
- [SquareConnect::V1DiscountColor](docs/V1DiscountColor.md)
|
539
|
-
- [SquareConnect::V1DiscountDiscountType](docs/V1DiscountDiscountType.md)
|
540
|
-
- [SquareConnect::V1Employee](docs/V1Employee.md)
|
541
|
-
- [SquareConnect::V1EmployeeRole](docs/V1EmployeeRole.md)
|
542
|
-
- [SquareConnect::V1EmployeeRolePermissions](docs/V1EmployeeRolePermissions.md)
|
543
|
-
- [SquareConnect::V1EmployeeStatus](docs/V1EmployeeStatus.md)
|
544
|
-
- [SquareConnect::V1Fee](docs/V1Fee.md)
|
545
|
-
- [SquareConnect::V1FeeAdjustmentType](docs/V1FeeAdjustmentType.md)
|
546
|
-
- [SquareConnect::V1FeeCalculationPhase](docs/V1FeeCalculationPhase.md)
|
547
|
-
- [SquareConnect::V1FeeInclusionType](docs/V1FeeInclusionType.md)
|
548
|
-
- [SquareConnect::V1FeeType](docs/V1FeeType.md)
|
549
|
-
- [SquareConnect::V1InventoryEntry](docs/V1InventoryEntry.md)
|
550
|
-
- [SquareConnect::V1Item](docs/V1Item.md)
|
551
|
-
- [SquareConnect::V1ItemColor](docs/V1ItemColor.md)
|
552
|
-
- [SquareConnect::V1ItemImage](docs/V1ItemImage.md)
|
553
|
-
- [SquareConnect::V1ItemType](docs/V1ItemType.md)
|
554
|
-
- [SquareConnect::V1ItemVisibility](docs/V1ItemVisibility.md)
|
555
|
-
- [SquareConnect::V1ListBankAccountsRequest](docs/V1ListBankAccountsRequest.md)
|
556
|
-
- [SquareConnect::V1ListBankAccountsResponse](docs/V1ListBankAccountsResponse.md)
|
557
|
-
- [SquareConnect::V1ListCashDrawerShiftsRequest](docs/V1ListCashDrawerShiftsRequest.md)
|
558
|
-
- [SquareConnect::V1ListCashDrawerShiftsResponse](docs/V1ListCashDrawerShiftsResponse.md)
|
559
|
-
- [SquareConnect::V1ListCategoriesRequest](docs/V1ListCategoriesRequest.md)
|
560
|
-
- [SquareConnect::V1ListCategoriesResponse](docs/V1ListCategoriesResponse.md)
|
561
|
-
- [SquareConnect::V1ListDiscountsRequest](docs/V1ListDiscountsRequest.md)
|
562
|
-
- [SquareConnect::V1ListDiscountsResponse](docs/V1ListDiscountsResponse.md)
|
563
|
-
- [SquareConnect::V1ListEmployeeRolesRequest](docs/V1ListEmployeeRolesRequest.md)
|
564
|
-
- [SquareConnect::V1ListEmployeeRolesResponse](docs/V1ListEmployeeRolesResponse.md)
|
565
|
-
- [SquareConnect::V1ListEmployeesRequest](docs/V1ListEmployeesRequest.md)
|
566
|
-
- [SquareConnect::V1ListEmployeesRequestStatus](docs/V1ListEmployeesRequestStatus.md)
|
567
|
-
- [SquareConnect::V1ListEmployeesResponse](docs/V1ListEmployeesResponse.md)
|
568
|
-
- [SquareConnect::V1ListFeesRequest](docs/V1ListFeesRequest.md)
|
569
|
-
- [SquareConnect::V1ListFeesResponse](docs/V1ListFeesResponse.md)
|
570
|
-
- [SquareConnect::V1ListInventoryRequest](docs/V1ListInventoryRequest.md)
|
571
|
-
- [SquareConnect::V1ListInventoryResponse](docs/V1ListInventoryResponse.md)
|
572
|
-
- [SquareConnect::V1ListItemsRequest](docs/V1ListItemsRequest.md)
|
573
|
-
- [SquareConnect::V1ListItemsResponse](docs/V1ListItemsResponse.md)
|
574
|
-
- [SquareConnect::V1ListLocationsRequest](docs/V1ListLocationsRequest.md)
|
575
|
-
- [SquareConnect::V1ListLocationsResponse](docs/V1ListLocationsResponse.md)
|
576
|
-
- [SquareConnect::V1ListModifierListsRequest](docs/V1ListModifierListsRequest.md)
|
577
|
-
- [SquareConnect::V1ListModifierListsResponse](docs/V1ListModifierListsResponse.md)
|
578
|
-
- [SquareConnect::V1ListOrdersRequest](docs/V1ListOrdersRequest.md)
|
579
|
-
- [SquareConnect::V1ListOrdersResponse](docs/V1ListOrdersResponse.md)
|
580
|
-
- [SquareConnect::V1ListPagesRequest](docs/V1ListPagesRequest.md)
|
581
|
-
- [SquareConnect::V1ListPagesResponse](docs/V1ListPagesResponse.md)
|
582
|
-
- [SquareConnect::V1ListPaymentsRequest](docs/V1ListPaymentsRequest.md)
|
583
|
-
- [SquareConnect::V1ListPaymentsResponse](docs/V1ListPaymentsResponse.md)
|
584
|
-
- [SquareConnect::V1ListRefundsRequest](docs/V1ListRefundsRequest.md)
|
585
|
-
- [SquareConnect::V1ListRefundsResponse](docs/V1ListRefundsResponse.md)
|
586
|
-
- [SquareConnect::V1ListSettlementsRequest](docs/V1ListSettlementsRequest.md)
|
587
|
-
- [SquareConnect::V1ListSettlementsRequestStatus](docs/V1ListSettlementsRequestStatus.md)
|
588
|
-
- [SquareConnect::V1ListSettlementsResponse](docs/V1ListSettlementsResponse.md)
|
589
|
-
- [SquareConnect::V1ListTimecardEventsRequest](docs/V1ListTimecardEventsRequest.md)
|
590
|
-
- [SquareConnect::V1ListTimecardEventsResponse](docs/V1ListTimecardEventsResponse.md)
|
591
|
-
- [SquareConnect::V1ListTimecardsRequest](docs/V1ListTimecardsRequest.md)
|
592
|
-
- [SquareConnect::V1ListTimecardsResponse](docs/V1ListTimecardsResponse.md)
|
593
|
-
- [SquareConnect::V1Merchant](docs/V1Merchant.md)
|
594
|
-
- [SquareConnect::V1MerchantAccountType](docs/V1MerchantAccountType.md)
|
595
|
-
- [SquareConnect::V1MerchantBusinessType](docs/V1MerchantBusinessType.md)
|
596
|
-
- [SquareConnect::V1MerchantLocationDetails](docs/V1MerchantLocationDetails.md)
|
597
|
-
- [SquareConnect::V1ModifierList](docs/V1ModifierList.md)
|
598
|
-
- [SquareConnect::V1ModifierListSelectionType](docs/V1ModifierListSelectionType.md)
|
599
|
-
- [SquareConnect::V1ModifierOption](docs/V1ModifierOption.md)
|
600
|
-
- [SquareConnect::V1Money](docs/V1Money.md)
|
601
|
-
- [SquareConnect::V1Order](docs/V1Order.md)
|
602
|
-
- [SquareConnect::V1OrderHistoryEntry](docs/V1OrderHistoryEntry.md)
|
603
|
-
- [SquareConnect::V1OrderHistoryEntryAction](docs/V1OrderHistoryEntryAction.md)
|
604
|
-
- [SquareConnect::V1OrderState](docs/V1OrderState.md)
|
605
|
-
- [SquareConnect::V1Page](docs/V1Page.md)
|
606
|
-
- [SquareConnect::V1PageCell](docs/V1PageCell.md)
|
607
|
-
- [SquareConnect::V1PageCellObjectType](docs/V1PageCellObjectType.md)
|
608
|
-
- [SquareConnect::V1PageCellPlaceholderType](docs/V1PageCellPlaceholderType.md)
|
609
|
-
- [SquareConnect::V1Payment](docs/V1Payment.md)
|
610
|
-
- [SquareConnect::V1PaymentDiscount](docs/V1PaymentDiscount.md)
|
611
|
-
- [SquareConnect::V1PaymentItemDetail](docs/V1PaymentItemDetail.md)
|
612
|
-
- [SquareConnect::V1PaymentItemization](docs/V1PaymentItemization.md)
|
613
|
-
- [SquareConnect::V1PaymentItemizationItemizationType](docs/V1PaymentItemizationItemizationType.md)
|
614
|
-
- [SquareConnect::V1PaymentModifier](docs/V1PaymentModifier.md)
|
615
|
-
- [SquareConnect::V1PaymentSurcharge](docs/V1PaymentSurcharge.md)
|
616
|
-
- [SquareConnect::V1PaymentSurchargeType](docs/V1PaymentSurchargeType.md)
|
617
|
-
- [SquareConnect::V1PaymentTax](docs/V1PaymentTax.md)
|
618
|
-
- [SquareConnect::V1PaymentTaxInclusionType](docs/V1PaymentTaxInclusionType.md)
|
619
|
-
- [SquareConnect::V1PhoneNumber](docs/V1PhoneNumber.md)
|
620
|
-
- [SquareConnect::V1Refund](docs/V1Refund.md)
|
621
|
-
- [SquareConnect::V1RefundType](docs/V1RefundType.md)
|
622
|
-
- [SquareConnect::V1RemoveFeeRequest](docs/V1RemoveFeeRequest.md)
|
623
|
-
- [SquareConnect::V1RemoveModifierListRequest](docs/V1RemoveModifierListRequest.md)
|
624
|
-
- [SquareConnect::V1RetrieveBankAccountRequest](docs/V1RetrieveBankAccountRequest.md)
|
625
|
-
- [SquareConnect::V1RetrieveBusinessRequest](docs/V1RetrieveBusinessRequest.md)
|
626
|
-
- [SquareConnect::V1RetrieveCashDrawerShiftRequest](docs/V1RetrieveCashDrawerShiftRequest.md)
|
627
|
-
- [SquareConnect::V1RetrieveEmployeeRequest](docs/V1RetrieveEmployeeRequest.md)
|
628
|
-
- [SquareConnect::V1RetrieveEmployeeRoleRequest](docs/V1RetrieveEmployeeRoleRequest.md)
|
629
|
-
- [SquareConnect::V1RetrieveItemRequest](docs/V1RetrieveItemRequest.md)
|
630
|
-
- [SquareConnect::V1RetrieveModifierListRequest](docs/V1RetrieveModifierListRequest.md)
|
631
|
-
- [SquareConnect::V1RetrieveOrderRequest](docs/V1RetrieveOrderRequest.md)
|
632
|
-
- [SquareConnect::V1RetrievePaymentRequest](docs/V1RetrievePaymentRequest.md)
|
633
|
-
- [SquareConnect::V1RetrieveSettlementRequest](docs/V1RetrieveSettlementRequest.md)
|
634
|
-
- [SquareConnect::V1RetrieveTimecardRequest](docs/V1RetrieveTimecardRequest.md)
|
635
|
-
- [SquareConnect::V1Settlement](docs/V1Settlement.md)
|
636
|
-
- [SquareConnect::V1SettlementEntry](docs/V1SettlementEntry.md)
|
637
|
-
- [SquareConnect::V1SettlementEntryType](docs/V1SettlementEntryType.md)
|
638
|
-
- [SquareConnect::V1SettlementStatus](docs/V1SettlementStatus.md)
|
639
|
-
- [SquareConnect::V1Tender](docs/V1Tender.md)
|
640
|
-
- [SquareConnect::V1TenderCardBrand](docs/V1TenderCardBrand.md)
|
641
|
-
- [SquareConnect::V1TenderEntryMethod](docs/V1TenderEntryMethod.md)
|
642
|
-
- [SquareConnect::V1TenderType](docs/V1TenderType.md)
|
643
|
-
- [SquareConnect::V1Timecard](docs/V1Timecard.md)
|
644
|
-
- [SquareConnect::V1TimecardEvent](docs/V1TimecardEvent.md)
|
645
|
-
- [SquareConnect::V1TimecardEventEventType](docs/V1TimecardEventEventType.md)
|
646
|
-
- [SquareConnect::V1UpdateCategoryRequest](docs/V1UpdateCategoryRequest.md)
|
647
|
-
- [SquareConnect::V1UpdateDiscountRequest](docs/V1UpdateDiscountRequest.md)
|
648
|
-
- [SquareConnect::V1UpdateEmployeeRequest](docs/V1UpdateEmployeeRequest.md)
|
649
|
-
- [SquareConnect::V1UpdateEmployeeRoleRequest](docs/V1UpdateEmployeeRoleRequest.md)
|
650
|
-
- [SquareConnect::V1UpdateFeeRequest](docs/V1UpdateFeeRequest.md)
|
651
|
-
- [SquareConnect::V1UpdateItemRequest](docs/V1UpdateItemRequest.md)
|
652
|
-
- [SquareConnect::V1UpdateModifierListRequest](docs/V1UpdateModifierListRequest.md)
|
653
|
-
- [SquareConnect::V1UpdateModifierListRequestSelectionType](docs/V1UpdateModifierListRequestSelectionType.md)
|
654
|
-
- [SquareConnect::V1UpdateModifierOptionRequest](docs/V1UpdateModifierOptionRequest.md)
|
655
|
-
- [SquareConnect::V1UpdateOrderRequest](docs/V1UpdateOrderRequest.md)
|
656
|
-
- [SquareConnect::V1UpdateOrderRequestAction](docs/V1UpdateOrderRequestAction.md)
|
657
|
-
- [SquareConnect::V1UpdatePageCellRequest](docs/V1UpdatePageCellRequest.md)
|
658
|
-
- [SquareConnect::V1UpdatePageRequest](docs/V1UpdatePageRequest.md)
|
659
|
-
- [SquareConnect::V1UpdateTimecardRequest](docs/V1UpdateTimecardRequest.md)
|
660
|
-
- [SquareConnect::V1UpdateVariationRequest](docs/V1UpdateVariationRequest.md)
|
661
|
-
- [SquareConnect::V1Variation](docs/V1Variation.md)
|
662
|
-
- [SquareConnect::V1VariationInventoryAlertType](docs/V1VariationInventoryAlertType.md)
|
663
|
-
- [SquareConnect::V1VariationPricingType](docs/V1VariationPricingType.md)
|
664
|
-
- [SquareConnect::VoidTransactionRequest](docs/VoidTransactionRequest.md)
|
665
|
-
- [SquareConnect::VoidTransactionResponse](docs/VoidTransactionResponse.md)
|
666
|
-
- [SquareConnect::WebhookEvents](docs/WebhookEvents.md)
|
667
|
-
- [SquareConnect::Weekday](docs/Weekday.md)
|
668
|
-
- [SquareConnect::WorkweekConfig](docs/WorkweekConfig.md)
|
669
|
-
|
670
|
-
|
671
|
-
## Documentation for Authorization
|
672
|
-
|
673
|
-
|
674
|
-
### oauth2
|
675
|
-
|
676
|
-
- **Type**: OAuth
|
677
|
-
- **Flow**: accessCode
|
678
|
-
- **Authorization URL**: `https://connect.squareup.com/oauth2/authorize`
|
679
|
-
- **Scopes**:
|
680
|
-
- BANK_ACCOUNTS_READ: __HTTP Method__: `GET` Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint.
|
681
|
-
- CUSTOMERS_READ: __HTTP Method__: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint.
|
682
|
-
- CUSTOMERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles.
|
683
|
-
- EMPLOYEES_READ: __HTTP Method__: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API.
|
684
|
-
- EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles.
|
685
|
-
- INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
|
686
|
-
- INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
|
687
|
-
- ITEMS_READ: __HTTP Method__: `GET` Grants read access to product catalog information. For example, to get an item or a list of items.
|
688
|
-
- ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog.
|
689
|
-
- MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
|
690
|
-
- ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
|
691
|
-
- ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint.
|
692
|
-
- PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
|
693
|
-
- PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Transactions or Checkout API.
|
694
|
-
- PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Transactions API.
|
695
|
-
- PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process in-person payments.
|
696
|
-
- SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
|
697
|
-
- TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint.
|
698
|
-
- TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard information. For example, to create and modify timecards.
|
699
|
-
- TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
|
700
|
-
- TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
|
701
|
-
|
702
|
-
### oauth2ClientSecret
|
703
|
-
|
704
|
-
- **Type**: API key
|
705
|
-
- **API key parameter name**: Authorization
|
706
|
-
- **Location**: HTTP header
|
707
|
-
|
708
|
-
|
709
|
-
## Pagination of V1 Endpoints
|
710
|
-
|
711
|
-
V1 Endpoints return pagination information via HTTP headers. In order to obtain
|
712
|
-
response headers and extract the `batch_token` parameter you will need to follow
|
713
|
-
the following steps:
|
714
|
-
|
715
|
-
1. Use the full information endpoint methods of each API to get the response HTTP
|
716
|
-
Headers. They are named as their simple counterpart with a `with_http_info` suffix.
|
717
|
-
Hence `listEmployeeRoles` would be called `list_employee_roles_with_http_info`. This
|
718
|
-
method returns an array with 3 parameters: `response`, `http_status`, and
|
719
|
-
`http_headers`.
|
720
|
-
2. Use `batch_token = api_client.get_v1_batch_token_from_headers(http_headers)`
|
721
|
-
to extract the token and proceed to get the following page if a token is present.
|
722
|
-
|
723
|
-
### Example
|
134
|
+
Now consider equivalent code using the new `square.rb` gem:
|
724
135
|
|
725
136
|
```ruby
|
726
|
-
|
727
|
-
require 'square_connect'
|
728
|
-
# setup authorization
|
729
|
-
SquareConnect.configure do |config|
|
730
|
-
# Configure OAuth2 access token for authorization: oauth2
|
731
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
732
|
-
end
|
137
|
+
require 'square'
|
733
138
|
|
734
|
-
|
735
|
-
|
139
|
+
# Instantiate the client
|
140
|
+
square = Square::Client.new(access_token: 'YOUR ACCESS TOKEN')
|
736
141
|
|
737
|
-
|
738
|
-
|
739
|
-
limit: 56 # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
740
|
-
}
|
142
|
+
# Call the endpoint
|
143
|
+
response = square.customers.create_customer(body: new_customer)
|
741
144
|
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
puts "Exception when calling V1EmployeesApi#list_employee_roles_with_http_info: #{e}"
|
749
|
-
end while opts[:batch_token]
|
750
|
-
|
751
|
-
p roles
|
145
|
+
# Handle the response and warn on errors
|
146
|
+
if response.success?
|
147
|
+
p response.data
|
148
|
+
else
|
149
|
+
warn response.errors
|
150
|
+
end
|
752
151
|
```
|
753
152
|
|
754
|
-
|
755
|
-
------------
|
153
|
+
That's it!
|
756
154
|
|
757
|
-
|
758
|
-
|
759
|
-
|
155
|
+
What was once a multi-block process can be handled in 2 lines of code and an
|
156
|
+
`if/else` block. Migrating to the `square.rb` gem reduces boilerplate and lets
|
157
|
+
you focus on the parts of your code that really matter.
|
760
158
|
|
761
|
-
|
762
|
-
-------
|
159
|
+
<br/>
|
763
160
|
|
764
|
-
|
765
|
-
Copyright 2017 Square, Inc.
|
161
|
+
---
|
766
162
|
|
767
|
-
|
768
|
-
you may not use this file except in compliance with the License.
|
769
|
-
You may obtain a copy of the License at
|
163
|
+
<br/>
|
770
164
|
|
771
|
-
|
165
|
+
## Ask the community
|
772
166
|
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
167
|
+
Please join us in our [Square developer community] if you have any questions!
|
168
|
+
|
169
|
+
|
170
|
+
[//]: # "Link anchor definitions"
|
171
|
+
[Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg
|
172
|
+
[Square Ruby SDK gem]: https://github.com/square/square-ruby-sdk
|
173
|
+
[Square developer community]: https://squ.re/slack
|