square.rb 10.0.0.202104217 → 11.0.0.20210513

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c9c3a6b13fa697e2fffc362d766cb1b7ded51f360ad7fcf342039d2623911d
-  data.tar.gz: 11954b03a0f85edec268ef6d4f7bb020386dfba4134f28a720c5b6c39b3c2315
+  metadata.gz: 5bd47b45ea9eca98fd3703e49daddc69b4b2ff2dea6d7badf813f75712ef1a41
+  data.tar.gz: a26991adca5e6f459a2467678cce0f61e244b2a997aa60750ed2d3a17f183aec
 SHA512:
-  metadata.gz: cc03189601f3985171af4af574f987b31d4c3132ffb96b7d4ada0996056309183a50d1f02a8af602a9a63543f0737903f336185a7e4284db324df74ff114f6e5
-  data.tar.gz: 042712b0f44ce7a117e7b1cd7f9286d4ada8c033d54b9e347e62a4dc491463fa984f5f0590c9a6d29ef0f3bade77199ee76eab60f4c7960c12a6e95d551acc15
+  metadata.gz: 4923c144ec01aade0ca6386fef939d257213eac3f55565fcf29f34c9876e032c9ff47004e04d36453b70028d00b04573911c59434654cd500f655b3a718df04b
+  data.tar.gz: 9b2539e8da3c4d0e613c76e27a0ae82c64accac2008e7db8ca324cb48e19cfe663e65f1b86118ba56f133daeaf813e98dad05f1bd75144c198494c07fe61457d

data/README.md

@@ -2,7 +2,7 @@
 
 # Square Ruby SDK
 
