square.rb 44.2.0.20251016 → 45.0.1.20260122

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc644952318e3b6c73ba6051c84c8d48ba7b71159718d157d166a898aa7b8927
-  data.tar.gz: 9f826398732a94f77edc36321870fbc4c4fc7877e813e891c14d409ef5640879
+  metadata.gz: 056af038668564ff8d7f1860bcc35e44449e21f4784d91846121c139d4c139d5
+  data.tar.gz: 357823902c08c710857fe636e58f92cc223ef2269e1795b888077cea2d79114b
 SHA512:
-  metadata.gz: 77e474f38cc44948e191b349a687fb6b309fd722e2062d4d9932953246f6abeca552da862f8f810dd42231e9edbe240bb06e4f97b6674ff8578df11b760eb39e
-  data.tar.gz: 4bf717bfbe85b04e95160831c21c039bac603e4b5a02736c95169abdfa4fd34364502fcca1a33864c7b3f4ccdbf3d0cb5cb843d160ef5d83419dedfa5162f96e
+  metadata.gz: 86385d14a820fcc51363fad79429b7f543b80329559128f3c609ced4c30cbcb06c4e5bce954b379f628ea34ffe69163e1231bedd7b41c12f3e46162f479694ec
+  data.tar.gz: e93cc124da8f72be75e60cf8e7401ad706edcde4efe464579081a684fafb86c28792dc6e46728eb2bf5531b4c02d4eac68e53ecb6204b597e15489013f4ffccd

data/.fern/metadata.json

@@ -0,0 +1,9 @@
+{
+  "cliVersion": "3.49.3",
+  "generatorName": "fernapi/fern-ruby-sdk",
+  "generatorVersion": "1.0.0-rc84",
+  "generatorConfig": {
+    "enableWireTests": true
+  },
+  "sdkVersion": "45.0.1.20260122"
+}

data/.fernignore

@@ -0,0 +1,20 @@
+lib/square_legacy/
+lib/square_legacy.rb
+Rakefile
+.gitignore
+test/square_legacy
+test/custom
+.github/workflows
+README.md
+lib/square/file_param.rb
+Gemfile.custom
+custom.gemspec.rb
+
+# Pagination is currently broken for endpoints where the page token is not submitted via a query param
+# Manually fixed pagination bugs in:
+lib/square/inventory/client.rb
+lib/square/transfer_orders/client.rb
+
+# Iterator does not handle nil item fields (when API returns nil instead of empty array for no items)
+# Manually added nil checks to avoid calling .shift/.empty? on nil
+lib/square/internal/iterators/item_iterator.rb

data/.rubocop.yml

@@ -0,0 +1,60 @@
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Minitest/UselessAssertion:
+  Enabled: false

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Square.
+Copyright (c) 2026 Square.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test]
+
+task lint: %i[rubocop]
+
+# Legacy tests task
+Minitest::TestTask.create(:legacy_test) do |t|
+  t.libs << "test"
+  t.test_globs = ["test/square_legacy/**/*_test.rb"]
+end
+
+# Integration tests
+task :integration_test do
+  integration_test_files = Dir.glob("test/custom/integration/**/*.rb").sort
+  cmd = "ruby -Ilib:test:. -w -e 'require \"minitest/autorun\"; "
+  cmd += integration_test_files.map { |f| "require \"#{f}\"" }.join("; ")
+  cmd += "'"
+  sh cmd
+end

data/custom.gemspec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Custom gemspec configuration file
+# This file is automatically loaded by the main gemspec file. The 'spec' variable is available
+# in this context from the main gemspec file. You can modify this file to add custom metadata,
+# dependencies, or other gemspec configurations. If you do make changes to this file, you will
+# need to add it to the .fernignore file to prevent your changes from being overwritten.
+
+def add_custom_gemspec_data(spec)
+  spec.authors = ['Square Developer Platform']
+  spec.email = ['developers@squareup.com']
+  spec.homepage = 'https://squareup.com/developers'
+  spec.licenses = ['MIT']
+  spec.add_dependency('apimatic_core_interfaces', '~> 0.2.1')
+  spec.add_dependency('apimatic_core', '~> 0.3.11')
+  spec.add_dependency('apimatic_faraday_client_adapter', '~> 0.1.4')
+  spec.add_development_dependency('minitest', '~> 5.20')
+  spec.add_development_dependency('minitest-proveit', '~> 1.0')
+end

data/lib/square/apple_pay/client.rb

@@ -3,7 +3,9 @@
 module Square
   module ApplePay
     class Client
-      # @return [Square::ApplePay::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
@@ -16,32 +18,44 @@ module Square
       # Apple Pay on the Web with Square for merchants using their platform.
       #
       # Note: You will need to host a valid domain verification file on your domain to support Apple Pay.  The
-      # current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
+      # current version of this file is always available at
+      # https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
       # and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your
       # domain.  This file is subject to change; we strongly recommend checking for updates regularly and avoiding
       # long-lived caches that might not keep in sync with the correct file version.
       #
-      # To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
+      # To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay
+      # Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
+      #
+      # @param request_options [Hash]
+      # @param params [Square::ApplePay::Types::RegisterDomainRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
       #
       # @return [Square::Types::RegisterDomainResponse]
       def register_domain(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "POST",
           path: "v2/apple-pay/domains",
-          body: params
+          body: Square::ApplePay::Types::RegisterDomainRequest.new(params).to_h,
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::RegisterDomainResponse.load(_response.body)
+          Square::Types::RegisterDomainResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
     end

data/lib/square/bank_accounts/client.rb

@@ -3,86 +3,199 @@
 module Square
   module BankAccounts
     class Client
-      # @return [Square::BankAccounts::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
 
       # Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account.
       #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :cursor
+      # @option params [Integer, nil] :limit
+      # @option params [String, nil] :location_id
+      # @option params [String, nil] :customer_id
+      #
       # @return [Square::Types::ListBankAccountsResponse]
       def list(request_options: {}, **params)
-        _query_param_names = [
-          %w[cursor limit location_id],
-          %i[cursor limit location_id]
-        ].flatten
-        _query = params.slice(*_query_param_names)
-        params.except(*_query_param_names)
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[cursor limit location_id customer_id]
+        query_params = {}
+        query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["location_id"] = params[:location_id] if params.key?(:location_id)
+        query_params["customer_id"] = params[:customer_id] if params.key?(:customer_id)
+        params.except(*query_param_names)
 
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-          method: "GET",
+        Square::Internal::CursorItemIterator.new(
+          cursor_field: :cursor,
+          item_field: :bank_accounts,
+          initial_cursor: query_params[:cursor]
+        ) do |next_cursor|
+          query_params[:cursor] = next_cursor
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v2/bank-accounts",
+            query: query_params,
+            request_options: request_options
+          )
+          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::ListBankAccountsResponse.load(response.body)
+          else
+            error_class = Square::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+
+      # Store a bank account on file for a square account
+      #
+      # @param request_options [Hash]
+      # @param params [Square::BankAccounts::Types::CreateBankAccountRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Square::Types::CreateBankAccountResponse]
+      def create_bank_account(request_options: {}, **params)
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
           path: "v2/bank-accounts",
-          query: _query
+          body: Square::BankAccounts::Types::CreateBankAccountRequest.new(params).to_h,
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::ListBankAccountsResponse.load(_response.body)
+          Square::Types::CreateBankAccountResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 
       # Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID.
       #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :v_1_bank_account_id
+      #
       # @return [Square::Types::GetBankAccountByV1IdResponse]
       def get_by_v_1_id(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "GET",
-          path: "v2/bank-accounts/by-v1-id/#{params[:v1_bank_account_id]}"
+          path: "v2/bank-accounts/by-v1-id/#{params[:v_1_bank_account_id]}",
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::GetBankAccountByV1IdResponse.load(_response.body)
+          Square::Types::GetBankAccountByV1IdResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 
-      # Returns details of a [BankAccount](entity:BankAccount)
-      # linked to a Square account.
+      # Retrieve details of a [BankAccount](entity:BankAccount) bank account linked to a Square account.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :bank_account_id
       #
       # @return [Square::Types::GetBankAccountResponse]
       def get(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "GET",
-          path: "v2/bank-accounts/#{params[:bank_account_id]}"
+          path: "v2/bank-accounts/#{params[:bank_account_id]}",
+          request_options: request_options
+        )
+        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::GetBankAccountResponse.load(response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Disable a bank account.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :bank_account_id
+      #
+      # @return [Square::Types::DisableBankAccountResponse]
+      def disable_bank_account(request_options: {}, **params)
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v2/bank-accounts/#{params[:bank_account_id]}/disable",
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::GetBankAccountResponse.load(_response.body)
+          Square::Types::DisableBankAccountResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
     end

data/lib/square/bank_accounts/types/create_bank_account_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module BankAccounts
+    module Types
+      class CreateBankAccountRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :source_id, -> { String }, optional: false, nullable: false
+        field :customer_id, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/bank_accounts/types/disable_bank_account_request.rb

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

data/lib/square/bank_accounts/types/get_by_v_1_id_bank_accounts_request.rb

@@ -4,7 +4,7 @@ module Square
   module BankAccounts
     module Types
       class GetByV1IdBankAccountsRequest < Internal::Types::Model
-        field :v_1_bank_account_id, -> { String }, optional: false, nullable: false
+        field :v_1_bank_account_id, -> { String }, optional: false, nullable: false, api_name: "v1_bank_account_id"
       end
     end
   end

data/lib/square/bank_accounts/types/list_bank_accounts_request.rb

@@ -7,6 +7,7 @@ module Square
         field :cursor, -> { String }, optional: true, nullable: false
         field :limit, -> { Integer }, optional: true, nullable: false
         field :location_id, -> { String }, optional: true, nullable: false
+        field :customer_id, -> { String }, optional: true, nullable: false
       end
     end
   end