square.rb 22.0.0.20220817 → 23.0.0.20220921

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7406eafacea5f827425c9891d255ae7294e87d6129ca8fdbe9c6d3afe2ca8976
-  data.tar.gz: fbada6b040581a4189aae2d6aa6a55ba76be2551e08191d94f054b2aa4133c96
+  metadata.gz: b74663d36bae14fe320c23d640aa2172cf62cf6c4826a626360917627cf5f7c1
+  data.tar.gz: d85621b6ae408a39d492d5d7a5d28721af66eb881f6b7666e1e5a0fc73639b1d
 SHA512:
-  metadata.gz: a13e3097da587460e8d566a5f51c389707d0945840c569795473d3e27851706a96f3e944656cc9cd1d6fd2309f784d77cc91ff35323257a93594f58f6c310cba
-  data.tar.gz: 876ee033a900d638697c0e992a73d8406febe43b9a1cab66666cfc4f3f375c2feca3763cdc32d4161b5b7545cb5e91d3e24d61867d68959c3ad3611191e2e909
+  metadata.gz: a8486bc18c8303c18e64183a16136fb826ffca13451106cb06a43e8d8377b03e8e169a3f54e75f3f511c99268d6c40be24472512b35919df22c3138a937c4057
+  data.tar.gz: cf3be15a882df1d1b323057ddb065aec10bd870da9e8ebd6ef9b625393b4af14379d6f61d1565f235647472d7a61a2e1c67e6a6a9220b4d273c3f24f05059c8b

data/README.md

