sentdm 0.0.3 → 0.2.0

data/lib/sentdm/resources/organizations/users.rb

@@ -1,150 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Resources
-    class Organizations
-      class Users
-        # Retrieves a specific user by their ID. Requires appropriate permissions. The
-        # customerId can be either an organization ID or a profile ID.
-        #
-        # @overload retrieve(user_id, customer_id:, request_options: {})
-        #
-        # @param user_id [String]
-        # @param customer_id [String]
-        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Sentdm::Models::Organizations::CustomerUser]
-        #
-        # @see Sentdm::Models::Organizations::UserRetrieveParams
-        def retrieve(user_id, params)
-          parsed, options = Sentdm::Organizations::UserRetrieveParams.dump_request(params)
-          customer_id =
-            parsed.delete(:customer_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
-          @client.request(
-            method: :get,
-            path: ["v2/organizations/%1$s/users/%2$s", customer_id, user_id],
-            model: Sentdm::Organizations::CustomerUser,
-            options: options
-          )
-        end
-
-        # Retrieves all users associated with an organization or sender profile. Requires
-        # appropriate permissions. Supports pagination.
-        #
-        # @overload list(customer_id, page:, page_size:, request_options: {})
-        #
-        # @param customer_id [String]
-        # @param page [Integer]
-        # @param page_size [Integer]
-        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Sentdm::Models::Organizations::UserListResponse]
-        #
-        # @see Sentdm::Models::Organizations::UserListParams
-        def list(customer_id, params)
-          parsed, options = Sentdm::Organizations::UserListParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v2/organizations/%1$s/users", customer_id],
-            query: parsed.transform_keys(page_size: "pageSize"),
-            model: Sentdm::Models::Organizations::UserListResponse,
-            options: options
-          )
-        end
-
-        # Removes a user from an organization or sender profile. Requires admin
-        # permissions. This action permanently deletes the user association.
-        #
-        # @overload delete(user_id, customer_id:, request_options: {})
-        #
-        # @param user_id [String]
-        # @param customer_id [String]
-        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [nil]
-        #
-        # @see Sentdm::Models::Organizations::UserDeleteParams
-        def delete(user_id, params)
-          parsed, options = Sentdm::Organizations::UserDeleteParams.dump_request(params)
-          customer_id =
-            parsed.delete(:customer_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
-          @client.request(
-            method: :delete,
-            path: ["v2/organizations/%1$s/users/%2$s", customer_id, user_id],
-            model: NilClass,
-            options: options
-          )
-        end
-
-        # Invites a user to an organization or sender profile with a specified role.
-        # Requires appropriate permissions. The customerId can be either an organization
-        # ID or a profile ID.
-        #
-        # @overload invite(customer_id, email: nil, invited_by: nil, name: nil, role: nil, request_options: {})
-        #
-        # @param customer_id [String]
-        # @param email [String]
-        # @param invited_by [String, nil]
-        # @param name [String]
-        # @param role [String]
-        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Sentdm::Models::Organizations::CustomerUser]
-        #
-        # @see Sentdm::Models::Organizations::UserInviteParams
-        def invite(customer_id, params = {})
-          parsed, options = Sentdm::Organizations::UserInviteParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: ["v2/organizations/%1$s/users", customer_id],
-            body: parsed,
-            model: Sentdm::Organizations::CustomerUser,
-            options: options
-          )
-        end
-
-        # Updates a user's role within an organization or sender profile. Requires admin
-        # permissions. Valid roles are: admin, billing, developer.
-        #
-        # @overload update_role(user_id, customer_id:, role: nil, request_options: {})
-        #
-        # @param user_id [String] Path param
-        #
-        # @param customer_id [String] Path param
-        #
-        # @param role [String] Body param
-        #
-        # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Sentdm::Models::Organizations::CustomerUser]
-        #
-        # @see Sentdm::Models::Organizations::UserUpdateRoleParams
-        def update_role(user_id, params)
-          parsed, options = Sentdm::Organizations::UserUpdateRoleParams.dump_request(params)
-          customer_id =
-            parsed.delete(:customer_id) do
-              raise ArgumentError.new("missing required path argument #{_1}")
-            end
-          @client.request(
-            method: :put,
-            path: ["v2/organizations/%1$s/users/%2$s", customer_id, user_id],
-            body: parsed,
-            model: Sentdm::Organizations::CustomerUser,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Sentdm::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/sentdm/resources/organizations.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Resources
-    class Organizations
-      # @return [Sentdm::Resources::Organizations::Users]
-      attr_reader :users
-
-      # Retrieves all organizations that the authenticated user has access to, including
-      # the sender profiles within each organization that the user can access. Returns
-      # organization details with nested profiles filtered by user permissions.
-      #
-      # @overload list(request_options: {})
-      #
-      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Sentdm::Models::OrganizationListResponse]
-      #
-      # @see Sentdm::Models::OrganizationListParams
-      def list(params = {})
-        @client.request(
-          method: :get,
-          path: "v2/organizations",
-          model: Sentdm::Models::OrganizationListResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Retrieves all sender profiles within an organization that the authenticated user
-      # has access to. Returns filtered list based on user's permissions.
-      #
-      # @overload retrieve_profiles(org_id, request_options: {})
-      #
-      # @param org_id [String]
-      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Sentdm::Models::OrganizationRetrieveProfilesResponse]
-      #
-      # @see Sentdm::Models::OrganizationRetrieveProfilesParams
-      def retrieve_profiles(org_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["v2/organizations/%1$s/profiles", org_id],
-          model: Sentdm::Models::OrganizationRetrieveProfilesResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Sentdm::Client]
-      def initialize(client:)
-        @client = client
-        @users = Sentdm::Resources::Organizations::Users.new(client: client)
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organization_list_params.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class OrganizationListParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Sentdm::OrganizationListParams, Sentdm::Internal::AnyHash)
-        end
-
-      sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organization_list_response.rbi

