clerk-sdk-ruby 7.0.0 → 8.0.0

data/lib/clerk/models/operations/removeuserpassword_requestbody.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 RemoveUserPasswordRequestBody
+        
+        include Crystalline::MetadataFields
+
+        # Set to `true` to revoke all of the user's active sessions after removing the password.
+        field :sign_out_of_other_sessions, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('sign_out_of_other_sessions') } }
+
+        
+        def initialize(sign_out_of_other_sessions: false)
+          @sign_out_of_other_sessions = sign_out_of_other_sessions
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @sign_out_of_other_sessions == other.sign_out_of_other_sessions
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/removeuserpassword_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 RemoveUserPasswordResponse
+        
+        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/removeuserpassword_response.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::RemoveUserPasswordResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::RemoveUserPasswordResponse
+  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/replacescimgrouprolemappings_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 ReplaceSCIMGroupRoleMappingsRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the SCIM directory.
+        field :scim_directory_id, ::String, { 'path_param': { 'field_name': 'scim_directory_id', 'style': 'simple', 'explode': false } }
+
+        field :body, Models::Operations::ReplaceSCIMGroupRoleMappingsRequestBody, { 'request': { 'media_type': 'application/json' } }
+
+        
+        def initialize(scim_directory_id:, body:)
+          @scim_directory_id = scim_directory_id
+          @body = body
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @scim_directory_id == other.scim_directory_id
+          return false unless @body == other.body
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/replacescimgrouprolemappings_requestbody.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 ReplaceSCIMGroupRoleMappingsRequestBody
+        
+        include Crystalline::MetadataFields
+
+        # The desired set of mappings. Array order sets precedence (1-indexed). An empty array clears all mappings.
+        field :mappings, Crystalline::Array.new(Models::Operations::Mapping), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('mappings'), required: true } }
+
+        
+        def initialize(mappings:)
+          @mappings = mappings
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @mappings == other.mappings
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/replacescimgrouprolemappings_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 ReplaceSCIMGroupRoleMappingsResponse
+        
+        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 list of SCIM group role mappings, ordered by precedence.
+        field :scim_group_role_mapping_list, Crystalline::Nilable.new(Models::Components::SCIMGroupRoleMappingList)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, scim_group_role_mapping_list: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @scim_group_role_mapping_list = scim_group_role_mapping_list
+        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 @scim_group_role_mapping_list == other.scim_group_role_mapping_list
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::ReplaceSCIMGroupRoleMappingsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::ReplaceSCIMGroupRoleMappingsResponse
+  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 scim_group_role_mapping_list(); end
+  def scim_group_role_mapping_list=(str_); end
+end

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

@@ -8,13 +8,21 @@ module Clerk
   module Models
     module Operations
       # ReplaceUserEmailAddressIdentificationStatus - Controls the status of the replacement email address. Defaults to `verified`. Set to
-      # `reserved` to create it reserved (unverified but usable for sign-in and locked)
-      # instead of verified.
+      # `reserved` to create it reserved (unverified but usable for sign-in and locked so no
+      # other user can claim it), or to `unverified` to create it neither usable for sign-in
+      # nor locked.
+      #
+      # **Warning:** `unverified` can lock the user out of their account. An unverified email
+      # address cannot be used to sign in, so if the user has no other verified or reserved
+      # identifier, they will be unable to authenticate and unable to verify this address.
+      # Prefer `reserved` unless you specifically need the address left unclaimed — for
+      # example so that another user can also hold it until one of them verifies it.
       class ReplaceUserEmailAddressIdentificationStatus
         include ::Crystalline::Enum
         enums do
           VERIFIED = new('verified')
           RESERVED = new('reserved')
+          UNVERIFIED = new('unverified')
         end
       end
     end

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

@@ -15,14 +15,26 @@ module Clerk
         # The new email address. Must adhere to the RFC 5322 specification for email address format.
         field :email_address, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('email_address'), required: true } }
         # Controls the status of the replacement email address. Defaults to `verified`. Set to
-        # `reserved` to create it reserved (unverified but usable for sign-in and locked)
-        # instead of verified.
+        # `reserved` to create it reserved (unverified but usable for sign-in and locked so no
+        # other user can claim it), or to `unverified` to create it neither usable for sign-in
+        # nor locked.
+        #
+        # **Warning:** `unverified` can lock the user out of their account. An unverified email
+        # address cannot be used to sign in, so if the user has no other verified or reserved
+        # identifier, they will be unable to authenticate and unable to verify this address.
+        # Prefer `reserved` unless you specifically need the address left unclaimed — for
+        # example so that another user can also hold it until one of them verifies it.
         field :identification_status, Crystalline::Nilable.new(Models::Operations::ReplaceUserEmailAddressIdentificationStatus), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('identification_status'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Operations::ReplaceUserEmailAddressIdentificationStatus, true) } }
+        # If set to `true`, the user's previous primary email address is notified that the
+        # primary email address has changed. No notification is sent when the replacement
+        # is the user's current primary email address. By default, no notification is sent.
+        field :notify_primary_email_address_changed, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('notify_primary_email_address_changed') } }
 
         
-        def initialize(email_address:, identification_status: Models::Operations::ReplaceUserEmailAddressIdentificationStatus::VERIFIED)
+        def initialize(email_address:, identification_status: Models::Operations::ReplaceUserEmailAddressIdentificationStatus::VERIFIED, notify_primary_email_address_changed: false)
           @email_address = email_address
           @identification_status = identification_status
