increase 1.241.0 → 1.242.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a04be041eba6a264331c3d2790223aac3bcd162e58d41c948ee77895342f59ed
-  data.tar.gz: acbd6d8dbf14a45bd3eca79fce36e3d6fbcd38cbc00fe9d7355133ee1269c7eb
+  metadata.gz: fce3493743b7f1e3f2193de6a7e044d9e7b987320e8eaec2715c6c19b26e87e6
+  data.tar.gz: 8a9a9b0689feff56ecd5005669356613b69a33f67e44e545ae1170d79dfa62e3
 SHA512:
-  metadata.gz: 344aec2294c913273b00a4fcc7aba0ac974ced037aebd2048c5e60d482c925778ba7da9c98d909f11c50302022c3f945d9c2c0af4e72aa9f7d334d30d0cb29d2
-  data.tar.gz: 73c02285fab40ef9d198665de68036fe6cda8c8a7d47167371497b57d54e2516d41706d8cbcfd699b07845a4cb712b2fa40d8eda8917a03db1d6266d242e8017
+  metadata.gz: 9f299a870b76d3fb04e30499ba66af6bf54dbd225d061846d4e519746ea6399e121302149124382ab46ca93cb6286820056949f5ed46c801cb1847e4d648d0bc
+  data.tar.gz: 02b939d5884249325b3f4d1a54d78603d421b26189c34fec5f0624e3aa017694933585c5b2dd053b9df1033d2108a1f90b745b7bb12a66f91c012393eb890be2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 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.242.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/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.242.0"
 end

data/lib/increase.rb

@@ -30,6 +30,7 @@ end
 
 # Gems.
 require "connection_pool"
+require "standardwebhooks"
 
 # Package files.
 require_relative "increase/version"

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/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/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.242.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: []