sentdm 0.0.2

data/lib/sentdm/models/number_lookup_retrieve_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::NumberLookup#retrieve
+    class NumberLookupRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute country_code
+      #   The country calling code (e.g., 1 for US/Canada)
+      #
+      #   @return [String, nil]
+      optional :country_code, String, api_name: :countryCode
+
+      # @!attribute format_e164
+      #   The phone number formatted in E.164 standard (e.g., +1234567890)
+      #
+      #   @return [String, nil]
+      optional :format_e164, String, api_name: :formatE164
+
+      # @!attribute format_international
+      #   The phone number formatted for international dialing (e.g., +1 234-567-890)
+      #
+      #   @return [String, nil]
+      optional :format_international, String, api_name: :formatInternational
+
+      # @!attribute format_national
+      #   The phone number formatted for national dialing (e.g., (234) 567-890)
+      #
+      #   @return [String, nil]
+      optional :format_national, String, api_name: :formatNational
+
+      # @!attribute format_rfc
+      #   The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
+      #
+      #   @return [String, nil]
+      optional :format_rfc, String, api_name: :formatRfc
+
+      # @!attribute number_type
+      #   The type of phone number (e.g., mobile, fixed_line, voip)
+      #
+      #   @return [String, nil]
+      optional :number_type, String, api_name: :numberType
+
+      # @!attribute phone_number
+      #   The phone number in its original format
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, api_name: :phoneNumber
+
+      # @!attribute phone_timezones
+      #   The timezones associated with the phone number
+      #
+      #   @return [String, nil]
+      optional :phone_timezones, String, api_name: :phoneTimezones
+
+      # @!attribute region_code
+      #   The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+      #
+      #   @return [String, nil]
+      optional :region_code, String, api_name: :regionCode
+
+      # @!method initialize(country_code: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, number_type: nil, phone_number: nil, phone_timezones: nil, region_code: nil)
+      #   Response containing phone number lookup data
+      #
+      #   @param country_code [String] The country calling code (e.g., 1 for US/Canada)
+      #
+      #   @param format_e164 [String] The phone number formatted in E.164 standard (e.g., +1234567890)
+      #
+      #   @param format_international [String] The phone number formatted for international dialing (e.g., +1 234-567-890)
+      #
+      #   @param format_national [String] The phone number formatted for national dialing (e.g., (234) 567-890)
+      #
+      #   @param format_rfc [String] The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
+      #
+      #   @param number_type [String] The type of phone number (e.g., mobile, fixed_line, voip)
+      #
+      #   @param phone_number [String] The phone number in its original format
+      #
+      #   @param phone_timezones [String] The timezones associated with the phone number
+      #
+      #   @param region_code [String] The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+    end
+  end
+end

data/lib/sentdm/models/organization_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Organizations#list
+    class OrganizationListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/organization_list_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Organizations#list
+    class OrganizationListResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute organizations
+      #
+      #   @return [Array<Sentdm::Models::OrganizationListResponse::Organization>, nil]
+      optional :organizations,
+               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::OrganizationListResponse::Organization] }
+
+      # @!method initialize(organizations: nil)
+      #   @param organizations [Array<Sentdm::Models::OrganizationListResponse::Organization>]
+
+      class Organization < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, api_name: :createdAt
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute icon
+        #
+        #   @return [String, nil]
+        optional :icon, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute profiles
+        #
+        #   @return [Array<Sentdm::Models::ProfileSummary>, nil]
+        optional :profiles, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ProfileSummary] }
+
+        # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, profiles: nil)
+        #   @param id [String]
+        #   @param created_at [Time]
+        #   @param description [String, nil]
+        #   @param icon [String, nil]
+        #   @param name [String]
+        #   @param profiles [Array<Sentdm::Models::ProfileSummary>]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organization_retrieve_profiles_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Organizations#retrieve_profiles
+    class OrganizationRetrieveProfilesParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/organization_retrieve_profiles_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Organizations#retrieve_profiles
+    class OrganizationRetrieveProfilesResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute organization_id
+      #
+      #   @return [String, nil]
+      optional :organization_id, String, api_name: :organizationId
+
+      # @!attribute profiles
+      #
+      #   @return [Array<Sentdm::Models::ProfileSummary>, nil]
+      optional :profiles, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ProfileSummary] }
+
+      # @!method initialize(organization_id: nil, profiles: nil)
+      #   @param organization_id [String]
+      #   @param profiles [Array<Sentdm::Models::ProfileSummary>]
+    end
+  end
+end