-[![Travis status](https://travis-ci.org/square/square-ruby-sdk.svg?branch=master)](https://travis-ci.org/square/square-ruby-sdk)
+[![Build](https://github.com/square/square-ruby-sdk/actions/workflows/ruby.yml/badge.svg)](https://github.com/square/square-ruby-sdk/actions/workflows/ruby.yml)
 [![Gem version](https://badge.fury.io/rb/square.rb.svg?new)](https://badge.fury.io/rb/square.rb)
 [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
@@ -73,9 +73,13 @@ gem 'square.rb'
 ### Financials
 * [Bank Accounts]
 
+### Online
+* [Sites]
+* [Snippets]
+
 ### Authorization APIs
 * [Mobile Authorization]
-* [O Auth]
+* [OAuth]
 
 ### Deprecated APIs
 * [V1 Employees]
@@ -322,8 +326,10 @@ You can also use the Square API to create applications or services that work wit
 [Refunds]: doc/api/refunds.md
 [Subscriptions]: doc/api/subscriptions.md
 [Mobile Authorization]: doc/api/mobile-authorization.md
-[O Auth]: doc/api/o-auth.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

data/lib/square.rb

@@ -55,6 +55,8 @@ 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'

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

data/lib/square/api/catalog_api.rb

@@ -241,7 +241,8 @@ module Square
     # [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
     # and set the `include_deleted_objects` attribute value to `true`.
     # @param [String] cursor Optional parameter: The pagination cursor returned
-    # in the previous response. Leave unset for an initial request. See
+    # in the previous response. Leave unset for an initial request. The page
+    # size is currently set to be 100. See
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
     # @param [String] types Optional parameter: An optional case-insensitive,

data/lib/square/api/loyalty_api.rb

@@ -6,8 +6,7 @@ module Square
     end
 
     # Creates a loyalty account. To create a loyalty account, you must provide
-    # the `program_id` and either the `mapping` field (preferred) or the
-    # `mappings` field.
+    # the `program_id` and a `mapping` with the `phone_number` of the buyer.
     # @param [CreateLoyaltyAccountRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -254,9 +253,16 @@ module Square
     end
 
     # Returns a list of loyalty programs in the seller's account.
-    # Currently, a seller can only have one loyalty program.
+    # Loyalty programs define how buyers can earn points and redeem points for
+    # rewards. Square sellers can have only one loyalty program, which is
+    # created and managed from the Seller Dashboard. For more information, see
+    # [Loyalty Program
+    # Overview](https://developer.squareup.com/docs/loyalty/overview).
+    # Replaced with [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram)
+    # when used with the keyword `main`.
     # @return [ListLoyaltyProgramsResponse Hash] response from the API call
     def list_loyalty_programs
+      warn 'Endpoint list_loyalty_programs in LoyaltyApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/loyalty/programs'

data/lib/square/api/orders_api.rb

@@ -5,13 +5,12 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a new [Order]($m/Order) which can include information on products
-    # for
+    # Creates a new [order]($m/Order) that can include information about
+    # products for
     # purchase and settings to apply to the purchase.
-    # To pay for a created order, please refer to the
+    # To pay for a created order, see
     # [Pay for
-    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
-    # guide.
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).
     # You can modify open orders using the [UpdateOrder]($e/Orders/UpdateOrder)
     # endpoint.
     # @param [CreateOrderRequest] body Required parameter: An object containing
@@ -47,8 +46,8 @@ module Square
       )
     end
 
-    # Retrieves a set of [Order]($m/Order)s by their IDs.
-    # If a given Order ID does not exist, the ID is ignored instead of
+    # Retrieves a set of [orders]($m/Order) by their IDs.
+    # If a given order ID does not exist, the ID is ignored instead of
     # generating an error.
     # @param [BatchRetrieveOrdersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -119,17 +118,18 @@ module Square
 
     # 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 (e.g. Point of Sale, Invoices, Connect APIs, etc).
-    # SearchOrders requests need to specify which locations to search and define
-    # a
-    # [`SearchOrdersQuery`]($m/SearchOrdersQuery) object which controls
-    # how to sort or filter the results. Your SearchOrdersQuery can:
+    # ecosystem (such as Point of Sale, Invoices, and Connect APIs).
+    # `SearchOrders` requests need to specify which locations to search and
+    # define a
+    # [SearchOrdersQuery]($m/SearchOrdersQuery) object that controls
+    # how to sort or filter the results. Your `SearchOrdersQuery` can:
     #   Set filter criteria.
-    #   Set sort order.
-    #   Determine whether to return results as complete Order objects, or as
+    #   Set the sort order.
+    #   Determine whether to return results as complete `Order` objects or as
     # [OrderEntry]($m/OrderEntry) objects.
     # Note that details for orders processed with Square Point of Sale while in
-    # offline mode may not be transmitted to Square for up to 72 hours. Offline
+    # offline mode might not be transmitted to Square for up to 72 hours.
+    # Offline
     # orders have a `created_at` value that reflects the time the order was
     # created,
     # not the time it was subsequently transmitted to Square.
@@ -201,24 +201,24 @@ module Square
       )
     end
 
-    # Updates an open [Order]($m/Order) by adding, replacing, or deleting
+    # Updates an open [order]($m/Order) by adding, replacing, or deleting
     # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
-    # An UpdateOrder request requires the following:
+    # An `UpdateOrder` request requires the following:
     # - The `order_id` in the endpoint path, identifying the order to update.
     # - The latest `version` of the order to update.
     # - The [sparse
     # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
     # -order-objects)
-    # containing only the fields to update and the version the update is
-    # being applied to.
+    # containing only the fields to update and the version to which the update
+    # is
+    # being applied.
     # - If deleting fields, the [dot notation
     # paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot
     # -notation)
-    # identifying fields to clear.
-    # To pay for an order, please refer to the
+    # identifying the fields to clear.
+    # To pay for an order, see
     # [Pay for
-    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
-    # guide.
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).
     # @param [String] order_id Required parameter: The ID of the order to
     # update.
     # @param [UpdateOrderRequest] body Required parameter: An object containing
@@ -260,23 +260,23 @@ module Square
     end
 
     # Pay for an [order]($m/Order) using one or more approved
-    # [payments]($m/Payment),
+    # [payments]($m/Payment)
     # or settle an order with a total of `0`.
     # The total of the `payment_ids` listed in the request must be equal to the
     # order
     # total. Orders with a total amount of `0` can be marked as paid by
     # specifying an empty
     # array of `payment_ids` in the request.
-    # To be used with PayOrder, a payment must:
+    # To be used with `PayOrder`, a payment must:
     # - Reference the order by specifying the `order_id` when [creating the
     # payment]($e/Payments/CreatePayment).
     # Any approved payments that reference the same `order_id` not specified in
     # the
-    # `payment_ids` will be canceled.
+    # `payment_ids` is canceled.
     # - Be approved with [delayed
     # capture](https://developer.squareup.com/docs/payments-api/take-payments#de
     # layed-capture).
-    # Using a delayed capture payment with PayOrder will complete the approved
+    # Using a delayed capture payment with `PayOrder` completes the approved
     # payment.
     # @param [String] order_id Required parameter: The ID of the order being
     # paid.

data/lib/square/api/sites_api.rb

@@ -0,0 +1,42 @@
+module Square
+  # SitesApi
+  class SitesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists the Square Online sites that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @return [ListSitesResponse Hash] response from the API call
+    def list_sites
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites'
+      _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
+  end
+end

data/lib/square/api/snippets_api.rb

@@ -0,0 +1,146 @@
+module Square
+  # SnippetsApi
+  class SnippetsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Removes your snippet from a Square Online site.
+    # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
+    # that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @param [String] site_id Required parameter: The ID of the site that
+    # contains the snippet.
+    # @return [DeleteSnippetResponse Hash] response from the API call
+    def delete_snippet(site_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites/{site_id}/snippet'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'site_id' => { 'value' => site_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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
+
+    # Retrieves your snippet from a Square Online site. A site can contain
+    # snippets from multiple snippet applications, but you can retrieve only the
+    # snippet that was added by your application.
+    # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
+    # that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @param [String] site_id Required parameter: The ID of the site that
+    # contains the snippet.
+    # @return [RetrieveSnippetResponse Hash] response from the API call
+    def retrieve_snippet(site_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites/{site_id}/snippet'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'site_id' => { 'value' => site_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
+
+    # Adds a snippet to a Square Online site or updates the existing snippet on
+    # the site.
+    # The snippet code is appended to the end of the `head` element on every
+    # page of the site, except checkout pages. A snippet application can add one
+    # snippet to a given site.
+    # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
+    # that belong to a seller.
+    # __Note:__ Square Online APIs are publicly available as part of an early
+    # access program. For more information, see [Early access program for Square
+    # Online
+    # APIs](https://developer.squareup.com/docs/online-api#early-access-program-
+    # for-square-online-apis).
+    # @param [String] site_id Required parameter: The ID of the site where you
+    # want to add or update the snippet.
+    # @param [UpsertSnippetRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [UpsertSnippetResponse Hash] response from the API call
+    def upsert_snippet(site_id:,
+                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/sites/{site_id}/snippet'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'site_id' => { 'value' => site_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.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
+  end
+end

data/lib/square/api/v1_transactions_api.rb

@@ -20,6 +20,7 @@ module Square
                     order: nil,
                     limit: nil,
                     batch_token: nil)
+      warn 'Endpoint list_orders in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders'
@@ -66,6 +67,7 @@ module Square
     # @return [V1Order Hash] response from the API call
     def retrieve_order(location_id:,
                        order_id:)
+      warn 'Endpoint retrieve_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -111,6 +113,7 @@ module Square
     def update_order(location_id:,
                      order_id:,
                      body:)
+      warn 'Endpoint update_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
@@ -184,6 +187,7 @@ module Square
                       limit: nil,
                       batch_token: nil,
                       include_partial: false)
+      warn 'Endpoint list_payments in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments'
@@ -233,6 +237,7 @@ module Square
     # @return [V1Payment Hash] response from the API call
     def retrieve_payment(location_id:,
                          payment_id:)
+      warn 'Endpoint retrieve_payment in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
@@ -294,6 +299,7 @@ module Square
                      end_time: nil,
                      limit: nil,
                      batch_token: nil)
+      warn 'Endpoint list_refunds in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -350,6 +356,7 @@ module Square
     # @return [V1Refund Hash] response from the API call
     def create_refund(location_id:,
                       body:)
+      warn 'Endpoint create_refund in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
@@ -417,6 +424,7 @@ module Square
                          limit: nil,
                          status: nil,
                          batch_token: nil)
+      warn 'Endpoint list_settlements in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements'
@@ -479,6 +487,7 @@ module Square
     # @return [V1Settlement Hash] response from the API call
     def retrieve_settlement(location_id:,
                             settlement_id:)
+      warn 'Endpoint 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/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '10.0.0.202104217'
+      '11.0.0.20210513'
     end
 
     def square_version
@@ -167,6 +167,18 @@ module Square
       @refunds ||= RefundsApi.new config
     end
 
+    # Access to sites controller.
+    # @return [SitesApi] Returns the controller instance.
+    def sites
+      @sites ||= SitesApi.new config
+    end
+
+    # Access to snippets controller.
+    # @return [SnippetsApi] Returns the controller instance.
+    def snippets
+      @snippets ||= SnippetsApi.new config
+    end
+
     # Access to subscriptions controller.
     # @return [SubscriptionsApi] Returns the controller instance.
     def subscriptions
@@ -188,7 +200,7 @@ module Square
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-04-21', access_token: 'TODO: Replace',
+                   square_version: '2021-05-13', 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

@@ -24,7 +24,7 @@ module Square
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-04-21', access_token: 'TODO: Replace',
+                   square_version: '2021-05-13', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 10.0.0.202104217
+  version: 11.0.0.20210513
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -160,6 +160,8 @@ files:
 - lib/square/api/orders_api.rb
 - lib/square/api/payments_api.rb
 - lib/square/api/refunds_api.rb
+- lib/square/api/sites_api.rb
+- lib/square/api/snippets_api.rb
 - lib/square/api/subscriptions_api.rb
 - lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb