square.rb 44.2.0.20251016 → 45.0.1.20260122

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 44.2.0.20251016
+  version: 45.0.1.20260122
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2025-10-16 00:00:00.000000000 Z
+date: 2026-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -80,19 +80,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: ''
+description: The Square Ruby library provides convenient access to the Square API
+  from Ruby.
 email:
 - developers@squareup.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".fern/metadata.json"
+- ".fernignore"
+- ".rubocop.yml"
 - LICENSE
 - README.md
+- Rakefile
+- custom.gemspec.rb
 - lib/square.rb
 - lib/square/apple_pay/client.rb
 - lib/square/apple_pay/types/register_domain_request.rb
 - lib/square/bank_accounts/client.rb
+- lib/square/bank_accounts/types/create_bank_account_request.rb
+- lib/square/bank_accounts/types/disable_bank_account_request.rb
 - lib/square/bank_accounts/types/get_bank_accounts_request.rb
 - lib/square/bank_accounts/types/get_by_v_1_id_bank_accounts_request.rb
 - lib/square/bank_accounts/types/list_bank_accounts_request.rb
@@ -249,6 +257,11 @@ files:
 - lib/square/internal/errors/type_error.rb
 - lib/square/internal/http/base_request.rb
 - lib/square/internal/http/raw_client.rb
+- lib/square/internal/iterators/cursor_item_iterator.rb
+- lib/square/internal/iterators/cursor_page_iterator.rb
+- lib/square/internal/iterators/item_iterator.rb
+- lib/square/internal/iterators/offset_item_iterator.rb
+- lib/square/internal/iterators/offset_page_iterator.rb
 - lib/square/internal/json/request.rb
 - lib/square/internal/json/serializable.rb
 - lib/square/internal/multipart/multipart_encoder.rb
@@ -378,8 +391,6 @@ files:
 - lib/square/merchants/custom_attributes/types/upsert_merchant_custom_attribute_request.rb
 - lib/square/merchants/types/get_merchants_request.rb
 - lib/square/merchants/types/list_merchants_request.rb
-- lib/square/mobile/client.rb
-- lib/square/mobile/types/create_mobile_authorization_code_request.rb
 - lib/square/o_auth/client.rb
 - lib/square/o_auth/types/obtain_token_request.rb
 - lib/square/o_auth/types/revoke_token_request.rb
@@ -493,6 +504,7 @@ files:
 - lib/square/types/afterpay_details.rb
 - lib/square/types/application_details.rb
 - lib/square/types/application_details_external_square_product.rb
+- lib/square/types/application_type.rb
 - lib/square/types/appointment_segment.rb
 - lib/square/types/archived_state.rb
 - lib/square/types/availability.rb
@@ -569,6 +581,7 @@ files:
 - lib/square/types/bulk_publish_scheduled_shifts_data.rb
 - lib/square/types/bulk_publish_scheduled_shifts_response.rb
 - lib/square/types/bulk_retrieve_bookings_response.rb
+- lib/square/types/bulk_retrieve_channels_request_constants.rb
 - lib/square/types/bulk_retrieve_channels_response.rb
 - lib/square/types/bulk_retrieve_customers_response.rb
 - lib/square/types/bulk_retrieve_team_member_booking_profiles_response.rb
@@ -624,6 +637,7 @@ files:
 - lib/square/types/card_forgotten_event_card.rb
 - lib/square/types/card_forgotten_event_data.rb
 - lib/square/types/card_forgotten_event_object.rb
+- lib/square/types/card_issuer_alert.rb
 - lib/square/types/card_payment_details.rb
 - lib/square/types/card_payment_timeline.rb
 - lib/square/types/card_prepaid_type.rb
@@ -679,6 +693,7 @@ files:
 - lib/square/types/catalog_modifier_list_modifier_type.rb
 - lib/square/types/catalog_modifier_list_selection_type.rb
 - lib/square/types/catalog_modifier_override.rb
+- lib/square/types/catalog_modifier_toggle_override_type.rb
 - lib/square/types/catalog_object.rb
 - lib/square/types/catalog_object_availability_period.rb
 - lib/square/types/catalog_object_base.rb
@@ -762,6 +777,7 @@ files:
 - lib/square/types/confirmation_options.rb
 - lib/square/types/coordinates.rb
 - lib/square/types/country.rb
