square.rb 35.0.0.20240118 → 36.0.0.20240222

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 249614d84c1818c028f583951e3fa380f1533985909801204a1ee94eb0a91733
-  data.tar.gz: 4ae2b2cceb63628934b529fff05bd58f2cd27d8f22ae10a44ec26e0bc40f087d
+  metadata.gz: ea20e3c2ee0ef503bef9ebb50a42a318ac2bfd2a38cd0462550e6590be2b8750
+  data.tar.gz: 7da667a65f84a3ac563d9422ad550b0654f2fb6083ea636f3ba1030d22743335
 SHA512:
-  metadata.gz: 7ebdb416a8041d2d70a9d8108ce432ec26f2558bc67589a5f5e5625625f4366f4998d20575e0a8ac9e872b11a37133180ee6b27d7fffc9147674ff89a638f05e
-  data.tar.gz: 8fe1a39713a031a36023433a9a84c7492654a28adbd1c02a5130513cfd936336ad2c9c7d53ec707623498f8fc4bc3972bd9a2c45756664d2b628350c45b0ee45
+  metadata.gz: 9f0441c199381f05274e0e2afc4a5f2620773a9f72ba1a8b6eb76e137ee7c6129d076bba6cfe779dd20c7aa00238db283d9e3e2b06c8682dfa88a7d85aa1e164
+  data.tar.gz: f5bb1c5f90feb1af56ee67027606145a36672a7c69a1fe0e0e81049f07c7eb9dbe04384538b09565130c951cf005d61cd3919aaf61889be70018f45780a3dd07

data/lib/square/api/base_api.rb

@@ -1,10 +1,11 @@
 module Square
   # BaseApi.
   class BaseApi
+    include CoreLibrary
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/35.0.0.20240118 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/36.0.0.20240222 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/checkout_api.rb

@@ -125,8 +125,8 @@ module Square
     # a previous call to this endpoint. Provide this cursor to retrieve the next
     # set of results for the original query. If a cursor is not provided, the
     # endpoint returns the first page of the results. For more  information, see
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # .
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: A limit on the number of
     # results to return per page. The limit is advisory and the implementation
     # might return more or less results. If the supplied limit is negative,

data/lib/square/api/customers_api.rb

@@ -83,6 +83,109 @@ module Square
         .execute
     end
 
