sentdm 0.45.0 → 0.46.0

data/lib/sentdm/models/me_retrieve_response.rb

@@ -1,409 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Me#retrieve
-    class MeRetrieveResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   Account response for GET /v3/me endpoint. Returns organization (with profiles),
-      #   user (standalone), or profile (child of an organization) data depending on the
-      #   API key type. Always includes messaging channel configuration.
-      #
-      #   @return [Sentdm::Models::MeRetrieveResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::MeRetrieveResponse::Data }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
-
-      # @!attribute success
-      #   Indicates whether the request was successful
-      #
-      #   @return [Boolean, nil]
-      optional :success, Sentdm::Internal::Type::Boolean
-
-      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MeRetrieveResponse} for more details.
-      #
-      #   Standard API response envelope for all v3 endpoints
-      #
-      #   @param data [Sentdm::Models::MeRetrieveResponse::Data, nil] Account response for GET /v3/me endpoint.
-      #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-
-      # @see Sentdm::Models::MeRetrieveResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute id
-        #   Customer ID (organization, account, or profile)
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute channels
-        #   Messaging channel configuration. All three channels are always present. Each
-        #   channel has a "configured" flag; configured channels expose additional details.
-        #
-        #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels, nil]
-        optional :channels, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels }
-
-        # @!attribute created_at
-        #   When the account was created
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute description
-        #   Account description
-        #
-        #   @return [String, nil]
-        optional :description, String, nil?: true
-
-        # @!attribute email
-        #   Contact email address
-        #
-        #   @return [String, nil]
-        optional :email, String, nil?: true
-
-        # @!attribute enable_template_auto_creation_for_sp
-        #   Whether this account may mark a template for automatic creation on its sender
-        #   profiles. Granted by Sent per account and off by default, so it is what a
-        #   template-create form reads to decide whether to offer the option at all —
-        #   marking a template without it does nothing.
-        #
-        #   Top-level rather than inside settings, which is written for type: "profile" only
-        #   and so would never carry it to the account type that can act on it.
-        #
-        #   This is the capability, not the stored flag: a profile reports false whatever
-        #   its own row holds. A sender profile owns no sender profiles, so a template it
-        #   marked would have nothing to be created on and the fan-out would never read the
-        #   flag. The admin GET /customers/{id} reports the stored value instead, because
-        #   that is the one an operator granted.
-        #
-        #   @return [Boolean, nil]
-        optional :enable_template_auto_creation_for_sp, Sentdm::Internal::Type::Boolean
-
-        # @!attribute icon
-        #   Account icon URL
-        #
-        #   @return [String, nil]
-        optional :icon, String, nil?: true
-
-        # @!attribute name
-        #   Account name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!attribute organization_id
-        #   Organization ID (only for profile type — the parent organization)
-        #
-        #   @return [String, nil]
-        optional :organization_id, String, nil?: true
-
-        # @!attribute profiles
-        #   List of profiles (populated for organization type, empty for user and profile
-        #   types)
-        #
-        #   @return [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil]
-        optional :profiles,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] }
-
-        # @!attribute sending_phone_number
-        #   The SMS sender this account sends from in the United States, in E.164 form. Null
-        #   when the account has no US SMS sender.
-        #
-        #   The same value as channels.sms.phone_number, published under both names on
-        #   purpose: sending_phone_number is what this value is already called on GET
-        #   /v3/profiles, so the same key answers the same question whichever of the two
-        #   endpoints you ask. Neither name is preferred over the other and neither is
-        #   deprecated.
-        #
-        #   The same value, not the same presence: this key is always written, including as
-        #   null, whereas channels.sms.phone_number is left out entirely when there is no
-        #   sender.
-        #
-        #   @return [String, nil]
-        optional :sending_phone_number, String, nil?: true
-
-        # @!attribute sending_phone_number_profile_id
-        #   The account that holds sending_phone_number in number inventory: normally this
-        #   account itself, and a different account when the number is held elsewhere. Null
-        #   when there is no US sender, or when the sender is not a number drawn from
-        #   inventory — an alphanumeric sender ID or a short code.
-        #
-        #   @return [String, nil]
-        optional :sending_phone_number_profile_id, String, nil?: true
-
-        # @!attribute settings
-        #   Profile configuration settings
-        #
-        #   @return [Sentdm::Models::ProfileSettings, nil]
-        optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
-
-        # @!attribute short_name
-        #   Short name / abbreviation (only for profile type)
-        #
-        #   @return [String, nil]
-        optional :short_name, String, nil?: true
-
-        # @!attribute status
-        #   Profile status (only for profile type): incomplete, pending_review, approved,
-        #   etc.
-        #
-        #   @return [String, nil]
-        optional :status, String, nil?: true
-
-        # @!attribute type
-        #   Account type: "organization" (has profiles), "user" (no profiles), or "profile"
-        #   (child of an organization)
-        #
-        #   @return [String, nil]
-        optional :type, String
-
-        # @!method initialize(id: nil, channels: nil, created_at: nil, description: nil, email: nil, enable_template_auto_creation_for_sp: nil, icon: nil, name: nil, organization_id: nil, profiles: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, settings: nil, short_name: nil, status: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::MeRetrieveResponse::Data} for more details.
-        #
-        #   Account response for GET /v3/me endpoint. Returns organization (with profiles),
-        #   user (standalone), or profile (child of an organization) data depending on the
-        #   API key type. Always includes messaging channel configuration.
-        #
-        #   @param id [String] Customer ID (organization, account, or profile)
-        #
-        #   @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration. All three channels are always present.
-        #
-        #   @param created_at [Time] When the account was created
-        #
-        #   @param description [String, nil] Account description
-        #
-        #   @param email [String, nil] Contact email address
-        #
-        #   @param enable_template_auto_creation_for_sp [Boolean] Whether this account may mark a template for automatic creation on its sender pr
-        #
-        #   @param icon [String, nil] Account icon URL
-        #
-        #   @param name [String] Account name
-        #
-        #   @param organization_id [String, nil] Organization ID (only for profile type — the parent organization)
-        #
-        #   @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
-        #
-        #   @param sending_phone_number [String, nil] The SMS sender this account sends from in the United States, in E.164 form. Null
-        #
-        #   @param sending_phone_number_profile_id [String, nil] The account that holds sending_phone_number in number inventory: normally this a
-        #
-        #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile configuration settings
-        #
-        #   @param short_name [String, nil] Short name / abbreviation (only for profile type)
-        #
-        #   @param status [String, nil] Profile status (only for profile type): incomplete, pending_review, approved, et
-        #
-        #   @param type [String] Account type: "organization" (has profiles), "user" (no profiles), or "profile"
-
-        # @see Sentdm::Models::MeRetrieveResponse::Data#channels
-        class Channels < Sentdm::Internal::Type::BaseModel
-          # @!attribute rcs
-          #   RCS channel configuration. When configured, includes the RCS phone number.
-          #
-          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs, nil]
-          optional :rcs, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs }
-
-          # @!attribute sms
-          #   SMS channel configuration. When configured, includes the sending phone number.
-          #
-          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS, nil]
-          optional :sms, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS }
-
-          # @!attribute whatsapp
-          #   WhatsApp Business channel configuration. When configured, includes the WhatsApp
-          #   phone number and business name.
-          #
-          #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp, nil]
-          optional :whatsapp, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp }
-
-          # @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::MeRetrieveResponse::Data::Channels} for more details.
-          #
-          #   Messaging channel configuration. All three channels are always present. Each
-          #   channel has a "configured" flag; configured channels expose additional details.
-          #
-          #   @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel configuration. When configured, includes the RCS phone number.
-          #
-          #   @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel configuration. When configured, includes the sending phone number.
-          #
-          #   @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel configuration. When configured, includes the WhatsApp
-
-          # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#rcs
-          class Rcs < Sentdm::Internal::Type::BaseModel
-            # @!attribute configured
-            #   Whether RCS is configured for this account
-            #
-            #   @return [Boolean, nil]
-            optional :configured, Sentdm::Internal::Type::Boolean
-
-            # @!attribute phone_number
-            #   RCS-enabled phone number in E.164 format
-            #
-            #   @return [String, nil]
-            optional :phone_number, String, nil?: true
-
-            # @!method initialize(configured: nil, phone_number: nil)
-            #   RCS channel configuration. When configured, includes the RCS phone number.
-            #
-            #   @param configured [Boolean] Whether RCS is configured for this account
-            #
-            #   @param phone_number [String, nil] RCS-enabled phone number in E.164 format
-          end
-
-          # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#sms
-          class SMS < Sentdm::Internal::Type::BaseModel
-            # @!attribute configured
-            #   Whether SMS is configured for this account
-            #
-            #   @return [Boolean, nil]
-            optional :configured, Sentdm::Internal::Type::Boolean
-
-            # @!attribute phone_number
-            #   Sending phone number in E.164 format
-            #
-            #   @return [String, nil]
-            optional :phone_number, String, nil?: true
-
-            # @!method initialize(configured: nil, phone_number: nil)
-            #   SMS channel configuration. When configured, includes the sending phone number.
-            #
-            #   @param configured [Boolean] Whether SMS is configured for this account
-            #
-            #   @param phone_number [String, nil] Sending phone number in E.164 format
-          end
-
-          # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#whatsapp
-          class Whatsapp < Sentdm::Internal::Type::BaseModel
-            # @!attribute business_name
-            #   WhatsApp Business display name
-            #
-            #   @return [String, nil]
-            optional :business_name, String, nil?: true
-
-            # @!attribute configured
-            #   Whether WhatsApp is configured for this account
-            #
-            #   @return [Boolean, nil]
-            optional :configured, Sentdm::Internal::Type::Boolean
-
-            # @!attribute phone_number
-            #   WhatsApp phone number in E.164 format
-            #
-            #   @return [String, nil]
-            optional :phone_number, String, nil?: true
-
-            # @!method initialize(business_name: nil, configured: nil, phone_number: nil)
-            #   WhatsApp Business channel configuration. When configured, includes the WhatsApp
-            #   phone number and business name.
-            #
-            #   @param business_name [String, nil] WhatsApp Business display name
-            #
-            #   @param configured [Boolean] Whether WhatsApp is configured for this account
-            #
-            #   @param phone_number [String, nil] WhatsApp phone number in E.164 format
-          end
-        end
-
-        class Profile < Sentdm::Internal::Type::BaseModel
-          # @!attribute id
-          #   Profile unique identifier
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!attribute created_at
-          #   When the profile was created
-          #
-          #   @return [Time, nil]
-          optional :created_at, Time
-
-          # @!attribute description
-          #   Profile description
-          #
-          #   @return [String, nil]
-          optional :description, String, nil?: true
-
-          # @!attribute icon
-          #   Profile icon URL
-          #
-          #   @return [String, nil]
-          optional :icon, String, nil?: true
-
-          # @!attribute name
-          #   Profile name
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute role
-          #   User's role in this profile: admin, billing, developer (inherited from
-          #   organization if not explicitly set)
-          #
-          #   @return [String, nil]
-          optional :role, String, nil?: true
-
-          # @!attribute settings
-          #   Profile configuration settings
-          #
-          #   @return [Sentdm::Models::ProfileSettings, nil]
-          optional :settings, -> { Sentdm::ProfileSettings }
-
-          # @!attribute short_name
-          #   Profile short name (abbreviation)
-          #
-          #   @return [String, nil]
-          optional :short_name, String, nil?: true
-
-          # @!attribute status
-          #   Profile setup status: incomplete, pending_review, approved, rejected
-          #
-          #   @return [String, nil]
-          optional :status, String, nil?: true
-
-          # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, role: nil, settings: nil, short_name: nil, status: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::MeRetrieveResponse::Data::Profile} for more details.
-          #
-          #   Profile (sender profile) response for v3 API
-          #
-          #   @param id [String] Profile unique identifier
-          #
-          #   @param created_at [Time] When the profile was created
-          #
-          #   @param description [String, nil] Profile description
-          #
-          #   @param icon [String, nil] Profile icon URL
-          #
-          #   @param name [String] Profile name
-          #
-          #   @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
-          #
-          #   @param settings [Sentdm::Models::ProfileSettings] Profile configuration settings
-          #
-          #   @param short_name [String, nil] Profile short name (abbreviation)
-          #
-          #   @param status [String, nil] Profile setup status: incomplete, pending_review, approved, rejected
-        end
-      end
-    end
-  end
-end

data/lib/sentdm/models/message_retrieve_activities_response.rb

@@ -1,175 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Messages#retrieve_activities
-    class MessageRetrieveActivitiesResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   Response for GET /messages/{id}/activities
-      #
-      #   @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Data }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
-
-      # @!attribute success
-      #   Indicates whether the request was successful
-      #
-      #   @return [Boolean, nil]
-      optional :success, Sentdm::Internal::Type::Boolean
-
-      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
-      #   Standard API response envelope for all v3 endpoints
-      #
-      #   @param data [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil] Response for GET /messages/{id}/activities
-      #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-
-      # @see Sentdm::Models::MessageRetrieveActivitiesResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute activities
-        #   List of activity events ordered by most recent first
-        #
-        #   @return [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>, nil]
-        optional :activities,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity] }
-
-        # @!attribute message_id
-        #   The message ID these activities belong to
-        #
-        #   @return [String, nil]
-        optional :message_id, String
-
-        # @!attribute pagination
-        #   Pagination metadata for list responses
-        #
-        #   @return [Sentdm::Models::PaginationMeta, nil]
-        optional :pagination, -> { Sentdm::PaginationMeta }
-
-        # @!method initialize(activities: nil, message_id: nil, pagination: nil)
-        #   Response for GET /messages/{id}/activities
-        #
-        #   @param activities [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>] List of activity events ordered by most recent first
-        #
-        #   @param message_id [String] The message ID these activities belong to
-        #
-        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
-
-        class Activity < Sentdm::Internal::Type::BaseModel
-          # @!attribute active_contact_price
-          #   Active contact markup applied on top of the channel cost, formatted to 4 decimal
-          #   places.
-          #
-          #   @return [String, nil]
-          optional :active_contact_price, String, nil?: true
-
-          # @!attribute description
-          #   Human-readable description of the activity
-          #
-          #   @return [String, nil]
-          optional :description, String
-
-          # @!attribute from
-          #   Sender phone number for this activity (the customer's sending number for
-          #   outbound, the external sender for inbound). Null when not reported by the
-          #   provider.
-          #
-          #   @return [String, nil]
-          optional :from, String, nil?: true
-
-          # @!attribute price
-          #   Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
-          #   4 decimal places.
-          #
-          #   @return [String, nil]
-          optional :price, String, nil?: true
-
-          # @!attribute reason
-          #   A human-readable sentence for reason_code, for example "The recipient is not
-          #   registered on this channel" Omitted whenever reason_code is.
-          #
-          #   @return [String, nil]
-          optional :reason, String, nil?: true
-
-          # @!attribute reason_code
-          #   Why the message reached this status, as a stable platform code such as
-          #   DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
-          #   activities; omitted on every status that needs no explanation. Switch on this
-          #   rather than on reason: the code is stable, the wording may be improved. Same
-          #   wire name and vocabulary as on the message and the webhook.
-          #
-          #   @return [String, nil]
-          optional :reason_code, String, nil?: true
-
-          # @!attribute scheduled_at
-          #   SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
-          #   held message will be released for delivery; on a CANCELLED entry, the instant
-          #   that was called off. Same wire name as on the send response, the message and the
-          #   webhook. Omitted on every other activity. A message that quiet hours moved at
-          #   release has two SCHEDULED entries, each carrying the instant as it stood at that
-          #   moment.
-          #
-          #   @return [Time, nil]
-          optional :scheduled_at, Time, nil?: true
-
-          # @!attribute status
-          #   Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
-          #   DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
-          #
-          #   @return [String, nil]
-          optional :status, String
-
-          # @!attribute timestamp
-          #   When this activity occurred
-          #
-          #   @return [Time, nil]
-          optional :timestamp, Time
-
-          # @!method initialize(active_contact_price: nil, description: nil, from: nil, price: nil, reason: nil, reason_code: nil, scheduled_at: nil, status: nil, timestamp: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity} for more
-          #   details.
-          #
-          #   A single message activity event for v3 API.
-          #
-          #   The activity list mixes statuses, so unlike a message it is one shape rather
-          #   than two: a SCHEDULED entry carries scheduled_at, and every other entry has no
-          #   such key.
-          #
-          #   @param active_contact_price [String, nil] Active contact markup applied on top of the channel cost, formatted to 4 decimal
-          #
-          #   @param description [String] Human-readable description of the activity
-          #
-          #   @param from [String, nil] Sender phone number for this activity (the customer's sending number for outboun
-          #
-          #   @param price [String, nil] Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
-          #
-          #   @param reason [String, nil] A human-readable sentence for reason_code, for example "The recipient is not reg
-          #
-          #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
-          #   DELIVERY\_
-          #
-          #   @param scheduled_at [Time, nil] SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
-          #
-          #   @param status [String] Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT, DELIVERED
-          #
-          #   @param timestamp [Time] When this activity occurred
-        end
-      end
-    end
-  end
-end