clerk-sdk-ruby 5.0.0.pre.beta → 5.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb5f08a417654935729d5612687131b38d9e4817689edcfd964ab250274dc4d3
-  data.tar.gz: 4dce981bcf6a5024f8c80e6cb9a57346dc678bad3101a72e64a3334a37a7e8ff
+  metadata.gz: cc7b0d0982301864ad97026cc179a43e7e9f6c68a392396ebbbac98016bb19bf
+  data.tar.gz: b5c91c3096c37dc48ca43b8ac9af13ab25bff49821151872d48ee3c03947955e
 SHA512:
-  metadata.gz: f17eb690523cbc400f2b197105d4054a882144a25a7a388d57d595fcdb20e297ded9c062f85c9a865228860c37b8b4b1849a0c332899b1f56eff97dafecd96a0
-  data.tar.gz: ab365152be6bba6f79445f8322b10f4b14568c9ad704b7e042a260915ecbb0f4884cee5408e95582e417b722b77fd54ce969376b5f81e26bdbfe6ba6f3829f19
+  metadata.gz: 3cba47d353ed5abef6c7639fe7dbbeb7d59e18d9c07fd7e6038eda6c278f690f60a4a3a2ea0f319f00646f048ce47c650271dd27494de28c4d1cd86661315af4
+  data.tar.gz: 10d2eeb326457c39d445b010ccce48da8d2c3b22a6e7663556a0fbfae96ed2a8cc6474ed181bc8670b263a04a369f7d1f3dae05ea4b1af28ca2bb547da50fafb

data/lib/clerk/billing.rb

@@ -678,6 +678,176 @@ module Clerk
 
 
     
+    def create_price_transition(body:, subscription_item_id:, retries: nil, timeout_ms: nil)
+      # create_price_transition - Create a price transition for a subscription item
+      # Creates a price transition for the specified subscription item.
+      # This may create an upcoming subscription item or activate immediately depending on plan and payer rules.
+      request = Models::Operations::CreateBillingPriceTransitionRequest.new(
+        subscription_item_id: subscription_item_id,
+        body: body
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Models::Operations::CreateBillingPriceTransitionRequest,
+        base_url,
+        '/billing/subscription_items/{subscription_item_id}/price_transition',
+        request
+      )
+      headers = {}
+      
+      req_content_type, data, form = Utils.serialize_request_body(request, false, false, :body, :json)
+      headers['content-type'] = req_content_type
+      raise StandardError, 'request body is required' if data.nil? && form.nil?
+
+      if form
+        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: 'CreateBillingPriceTransition',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = nil
+      http_response = nil
+      
+      
+      begin
+        http_response = connection.post(url) do |req|
+          req.body = body
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @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::CommercePriceTransitionResponse)
+          response = Models::Operations::CreateBillingPriceTransitionResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            commerce_price_transition_response: 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, ['400', '401', '403', '404', '409', '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, ['500'])
+        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 list_statements(paginated: nil, limit: nil, offset: nil, retries: nil, timeout_ms: nil)
       # list_statements - List all billing statements
       # Returns a list of all billing statements for the instance. The statements are returned sorted by creation date,

data/lib/clerk/instancesettings.rb

@@ -14,7 +14,7 @@ module Clerk
   class InstanceSettings
     
     
-
+    # Modify the settings of your instance.
 
     
     def initialize(sdk_config)
@@ -716,5 +716,265 @@ module Clerk
 
       end
     end
+
+
+    
+    def get_instance_protect(retries: nil, timeout_ms: nil)
+      # get_instance_protect - Get instance protect settings
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/instance/protect"
+      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: 'GetInstanceProtect',
+        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)
+
+          @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::InstanceProtect)
+          response = Models::Operations::GetInstanceProtectResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            instance_protect: 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_instance_protect(request: nil, retries: nil, timeout_ms: nil)
+      # update_instance_protect - Update instance protect settings
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/instance/protect"
+      headers = {}
+      
+      req_content_type, data, form = Utils.serialize_request_body(request, false, true, :request, :json)
+      headers['content-type'] = req_content_type
+
+      if form
+        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: 'UpdateInstanceProtect',
+        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)
+
+          @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::InstanceProtect)
+          response = Models::Operations::UpdateInstanceProtectResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            instance_protect: 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
   end
 end

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

