clerk-sdk-ruby 7.0.0 → 8.0.0

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

@@ -38,9 +38,11 @@ module Clerk
         field :organization_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('organization_id') } }
         # Define the attribute name mapping between Identity Provider and Clerk's user properties
         field :attribute_mapping, Crystalline::Nilable.new(Models::Operations::CreateSAMLConnectionAttributeMapping2), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('attribute_mapping') } }
+        # Configuration for the login_hint sent to the IdP on SSO sign-in
+        field :login_hint, Crystalline::Nilable.new(Models::Operations::CreateSAMLConnectionLoginHint2), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('login_hint') } }
 
         
-        def initialize(name:, domains:, provider:, domain: nil, force_authn: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, organization_id: nil, attribute_mapping: nil)
+        def initialize(name:, domains:, provider:, domain: nil, force_authn: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, organization_id: nil, attribute_mapping: nil, login_hint: nil)
           @name = name
           @domains = domains
           @provider = provider
@@ -53,6 +55,7 @@ module Clerk
           @idp_metadata = idp_metadata
           @organization_id = organization_id
           @attribute_mapping = attribute_mapping
+          @login_hint = login_hint
         end
 
         
@@ -70,6 +73,7 @@ module Clerk
           return false unless @idp_metadata == other.idp_metadata
           return false unless @organization_id == other.organization_id
           return false unless @attribute_mapping == other.attribute_mapping
+          return false unless @login_hint == other.login_hint
           true
         end
       end

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

@@ -32,4 +32,6 @@ class Clerk::Models::Operations::CreateSAMLConnectionRequestBody2
   def organization_id=(str_); end
   def attribute_mapping(); end
   def attribute_mapping=(str_); end
+  def login_hint(); end
+  def login_hint=(str_); end
 end

data/lib/clerk/models/operations/createscimdirectory_request.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 CreateSCIMDirectoryRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the enterprise connection to associate with this SCIM directory.
+        field :enterprise_connection_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('enterprise_connection_id'), required: true } }
+        # The identity provider for this SCIM directory.
+        field :provider, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('provider'), required: true } }
+        # A human-friendly name for the SCIM directory.
+        field :name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('name') } }
+        # Optional SCIM group to organization role mappings to create with the directory.
+        field :group_role_mappings, Crystalline::Nilable.new(Crystalline::Array.new(Models::Operations::GroupRoleMapping)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('group_role_mappings') } }
+
+        
+        def initialize(enterprise_connection_id:, provider:, name: nil, group_role_mappings: nil)
+          @enterprise_connection_id = enterprise_connection_id
+          @provider = provider
+          @name = name
+          @group_role_mappings = group_role_mappings
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @enterprise_connection_id == other.enterprise_connection_id
+          return false unless @provider == other.provider
+          return false unless @name == other.name
+          return false unless @group_role_mappings == other.group_role_mappings
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::CreateSCIMDirectoryRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::CreateSCIMDirectoryRequest
+  def enterprise_connection_id(); end
+  def enterprise_connection_id=(str_); end
+  def provider(); end
+  def provider=(str_); end
+  def name(); end
+  def name=(str_); end
+  def group_role_mappings(); end
+  def group_role_mappings=(str_); end
+end

data/lib/clerk/models/operations/createscimdirectory_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 CreateSCIMDirectoryResponse
+        
+        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 SCIM directory
+        field :scim_directory, Crystalline::Nilable.new(Models::Components::SCIMDirectory)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, scim_directory: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @scim_directory = scim_directory
+        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_directory == other.scim_directory
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/createscimgrouprolemapping_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 CreateSCIMGroupRoleMappingRequest
+        
+        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::CreateSCIMGroupRoleMappingRequestBody, { '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/createscimgrouprolemapping_request.rbi

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

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

@@ -0,0 +1,42 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class CreateSCIMGroupRoleMappingRequestBody
+        
+        include Crystalline::MetadataFields
+
+        # The SCIM group ID from the identity provider.
+        field :scim_group_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('scim_group_id'), required: true } }
+        # The ID of the organization role to assign to members of the SCIM group.
+        field :role_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('role_id'), required: true } }
+        # The precedence for this mapping. Lower values take priority when a user belongs
+        # to multiple mapped groups. If omitted, the mapping is appended with the
+        # next-highest precedence.
+        field :precedence, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('precedence') } }
+
+        
+        def initialize(scim_group_id:, role_id:, precedence: nil)
+          @scim_group_id = scim_group_id
+          @role_id = role_id
+          @precedence = precedence
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @scim_group_id == other.scim_group_id
+          return false unless @role_id == other.role_id
+          return false unless @precedence == other.precedence
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::CreateSCIMGroupRoleMappingRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::CreateSCIMGroupRoleMappingRequestBody
+  def scim_group_id(); end
+  def scim_group_id=(str_); end
+  def role_id(); end
+  def role_id=(str_); end
+  def precedence(); end
+  def precedence=(str_); end
+end

data/lib/clerk/models/operations/createscimgrouprolemapping_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 CreateSCIMGroupRoleMappingResponse
+        
+        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 SCIM group role mapping
+        field :scim_group_role_mapping, Crystalline::Nilable.new(Models::Components::SCIMGroupRoleMapping)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, scim_group_role_mapping: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @scim_group_role_mapping = scim_group_role_mapping
+        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 == other.scim_group_role_mapping
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -14,13 +14,17 @@ module Clerk
 
         # The ID of the user that can use the newly created sign in token
         field :user_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('user_id'), required: true } }
+        # The ID of the organization to activate when the user signs in.
+        # Organizations must be enabled for the instance, and the user must be a member of the organization.
+        field :org_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('org_id') } }
         # Optional parameter to specify the life duration of the sign in token in seconds.
         # By default, the duration is 30 days.
         field :expires_in_seconds, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expires_in_seconds') } }
 
         
-        def initialize(user_id:, expires_in_seconds: 2_592_000)
+        def initialize(user_id:, org_id: nil, expires_in_seconds: 2_592_000)
           @user_id = user_id
+          @org_id = org_id
           @expires_in_seconds = expires_in_seconds
         end
 
@@ -28,6 +32,7 @@ module Clerk
         def ==(other)
           return false unless other.is_a? self.class
           return false unless @user_id == other.user_id
+          return false unless @org_id == other.org_id
           return false unless @expires_in_seconds == other.expires_in_seconds
           true
         end

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

@@ -10,6 +10,8 @@ end
 class Clerk::Models::Operations::CreateSignInTokenRequest
   def user_id(); end
   def user_id=(str_); end
+  def org_id(); end
+  def org_id=(str_); end
   def expires_in_seconds(); end
   def expires_in_seconds=(str_); end
 end

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

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

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

data/lib/clerk/models/operations/deletescimdirectory_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 DeleteSCIMDirectoryResponse
+        
+        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
+        # Deleted Object
+        field :deleted_object, Crystalline::Nilable.new(Models::Components::DeletedObject)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, deleted_object: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @deleted_object = deleted_object
+        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 @deleted_object == other.deleted_object
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/deletescimgrouprolemapping_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 DeleteSCIMGroupRoleMappingRequest
+        
+        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 } }
+        # The ID of the SCIM group role mapping to delete.
+        field :mapping_id, ::String, { 'path_param': { 'field_name': 'mapping_id', 'style': 'simple', 'explode': false } }
+
+        
+        def initialize(scim_directory_id:, mapping_id:)
+          @scim_directory_id = scim_directory_id
+          @mapping_id = mapping_id
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @scim_directory_id == other.scim_directory_id
+          return false unless @mapping_id == other.mapping_id
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/deletescimgrouprolemapping_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 DeleteSCIMGroupRoleMappingResponse
+        
+        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 SCIM group role mapping was deleted.
+        field :scim_group_role_mapping_deleted, Crystalline::Nilable.new(Models::Components::SCIMGroupRoleMappingDeleted)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, scim_group_role_mapping_deleted: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @scim_group_role_mapping_deleted = scim_group_role_mapping_deleted
+        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_deleted == other.scim_group_role_mapping_deleted
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -14,6 +14,11 @@ module Clerk
           MANUAL_INVITATION = new('manual_invitation')
           AUTOMATIC_INVITATION = new('automatic_invitation')
           AUTOMATIC_SUGGESTION = new('automatic_suggestion')
+          ENTERPRISE_SSO = new('enterprise_sso')
+          MINUS_MANUAL_INVITATION = new('-manual_invitation')
+          MINUS_AUTOMATIC_INVITATION = new('-automatic_invitation')
+          MINUS_AUTOMATIC_SUGGESTION = new('-automatic_suggestion')
+          MINUS_ENTERPRISE_SSO = new('-enterprise_sso')
         end
       end
     end

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

@@ -19,14 +19,14 @@ module Clerk
         # Raw HTTP response; suitable for custom response parsing
         field :raw_response, ::Faraday::Response
         # A commerce subscription item.
-        field :schemas_commerce_subscription_item, Crystalline::Nilable.new(Models::Components::SchemasCommerceSubscriptionItem)
+        field :commerce_subscription_item_2, Crystalline::Nilable.new(Models::Components::CommerceSubscriptionItem2)
 
         
-        def initialize(content_type:, status_code:, raw_response:, schemas_commerce_subscription_item: nil)
+        def initialize(content_type:, status_code:, raw_response:, commerce_subscription_item_2: nil)
           @content_type = content_type
           @status_code = status_code
           @raw_response = raw_response
-          @schemas_commerce_subscription_item = schemas_commerce_subscription_item
+          @commerce_subscription_item_2 = commerce_subscription_item_2
         end
 
         
@@ -35,7 +35,7 @@ module Clerk
           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 @schemas_commerce_subscription_item == other.schemas_commerce_subscription_item
+          return false unless @commerce_subscription_item_2 == other.commerce_subscription_item_2
           true
         end
       end

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

@@ -14,6 +14,6 @@ class Clerk::Models::Operations::ExtendBillingSubscriptionItemFreeTrialResponse
   def status_code=(str_); end
   def raw_response(); end
   def raw_response=(str_); end
-  def schemas_commerce_subscription_item(); end
-  def schemas_commerce_subscription_item=(str_); end
+  def commerce_subscription_item_2(); end
+  def commerce_subscription_item_2=(str_); end
 end