square.rb 13.1.0.20210818 → 14.1.0.20210915

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a624808dd5bb0375fef64adf65cbe8203c6b582bd38e34afb69b4b0c0f4fd8a4
-  data.tar.gz: 849966858b71f5a2b2f4abb9811561156172b591cf2a3c93886bee88c5ecff83
+  metadata.gz: cb09b4404e4f7f5cb0923e135ada308b9a9c3482106b0ab8cc2e80eee63f8de0
+  data.tar.gz: fc7d73e6a5d955857fe4bfb4341a75cdd80764f3cced0e19afbbb37cdca4d9bb
 SHA512:
-  metadata.gz: bcb9330214a8a813a1d6bf405db19dcd2264f70f1745b793c9cf7c844f340dc056cf7a141a0e12ca65187ee02d1c856ee59621ab2143f18e518bdc734bc9f35c
-  data.tar.gz: 5a93c48a1751fae253c1819fd0c4925b47e3998be01ad9af2acae45cbac6c4a6d9979bf4e0e36baa9475bd54c396135c5d136981fc4b87ec0c04d507cf259698
+  metadata.gz: fcf0ff7ca1313121f98083f32cdf8201c30be1814a7f7f6aac89c09e752e129a92ba1f5117f9049559d835846a3e49abfc1d83c906a59c362b8fd05e2c31fbf6
+  data.tar.gz: 2870c75eef04c8798e3699c17a4e88296bfe144400b81c7bf4463c0d3bcface04ef151cae4a0b0349266890d16485a4257d5aa4756d4985684dceb789021b0eb

data/README.md

@@ -37,6 +37,9 @@ gem 'square.rb'
 * [Disputes]
 * [Checkout]
 * [Apple Pay]
+* [Cards]
+
+### Terminal
 * [Terminal]
 
 ### Orders
@@ -60,6 +63,10 @@ gem 'square.rb'
 ### Loyalty
 * [Loyalty]
 
+### Gift Cards
+* [Gift Cards]
+* [Gift Card Activities]
+
 ### Bookings
 * [Bookings]
 
@@ -67,12 +74,11 @@ gem 'square.rb'
 * [Merchants]
 * [Locations]
 * [Devices]
+* [Cash Drawers]
 
 ### Team
 * [Team]
-* [Employees]
 * [Labor]
-* [Cash Drawers]
 
 ### Financials
 * [Bank Accounts]
@@ -86,6 +92,7 @@ gem 'square.rb'
 * [OAuth]
 
 ### Deprecated APIs
+* [Employees]
 * [V1 Employees]
 * [V1 Transactions]
 * [V1 Items]
@@ -337,3 +344,6 @@ You can also use the Square API to create applications or services that work wit
 [Transactions]: doc/api/transactions.md
 [Sites]: doc/api/sites.md
 [Snippets]: doc/api/snippets.md
+[Cards]: doc/api/cards.md
+[Gift Cards]: doc/api/gift-cards.md
+[Gift Card Activities]: doc/api/gift-card-activities.md

data/lib/square/api/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/13.1.0.20210818',
+        'user-agent' => 'Square-Ruby-SDK/14.1.0.20210915',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/catalog_api.rb

@@ -435,7 +435,7 @@ module Square
     # Searches for [CatalogObject]($m/CatalogObject) of any type by matching
     # supported search attribute values,
     # excluding custom attribute values on items or item variations, against one
-    # or more of the specified query expressions.
+    # or more of the specified query filters.
     # This (`SearchCatalogObjects`) endpoint differs from the
     # [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
     # endpoint in the following aspects:
@@ -485,7 +485,7 @@ module Square
     # Searches for catalog items or item variations by matching supported search
     # attribute values, including
     # custom attribute values, against one or more of the specified query
-    # expressions.
+    # filters.
     # This (`SearchCatalogItems`) endpoint differs from the
     # [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
     # endpoint in the following aspects:

data/lib/square/api/o_auth_api.rb

@@ -27,8 +27,8 @@ module Square
     # Credentials
     # page in the [developer dashboard](https://developer.squareup.com/apps).
     # @param [String] client_id Required parameter: Your application ID,
-    # available from the [developer
-    # dashboard](https://developer.squareup.com/apps).
+    # available from the OAuth page for your  application on the Developer
+    # Dashboard.
     # @param [RenewTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -84,7 +84,7 @@ module Square
     # Authorization: Client APPLICATION_SECRET
     # ```
     # Replace `APPLICATION_SECRET` with the application secret on the OAuth
-    # page in the [developer dashboard](https://developer.squareup.com/apps).
+    # page for your application on the Developer Dashboard.
     # @param [RevokeTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -121,15 +121,22 @@ module Square
       )
     end
 
-    # Returns an OAuth access token.
-    # The endpoint supports distinct methods of obtaining OAuth access tokens.
-    # Applications specify a method by adding the `grant_type` parameter
-    # in the request and also provide relevant information.
-    # __Note:__ Regardless of the method application specified,
-    # the endpoint always returns two items; an OAuth access token and
-    # a refresh token in the response.
-    # __OAuth tokens should only live on secure servers. Application clients
-    # should never interact directly with OAuth tokens__.
+    # Returns an OAuth access token and a refresh token unless the
+    # `short_lived` parameter is set to `true`, in which case the endpoint
+    # returns only an access token.
+    # The `grant_type` parameter specifies the type of OAuth request. If
+    # `grant_type` is `authorization_code`, you must include the authorization
+    # code you received when a seller granted you authorization. If `grant_type`
+    # is `refresh_token`, you must provide a valid refresh token. If you are
+    # using
+    # an old version of the Square APIs (prior to March 13, 2019), `grant_type`
+    # can be `migration_token` and you must provide a valid migration token.
+    # You can use the `scopes` parameter to limit the set of permissions granted
+    # to the access token and refresh token. You can use the `short_lived`
+    # parameter
+    # to create an access token that expires in 24 hours.
+    # __Note:__ OAuth tokens should be encrypted and stored on a secure server.
+    # Application clients should never interact directly with OAuth tokens.
     # @param [ObtainTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.

data/lib/square/api/orders_api.rb

@@ -116,6 +116,43 @@ module Square
       )
     end
 
+    # Creates a new order, in the `DRAFT` state, by duplicating an existing
+    # order. The newly created order has
+    # only the core fields (such as line items, taxes, and discounts) copied
+    # from the original order.
+    # @param [CloneOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CloneOrderResponse Hash] response from the API call
+    def clone_order(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/clone'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
     # Search all orders for one or more locations. Orders include all sales,
     # returns, and exchanges regardless of how or when they entered the Square
     # ecosystem (such as Point of Sale, Invoices, and Connect APIs).

data/lib/square/api_helper.rb

@@ -168,6 +168,7 @@ module Square
       a.each do |key, value_a|
         b.each do |k, value_b|
           next unless key == k
+
           x[k] = []
           if value_a.instance_of? Array
             value_a.each do |v|

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '13.1.0.20210818'
+      '14.1.0.20210915'
     end
 
     def square_version
@@ -23,12 +23,6 @@ module Square
       @o_auth ||= OAuthApi.new config
     end
 
-    # Access to v1_employees controller.
-    # @return [V1EmployeesApi] Returns the controller instance.
-    def v1_employees
-      @v1_employees ||= V1EmployeesApi.new config
-    end
-
     # Access to v1_transactions controller.
     # @return [V1TransactionsApi] Returns the controller instance.
     def v1_transactions
@@ -220,7 +214,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-08-18', access_token: 'TODO: Replace',
+                   square_version: '2021-09-15', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,

data/lib/square/configuration.rb

@@ -3,22 +3,15 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client
-    attr_reader :timeout
-    attr_reader :max_retries
-    attr_reader :retry_interval
-    attr_reader :backoff_factor
-    attr_reader :retry_statuses
-    attr_reader :retry_methods
-    attr_reader :environment
-    attr_reader :custom_url
-    attr_reader :square_version
-    attr_reader :access_token
-
+    attr_reader :http_client, :timeout, :max_retries, :retry_interval, :backoff_factor,
+                :retry_statuses, :retry_methods, :environment, :custom_url, :square_version,
+                :access_token,
+                
     def additional_headers
       @additional_headers.clone
     end
 
+
     class << self
       attr_reader :environments
     end
@@ -28,7 +21,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-08-18', access_token: 'TODO: Replace',
+                   square_version: '2021-09-15', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

data/lib/square/utilities/file_wrapper.rb

@@ -1,8 +1,7 @@
 module Square
   # A utility to allow users to set the content-type for files
   class FileWrapper
-    attr_reader :content_type
-    attr_reader :file
+    attr_reader :content_type, :file
 
     def initialize(file, content_type: 'application/octet-stream')
       @file = file

data/lib/square.rb

@@ -4,63 +4,62 @@ require 'faraday'
 require 'certifi'
 require 'logging'
 
-require_relative 'square/api_helper.rb'
-require_relative 'square/client.rb'
+require_relative 'square/api_helper'
+require_relative 'square/client'
 
 # Utilities
-require_relative 'square/utilities/file_wrapper.rb'
-require_relative 'square/utilities/date_time_helper.rb'
+require_relative 'square/utilities/file_wrapper'
+require_relative 'square/utilities/date_time_helper'
 
 # Http
-require_relative 'square/http/api_response.rb'
-require_relative 'square/http/http_call_back.rb'
-require_relative 'square/http/http_client.rb'
-require_relative 'square/http/faraday_client.rb'
-require_relative 'square/http/http_method_enum.rb'
-require_relative 'square/http/http_request.rb'
-require_relative 'square/http/http_response.rb'
-require_relative 'square/http/auth/o_auth2.rb'
+require_relative 'square/http/api_response'
+require_relative 'square/http/http_call_back'
+require_relative 'square/http/http_client'
+require_relative 'square/http/faraday_client'
+require_relative 'square/http/http_method_enum'
+require_relative 'square/http/http_request'
+require_relative 'square/http/http_response'
+require_relative 'square/http/auth/o_auth2'
 
 # Models
 
 # Exceptions
-require_relative 'square/exceptions/api_exception.rb'
+require_relative 'square/exceptions/api_exception'
 
-require_relative 'square/configuration.rb'
+require_relative 'square/configuration'
 
 # Controllers
-require_relative 'square/api/base_api.rb'
-require_relative 'square/api/mobile_authorization_api.rb'
-require_relative 'square/api/o_auth_api.rb'
-require_relative 'square/api/v1_employees_api.rb'
-require_relative 'square/api/v1_transactions_api.rb'
-require_relative 'square/api/apple_pay_api.rb'
-require_relative 'square/api/bank_accounts_api.rb'
-require_relative 'square/api/bookings_api.rb'
-require_relative 'square/api/cards_api.rb'
-require_relative 'square/api/cash_drawers_api.rb'
-require_relative 'square/api/catalog_api.rb'
-require_relative 'square/api/customers_api.rb'
-require_relative 'square/api/customer_groups_api.rb'
-require_relative 'square/api/customer_segments_api.rb'
-require_relative 'square/api/devices_api.rb'
-require_relative 'square/api/disputes_api.rb'
-require_relative 'square/api/employees_api.rb'
-require_relative 'square/api/gift_cards_api.rb'
-require_relative 'square/api/gift_card_activities_api.rb'
-require_relative 'square/api/inventory_api.rb'
-require_relative 'square/api/invoices_api.rb'
-require_relative 'square/api/labor_api.rb'
-require_relative 'square/api/locations_api.rb'
-require_relative 'square/api/checkout_api.rb'
-require_relative 'square/api/transactions_api.rb'
-require_relative 'square/api/loyalty_api.rb'
-require_relative 'square/api/merchants_api.rb'
-require_relative 'square/api/orders_api.rb'
-require_relative 'square/api/payments_api.rb'
-require_relative 'square/api/refunds_api.rb'
-require_relative 'square/api/sites_api.rb'
-require_relative 'square/api/snippets_api.rb'
-require_relative 'square/api/subscriptions_api.rb'
-require_relative 'square/api/team_api.rb'
-require_relative 'square/api/terminal_api.rb'
+require_relative 'square/api/base_api'
+require_relative 'square/api/mobile_authorization_api'
+require_relative 'square/api/o_auth_api'
+require_relative 'square/api/v1_transactions_api'
+require_relative 'square/api/apple_pay_api'
+require_relative 'square/api/bank_accounts_api'
+require_relative 'square/api/bookings_api'
+require_relative 'square/api/cards_api'
+require_relative 'square/api/cash_drawers_api'
+require_relative 'square/api/catalog_api'
+require_relative 'square/api/customers_api'
+require_relative 'square/api/customer_groups_api'
+require_relative 'square/api/customer_segments_api'
+require_relative 'square/api/devices_api'
+require_relative 'square/api/disputes_api'
+require_relative 'square/api/employees_api'
+require_relative 'square/api/gift_cards_api'
+require_relative 'square/api/gift_card_activities_api'
+require_relative 'square/api/inventory_api'
+require_relative 'square/api/invoices_api'
+require_relative 'square/api/labor_api'
+require_relative 'square/api/locations_api'
+require_relative 'square/api/checkout_api'
+require_relative 'square/api/transactions_api'
+require_relative 'square/api/loyalty_api'
+require_relative 'square/api/merchants_api'
+require_relative 'square/api/orders_api'
+require_relative 'square/api/payments_api'
+require_relative 'square/api/refunds_api'
+require_relative 'square/api/sites_api'
+require_relative 'square/api/snippets_api'
+require_relative 'square/api/subscriptions_api'
+require_relative 'square/api/team_api'
+require_relative 'square/api/terminal_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 13.1.0.20210818
+  version: 14.1.0.20210915
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -31,9 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +169,6 @@ files:
 - lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb
 - lib/square/api/transactions_api.rb
-- lib/square/api/v1_employees_api.rb
 - lib/square/api/v1_transactions_api.rb
 - lib/square/api_helper.rb
 - lib/square/client.rb
@@ -219,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: square

data/lib/square/api/v1_employees_api.rb

@@ -1,362 +0,0 @@
-module Square
-  # V1EmployeesApi
-  class V1EmployeesApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
-    # Provides summary information for all of a business's employees.
-    # @param [SortOrder] order Optional parameter: The order in which employees
-    # are listed in the response, based on their created_at field.      Default
-    # value: ASC
-    # @param [String] begin_updated_at Optional parameter: If filtering results
-    # by their updated_at field, the beginning of the requested reporting
-    # period, in ISO 8601 format
-    # @param [String] end_updated_at Optional parameter: If filtering results by
-    # there updated_at field, the end of the requested reporting period, in ISO
-    # 8601 format.
-    # @param [String] begin_created_at Optional parameter: If filtering results
-    # by their created_at field, the beginning of the requested reporting
-    # period, in ISO 8601 format.
-    # @param [String] end_created_at Optional parameter: If filtering results by
-    # their created_at field, the end of the requested reporting period, in ISO
-    # 8601 format.
-    # @param [V1ListEmployeesRequestStatus] status Optional parameter: If
-    # provided, the endpoint returns only employee entities with the specified
-    # status (ACTIVE or INACTIVE).
-    # @param [String] external_id Optional parameter: If provided, the endpoint
-    # returns only employee entities with the specified external_id.
-    # @param [Integer] limit Optional parameter: The maximum integer number of
-    # employee entities to return in a single response. Default 100, maximum
-    # 200.
-    # @param [String] batch_token Optional parameter: A pagination cursor to
-    # retrieve the next set of results for your original query to the
-    # endpoint.
-    # @return [List of V1Employee Hash] response from the API call
-    def list_employees(order: nil,
-                       begin_updated_at: nil,
-                       end_updated_at: nil,
-                       begin_created_at: nil,
-                       end_created_at: nil,
-                       status: nil,
-                       external_id: nil,
-                       limit: nil,
-                       batch_token: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/employees'
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'order' => order,
-        'begin_updated_at' => begin_updated_at,
-        'end_updated_at' => end_updated_at,
-        'begin_created_at' => begin_created_at,
-        'end_created_at' => end_created_at,
-        'status' => status,
-        'external_id' => external_id,
-        'limit' => limit,
-        'batch_token' => batch_token
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    #  Use the CreateEmployee endpoint to add an employee to a Square
-    # account. Employees created with the Connect API have an initial status
-    # of `INACTIVE`. Inactive employees cannot sign in to Square Point of Sale
-    # until they are activated from the Square Dashboard. Employee status
-    # cannot be changed with the Connect API.
-    # Employee entities cannot be deleted. To disable employee profiles,
-    # set the employee's status to <code>INACTIVE</code>
-    # @param [V1Employee] body Required parameter: An object containing the
-    # fields to POST for the request.  See the corresponding object definition
-    # for field details.
-    # @return [V1Employee Hash] response from the API call
-    def create_employee(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/employees'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    # Provides the details for a single employee.
-    # @param [String] employee_id Required parameter: The employee's ID.
-    # @return [V1Employee Hash] response from the API call
-    def retrieve_employee(employee_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/employees/{employee_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'employee_id' => { 'value' => employee_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    # UpdateEmployee
-    # @param [String] employee_id Required parameter: The ID of the role to
-    # modify.
-    # @param [V1Employee] body Required parameter: An object containing the
-    # fields to POST for the request.  See the corresponding object definition
-    # for field details.
-    # @return [V1Employee Hash] response from the API call
-    def update_employee(employee_id:,
-                        body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/employees/{employee_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'employee_id' => { 'value' => employee_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.put(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    # Provides summary information for all of a business's employee roles.
-    # @param [SortOrder] order Optional parameter: The order in which employees
-    # are listed in the response, based on their created_at field.Default value:
-    # ASC
-    # @param [Integer] limit Optional parameter: The maximum integer number of
-    # employee entities to return in a single response. Default 100, maximum
-    # 200.
-    # @param [String] batch_token Optional parameter: A pagination cursor to
-    # retrieve the next set of results for your original query to the
-    # endpoint.
-    # @return [List of V1EmployeeRole Hash] response from the API call
-    def list_employee_roles(order: nil,
-                            limit: nil,
-                            batch_token: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/roles'
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'order' => order,
-        'limit' => limit,
-        'batch_token' => batch_token
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    # Creates an employee role you can then assign to employees.
-    # Square accounts can include any number of roles that can be assigned to
-    # employees. These roles define the actions and permissions granted to an
-    # employee with that role. For example, an employee with a "Shift Manager"
-    # role might be able to issue refunds in Square Point of Sale, whereas an
-    # employee with a "Clerk" role might not.
-    # Roles are assigned with the
-    # [V1UpdateEmployee]($e/V1Employees/UpdateEmployeeRole)
-    # endpoint. An employee can have only one role at a time.
-    # If an employee has no role, they have none of the permissions associated
-    # with roles. All employees can accept payments with Square Point of Sale.
-    # @param [V1EmployeeRole] body Required parameter: An EmployeeRole object
-    # with a name and permissions, and an optional owner flag.
-    # @return [V1EmployeeRole Hash] response from the API call
-    def create_employee_role(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/roles'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    # Provides the details for a single employee role.
-    # @param [String] role_id Required parameter: The role's ID.
-    # @return [V1EmployeeRole Hash] response from the API call
-    def retrieve_employee_role(role_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/roles/{role_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'role_id' => { 'value' => role_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
-    # Modifies the details of an employee role.
-    # @param [String] role_id Required parameter: The ID of the role to
-    # modify.
-    # @param [V1EmployeeRole] body Required parameter: An object containing the
-    # fields to POST for the request.  See the corresponding object definition
-    # for field details.
-    # @return [V1EmployeeRole Hash] response from the API call
-    def update_employee_role(role_id:,
-                             body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/me/roles/{role_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'role_id' => { 'value' => role_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.put(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-  end
-end