square_connect 2.0.2.69 → 2.1.0.beta

data/docs/V1AdjustInventoryRequest.md

@@ -0,0 +1,12 @@
+# SquareConnect::V1AdjustInventoryRequest
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity_delta** | **Float** | The number to adjust the variation's quantity by. | [optional] 
+**adjustment_type** | **Float** | The reason for the inventory adjustment. | [optional] 
+**memo** | **String** | A note about the inventory adjustment. | [optional] 
+
+

data/docs/V1BankAccount.md

@@ -0,0 +1,17 @@
+# SquareConnect::V1BankAccount
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The bank account's Square-issued ID. | [optional] 
+**merchant_id** | **String** | The Square-issued ID of the merchant associated with the bank account. | [optional] 
+**bank_name** | **String** | The name of the bank that manages the account. | [optional] 
+**name** | **String** | The name associated with the bank account. | [optional] 
+**routing_number** | **String** | The bank account's routing number. | [optional] 
+**account_number_suffix** | **String** | The last few digits of the bank account number. | [optional] 
+**currency_code** | **String** | The currency code of the currency associated with the bank account, in ISO 4217 format. For example, the currency code for US dollars is USD. | [optional] 
+**type** | **String** | The bank account's type (for example, savings or checking). | [optional] 
+
+

data/docs/V1CashDrawerEvent.md

@@ -0,0 +1,15 @@
+# SquareConnect::V1CashDrawerEvent
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The event's unique ID. | [optional] 
+**employee_id** | **String** | The ID of the employee that created the event. | [optional] 
+**event_type** | **String** | The type of event that occurred. | [optional] 
+**event_money** | [**V1Money**](V1Money.md) | The amount of money that was added to or removed from the cash drawer because of the event. This value can be positive (for added money) or negative (for removed money). | [optional] 
+**created_at** | **String** | The time when the event occurred, in ISO 8601 format. | [optional] 
+**description** | **String** | An optional description of the event, entered by the employee that created it. | [optional] 
+
+

data/docs/V1CashDrawerShift.md

@@ -0,0 +1,28 @@
+# SquareConnect::V1CashDrawerShift
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The shift's unique ID. | [optional] 
+**event_type** | **String** | The shift's current state. | [optional] 
+**opened_at** | **String** | The time when the shift began, in ISO 8601 format. | [optional] 
+**ended_at** | **BOOLEAN** | The time when the shift ended, in ISO 8601 format. | [optional] 
+**closed_at** | **String** | The time when the shift was closed, in ISO 8601 format. | [optional] 
+**employee_ids** | **Array<String>** | The IDs of all employees that were logged into Square Register at some point during the cash drawer shift. | [optional] 
+**opening_employee_id** | **String** | The ID of the employee that started the cash drawer shift. | [optional] 
+**ending_employee_id** | **String** | The ID of the employee that ended the cash drawer shift. | [optional] 
+**closing_employee_id** | **String** | The ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents. | [optional] 
+**description** | **String** | The time when the timecard was created, in ISO 8601 format. | [optional] 
+**starting_cash_money** | [**V1Money**](V1Money.md) | The amount of money in the cash drawer at the start of the shift. | [optional] 
+**cash_payment_money** | [**V1Money**](V1Money.md) | The amount of money added to the cash drawer from cash payments. | [optional] 
+**cash_refunds_money** | [**V1Money**](V1Money.md) | The amount of money removed from the cash drawer from cash refunds. This value is always negative or zero. | [optional] 
+**cash_paid_in_money** | [**V1Money**](V1Money.md) | The amount of money added to the cash drawer for reasons other than cash payments. | [optional] 
+**cash_paid_out_money** | [**V1Money**](V1Money.md) | The amount of money removed from the cash drawer for reasons other than cash refunds. | [optional] 
+**expected_cash_money** | [**V1Money**](V1Money.md) | The amount of money that should be in the cash drawer at the end of the shift, based on the shift's other money amounts. | [optional] 
+**closed_cash_money** | [**V1Money**](V1Money.md) | The amount of money found in the cash drawer at the end of the shift by an auditing employee. | [optional] 
+**device** | [**Device**](Device.md) | The device running Square Register that was connected to the cash drawer. | [optional] 
+**events** | [**Array<V1CashDrawerEvent>**](V1CashDrawerEvent.md) | All of the events (payments, refunds, and so on) that involved the cash drawer during the shift. | [optional] 
+
+