@@ -0,0 +1,76 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class CommercePriceResponse
+        
+        include Crystalline::MetadataFields
+
+        # String representing the object's type. Objects of the same type share the same value.
+        field :object, Models::Components::CommercePriceResponseObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': Utils.enum_from_string(Models::Components::CommercePriceResponseObject, false) } }
+        # Unique identifier for the price.
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+        # Unique identifier for the associated plan.
+        field :plan_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('plan_id'), required: true } }
+        # Unique identifier for the instance.
+        field :instance_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('instance_id'), required: true } }
+        # The currency code (e.g., "USD").
+        field :currency, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('currency'), required: true } }
+        # The currency symbol (e.g., "$").
+        field :currency_symbol, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('currency_symbol'), required: true } }
+        # The amount in cents for the price.
+        field :amount, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount'), required: true } }
+        # The monthly amount in cents when billed annually.
+        field :annual_monthly_amount, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('annual_monthly_amount'), required: true } }
+
+        field :fee, Models::Components::CommerceMoneyResponse, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('fee'), required: true } }
+
+        field :annual_monthly_fee, Models::Components::CommerceMoneyResponse, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('annual_monthly_fee'), required: true } }
+        # Unix timestamp (milliseconds) of creation.
+        field :created_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('created_at'), required: true } }
+        # The description of the price.
+        field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('description') } }
+
+        
+        def initialize(object:, id:, plan_id:, instance_id:, currency:, currency_symbol:, amount:, annual_monthly_amount:, fee:, annual_monthly_fee:, created_at:, description: nil)
+          @object = object
+          @id = id
+          @plan_id = plan_id
+          @instance_id = instance_id
+          @currency = currency
+          @currency_symbol = currency_symbol
+          @amount = amount
+          @annual_monthly_amount = annual_monthly_amount
+          @fee = fee
+          @annual_monthly_fee = annual_monthly_fee
+          @created_at = created_at
+          @description = description
+        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 @plan_id == other.plan_id
+          return false unless @instance_id == other.instance_id
+          return false unless @currency == other.currency
+          return false unless @currency_symbol == other.currency_symbol
+          return false unless @amount == other.amount
+          return false unless @annual_monthly_amount == other.annual_monthly_amount
+          return false unless @fee == other.fee
+          return false unless @annual_monthly_fee == other.annual_monthly_fee
+          return false unless @created_at == other.created_at
+          return false unless @description == other.description
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::CommercePriceResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::CommercePriceResponse
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def plan_id(); end
+  def plan_id=(str_); end
+  def instance_id(); end
+  def instance_id=(str_); end
+  def currency(); end
+  def currency=(str_); end
+  def currency_symbol(); end
+  def currency_symbol=(str_); end
+  def amount(); end
+  def amount=(str_); end
+  def annual_monthly_amount(); end
+  def annual_monthly_amount=(str_); end
+  def fee(); end
+  def fee=(str_); end
+  def annual_monthly_fee(); end
+  def annual_monthly_fee=(str_); end
+  def created_at(); end
+  def created_at=(str_); end
+  def description(); end
+  def description=(str_); end
+end

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

@@ -0,0 +1,22 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # CommercePriceResponseObject - String representing the object's type. Objects of the same type share the same value.
+      class CommercePriceResponseObject
+
+
+        include ::Crystalline::Enum
+
+        enums do
+          COMMERCE_PRICE = new('commerce_price')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::CommercePriceResponseObject
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::CommercePriceResponseObject
+end

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

@@ -0,0 +1,64 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class CommercePriceTransitionDetails
+        
+        include Crystalline::MetadataFields
+
+
+        field :previous_plan, Models::Components::SchemasCommercePlan, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('previous_plan'), required: true } }
+
+        field :previous_price, Models::Components::CommercePriceResponse, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('previous_price'), required: true } }
+        # Unix timestamp (milliseconds) when the new price takes effect.
+        field :effective_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('effective_at'), required: true } }
+        # When the new price takes effect.
+        field :effective_mode, Models::Components::EffectiveMode, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('effective_mode'), required: true, 'decoder': Utils.enum_from_string(Models::Components::EffectiveMode, false) } }
+        # Whether an immediate charge was made.
+        field :charged_immediately, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('charged_immediately'), required: true } }
+        # The status of the previous subscription item after transition.
+        field :previous_subscription_item_status, Models::Components::PreviousSubscriptionItemStatus, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('previous_subscription_item_status'), required: true, 'decoder': Utils.enum_from_string(Models::Components::PreviousSubscriptionItemStatus, false) } }
+        # The ID of the previous subscription item.
+        field :previous_subscription_item_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('previous_subscription_item_id'), required: true } }
+        # Unix timestamp (milliseconds) for the next billing date.
+        field :next_billing_date, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('next_billing_date') } }
+        # Amount charged immediately, if any.
+        field :immediate_charge, Crystalline::Nilable.new(Models::Components::ImmediateCharge), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('immediate_charge') } }
+
+        
+        def initialize(previous_plan:, previous_price:, effective_at:, effective_mode:, charged_immediately:, previous_subscription_item_status:, previous_subscription_item_id:, next_billing_date: nil, immediate_charge: nil)
+          @previous_plan = previous_plan
+          @previous_price = previous_price
+          @effective_at = effective_at
+          @effective_mode = effective_mode
+          @charged_immediately = charged_immediately
+          @previous_subscription_item_status = previous_subscription_item_status
+          @previous_subscription_item_id = previous_subscription_item_id
+          @next_billing_date = next_billing_date
+          @immediate_charge = immediate_charge
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @previous_plan == other.previous_plan
+          return false unless @previous_price == other.previous_price
+          return false unless @effective_at == other.effective_at
+          return false unless @effective_mode == other.effective_mode
+          return false unless @charged_immediately == other.charged_immediately
+          return false unless @previous_subscription_item_status == other.previous_subscription_item_status
+          return false unless @previous_subscription_item_id == other.previous_subscription_item_id
+          return false unless @next_billing_date == other.next_billing_date
+          return false unless @immediate_charge == other.immediate_charge
+          true
+        end
+      end
+    end
+  end
+end