cloudinary-account-provisioning 0.1.0

data/lib/cld_provisioning/models/shared/principal.rb

@@ -0,0 +1,46 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: ed1a27e8200b
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Shared
+
+      class Principal
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The type of principal.
+        field(
+          :type,
+          Models::Shared::PrincipalTypeEnum,
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("type"),
+              required: true,
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::PrincipalTypeEnum, false)
+            }
+          }
+        )
+        # The unique identifier of the principal.
+        field :id, ::String, {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("id"), required: true}}
+
+        sig { params(type: Models::Shared::PrincipalTypeEnum, id: ::String).void }
+        def initialize(type:, id:)
+          @type = type
+          @id = id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @type == other.type
+          return false unless @id == other.id
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/shared/principal.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Shared::Principal
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Shared::Principal
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def id
+  end
+
+  def id=(str_)
+  end
+end

data/lib/cld_provisioning/models/shared/principalresponsedata.rb

@@ -0,0 +1,120 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: d88934f83aa1
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Shared
+
+      class PrincipalResponseData
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier of the principal.
+        field :id, ::String, {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("id"), required: true}}
+        # The type of principal.
+        field(
+          :type,
+          Models::Shared::PrincipalTypeEnum,
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("type"),
+              required: true,
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::PrincipalTypeEnum, false)
+            }
+          }
+        )
+
+        field(
+          :role_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("role_id")}}
+        )
+
+        field(
+          :policy_parameters,
+          Crystalline::Nilable.new(Models::Shared::PrincipalResponseDataPolicyParameters),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("policy_parameters")}}
+        )
+        # Specifies where the role/policy is applied, either at the account level or within product environments.
+        field(
+          :scope_type,
+          Crystalline::Nilable.new(Models::Shared::ScopeTypeEnum),
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("scope_type"),
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::ScopeTypeEnum, true)
+            }
+          }
+        )
+
+        field(
+          :created_at,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("created_at")}}
+        )
+
+        field(
+          :updated_at,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("updated_at")}}
+        )
+
+        field(
+          :scope_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("scope_id")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            type: Models::Shared::PrincipalTypeEnum,
+            role_id: T.nilable(::String),
+            policy_parameters: T.nilable(Models::Shared::PrincipalResponseDataPolicyParameters),
+            scope_type: T.nilable(Models::Shared::ScopeTypeEnum),
+            created_at: T.nilable(::Integer),
+            updated_at: T.nilable(::Integer),
+            scope_id: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          id:,
+          type:,
+          role_id: nil,
+          policy_parameters: nil,
+          scope_type: nil,
+          created_at: nil,
+          updated_at: nil,
+          scope_id: nil
+        )
+          @id = id
+          @type = type
+          @role_id = role_id
+          @policy_parameters = policy_parameters
+          @scope_type = scope_type
+          @created_at = created_at
+          @updated_at = updated_at
+          @scope_id = scope_id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @type == other.type
+          return false unless @role_id == other.role_id
+          return false unless @policy_parameters == other.policy_parameters
+          return false unless @scope_type == other.scope_type
+          return false unless @created_at == other.created_at
+          return false unless @updated_at == other.updated_at
+          return false unless @scope_id == other.scope_id
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/shared/principalresponsedata.rbi

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Shared::PrincipalResponseData
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Shared::PrincipalResponseData
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def role_id
+  end
+
+  def role_id=(str_)
+  end
+
+  def policy_parameters
+  end
+
+  def policy_parameters=(str_)
+  end
+
+  def scope_type
+  end
+
+  def scope_type=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def updated_at
+  end
+
+  def updated_at=(str_)
+  end
+
+  def scope_id
+  end
+
+  def scope_id=(str_)
+  end
+end

data/lib/cld_provisioning/models/shared/principalresponsedata_policy_parameters.rb

@@ -0,0 +1,26 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 2705144dd7d9
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Shared
+
+      class PrincipalResponseDataPolicyParameters
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/shared/principalresponsedata_policy_parameters.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Shared::PrincipalResponseDataPolicyParameters
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Shared::PrincipalResponseDataPolicyParameters
+end

data/lib/cld_provisioning/models/shared/principalrole.rb

@@ -0,0 +1,68 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 82d1569cc434
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Shared
+
+      class PrincipalRole
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The type of principal you want to retrieve roles or permission policies for.
+        #
+        # - user
+        #
+        # - group
+        #
+        # - apiKey
+        #
+        # - provisioningKey
+        #
+        field(
+          :principal_type,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("principal_type")}}
+        )
+        # The unique identifier of the principal.
+        field(
+          :principal_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("principal_id")}}
+        )
+        # A list of all the roles that are added to this principal.
+        field(
+          :roles,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::EffectiveRole)),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("roles")}}
+        )
+
+        sig {
+          params(
+            principal_type: T.nilable(::String),
+            principal_id: T.nilable(::String),
+            roles: T.nilable(T::Array[Models::Shared::EffectiveRole])
+          )
+            .void
+        }
+        def initialize(principal_type: nil, principal_id: nil, roles: nil)
+          @principal_type = principal_type
+          @principal_id = principal_id
+          @roles = roles
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @principal_type == other.principal_type
+          return false unless @principal_id == other.principal_id
+          return false unless @roles == other.roles
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/shared/principalrole.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Shared::PrincipalRole
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Shared::PrincipalRole
+  def principal_type
+  end
+
+  def principal_type=(str_)
+  end
+
+  def principal_id
+  end
+
+  def principal_id=(str_)
+  end
+
+  def roles
+  end
+
+  def roles=(str_)
+  end
+end

data/lib/cld_provisioning/models/shared/principalrolesdata.rb