data/docs/V1Category.md

@@ -0,0 +1,11 @@
+# SquareConnect::V1Category
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The category's unique ID. | [optional] 
+**name** | **String** | The category's name. | [optional] 
+
+

data/docs/V1CreateRefundRequest.md

@@ -0,0 +1,14 @@
+# SquareConnect::V1CreateRefundRequest
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | The ID of the payment to refund. If you're creating a PARTIAL refund for a split tender payment, instead provide the id of the particular tender you want to refund. See Split Tender Payments for details. | 
+**type** | **String** | TThe type of refund (FULL or PARTIAL). | 
+**reason** | **String** | The reason for the refund. | 
+**refunded_money** | [**V1Money**](V1Money.md) | The amount of money to refund. Required only for PARTIAL refunds. | [optional] 
+**request_idempotence_key** | **String** | An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once. | [optional] 
+
+

data/docs/V1Discount.md

@@ -0,0 +1,16 @@
+# SquareConnect::V1Discount
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The discount's unique ID. | [optional] 
+**name** | **String** | The discount's name. | [optional] 
+**rate** | **String** | The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE. | [optional] 
+**amount_money** | [**V1Money**](V1Money.md) | The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts. | [optional] 
+**discount_type** | **String** | Indicates whether the discount is a FIXED value or entered at the time of sale. | [optional] 
+**pin_required** | **BOOLEAN** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment. | [optional] 
+**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. | [optional] 
+
+

data/docs/V1Employee.md

@@ -0,0 +1,21 @@
+# SquareConnect::V1Employee
+
+### Description
+
+Represents one of a business's employees.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The employee's unique ID. | [optional] 
+**first_name** | **String** | The employee's first name. | 
+**last_name** | **String** | The employee's last name. | 
+**role_ids** | **Array<String>** | The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee. | [optional] 
+**authorized_location_ids** | **Array<String>** | The IDs of the locations the employee is allowed to clock in at. | [optional] 
+**email** | **String** | The employee's email address. | [optional] 
+**status** | **String** | CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.  | [optional] 
+**external_id** | **String** | An ID the merchant can set to associate the employee with an entity in another system. | [optional] 
+**created_at** | **String** | The time when the employee entity was created, in ISO 8601 format. | [optional] 
+**updated_at** | **String** | The time when the employee entity was most recently updated, in ISO 8601 format. | [optional] 
+
+

data/docs/V1EmployeeRole.md

@@ -0,0 +1,15 @@
+# SquareConnect::V1EmployeeRole
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The role's unique ID, Can only be set by Square. | [optional] 
+**name** | **String** | The role's merchant-defined name. | 
+**permissions** | **Array<String>** | The role's permissions. | 
+**is_owner** | **BOOLEAN** | If true, employees with this role have all permissions, regardless of the values indicated in permissions. | [optional] 
+**created_at** | **String** | The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created. | [optional] 
+**updated_at** | **String** | The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated. | [optional] 
+
+

data/docs/V1EmployeesApi.md