@@ -8,6 +8,14 @@
 
 Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
 
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Quickstart](#quickstart)
+* [Usage](#usage)
+* [Tests](#tests)
+* [SDK Reference](#sdk-reference)
+* [Deprecated APIs](#deprecated-apis)
+
 ## Requirements
 
 Use of the Square Ruby SDK requires:
@@ -114,18 +122,19 @@ rake
 * [Sites]
 * [Snippets]
 
-### Authorization APIs
+### Authorization
 * [Mobile Authorization]
 * [OAuth]
 
-### Deprecated APIs
-* [Employees]
-* [V1 Employees]
-* [V1 Transactions]
-* [V1 Items]
-* [Transactions]
+## Deprecated APIs
+
+The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle):
 
+* [Employees] - replaced by the [Team] API. For more information, see [Migrate from the Employees API](https://developer.squareup.com/docs/team/migrate-from-v2-employees).
 
+* [Transactions] - replaced by the [Orders] and [Payments] APIs.  For more information, see [Migrate from the Transactions API](https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api).
+
+  
 [//]: # "Link anchor definitions"
 [Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg
 [Developer Dashboard]: https://developer.squareup.com/apps
@@ -146,7 +155,6 @@ rake
 [Catalog]: doc/api/catalog.md
 [Customers]: doc/api/customers.md
 [Customer Custom Attributes]: doc/api/customer-custom-attributes.md
-[Employees]: doc/api/employees.md
 [Inventory]: doc/api/inventory.md
 [Labor]: doc/api/labor.md
 [Loyalty]: doc/api/loyalty.md
@@ -160,13 +168,11 @@ rake
 [Subscriptions]: doc/api/subscriptions.md
 [Mobile Authorization]: doc/api/mobile-authorization.md
 [OAuth]: doc/api/o-auth.md
-[V1 Employees]: doc/api/v1-employees.md
-[V1 Transactions]: doc/api/v1-transactions.md
-[V1 Items]: doc/api/v1-items.md
-[Transactions]: doc/api/transactions.md
 [Sites]: doc/api/sites.md
 [Snippets]: doc/api/snippets.md
 [Cards]: doc/api/cards.md
 [Payouts]: doc/api/payouts.md
 [Gift Cards]: doc/api/gift-cards.md
 [Gift Card Activities]: doc/api/gift-card-activities.md
+[Employees]: doc/api/employees.md
+[Transactions]: doc/api/transactions.md

data/lib/square/api/apple_pay_api.rb

@@ -13,10 +13,16 @@ module Square
     # This endpoint provides an easy way for platform developers to bulk
     # activate
     # Apple Pay on the Web with Square for merchants using their platform.
-    # To learn more about Web Apple Pay, see
-    # [Add the Apple Pay on the Web
-    # Button](https://developer.squareup.com/docs/payment-form/add-digital-walle
-    # ts/apple-pay).
+    # Note: The SqPaymentForm library is deprecated as of May 13, 2021, and will
+    # only receive critical security updates until it is retired on October 31,
+    # 2022.
+    # You must migrate your payment form code to the Web Payments SDK to
+    # continue using your domain for Apple Pay. For more information on
+    # migrating to the Web Payments SDK, see [Migrate to the Web Payments
+    # SDK](https://developer.squareup.com/docs/web-payments/migrate).
+    # To learn more about the Web Payments SDK and how to add Apple Pay, see
+    # [Take an Apple Pay
+    # Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
     # @param [RegisterDomainRequest] 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/base_api.rb

@@ -45,7 +45,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/22.0.0.20220817 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/23.0.0.20220921 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
       user_agent['{engine}'] = RUBY_ENGINE
       user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
       user_agent['{os-info}'] = RUBY_PLATFORM

data/lib/square/api/loyalty_api.rb

@@ -133,8 +133,11 @@ module Square
     # the loyalty program and
     # loyalty promotion. For spend-based and visit-based programs, you can call
     # [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints)
-    # to compute the points earned from the loyalty program (but not points
-    # earned from a loyalty promotion).
+    # to compute the points earned from the base loyalty program. For
+    # information about computing points earned from a loyalty promotion, see
+    # [Calculating promotion
+    # points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions
+    # #calculate-promotion-points).
     # @param [String] account_id Required parameter: The ID of the target
     # [loyalty account]($m/LoyaltyAccount).
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object

data/lib/square/api/v1_transactions_api.rb

@@ -16,11 +16,11 @@ module Square
     # retrieve the next set of results for your original query to the
     # endpoint.
     # @return [List of V1Order Hash] response from the API call
-    def list_orders(location_id:,
-                    order: nil,
-                    limit: nil,
-                    batch_token: nil)
-      warn 'Endpoint list_orders in V1TransactionsApi is deprecated'
+    def v1_list_orders(location_id:,
+                       order: nil,
+                       limit: nil,
+                       batch_token: nil)
+      warn 'Endpoint v1_list_orders in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders'
@@ -65,9 +65,9 @@ module Square
     # You obtain this value from Order objects returned by the List Orders
     # endpoint
     # @return [V1Order Hash] response from the API call
-    def retrieve_order(location_id:,
-                       order_id:)
-      warn 'Endpoint retrieve_order in V1TransactionsApi is deprecated'
+    def v1_retrieve_order(location_id:,
+                          order_id:)
+      warn 'Endpoint v1_retrieve_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -110,10 +110,10 @@ module Square
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
     # @return [V1Order Hash] response from the API call
-    def update_order(location_id:,
-                     order_id:,
-                     body:)
-      warn 'Endpoint update_order in V1TransactionsApi is deprecated'
+    def v1_update_order(location_id:,
+                        order_id:,
+                        body:)
+      warn 'Endpoint v1_update_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -180,14 +180,14 @@ module Square
     # Partial payments will have the tenders collected so far, but the
     # itemizations will be empty until the payment is completed.
     # @return [List of V1Payment Hash] response from the API call
-    def list_payments(location_id:,
-                      order: nil,
-                      begin_time: nil,
-                      end_time: nil,
-                      limit: nil,
-                      batch_token: nil,
-                      include_partial: false)
-      warn 'Endpoint list_payments in V1TransactionsApi is deprecated'
+    def v1_list_payments(location_id:,
+                         order: nil,
+                         begin_time: nil,
+                         end_time: nil,
+                         limit: nil,
+                         batch_token: nil,
+                         include_partial: false)
+      warn 'Endpoint v1_list_payments in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments'
@@ -235,9 +235,9 @@ module Square
     # endpoint, Settlement objects returned by the List Settlements endpoint, or
     # Refund objects returned by the List Refunds endpoint.
     # @return [V1Payment Hash] response from the API call
-    def retrieve_payment(location_id:,
-                         payment_id:)
-      warn 'Endpoint retrieve_payment in V1TransactionsApi is deprecated'
+    def v1_retrieve_payment(location_id:,
+                            payment_id:)
+      warn 'Endpoint v1_retrieve_payment in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
@@ -293,13 +293,13 @@ module Square
     # retrieve the next set of results for your original query to the
     # endpoint.
     # @return [List of V1Refund Hash] response from the API call
-    def list_refunds(location_id:,
-                     order: nil,
-                     begin_time: nil,
-                     end_time: nil,
-                     limit: nil,
-                     batch_token: nil)
-      warn 'Endpoint list_refunds in V1TransactionsApi is deprecated'
+    def v1_list_refunds(location_id:,
+                        order: nil,
+                        begin_time: nil,
+                        end_time: nil,
+                        limit: nil,
+                        batch_token: nil)
+      warn 'Endpoint v1_list_refunds in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -354,9 +354,9 @@ module Square
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
     # @return [V1Refund Hash] response from the API call
-    def create_refund(location_id:,
-                      body:)
-      warn 'Endpoint create_refund in V1TransactionsApi is deprecated'
+    def v1_create_refund(location_id:,
+                         body:)
+      warn 'Endpoint v1_create_refund in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -417,14 +417,14 @@ module Square
     # retrieve the next set of results for your original query to the
     # endpoint.
     # @return [List of V1Settlement Hash] response from the API call
-    def list_settlements(location_id:,
-                         order: nil,
-                         begin_time: nil,
-                         end_time: nil,
-                         limit: nil,
-                         status: nil,
-                         batch_token: nil)
-      warn 'Endpoint list_settlements in V1TransactionsApi is deprecated'
+    def v1_list_settlements(location_id:,
+                            order: nil,
+                            begin_time: nil,
+                            end_time: nil,
+                            limit: nil,
+                            status: nil,
+                            batch_token: nil)
+      warn 'Endpoint v1_list_settlements in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements'
@@ -485,9 +485,9 @@ module Square
     # Square-issued ID. You obtain this value from Settlement objects returned
     # by the List Settlements endpoint.
     # @return [V1Settlement Hash] response from the API call
-    def retrieve_settlement(location_id:,
-                            settlement_id:)
-      warn 'Endpoint retrieve_settlement in V1TransactionsApi is deprecated'
+    def v1_retrieve_settlement(location_id:,
+                               settlement_id:)
+      warn 'Endpoint v1_retrieve_settlement in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements/{settlement_id}'

data/lib/square/api/webhook_subscriptions_api.rb

@@ -56,8 +56,7 @@ module Square
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to be returned in a single page. It is possible to receive fewer results
     # than the specified limit on a given page. The default value of 100 is also
-    # the maximum allowed value. If the provided value is greater than 100, it
-    # is ignored and the default value is used instead.  Default: 100
+    # the maximum allowed value.  Default: 100
     # @return [ListWebhookSubscriptionsResponse Hash] response from the API call
     def list_webhook_subscriptions(cursor: nil,
                                    include_disabled: false,

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '22.0.0.20220817'
+      '23.0.0.20220921'
     end
 
     def square_version
@@ -242,7 +242,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: '2022-08-17', access_token: '',
+                   square_version: '2022-09-21', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -20,7 +20,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: '2022-08-17', access_token: '',
+                   square_version: '2022-09-21', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 22.0.0.20220817
+  version: 23.0.0.20220921
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -31,9 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement