square.rb 31.0.0.20230816 → 33.0.0.20231018

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a240a4a6d004debbbfa68cda7f06de20424c7095df8cdd3f9874dab556d6f869
-  data.tar.gz: 5387eaf02e834b69df1cd238a8ba68e3d7195966d8b40f831e9942f52066e39f
+  metadata.gz: b1a9e797a4ed71794d0b22d02812a467b629f093bf7b52d0f431d1989b7674ae
+  data.tar.gz: b9f99ab1089d405de8c1e73efb286beed4f3c0e609c40e84a0453e403c31c57f
 SHA512:
-  metadata.gz: d0296c13c1fc83e7e54d56cc397929f3d50ed3d243505c6372e890e7fec6cb65b6aabafd62bf15f80602982196ab36103bc8e7b816c633665717e172e0a8bdda
-  data.tar.gz: 2dce736c93cff6399463e35427319a4fe82009019c1300eafc39b3588a0056bdbba7bc26489b31f18152e22ffe6e9c7aadf10640b46384d8d0812755e65ab431
+  metadata.gz: 5d425e644acdb896add3713f6a5883d998e37a9cd7ffe444186cff00b169f7a1fc2d1fbb492a75eb853547e28e2fe623829ece836224c3175eb25767aa9b65ff
+  data.tar.gz: 78de8fb5d730819d3e731776ed7c87c8448feec80666a1d5b9b4a594fa78f8aa1521f25c81fc7ec03bb17f762e7b80a12f436090d030d3c44c40a4468dafa210

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/31.0.0.20230816 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/33.0.0.20231018 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/bookings_api.rb

@@ -157,6 +157,50 @@ module Square
         .execute
     end
 
+    # Lists location booking profiles of a seller.
+    # @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
+    # preceding response to return the next page of the results. Do not set this
+    # when retrieving the first page of the results.
+    # @return [ListLocationBookingProfilesResponse Hash] response from the API call
+    def list_location_booking_profiles(limit: nil,
+                                       cursor: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/bookings/location-booking-profiles',
+                                     'default')
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .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
+
+    # Retrieves a seller's location booking profile.
+    # @param [String] location_id Required parameter: The ID of the location to
+    # retrieve the booking profile.
+    # @return [RetrieveLocationBookingProfileResponse Hash] response from the API call
+    def retrieve_location_booking_profile(location_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/bookings/location-booking-profiles/{location_id}',
+                                     'default')
+                   .template_param(new_parameter(location_id, key: 'location_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
+
     # Lists booking profiles for team members.
     # @param [TrueClass | FalseClass] bookable_only Optional parameter:
     # Indicates whether to include only bookable team members in the returned
@@ -191,6 +235,28 @@ module Square
         .execute
     end
 
+    # Retrieves one or more team members' booking profiles.
+    # @param [BulkRetrieveTeamMemberBookingProfilesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkRetrieveTeamMemberBookingProfilesResponse Hash] response from the API call
+    def bulk_retrieve_team_member_booking_profiles(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/bookings/team-member-booking-profiles/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 team member's booking profile.
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to retrieve.

data/lib/square/api/checkout_api.rb

@@ -8,9 +8,6 @@ module Square
     # For more information, see [Checkout API
     # highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-
     # highlights).
-    # We recommend that you use the
-    # new [CreatePaymentLink](api-endpoint:Checkout-CreatePaymentLink)
-    # endpoint in place of this previously released endpoint.
     # @param [String] location_id Required parameter: The ID of the business
     # location to associate the checkout with.
     # @param [CreateCheckoutRequest] body Required parameter: An object

data/lib/square/api/devices_api.rb

@@ -1,6 +1,42 @@
 module Square
   # DevicesApi
   class DevicesApi < BaseApi
+    # List devices associated with the merchant. Currently, only Terminal API
+    # devices are supported.
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for the original query. See
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination) for more information.
+    # @param [SortOrder] sort_order Optional parameter: The order in which
+    # results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to
+    # oldest (default).
+    # @param [Integer] limit Optional parameter: The number of results to return
+    # in a single page.
+    # @param [String] location_id Optional parameter: If present, only returns
+    # devices at the target location.
+    # @return [ListDevicesResponse Hash] response from the API call
+    def list_devices(cursor: nil,
+                     sort_order: nil,
+                     limit: nil,
+                     location_id: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/devices',
+                                     'default')
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(sort_order, key: 'sort_order'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(location_id, key: 'location_id'))
+                   .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
+
     # Lists all DeviceCodes associated with the merchant.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
@@ -81,5 +117,25 @@ module Square
                    .convertor(ApiResponse.method(:create)))
         .execute
     end
+
+    # Retrieves Device with the associated `device_id`.
+    # @param [String] device_id Required parameter: The unique ID for the
+    # desired `Device`.
+    # @return [GetDeviceResponse Hash] response from the API call
+    def get_device(device_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/devices/{device_id}',
+                                     'default')
+                   .template_param(new_parameter(device_id, key: 'device_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/api/employees_api.rb

@@ -1,7 +1,7 @@
 module Square
   # EmployeesApi
   class EmployeesApi < BaseApi
-    # ListEmployees
+    # TODO: type endpoint description here
     # @param [String] location_id Optional parameter: Example:
     # @param [EmployeeStatus] status Optional parameter: Specifies the
     # EmployeeStatus to filter the employee by.
@@ -32,7 +32,7 @@ module Square
         .execute
     end
 
-    # RetrieveEmployee
+    # TODO: type endpoint description here
     # @param [String] id Required parameter: UUID for the employee that was
     # requested.
     # @return [RetrieveEmployeeResponse Hash] response from the API call

data/lib/square/api/o_auth_api.rb

@@ -56,10 +56,7 @@ module Square
     # Revokes an access token generated with the OAuth flow.
     # If an account has more than one OAuth access token for your application,
     # this
-    # endpoint revokes all of them, regardless of which token you specify. When
-    # an
-    # OAuth access token is revoked, all of the active subscriptions associated
-    # with that OAuth token are canceled immediately.
+    # endpoint revokes all of them, regardless of which token you specify.
     # __Important:__ The `Authorization` header for this endpoint must have the
     # following format:
     # ```

data/lib/square/api/subscriptions_api.rb

@@ -32,6 +32,32 @@ module Square
         .execute
     end
 
+    # Schedules a plan variation change for all active subscriptions under a
+    # given plan
+    # variation. For more information, see [Swap Subscription Plan
+    # Variations](https://developer.squareup.com/docs/subscriptions-api/swap-pla
+    # n-variations).
+    # @param [BulkSwapPlanRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [BulkSwapPlanResponse Hash] response from the API call
+    def bulk_swap_plan(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/subscriptions/bulk-swap-plan',
+                                     '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 for subscriptions.
     # Results are ordered chronologically by subscription creation date. If
     # the request specifies more than one location ID,
@@ -146,6 +172,36 @@ module Square
         .execute
     end
 
+    # Changes the [billing anchor
+    # date](https://developer.squareup.com/docs/subscriptions-api/subscription-b
+    # illing#billing-dates)
+    # for a subscription.
+    # @param [String] subscription_id Required parameter: The ID of the
+    # subscription to update the billing anchor date.
+    # @param [ChangeBillingAnchorDateRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [ChangeBillingAnchorDateResponse Hash] response from the API call
+    def change_billing_anchor_date(subscription_id:,
+                                   body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/subscriptions/{subscription_id}/billing-anchor',
+                                     'default')
+                   .template_param(new_parameter(subscription_id, key: 'subscription_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
+
     # Schedules a `CANCEL` action to cancel an active subscription. This
     # sets the `canceled_date` field to the end of the active billing period.
     # After this date,

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '31.0.0.20230816'
+      '33.0.0.20231018'
     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-08-16', user_agent_detail: '',
+                   square_version: '2023-10-18', user_agent_detail: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

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-08-16', user_agent_detail: '',
+                   square_version: '2023-10-18', user_agent_detail: '',
                    additional_headers: {})
 
       super connection: connection, adapter: adapter, timeout: timeout,

data/lib/square/utilities/webhooks_helper.rb

@@ -0,0 +1,23 @@
+require 'openssl'
+require 'base64'
+
+module Square
+  class WebhooksHelper
+    def self.is_valid_webhook_event_signature(request_body, signature_header, signature_key, notification_url)
+      return false if request_body.nil?
+      raise 'signature_key is null or empty' if signature_key.nil? || signature_key.empty?
+      raise 'notification_url is null or empty' if notification_url.nil? || notification_url.empty?
+
+      # Perform UTF-8 encoding to bytes
+      payload_bytes = "#{notification_url}#{request_body}".force_encoding('utf-8')
+      signature_key_bytes = signature_key.force_encoding('utf-8')
+
+      # Compute the hash value
+      hmac = OpenSSL::HMAC.digest('sha256', signature_key_bytes, payload_bytes)
+
+      # Compare the computed hash vs the value in the signature header
+      hash_base64 = Base64.strict_encode64(hmac)
+      hash_base64 == signature_header
+    end
+  end
+end

data/lib/square.rb

@@ -72,3 +72,4 @@ require_relative 'square/api/team_api'
 require_relative 'square/api/terminal_api'
 require_relative 'square/api/vendors_api'
 require_relative 'square/api/webhook_subscriptions_api'
+require_relative 'square/utilities/webhooks_helper'

data/test/webhooks/test_webhooks_helper.rb

@@ -0,0 +1,136 @@
+require_relative '../../lib/square/utilities/webhooks_helper.rb'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'logger'
+
+class WebhooksHelperTest < Minitest::Test
+  # Called only once for the class before any test has executed
+  def setup
+    @logger = Logger.new(STDOUT) # Create a Logger instance for logging
+    @logger.level = Logger::INFO # Set the log level to INFO or any desired level
+    @request_body = '{"merchant_id":"MLEFBHHSJGVHD","type":"webhooks.test_notification","event_id":"ac3ac95b-f97d-458c-a6e6-18981597e05f","created_at":"2022-07-13T20:30:59.037339943Z","data":{"type":"webhooks","id":"bc368e64-01aa-407e-b46e-3231809b1129"}}'
+    @signature_header = 'GF4YkrJgGBDZ9NIYbNXBnMzqb2HoL4RW/S6vkZ9/2N4='
+    @signature_key = 'Ibxx_5AKakO-3qeNVR61Dw'
+    @notification_url = 'https://webhook.site/679a4f3a-dcfa-49ee-bac5-9d0edad886b9'
+  end
+
+  def test_signature_validation_pass
+    @logger.info('Running test_signature_validation_pass') # Log a message
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      @request_body,
+      @signature_header,
+      @signature_key,
+      @notification_url
+    )
+    assert_equal true, is_valid
+  end
+
+  def test_signature_validation_fails_on_notification_url_mismatch
+    @logger.info('Running test_signature_validation_fails_on_notification_url_mismatch') # Log a message
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      @request_body,
+      @signature_header,
+      @signature_key,
+      'https://webhook.site/79a4f3a-dcfa-49ee-bac5-9d0edad886b9'
+    )
+    assert_equal false, is_valid
+  end
+
+  def test_signature_validation_fails_on_invalid_signature_key
+    @logger.info('Running test_signature_validation_fails_on_invalid_signature_key') # Log a message
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      @request_body,
+      @signature_header,
+      'MCmhFRxGX82xMwg5FsaoQA',
+      @notification_url
+    )
+    assert_equal false, is_valid
+  end
+
+  def test_signature_validation_fails_on_invalid_signature_header
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      @request_body,
+      '1z2n3DEJJiUPKcPzQo1ftvbxGdw=',
+      @signature_key,
+      @notification_url
+    )
+    assert_equal false, is_valid
+  end
+
+  def test_signature_validation_fails_on_request_body_mismatch
+    request_body = '{"merchant_id":"MLEFBHHSJGVHD","type":"webhooks.test_notification","event_id":"ac3ac95b-f97d-458c-a6e6-18981597e05f","created_at":"2022-06-13T20:30:59.037339943Z","data":{"type":"webhooks","id":"bc368e64-01aa-407e-b46e-3231809b1129"}}'
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      request_body,
+      @signature_header,
+      @signature_key,
+      @notification_url
+    )
+    assert_equal false, is_valid
+  end
+
+  def test_signature_validation_fails_on_request_body_formatted
+    request_body = '{
+            "merchant_id": "MLEFBHHSJGVHD",
+            "type": "webhooks.test_notification",
+            "event_id": "ac3ac95b-f97d-458c-a6e6-18981597e05f",
+            "created_at": "2022-07-13T20:30:59.037339943Z",
+            "data": {
+                "type": "webhooks",
+                "id": "bc368e64-01aa-407e-b46e-3231809b1129"
+            }
+        }'
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      request_body,
+      @signature_header,
+      @signature_key,
+      @notification_url
+    )
+    assert_equal false, is_valid
+  end
+
+  def test_throws_error_on_empty_signature_key
+    assert_raises(RuntimeError, 'signature_key is null or empty') do
+      Square::WebhooksHelper.is_valid_webhook_event_signature(
+        @request_body,
+        @signature_header,
+        '',
+        @notification_url
+      )
+    end
+  end
+
+  def test_throws_error_on_signature_key_not_configured
+    assert_raises(RuntimeError) do
+      Square::WebhooksHelper.is_valid_webhook_event_signature(
+        @request_body,
+        @signature_header,
+        nil,
+        @notification_url
+      )
+    end
+  end
+
+  def test_throws_error_on_empty_notification_url
+    assert_raises(RuntimeError, 'notification_url is null or empty') do
+      Square::WebhooksHelper.is_valid_webhook_event_signature(
+        @request_body,
+        @signature_header,
+        @signature_key,
+        ''
+      )
+    end
+  end
+
+  def test_throws_error_on_notification_url_not_configured
+    assert_raises(RuntimeError) do
+      Square::WebhooksHelper.is_valid_webhook_event_signature(
+        @request_body,
+        @signature_header,
+        @signature_key,
+        nil
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 31.0.0.20230816
+  version: 33.0.0.20231018
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -150,6 +150,7 @@ files:
 - lib/square/http/http_response.rb
 - lib/square/utilities/date_time_helper.rb
 - lib/square/utilities/file_wrapper.rb
+- lib/square/utilities/webhooks_helper.rb
 - spec/user_journey_spec.rb
 - test/api/api_test_base.rb
 - test/api/test_catalog_api.rb
@@ -161,6 +162,7 @@ files:
 - test/api/test_payments_api.rb
 - test/api/test_refunds_api.rb
 - test/http_response_catcher.rb
+- test/webhooks/test_webhooks_helper.rb
 homepage: ''
 licenses:
 - Apache-2.0