@@ -0,0 +1,915 @@
+# SquareConnect::V1EmployeesApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_employee**](V1EmployeesApi.md#create_employee) | **POST** /v1/me/employees | Creates an employee for a business.
+[**create_employee_role**](V1EmployeesApi.md#create_employee_role) | **POST** /v1/me/roles | Creates an employee role you can then assign to employees.
+[**create_timecard**](V1EmployeesApi.md#create_timecard) | **POST** /v1/me/timecards | Creates a timecard for an employee. Each timecard corresponds to a single shift.
+[**delete_timecard**](V1EmployeesApi.md#delete_timecard) | **DELETE** /v1/me/timecards/{timecard_id} | Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+[**list_cash_drawer_shifts**](V1EmployeesApi.md#list_cash_drawer_shifts) | **GET** /v1/{location_id}/cash-drawer-shifts | Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+[**list_employee_roles**](V1EmployeesApi.md#list_employee_roles) | **GET** /v1/me/roles | Provides summary information for all of a business's employee roles.
+[**list_employees**](V1EmployeesApi.md#list_employees) | **GET** /v1/me/employees | Provides summary information for all of a business's employees.
+[**list_timecard_events**](V1EmployeesApi.md#list_timecard_events) | **GET** /v1/me/timecards/{timecard_id}/events | Provides summary information for all events associated with a particular timecard.
+[**list_timecards**](V1EmployeesApi.md#list_timecards) | **GET** /v1/me/timecards | Provides summary information for all of a business's employee timecards.
+[**retrieve_cash_drawer_shift**](V1EmployeesApi.md#retrieve_cash_drawer_shift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+[**retrieve_employee**](V1EmployeesApi.md#retrieve_employee) | **GET** /v1/me/employees/{employee_id} | Provides the details for a single employee.
+[**retrieve_employee_role**](V1EmployeesApi.md#retrieve_employee_role) | **GET** /v1/me/roles/{role_id} | Provides the details for a single employee role.
+[**retrieve_timecard**](V1EmployeesApi.md#retrieve_timecard) | **GET** /v1/me/timecards/{timecard_id} | Provides the details for a single timecard.
+[**update_employee**](V1EmployeesApi.md#update_employee) | **PUT** /v1/me/employees/{employee_id} | V1 UpdateEmployee
+[**update_employee_role**](V1EmployeesApi.md#update_employee_role) | **PUT** /v1/me/roles/{role_id} | Modifies the details of an employee role.
+[**update_timecard**](V1EmployeesApi.md#update_timecard) | **PUT** /v1/me/timecards/{timecard_id} | Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
+
+
+# **create_employee**
+> V1Employee create_employee(body)
+
+Creates an employee for a business.
+
+Creates an employee for a business.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+body = SquareConnect::V1Employee.new # V1Employee | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Creates an employee for a business.
+  result = api_instance.create_employee(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->create_employee: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1Employee**](V1Employee.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1Employee**](V1Employee.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_employee_role**
+> V1EmployeeRole create_employee_role(employee_role)
+
+Creates an employee role you can then assign to employees.
+
+Creates an employee role you can then assign to employees.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+employee_role = SquareConnect::V1EmployeeRole.new # V1EmployeeRole | An EmployeeRole object with a name and permissions, and an optional owner flag.
+
+
+begin
+  #Creates an employee role you can then assign to employees.
+  result = api_instance.create_employee_role(employee_role)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->create_employee_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_role** | [**V1EmployeeRole**](V1EmployeeRole.md)| An EmployeeRole object with a name and permissions, and an optional owner flag. | 
+
+### Return type
+
+[**V1EmployeeRole**](V1EmployeeRole.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_timecard**
+> V1Timecard create_timecard(body)
+
+Creates a timecard for an employee. Each timecard corresponds to a single shift.
+
+Creates a timecard for an employee. Each timecard corresponds to a single shift.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Creates a timecard for an employee. Each timecard corresponds to a single shift.
+  result = api_instance.create_timecard(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->create_timecard: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1Timecard**](V1Timecard.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1Timecard**](V1Timecard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_timecard**
+> Object delete_timecard(timecard_id)
+
+Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+
+Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+timecard_id = "timecard_id_example" # String | The ID of the timecard to delete.
+
+
+begin
+  #Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+  result = api_instance.delete_timecard(timecard_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->delete_timecard: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **timecard_id** | **String**| The ID of the timecard to delete. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_cash_drawer_shifts**
+> Array<V1CashDrawerShift> list_cash_drawer_shifts(location_id, opts)
+
+Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+
+Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list cash drawer shifts for.
+
+opts = { 
+  order: "order_example", # String | The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC
+  begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.
+  end_time: "end_time_example" # String | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.
+}
+
+begin
+  #Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+  result = api_instance.list_cash_drawer_shifts(location_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->list_cash_drawer_shifts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list cash drawer shifts for. | 
+ **order** | **String**| The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC | [optional] 
+ **begin_time** | **String**| The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days. | [optional] 
+ **end_time** | **String**| The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time. | [optional] 
+
+### Return type
+
+[**Array<V1CashDrawerShift>**](V1CashDrawerShift.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_employee_roles**
+> Array<V1EmployeeRole> list_employee_roles(opts)
+
+Provides summary information for all of a business's employee roles.
+
+Provides summary information for all of a business's employee roles.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+opts = { 
+  order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
+  limit: 56, # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+  cursor: "cursor_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+}
+
+begin
+  #Provides summary information for all of a business's employee roles.
+  result = api_instance.list_employee_roles(opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->list_employee_roles: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order** | **String**| The order in which employees are listed in the response, based on their created_at field.Default value: ASC  | [optional] 
+ **limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
+ **cursor** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
+
+### Return type
+
+[**Array<V1EmployeeRole>**](V1EmployeeRole.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_employees**
+> Array<V1Employee> list_employees(opts)
+
+Provides summary information for all of a business's employees.
+
+Provides summary information for all of a business's employees.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+opts = { 
+  order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field.      Default value: ASC 
+  begin_updated_at: "begin_updated_at_example", # String | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
+  end_updated_at: "end_updated_at_example", # String | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
+  begin_created_at: "begin_created_at_example", # String | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
+  end_created_at: "end_created_at_example", # String | If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
+  status: "status_example", # String | If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
+  external_id: "external_id_example", # String | If provided, the endpoint returns only employee entities with the specified external_id.
+  limit: 56 # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+}
+
+begin
+  #Provides summary information for all of a business's employees.
+  result = api_instance.list_employees(opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->list_employees: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order** | **String**| The order in which employees are listed in the response, based on their created_at field.      Default value: ASC  | [optional] 
+ **begin_updated_at** | **String**| If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format | [optional] 
+ **end_updated_at** | **String**| If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] 
+ **begin_created_at** | **String**| If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] 
+ **end_created_at** | **String**| If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] 
+ **status** | **String**| If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). | [optional] 
+ **external_id** | **String**| If provided, the endpoint returns only employee entities with the specified external_id. | [optional] 
+ **limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
+
+### Return type
+
+[**Array<V1Employee>**](V1Employee.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_timecard_events**
+> Array<V1TimecardEvent> list_timecard_events(timecard_id)
+
+Provides summary information for all events associated with a particular timecard.
+
+Provides summary information for all events associated with a particular timecard.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+timecard_id = "timecard_id_example" # String | The ID of the timecard to list events for.
+
+
+begin
+  #Provides summary information for all events associated with a particular timecard.
+  result = api_instance.list_timecard_events(timecard_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->list_timecard_events: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **timecard_id** | **String**| The ID of the timecard to list events for. | 
+
+### Return type
+
+[**Array<V1TimecardEvent>**](V1TimecardEvent.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_timecards**
+> Array<V1Timecard> list_timecards(opts)
+
+Provides summary information for all of a business's employee timecards.
+
+Provides summary information for all of a business's employee timecards.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+opts = { 
+  order: "order_example", # String | The order in which timecards are listed in the response, based on their created_at field.
+  employee_id: "employee_id_example", # String | If provided, the endpoint returns only timecards for the employee with the specified ID.
+  begin_clockin_time: "begin_clockin_time_example", # String | If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
+  end_clockin_time: "end_clockin_time_example", # String | If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
+  begin_clockout_time: "begin_clockout_time_example", # String | If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
+  end_clockout_time: "end_clockout_time_example", # String | If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
+  begin_updated_at: "begin_updated_at_example", # String | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
+  end_updated_at: "end_updated_at_example", # String | If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
+  deleted: true, # BOOLEAN | If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
+  limit: 56, # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+  cursor: "cursor_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+}
+
+begin
+  #Provides summary information for all of a business's employee timecards.
+  result = api_instance.list_timecards(opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->list_timecards: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order** | **String**| The order in which timecards are listed in the response, based on their created_at field. | [optional] 
+ **employee_id** | **String**| If provided, the endpoint returns only timecards for the employee with the specified ID. | [optional] 
+ **begin_clockin_time** | **String**| If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] 
+ **end_clockin_time** | **String**| If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format. | [optional] 
+ **begin_clockout_time** | **String**| If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] 
+ **end_clockout_time** | **String**| If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format. | [optional] 
+ **begin_updated_at** | **String**| If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] 
+ **end_updated_at** | **String**| If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] 
+ **deleted** | **BOOLEAN**| If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned. | [optional] 
+ **limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
+ **cursor** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
+
+### Return type
+
+[**Array<V1Timecard>**](V1Timecard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_cash_drawer_shift**
+> V1CashDrawerShift retrieve_cash_drawer_shift(location_id, shift_id)
+
+Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+
+Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+location_id = "location_id_example" # String | The ID of the location to list cash drawer shifts for.
+
+shift_id = "shift_id_example" # String | The shift's ID.
+
+
+begin
+  #Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+  result = api_instance.retrieve_cash_drawer_shift(location_id, shift_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->retrieve_cash_drawer_shift: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| The ID of the location to list cash drawer shifts for. | 
+ **shift_id** | **String**| The shift's ID. | 
+
+### Return type
+
+[**V1CashDrawerShift**](V1CashDrawerShift.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_employee**
+> V1Employee retrieve_employee(employee_id)
+
+Provides the details for a single employee.
+
+Provides the details for a single employee.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+employee_id = "employee_id_example" # String | The employee's ID.
+
+
+begin
+  #Provides the details for a single employee.
+  result = api_instance.retrieve_employee(employee_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->retrieve_employee: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_id** | **String**| The employee's ID. | 
+
+### Return type
+
+[**V1Employee**](V1Employee.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_employee_role**
+> V1EmployeeRole retrieve_employee_role(role_id)
+
+Provides the details for a single employee role.
+
+Provides the details for a single employee role.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+role_id = "role_id_example" # String | The role's ID.
+
+
+begin
+  #Provides the details for a single employee role.
+  result = api_instance.retrieve_employee_role(role_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->retrieve_employee_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_id** | **String**| The role's ID. | 
+
+### Return type
+
+[**V1EmployeeRole**](V1EmployeeRole.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_timecard**
+> V1Timecard retrieve_timecard(timecard_id)
+
+Provides the details for a single timecard.
+
+Provides the details for a single timecard.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+timecard_id = "timecard_id_example" # String | The timecard's ID.
+
+
+begin
+  #Provides the details for a single timecard.
+  result = api_instance.retrieve_timecard(timecard_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->retrieve_timecard: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **timecard_id** | **String**| The timecard's ID. | 
+
+### Return type
+
+[**V1Timecard**](V1Timecard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_employee**
+> V1Employee update_employee(employee_id, body)
+
+V1 UpdateEmployee
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+employee_id = "employee_id_example" # String | The ID of the role to modify.
+
+body = SquareConnect::V1Employee.new # V1Employee | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #V1 UpdateEmployee
+  result = api_instance.update_employee(employee_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->update_employee: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **employee_id** | **String**| The ID of the role to modify. | 
+ **body** | [**V1Employee**](V1Employee.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1Employee**](V1Employee.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_employee_role**
+> V1EmployeeRole update_employee_role(role_id, body)
+
+Modifies the details of an employee role.
+
+Modifies the details of an employee role.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+role_id = "role_id_example" # String | The ID of the role to modify.
+
+body = SquareConnect::V1EmployeeRole.new # V1EmployeeRole | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Modifies the details of an employee role.
+  result = api_instance.update_employee_role(role_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->update_employee_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_id** | **String**| The ID of the role to modify. | 
+ **body** | [**V1EmployeeRole**](V1EmployeeRole.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1EmployeeRole**](V1EmployeeRole.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_timecard**
+> V1Timecard update_timecard(timecard_id, body)
+
+Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
+
+Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
+
+### Example
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+
+timecard_id = "timecard_id_example" # String | TThe ID of the timecard to modify.
+
+body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
+  result = api_instance.update_timecard(timecard_id, body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi->update_timecard: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **timecard_id** | **String**| TThe ID of the timecard to modify. | 
+ **body** | [**V1Timecard**](V1Timecard.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**V1Timecard**](V1Timecard.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+