clerk-sdk-ruby 8.0.0 → 8.0.1

data/lib/clerk/domains.rb

@@ -168,7 +168,10 @@ module Clerk
       # Add a new domain for your instance.
       # Useful in the case of multi-domain instances, allows adding satellite domains to an instance.
       # The new domain must have a `name`. The domain name can contain the port for development instances, like `localhost:3000`.
-      # At the moment, instances can have only one primary domain, so the `is_satellite` parameter must be set to `true`.
+      # Set `is_satellite` to `true` to add a satellite domain.
+      # To migrate a production instance from an active provider domain to its first custom primary domain,
+      # set `is_satellite` to `false`. The custom domain becomes active and the provider domain stays attached.
+      # Additional custom primary domains are not supported.
       # If you're planning to configure the new satellite domain to run behind a proxy, pass the `proxy_url` parameter accordingly.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -315,9 +318,9 @@ module Clerk
 
     
     def delete(domain_id:, retries: nil, timeout_ms: nil, http_headers: nil)
-      # delete - Delete a satellite domain
-      # Deletes a satellite domain for the instance.
-      # It is currently not possible to delete the instance's primary domain.
+      # delete - Delete a domain
+      # Deletes a domain for the instance.
+      # The instance's active domain cannot be deleted.
       request = Models::Operations::DeleteDomainRequest.new(
         domain_id: domain_id
       )

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

@@ -0,0 +1,44 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # Fixed amount off when the effect is fixed_amount.
+      class AmountOff
+        
+        include Crystalline::MetadataFields
+
+        # The amount in cents.
+        field :amount, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount'), required: true } }
+        # The formatted amount as a string (e.g., "$49.99").
+        field :amount_formatted, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount_formatted'), 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 } }
+
+        
+        def initialize(amount:, amount_formatted:, currency:, currency_symbol:)
+          @amount = amount
+          @amount_formatted = amount_formatted
+          @currency = currency
+          @currency_symbol = currency_symbol
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @amount == other.amount
+          return false unless @amount_formatted == other.amount_formatted
+          return false unless @currency == other.currency
+          return false unless @currency_symbol == other.currency_symbol
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::AmountOff
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::AmountOff
+  def amount(); end
+  def amount=(str_); end
+  def amount_formatted(); end
+  def amount_formatted=(str_); end
+  def currency(); end
+  def currency=(str_); end
+  def currency_symbol(); end
+  def currency_symbol=(str_); end
+end

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

@@ -0,0 +1,32 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class ApplyCommerceDiscountRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the discount to apply to the subscription item.
+        field :discount_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('discount_id'), required: true } }
+
+        
+        def initialize(discount_id:)
+          @discount_id = discount_id
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @discount_id == other.discount_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::ApplyCommerceDiscountRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::ApplyCommerceDiscountRequest
+  def discount_id(); end
+  def discount_id=(str_); end
+end

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

@@ -0,0 +1,21 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class AutomationDisposition
+        include ::Crystalline::Enum
+        enums do
+          ALREADY_SATISFIED = new('already_satisfied')
+          SAFE_TO_CREATE = new('safe_to_create')
+          MANUAL_RESOLUTION_REQUIRED = new('manual_resolution_required')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -27,7 +27,7 @@ module Clerk
         # Totals for the statement.
         field :totals, Models::Components::BillingStatementTotals, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('totals'), required: true } }
         # Array of statement groups.
-        field :groups, Crystalline::Array.new(Models::Components::Group), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('groups'), required: true } }
+        field :groups, Crystalline::Array.new(Models::Components::BillingStatementGroup), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('groups'), required: true } }
 
         
         def initialize(object:, id:, instance_id:, timestamp:, payer:, status:, totals:, groups:)

data/lib/clerk/models/components/{group.rb → billingstatement_group.rb}

@@ -8,7 +8,7 @@ module Clerk
   module Models
     module Components
       # A statement group.
-      class Group
+      class BillingStatementGroup
         
         include Crystalline::MetadataFields
 

data/lib/clerk/models/components/{group.rbi → billingstatement_group.rbi}

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 
-class Clerk::Models::Components::Group
+class Clerk::Models::Components::BillingStatementGroup
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
 
-class Clerk::Models::Components::Group
+class Clerk::Models::Components::BillingStatementGroup
   def object(); end
   def object=(str_); end
   def timestamp(); end

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

