increase 1.241.0 → 1.243.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a04be041eba6a264331c3d2790223aac3bcd162e58d41c948ee77895342f59ed
-  data.tar.gz: acbd6d8dbf14a45bd3eca79fce36e3d6fbcd38cbc00fe9d7355133ee1269c7eb
+  metadata.gz: d0e295da15aeecb29c4be017366f5464761d7075423ef1a75275116cc0bc8bce
+  data.tar.gz: '019a5d091730152904019de802312abccd1867c5a8ee66db6c6df18e36b84f02'
 SHA512:
-  metadata.gz: 344aec2294c913273b00a4fcc7aba0ac974ced037aebd2048c5e60d482c925778ba7da9c98d909f11c50302022c3f945d9c2c0af4e72aa9f7d334d30d0cb29d2
-  data.tar.gz: 73c02285fab40ef9d198665de68036fe6cda8c8a7d47167371497b57d54e2516d41706d8cbcfd699b07845a4cb712b2fa40d8eda8917a03db1d6266d242e8017
+  metadata.gz: '09b7000fc7515a2d688d9d5511fc485a4db02f62c2eac4e72988824846977232982a87b5b3c643ceac2b7e44caf278394a0e8852830965be1dc022cf9c57ac48'
+  data.tar.gz: 656aa50c9f47b6ff1ca20392b8e2b1f5ea187f3c34fce75d7207fdc395ced126d0fc819276b2172aa2f4fc28cead7a22ae41d5d5edc3439249eb44dbc255ade4

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.243.0 (2026-03-11)
+
+Full Changelog: [v1.242.0...v1.243.0](https://github.com/Increase/increase-ruby/compare/v1.242.0...v1.243.0)
+
+### Features
+
+* **api:** api update ([8a6513b](https://github.com/Increase/increase-ruby/commit/8a6513bcf67ab8f7d66e55aa6df26d21af4abb3a))
+
+## 1.242.0 (2026-03-11)
+
+Full Changelog: [v1.241.0...v1.242.0](https://github.com/Increase/increase-ruby/compare/v1.241.0...v1.242.0)
+
+### Features
+
+* **client:** add webhook support ([227d6ab](https://github.com/Increase/increase-ruby/commit/227d6ab8bec444b348c61ae7b85969cd38dcd764))
+
 ## 1.241.0 (2026-03-11)
 
 Full Changelog: [v1.240.0...v1.241.0](https://github.com/Increase/increase-ruby/compare/v1.240.0...v1.241.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.241.0"
+gem "increase", "~> 1.243.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/client.rb

@@ -23,6 +23,9 @@ module Increase
     # @return [String]
     attr_reader :api_key
 
+    # @return [String, nil]
+    attr_reader :webhook_secret
+
     # @return [Increase::Resources::Accounts]
     attr_reader :accounts
 
@@ -210,6 +213,8 @@ module Increase
     #
     # @param api_key [String, nil] Defaults to `ENV["INCREASE_API_KEY"]`
     #
+    # @param webhook_secret [String, nil] Defaults to `ENV["INCREASE_WEBHOOK_SECRET"]`
+    #
     # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
     #
     # Each environment maps to a different base URL:
@@ -231,6 +236,7 @@ module Increase
     # @param idempotency_header [String]
     def initialize(
       api_key: ENV["INCREASE_API_KEY"],
+      webhook_secret: ENV["INCREASE_WEBHOOK_SECRET"],
       environment: nil,
       base_url: ENV["INCREASE_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
@@ -249,6 +255,7 @@ module Increase
       end
 
       @api_key = api_key.to_s
+      @webhook_secret = webhook_secret&.to_s
 
       super(
         base_url: base_url,

data/lib/increase/models/beneficial_owner_update_params.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BeneficialOwners#update
+    class BeneficialOwnerUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute entity_beneficial_owner_id
+      #   The identifier of the Beneficial Owner to update.
+      #
+      #   @return [String]
+      required :entity_beneficial_owner_id, String
+
+      # @!attribute address
+      #   The individual's physical address. Mail receiving locations like PO Boxes and
+      #   PMB's are disallowed.
+      #
+      #   @return [Increase::Models::BeneficialOwnerUpdateParams::Address, nil]
+      optional :address, -> { Increase::BeneficialOwnerUpdateParams::Address }
+
+      # @!method initialize(entity_beneficial_owner_id:, address: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::BeneficialOwnerUpdateParams} for more details.
+      #
+      #   @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
+      #
+      #   @param address [Increase::Models::BeneficialOwnerUpdateParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Address < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city, district, town, or village of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute country
+        #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute line1
+        #   The first line of the address. This is usually the street number and street.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of the address. This might be the floor or room number.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!attribute state
+        #   The two-letter United States Postal Service (USPS) abbreviation for the US
+        #   state, province, or region of the address. Required in certain countries.
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!attribute zip
+        #   The ZIP or postal code of the address. Required in certain countries.
+        #
+        #   @return [String, nil]
+        optional :zip, String
+
+        # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::BeneficialOwnerUpdateParams::Address} for more details.
+        #
+        #   The individual's physical address. Mail receiving locations like PO Boxes and
+        #   PMB's are disallowed.
+        #
+        #   @param city [String] The city, district, town, or village of the address.
+        #
+        #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+        #
+        #   @param line1 [String] The first line of the address. This is usually the street number and street.
+        #
+        #   @param line2 [String] The second line of the address. This might be the floor or room number.
+        #
+        #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
+        #
+        #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -107,6 +107,8 @@ module Increase
 
   BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams
 
+  BeneficialOwnerUpdateParams = Increase::Models::BeneficialOwnerUpdateParams
+
   BookkeepingAccount = Increase::Models::BookkeepingAccount
 
   BookkeepingAccountBalanceParams = Increase::Models::BookkeepingAccountBalanceParams

data/lib/increase/resources/beneficial_owners.rb

@@ -23,6 +23,33 @@ module Increase
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::BeneficialOwnerUpdateParams} for more details.
+      #
+      # Update a Beneficial Owner
+      #
+      # @overload update(entity_beneficial_owner_id, address: nil, request_options: {})
+      #
+      # @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
+      #
+      # @param address [Increase::Models::BeneficialOwnerUpdateParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::EntityBeneficialOwner]
+      #
+      # @see Increase::Models::BeneficialOwnerUpdateParams
+      def update(entity_beneficial_owner_id, params = {})
+        parsed, options = Increase::BeneficialOwnerUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["entity_beneficial_owners/%1$s", entity_beneficial_owner_id],
+          body: parsed,
+          model: Increase::EntityBeneficialOwner,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Increase::Models::BeneficialOwnerListParams} for more details.
       #

data/lib/increase/resources/events.rb

@@ -60,8 +60,18 @@ module Increase
 
       # @param payload [String] The raw webhook payload as a string
       #
+      # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
+      #
+      # @param key [String, nil] The webhook signing key
+      #
       # @return [Increase::Models::UnwrapWebhookEvent]
-      def unwrap(payload)
+      def unwrap(payload, headers:, key: @client.webhook_secret)
+        if key.nil?
+          raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_secret or passed in as an argument")
+        end
+
+        ::StandardWebhooks::Webhook.new(Base64.strict_encode64(key)).verify(payload, headers)
+
         parsed = JSON.parse(payload, symbolize_names: true)
         Increase::Internal::Type::Converter.coerce(Increase::Models::UnwrapWebhookEvent, parsed)
       end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.241.0"
+  VERSION = "1.243.0"
 end

data/lib/increase.rb

@@ -30,6 +30,7 @@ end
 
 # Gems.
 require "connection_pool"
+require "standardwebhooks"
 
 # Package files.
 require_relative "increase/version"
@@ -87,6 +88,7 @@ require_relative "increase/models/ach_transfer_retrieve_params"
 require_relative "increase/models/balance_lookup"
 require_relative "increase/models/beneficial_owner_list_params"
 require_relative "increase/models/beneficial_owner_retrieve_params"
+require_relative "increase/models/beneficial_owner_update_params"
 require_relative "increase/models/bookkeeping_account"
 require_relative "increase/models/bookkeeping_account_balance_params"
 require_relative "increase/models/bookkeeping_account_create_params"

data/rbi/increase/client.rbi

@@ -22,6 +22,9 @@ module Increase
     sig { returns(String) }
     attr_reader :api_key
 
+    sig { returns(T.nilable(String)) }
+    attr_reader :webhook_secret
+
     sig { returns(Increase::Resources::Accounts) }
     attr_reader :accounts
 
@@ -205,6 +208,7 @@ module Increase
     sig do
       params(
         api_key: T.nilable(String),
+        webhook_secret: T.nilable(String),
         environment: T.nilable(T.any(Symbol, String)),
         base_url: T.nilable(String),
         max_retries: Integer,
@@ -217,6 +221,8 @@ module Increase
     def self.new(
       # Defaults to `ENV["INCREASE_API_KEY"]`
       api_key: ENV["INCREASE_API_KEY"],
+      # Defaults to `ENV["INCREASE_WEBHOOK_SECRET"]`
+      webhook_secret: ENV["INCREASE_WEBHOOK_SECRET"],
       # Specifies the environment to use for the API.
       #
       # Each environment maps to a different base URL:

data/rbi/increase/models/beneficial_owner_update_params.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module Increase
+  module Models
+    class BeneficialOwnerUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::BeneficialOwnerUpdateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Beneficial Owner to update.
+      sig { returns(String) }
+      attr_accessor :entity_beneficial_owner_id
+
+      # The individual's physical address. Mail receiving locations like PO Boxes and
+      # PMB's are disallowed.
+      sig { returns(T.nilable(Increase::BeneficialOwnerUpdateParams::Address)) }
+      attr_reader :address
+
+      sig do
+        params(
+          address: Increase::BeneficialOwnerUpdateParams::Address::OrHash
+        ).void
+      end
+      attr_writer :address
+
+      sig do
+        params(
+          entity_beneficial_owner_id: String,
+          address: Increase::BeneficialOwnerUpdateParams::Address::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Beneficial Owner to update.
+        entity_beneficial_owner_id:,
+        # The individual's physical address. Mail receiving locations like PO Boxes and
+        # PMB's are disallowed.
+        address: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_beneficial_owner_id: String,
+            address: Increase::BeneficialOwnerUpdateParams::Address,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Address < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::BeneficialOwnerUpdateParams::Address,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The city, district, town, or village of the address.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+        sig { returns(String) }
+        attr_accessor :country
+
+        # The first line of the address. This is usually the street number and street.
+        sig { returns(String) }
+        attr_accessor :line1
+
+        # The second line of the address. This might be the floor or room number.
+        sig { returns(T.nilable(String)) }
+        attr_reader :line2
+
+        sig { params(line2: String).void }
+        attr_writer :line2
+
+        # The two-letter United States Postal Service (USPS) abbreviation for the US
+        # state, province, or region of the address. Required in certain countries.
+        sig { returns(T.nilable(String)) }
+        attr_reader :state
+
+        sig { params(state: String).void }
+        attr_writer :state
+
+        # The ZIP or postal code of the address. Required in certain countries.
+        sig { returns(T.nilable(String)) }
+        attr_reader :zip
+
+        sig { params(zip: String).void }
+        attr_writer :zip
+
+        # The individual's physical address. Mail receiving locations like PO Boxes and
+        # PMB's are disallowed.
+        sig do
+          params(
+            city: String,
+            country: String,
+            line1: String,
+            line2: String,
+            state: String,
+            zip: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city, district, town, or village of the address.
+          city:,
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          country:,
+          # The first line of the address. This is usually the street number and street.
+          line1:,
+          # The second line of the address. This might be the floor or room number.
+          line2: nil,
+          # The two-letter United States Postal Service (USPS) abbreviation for the US
+          # state, province, or region of the address. Required in certain countries.
+          state: nil,
+          # The ZIP or postal code of the address. Required in certain countries.
+          zip: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              city: String,
+              country: String,
+              line1: String,
+              line2: String,
+              state: String,
+              zip: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models.rbi

@@ -74,6 +74,8 @@ module Increase
   BeneficialOwnerRetrieveParams =
     Increase::Models::BeneficialOwnerRetrieveParams
 
+  BeneficialOwnerUpdateParams = Increase::Models::BeneficialOwnerUpdateParams
+
   BookkeepingAccount = Increase::Models::BookkeepingAccount
 
   BookkeepingAccountBalanceParams =

data/rbi/increase/resources/beneficial_owners.rbi

@@ -17,6 +17,24 @@ module Increase
       )
       end
 
+      # Update a Beneficial Owner
+      sig do
+        params(
+          entity_beneficial_owner_id: String,
+          address: Increase::BeneficialOwnerUpdateParams::Address::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityBeneficialOwner)
+      end
+      def update(
+        # The identifier of the Beneficial Owner to update.
+        entity_beneficial_owner_id,
+        # The individual's physical address. Mail receiving locations like PO Boxes and
+        # PMB's are disallowed.
+        address: nil,
+        request_options: {}
+      )
+      end
+
       # List Beneficial Owners
       sig do
         params(

data/rbi/increase/resources/events.rbi

@@ -42,10 +42,20 @@ module Increase
       )
       end
 
-      sig { params(payload: String).returns(Increase::UnwrapWebhookEvent) }
+      sig do
+        params(
+          payload: String,
+          headers: T::Hash[String, String],
+          key: T.nilable(String)
+        ).returns(Increase::UnwrapWebhookEvent)
+      end
       def unwrap(
         # The raw webhook payload as a string
-        payload
+        payload,
+        # The raw HTTP headers that came with the payload
+        headers:,
+        # The webhook signing key
+        key: @client.webhook_secret
       )
       end
 

data/sig/increase/client.rbs

@@ -15,6 +15,8 @@ module Increase
 
     attr_reader api_key: String
 
+    attr_reader webhook_secret: String?
+
     attr_reader accounts: Increase::Resources::Accounts
 
     attr_reader account_numbers: Increase::Resources::AccountNumbers
@@ -135,6 +137,7 @@ module Increase
 
     def initialize: (
       ?api_key: String?,
+      ?webhook_secret: String?,
       ?environment: :production | :sandbox | nil,
       ?base_url: String?,
       ?max_retries: Integer,

data/sig/increase/models/beneficial_owner_update_params.rbs

@@ -0,0 +1,83 @@
+module Increase
+  module Models
+    type beneficial_owner_update_params =
+      {
+        entity_beneficial_owner_id: String,
+        address: Increase::BeneficialOwnerUpdateParams::Address
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class BeneficialOwnerUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor entity_beneficial_owner_id: String
+
+      attr_reader address: Increase::BeneficialOwnerUpdateParams::Address?
+
+      def address=: (
+        Increase::BeneficialOwnerUpdateParams::Address
+      ) -> Increase::BeneficialOwnerUpdateParams::Address
+
+      def initialize: (
+        entity_beneficial_owner_id: String,
+        ?address: Increase::BeneficialOwnerUpdateParams::Address,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        entity_beneficial_owner_id: String,
+        address: Increase::BeneficialOwnerUpdateParams::Address,
+        request_options: Increase::RequestOptions
+      }
+
+      type address =
+        {
+          city: String,
+          country: String,
+          :line1 => String,
+          :line2 => String,
+          state: String,
+          zip: String
+        }
+
+      class Address < Increase::Internal::Type::BaseModel
+        attr_accessor city: String
+
+        attr_accessor country: String
+
+        attr_accessor line1: String
+
+        attr_reader line2: String?
+
+        def line2=: (String) -> String
+
+        attr_reader state: String?
+
+        def state=: (String) -> String
+
+        attr_reader zip: String?
+
+        def zip=: (String) -> String
+
+        def initialize: (
+          city: String,
+          country: String,
+          line1: String,
+          ?line2: String,
+          ?state: String,
+          ?zip: String
+        ) -> void
+
+        def to_hash: -> {
+          city: String,
+          country: String,
+          :line1 => String,
+          :line2 => String,
+          state: String,
+          zip: String
+        }
+      end
+    end
+  end
+end

data/sig/increase/models.rbs

@@ -67,6 +67,8 @@ module Increase
 
   class BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams
 
+  class BeneficialOwnerUpdateParams = Increase::Models::BeneficialOwnerUpdateParams
+
   class BookkeepingAccount = Increase::Models::BookkeepingAccount
 
   class BookkeepingAccountBalanceParams = Increase::Models::BookkeepingAccountBalanceParams

data/sig/increase/resources/beneficial_owners.rbs

@@ -6,6 +6,12 @@ module Increase
         ?request_options: Increase::request_opts
       ) -> Increase::EntityBeneficialOwner
 
+      def update: (
+        String entity_beneficial_owner_id,
+        ?address: Increase::BeneficialOwnerUpdateParams::Address,
+        ?request_options: Increase::request_opts
+      ) -> Increase::EntityBeneficialOwner
+
       def list: (
         entity_id: String,
         ?cursor: String,

data/sig/increase/resources/events.rbs

@@ -15,7 +15,11 @@ module Increase
         ?request_options: Increase::request_opts
       ) -> Increase::Internal::Page[Increase::Event]
 
-      def unwrap: (String payload) -> Increase::UnwrapWebhookEvent
+      def unwrap: (
+        String payload,
+        headers: ::Hash[String, String],
+        ?key: String?
+      ) -> Increase::UnwrapWebhookEvent
 
       def initialize: (client: Increase::Client) -> void
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.241.0
+  version: 1.243.0
 platform: ruby
 authors:
 - Increase
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardwebhooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: dev-feedback@increase.com
 executables: []
@@ -104,6 +118,7 @@ files:
 - lib/increase/models/balance_lookup.rb
 - lib/increase/models/beneficial_owner_list_params.rb
 - lib/increase/models/beneficial_owner_retrieve_params.rb
+- lib/increase/models/beneficial_owner_update_params.rb
 - lib/increase/models/bookkeeping_account.rb
 - lib/increase/models/bookkeeping_account_balance_params.rb
 - lib/increase/models/bookkeeping_account_create_params.rb
@@ -519,6 +534,7 @@ files:
 - rbi/increase/models/balance_lookup.rbi
 - rbi/increase/models/beneficial_owner_list_params.rbi
 - rbi/increase/models/beneficial_owner_retrieve_params.rbi
+- rbi/increase/models/beneficial_owner_update_params.rbi
 - rbi/increase/models/bookkeeping_account.rbi
 - rbi/increase/models/bookkeeping_account_balance_params.rbi
 - rbi/increase/models/bookkeeping_account_create_params.rbi
@@ -933,6 +949,7 @@ files:
 - sig/increase/models/balance_lookup.rbs
 - sig/increase/models/beneficial_owner_list_params.rbs
 - sig/increase/models/beneficial_owner_retrieve_params.rbs
+- sig/increase/models/beneficial_owner_update_params.rbs
 - sig/increase/models/bookkeeping_account.rbs
 - sig/increase/models/bookkeeping_account_balance_params.rbs
 - sig/increase/models/bookkeeping_account_create_params.rbs