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