@@ -0,0 +1,150 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 71e1d796d357
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Shared
+
+      class PrincipalRolesData
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier of the role.
+        field :id, ::String, {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("id"), required: true}}
+        # The name of the role.
+        field(
+          :name,
+          ::String,
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("name"), required: true}}
+        )
+        # Specifies whether the role's policies are managed by Cloudinary (`system`) or by the user (`custom`).
+        field(
+          :management_type,
+          Models::Shared::ManagementTypeEnum,
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("management_type"),
+              required: true,
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::ManagementTypeEnum, false)
+            }
+          }
+        )
+        # Specifies whether permissions apply globally or to specific content.
+        field(
+          :permission_type,
+          Models::Shared::PermissionTypeEnum,
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("permission_type"),
+              required: true,
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::PermissionTypeEnum, false)
+            }
+          }
+        )
+        # Specifies where the role/policy is applied, either at the account level or within product environments.
+        field(
+          :scope_type,
+          Models::Shared::ScopeTypeEnum,
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("scope_type"),
+              required: true,
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::ScopeTypeEnum, false)
+            }
+          }
+        )
+        # Creation time of the policy in epoch time.
+        field(
+          :created_at,
+          ::Integer,
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("created_at"), required: true}}
+        )
+        # Last updated time of the policy in epoch time.
+        field(
+          :updated_at,
+          ::Integer,
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("updated_at"), required: true}}
+        )
+        # A short description of the role.
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("description")}}
+        )
+        # Returned only if the scope type is product environment. Can be "all" to represent all product environments or an ID of a specific product environment.
+        field(
+          :scope_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("scope_id")}}
+        )
+        # For roles with `permission_type` set to `content`, this defines the type of content the role's policies apply to:
+        # - The content type can be: `folder_id` or `collection_id`.
+        # - When assigning the role, provide the instance, e.g. `{"folder_id":"asdfjkl12347890"}`. This specification is passed to the `policy_statement` (Cedar).
+        #
+        field(
+          :policy_parameters,
+          Crystalline::Nilable.new(Models::Shared::PolicyParameters),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("policy_parameters")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            name: ::String,
+            management_type: Models::Shared::ManagementTypeEnum,
+            permission_type: Models::Shared::PermissionTypeEnum,
+            scope_type: Models::Shared::ScopeTypeEnum,
+            created_at: ::Integer,
+            updated_at: ::Integer,
+            description: T.nilable(::String),
+            scope_id: T.nilable(::String),
+            policy_parameters: T.nilable(Models::Shared::PolicyParameters)
+          )
+            .void
+        }
+        def initialize(
+          id:,
+          name:,
+          management_type:,
+          permission_type:,
+          scope_type:,
+          created_at:,
+          updated_at:,
+          description: nil,
+          scope_id: nil,
+          policy_parameters: nil
+        )
+          @id = id
+          @name = name
+          @management_type = management_type
+          @permission_type = permission_type
+          @scope_type = scope_type
+          @created_at = created_at
+          @updated_at = updated_at
+          @description = description
+          @scope_id = scope_id
+          @policy_parameters = policy_parameters
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @name == other.name
+          return false unless @management_type == other.management_type
+          return false unless @permission_type == other.permission_type
+          return false unless @scope_type == other.scope_type
+          return false unless @created_at == other.created_at
+          return false unless @updated_at == other.updated_at
+          return false unless @description == other.description
+          return false unless @scope_id == other.scope_id
+          return false unless @policy_parameters == other.policy_parameters
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/shared/principalrolesdata.rbi

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Shared::PrincipalRolesData
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Shared::PrincipalRolesData
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def management_type
+  end
+
+  def management_type=(str_)
+  end
+
+  def permission_type
+  end
+
+  def permission_type=(str_)
+  end
+
+  def scope_type
+  end
+
+  def scope_type=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def updated_at
+  end
+
+  def updated_at=(str_)
+  end
+
+  def description
+  end
+
+  def description=(str_)
+  end
+
+  def scope_id
+  end
+
+  def scope_id=(str_)
+  end
+
+  def policy_parameters
+  end
+
+  def policy_parameters=(str_)
+  end
+end

data/lib/cld_provisioning/models/shared/principalrolesinspectdata.rb

@@ -0,0 +1,61 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: fbaaf00e69fc
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Shared
+
+      class PrincipalRolesInspectData
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The type of principal.
+        field(
+          :type,
+          Models::Shared::PrincipalTypeEnum,
+          {
+            'format_json': {
+              'letter_case': ::CldProvisioning::Utils.field_name("type"),
+              required: true,
+              'decoder': ::CldProvisioning::Utils.open_enum_from_string(Models::Shared::PrincipalTypeEnum, false)
+            }
+          }
+        )
+        # The unique identifier of the principal.
+        field :id, ::String, {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("id"), required: true}}
+
+        field(
+          :roles,
+          Crystalline::Array.new(Models::Shared::PrincipalRolesData),
+          {'format_json': {'letter_case': ::CldProvisioning::Utils.field_name("roles"), required: true}}
+        )
+
+        sig {
+          params(
+            type: Models::Shared::PrincipalTypeEnum,
+            id: ::String,
+            roles: T::Array[Models::Shared::PrincipalRolesData]
+          )
+            .void
+        }
+        def initialize(type:, id:, roles:)
+          @type = type
+          @id = id
+          @roles = roles
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @type == other.type
+          return false unless @id == other.id
+          return false unless @roles == other.roles
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/shared/principalrolesinspectdata.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Shared::PrincipalRolesInspectData
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Shared::PrincipalRolesInspectData
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def roles
+  end
+
+  def roles=(str_)
+  end
+end