clerk-sdk-ruby 8.0.0 → 8.0.1

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

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

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

data/lib/clerk/models/operations/deletedirectory_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 DeleteDirectoryResponse
+        
+        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/deletedirectory_response.rbi

@@ -0,0 +1,19 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Operations::DeleteDirectoryResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Operations::DeleteDirectoryResponse
+  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/deletedirectorygrouprolemapping_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 DeleteDirectoryGroupRoleMappingRequest
+        
+        include Crystalline::MetadataFields
+
+        # The ID of the directory.
+        field :directory_id, ::String, { 'path_param': { 'field_name': 'directory_id', 'style': 'simple', 'explode': false } }
+        # The ID of the directory group role mapping to delete.
+        field :mapping_id, ::String, { 'path_param': { 'field_name': 'mapping_id', 'style': 'simple', 'explode': false } }
+
+        
+        def initialize(directory_id:, mapping_id:)
+          @directory_id = directory_id
+          @mapping_id = mapping_id
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @directory_id == other.directory_id
+          return false unless @mapping_id == other.mapping_id
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/deletedirectorygrouprolemapping_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 DeleteDirectoryGroupRoleMappingResponse
+        
+        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 directory group role mapping was deleted.
+        field :directory_group_role_mapping_deleted, Crystalline::Nilable.new(Models::Components::DirectoryGroupRoleMappingDeleted)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, directory_group_role_mapping_deleted: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @directory_group_role_mapping_deleted = directory_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 @directory_group_role_mapping_deleted == other.directory_group_role_mapping_deleted
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -12,7 +12,7 @@ module Clerk
         
         include Crystalline::MetadataFields
 
-        # The ID of the domain that will be deleted. Must be a satellite domain.
+        # The ID of the domain that will be deleted.
         field :domain_id, ::String, { 'path_param': { 'field_name': 'domain_id', 'style': 'simple', 'explode': false } }
 
         

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

@@ -12,7 +12,7 @@ module Clerk
         
         include Crystalline::MetadataFields
 
-        # The ID of the SCIM directory to delete
+        # The ID of the directory to delete
         field :scim_directory_id, ::String, { 'path_param': { 'field_name': 'scim_directory_id', 'style': 'simple', 'explode': false } }
 
         

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

@@ -12,7 +12,7 @@ module Clerk
         
         include Crystalline::MetadataFields
 
-        # The ID of the SCIM directory.
+        # The ID of the 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 } }

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -12,7 +12,7 @@ module Clerk
         
         include Crystalline::MetadataFields
 
-        # The ID of the SCIM directory to retrieve
+        # The ID of the directory to retrieve
         field :scim_directory_id, ::String, { 'path_param': { 'field_name': 'scim_directory_id', 'style': 'simple', 'explode': false } }
 
         

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

@@ -18,7 +18,7 @@ module Clerk
         field :status_code, ::Integer
         # Raw HTTP response; suitable for custom response parsing
         field :raw_response, ::Faraday::Response
-        # A SCIM directory
+        # A directory
         field :scim_directory, Crystalline::Nilable.new(Models::Components::SCIMDirectory)
 
         

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

@@ -103,6 +103,15 @@ module Clerk
         # Accepts up to 100 provider user IDs.
         # Any provider user IDs not found are ignored.
         field :provider_user_id, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'query_param': { 'field_name': 'provider_user_id', 'style': 'form', 'explode': true } }
+        # A cursor for pagination: the `id` of the last user on the previous page. Returns the users that follow it.
+        #
+        # **Requires ordering by `created_at`** — that is, `order_by` omitted, or set to `created_at`, `+created_at`
+        # or `-created_at`. Any other `order_by` value is rejected with a 422: the other orderings sort by a value
+        # that is neither unique per user nor immutable, so a cursor over them would skip or repeat users.
+        #
+        # Cannot be combined with a non-zero `offset`, which is also a 422. Keep every other parameter identical
+        # across requests, and stop when a page returns fewer than `limit` users.
+        field :starting_after, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'starting_after', 'style': 'form', 'explode': true } }
         # Applies a limit to the number of results returned.
         # Can be used for paginating the results together with `offset`.
         field :limit, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