@@ -1,131 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class OrganizationListResponse < Sentdm::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            Sentdm::Models::OrganizationListResponse,
-            Sentdm::Internal::AnyHash
-          )
-        end
-
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Sentdm::Models::OrganizationListResponse::Organization]
-          )
-        )
-      end
-      attr_reader :organizations
-
-      sig do
-        params(
-          organizations:
-            T::Array[
-              Sentdm::Models::OrganizationListResponse::Organization::OrHash
-            ]
-        ).void
-      end
-      attr_writer :organizations
-
-      sig do
-        params(
-          organizations:
-            T::Array[
-              Sentdm::Models::OrganizationListResponse::Organization::OrHash
-            ]
-        ).returns(T.attached_class)
-      end
-      def self.new(organizations: nil)
-      end
-
-      sig do
-        override.returns(
-          {
-            organizations:
-              T::Array[Sentdm::Models::OrganizationListResponse::Organization]
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Organization < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::Models::OrganizationListResponse::Organization,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        sig { returns(T.nilable(Time)) }
-        attr_reader :created_at
-
-        sig { params(created_at: Time).void }
-        attr_writer :created_at
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :icon
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :name
-
-        sig { params(name: String).void }
-        attr_writer :name
-
-        sig { returns(T.nilable(T::Array[Sentdm::ProfileSummary])) }
-        attr_reader :profiles
-
-        sig { params(profiles: T::Array[Sentdm::ProfileSummary::OrHash]).void }
-        attr_writer :profiles
-
-        sig do
-          params(
-            id: String,
-            created_at: Time,
-            description: T.nilable(String),
-            icon: T.nilable(String),
-            name: String,
-            profiles: T::Array[Sentdm::ProfileSummary::OrHash]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id: nil,
-          created_at: nil,
-          description: nil,
-          icon: nil,
-          name: nil,
-          profiles: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              created_at: Time,
-              description: T.nilable(String),
-              icon: T.nilable(String),
-              name: String,
-              profiles: T::Array[Sentdm::ProfileSummary]
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organization_retrieve_profiles_params.rbi

@@ -1,30 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class OrganizationRetrieveProfilesParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            Sentdm::OrganizationRetrieveProfilesParams,
-            Sentdm::Internal::AnyHash
-          )
-        end
-
-      sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organization_retrieve_profiles_response.rbi

@@ -1,47 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class OrganizationRetrieveProfilesResponse < Sentdm::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            Sentdm::Models::OrganizationRetrieveProfilesResponse,
-            Sentdm::Internal::AnyHash
-          )
-        end
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :organization_id
-
-      sig { params(organization_id: String).void }
-      attr_writer :organization_id
-
-      sig { returns(T.nilable(T::Array[Sentdm::ProfileSummary])) }
-      attr_reader :profiles
-
-      sig { params(profiles: T::Array[Sentdm::ProfileSummary::OrHash]).void }
-      attr_writer :profiles
-
-      sig do
-        params(
-          organization_id: String,
-          profiles: T::Array[Sentdm::ProfileSummary::OrHash]
-        ).returns(T.attached_class)
-      end
-      def self.new(organization_id: nil, profiles: nil)
-      end
-
-      sig do
-        override.returns(
-          {
-            organization_id: String,
-            profiles: T::Array[Sentdm::ProfileSummary]
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organizations/customer_user.rbi

@@ -1,129 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    module Organizations
-      class CustomerUser < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::Organizations::CustomerUser,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        # Unique identifier
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        sig { returns(T.nilable(Time)) }
-        attr_reader :created_at
-
-        sig { params(created_at: Time).void }
-        attr_writer :created_at
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :customer_id
-
-        sig { params(customer_id: String).void }
-        attr_writer :customer_id
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :email
-
-        sig { params(email: String).void }
-        attr_writer :email
-
-        sig { returns(T.nilable(Time)) }
-        attr_accessor :invitation_sent_at
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :invitation_token
-
-        sig { returns(T.nilable(Time)) }
-        attr_accessor :invitation_token_expires_at
-
-        sig { returns(T.nilable(Time)) }
-        attr_accessor :last_login_at
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :name
-
-        sig { params(name: String).void }
-        attr_writer :name
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :role
-
-        sig { params(role: String).void }
-        attr_writer :role
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :status
-
-        sig { params(status: String).void }
-        attr_writer :status
-
-        sig { returns(T.nilable(Time)) }
-        attr_accessor :updated_at
-
-        sig do
-          params(
-            id: String,
-            created_at: Time,
-            customer_id: String,
-            email: String,
-            invitation_sent_at: T.nilable(Time),
-            invitation_token: T.nilable(String),
-            invitation_token_expires_at: T.nilable(Time),
-            last_login_at: T.nilable(Time),
-            name: String,
-            role: String,
-            status: String,
-            updated_at: T.nilable(Time)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Unique identifier
-          id: nil,
-          created_at: nil,
-          customer_id: nil,
-          email: nil,
-          invitation_sent_at: nil,
-          invitation_token: nil,
-          invitation_token_expires_at: nil,
-          last_login_at: nil,
-          name: nil,
-          role: nil,
-          status: nil,
-          updated_at: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              created_at: Time,
-              customer_id: String,
-              email: String,
-              invitation_sent_at: T.nilable(Time),
-              invitation_token: T.nilable(String),
-              invitation_token_expires_at: T.nilable(Time),
-              last_login_at: T.nilable(Time),
-              name: String,
-              role: String,
-              status: String,
-              updated_at: T.nilable(Time)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organizations/user_delete_params.rbi

@@ -1,40 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    module Organizations
-      class UserDeleteParams < Sentdm::Internal::Type::BaseModel
-        extend Sentdm::Internal::Type::RequestParameters::Converter
-        include Sentdm::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::Organizations::UserDeleteParams,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :customer_id
-
-        sig do
-          params(
-            customer_id: String,
-            request_options: Sentdm::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(customer_id:, request_options: {})
-        end
-
-        sig do
-          override.returns(
-            { customer_id: String, request_options: Sentdm::RequestOptions }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/sentdm/models/organizations/user_invite_params.rbi

@@ -1,73 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    module Organizations
-      class UserInviteParams < Sentdm::Internal::Type::BaseModel
-        extend Sentdm::Internal::Type::RequestParameters::Converter
-        include Sentdm::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::Organizations::UserInviteParams,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :email
-
-        sig { params(email: String).void }
-        attr_writer :email
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :invited_by
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :name
-
-        sig { params(name: String).void }
-        attr_writer :name
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :role
-
-        sig { params(role: String).void }
-        attr_writer :role
-
-        sig do
-          params(
-            email: String,
-            invited_by: T.nilable(String),
-            name: String,
-            role: String,
-            request_options: Sentdm::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          email: nil,
-          invited_by: nil,
-          name: nil,
-          role: nil,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              email: String,
-              invited_by: T.nilable(String),
-              name: String,
-              role: String,
-              request_options: Sentdm::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end