@@ -0,0 +1,72 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class BiometricCredential
+        
+        include Crystalline::MetadataFields
+
+        # String representing the object's type.
+        field :object, Models::Components::BiometricCredentialObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::BiometricCredentialObject, false) } }
+
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+
+        field :platform, Models::Components::BiometricCredentialPlatform, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('platform'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::BiometricCredentialPlatform, false) } }
+
+        field :app_identifier, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('app_identifier'), required: true } }
+
+        field :algorithm, Models::Components::BiometricCredentialAlgorithm, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('algorithm'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::BiometricCredentialAlgorithm, false) } }
+
+        field :status, Models::Components::BiometricCredentialStatus, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('status'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::BiometricCredentialStatus, false) } }
+        # Unix timestamp of creation in milliseconds.
+        field :created_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('created_at'), required: true } }
+        # Unix timestamp of the last update in milliseconds.
+        field :updated_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('updated_at'), required: true } }
+
+        field :name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('name') } }
+        # Unix timestamp of the last use in milliseconds.
+        field :last_used_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('last_used_at') } }
+        # Unix timestamp of revocation in milliseconds.
+        field :revoked_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('revoked_at') } }
+
+        
+        def initialize(object:, id:, platform:, app_identifier:, algorithm:, status:, created_at:, updated_at:, name: nil, last_used_at: nil, revoked_at: nil)
+          @object = object
+          @id = id
+          @platform = platform
+          @app_identifier = app_identifier
+          @algorithm = algorithm
+          @status = status
+          @created_at = created_at
+          @updated_at = updated_at
+          @name = name
+          @last_used_at = last_used_at
+          @revoked_at = revoked_at
+        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 @platform == other.platform
+          return false unless @app_identifier == other.app_identifier
+          return false unless @algorithm == other.algorithm
+          return false unless @status == other.status
+          return false unless @created_at == other.created_at
+          return false unless @updated_at == other.updated_at
+          return false unless @name == other.name
+          return false unless @last_used_at == other.last_used_at
+          return false unless @revoked_at == other.revoked_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::BiometricCredential
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::BiometricCredential
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def platform(); end
+  def platform=(str_); end
+  def app_identifier(); end
+  def app_identifier=(str_); end
+  def algorithm(); end
+  def algorithm=(str_); end
+  def status(); end
+  def status=(str_); end
+  def created_at(); end
+  def created_at=(str_); end
+  def updated_at(); end
+  def updated_at=(str_); end
+  def name(); end
+  def name=(str_); end
+  def last_used_at(); end
+  def last_used_at=(str_); end
+  def revoked_at(); end
+  def revoked_at=(str_); end
+end

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

@@ -0,0 +1,19 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class BiometricCredentialAlgorithm
+        include ::Crystalline::Enum
+        enums do
+          ES256 = new('ES256')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # Success
+      class BiometricCredentialList
+        
+        include Crystalline::MetadataFields
+
+
+        field :data, Crystalline::Array.new(Models::Components::BiometricCredential), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('data'), required: true } }
+        # Total number of biometric credentials
+        field :total_count, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('total_count'), required: true } }
+
+        
+        def initialize(data:, total_count:)
+          @data = data
+          @total_count = total_count
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @data == other.data
+          return false unless @total_count == other.total_count
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::BiometricCredentialList
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::BiometricCredentialList
+  def data(); end
+  def data=(str_); end
+  def total_count(); end
+  def total_count=(str_); end
+end

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

