cloudinary-account-provisioning 0.1.0

data/lib/cld_provisioning/models/operations/getroleprincipals_request.rb

@@ -0,0 +1,135 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 065ede6988a0
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetRolePrincipalsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A unique identifier for the role.
+        field :role_id, ::String, {'path_param': {'field_name': "role_id", 'style': "simple", 'explode': false}}
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+        # Specifies the level for retrieving policies or roles, either at the account level or within product environments.
+        field(
+          :scope_type,
+          Crystalline::Nilable.new(Models::Shared::ScopeTypeEnum),
+          {'query_param': {'field_name': "scope_type", 'style': "form", 'explode': true}}
+        )
+        # The ID of a specific product environment where the policy is applied. This parameter is only relevant if `scope_type` is "prodenv".
+        # - <product_environment_id>
+        #
+        field(
+          :scope_id,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "scope_id", 'style': "form", 'explode': true}}
+        )
+        # Determines whether the response contains all the parameters described below (`true`), or only `id` and `principal_type` (`false`). *Default:* `false`
+        field(
+          :verbose,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'query_param': {'field_name': "verbose", 'style': "form", 'explode': true}}
+        )
+        # * In the **Get role** endpoint, the specified `folder_id` is included in the `policy_statement` parameter of the response. If no `folder_id` is specified, the `policy_statement` shows a placeholder for the `folder_id` where relevant.
+        # * In the **Get a principal's roles**, **Get a role's principals**, and **Inspect** endpoints, the results are filtered by the specified `folder_id`. Only roles or principals with `policy_statement` parameters associated with that `folder_id` are returned.
+        #
+        field(
+          :folder_id,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "folder_id", 'style': "form", 'explode': true}}
+        )
+        # Not currently supported.
+        field(
+          :asset_id,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "asset_id", 'style': "form", 'explode': true}}
+        )
+        # * In the **Get role** endpoint, the specified `collection_id` is included in the `policy_statement` parameter of the response. If no `collection_id` is specified, the `policy_statement` shows a placeholder for the `collection_id` where relevant.
+        # * In the **Get a principal's roles** and **Get a role's principals** endpoints, the results are filtered by the specified `collection_id`. Only roles or principals with `policy_statement` parameters associated with that `collection_id` are returned.
+        #
+        field(
+          :collection_id,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "collection_id", 'style': "form", 'explode': true}}
+        )
+        # The type of content instance the role applies to, either `folder_id` or `collection_id`. Use together with `param_value` to retrieve role assignments as they apply to a specific instance.
+        field(
+          :param_key,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'query_param': {'field_name': "param_key", 'style': "form", 'explode': true}}
+        )
+        # The ID of the content instance (for example, a specific folder or collection). Use together with param_key to retrieve roles as they apply to a specific instance.
+        field(
+          :param_value,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'query_param': {'field_name': "param_value", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(
+            role_id: ::String,
+            account_id: T.nilable(::String),
+            scope_type: T.nilable(Models::Shared::ScopeTypeEnum),
+            scope_id: T.nilable(::String),
+            verbose: T.nilable(T::Boolean),
+            folder_id: T.nilable(::String),
+            asset_id: T.nilable(::String),
+            collection_id: T.nilable(::String),
+            param_key: T.nilable(T::Array[::String]),
+            param_value: T.nilable(T::Array[::String])
+          )
+            .void
+        }
+        def initialize(
+          role_id:,
+          account_id: nil,
+          scope_type: nil,
+          scope_id: nil,
+          verbose: nil,
+          folder_id: nil,
+          asset_id: nil,
+          collection_id: nil,
+          param_key: nil,
+          param_value: nil
+        )
+          @role_id = role_id
+          @account_id = account_id
+          @scope_type = scope_type
+          @scope_id = scope_id
+          @verbose = verbose
+          @folder_id = folder_id
+          @asset_id = asset_id
+          @collection_id = collection_id
+          @param_key = param_key
+          @param_value = param_value
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @role_id == other.role_id
+          return false unless @account_id == other.account_id
+          return false unless @scope_type == other.scope_type
+          return false unless @scope_id == other.scope_id
+          return false unless @verbose == other.verbose
+          return false unless @folder_id == other.folder_id
+          return false unless @asset_id == other.asset_id
+          return false unless @collection_id == other.collection_id
+          return false unless @param_key == other.param_key
+          return false unless @param_value == other.param_value
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getroleprincipals_request.rbi

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetRolePrincipalsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetRolePrincipalsRequest
+  def role_id
+  end
+
+  def role_id=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def scope_type
+  end
+
+  def scope_type=(str_)
+  end
+
+  def scope_id
+  end
+
+  def scope_id=(str_)
+  end
+
+  def verbose
+  end
+
+  def verbose=(str_)
+  end
+
+  def folder_id
+  end
+
+  def folder_id=(str_)
+  end
+
+  def asset_id
+  end
+
+  def asset_id=(str_)
+  end
+
+  def collection_id
+  end
+
+  def collection_id=(str_)
+  end
+
+  def param_key
+  end
+
+  def param_key=(str_)
+  end
+
+  def param_value
+  end
+
+  def param_value=(str_)
+  end
+end

data/lib/cld_provisioning/models/operations/getroles_request.rb

@@ -0,0 +1,80 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 7e7edc34c4b8
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetRolesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Specifies whether to retrieve roles whose permissions apply globally across all contexts within the scope (i.e., security settings for the account, or all folders in a product environment), or specifically to designated content instances (i.e., folder with external ID "fg3841spr").
+        field(
+          :permission_type,
+          Models::Shared::PermissionTypeEnum,
+          {'query_param': {'field_name': "permission_type", 'style': "form", 'explode': true}}
+        )
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+        # Specifies the level for retrieving policies or roles, either at the account level or within product environments.
+        field(
+          :scope_type,
+          Crystalline::Nilable.new(Models::Shared::ScopeTypeEnum),
+          {'query_param': {'field_name': "scope_type", 'style': "form", 'explode': true}}
+        )
+        # Specifies whether the role's policies are managed by Cloudinary (`system`) or by the user (`custom`).
+        field(
+          :management_type,
+          Crystalline::Nilable.new(Models::Shared::ManagementTypeEnum),
+          {'query_param': {'field_name': "management_type", 'style': "form", 'explode': true}}
+        )
+        # 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(Crystalline::Array.new(::String)),
+          {'query_param': {'field_name': "policy_parameters", 'serialization': "json"}}
+        )
+
+        sig {
+          params(
+            permission_type: Models::Shared::PermissionTypeEnum,
+            account_id: T.nilable(::String),
+            scope_type: T.nilable(Models::Shared::ScopeTypeEnum),
+            management_type: T.nilable(Models::Shared::ManagementTypeEnum),
+            policy_parameters: T.nilable(T::Array[::String])
+          )
+            .void
+        }
+        def initialize(permission_type:, account_id: nil, scope_type: nil, management_type: nil, policy_parameters: nil)
+          @permission_type = permission_type
+          @account_id = account_id
+          @scope_type = scope_type
+          @management_type = management_type
+          @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 @permission_type == other.permission_type
+          return false unless @account_id == other.account_id
+          return false unless @scope_type == other.scope_type
+          return false unless @management_type == other.management_type
+          return false unless @policy_parameters == other.policy_parameters
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getroles_request.rbi

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetRolesRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetRolesRequest
+  def permission_type
+  end
+
+  def permission_type=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def scope_type
+  end
+
+  def scope_type=(str_)
+  end
+
+  def management_type
+  end
+
+  def management_type=(str_)
+  end
+
+  def policy_parameters
+  end
+
+  def policy_parameters=(str_)
+  end
+end