+    # Creates multiple [customer profiles]($m/Customer) for a business.
+    # This endpoint takes a map of individual create requests and returns a map
+    # of responses.
+    # You must provide at least one of the following values in each create
+    # request:
+    # - `given_name`
+    # - `family_name`
+    # - `company_name`
+    # - `email_address`
+    # - `phone_number`
+    # @param [BulkCreateCustomersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkCreateCustomersResponse Hash] response from the API call
+    def bulk_create_customers(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/customers/bulk-create',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes multiple customer profiles.
+    # The endpoint takes a list of customer IDs and returns a map of responses.
+    # @param [BulkDeleteCustomersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkDeleteCustomersResponse Hash] response from the API call
+    def bulk_delete_customers(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/customers/bulk-delete',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Retrieves multiple customer profiles.
+    # This endpoint takes a list of customer IDs and returns a map of responses.
+    # @param [BulkRetrieveCustomersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkRetrieveCustomersResponse Hash] response from the API call
+    def bulk_retrieve_customers(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/customers/bulk-retrieve',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Updates multiple customer profiles.
+    # This endpoint takes a map of individual update requests and returns a map
+    # of responses.
+    # You cannot use this endpoint to change cards on file. To make changes, use
+    # the [Cards API]($e/Cards) or [Gift Cards API]($e/GiftCards).
+    # @param [BulkUpdateCustomersRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkUpdateCustomersResponse Hash] response from the API call
+    def bulk_update_customers(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/customers/bulk-update',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
     # Searches the customer profiles associated with a Square account using one
     # or more supported query filters.
     # Calling `SearchCustomers` without any explicit query filter returns all
@@ -117,12 +220,6 @@ module Square
 
     # Deletes a customer profile from a business. This operation also unlinks
     # any associated cards on file.
-    # As a best practice, include the `version` field in the request to enable
-    # [optimistic
-    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
-    # atterns/optimistic-concurrency) control.
-    # If included, the value must be set to the current version of the customer
-    # profile.
     # To delete a customer profile that was created by merging existing
     # profiles, you must use the ID of the newly created profile.
     # @param [String] customer_id Required parameter: The ID of the customer to
@@ -177,14 +274,7 @@ module Square
     # Updates a customer profile. This endpoint supports sparse updates, so only
     # new or changed fields are required in the request.
     # To add or update a field, specify the new value. To remove a field,
-    # specify `null`
-    # (recommended) or specify an empty string (string fields only).
-    # As a best practice, include the `version` field in the request to enable
-    # [optimistic
-    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
-    # atterns/optimistic-concurrency) control.
-    # If included, the value must be set to the current version of the customer
-    # profile.
+    # specify `null`.
     # To update a customer profile that was created by merging existing
     # profiles, you must use the ID of the newly created profile.
     # You cannot use this endpoint to change cards on file. To make changes, use

data/lib/square/api/invoices_api.rb

@@ -276,9 +276,13 @@ module Square
     # The invoice `status` also changes from `DRAFT` to a status
     # based on the invoice configuration. For example, the status changes to
     # `UNPAID` if
-    # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
+    # Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on
     # file for a portion of the
     # invoice amount.
+    # In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE`
+    # permissions, `CUSTOMERS_READ`
+    # and `PAYMENTS_WRITE` are required when publishing invoices configured for
+    # card-on-file payments.
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # publish.
     # @param [PublishInvoiceRequest] body Required parameter: An object

data/lib/square/api/locations_api.rb

@@ -3,7 +3,8 @@ module Square
   class LocationsApi < BaseApi
     # Provides details about all of the seller's
     # [locations](https://developer.squareup.com/docs/locations-api),
-    # including those with an inactive status.
+    # including those with an inactive status. Locations are listed
+    # alphabetically by `name`.
     # @return [ListLocationsResponse Hash] response from the API call
     def list_locations
       new_api_call_builder

data/lib/square/api/v1_transactions_api.rb

@@ -98,284 +98,5 @@ module Square
                    .convertor(ApiResponse.method(:create)))
         .execute
     end
-
-    # Provides summary information for all payments taken for a given
-    # Square account during a date range. Date ranges cannot exceed 1 year in
-    # length. See Date ranges for details of inclusive and exclusive dates.
-    # *Note**: Details for payments processed with Square Point of Sale while
-    # in offline mode may not be transmitted to Square for up to 72 hours.
-    # Offline payments have a `created_at` value that reflects the time the
-    # payment was originally processed, not the time it was subsequently
-    # transmitted to Square. Consequently, the ListPayments endpoint might
-    # list an offline payment chronologically between online payments that
-    # were seen in a previous request.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list payments for. If you specify me, this endpoint returns payments
-    # aggregated from all of the business's locations.
-    # @param [SortOrder] order Optional parameter: The order in which payments
-    # are listed in the response.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in ISO 8601 format. If this value is before
-    # January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error.
-    # Default value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in ISO 8601 format. If this value is more than one year
-    # greater than begin_time, this endpoint returns an error. Default value:
-    # The current time.
-    # @param [Integer] limit Optional parameter: The maximum number of payments
-    # to return in a single response. This value cannot exceed 200.
-    # @param [String] batch_token Optional parameter: A pagination cursor to
-    # retrieve the next set of results for your original query to the
-    # endpoint.
-    # @param [TrueClass | FalseClass] include_partial Optional parameter:
-    # Indicates whether or not to include partial payments in the response.
-    # Partial payments will have the tenders collected so far, but the
-    # itemizations will be empty until the payment is completed.
-    # @return [Array[V1Payment] Hash] response from the API call
-    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'
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v1/{location_id}/payments',
-                                     'default')
-                   .template_param(new_parameter(location_id, key: 'location_id')
-                                    .should_encode(true))
-                   .query_param(new_parameter(order, key: 'order'))
-                   .query_param(new_parameter(begin_time, key: 'begin_time'))
-                   .query_param(new_parameter(end_time, key: 'end_time'))
-                   .query_param(new_parameter(limit, key: 'limit'))
-                   .query_param(new_parameter(batch_token, key: 'batch_token'))
-                   .query_param(new_parameter(include_partial, key: 'include_partial'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('global')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Provides comprehensive information for a single payment.
-    # @param [String] location_id Required parameter: The ID of the payment's
-    # associated location.
-    # @param [String] payment_id Required parameter: The Square-issued payment
-    # ID. payment_id comes from Payment objects returned by the List Payments
-    # 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 v1_retrieve_payment(location_id:,
-                            payment_id:)
-      warn 'Endpoint v1_retrieve_payment in V1TransactionsApi is deprecated'
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v1/{location_id}/payments/{payment_id}',
-                                     'default')
-                   .template_param(new_parameter(location_id, key: 'location_id')
-                                    .should_encode(true))
-                   .template_param(new_parameter(payment_id, key: 'payment_id')
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('global')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
-        .execute
-    end
-
-    # Provides the details for all refunds initiated by a merchant or any of the
-    # merchant's mobile staff during a date range. Date ranges cannot exceed one
-    # year in length.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list refunds for.
-    # @param [SortOrder] order Optional parameter: The order in which payments
-    # are listed in the response.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in ISO 8601 format. If this value is before
-    # January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error.
-    # Default value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in ISO 8601 format. If this value is more than one year
-    # greater than begin_time, this endpoint returns an error. Default value:
-    # The current time.
-    # @param [Integer] limit Optional parameter: The approximate number of
-    # refunds to return in a single response. Default: 100. Max: 200. Response
-    # may contain more results than the prescribed limit when refunds are made
-    # simultaneously to multiple tenders in a payment or when refunds are
-    # generated in an exchange to account for the value of returned goods.
-    # @param [String] batch_token Optional parameter: A pagination cursor to
-    # retrieve the next set of results for your original query to the
-    # endpoint.
-    # @return [Array[V1Refund] Hash] response from the API call
-    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'
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v1/{location_id}/refunds',
-                                     'default')
-                   .template_param(new_parameter(location_id, key: 'location_id')
-                                    .should_encode(true))
-                   .query_param(new_parameter(order, key: 'order'))
-                   .query_param(new_parameter(begin_time, key: 'begin_time'))
-                   .query_param(new_parameter(end_time, key: 'end_time'))
-                   .query_param(new_parameter(limit, key: 'limit'))
-                   .query_param(new_parameter(batch_token, key: 'batch_token'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('global')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Issues a refund for a previously processed payment. You must issue
-    # a refund within 60 days of the associated payment.
-    # You cannot issue a partial refund for a split tender payment. You must
-    # instead issue a full or partial refund for a particular tender, by
-    # providing the applicable tender id to the V1CreateRefund endpoint.
-    # Issuing a full refund for a split tender payment refunds all tenders
-    # associated with the payment.
-    # Issuing a refund for a card payment is not reversible. For development
-    # purposes, you can create fake cash payments in Square Point of Sale and
-    # refund them.
-    # @param [String] location_id Required parameter: The ID of the original
-    # payment's associated location.
-    # @param [V1CreateRefundRequest] body Required parameter: An object
-    # 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 v1_create_refund(location_id:,
-                         body:)
-      warn 'Endpoint v1_create_refund in V1TransactionsApi is deprecated'
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/v1/{location_id}/refunds',
-                                     'default')
-                   .template_param(new_parameter(location_id, key: 'location_id')
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('global')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
-        .execute
-    end
-
-    # Provides summary information for all deposits and withdrawals
-    # initiated by Square to a linked bank account during a date range. Date
-    # ranges cannot exceed one year in length.
-    # *Note**: the ListSettlements endpoint does not provide entry
-    # information.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list settlements for. If you specify me, this endpoint returns settlements
-    # aggregated from all of the business's locations.
-    # @param [SortOrder] order Optional parameter: The order in which
-    # settlements are listed in the response.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in ISO 8601 format. If this value is before
-    # January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error.
-    # Default value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in ISO 8601 format. If this value is more than one year
-    # greater than begin_time, this endpoint returns an error. Default value:
-    # The current time.
-    # @param [Integer] limit Optional parameter: The maximum number of
-    # settlements to return in a single response. This value cannot exceed
-    # 200.
-    # @param [V1ListSettlementsRequestStatus] status Optional parameter: Provide
-    # this parameter to retrieve only settlements with a particular status (SENT
-    # or FAILED).
-    # @param [String] batch_token Optional parameter: A pagination cursor to
-    # retrieve the next set of results for your original query to the
-    # endpoint.
-    # @return [Array[V1Settlement] Hash] response from the API call
-    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'
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v1/{location_id}/settlements',
-                                     'default')
-                   .template_param(new_parameter(location_id, key: 'location_id')
-                                    .should_encode(true))
-                   .query_param(new_parameter(order, key: 'order'))
-                   .query_param(new_parameter(begin_time, key: 'begin_time'))
-                   .query_param(new_parameter(end_time, key: 'end_time'))
-                   .query_param(new_parameter(limit, key: 'limit'))
-                   .query_param(new_parameter(status, key: 'status'))
-                   .query_param(new_parameter(batch_token, key: 'batch_token'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('global')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Provides comprehensive information for a single settlement.
-    # The returned `Settlement` objects include an `entries` field that lists
-    # the transactions that contribute to the settlement total. Most
-    # settlement entries correspond to a payment payout, but settlement
-    # entries are also generated for less common events, like refunds, manual
-    # adjustments, or chargeback holds.
-    # Square initiates its regular deposits as indicated in the
-    # [Deposit Options with
-    # Square](https://squareup.com/help/us/en/article/3807)
-    # help article. Details for a regular deposit are usually not available
-    # from Connect API endpoints before 10 p.m. PST the same day.
-    # Square does not know when an initiated settlement **completes**, only
-    # whether it has failed. A completed settlement is typically reflected in
-    # a bank account within 3 business days, but in exceptional cases it may
-    # take longer.
-    # @param [String] location_id Required parameter: The ID of the
-    # settlements's associated location.
-    # @param [String] settlement_id Required parameter: The settlement's
-    # 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 v1_retrieve_settlement(location_id:,
-                               settlement_id:)
-      warn 'Endpoint v1_retrieve_settlement in V1TransactionsApi is deprecated'
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v1/{location_id}/settlements/{settlement_id}',
-                                     'default')
-                   .template_param(new_parameter(location_id, key: 'location_id')
-                                    .should_encode(true))
-                   .template_param(new_parameter(settlement_id, key: 'settlement_id')
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('global')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
-        .execute
-    end
   end
 end

data/lib/square/client.rb

@@ -1,10 +1,11 @@
 module Square
   #  square client class.
   class Client
+    include CoreLibrary
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '35.0.0.20240118'
+      '36.0.0.20240222'
     end
 
     def square_version
@@ -261,28 +262,29 @@ module Square
       @webhook_subscriptions ||= WebhookSubscriptionsApi.new @global_configuration
     end
 
-    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
-                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
-                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-                   retry_methods: %i[get put], http_callback: nil,
-                   environment: 'production',
-                   custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2024-01-18', user_agent_detail: '',
-                   additional_headers: {}, config: nil)
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, environment: 'production',
+      custom_url: 'https://connect.squareup.com', access_token: nil,
+      bearer_auth_credentials: nil, square_version: '2024-02-22',
+      user_agent_detail: '', additional_headers: {}, config: nil
+    )
       @config = if config.nil?
-                  Configuration.new(connection: connection, adapter: adapter,
-                                    timeout: timeout, max_retries: max_retries,
-                                    retry_interval: retry_interval,
-                                    backoff_factor: backoff_factor,
-                                    retry_statuses: retry_statuses,
-                                    retry_methods: retry_methods,
-                                    http_callback: http_callback,
-                                    environment: environment,
-                                    custom_url: custom_url,
-                                    access_token: access_token,
-                                    square_version: square_version,
-                                    user_agent_detail: user_agent_detail,
-                                    additional_headers: additional_headers)
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    environment: environment, custom_url: custom_url,
+                    access_token: access_token,
+                    bearer_auth_credentials: bearer_auth_credentials,
+                    square_version: square_version,
+                    user_agent_detail: user_agent_detail,
+                    additional_headers: additional_headers
+                  )
                 else
                   config
                 end