+          @notify_primary_email_address_changed = notify_primary_email_address_changed
         end
 
         
@@ -30,6 +42,7 @@ module Clerk
           return false unless other.is_a? self.class
           return false unless @email_address == other.email_address
           return false unless @identification_status == other.identification_status
+          return false unless @notify_primary_email_address_changed == other.notify_primary_email_address_changed
           true
         end
       end

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

@@ -12,4 +12,6 @@ class Clerk::Models::Operations::ReplaceUserEmailAddressRequestBody
   def email_address=(str_); end
   def identification_status(); end
   def identification_status=(str_); end
+  def notify_primary_email_address_changed(); end
+  def notify_primary_email_address_changed=(str_); end
 end

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

@@ -8,13 +8,21 @@ module Clerk
   module Models
     module Operations
       # ReplaceUserPhoneNumberIdentificationStatus - Controls the status of the replacement phone number. Defaults to `verified`. Set to
-      # `reserved` to create it reserved (unverified but usable for sign-in and locked)
-      # instead of verified.
+      # `reserved` to create it reserved (unverified but usable for sign-in and locked so no
+      # other user can claim it), or to `unverified` to create it neither usable for sign-in
+      # nor locked.
+      #
+      # **Warning:** `unverified` can lock the user out of their account. An unverified phone
+      # number cannot be used to sign in, so if the user has no other verified or reserved
+      # identifier, they will be unable to authenticate and unable to verify this number.
+      # Prefer `reserved` unless you specifically need the number left unclaimed — for
+      # example so that another user can also hold it until one of them verifies it.
       class ReplaceUserPhoneNumberIdentificationStatus
         include ::Crystalline::Enum
         enums do
           VERIFIED = new('verified')
           RESERVED = new('reserved')
+          UNVERIFIED = new('unverified')
         end
       end
     end

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

@@ -15,8 +15,15 @@ module Clerk
         # The new phone number. Must adhere to the E.164 standard for phone number format.
         field :phone_number, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('phone_number'), required: true } }
         # Controls the status of the replacement phone number. Defaults to `verified`. Set to
-        # `reserved` to create it reserved (unverified but usable for sign-in and locked)
-        # instead of verified.
+        # `reserved` to create it reserved (unverified but usable for sign-in and locked so no
+        # other user can claim it), or to `unverified` to create it neither usable for sign-in
+        # nor locked.
+        #
+        # **Warning:** `unverified` can lock the user out of their account. An unverified phone
+        # number cannot be used to sign in, so if the user has no other verified or reserved
+        # identifier, they will be unable to authenticate and unable to verify this number.
+        # Prefer `reserved` unless you specifically need the number left unclaimed — for
+        # example so that another user can also hold it until one of them verifies it.
         field :identification_status, Crystalline::Nilable.new(Models::Operations::ReplaceUserPhoneNumberIdentificationStatus), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('identification_status'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Operations::ReplaceUserPhoneNumberIdentificationStatus, true) } }
 
         

data/lib/clerk/models/operations/revokeoauthapplicationtoken_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 RevokeOAuthApplicationTokenRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the OAuth application for which to revoke the token
+        field :oauth_application_id, ::String, { 'path_param': { 'field_name': 'oauth_application_id', 'style': 'simple', 'explode': false } }
+
+        field :body, Models::Operations::RevokeOAuthApplicationTokenRequestBody, { 'request': { 'media_type': 'application/json' } }
+
+        
+        def initialize(oauth_application_id:, body:)
+          @oauth_application_id = oauth_application_id
+          @body = body
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @oauth_application_id == other.oauth_application_id
+          return false unless @body == other.body
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/revokeoauthapplicationtoken_requestbody.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 RevokeOAuthApplicationTokenRequestBody
+        
+        include Crystalline::MetadataFields
+
+        # The opaque OAuth access token or refresh token to revoke. All tokens associated with the same OAuth grant are also revoked.
+        field :token, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('token'), required: true } }
+
+        
+        def initialize(token:)
+          @token = token
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @token == other.token
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/revokeoauthapplicationtoken_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 RevokeOAuthApplicationTokenResponse
+        
+        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/revokeoauthapplicationtoken_response.rbi

@@ -0,0 +1,17 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::RevokeOAuthApplicationTokenResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::RevokeOAuthApplicationTokenResponse
+  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/revokeusertrusteddevice_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 RevokeUserTrustedDeviceRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the user that owns the trusted device
+        field :user_id, ::String, { 'path_param': { 'field_name': 'user_id', 'style': 'simple', 'explode': false } }
+        # The ID of the trusted device to revoke
+        field :trusted_device_id, ::String, { 'path_param': { 'field_name': 'trusted_device_id', 'style': 'simple', 'explode': false } }
+
+        
+        def initialize(user_id:, trusted_device_id:)
+          @user_id = user_id
+          @trusted_device_id = trusted_device_id
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @user_id == other.user_id
+          return false unless @trusted_device_id == other.trusted_device_id
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/revokeusertrusteddevice_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 RevokeUserTrustedDeviceResponse
+        
+        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 :trusted_device, Crystalline::Nilable.new(Models::Components::TrustedDevice)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, trusted_device: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @trusted_device = trusted_device
+        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 @trusted_device == other.trusted_device
+          true
+        end
+      end
+    end
+  end
+end