square.rb 29.0.1.20230608 → 31.0.0.20230816

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3fa2994020f97860c311bfb608f4ef62419c8062273c0ff15f3aa313a2b28d
-  data.tar.gz: 88cc6d11c92d5ec5c928246045c6142b96a239ccf6d1eaa39ed9e94c5b9bac96
+  metadata.gz: a240a4a6d004debbbfa68cda7f06de20424c7095df8cdd3f9874dab556d6f869
+  data.tar.gz: 5387eaf02e834b69df1cd238a8ba68e3d7195966d8b40f831e9942f52066e39f
 SHA512:
-  metadata.gz: aa70c3a2b4e60a1d78f7afcc336cdfef1bfe2833e30221be212fd4f5a5de3d314cab11099e8ccc48bbbc6ad18adddf5fdf3b08cef2685c6abb3112109ea6417d
-  data.tar.gz: 700e6f4271f27cd7b446ef984b46786ee05d72bd59a9089297d7faf3f71e77e45c8aa19540ba6a3be5c87e24311d97c5bdf07511cdf06fd2e8a8f3a298e4f507
+  metadata.gz: d0296c13c1fc83e7e54d56cc397929f3d50ed3d243505c6372e890e7fec6cb65b6aabafd62bf15f80602982196ab36103bc8e7b816c633665717e172e0a8bdda
+  data.tar.gz: 2dce736c93cff6399463e35427319a4fe82009019c1300eafc39b3588a0056bdbba7bc26489b31f18152e22ffe6e9c7aadf10640b46384d8d0812755e65ab431

data/README.md

@@ -77,6 +77,7 @@ rake
 
 ### Orders
 * [Orders]
+* [Order Custom Attributes]
 
 ### Subscriptions
 * [Subscriptions]
@@ -103,10 +104,13 @@ rake
 
 ### Bookings
 * [Bookings]
+* [Booking Custom Attributes]
 
 ### Business
 * [Merchants]
+* [Merchant Custom Attributes]
 * [Locations]
+* [Location Custom Attributes]
 * [Devices]
 * [Cash Drawers]
 * [Vendors]
@@ -162,9 +166,13 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [Labor]: doc/api/labor.md
 [Loyalty]: doc/api/loyalty.md
 [Bookings]: doc/api/bookings.md
+[Booking Custom Attributes]: doc/api/booking-custom-attributes.md
 [Locations]: doc/api/locations.md
+[Location Custom Attributes]: doc/api/location-custom-attributes.md
 [Merchants]: doc/api/merchants.md
+[Merchant Custom Attributes]: doc/api/merchant-custom-attributes.md
 [Orders]: doc/api/orders.md
+[Order Custom Attributes]: doc/api/order-custom-attributes.md
 [Invoices]: doc/api/invoices.md
 [Apple Pay]: doc/api/apple-pay.md
 [Refunds]: doc/api/refunds.md

data/lib/square/api/base_api.rb

@@ -4,7 +4,7 @@ module Square
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/29.0.1.20230608 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/31.0.0.20230816 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters
@@ -31,7 +31,7 @@ module Square
     end
 
     # Creates a new instance of the request builder.
-    # @param [HttpMethodEnum] http_method The HTTP method to use in the request.
+    # @param [String] http_method The HTTP method to use in the request.
     # @param [String] path The endpoint path to use in the request.
     # @param [String] server The server to extract the base uri for the request.
     # @return [RequestBuilder] The instance of RequestBuilder.

data/lib/square/api/booking_custom_attributes_api.rb

@@ -236,7 +236,7 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # @param [TrueClass | FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # each custom attribute. Set this parameter to `true` to get the name and
@@ -310,7 +310,7 @@ module Square
     # retrieve. This key must match the `key` of a custom attribute definition
     # in the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # @param [TrueClass | FalseClass] with_definition Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # the custom attribute. Set this parameter to `true` to get the name and

data/lib/square/api/bookings_api.rb

@@ -11,6 +11,9 @@ module Square
     # @param [String] cursor Optional parameter: The pagination cursor from the
     # preceding response to return the next page of the results. Do not set this
     # when retrieving the first page of the results.