+- lib/square/types/create_bank_account_response.rb
 - lib/square/types/create_booking_custom_attribute_definition_response.rb
 - lib/square/types/create_booking_response.rb
 - lib/square/types/create_break_type_response.rb
@@ -789,7 +805,6 @@ files:
 - lib/square/types/create_loyalty_promotion_response.rb
 - lib/square/types/create_loyalty_reward_response.rb
 - lib/square/types/create_merchant_custom_attribute_definition_response.rb
-- lib/square/types/create_mobile_authorization_code_response.rb
 - lib/square/types/create_order_custom_attribute_definition_response.rb
 - lib/square/types/create_order_request.rb
 - lib/square/types/create_order_response.rb
@@ -930,6 +945,7 @@ files:
 - lib/square/types/device_status.rb
 - lib/square/types/device_status_category.rb
 - lib/square/types/digital_wallet_details.rb
+- lib/square/types/disable_bank_account_response.rb
 - lib/square/types/disable_card_response.rb
 - lib/square/types/disable_events_response.rb
 - lib/square/types/dismiss_terminal_action_response.rb
@@ -993,55 +1009,83 @@ files:
 - lib/square/types/fulfillment_type.rb
 - lib/square/types/get_bank_account_by_v_1_id_response.rb
 - lib/square/types/get_bank_account_response.rb
+- lib/square/types/get_booking_request.rb
 - lib/square/types/get_booking_response.rb
 - lib/square/types/get_break_type_response.rb
+- lib/square/types/get_business_booking_profile_request.rb
 - lib/square/types/get_business_booking_profile_response.rb
+- lib/square/types/get_card_request.rb
 - lib/square/types/get_card_response.rb
 - lib/square/types/get_cash_drawer_shift_response.rb
 - lib/square/types/get_catalog_object_response.rb
 - lib/square/types/get_customer_custom_attribute_definition_response.rb
 - lib/square/types/get_customer_custom_attribute_response.rb
+- lib/square/types/get_customer_group_request.rb
 - lib/square/types/get_customer_group_response.rb
+- lib/square/types/get_customer_request.rb
 - lib/square/types/get_customer_response.rb
+- lib/square/types/get_customer_segment_request.rb
 - lib/square/types/get_customer_segment_response.rb
 - lib/square/types/get_device_code_response.rb
 - lib/square/types/get_device_response.rb
+- lib/square/types/get_dispute_evidence_request.rb
 - lib/square/types/get_dispute_evidence_response.rb
+- lib/square/types/get_dispute_request.rb
 - lib/square/types/get_dispute_response.rb
+- lib/square/types/get_employee_request.rb
 - lib/square/types/get_employee_response.rb
 - lib/square/types/get_employee_wage_response.rb
 - lib/square/types/get_gift_card_from_gan_response.rb
 - lib/square/types/get_gift_card_from_nonce_response.rb
+- lib/square/types/get_gift_card_request.rb
 - lib/square/types/get_gift_card_response.rb
+- lib/square/types/get_inventory_adjustment_request.rb
 - lib/square/types/get_inventory_adjustment_response.rb
 - lib/square/types/get_inventory_changes_response.rb
 - lib/square/types/get_inventory_count_response.rb
+- lib/square/types/get_inventory_physical_count_request.rb
 - lib/square/types/get_inventory_physical_count_response.rb
+- lib/square/types/get_inventory_transfer_request.rb
 - lib/square/types/get_inventory_transfer_response.rb
 - lib/square/types/get_invoice_response.rb
+- lib/square/types/get_location_request.rb
 - lib/square/types/get_location_response.rb
+- lib/square/types/get_loyalty_account_request.rb
 - lib/square/types/get_loyalty_account_response.rb
+- lib/square/types/get_loyalty_program_request.rb
 - lib/square/types/get_loyalty_program_response.rb
+- lib/square/types/get_loyalty_promotion_request.rb
 - lib/square/types/get_loyalty_promotion_response.rb
+- lib/square/types/get_loyalty_reward_request.rb
 - lib/square/types/get_loyalty_reward_response.rb
+- lib/square/types/get_merchant_request.rb
 - lib/square/types/get_merchant_response.rb
+- lib/square/types/get_order_request.rb
 - lib/square/types/get_order_response.rb
+- lib/square/types/get_payment_link_request.rb
 - lib/square/types/get_payment_link_response.rb
 - lib/square/types/get_payment_refund_response.rb
 - lib/square/types/get_payment_response.rb
 - lib/square/types/get_payout_response.rb
 - lib/square/types/get_shift_response.rb
+- lib/square/types/get_snippet_request.rb
 - lib/square/types/get_snippet_response.rb
 - lib/square/types/get_subscription_response.rb
+- lib/square/types/get_team_member_booking_profile_request.rb
 - lib/square/types/get_team_member_booking_profile_response.rb
+- lib/square/types/get_team_member_request.rb
 - lib/square/types/get_team_member_response.rb
 - lib/square/types/get_team_member_wage_response.rb
 - lib/square/types/get_terminal_action_response.rb
 - lib/square/types/get_terminal_checkout_response.rb
 - lib/square/types/get_terminal_refund_response.rb
+- lib/square/types/get_transaction_request.rb
 - lib/square/types/get_transaction_response.rb
+- lib/square/types/get_vendor_request.rb
 - lib/square/types/get_vendor_response.rb
+- lib/square/types/get_wage_setting_request.rb
 - lib/square/types/get_wage_setting_response.rb
+- lib/square/types/get_webhook_subscription_request.rb
 - lib/square/types/get_webhook_subscription_response.rb
 - lib/square/types/gift_card.rb
 - lib/square/types/gift_card_activity.rb
@@ -1051,6 +1095,7 @@ files:
 - lib/square/types/gift_card_activity_adjust_increment.rb
 - lib/square/types/gift_card_activity_adjust_increment_reason.rb
 - lib/square/types/gift_card_activity_block.rb
+- lib/square/types/gift_card_activity_block_reason.rb
 - lib/square/types/gift_card_activity_clear_balance.rb
 - lib/square/types/gift_card_activity_clear_balance_reason.rb
 - lib/square/types/gift_card_activity_created_event.rb
@@ -1068,6 +1113,7 @@ files:
 - lib/square/types/gift_card_activity_transfer_balance_to.rb
 - lib/square/types/gift_card_activity_type.rb
 - lib/square/types/gift_card_activity_unblock.rb
+- lib/square/types/gift_card_activity_unblock_reason.rb
 - lib/square/types/gift_card_activity_unlinked_activity_refund.rb
 - lib/square/types/gift_card_activity_updated_event.rb
 - lib/square/types/gift_card_activity_updated_event_data.rb
@@ -1136,6 +1182,7 @@ files:
 - lib/square/types/invoice_scheduled_charge_failed_event_data.rb
 - lib/square/types/invoice_scheduled_charge_failed_event_object.rb
 - lib/square/types/invoice_sort.rb
+- lib/square/types/invoice_sort_field.rb
 - lib/square/types/invoice_status.rb
 - lib/square/types/invoice_updated_event.rb
 - lib/square/types/invoice_updated_event_data.rb
@@ -1187,6 +1234,7 @@ files:
 - lib/square/types/list_cash_drawer_shift_events_response.rb
 - lib/square/types/list_cash_drawer_shifts_response.rb
 - lib/square/types/list_catalog_response.rb
+- lib/square/types/list_channels_request_constants.rb
 - lib/square/types/list_channels_response.rb
 - lib/square/types/list_customer_custom_attribute_definitions_response.rb
 - lib/square/types/list_customer_custom_attributes_response.rb
@@ -1261,6 +1309,7 @@ files:
 - lib/square/types/loyalty_account_deleted_event_object.rb
 - lib/square/types/loyalty_account_expiring_point_deadline.rb
 - lib/square/types/loyalty_account_mapping.rb
+- lib/square/types/loyalty_account_mapping_type.rb
 - lib/square/types/loyalty_account_updated_event.rb
 - lib/square/types/loyalty_account_updated_event_data.rb
 - lib/square/types/loyalty_account_updated_event_object.rb
@@ -1323,6 +1372,7 @@ files:
 - lib/square/types/measurement_unit.rb
 - lib/square/types/measurement_unit_area.rb
 - lib/square/types/measurement_unit_custom.rb
+- lib/square/types/measurement_unit_generic.rb
 - lib/square/types/measurement_unit_length.rb
 - lib/square/types/measurement_unit_time.rb
 - lib/square/types/measurement_unit_unit_type.rb
@@ -1353,6 +1403,7 @@ files:
 - lib/square/types/obtain_token_response.rb
 - lib/square/types/offline_payment_details.rb
 - lib/square/types/order.rb
+- lib/square/types/order_card_surcharge_treatment_type.rb
 - lib/square/types/order_created.rb
 - lib/square/types/order_created_event.rb
 - lib/square/types/order_created_event_data.rb
@@ -1389,6 +1440,7 @@ files:
 - lib/square/types/order_line_item_modifier.rb
 - lib/square/types/order_line_item_pricing_blocklists.rb
 - lib/square/types/order_line_item_pricing_blocklists_blocked_discount.rb
+- lib/square/types/order_line_item_pricing_blocklists_blocked_service_charge.rb
 - lib/square/types/order_line_item_pricing_blocklists_blocked_tax.rb
 - lib/square/types/order_line_item_tax.rb
 - lib/square/types/order_line_item_tax_scope.rb
@@ -1475,6 +1527,7 @@ files:
 - lib/square/types/pre_populated_data.rb
 - lib/square/types/processing_fee.rb
 - lib/square/types/product.rb
+- lib/square/types/product_type.rb
 - lib/square/types/publish_invoice_response.rb
 - lib/square/types/publish_scheduled_shift_response.rb
 - lib/square/types/qr_code_options.rb
@@ -1541,6 +1594,7 @@ files:
 - lib/square/types/search_events_query.rb
 - lib/square/types/search_events_response.rb
 - lib/square/types/search_events_sort.rb
+- lib/square/types/search_events_sort_field.rb
 - lib/square/types/search_invoices_response.rb
 - lib/square/types/search_loyalty_accounts_request_loyalty_account_query.rb
 - lib/square/types/search_loyalty_accounts_response.rb
@@ -1760,6 +1814,8 @@ files:
 - lib/square/types/upsert_merchant_custom_attribute_response.rb
 - lib/square/types/upsert_order_custom_attribute_response.rb
 - lib/square/types/upsert_snippet_response.rb
+- lib/square/types/v_1_get_payment_request.rb
+- lib/square/types/v_1_get_settlement_request.rb
 - lib/square/types/v_1_money.rb
 - lib/square/types/v_1_order.rb
 - lib/square/types/v_1_order_history_entry.rb
@@ -1775,10 +1831,12 @@ files:
 - lib/square/types/vendor_created_event.rb
 - lib/square/types/vendor_created_event_data.rb
 - lib/square/types/vendor_created_event_object.rb
+- lib/square/types/vendor_created_event_object_operation.rb
 - lib/square/types/vendor_status.rb
 - lib/square/types/vendor_updated_event.rb
 - lib/square/types/vendor_updated_event_data.rb
 - lib/square/types/vendor_updated_event_object.rb
+- lib/square/types/vendor_updated_event_object_operation.rb
 - lib/square/types/visibility_filter.rb
 - lib/square/types/void_transaction_response.rb
 - lib/square/types/wage_setting.rb
@@ -1866,43 +1924,9 @@ files:
 - lib/square_legacy/utilities/date_time_helper.rb
 - lib/square_legacy/utilities/file_wrapper.rb
 - lib/square_legacy/utilities/webhooks_helper.rb
-- test/square/integration/client_tests/test_cash_drawers.rb
-- test/square/integration/client_tests/test_catalog.rb
-- test/square/integration/client_tests/test_customers.rb
-- test/square/integration/client_tests/test_customers_groups.rb
-- test/square/integration/client_tests/test_customers_segments.rb
-- test/square/integration/client_tests/test_devices.rb
-- test/square/integration/client_tests/test_inventory.rb
-- test/square/integration/client_tests/test_locations.rb
-- test/square/integration/client_tests/test_merchants.rb
-- test/square/integration/client_tests/test_mobile.rb
-- test/square/integration/client_tests/test_orders.rb
-- test/square/integration/client_tests/test_payments.rb
-- test/square/integration/client_tests/test_refunds.rb
-- test/square/integration/client_tests/test_team_members.rb
-- test/square/integration/client_tests/test_terminal.rb
-- test/square/integration/integration_test_base.rb
-- test/square/integration/testdata/image.jpeg
-- test/square/internal/multipart/test_form_data.rb
-- test/square/internal/types/test_array.rb
-- test/square/internal/types/test_boolean.rb
-- test/square/internal/types/test_enum.rb
-- test/square/internal/types/test_hash.rb
-- test/square/internal/types/test_model.rb
-- test/square/internal/types/test_union.rb
-- test/square/internal/types/test_utils.rb
-- test/square_legacy/api/api_test_base.rb
-- test/square_legacy/api/test_catalog_api.rb
-- test/square_legacy/api/test_customers_api.rb
-- test/square_legacy/api/test_employees_api.rb
-- test/square_legacy/api/test_labor_api.rb
-- test/square_legacy/api/test_locations_api.rb
-- test/square_legacy/api/test_merchants_api.rb
-- test/square_legacy/api/test_payments_api.rb
-- test/square_legacy/api/test_refunds_api.rb
-- test/square_legacy/http_response_catcher.rb
-- test/square_legacy/webhooks/test_webhooks_helper.rb
-- test/test_helper.rb
+- reference.md
+- wiremock/docker-compose.test.yml
+- wiremock/wiremock-mappings.json
 homepage: https://squareup.com/developers
 licenses:
 - MIT
@@ -1925,5 +1949,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: square
+summary: Ruby client library for the Square API
 test_files: []

data/lib/square/mobile/client.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Square
-  module Mobile
-    class Client
-      # @return [Square::Mobile::Client]
-      def initialize(client:)
-        @client = client
-      end
-
-      # __Note:__ This endpoint is used by the deprecated Reader SDK.
-      # Developers should update their integration to use the [Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk), which includes its own authorization methods.
-      #
-      # Generates code to authorize a mobile application to connect to a Square card reader.
-      #
-      # Authorization codes are one-time-use codes and expire 60 minutes after being issued.
-      #
-      # The `Authorization` header you provide to this endpoint must have the following format:
-      #
-      # ```
-      # Authorization: Bearer ACCESS_TOKEN
-      # ```
-      #
-      # Replace `ACCESS_TOKEN` with a
-      # [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).
-      #
-      # @return [Square::Types::CreateMobileAuthorizationCodeResponse]
-      def authorization_code(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-          method: "POST",
-          path: "mobile/authorization-code",
-          body: params
-        )
-        begin
-          _response = @client.send(_request)
-        rescue Net::HTTPRequestTimeout
-          raise Square::Errors::TimeoutError
-        end
-        code = _response.code.to_i
-        if code.between?(200, 299)
-          Square::Types::CreateMobileAuthorizationCodeResponse.load(_response.body)
-        else
-          error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
-        end
-      end
-    end
-  end
-end

data/lib/square/mobile/types/create_mobile_authorization_code_request.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Square
-  module Mobile
-    module Types
-      class CreateMobileAuthorizationCodeRequest < Internal::Types::Model
-        field :location_id, -> { String }, optional: true, nullable: false
-      end
-    end
-  end
-end

data/lib/square/types/create_mobile_authorization_code_response.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Square
-  module Types
-    # Defines the fields that are included in the response body of
-    # a request to the `CreateMobileAuthorizationCode` endpoint.
-    class CreateMobileAuthorizationCodeResponse < Internal::Types::Model
-      field :authorization_code, -> { String }, optional: true, nullable: false
-      field :expires_at, -> { String }, optional: true, nullable: false
-      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
-    end
-  end
-end

data/test/square/integration/client_tests/test_cash_drawers.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-describe Square::CashDrawers::Shifts::Client do
-  describe "#list" do
-    it "list cash drawer shifts" do
-      skip '{"errors": [{"code": "BAD_REQUEST","detail": "The location_id is missing.","category": "INVALID_REQUEST_ERROR"}]}'
-      start_time = Time.now - 3600  # 1 hour ago
-      end_time = Time.now
-      
-      _request = Square::CashDrawers::Shifts::Types::ListShiftsRequest.new(
-        location_id: client.locations.list.locations.first.id,
-        begin_time: start_time.iso8601,
-        end_time: end_time.iso8601
-      )
-
-      puts "request #{_request.to_h}" if verbose?
-
-      response = client.cash_drawers.shifts.list(**_request.to_h)
-      refute_nil response
-      assert_equal response.class, Square::Types::ListCashDrawerShiftsResponse
-
-      puts "response #{response.to_h}" if verbose?
-    end
-  end
-end