clerk-sdk-ruby 5.1.3 → 6.0.0

data/lib/clerk/instancesettings.rb

@@ -447,6 +447,278 @@ module Clerk
 
 
     
+    def get_communication(retries: nil, timeout_ms: nil, http_headers: nil)
+      # get_communication - Get instance communication settings
+      # Retrieves the per-instance SMS communication settings, including the SMS country blocklist.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/instance/communication"
+      headers = {}
+      
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+      retries ||= @sdk_configuration.retry_config
+      retries ||= Utils::RetryConfig.new(
+        backoff: Utils::BackoffStrategy.new(
+          exponent: 1.5,
+          initial_interval: 500,
+          max_elapsed_time: 3_600_000,
+          max_interval: 60_000
+        ),
+        retry_connection_errors: true,
+        strategy: 'backoff'
+      )
+      retry_options = retries.to_faraday_retry_options(initial_time: Time.now)
+      retry_options[:retry_statuses] = [500, 501, 502, 503, 504, 505]
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client.dup
+      connection.request :retry, retry_options
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'GetInstanceCommunication',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = nil
+      http_response = nil
+      
+      
+      begin
+        http_response = connection.get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+          http_headers&.each do |key, value|
+            req.headers[key.to_s] = value
+          end
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Components::InstanceCommunication)
+          response = Models::Operations::GetInstanceCommunicationResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            instance_communication: obj
+          )
+
+          return response
+        else
+          raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+
+
+    
+    def update_communication(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
+      # update_communication - Update instance communication settings
+      # Replaces the SMS country blocklist for this instance. Pass the full set of ISO 3166-1
+      # alpha-2 country codes that should be blocked; codes that aren't recognized as SMS-tier
+      # countries are silently dropped from the persisted list. Omitting `blocked_country_codes`
+      # is a no-op.
+      #
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/instance/communication"
+      headers = {}
+      
+      req_content_type, data, form = Utils.serialize_request_body(request, false, true, :request, :json)
+      headers['content-type'] = req_content_type
+
+      if form && !form.empty?
+        body = Utils.encode_form(form)
+      elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
+        body = URI.encode_www_form(data)
+      else
+        body = data
+      end
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+      retries ||= @sdk_configuration.retry_config
+      retries ||= Utils::RetryConfig.new(
+        backoff: Utils::BackoffStrategy.new(
+          exponent: 1.5,
+          initial_interval: 500,
+          max_elapsed_time: 3_600_000,
+          max_interval: 60_000
+        ),
+        retry_connection_errors: true,
+        strategy: 'backoff'
+      )
+      retry_options = retries.to_faraday_retry_options(initial_time: Time.now)
+      retry_options[:retry_statuses] = [500, 501, 502, 503, 504, 505]
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client.dup
+      connection.request :retry, retry_options
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'UpdateInstanceCommunication',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = nil
+      http_response = nil
+      
+      
+      begin
+        http_response = connection.patch(url) do |req|
+          req.body = body
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+          http_headers&.each do |key, value|
+            req.headers[key.to_s] = value
+          end
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Components::InstanceCommunication)
+          response = Models::Operations::UpdateInstanceCommunicationResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            instance_communication: obj
+          )
+
+          return response
+        else
+          raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['422'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ClerkErrors)
+          obj.raw_response = http_response
+          raise obj
+        else
+          raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+
+
+    
     def get_o_auth_application_settings(retries: nil, timeout_ms: nil, http_headers: nil)
       # get_o_auth_application_settings - Get OAuth application settings
       # Retrieves the settings for OAuth applications for the instance (dynamic client registration, JWT access tokens, etc.).
@@ -857,6 +1129,142 @@ module Clerk
 
 
     
