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

data/lib/clerk/models/operations/assignpermissiontoorganizationrole_response.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::AssignPermissionToOrganizationRoleResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::AssignPermissionToOrganizationRoleResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def role(); end
+  def role=(str_); end
+end

data/lib/clerk/models/operations/banuser_request.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 Operations
+
+      class BanUserRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the user to ban
+        field :user_id, ::String, { 'path_param': { 'field_name': 'user_id', 'style': 'simple', 'explode': false } }
+
+        
+        def initialize(user_id:)
+          @user_id = user_id
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @user_id == other.user_id
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/banuser_request.rbi

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

data/lib/clerk/models/operations/banuser_response.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 Operations
+
+      class BanUserResponse
+        
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # Success
+        field :user, Crystalline::Nilable.new(Models::Components::User)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, user: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @user = user
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @user == other.user
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/banuser_response.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::BanUserResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::BanUserResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def user(); end
+  def user=(str_); end
+end

data/lib/clerk/models/operations/cancelcommercesubscriptionitem_request.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 Operations
+
+      class CancelCommerceSubscriptionItemRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the subscription item to cancel
+        field :subscription_item_id, ::String, { 'path_param': { 'field_name': 'subscription_item_id', 'style': 'simple', 'explode': false } }
+        # Whether to cancel the subscription immediately (true) or at the end of the current billing period (false, default)
+        field :end_now, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'end_now', 'style': 'form', 'explode': true } }
+
+        
+        def initialize(subscription_item_id:, end_now: false)
+          @subscription_item_id = subscription_item_id
+          @end_now = end_now
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @subscription_item_id == other.subscription_item_id
+          return false unless @end_now == other.end_now
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/cancelcommercesubscriptionitem_request.rbi

@@ -0,0 +1,15 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::CancelCommerceSubscriptionItemRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::CancelCommerceSubscriptionItemRequest
+  def subscription_item_id(); end
+  def subscription_item_id=(str_); end
+  def end_now(); end
+  def end_now=(str_); end
+end

data/lib/clerk/models/operations/cancelcommercesubscriptionitem_response.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 Operations
+
+      class CancelCommerceSubscriptionItemResponse
+        
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # A commerce subscription item.
+        field :commerce_subscription_item, Crystalline::Nilable.new(Models::Components::CommerceSubscriptionItem)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, commerce_subscription_item: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @commerce_subscription_item = commerce_subscription_item
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @commerce_subscription_item == other.commerce_subscription_item
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/cancelcommercesubscriptionitem_response.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::CancelCommerceSubscriptionItemResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::CancelCommerceSubscriptionItemResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def commerce_subscription_item(); end
+  def commerce_subscription_item=(str_); end
+end

data/lib/clerk/models/operations/changeproductioninstancedomain_request.rb

@@ -0,0 +1,38 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class ChangeProductionInstanceDomainRequest
+        
+        include Crystalline::MetadataFields
+
+        # The new home URL of the production instance e.g. https://www.example.com
+        field :home_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('home_url') } }
+        # Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and
+        # will be stored as part of the domain. This is useful for supporting multiple apps (one primary and
+        # multiple secondaries) on the same root domain (eTLD+1).
+        field :is_secondary, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('is_secondary') } }
+
+        
+        def initialize(home_url: nil, is_secondary: nil)
+          @home_url = home_url
+          @is_secondary = is_secondary
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @home_url == other.home_url
+          return false unless @is_secondary == other.is_secondary
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/changeproductioninstancedomain_request.rbi

@@ -0,0 +1,15 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::ChangeProductionInstanceDomainRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::ChangeProductionInstanceDomainRequest
+  def home_url(); end
+  def home_url=(str_); end
+  def is_secondary(); end
+  def is_secondary=(str_); end
+end

data/lib/clerk/models/operations/changeproductioninstancedomain_response.rb

@@ -0,0 +1,40 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class ChangeProductionInstanceDomainResponse
+        
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+
+        
+        def initialize(content_type:, status_code:, raw_response:)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/changeproductioninstancedomain_response.rbi

@@ -0,0 +1,17 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::ChangeProductionInstanceDomainResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::ChangeProductionInstanceDomainResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+end