+    # @param [String] customer_id Optional parameter: The
+    # [customer](entity:Customer) for whom to retrieve bookings. If this is not
+    # set, bookings for all customers are retrieved.
     # @param [String] team_member_id Optional parameter: The team member for
     # whom to retrieve bookings. If this is not set, bookings of all members are
     # retrieved.
@@ -26,6 +29,7 @@ module Square
     # @return [ListBookingsResponse Hash] response from the API call
     def list_bookings(limit: nil,
                       cursor: nil,
+                      customer_id: nil,
                       team_member_id: nil,
                       location_id: nil,
                       start_at_min: nil,
@@ -36,6 +40,7 @@ module Square
                                      'default')
                    .query_param(new_parameter(limit, key: 'limit'))
                    .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(customer_id, key: 'customer_id'))
                    .query_param(new_parameter(team_member_id, key: 'team_member_id'))
                    .query_param(new_parameter(location_id, key: 'location_id'))
                    .query_param(new_parameter(start_at_min, key: 'start_at_min'))
@@ -110,6 +115,32 @@ module Square
         .execute
     end
 
+    # Bulk-Retrieves a list of bookings by booking IDs.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_READ` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+    # @param [BulkRetrieveBookingsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkRetrieveBookingsResponse Hash] response from the API call
+    def bulk_retrieve_bookings(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/bookings/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
+
     # Retrieves a seller's booking profile.
     # @return [RetrieveBusinessBookingProfileResponse Hash] response from the API call
     def retrieve_business_booking_profile
@@ -127,9 +158,9 @@ module Square
     end
 
     # Lists booking profiles for team members.
-    # @param [TrueClass|FalseClass] bookable_only Optional parameter: Indicates
-    # whether to include only bookable team members in the returned result
-    # (`true`) or not (`false`).
+    # @param [TrueClass | FalseClass] bookable_only Optional parameter:
+    # Indicates whether to include only bookable team members in the returned
+    # result (`true`) or not (`false`).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a paged response.
     # @param [String] cursor Optional parameter: The pagination cursor from the

data/lib/square/api/cards_api.rb

@@ -11,7 +11,7 @@ module Square
     # @param [String] customer_id Optional parameter: Limit results to cards
     # associated with the customer supplied. By default, all cards owned by the
     # merchant are returned.
-    # @param [TrueClass|FalseClass] include_disabled Optional parameter:
+    # @param [TrueClass | FalseClass] include_disabled Optional parameter:
     # Includes disabled cards. By default, all enabled cards owned by the
     # merchant are returned.
     # @param [String] reference_id Optional parameter: Limit results to cards

data/lib/square/api/catalog_api.rb

@@ -308,20 +308,20 @@ module Square
     # any [CatalogTax]($m/CatalogTax) objects that apply to it.
     # @param [String] object_id Required parameter: The object ID of any type of
     # catalog objects to be retrieved.
-    # @param [TrueClass|FalseClass] include_related_objects Optional parameter:
-    # If `true`, the response will include additional objects that are related
-    # to the requested objects. Related objects are defined as any objects
-    # referenced by ID by the results in the `objects` field of the response.
-    # These objects are put in the `related_objects` field. Setting this to
-    # `true` is helpful when the objects are needed for immediate display to a
-    # user. This process only goes one level deep. Objects referenced by the
-    # related objects will not be included. For example,  if the `objects` field
-    # of the response contains a CatalogItem, its associated CatalogCategory
-    # objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists
-    # will be returned in the `related_objects` field of the response. If the
-    # `objects` field of the response contains a CatalogItemVariation, its
-    # parent CatalogItem will be returned in the `related_objects` field of the
-    # response.  Default value: `false`
+    # @param [TrueClass | FalseClass] include_related_objects Optional
+    # parameter: If `true`, the response will include additional objects that
+    # are related to the requested objects. Related objects are defined as any
+    # objects referenced by ID by the results in the `objects` field of the
+    # response. These objects are put in the `related_objects` field. Setting
+    # this to `true` is helpful when the objects are needed for immediate
+    # display to a user. This process only goes one level deep. Objects
+    # referenced by the related objects will not be included. For example,  if
+    # the `objects` field of the response contains a CatalogItem, its associated
+    # CatalogCategory objects, CatalogTax objects, CatalogImage objects and
+    # CatalogModifierLists will be returned in the `related_objects` field of
+    # the response. If the `objects` field of the response contains a
+    # CatalogItemVariation, its parent CatalogItem will be returned in the
+    # `related_objects` field of the response.  Default value: `false`
     # @param [Integer] catalog_version Optional parameter: Requests objects as
     # of a specific version of the catalog. This allows you to retrieve
     # historical versions of objects. The value to retrieve a specific version

data/lib/square/api/customer_custom_attributes_api.rb

@@ -242,7 +242,7 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # @param [TrueClass | FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # each custom attribute. Set this parameter to `true` to get the name and
@@ -321,7 +321,7 @@ module Square
     # retrieve. This key must match the `key` of a custom attribute definition
     # in the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # @param [TrueClass | FalseClass] with_definition Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # the custom attribute. Set this parameter to `true` to get the name and

data/lib/square/api/customers_api.rb

@@ -26,11 +26,15 @@ module Square
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
     # customers should be sorted in ascending (`ASC`) or descending (`DESC`)
     # order.  The default value is `ASC`.
+    # @param [TrueClass | FalseClass] count Optional parameter: Indicates
+    # whether to return the total count of customers in the `count` field of the
+    # response.  The default value is `false`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
                        limit: nil,
                        sort_field: nil,
-                       sort_order: nil)
+                       sort_order: nil,
+                       count: false)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/customers',
@@ -39,6 +43,7 @@ module Square
                    .query_param(new_parameter(limit, key: 'limit'))
                    .query_param(new_parameter(sort_field, key: 'sort_field'))
                    .query_param(new_parameter(sort_order, key: 'sort_order'))