@@ -311,8 +313,8 @@ module Square
     def initialize_auth_managers(global_config)
       @auth_managers = {}
       http_client_config = global_config.client_configuration
-      ['global'].each { |auth| @auth_managers[auth] = nil }
-      @auth_managers['global'] = OAuth2.new(http_client_config.access_token)
+      %w[global].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['global'] = OAuth2.new(http_client_config.bearer_auth_credentials)
     end
   end
 end

data/lib/square/configuration.rb

@@ -2,8 +2,13 @@ module Square
   # All configuration including auth info and base URI for the API access
   # are configured in this class.
   class Configuration < CoreLibrary::HttpClientConfiguration
+    def access_token
+      @bearer_auth_credentials.access_token
+    end
+
     # The attribute readers for properties.
-    attr_reader :environment, :custom_url, :access_token, :square_version, :user_agent_detail
+    attr_reader :environment, :custom_url, :bearer_auth_credentials, :square_version,
+                :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -13,14 +18,15 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
-                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
-                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-                   retry_methods: %i[get put], http_callback: nil,
-                   environment: 'production',
-                   custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2024-01-18', user_agent_detail: '',
-                   additional_headers: {})
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, environment: 'production',
+      custom_url: 'https://connect.squareup.com', access_token: nil,
+      bearer_auth_credentials: nil, square_version: '2024-02-22',
+      user_agent_detail: '', additional_headers: {}
+    )
 
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
@@ -42,6 +48,11 @@ module Square
       # Additional headers to add to each API request
       @additional_headers = additional_headers.clone
 