@@ -116,10 +125,11 @@ module Clerk
         # For example, if you want users to be returned in descending order according to their `created_at` property, you can use `-created_at`.
         # If you don't use `+` or `-`, then `+` is implied. We only support one `order_by` parameter, and if multiple `order_by` parameters are provided, we will only keep the first one. For example,
         # if you pass `order_by=username&order_by=created_at`, we will consider only the first `order_by` parameter, which is `username`. The `created_at` parameter will be ignored in this case.
+        # Only the `created_at` orderings can be combined with `starting_after` cursor pagination; see that parameter.
         field :order_by, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'order_by', 'style': 'form', 'explode': true } }
 
         
-        def initialize(email_address: nil, phone_number: nil, external_id: nil, username: nil, web3_wallet: nil, user_id: nil, organization_id: nil, query: nil, email_address_query: nil, phone_number_query: nil, username_query: nil, name_query: nil, banned: nil, last_active_at_before: nil, last_active_at_after: nil, last_active_at_since: nil, created_at_before: nil, created_at_after: nil, last_sign_in_at_before: nil, last_sign_in_at_after: nil, provider: nil, provider_user_id: nil, limit: 10, offset: 0, order_by: '-created_at')
+        def initialize(email_address: nil, phone_number: nil, external_id: nil, username: nil, web3_wallet: nil, user_id: nil, organization_id: nil, query: nil, email_address_query: nil, phone_number_query: nil, username_query: nil, name_query: nil, banned: nil, last_active_at_before: nil, last_active_at_after: nil, last_active_at_since: nil, created_at_before: nil, created_at_after: nil, last_sign_in_at_before: nil, last_sign_in_at_after: nil, provider: nil, provider_user_id: nil, starting_after: nil, limit: 10, offset: 0, order_by: '-created_at')
           @email_address = email_address
           @phone_number = phone_number
           @external_id = external_id
@@ -142,6 +152,7 @@ module Clerk
           @last_sign_in_at_after = last_sign_in_at_after
           @provider = provider
           @provider_user_id = provider_user_id
+          @starting_after = starting_after
           @limit = limit
           @offset = offset
           @order_by = order_by
@@ -172,6 +183,7 @@ module Clerk
           return false unless @last_sign_in_at_after == other.last_sign_in_at_after
           return false unless @provider == other.provider
           return false unless @provider_user_id == other.provider_user_id
+          return false unless @starting_after == other.starting_after
           return false unless @limit == other.limit
           return false unless @offset == other.offset
           return false unless @order_by == other.order_by

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

@@ -52,6 +52,8 @@ class Clerk::Models::Operations::GetUserListRequest
   def provider=(str_); end
   def provider_user_id(); end
   def provider_user_id=(str_); end
+  def starting_after(); end
+  def starting_after=(str_); end
   def limit(); end
   def limit=(str_); end
   def offset(); end

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

@@ -0,0 +1,39 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Operations
+
+      class ListDirectoriesRequest
+        
+        include Crystalline::MetadataFields
+
+        # Applies a limit to the number of results returned.
+        # Can be used for paginating the results together with `offset`.
+        field :limit, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
+        # Skip the first `offset` results when paginating.
+        # Needs to be an integer greater or equal to zero.
+        # To be used in conjunction with `limit`.
+        field :offset, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'offset', 'style': 'form', 'explode': true } }
+
+        
+        def initialize(limit: 10, offset: 0)
+          @limit = limit
+          @offset = offset
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @limit == other.limit
+          return false unless @offset == other.offset
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/clerk/models/operations/listdirectories_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 ListDirectoriesResponse
+        
+        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 directories
+        field :directory_list, Crystalline::Nilable.new(Models::Components::DirectoryList)
+
+        
+        def initialize(content_type:, status_code:, raw_response:, directory_list: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @directory_list = directory_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 @directory_list == other.directory_list
+          true
+        end
+      end
+    end
+  end
+end