data/lib/cld_provisioning/models/operations/getsubaccountsforuser_request.rb

@@ -0,0 +1,40 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 3ac3632068b2
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetSubAccountsForUserRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The ID of the user.
+        field :user_id, ::String, {'path_param': {'field_name': "user_id", 'style': "simple", 'explode': false}}
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+
+        sig { params(user_id: ::String, account_id: T.nilable(::String)).void }
+        def initialize(user_id:, account_id: nil)
+          @user_id = user_id
+          @account_id = account_id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @user_id == other.user_id
+          return false unless @account_id == other.account_id
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getsubaccountsforuser_request.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetSubAccountsForUserRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetSubAccountsForUserRequest
+  def user_id
+  end
+
+  def user_id=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+end

data/lib/cld_provisioning/models/operations/getsystempolicies_request.rb

@@ -0,0 +1,59 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 60a9cd274416
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetSystemPoliciesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+        # Specifies whether to retrieve roles whose permissions apply globally across all contexts within the scope (i.e., security settings for the account, or all folders in a product environment), or specifically to designated content instances (i.e., folder with external ID "fg3841spr").
+        field(
+          :permission_type,
+          Crystalline::Nilable.new(Models::Shared::PermissionTypeEnum),
+          {'query_param': {'field_name': "permission_type", 'style': "form", 'explode': true}}
+        )
+        # Specifies the level for retrieving policies or roles, either at the account level or within product environments.
+        field(
+          :scope_type,
+          Crystalline::Nilable.new(Models::Shared::ScopeTypeEnum),
+          {'query_param': {'field_name': "scope_type", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(
+            account_id: T.nilable(::String),
+            permission_type: T.nilable(Models::Shared::PermissionTypeEnum),
+            scope_type: T.nilable(Models::Shared::ScopeTypeEnum)
+          )
+            .void
+        }
+        def initialize(account_id: nil, permission_type: nil, scope_type: nil)
+          @account_id = account_id
+          @permission_type = permission_type
+          @scope_type = scope_type
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @account_id == other.account_id
+          return false unless @permission_type == other.permission_type
+          return false unless @scope_type == other.scope_type
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getsystempolicies_request.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetSystemPoliciesRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetSystemPoliciesRequest
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def permission_type
+  end
+
+  def permission_type=(str_)
+  end
+
+  def scope_type
+  end
+
+  def scope_type=(str_)
+  end
+end

data/lib/cld_provisioning/models/operations/getuser_request.rb

@@ -0,0 +1,40 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 920269b97a18
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetUserRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The ID of the user.
+        field :user_id, ::String, {'path_param': {'field_name': "user_id", 'style': "simple", 'explode': false}}
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+
+        sig { params(user_id: ::String, account_id: T.nilable(::String)).void }
+        def initialize(user_id:, account_id: nil)
+          @user_id = user_id
+          @account_id = account_id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @user_id == other.user_id
+          return false unless @account_id == other.account_id
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getuser_request.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetUserRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetUserRequest
+  def user_id
+  end
+
+  def user_id=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+end

data/lib/cld_provisioning/models/operations/getusergroup_request.rb

@@ -0,0 +1,52 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 2b75ec496754
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetUserGroupRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The ID of the user group.
+        field :group_id, ::String, {'path_param': {'field_name': "group_id", 'style': "simple", 'explode': false}}
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+        # Whether to only return extended (true) or basic information about the group (false).
+        # **Default**: false.
+        #
+        field(
+          :extended_details,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'query_param': {'field_name': "extended_details", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(group_id: ::String, account_id: T.nilable(::String), extended_details: T.nilable(T::Boolean)).void
+        }
+        def initialize(group_id:, account_id: nil, extended_details: nil)
+          @group_id = group_id
+          @account_id = account_id
+          @extended_details = extended_details
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @group_id == other.group_id
+          return false unless @account_id == other.account_id
+          return false unless @extended_details == other.extended_details
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getusergroup_request.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetUserGroupRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetUserGroupRequest
+  def group_id
+  end
+
+  def group_id=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def extended_details
+  end
+
+  def extended_details=(str_)
+  end
+end

data/lib/cld_provisioning/models/operations/getusergroups_request.rb

@@ -0,0 +1,46 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+# @generated-id: 76645a74cd9b
+
+# typed: true
+# frozen_string_literal: true
+
+module CldProvisioning
+  module Models
+    module Operations
+
+      class GetUserGroupsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Account ID
+        field(
+          :account_id,
+          Crystalline::Nilable.new(::String),
+          {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+        )
+        # Whether to only return extended (true) or basic information about the group (false).
+        # **Default**: false.
+        #
+        field(
+          :extended_details,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'query_param': {'field_name': "extended_details", 'style': "form", 'explode': true}}
+        )
+
+        sig { params(account_id: T.nilable(::String), extended_details: T.nilable(T::Boolean)).void }
+        def initialize(account_id: nil, extended_details: nil)
+          @account_id = account_id
+          @extended_details = extended_details
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @account_id == other.account_id
+          return false unless @extended_details == other.extended_details
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cld_provisioning/models/operations/getusergroups_request.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class CldProvisioning::Models::Operations::GetUserGroupsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class CldProvisioning::Models::Operations::GetUserGroupsRequest
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def extended_details
+  end
+
+  def extended_details=(str_)
+  end
+end