@@ -0,0 +1,19 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # BiometricCredentialObject - String representing the object's type.
+      class BiometricCredentialObject
+        include ::Crystalline::Enum
+        enums do
+          TRUSTED_DEVICE = new('trusted_device')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class BiometricCredentialPlatform
+        include ::Crystalline::Enum
+        enums do
+          IOS = new('ios')
+          ANDROID = new('android')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class BiometricCredentialStatus
+        include ::Crystalline::Enum
+        enums do
+          ACTIVE = new('active')
+          REVOKED = new('revoked')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,93 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # A commerce discount redemption.
+      class CommerceDiscountRedemptionResponse
+        
+        include Crystalline::MetadataFields
+
+        # String representing the object's type. Objects of the same type share the same value.
+        field :object, Models::Components::CommerceDiscountRedemptionResponseObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::CommerceDiscountRedemptionResponseObject, false) } }
+        # Unique identifier for the discount redemption.
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+        # Unique identifier for the subscription item the discount was applied to.
+        field :subscription_item_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('subscription_item_id'), required: true } }
+        # Unique identifier for the discount that was applied.
+        field :discount_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('discount_id'), required: true } }
+        # How the discount was applied to the subscription item.
+        field :source, Models::Components::Source, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('source'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::Source, false) } }
+        # Number of billing cycles the discount has already been applied to.
+        field :cycles_applied, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('cycles_applied'), required: true } }
+        # Unix timestamp (in milliseconds) when the discount was redeemed.
+        field :redeemed_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redeemed_at'), required: true } }
+        # The display name of the discount.
+        field :name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('name') } }
+        # The promo code used to redeem the discount, when applicable.
+        field :promo_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('promo_code') } }
+        # The snapshotted discount effect.
+        field :effect, Crystalline::Nilable.new(Models::Components::Effect), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('effect'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::Effect, true) } }
+        # Remaining billing cycles the discount applies to. Null means the discount lasts forever.
+        field :cycles_remaining, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('cycles_remaining'), required: true } }
+        # Current status of the discount redemption.
+        field :status, Crystalline::Nilable.new(Models::Components::CommerceDiscountRedemptionResponseStatus), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('status'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::CommerceDiscountRedemptionResponseStatus, true) } }
+        # Identifier of the actor that redeemed the discount, when available.
+        field :redeemed_by, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redeemed_by'), required: true } }
+        # Percent off when the effect is percentage.
+        field :percent_off, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('percent_off') } }
+        # Fixed amount off when the effect is fixed_amount.
+        field :amount_off, Crystalline::Nilable.new(Models::Components::AmountOff), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount_off') } }
+        # How much this discount takes off the subscription item's next renewal charge.
+        # Present for either effect when next-payment data is available.
+        field :amount, Crystalline::Nilable.new(Models::Components::CommerceDiscountRedemptionResponseAmount), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount') } }
+
+        
+        def initialize(object:, id:, subscription_item_id:, discount_id:, source:, cycles_applied:, redeemed_at:, name: nil, promo_code: nil, effect: nil, cycles_remaining: nil, status: nil, redeemed_by: nil, percent_off: nil, amount_off: nil, amount: nil)
+          @object = object
+          @id = id
+          @subscription_item_id = subscription_item_id
+          @discount_id = discount_id
+          @source = source
+          @cycles_applied = cycles_applied
+          @redeemed_at = redeemed_at
+          @name = name
+          @promo_code = promo_code
+          @effect = effect
+          @cycles_remaining = cycles_remaining
+          @status = status
+          @redeemed_by = redeemed_by
+          @percent_off = percent_off
+          @amount_off = amount_off
+          @amount = amount
+        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 @subscription_item_id == other.subscription_item_id
+          return false unless @discount_id == other.discount_id
+          return false unless @source == other.source
+          return false unless @cycles_applied == other.cycles_applied
+          return false unless @redeemed_at == other.redeemed_at
+          return false unless @name == other.name
+          return false unless @promo_code == other.promo_code
+          return false unless @effect == other.effect
+          return false unless @cycles_remaining == other.cycles_remaining
+          return false unless @status == other.status
+          return false unless @redeemed_by == other.redeemed_by
+          return false unless @percent_off == other.percent_off
+          return false unless @amount_off == other.amount_off
+          return false unless @amount == other.amount
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::CommerceDiscountRedemptionResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::CommerceDiscountRedemptionResponse
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def subscription_item_id(); end
+  def subscription_item_id=(str_); end
+  def discount_id(); end
+  def discount_id=(str_); end
+  def source(); end
+  def source=(str_); end
+  def cycles_applied(); end
+  def cycles_applied=(str_); end
+  def redeemed_at(); end
+  def redeemed_at=(str_); end
+  def name(); end
+  def name=(str_); end
+  def promo_code(); end
+  def promo_code=(str_); end
+  def effect(); end
+  def effect=(str_); end
+  def cycles_remaining(); end
+  def cycles_remaining=(str_); end
+  def status(); end
+  def status=(str_); end
+  def redeemed_by(); end
+  def redeemed_by=(str_); end
+  def percent_off(); end
+  def percent_off=(str_); end
+  def amount_off(); end
+  def amount_off=(str_); end
+  def amount(); end
+  def amount=(str_); end
+end