data/lib/clerk/models/operations/clerkidpoauthaccesstoken.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 Operations
+
+      class ClerkIdpOauthAccessToken
+        
+        include Crystalline::MetadataFields
+
+
+        field :object, Models::Operations::VerifyOAuthAccessTokenObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': Utils.enum_from_string(Models::Operations::VerifyOAuthAccessTokenObject, false) } }
+
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+
+        field :client_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('client_id'), required: true } }
+
+        field :subject, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('subject'), required: true } }
+
+        field :scopes, Crystalline::Array.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('scopes'), required: true } }
+
+        field :revoked, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('revoked'), required: true } }
+
+        field :expired, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expired'), required: true } }
+
+        field :created_at, ::Float, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('created_at'), required: true } }
+
+        field :updated_at, ::Float, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('updated_at'), required: true } }
+
+        field :revocation_reason, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('revocation_reason'), required: true } }
+
+        field :expiration, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expiration'), required: true } }
+
+        
+        def initialize(object:, id:, client_id:, subject:, scopes:, revoked:, expired:, created_at:, updated_at:, revocation_reason: nil, expiration: nil)
+          @object = object
+          @id = id
+          @client_id = client_id
+          @subject = subject
+          @scopes = scopes
+          @revoked = revoked
+          @expired = expired
+          @created_at = created_at
+          @updated_at = updated_at
+          @revocation_reason = revocation_reason
+          @expiration = expiration
+        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 @client_id == other.client_id
+          return false unless @subject == other.subject
+          return false unless @scopes == other.scopes
+          return false unless @revoked == other.revoked
+          return false unless @expired == other.expired
+          return false unless @created_at == other.created_at
+          return false unless @updated_at == other.updated_at
+          return false unless @revocation_reason == other.revocation_reason
+          return false unless @expiration == other.expiration
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/clerkidpoauthaccesstoken.rbi

@@ -0,0 +1,33 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::ClerkIdpOauthAccessToken
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::ClerkIdpOauthAccessToken
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def client_id(); end
+  def client_id=(str_); end
+  def subject(); end
+  def subject=(str_); end
+  def scopes(); end
+  def scopes=(str_); end
+  def revoked(); end
+  def revoked=(str_); end
+  def expired(); end
+  def expired=(str_); end
+  def created_at(); end
+  def created_at=(str_); end
+  def updated_at(); end
+  def updated_at=(str_); end
+  def revocation_reason(); end
+  def revocation_reason=(str_); end
+  def expiration(); end
+  def expiration=(str_); end
+end

data/lib/clerk/models/operations/code_type.rb

@@ -0,0 +1,23 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class CodeType
+
+
+        include ::Crystalline::Enum
+
+        enums do
+          TOTP = new('totp')
+          BACKUP_CODE = new('backup_code')
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/code_type.rbi

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

data/lib/clerk/models/operations/createactortoken_request.rb

@@ -0,0 +1,47 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class CreateActorTokenRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the user being impersonated.
+        field :user_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('user_id'), required: true } }
+        # The actor payload. It needs to include a sub property which should contain the ID of the actor.
+        # This whole payload will be also included in the JWT session token.
+        field :actor, Models::Operations::Actor, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('actor'), required: true } }
+        # Optional parameter to specify the life duration of the actor token in seconds.
+        # By default, the duration is 1 hour.
+        field :expires_in_seconds, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expires_in_seconds') } }
+        # The maximum duration that the session which will be created by the generated actor token should last.
+        # By default, the duration of a session created via an actor token, lasts 30 minutes.
+        field :session_max_duration_in_seconds, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('session_max_duration_in_seconds') } }
+
+        
+        def initialize(user_id:, actor:, expires_in_seconds: 3600, session_max_duration_in_seconds: 1800)
+          @user_id = user_id
+          @actor = actor
+          @expires_in_seconds = expires_in_seconds
+          @session_max_duration_in_seconds = session_max_duration_in_seconds
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @user_id == other.user_id
+          return false unless @actor == other.actor
+          return false unless @expires_in_seconds == other.expires_in_seconds
+          return false unless @session_max_duration_in_seconds == other.session_max_duration_in_seconds
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/createactortoken_request.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::CreateActorTokenRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::CreateActorTokenRequest
+  def user_id(); end
+  def user_id=(str_); end
+  def actor(); end
+  def actor=(str_); end
+  def expires_in_seconds(); end
+  def expires_in_seconds=(str_); end
+  def session_max_duration_in_seconds(); end
+  def session_max_duration_in_seconds=(str_); end
+end

data/lib/clerk/models/operations/createactortoken_response.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 Operations
+
+      class CreateActorTokenResponse
+        
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # Success
+        field :actor_token, Crystalline::Nilable.new(Models::Components::ActorToken)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, actor_token: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @actor_token = actor_token
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @actor_token == other.actor_token
+          true
+        end
+      end
+    end
+  end
+end

data/lib/clerk/models/operations/createactortoken_response.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::CreateActorTokenResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::CreateActorTokenResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def actor_token(); end
+  def actor_token=(str_); end
+end

data/lib/clerk/models/operations/createallowlistidentifier_request.rb

@@ -0,0 +1,38 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class CreateAllowlistIdentifierRequest
+        
+        include Crystalline::MetadataFields
+
+        # The identifier to be added in the allow-list.
+        # This can be an email address, a phone number, or a web3 wallet.
+        field :identifier, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('identifier'), required: true } }
+        # This flag denotes whether the given identifier will receive an invitation to join the application.
+        # Note that this only works for email address and phone number identifiers.
+        field :notify, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('notify') } }
+
+        
+        def initialize(identifier:, notify: false)
+          @identifier = identifier
+          @notify = notify
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @identifier == other.identifier
+          return false unless @notify == other.notify
+          true
+        end
+      end
+    end
+  end
+end