sentdm 0.26.0 → 0.28.0

data/rbi/sentdm/models/contact_retrieve_response.rbi

@@ -0,0 +1,409 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::ContactRetrieveResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Contact response for v3 API Uses snake_case for JSON property names
+      sig { returns(T.nilable(Sentdm::Models::ContactRetrieveResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ContactRetrieveResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::Models::ContactRetrieveResponse::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error:
+            T.nilable(Sentdm::Models::ContactRetrieveResponse::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::Models::ContactRetrieveResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Sentdm::Models::ContactRetrieveResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data:
+            T.nilable(Sentdm::Models::ContactRetrieveResponse::Data::OrHash),
+          error:
+            T.nilable(Sentdm::Models::ContactRetrieveResponse::Error::OrHash),
+          meta: Sentdm::Models::ContactRetrieveResponse::Meta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Contact response for v3 API Uses snake_case for JSON property names
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::ContactRetrieveResponse::Data),
+            error: T.nilable(Sentdm::Models::ContactRetrieveResponse::Error),
+            meta: Sentdm::Models::ContactRetrieveResponse::Meta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactRetrieveResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for the contact
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+        sig { returns(T.nilable(String)) }
+        attr_reader :available_channels
+
+        sig { params(available_channels: String).void }
+        attr_writer :available_channels
+
+        # Country calling code (e.g., 1 for US/Canada)
+        sig { returns(T.nilable(String)) }
+        attr_reader :country_code
+
+        sig { params(country_code: String).void }
+        attr_writer :country_code
+
+        # When the contact was created
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        # Default messaging channel to use (e.g., "sms" or "whatsapp")
+        sig { returns(T.nilable(String)) }
+        attr_reader :default_channel
+
+        sig { params(default_channel: String).void }
+        attr_writer :default_channel
+
+        # Phone number in E.164 format (e.g., +1234567890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_e164
+
+        sig { params(format_e164: String).void }
+        attr_writer :format_e164
+
+        # Phone number in international format (e.g., +1 234-567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_international
+
+        sig { params(format_international: String).void }
+        attr_writer :format_international
+
+        # Phone number in national format (e.g., (234) 567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_national
+
+        sig { params(format_national: String).void }
+        attr_writer :format_national
+
+        # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_rfc
+
+        sig { params(format_rfc: String).void }
+        attr_writer :format_rfc
+
+        # Always false. Contacts are no longer shared or inherited between sender profiles
+        # — a profile sees only the contacts it owns. Retained so existing v3 clients
+        # reading is_inherited keep deserializing; it carries no information.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_inherited
+
+        sig { params(is_inherited: T::Boolean).void }
+        attr_writer :is_inherited
+
+        # Whether the contact has opted out of messaging. Single source of truth — opt-out
+        # is per-contact, not per-channel.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :opt_out
+
+        sig { params(opt_out: T::Boolean).void }
+        attr_writer :opt_out
+
+        # Phone number in original format
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_code
+
+        sig { params(region_code: String).void }
+        attr_writer :region_code
+
+        # When the contact was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Contact response for v3 API Uses snake_case for JSON property names
+        sig do
+          params(
+            id: String,
+            available_channels: String,
+            country_code: String,
+            created_at: Time,
+            customer_id: String,
+            default_channel: String,
+            format_e164: String,
+            format_international: String,
+            format_national: String,
+            format_rfc: String,
+            is_inherited: T::Boolean,
+            opt_out: T::Boolean,
+            phone_number: String,
+            region_code: String,
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the contact
+          id: nil,
+          # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+          available_channels: nil,
+          # Country calling code (e.g., 1 for US/Canada)
+          country_code: nil,
+          # When the contact was created
+          created_at: nil,
+          # 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.
+          customer_id: nil,
+          # Default messaging channel to use (e.g., "sms" or "whatsapp")
+          default_channel: nil,
+          # Phone number in E.164 format (e.g., +1234567890)
+          format_e164: nil,
+          # Phone number in international format (e.g., +1 234-567-890)
+          format_international: nil,
+          # Phone number in national format (e.g., (234) 567-890)
+          format_national: nil,
+          # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+          format_rfc: nil,
+          # Always false. Contacts are no longer shared or inherited between sender profiles
+          # — a profile sees only the contacts it owns. Retained so existing v3 clients
+          # reading is_inherited keep deserializing; it carries no information.
+          is_inherited: nil,
+          # Whether the contact has opted out of messaging. Single source of truth — opt-out
+          # is per-contact, not per-channel.
+          opt_out: nil,
+          # Phone number in original format
+          phone_number: nil,
+          # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+          region_code: nil,
+          # When the contact was last updated
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              available_channels: String,
+              country_code: String,
+              created_at: Time,
+              customer_id: String,
+              default_channel: String,
+              format_e164: String,
+              format_international: String,
+              format_national: String,
+              format_rfc: String,
+              is_inherited: T::Boolean,
+              opt_out: T::Boolean,
+              phone_number: String,
+              region_code: String,
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactRetrieveResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Additional validation error details (field-level errors)
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :details
+
+        # URL to documentation about this error
+        sig { returns(T.nilable(String)) }
+        attr_accessor :doc_url
+
+        # Human-readable error message
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Error information
+        sig do
+          params(
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Machine-readable error code (e.g., "RESOURCE_001")
+          code: nil,
+          # Additional validation error details (field-level errors)
+          details: nil,
+          # URL to documentation about this error
+          doc_url: nil,
+          # Human-readable error message
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              doc_url: T.nilable(String),
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactRetrieveResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end