clerk-sdk-ruby 7.0.0 → 8.0.1

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

@@ -0,0 +1,52 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class SCIMDirectoryCustomAttribute
+        
+        include Crystalline::MetadataFields
+
+        # Display name for the custom attribute
+        field :name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('name') } }
+        # Key used to store the attribute in the user's public/private/unsafe metadata
+        field :key, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('key') } }
+        # Path to extract the attribute value from SSO claims (SAML assertions or OIDC claims)
+        field :sso_path, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('sso_path') } }
+        # GJSON path to extract the attribute value from SCIM user resources
+        field :scim_path, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('scim_path') } }
+        # GJSON path to extract the attribute value from directory sync user resources. Same value as `scim_path`.
+        field :directory_path, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_path') } }
+        # When true, the attribute supports multiple values; values from the IdP are written to public_metadata as an array. Defaults to false.
+        field :multi_valued, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('multi_valued') } }
+
+        
+        def initialize(name: nil, key: nil, sso_path: nil, scim_path: nil, directory_path: nil, multi_valued: nil)
+          @name = name
+          @key = key
+          @sso_path = sso_path
+          @scim_path = scim_path
+          @directory_path = directory_path
+          @multi_valued = multi_valued
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @name == other.name
+          return false unless @key == other.key
+          return false unless @sso_path == other.sso_path
+          return false unless @scim_path == other.scim_path
+          return false unless @directory_path == other.directory_path
+          return false unless @multi_valued == other.multi_valued
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::SCIMDirectoryCustomAttribute
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::SCIMDirectoryCustomAttribute
+  def name(); end
+  def name=(str_); end
+  def key(); end
+  def key=(str_); end
+  def sso_path(); end
+  def sso_path=(str_); end
+  def scim_path(); end
+  def scim_path=(str_); end
+  def directory_path(); end
+  def directory_path=(str_); end
+  def multi_valued(); end
+  def multi_valued=(str_); end
+end

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,76 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # A mapping from a SCIM group to an organization role. Members of the group are assigned the role; the lowest-precedence match wins when a user belongs to multiple mapped groups.
+      class SCIMGroupRoleMapping
+        
+        include Crystalline::MetadataFields
+
+        # String representing the object's type. Always "scim_group_role_mapping".
+        field :object, Models::Components::SCIMGroupRoleMappingObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::SCIMGroupRoleMappingObject, false) } }
+        # Unique identifier for the SCIM group role mapping.
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+        # The ID of the directory this mapping belongs to.
+        field :scim_directory_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('scim_directory_id'), required: true } }
+        # The ID of the directory this mapping belongs to. Same value as `scim_directory_id`.
+        field :directory_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_id'), required: true } }
+        # 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 group ID from the identity provider. Same value as `scim_group_id`.
+        field :directory_group_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_group_id'), required: true } }
+        # The display name of the SCIM group, as reported by the identity provider.
+        field :scim_group_display_name, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('scim_group_display_name'), required: true } }
+        # The display name of the group, as reported by the identity provider. Same value as `scim_group_display_name`.
+        field :directory_group_display_name, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_group_display_name'), required: true } }
+        # Mapping precedence, starting at 1. Lower values take priority when a user belongs to multiple mapped groups.
+        field :precedence, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('precedence'), required: true } }
+        # Unix timestamp (milliseconds) of when the mapping was created.
+        field :created_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('created_at'), required: true } }
+        # Unix timestamp (milliseconds) of when the mapping was last updated.
+        field :updated_at, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('updated_at'), required: true } }
+
+        field :role, Crystalline::Nilable.new(Models::Components::Role), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('role') } }
+
+        
+        def initialize(object:, id:, scim_directory_id:, directory_id:, scim_group_id:, directory_group_id:, scim_group_display_name:, directory_group_display_name:, precedence:, created_at:, updated_at:, role: nil)
+          @object = object
+          @id = id
+          @scim_directory_id = scim_directory_id
+          @directory_id = directory_id
+          @scim_group_id = scim_group_id
+          @directory_group_id = directory_group_id
+          @scim_group_display_name = scim_group_display_name
+          @directory_group_display_name = directory_group_display_name
+          @precedence = precedence
+          @created_at = created_at
+          @updated_at = updated_at
+          @role = role
+        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 @scim_directory_id == other.scim_directory_id
+          return false unless @directory_id == other.directory_id
+          return false unless @scim_group_id == other.scim_group_id
+          return false unless @directory_group_id == other.directory_group_id
+          return false unless @scim_group_display_name == other.scim_group_display_name
+          return false unless @directory_group_display_name == other.directory_group_display_name
+          return false unless @precedence == other.precedence
+          return false unless @created_at == other.created_at
+          return false unless @updated_at == other.updated_at
+          return false unless @role == other.role
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::SCIMGroupRoleMapping
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::SCIMGroupRoleMapping
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def scim_directory_id(); end
+  def scim_directory_id=(str_); end
+  def directory_id(); end
+  def directory_id=(str_); end
+  def scim_group_id(); end
+  def scim_group_id=(str_); end
+  def directory_group_id(); end
+  def directory_group_id=(str_); end
+  def scim_group_display_name(); end
+  def scim_group_display_name=(str_); end
+  def directory_group_display_name(); end
+  def directory_group_display_name=(str_); end
+  def precedence(); end
+  def precedence=(str_); end
+  def created_at(); end
+  def created_at=(str_); end
+  def updated_at(); end
+  def updated_at=(str_); end
+  def role(); end
+  def role=(str_); end
+end

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