+      # Initializing OAuth 2 Bearer token credentials with the provided auth parameters
+      @bearer_auth_credentials = create_auth_credentials_object(
+        access_token, bearer_auth_credentials
+      )
+
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
 
@@ -53,8 +64,8 @@ module Square
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, http_callback: nil,
                    environment: nil, custom_url: nil, access_token: nil,
-                   square_version: nil, user_agent_detail: nil,
-                   additional_headers: nil)
+                   bearer_auth_credentials: nil, square_version: nil,
+                   user_agent_detail: nil, additional_headers: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -66,10 +77,12 @@ module Square
       http_callback ||= self.http_callback
       environment ||= self.environment
       custom_url ||= self.custom_url
-      access_token ||= self.access_token
       square_version ||= self.square_version
       user_agent_detail ||= self.user_agent_detail
       additional_headers ||= self.additional_headers
+      bearer_auth_credentials = create_auth_credentials_object(
+        access_token, bearer_auth_credentials || self.bearer_auth_credentials
+      )
 
       Configuration.new(connection: connection, adapter: adapter,
                         timeout: timeout, max_retries: max_retries,
@@ -78,10 +91,10 @@ module Square
                         retry_statuses: retry_statuses,
                         retry_methods: retry_methods,
                         http_callback: http_callback, environment: environment,
-                        custom_url: custom_url, access_token: access_token,
-                        square_version: square_version,
+                        custom_url: custom_url, square_version: square_version,
                         user_agent_detail: user_agent_detail,
-                        additional_headers: additional_headers)
+                        additional_headers: additional_headers,
+                        bearer_auth_credentials: bearer_auth_credentials)
     end
 
     def get_user_agent(user_agent_detail)