+    def get_organization_settings(retries: nil, timeout_ms: nil, http_headers: nil)
+      # get_organization_settings - Get instance organization settings
+      # Retrieves the organization settings of the instance
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/instance/organization_settings"
+      headers = {}
+      
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+      retries ||= @sdk_configuration.retry_config
+      retries ||= Utils::RetryConfig.new(
+        backoff: Utils::BackoffStrategy.new(
+          exponent: 1.5,
+          initial_interval: 500,
+          max_elapsed_time: 3_600_000,
+          max_interval: 60_000
+        ),
+        retry_connection_errors: true,
+        strategy: 'backoff'
+      )
+      retry_options = retries.to_faraday_retry_options(initial_time: Time.now)
+      retry_options[:retry_statuses] = [500, 501, 502, 503, 504, 505]
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client.dup
+      connection.request :retry, retry_options
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'GetInstanceOrganizationSettings',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = nil
+      http_response = nil
+      
+      
+      begin
+        http_response = connection.get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+          http_headers&.each do |key, value|
+            req.headers[key.to_s] = value
+          end
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Components::OrganizationSettings)
+          response = Models::Operations::GetInstanceOrganizationSettingsResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            organization_settings: obj
+          )
+
+          return response
+        else
+          raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['402', '404', '422'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ClerkErrors)
+          obj.raw_response = http_response
+          raise obj
+        else
+          raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+
+
+    
     def update_organization_settings(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # update_organization_settings - Update instance organization settings
       # Updates the organization settings of the instance
@@ -977,7 +1385,7 @@ module Clerk
         else
           raise ::Clerk::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
         end
-      elsif Utils.match_status_code(http_response.status, ['400', '402', '404', '422'])
+      elsif Utils.match_status_code(http_response.status, ['400', '402', '403', '404', '422'])
         if Utils.match_content_type(content_type, 'application/json')
           http_response = @sdk_configuration.hooks.after_success(
             hook_ctx: SDKHooks::AfterSuccessHookContext.new(

data/lib/clerk/m2m.rb

@@ -346,7 +346,7 @@ module Clerk
             response: http_response
           )
           response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ForbiddenError)
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::GetM2MTokensForbiddenError)
           obj.raw_response = http_response
           raise obj
         else

data/lib/clerk/models/components/_verificationresponse.rb

@@ -0,0 +1,57 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # The verification. After prepare_verification it is pending (unverified);
+      # after attempt_verification its status reflects the attempt outcome.
+      class VerificationResponse
+        
+        include Crystalline::MetadataFields
+
+        # The type of the verification object.
+        field :object, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object') } }
+        # The ID of the verification. Pass this to attempt_verification.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id') } }
+        # The status of the verification (unverified, verified, expired, or failed).
+        field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('status') } }
+        # The verification strategy (email_code or phone_code).
+        field :strategy, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('strategy') } }
+        # The number of attempts made against this verification.
+        field :attempts, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('attempts') } }
+        # Unix timestamp (milliseconds) at which the code expires.
+        field :expire_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expire_at') } }
+        # The channel the code was sent over (phone numbers only).
+        field :channel, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('channel') } }
+
+        
+        def initialize(object: nil, id: nil, status: nil, strategy: nil, attempts: nil, expire_at: nil, channel: nil)
+          @object = object
+          @id = id
+          @status = status
+          @strategy = strategy
+          @attempts = attempts
+          @expire_at = expire_at
+          @channel = channel
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @object == other.object
+          return false unless @id == other.id
+          return false unless @status == other.status
+          return false unless @strategy == other.strategy
+          return false unless @attempts == other.attempts
+          return false unless @expire_at == other.expire_at
+          return false unless @channel == other.channel
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/components/_verificationresponse.rbi

@@ -0,0 +1,25 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::VerificationResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::VerificationResponse
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def status(); end
+  def status=(str_); end
+  def strategy(); end
+  def strategy=(str_); end
+  def attempts(); end
+  def attempts=(str_); end
+  def expire_at(); end
+  def expire_at=(str_); end
+  def channel(); end
+  def channel=(str_); end
+end

data/lib/clerk/models/components/action.rbi

@@ -8,4 +8,4 @@ end
 
 
 class Clerk::Models::Components::Action
-end
+end

data/lib/clerk/models/components/actortoken.rbi

@@ -26,4 +26,4 @@ class Clerk::Models::Components::ActorToken
   def token=(str_); end
   def url(); end
   def url=(str_); end
-end
+end

data/lib/clerk/models/components/actortoken_actor.rbi

@@ -8,4 +8,4 @@ end
 
 
 class Clerk::Models::Components::ActorTokenActor
-end
+end

data/lib/clerk/models/components/actortoken_object.rbi

@@ -8,4 +8,4 @@ end
 
 
 class Clerk::Models::Components::ActorTokenObject
-end
+end

data/lib/clerk/models/components/actortoken_status.rbi

@@ -8,4 +8,4 @@ end
 
 
 class Clerk::Models::Components::ActorTokenStatus
-end
+end

data/lib/clerk/models/components/adjustcreditbalancerequest.rbi

@@ -18,4 +18,4 @@ class Clerk::Models::Components::AdjustCreditBalanceRequest
   def currency=(str_); end
   def note(); end
   def note=(str_); end
-end
+end

data/lib/clerk/models/components/affiliation_verification.rb

@@ -0,0 +1,50 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # Verification details for the user-facing affiliation between the domain and the organization (e.g. affiliation_email_code).
+      #
+      class AffiliationVerification
+        
+        include Crystalline::MetadataFields
+
+        # Status of the verification. It can be `unverified`, `verified`, `failed`, or `expired`.
+        field :status, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('status'), required: true } }
+        # Name of the strategy used to verify the domain
+        field :strategy, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('strategy'), required: true } }
+        # How many attempts have been made to verify the domain
+        field :attempts, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('attempts'), required: true } }
+        # Unix timestamp of when the verification will expire
+        field :expire_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expire_at'), required: true } }
+        # Unix timestamp of when ownership was verified. Only populated on `ownership_verification`; null on `affiliation_verification`.
+        #
+        field :verified_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('verified_at'), required: true } }
+
+        
+        def initialize(status:, strategy:, attempts: nil, expire_at: nil, verified_at: nil)
+          @status = status
+          @strategy = strategy
+          @attempts = attempts
+          @expire_at = expire_at
+          @verified_at = verified_at
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @status == other.status
+          return false unless @strategy == other.strategy
+          return false unless @attempts == other.attempts
+          return false unless @expire_at == other.expire_at
+          return false unless @verified_at == other.verified_at
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/components/affiliation_verification.rbi

@@ -0,0 +1,21 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::AffiliationVerification
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::AffiliationVerification
+  def status(); end
+  def status=(str_); end
+  def strategy(); end
+  def strategy=(str_); end
+  def attempts(); end
+  def attempts=(str_); end
+  def expire_at(); end
+  def expire_at=(str_); end
+  def verified_at(); end
+  def verified_at=(str_); end
+end

data/lib/clerk/models/components/agenttask.rb

@@ -19,15 +19,21 @@ module Clerk
         field :agent_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('agent_id'), required: true } }
         # A unique identifier for this agent task.
         #
+        field :agent_task_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('agent_task_id'), required: true } }
+        # A unique identifier for this agent task. Deprecated: use agent_task_id instead.
+        #
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
         field :task_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('task_id'), required: true } }
         # The URL that, when visited, creates a session for the user. Only present in the response to a create request.
         #
         field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('url') } }
 
         
-        def initialize(object:, agent_id:, task_id:, url: nil)
+        def initialize(object:, agent_id:, agent_task_id:, task_id:, url: nil)
           @object = object
           @agent_id = agent_id
+          @agent_task_id = agent_task_id
           @task_id = task_id
           @url = url
         end
@@ -37,6 +43,7 @@ module Clerk
           return false unless other.is_a? self.class
           return false unless @object == other.object
           return false unless @agent_id == other.agent_id
+          return false unless @agent_task_id == other.agent_task_id
           return false unless @task_id == other.task_id
           return false unless @url == other.url
           true

data/lib/clerk/models/components/agenttask.rbi

@@ -12,8 +12,10 @@ class Clerk::Models::Components::AgentTask
   def object=(str_); end
   def agent_id(); end
   def agent_id=(str_); end
+  def agent_task_id(); end
+  def agent_task_id=(str_); end
   def task_id(); end
   def task_id=(str_); end
   def url(); end
   def url=(str_); end
-end
+end