@@ -0,0 +1,43 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # A SCIM group role mapping was deleted.
+      class SCIMGroupRoleMappingDeleted
+        
+        include Crystalline::MetadataFields
+
+        # String representing the object's type.
+        field :object, Models::Components::SCIMGroupRoleMappingDeletedObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::SCIMGroupRoleMappingDeletedObject, false) } }
+        # The ID of the deleted SCIM group role mapping.
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+        # Whether the SCIM group role mapping was successfully deleted.
+        field :deleted, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('deleted'), required: true } }
+
+        
+        def initialize(object:, id:, deleted: true)
+          @object = object
+          @id = id
+          unless deleted == true
+            raise ArgumentError, 'Invalid value for deleted'
+          end
+          @deleted = true
+        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 @deleted == other.deleted
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::SCIMGroupRoleMappingDeleted
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::SCIMGroupRoleMappingDeleted
+  def object(); end
+  def object=(str_); end
+  def id(); end
+  def id=(str_); end
+  def deleted(); end
+  def deleted=(str_); end
+end

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

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

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

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

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

@@ -0,0 +1,36 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # A list of SCIM group role mappings, ordered by precedence.
+      class SCIMGroupRoleMappingList
+        
+        include Crystalline::MetadataFields
+
+
+        field :data, Crystalline::Array.new(Models::Components::SCIMGroupRoleMapping), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('data'), required: true } }
+        # Total number of SCIM group role mappings in the directory.
+        field :total_count, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('total_count'), required: true } }
+
+        
+        def initialize(data:, total_count:)
+          @data = data
+          @total_count = total_count
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @data == other.data
+          return false unless @total_count == other.total_count
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,64 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # Metadata describing a user's linkage to a directory. Included in user responses when directory data is requested, and in directory-triggered user webhooks. Its absence does not necessarily mean the user is not managed by a directory.
+      #
+      class SCIMUserMetadata
+        
+        include Crystalline::MetadataFields
+
+        # The user's resource ID in this directory.
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+
+        field :directory_name, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_name'), required: true } }
+
+        field :provider, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('provider'), required: true } }
+        # The ID of the directory the user is provisioned from.
+        #
+        field :directory_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_id'), required: true } }
+        # Whether the directory is currently enabled.
+        #
+        field :directory_enabled, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('directory_enabled'), required: true } }
+
+        field :enterprise_connection_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('enterprise_connection_id'), required: true } }
+        # Omitted when groups were not loaded; an empty array means no group memberships.
+        field :groups, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::SCIMUserMetadataGroup)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('groups') } }
+        # The user's external ID as reported by the directory, if any.
+        #
+        field :external_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('external_id'), required: true } }
+
+        
+        def initialize(id:, directory_name:, provider:, directory_id:, directory_enabled:, enterprise_connection_id: nil, groups: nil, external_id: nil)
+          @id = id
+          @directory_name = directory_name
+          @provider = provider
+          @directory_id = directory_id
+          @directory_enabled = directory_enabled
+          @enterprise_connection_id = enterprise_connection_id
+          @groups = groups
+          @external_id = external_id
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @id == other.id
+          return false unless @directory_name == other.directory_name
+          return false unless @provider == other.provider
+          return false unless @directory_id == other.directory_id
+          return false unless @directory_enabled == other.directory_enabled
+          return false unless @enterprise_connection_id == other.enterprise_connection_id
+          return false unless @groups == other.groups
+          return false unless @external_id == other.external_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# typed: false
+# frozen_string_literal: true
+
+
+class Clerk::Models::Components::SCIMUserMetadata
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Clerk::Models::Components::SCIMUserMetadata
+  def id(); end
+  def id=(str_); end
+  def directory_name(); end
+  def directory_name=(str_); end
+  def provider(); end
+  def provider=(str_); end
+  def directory_id(); end
+  def directory_id=(str_); end
+  def directory_enabled(); end
+  def directory_enabled=(str_); end
+  def enterprise_connection_id(); end
+  def enterprise_connection_id=(str_); end
+  def groups(); end
+  def groups=(str_); end
+  def external_id(); end
+  def external_id=(str_); end
+end

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

@@ -0,0 +1,36 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+
+      class SCIMUserMetadataGroup
+        
+        include Crystalline::MetadataFields
+
+
+        field :id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('id'), required: true } }
+
+        field :display_name, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('display_name'), required: true } }
+
+        
+        def initialize(id:, display_name:)
+          @id = id
+          @display_name = display_name
+        end
+
+        
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @id == other.id
+          return false unless @display_name == other.display_name
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -15,7 +15,7 @@ module Clerk
         # Seat quantity being billed; null means unlimited
         field :quantity, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('quantity'), required: true } }
         # Per-unit cost breakdown by pricing tier
-        field :tiers, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::SchemasCommercePerUnitTotalTier)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('tiers') } }
+        field :tiers, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::CommercePerUnitTotalTier2)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('tiers') } }
 
         
         def initialize(quantity: nil, tiers: nil)

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

@@ -0,0 +1,21 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: false
+# frozen_string_literal: true
+
+
+module Clerk
+  module Models
+    module Components
+      # Source - How the discount was applied to the subscription item.
+      class Source
+        include ::Crystalline::Enum
+        enums do
+          PROMOTION = new('promotion')
+          MANUAL = new('manual')
+          PROMO_CODE = new('promo_code')
+        end
+      end
+    end
+  end
+end

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

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