feat(client): add webhook support

Author: stainless-app[bot]

lib/finch_api/client.rb

@@ -24,6 +24,9 @@ class Client < FinchAPI::Internal::Transport::BaseClient
     # @return [String, nil]
     attr_reader :client_secret
 
+    # @return [String, nil]
+    attr_reader :webhook_secret
+
     # @return [FinchAPI::Resources::AccessTokens]
     attr_reader :access_tokens
 
@@ -90,6 +93,8 @@ class Client < FinchAPI::Internal::Transport::BaseClient
     #
     # @param access_token [String, nil]
     #
+    # @param webhook_secret [String, nil] Defaults to `ENV["FINCH_WEBHOOK_SECRET"]`
+    #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["FINCH_BASE_URL"]`
     #
@@ -104,6 +109,7 @@ def initialize(
       client_id: ENV["FINCH_CLIENT_ID"],
       client_secret: ENV["FINCH_CLIENT_SECRET"],
       access_token: nil,
+      webhook_secret: ENV["FINCH_WEBHOOK_SECRET"],
       base_url: ENV["FINCH_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -119,6 +125,7 @@ def initialize(
       @client_id = client_id&.to_s
       @client_secret = client_secret&.to_s
       @access_token = access_token&.to_s
+      @webhook_secret = webhook_secret&.to_s
 
       super(
         base_url: base_url,

rbi/finch_api/client.rbi

@@ -19,6 +19,9 @@ module FinchAPI
     sig { returns(T.nilable(String)) }
     attr_reader :client_secret
 
+    sig { returns(T.nilable(String)) }
+    attr_reader :webhook_secret
+
     sig { returns(FinchAPI::Resources::AccessTokens) }
     attr_reader :access_tokens
 
@@ -74,6 +77,7 @@ module FinchAPI
         client_id: T.nilable(String),
         client_secret: T.nilable(String),
         access_token: T.nilable(String),
+        webhook_secret: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -87,6 +91,8 @@ module FinchAPI
       # Defaults to `ENV["FINCH_CLIENT_SECRET"]`
       client_secret: ENV["FINCH_CLIENT_SECRET"],
       access_token: nil,
+      # Defaults to `ENV["FINCH_WEBHOOK_SECRET"]`
+      webhook_secret: ENV["FINCH_WEBHOOK_SECRET"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["FINCH_BASE_URL"]`
       base_url: ENV["FINCH_BASE_URL"],

sig/finch_api/client.rbs

@@ -14,6 +14,8 @@ module FinchAPI
 
     attr_reader client_secret: String?
 
+    attr_reader webhook_secret: String?
+
     attr_reader access_tokens: FinchAPI::Resources::AccessTokens
 
     attr_reader hris: FinchAPI::Resources::HRIS
@@ -46,6 +48,7 @@ module FinchAPI
       ?client_id: String?,
       ?client_secret: String?,
       ?access_token: String?,
+      ?webhook_secret: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,