sentdm 0.28.0 → 0.30.0

data/lib/sentdm/models/template_retrieve_response.rb

@@ -1,209 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Templates#retrieve
-    class TemplateRetrieveResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   Template response for v3 API
-      #
-      #   @return [Sentdm::Models::TemplateRetrieveResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::TemplateRetrieveResponse::Data }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::TemplateRetrieveResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::TemplateRetrieveResponse::Error }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @return [Sentdm::Models::TemplateRetrieveResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::TemplateRetrieveResponse::Meta }
-
-      # @!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::TemplateRetrieveResponse::Data, nil] Template response for v3 API
-      #
-      #   @param error [Sentdm::Models::TemplateRetrieveResponse::Error, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::TemplateRetrieveResponse::Meta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-
-      # @see Sentdm::Models::TemplateRetrieveResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute customer_id
-        #   Which customer owns this — the key's own, or the profile named in x-profile-id.
-        #   Says whose resource this is, which the resource's own id does not.
-        #
-        #   @return [String]
-        required :customer_id, String
-
-        # @!attribute id
-        #   Unique template identifier
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute category
-        #   Template category: MARKETING, UTILITY, AUTHENTICATION
-        #
-        #   @return [String, nil]
-        optional :category, String
-
-        # @!attribute channels
-        #   Supported channels: sms, whatsapp
-        #
-        #   @return [Array<String>, nil]
-        optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!attribute created_at
-        #   When the template was created
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute is_published
-        #   Whether the template is published and active
-        #
-        #   @return [Boolean, nil]
-        optional :is_published, Sentdm::Internal::Type::Boolean
-
-        # @!attribute language
-        #   Template language code (e.g., en_US)
-        #
-        #   @return [String, nil]
-        optional :language, String
-
-        # @!attribute name
-        #   Template display name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!attribute status
-        #   Template status: APPROVED, PENDING, REJECTED
-        #
-        #   @return [String, nil]
-        optional :status, String
-
-        # @!attribute updated_at
-        #   When the template was last updated
-        #
-        #   @return [Time, nil]
-        optional :updated_at, Time, nil?: true
-
-        # @!attribute variables
-        #   Template variables for personalization
-        #
-        #   @return [Array<String>, nil]
-        optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::TemplateRetrieveResponse::Data} for more details.
-        #
-        #   Template response for v3 API
-        #
-        #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
-        #
-        #   @param id [String] Unique template identifier
-        #
-        #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
-        #
-        #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
-        #
-        #   @param created_at [Time] When the template was created
-        #
-        #   @param is_published [Boolean] Whether the template is published and active
-        #
-        #   @param language [String] Template language code (e.g., en_US)
-        #
-        #   @param name [String] Template display name
-        #
-        #   @param status [String] Template status: APPROVED, PENDING, REJECTED
-        #
-        #   @param updated_at [Time, nil] When the template was last updated
-        #
-        #   @param variables [Array<String>, nil] Template variables for personalization
-      end
-
-      # @see Sentdm::Models::TemplateRetrieveResponse#error
-      class Error < Sentdm::Internal::Type::BaseModel
-        # @!attribute code
-        #   Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @return [String, nil]
-        optional :code, String
-
-        # @!attribute details
-        #   Additional validation error details (field-level errors)
-        #
-        #   @return [Hash{Symbol=>Array<String>}, nil]
-        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
-
-        # @!attribute doc_url
-        #   URL to documentation about this error
-        #
-        #   @return [String, nil]
-        optional :doc_url, String, nil?: true
-
-        # @!attribute message
-        #   Human-readable error message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
-        #   Error information
-        #
-        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
-        #
-        #   @param doc_url [String, nil] URL to documentation about this error
-        #
-        #   @param message [String] Human-readable error message
-      end
-
-      # @see Sentdm::Models::TemplateRetrieveResponse#meta
-      class Meta < Sentdm::Internal::Type::BaseModel
-        # @!attribute request_id
-        #   Unique identifier for this request (for tracing and support)
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!attribute timestamp
-        #   Server timestamp when the response was generated
-        #
-        #   @return [Time, nil]
-        optional :timestamp, Time
-
-        # @!attribute version
-        #   API version used for this request
-        #
-        #   @return [String, nil]
-        optional :version, String
-
-        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
-        #   Request and response metadata
-        #
-        #   @param request_id [String] Unique identifier for this request (for tracing and support)
-        #
-        #   @param timestamp [Time] Server timestamp when the response was generated
-        #
-        #   @param version [String] API version used for this request
-      end
-    end
-  end
-end

data/lib/sentdm/models/template_update_response.rb

@@ -1,209 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Templates#update
-    class TemplateUpdateResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   Template response for v3 API
-      #
-      #   @return [Sentdm::Models::TemplateUpdateResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::TemplateUpdateResponse::Data }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::TemplateUpdateResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::TemplateUpdateResponse::Error }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @return [Sentdm::Models::TemplateUpdateResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::TemplateUpdateResponse::Meta }
-
-      # @!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::TemplateUpdateResponse::Data, nil] Template response for v3 API
-      #
-      #   @param error [Sentdm::Models::TemplateUpdateResponse::Error, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::TemplateUpdateResponse::Meta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-
-      # @see Sentdm::Models::TemplateUpdateResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute customer_id
-        #   Which customer owns this — the key's own, or the profile named in x-profile-id.
-        #   Says whose resource this is, which the resource's own id does not.
-        #
-        #   @return [String]
-        required :customer_id, String
-
-        # @!attribute id
-        #   Unique template identifier
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute category
-        #   Template category: MARKETING, UTILITY, AUTHENTICATION
-        #
-        #   @return [String, nil]
-        optional :category, String
-
-        # @!attribute channels
-        #   Supported channels: sms, whatsapp
-        #
-        #   @return [Array<String>, nil]
-        optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!attribute created_at
-        #   When the template was created
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute is_published
-        #   Whether the template is published and active
-        #
-        #   @return [Boolean, nil]
-        optional :is_published, Sentdm::Internal::Type::Boolean
-
-        # @!attribute language
-        #   Template language code (e.g., en_US)
-        #
-        #   @return [String, nil]
-        optional :language, String
-
-        # @!attribute name
-        #   Template display name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!attribute status
-        #   Template status: APPROVED, PENDING, REJECTED
-        #
-        #   @return [String, nil]
-        optional :status, String
-
-        # @!attribute updated_at
-        #   When the template was last updated
-        #
-        #   @return [Time, nil]
-        optional :updated_at, Time, nil?: true
-
-        # @!attribute variables
-        #   Template variables for personalization
-        #
-        #   @return [Array<String>, nil]
-        optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::TemplateUpdateResponse::Data} for more details.
-        #
-        #   Template response for v3 API
-        #
-        #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
-        #
-        #   @param id [String] Unique template identifier
-        #
-        #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
-        #
-        #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
-        #
-        #   @param created_at [Time] When the template was created
-        #
-        #   @param is_published [Boolean] Whether the template is published and active
-        #
-        #   @param language [String] Template language code (e.g., en_US)
-        #
-        #   @param name [String] Template display name
-        #
-        #   @param status [String] Template status: APPROVED, PENDING, REJECTED
-        #
-        #   @param updated_at [Time, nil] When the template was last updated
-        #
-        #   @param variables [Array<String>, nil] Template variables for personalization
-      end
-
-      # @see Sentdm::Models::TemplateUpdateResponse#error
-      class Error < Sentdm::Internal::Type::BaseModel
-        # @!attribute code
-        #   Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @return [String, nil]
-        optional :code, String
-
-        # @!attribute details
-        #   Additional validation error details (field-level errors)
-        #
-        #   @return [Hash{Symbol=>Array<String>}, nil]
-        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
-
-        # @!attribute doc_url
-        #   URL to documentation about this error
-        #
-        #   @return [String, nil]
-        optional :doc_url, String, nil?: true
-
-        # @!attribute message
-        #   Human-readable error message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
-        #   Error information
-        #
-        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
-        #
-        #   @param doc_url [String, nil] URL to documentation about this error
-        #
-        #   @param message [String] Human-readable error message
-      end
-
-      # @see Sentdm::Models::TemplateUpdateResponse#meta
-      class Meta < Sentdm::Internal::Type::BaseModel
-        # @!attribute request_id
-        #   Unique identifier for this request (for tracing and support)
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!attribute timestamp
-        #   Server timestamp when the response was generated
-        #
-        #   @return [Time, nil]
-        optional :timestamp, Time
-
-        # @!attribute version
-        #   API version used for this request
-        #
-        #   @return [String, nil]
-        optional :version, String
-
-        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
-        #   Request and response metadata
-        #
-        #   @param request_id [String] Unique identifier for this request (for tracing and support)
-        #
-        #   @param timestamp [Time] Server timestamp when the response was generated
-        #
-        #   @param version [String] API version used for this request
-      end
-    end
-  end
-end

data/lib/sentdm/models/user_invite_response.rb

@@ -1,201 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Users#invite
-    class UserInviteResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   User response for v3 API
-      #
-      #   @return [Sentdm::Models::UserInviteResponse::Data, nil]
-      optional :data, -> { Sentdm::Models::UserInviteResponse::Data }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::UserInviteResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::UserInviteResponse::Error }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @return [Sentdm::Models::UserInviteResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::UserInviteResponse::Meta }
-
-      # @!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::UserInviteResponse::Data, nil] User response for v3 API
-      #
-      #   @param error [Sentdm::Models::UserInviteResponse::Error, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::UserInviteResponse::Meta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-
-      # @see Sentdm::Models::UserInviteResponse#data
-      class Data < Sentdm::Internal::Type::BaseModel
-        # @!attribute id
-        #   User unique identifier
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute created_at
-        #   When the user was added to the organization
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute customer_id
-        #   Which customer owns this — the key's own, or the profile named in x-profile-id.
-        #   Says whose resource this is, which the resource's own id does not.
-        #
-        #   @return [String, nil]
-        optional :customer_id, String
-
-        # @!attribute email
-        #   User email address
-        #
-        #   @return [String, nil]
-        optional :email, String
-
-        # @!attribute invited_at
-        #   When the user was invited
-        #
-        #   @return [Time, nil]
-        optional :invited_at, Time, nil?: true
-
-        # @!attribute last_login_at
-        #   When the user last logged in
-        #
-        #   @return [Time, nil]
-        optional :last_login_at, Time, nil?: true
-
-        # @!attribute name
-        #   User full name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!attribute role
-        #   User role in the organization: admin, billing, developer
-        #
-        #   @return [String, nil]
-        optional :role, String
-
-        # @!attribute status
-        #   User status: active, invited, suspended, rejected
-        #
-        #   @return [String, nil]
-        optional :status, String
-
-        # @!attribute updated_at
-        #   When the user record was last updated
-        #
-        #   @return [Time, nil]
-        optional :updated_at, Time, nil?: true
-
-        # @!method initialize(id: nil, created_at: nil, customer_id: nil, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::UserInviteResponse::Data} for more details.
-        #
-        #   User response for v3 API
-        #
-        #   @param id [String] User unique identifier
-        #
-        #   @param created_at [Time] When the user was added to the organization
-        #
-        #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
-        #
-        #   @param email [String] User email address
-        #
-        #   @param invited_at [Time, nil] When the user was invited
-        #
-        #   @param last_login_at [Time, nil] When the user last logged in
-        #
-        #   @param name [String] User full name
-        #
-        #   @param role [String] User role in the organization: admin, billing, developer
-        #
-        #   @param status [String] User status: active, invited, suspended, rejected
-        #
-        #   @param updated_at [Time, nil] When the user record was last updated
-      end
-
-      # @see Sentdm::Models::UserInviteResponse#error
-      class Error < Sentdm::Internal::Type::BaseModel
-        # @!attribute code
-        #   Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @return [String, nil]
-        optional :code, String
-
-        # @!attribute details
-        #   Additional validation error details (field-level errors)
-        #
-        #   @return [Hash{Symbol=>Array<String>}, nil]
-        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
-
-        # @!attribute doc_url
-        #   URL to documentation about this error
-        #
-        #   @return [String, nil]
-        optional :doc_url, String, nil?: true
-
-        # @!attribute message
-        #   Human-readable error message
-        #
-        #   @return [String, nil]
-        optional :message, String
-
-        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
-        #   Error information
-        #
-        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
-        #
-        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
-        #
-        #   @param doc_url [String, nil] URL to documentation about this error
-        #
-        #   @param message [String] Human-readable error message
-      end
-
-      # @see Sentdm::Models::UserInviteResponse#meta
-      class Meta < Sentdm::Internal::Type::BaseModel
-        # @!attribute request_id
-        #   Unique identifier for this request (for tracing and support)
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!attribute timestamp
-        #   Server timestamp when the response was generated
-        #
-        #   @return [Time, nil]
-        optional :timestamp, Time
-
-        # @!attribute version
-        #   API version used for this request
-        #
-        #   @return [String, nil]
-        optional :version, String
-
-        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
-        #   Request and response metadata
-        #
-        #   @param request_id [String] Unique identifier for this request (for tracing and support)
-        #
-        #   @param timestamp [Time] Server timestamp when the response was generated
-        #
-        #   @param version [String] API version used for this request
-      end
-    end
-  end
-end