@@ -91,6 +104,21 @@ module Square
       user_agent_detail
     end
 
+    def create_auth_credentials_object(access_token, bearer_auth_credentials)
+      return bearer_auth_credentials if access_token.nil?
+
+      warn('The \'access_token\' params are deprecated. Use \'bearer_auth_cred'\
+           'entials\' param instead.')
+
+      unless bearer_auth_credentials.nil?
+        return bearer_auth_credentials.clone_with(
+          access_token: access_token
+        )
+      end
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
       'production' => {

data/lib/square/http/auth/o_auth2.rb

@@ -1,6 +1,7 @@
 module Square
   # Utility class for OAuth 2 authorization and token management.
   class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
     # Display error message on occurrence of authentication failure.
     # @returns [String] The oAuth error message.
     def error_message
@@ -8,12 +9,30 @@ module Square
     end
 
     # Initialization constructor.
-    def initialize(access_token)
+    def initialize(bearer_auth_credentials)
       auth_params = {}
-      @_access_token = access_token
+      @_access_token = bearer_auth_credentials.access_token unless
+        bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
       auth_params['Authorization'] = "Bearer #{@_access_token}" unless @_access_token.nil?
 
       super auth_params
     end
   end
+
+  # Data class for BearerAuthCredentials.
+  class BearerAuthCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+  end
 end

data/lib/square.rb

@@ -3,9 +3,6 @@ require 'json'
 require 'apimatic_core_interfaces'
 require 'apimatic_core'
 require 'apimatic_faraday_client_adapter'
-# rubocop:disable Style/MixinUsage
-include CoreLibrary
-# rubocop:enable Style/MixinUsage
 
 require_relative 'square/api_helper'
 require_relative 'square/client'

data/test/api/api_test_base.rb

@@ -9,6 +9,7 @@ require_relative '../http_response_catcher'
 class ApiTestBase < Minitest::Test
   parallelize_me!
   include Square
+  include CoreLibrary
 
   # Create configuration and set any test parameters
   def create_configuration
@@ -22,6 +23,5 @@ class ApiTestBase < Minitest::Test
   def setup_class
     _config = create_configuration
     @client = Client.new(config: _config)
-    _auth_managers = @client.auth_managers
   end
 end

data/test/api/test_locations_api.rb

@@ -9,7 +9,7 @@ class LocationsApiTests < ApiTestBase
   end
 
   # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
-  #including those with an inactive status.
+  #including those with an inactive status. Locations are listed alphabetically by `name`.
   def test_list_locations
 
     # Perform the API call through the SDK function

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 35.0.0.20240118
+  version: 36.0.0.20240222
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces