square.rb 6.4.0.20200923 → 6.5.0.20201028

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff331317ad3b1bea0c21cf6a6cc9bfd0b46296890792bf0f5d19d21be6ea8ddb
-  data.tar.gz: dbf543ea3a0ebd7a70cd04e754ffc843d13575899c7e0fe1697c0a538d68fa0c
+  metadata.gz: e89b291628ca9e34dd317c1cabd319b96d3e7861de70eb8e9b1e006f521bd9e7
+  data.tar.gz: 316cd50188c224693b87df34043991a7cea712cfdc22814d08b90268924bd85b
 SHA512:
-  metadata.gz: 15818b53efa7435cc292b14f3d504feef1ab423e3edafdba332694ad229910d8400eb08e6ba67906c19629ac2ecdc9a76251d29f85790fb3046a115aca3a566c
-  data.tar.gz: 749326579ee962e569e387f932af7176f0137e6f6b175e7392bfa9b8e19e872092f34b7f2097fa9ce9d21cd744c2837cd23015e5c826b50510664887bd9ee546
+  metadata.gz: 7d3b58b7592ba99f662b7e6601f9eee48535fa61a5009c159d05a21080e75b5af4f182ba7907e6350830400790fcd802531a62b5130da19392e95e6c8af9322f
+  data.tar.gz: abf4ab1de91013ea370e77fa7186a2f9436831b2611d6bc574d1c1401c6f2d99676c5984c37a5024f5bbd231799b4d4a599bdc43b00557a213f8191a7039cc65

data/README.md

@@ -280,38 +280,39 @@ The Square Platform is built on the [Square API]. Square has a number of other S
 
 You can also use the Square API to create applications or services that work with payments, orders, inventory, etc. that have been created and managed in Square’s in-person hardware products (Square Point of Sale and Square Register).
 
+[//]: # "Link anchor definitions"
 [Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg
 [Developer Dashboard]: https://developer.squareup.com/apps
 [Square API]: https://squareup.com/developers
 [sign up for a developer account]: https://squareup.com/signup?v=developers
 [Client]: doc/client.md
-[Devices]: doc/devices.md
-[Disputes]: doc/disputes.md
-[Terminal]: doc/terminal.md
-[Team]: doc/team.md
-[Cash Drawers]: doc/cash-drawers.md
-[Customer Groups]: doc/customer-groups.md
-[Customer Segments]: doc/customer-segments.md
-[Bank Accounts]: doc/bank-accounts
-[Payments]: doc/payments.md
-[Checkout]: doc/checkout.md
-[Catalog]: doc/catalog.md
-[Customers]: doc/customers.md
-[Employees]: doc/employees.md
-[Inventory]: doc/inventory.md
-[Labor]: doc/labor.md
-[Loyalty]: doc/loyalty.md
-[Locations]: doc/locations.md
-[Merchants]: doc/merchants.md
-[Orders]: doc/orders.md
-[Invoices]: doc/invoices.md
-[Apple Pay]: doc/apple-pay.md
-[Refunds]: doc/refunds.md
-[Mobile Authorization]: doc/mobile-authorization.md
-[O Auth]: doc/o-auth.md
-[V1 Locations]: doc/v1-locations.md
-[V1 Employees]: doc/v1-employees.md
-[V1 Transactions]: doc/v1-transactions.md
-[V1 Items]: doc/v1-items.md
-[Transactions]: doc/transactions.md
-[Subscriptions]: doc/subscriptions.md
+[Devices]: doc/apis/devices.md
+[Disputes]: doc/apis/disputes.md
+[Terminal]: doc/apis/terminal.md
+[Team]: doc/apis/team.md
+[Cash Drawers]: doc/apis/cash-drawers.md
+[Customer Groups]: doc/apis/customer-groups.md
+[Customer Segments]: doc/apis/customer-segments.md
+[Bank Accounts]: doc/apis/bank-accounts
+[Payments]: doc/apis/payments.md
+[Checkout]: doc/apis/checkout.md
+[Catalog]: doc/apis/catalog.md
+[Customers]: doc/apis/customers.md
+[Employees]: doc/apis/employees.md
+[Inventory]: doc/apis/inventory.md
+[Labor]: doc/apis/labor.md
+[Loyalty]: doc/apis/loyalty.md
+[Locations]: doc/apis/locations.md
+[Merchants]: doc/apis/merchants.md
+[Orders]: doc/apis/orders.md
+[Invoices]: doc/apis/invoices.md
+[Apple Pay]: doc/apis/apple-pay.md
+[Refunds]: doc/apis/refunds.md
+[Subscriptions]: doc/apis/subscriptions.md
+[Mobile Authorization]: doc/apis/mobile-authorization.md
+[O Auth]: doc/apis/o-auth.md
+[V1 Locations]: doc/apis/v1-locations.md
+[V1 Employees]: doc/apis/v1-employees.md
+[V1 Transactions]: doc/apis/v1-transactions.md
+[V1 Items]: doc/apis/v1-items.md
+[Transactions]: doc/apis/transactions.md

data/lib/square.rb

@@ -1,61 +1,61 @@
-require 'date'
-require 'json'
-require 'faraday'
-require 'certifi'
-require 'logging'
-
-require_relative 'square/api_helper.rb'
-require_relative 'square/client.rb'
-
-# Utilities
-require_relative 'square/utilities/file_wrapper.rb'
-
-# 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'
-
-# Models
-
-# Exceptions
-require_relative 'square/exceptions/api_exception.rb'
-
-require_relative 'square/configuration.rb'
-
-# 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_locations_api.rb'
-require_relative 'square/api/v1_employees_api.rb'
-require_relative 'square/api/v1_transactions_api.rb'
-require_relative 'square/api/v1_items_api.rb'
-require_relative 'square/api/apple_pay_api.rb'
-require_relative 'square/api/bank_accounts_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/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/subscriptions_api.rb'
-require_relative 'square/api/team_api.rb'
-require_relative 'square/api/terminal_api.rb'
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'square/api_helper.rb'
+require_relative 'square/client.rb'
+
+# Utilities
+require_relative 'square/utilities/file_wrapper.rb'
+
+# 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'
+
+# Models
+
+# Exceptions
+require_relative 'square/exceptions/api_exception.rb'
+
+require_relative 'square/configuration.rb'
+
+# 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_locations_api.rb'
+require_relative 'square/api/v1_employees_api.rb'
+require_relative 'square/api/v1_transactions_api.rb'
+require_relative 'square/api/v1_items_api.rb'
+require_relative 'square/api/apple_pay_api.rb'
+require_relative 'square/api/bank_accounts_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/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/subscriptions_api.rb'
+require_relative 'square/api/team_api.rb'
+require_relative 'square/api/terminal_api.rb'

data/lib/square/api/apple_pay_api.rb

@@ -44,7 +44,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/bank_accounts_api.rb

@@ -7,9 +7,6 @@ module Square
 
     # Returns a list of [BankAccount](#type-bankaccount) objects linked to a
     # Square account.
-    # For more information, see
-    # [Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
     # @param [String] cursor Optional parameter: The pagination cursor returned
     # by a previous call to this endpoint. Use it in the next `ListBankAccounts`
     # request to retrieve the next set  of results.  See the
@@ -53,15 +50,13 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns details of a [BankAccount](#type-bankaccount) identified by V1
     # bank account ID.
-    # For more information, see
-    # [Retrieve a bank account by using an ID issued by V1 Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a
-    # -bank-account-by-using-an-id-issued-by-the-v1-bank-accounts-api).
     # @param [String] v1_bank_account_id Required parameter: Connect V1 ID of
     # the desired `BankAccount`. For more information, see  [Retrieve a bank
     # account by using an ID issued by V1 Bank Accounts
@@ -74,7 +69,7 @@ module Square
       _query_builder << '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'v1_bank_account_id' => v1_bank_account_id
+        'v1_bank_account_id' => { 'value' => v1_bank_account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -94,13 +89,13 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns details of a [BankAccount](#type-bankaccount)
-    # linked to a Square account. For more information, see
-    # [Bank Accounts
-    # API](https://developer.squareup.com/docs/docs/bank-accounts-api).
+    # linked to a Square account.
     # @param [String] bank_account_id Required parameter: Square-issued ID of
     # the desired `BankAccount`.
     # @return [GetBankAccountResponse Hash] response from the API call
@@ -110,7 +105,7 @@ module Square
       _query_builder << '/v2/bank-accounts/{bank_account_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'bank_account_id' => bank_account_id
+        'bank_account_id' => { 'value' => bank_account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -130,7 +125,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

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/6.4.0.20200923',
+        'user-agent' => 'Square-Ruby-SDK/6.5.0.20201028',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/cash_drawers_api.rb

@@ -57,7 +57,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides the summary details for a single cash drawer shift. See
@@ -73,7 +75,7 @@ module Square
       _query_builder << '/v2/cash-drawers/shifts/{shift_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'shift_id' => shift_id
+        'shift_id' => { 'value' => shift_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -97,7 +99,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides a paginated list of events for a single cash drawer shift.
@@ -118,7 +122,7 @@ module Square
       _query_builder << '/v2/cash-drawers/shifts/{shift_id}/events'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'shift_id' => shift_id
+        'shift_id' => { 'value' => shift_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -144,7 +148,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/catalog_api.rb

@@ -44,7 +44,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns a set of objects based on the provided ID.
@@ -83,7 +85,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates or updates up to 10,000 target objects based on the provided
@@ -128,10 +132,12 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Uploads an image file to be represented by an
+    # Uploads an image file to be represented by a
     # [CatalogImage](#type-catalogimage) object linked to an existing
     # [CatalogObject](#type-catalogobject) instance. A call to this endpoint can
     # upload an image, link an image to
@@ -139,10 +145,6 @@ module Square
     # This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data
     # requests with a JSON part and an image file part in
     # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
-    # Additional information and an example cURL request can be found in the
-    # [Create a Catalog Image
-    # recipe](https://developer.squareup.com/docs/more-apis/catalog/cookbook/cre
-    # ate-catalog-images).
     # @param [CreateCatalogImageRequest] request Optional parameter: Example:
     # @param [File | UploadIO] image_file Optional parameter: Example:
     # @return [CreateCatalogImageResponse Hash] response from the API call
@@ -191,7 +193,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Retrieves information about the Square Catalog API, such as batch size
@@ -219,7 +223,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns a list of [CatalogObject](#type-catalogobject)s that includes
@@ -274,7 +280,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates or updates the target [CatalogObject](#type-catalogobject).
@@ -306,7 +314,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Deletes a single [CatalogObject](#type-catalogobject) based on the
@@ -328,7 +338,7 @@ module Square
       _query_builder << '/v2/catalog/object/{object_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'object_id' => object_id
+        'object_id' => { 'value' => object_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -348,7 +358,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns a single [CatalogItem](#type-catalogitem) as a
@@ -364,12 +376,12 @@ module Square
     # @param [Boolean] include_related_objects Optional parameter: If `true`,
     # the response will include additional objects that are related to the
     # requested object, as follows:  If the `object` field of the response
-    # contains a CatalogItem, its associated CatalogCategory, CatalogTax
-    # objects, CatalogImages and CatalogModifierLists will be returned in the
+    # contains a `CatalogItem`, its associated `CatalogCategory`, `CatalogTax`,
+    # `CatalogImage` and `CatalogModifierList` objects will be returned in the
     # `related_objects` field of the response. If the `object` field of the
-    # response contains a CatalogItemVariation, its parent CatalogItem will be
-    # returned in the `related_objects` field of the response.  Default value:
-    # `false`
+    # response contains a `CatalogItemVariation`, its parent `CatalogItem` will
+    # be returned in the `related_objects` field of the response.  Default
+    # value: `false`
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false)
@@ -378,7 +390,7 @@ module Square
       _query_builder << '/v2/catalog/object/{object_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'object_id' => object_id
+        'object_id' => { 'value' => object_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -402,7 +414,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Searches for [CatalogObject](#type-CatalogObject) of any types against
@@ -450,7 +464,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Searches for catalog items or item variations by matching supported search
@@ -498,7 +514,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Updates the [CatalogModifierList](#type-catalogmodifierlist) objects
@@ -532,7 +550,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Updates the [CatalogTax](#type-catalogtax) objects that apply to the
@@ -566,7 +586,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end