data/lib/sentdm/models/organizations/customer_user.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#retrieve
+      class CustomerUser < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, api_name: :createdAt
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, api_name: :customerId
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute invitation_sent_at
+        #
+        #   @return [Time, nil]
+        optional :invitation_sent_at, Time, api_name: :invitationSentAt, nil?: true
+
+        # @!attribute invitation_token
+        #
+        #   @return [String, nil]
+        optional :invitation_token, String, api_name: :invitationToken, nil?: true
+
+        # @!attribute invitation_token_expires_at
+        #
+        #   @return [Time, nil]
+        optional :invitation_token_expires_at, Time, api_name: :invitationTokenExpiresAt, nil?: true
+
+        # @!attribute last_login_at
+        #
+        #   @return [Time, nil]
+        optional :last_login_at, Time, api_name: :lastLoginAt, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute role
+        #
+        #   @return [String, nil]
+        optional :role, String
+
+        # @!attribute status
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+        # @!method initialize(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)
+        #   @param id [String] Unique identifier
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param email [String]
+        #
+        #   @param invitation_sent_at [Time, nil]
+        #
+        #   @param invitation_token [String, nil]
+        #
+        #   @param invitation_token_expires_at [Time, nil]
+        #
+        #   @param last_login_at [Time, nil]
+        #
+        #   @param name [String]
+        #
+        #   @param role [String]
+        #
+        #   @param status [String]
+        #
+        #   @param updated_at [Time, nil]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organizations/user_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#delete
+      class UserDeleteParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!method initialize(customer_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organizations/user_invite_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#invite
+      class UserInviteParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute invited_by
+        #
+        #   @return [String, nil]
+        optional :invited_by, String, api_name: :invitedBy, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute role
+        #
+        #   @return [String, nil]
+        optional :role, String
+
+        # @!method initialize(email: nil, invited_by: nil, name: nil, role: nil, request_options: {})
+        #   @param email [String]
+        #   @param invited_by [String, nil]
+        #   @param name [String]
+        #   @param role [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organizations/user_list_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#list
+      class UserListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute page
+        #
+        #   @return [Integer]
+        required :page, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!method initialize(page:, page_size:, request_options: {})
+        #   @param page [Integer]
+        #   @param page_size [Integer]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organizations/user_list_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#list
+      class UserListResponse < Sentdm::Internal::Type::BaseModel
+        # @!attribute page
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer, api_name: :pageSize
+
+        # @!attribute total_count
+        #
+        #   @return [Integer, nil]
+        optional :total_count, Integer, api_name: :totalCount
+
+        # @!attribute users
+        #
+        #   @return [Array<Sentdm::Models::Organizations::CustomerUser>, nil]
+        optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Organizations::CustomerUser] }
+
+        # @!method initialize(page: nil, page_size: nil, total_count: nil, users: nil)
+        #   @param page [Integer]
+        #   @param page_size [Integer]
+        #   @param total_count [Integer]
+        #   @param users [Array<Sentdm::Models::Organizations::CustomerUser>]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organizations/user_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#retrieve
+      class UserRetrieveParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!method initialize(customer_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/organizations/user_update_role_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Organizations
+      # @see Sentdm::Resources::Organizations::Users#update_role
+      class UserUpdateRoleParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute role
+        #
+        #   @return [String, nil]
+        optional :role, String
+
+        # @!method initialize(customer_id:, role: nil, request_options: {})
+        #   @param customer_id [String]
+        #   @param role [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/profile_summary.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ProfileSummary < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute icon
+      #
+      #   @return [String, nil]
+      optional :icon, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute short_name
+      #
+      #   @return [String, nil]
+      optional :short_name, String, api_name: :shortName, nil?: true
+
+      # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, short_name: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param description [String, nil]
+      #   @param icon [String, nil]
+      #   @param name [String]
+      #   @param short_name [String, nil]
+    end
+  end
+end

data/lib/sentdm/models/template_body_content.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class TemplateBodyContent < Sentdm::Internal::Type::BaseModel
+      # @!attribute template
+      #
+      #   @return [String, nil]
+      optional :template, String
+
+      # @!attribute type
+      #
+      #   @return [String, nil]
+      optional :type, String, nil?: true
+
+      # @!attribute variables
+      #
+      #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
+      optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
+
+      # @!method initialize(template: nil, type: nil, variables: nil)
+      #   @param template [String]
+      #   @param type [String, nil]
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil]
+    end
+  end
+end

data/lib/sentdm/models/template_create_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Templates#create
+    class TemplateCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute definition
+      #   Template definition containing header, body, footer, and buttons
+      #
+      #   @return [Sentdm::Models::TemplateDefinition]
+      required :definition, -> { Sentdm::TemplateDefinition }
+
+      # @!attribute category
+      #   The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be
+      #   set when creating a new template. If not provided, will be auto-generated using
+      #   AI.
+      #
+      #   @return [String, nil]
+      optional :category, String, nil?: true
+
+      # @!attribute language
+      #   The template language code (e.g., en_US, es_ES). Can only be set when creating a
+      #   new template. If not provided, will be auto-detected using AI.
+      #
+      #   @return [String, nil]
+      optional :language, String, nil?: true
+
+      # @!attribute submit_for_review
+      #   When false, the template will be saved as draft. When true, the template will be
+      #   submitted for review.
+      #
+      #   @return [Boolean, nil]
+      optional :submit_for_review, Sentdm::Internal::Type::Boolean, api_name: :submitForReview
+
+      # @!method initialize(definition:, category: nil, language: nil, submit_for_review: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateCreateParams} for more details.
+      #
+      #   @param definition [Sentdm::Models::TemplateDefinition] Template definition containing header, body, footer, and buttons
+      #
+      #   @param category [String, nil] The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be se
+      #
+      #   @param language [String, nil] The template language code (e.g., en_US, es_ES). Can only be set when creating a
+      #
+      #   @param submit_for_review [Boolean] When false, the template will be saved as draft.
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end