+                   .query_param(new_parameter(count, key: 'count'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler

data/lib/square/api/gift_cards_api.rb

@@ -13,7 +13,7 @@ module Square
     # cards of all states.
     # @param [Integer] limit Optional parameter: If a limit is provided, the
     # endpoint returns only the specified number of results per page. The
-    # maximum value is 50. The default value is 30. For more information, see
+    # maximum value is 200. The default value is 30. For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
     # @param [String] cursor Optional parameter: A pagination cursor returned by

data/lib/square/api/location_custom_attributes_api.rb

@@ -259,7 +259,7 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # @param [TrueClass | FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # each custom attribute. Set this parameter to `true` to get the name and
@@ -335,7 +335,7 @@ module Square
     # retrieve. This key must match the `key` of a custom attribute definition
     # in the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # @param [TrueClass | FalseClass] with_definition Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # the custom attribute. Set this parameter to `true` to get the name and

data/lib/square/api/merchant_custom_attributes_api.rb

@@ -259,7 +259,7 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # @param [TrueClass | FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # each custom attribute. Set this parameter to `true` to get the name and
@@ -335,7 +335,7 @@ module Square
     # retrieve. This key must match the `key` of a custom attribute definition
     # in the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # @param [TrueClass | FalseClass] with_definition Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # the custom attribute. Set this parameter to `true` to get the name and

data/lib/square/api/order_custom_attributes_api.rb

@@ -274,7 +274,7 @@ module Square
     # see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
-    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # @param [TrueClass | FalseClass] with_definitions Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # each custom attribute. Set this parameter to `true` to get the name and
@@ -357,7 +357,7 @@ module Square
     # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/optimistic-concurrency) control, include this optional field and
     # specify the current version of the custom attribute.
-    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # @param [TrueClass | FalseClass] with_definition Optional parameter:
     # Indicates whether to return the [custom attribute
     # definition](entity:CustomAttributeDefinition) in the `definition` field of
     # each  custom attribute. Set this parameter to `true` to get the name and

data/lib/square/api/refunds_api.rb

@@ -7,7 +7,7 @@ module Square
     # seconds to appear.
     # The maximum results per page is 100.
     # @param [String] begin_time Optional parameter: Indicates the start of the
-    # time range to retrieve each PaymentRefund` for, in RFC 3339  format.  The
+    # time range to retrieve each `PaymentRefund` for, in RFC 3339  format.  The
     # range is determined using the `created_at` field for each `PaymentRefund`.
     #   Default: The current time minus one year.
     # @param [String] end_time Optional parameter: Indicates the end of the time

data/lib/square/api/v1_transactions_api.rb

@@ -11,7 +11,7 @@ module Square
     # @param [String] batch_token Optional parameter: A pagination cursor to
     # retrieve the next set of results for your original query to the
     # endpoint.
-    # @return [List of V1Order Hash] response from the API call
+    # @return [Array[V1Order] Hash] response from the API call
     def v1_list_orders(location_id:,
                        order: nil,
                        limit: nil,
@@ -127,11 +127,11 @@ module Square
     # @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:
+    # @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 [List of V1Payment Hash] response from the API call
+    # @return [Array[V1Payment] Hash] response from the API call
     def v1_list_payments(location_id:,
                          order: nil,
                          begin_time: nil,
@@ -213,7 +213,7 @@ module Square
     # @param [String] batch_token Optional parameter: A pagination cursor to
     # retrieve the next set of results for your original query to the
     # endpoint.
-    # @return [List of V1Refund Hash] response from the API call
+    # @return [Array[V1Refund] Hash] response from the API call
     def v1_list_refunds(location_id:,
                         order: nil,
                         begin_time: nil,
@@ -306,7 +306,7 @@ module Square
     # @param [String] batch_token Optional parameter: A pagination cursor to
     # retrieve the next set of results for your original query to the
     # endpoint.
-    # @return [List of V1Settlement Hash] response from the API call
+    # @return [Array[V1Settlement] Hash] response from the API call
     def v1_list_settlements(location_id:,
                             order: nil,
                             begin_time: nil,

data/lib/square/api/webhook_subscriptions_api.rb

@@ -27,7 +27,7 @@ module Square
     # results for your original query.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @param [TrueClass|FalseClass] include_disabled Optional parameter:
+    # @param [TrueClass | FalseClass] include_disabled Optional parameter:
     # Includes disabled [Subscription](entity:WebhookSubscription)s. By default,
     # all enabled [Subscription](entity:WebhookSubscription)s are returned.
     # @param [SortOrder] sort_order Optional parameter: Sorts the returned list

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '29.0.1.20230608'
+      '31.0.0.20230816'
     end
 
     def square_version
@@ -267,7 +267,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-06-08', user_agent_detail: '',
+                   square_version: '2023-08-16', user_agent_detail: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,
@@ -300,7 +300,6 @@ module Square
                                                              agent_parameters: user_agent_params)
                                                  .additional_headers(@config.additional_headers)
                                                  .global_header('Square-Version', @config.square_version)
-                                                 .sdk_module(Square)
                                                  .symbolize_hash(true)
 
       initialize_auth_managers(@global_configuration)

data/lib/square/configuration.rb

@@ -19,7 +19,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-06-08', user_agent_detail: '',
+                   square_version: '2023-08-16', user_agent_detail: '',
                    additional_headers: {})
 
       super connection: connection, adapter: adapter, timeout: timeout,

data/test/api/test_locations_api.rb

@@ -10,7 +10,7 @@ class LocationsApiTests < ApiTestBase
 
   # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
   #including those with an inactive status.
-  def test_list_locations()
+  def test_list_locations
 
     # Perform the API call through the SDK function
     result = @controller.list_locations()
@@ -19,4 +19,4 @@ class LocationsApiTests < ApiTestBase
     assert_equal(200, @response_catcher.response.status_code)
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 29.0.1.20230608
+  version: 31.0.0.20230816
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: apimatic_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: apimatic_faraday_client_adapter
   requirement: !ruby/object:Gem::Requirement