sentdm 0.18.0 → 0.19.0

data/sig/sentdm/models/profile_retrieve_response.rbs

@@ -0,0 +1,662 @@
+module Sentdm
+  module Models
+    type profile_retrieve_response =
+      {
+        data: Sentdm::Models::ProfileRetrieveResponse::Data?,
+        error: Sentdm::Models::ProfileRetrieveResponse::Error?,
+        meta: Sentdm::Models::ProfileRetrieveResponse::Meta,
+        success: bool
+      }
+
+    class ProfileRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::Models::ProfileRetrieveResponse::Data?
+
+      attr_accessor error: Sentdm::Models::ProfileRetrieveResponse::Error?
+
+      attr_reader meta: Sentdm::Models::ProfileRetrieveResponse::Meta?
+
+      def meta=: (
+        Sentdm::Models::ProfileRetrieveResponse::Meta
+      ) -> Sentdm::Models::ProfileRetrieveResponse::Meta
+
+      attr_reader success: bool?
+
+      def success=: (bool) -> bool
+
+      def initialize: (
+        ?data: Sentdm::Models::ProfileRetrieveResponse::Data?,
+        ?error: Sentdm::Models::ProfileRetrieveResponse::Error?,
+        ?meta: Sentdm::Models::ProfileRetrieveResponse::Meta,
+        ?success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Sentdm::Models::ProfileRetrieveResponse::Data?,
+        error: Sentdm::Models::ProfileRetrieveResponse::Error?,
+        meta: Sentdm::Models::ProfileRetrieveResponse::Meta,
+        success: bool
+      }
+
+      type data =
+        {
+          id: String,
+          allow_contact_sharing: bool,
+          allow_number_change_during_onboarding: bool?,
+          allow_template_sharing: bool,
+          billing_contact: Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact?,
+          billing_model: String,
+          brand: Sentdm::Models::ProfileRetrieveResponse::Data::Brand?,
+          created_at: Time,
+          description: String?,
+          email: String?,
+          icon: String?,
+          inherit_contacts: bool,
+          inherit_tcr_brand: bool,
+          inherit_tcr_campaign: bool,
+          inherit_templates: bool,
+          name: String,
+          organization_id: String?,
+          sending_phone_number: String?,
+          sending_phone_number_profile_id: String?,
+          sending_whatsapp_number_profile_id: String?,
+          short_name: String?,
+          status: String,
+          updated_at: Time?,
+          waba_id: String?,
+          whatsapp_phone_number: String?
+        }
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader allow_contact_sharing: bool?
+
+        def allow_contact_sharing=: (bool) -> bool
+
+        attr_accessor allow_number_change_during_onboarding: bool?
+
+        attr_reader allow_template_sharing: bool?
+
+        def allow_template_sharing=: (bool) -> bool
+
+        attr_accessor billing_contact: Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact?
+
+        attr_reader billing_model: String?
+
+        def billing_model=: (String) -> String
+
+        attr_accessor brand: Sentdm::Models::ProfileRetrieveResponse::Data::Brand?
+
+        attr_reader created_at: Time?
+
+        def created_at=: (Time) -> Time
+
+        attr_accessor description: String?
+
+        attr_accessor email: String?
+
+        attr_accessor icon: String?
+
+        attr_reader inherit_contacts: bool?
+
+        def inherit_contacts=: (bool) -> bool
+
+        attr_reader inherit_tcr_brand: bool?
+
+        def inherit_tcr_brand=: (bool) -> bool
+
+        attr_reader inherit_tcr_campaign: bool?
+
+        def inherit_tcr_campaign=: (bool) -> bool
+
+        attr_reader inherit_templates: bool?
+
+        def inherit_templates=: (bool) -> bool
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_accessor organization_id: String?
+
+        attr_accessor sending_phone_number: String?
+
+        attr_accessor sending_phone_number_profile_id: String?
+
+        attr_accessor sending_whatsapp_number_profile_id: String?
+
+        attr_accessor short_name: String?
+
+        attr_reader status: String?
+
+        def status=: (String) -> String
+
+        attr_accessor updated_at: Time?
+
+        attr_accessor waba_id: String?
+
+        attr_accessor whatsapp_phone_number: String?
+
+        def initialize: (
+          ?id: String,
+          ?allow_contact_sharing: bool,
+          ?allow_number_change_during_onboarding: bool?,
+          ?allow_template_sharing: bool,
+          ?billing_contact: Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact?,
+          ?billing_model: String,
+          ?brand: Sentdm::Models::ProfileRetrieveResponse::Data::Brand?,
+          ?created_at: Time,
+          ?description: String?,
+          ?email: String?,
+          ?icon: String?,
+          ?inherit_contacts: bool,
+          ?inherit_tcr_brand: bool,
+          ?inherit_tcr_campaign: bool,
+          ?inherit_templates: bool,
+          ?name: String,
+          ?organization_id: String?,
+          ?sending_phone_number: String?,
+          ?sending_phone_number_profile_id: String?,
+          ?sending_whatsapp_number_profile_id: String?,
+          ?short_name: String?,
+          ?status: String,
+          ?updated_at: Time?,
+          ?waba_id: String?,
+          ?whatsapp_phone_number: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          allow_contact_sharing: bool,
+          allow_number_change_during_onboarding: bool?,
+          allow_template_sharing: bool,
+          billing_contact: Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact?,
+          billing_model: String,
+          brand: Sentdm::Models::ProfileRetrieveResponse::Data::Brand?,
+          created_at: Time,
+          description: String?,
+          email: String?,
+          icon: String?,
+          inherit_contacts: bool,
+          inherit_tcr_brand: bool,
+          inherit_tcr_campaign: bool,
+          inherit_templates: bool,
+          name: String,
+          organization_id: String?,
+          sending_phone_number: String?,
+          sending_phone_number_profile_id: String?,
+          sending_whatsapp_number_profile_id: String?,
+          short_name: String?,
+          status: String,
+          updated_at: Time?,
+          waba_id: String?,
+          whatsapp_phone_number: String?
+        }
+
+        type billing_contact =
+          { address: String?, email: String?, name: String?, phone: String? }
+
+        class BillingContact < Sentdm::Internal::Type::BaseModel
+          attr_accessor address: String?
+
+          attr_accessor email: String?
+
+          attr_accessor name: String?
+
+          attr_accessor phone: String?
+
+          def initialize: (
+            ?address: String?,
+            ?email: String?,
+            ?name: String?,
+            ?phone: String?
+          ) -> void
+
+          def to_hash: -> {
+            address: String?,
+            email: String?,
+            name: String?,
+            phone: String?
+          }
+        end
+
+        type brand =
+          {
+            id: String,
+            business: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business?,
+            compliance: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance?,
+            contact: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact?,
+            created_at: Time,
+            csp_id: String?,
+            identity_status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::identity_status?,
+            is_inherited: bool,
+            status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::status?,
+            submitted_at: Time?,
+            submitted_to_tcr: bool,
+            tcr_brand_id: String?,
+            universal_ein: String?,
+            updated_at: Time?
+          }
+
+        class Brand < Sentdm::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_accessor business: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business?
+
+          attr_accessor compliance: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance?
+
+          attr_accessor contact: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact?
+
+          attr_reader created_at: Time?
+
+          def created_at=: (Time) -> Time
+
+          attr_accessor csp_id: String?
+
+          attr_accessor identity_status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::identity_status?
+
+          attr_reader is_inherited: bool?
+
+          def is_inherited=: (bool) -> bool
+
+          attr_accessor status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::status?
+
+          attr_accessor submitted_at: Time?
+
+          attr_reader submitted_to_tcr: bool?
+
+          def submitted_to_tcr=: (bool) -> bool
+
+          attr_accessor tcr_brand_id: String?
+
+          attr_accessor universal_ein: String?
+
+          attr_accessor updated_at: Time?
+
+          def initialize: (
+            ?id: String,
+            ?business: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business?,
+            ?compliance: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance?,
+            ?contact: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact?,
+            ?created_at: Time,
+            ?csp_id: String?,
+            ?identity_status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::identity_status?,
+            ?is_inherited: bool,
+            ?status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::status?,
+            ?submitted_at: Time?,
+            ?submitted_to_tcr: bool,
+            ?tcr_brand_id: String?,
+            ?universal_ein: String?,
+            ?updated_at: Time?
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            business: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business?,
+            compliance: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance?,
+            contact: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact?,
+            created_at: Time,
+            csp_id: String?,
+            identity_status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::identity_status?,
+            is_inherited: bool,
+            status: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::status?,
+            submitted_at: Time?,
+            submitted_to_tcr: bool,
+            tcr_brand_id: String?,
+            universal_ein: String?,
+            updated_at: Time?
+          }
+
+          type business =
+            {
+              city: String?,
+              country: String?,
+              country_of_registration: String?,
+              entity_type: String?,
+              legal_name: String?,
+              postal_code: String?,
+              state: String?,
+              street: String?,
+              tax_id: String?,
+              tax_id_type: String?,
+              url: String?
+            }
+
+          class Business < Sentdm::Internal::Type::BaseModel
+            attr_accessor city: String?
+
+            attr_accessor country: String?
+
+            attr_accessor country_of_registration: String?
+
+            attr_accessor entity_type: String?
+
+            attr_accessor legal_name: String?
+
+            attr_accessor postal_code: String?
+
+            attr_accessor state: String?
+
+            attr_accessor street: String?
+
+            attr_accessor tax_id: String?
+
+            attr_accessor tax_id_type: String?
+
+            attr_accessor url: String?
+
+            def initialize: (
+              ?city: String?,
+              ?country: String?,
+              ?country_of_registration: String?,
+              ?entity_type: String?,
+              ?legal_name: String?,
+              ?postal_code: String?,
+              ?state: String?,
+              ?street: String?,
+              ?tax_id: String?,
+              ?tax_id_type: String?,
+              ?url: String?
+            ) -> void
+
+            def to_hash: -> {
+              city: String?,
+              country: String?,
+              country_of_registration: String?,
+              entity_type: String?,
+              legal_name: String?,
+              postal_code: String?,
+              state: String?,
+              street: String?,
+              tax_id: String?,
+              tax_id_type: String?,
+              url: String?
+            }
+          end
+
+          type compliance =
+            {
+              brand_relationship: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::brand_relationship?,
+              destination_countries: ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry],
+              expected_messaging_volume: String?,
+              is_tcr_application: bool,
+              notes: String?,
+              phone_number_prefix: String?,
+              primary_use_case: String?,
+              vertical: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::vertical?
+            }
+
+          class Compliance < Sentdm::Internal::Type::BaseModel
+            attr_accessor brand_relationship: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::brand_relationship?
+
+            attr_reader destination_countries: ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry]?
+
+            def destination_countries=: (
+              ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry]
+            ) -> ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry]
+
+            attr_accessor expected_messaging_volume: String?
+
+            attr_reader is_tcr_application: bool?
+
+            def is_tcr_application=: (bool) -> bool
+
+            attr_accessor notes: String?
+
+            attr_accessor phone_number_prefix: String?
+
+            attr_accessor primary_use_case: String?
+
+            attr_accessor vertical: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::vertical?
+
+            def initialize: (
+              ?brand_relationship: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::brand_relationship?,
+              ?destination_countries: ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry],
+              ?expected_messaging_volume: String?,
+              ?is_tcr_application: bool,
+              ?notes: String?,
+              ?phone_number_prefix: String?,
+              ?primary_use_case: String?,
+              ?vertical: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::vertical?
+            ) -> void
+
+            def to_hash: -> {
+              brand_relationship: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::brand_relationship?,
+              destination_countries: ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry],
+              expected_messaging_volume: String?,
+              is_tcr_application: bool,
+              notes: String?,
+              phone_number_prefix: String?,
+              primary_use_case: String?,
+              vertical: Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::vertical?
+            }
+
+            type brand_relationship =
+              :BASIC_ACCOUNT
+              | :MEDIUM_ACCOUNT
+              | :LARGE_ACCOUNT
+              | :SMALL_ACCOUNT
+              | :KEY_ACCOUNT
+
+            module BrandRelationship
+              extend Sentdm::Internal::Type::Enum
+
+              BASIC_ACCOUNT: :BASIC_ACCOUNT
+              MEDIUM_ACCOUNT: :MEDIUM_ACCOUNT
+              LARGE_ACCOUNT: :LARGE_ACCOUNT
+              SMALL_ACCOUNT: :SMALL_ACCOUNT
+              KEY_ACCOUNT: :KEY_ACCOUNT
+
+              def self?.values: -> ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::brand_relationship]
+            end
+
+            type destination_country = { id: String, is_main: bool }
+
+            class DestinationCountry < Sentdm::Internal::Type::BaseModel
+              attr_reader id: String?
+
+              def id=: (String) -> String
+
+              attr_reader is_main: bool?
+
+              def is_main=: (bool) -> bool
+
+              def initialize: (?id: String, ?is_main: bool) -> void
+
+              def to_hash: -> { id: String, is_main: bool }
+            end
+
+            type vertical =
+              :PROFESSIONAL
+              | :REAL_ESTATE
+              | :HEALTHCARE
+              | :HUMAN_RESOURCES
+              | :ENERGY
+              | :ENTERTAINMENT
+              | :RETAIL
+              | :TRANSPORTATION
+              | :AGRICULTURE
+              | :INSURANCE
+              | :POSTAL
+              | :EDUCATION
+              | :HOSPITALITY
+              | :FINANCIAL
+              | :POLITICAL
+              | :GAMBLING
+              | :LEGAL
+              | :CONSTRUCTION
+              | :NGO
+              | :MANUFACTURING
+              | :GOVERNMENT
+              | :TECHNOLOGY
+              | :COMMUNICATION
+
+            module Vertical
+              extend Sentdm::Internal::Type::Enum
+
+              PROFESSIONAL: :PROFESSIONAL
+              REAL_ESTATE: :REAL_ESTATE
+              HEALTHCARE: :HEALTHCARE
+              HUMAN_RESOURCES: :HUMAN_RESOURCES
+              ENERGY: :ENERGY
+              ENTERTAINMENT: :ENTERTAINMENT
+              RETAIL: :RETAIL
+              TRANSPORTATION: :TRANSPORTATION
+              AGRICULTURE: :AGRICULTURE
+              INSURANCE: :INSURANCE
+              POSTAL: :POSTAL
+              EDUCATION: :EDUCATION
+              HOSPITALITY: :HOSPITALITY
+              FINANCIAL: :FINANCIAL
+              POLITICAL: :POLITICAL
+              GAMBLING: :GAMBLING
+              LEGAL: :LEGAL
+              CONSTRUCTION: :CONSTRUCTION
+              NGO: :NGO
+              MANUFACTURING: :MANUFACTURING
+              GOVERNMENT: :GOVERNMENT
+              TECHNOLOGY: :TECHNOLOGY
+              COMMUNICATION: :COMMUNICATION
+
+              def self?.values: -> ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::vertical]
+            end
+          end
+
+          type contact =
+            {
+              business_name: String?,
+              email: String?,
+              name: String,
+              phone: String?,
+              phone_country_code: String?,
+              role: String?
+            }
+
+          class Contact < Sentdm::Internal::Type::BaseModel
+            attr_accessor business_name: String?
+
+            attr_accessor email: String?
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            attr_accessor phone: String?
+
+            attr_accessor phone_country_code: String?
+
+            attr_accessor role: String?
+
+            def initialize: (
+              ?business_name: String?,
+              ?email: String?,
+              ?name: String,
+              ?phone: String?,
+              ?phone_country_code: String?,
+              ?role: String?
+            ) -> void
+
+            def to_hash: -> {
+              business_name: String?,
+              email: String?,
+              name: String,
+              phone: String?,
+              phone_country_code: String?,
+              role: String?
+            }
+          end
+
+          type identity_status =
+            :SELF_DECLARED | :UNVERIFIED | :VERIFIED | :VETTED_VERIFIED
+
+          module IdentityStatus
+            extend Sentdm::Internal::Type::Enum
+
+            SELF_DECLARED: :SELF_DECLARED
+            UNVERIFIED: :UNVERIFIED
+            VERIFIED: :VERIFIED
+            VETTED_VERIFIED: :VETTED_VERIFIED
+
+            def self?.values: -> ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::identity_status]
+          end
+
+          type status = :ACTIVE | :INACTIVE | :SUSPENDED
+
+          module Status
+            extend Sentdm::Internal::Type::Enum
+
+            ACTIVE: :ACTIVE
+            INACTIVE: :INACTIVE
+            SUSPENDED: :SUSPENDED
+
+            def self?.values: -> ::Array[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::status]
+          end
+        end
+      end
+
+      type error =
+        {
+          code: String,
+          details: ::Hash[Symbol, ::Array[String]]?,
+          doc_url: String?,
+          message: String
+        }
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        attr_reader code: String?
+
+        def code=: (String) -> String
+
+        attr_accessor details: ::Hash[Symbol, ::Array[String]]?
+
+        attr_accessor doc_url: String?
+
+        attr_reader message: String?
+
+        def message=: (String) -> String
+
+        def initialize: (
+          ?code: String,
+          ?details: ::Hash[Symbol, ::Array[String]]?,
+          ?doc_url: String?,
+          ?message: String
+        ) -> void
+
+        def to_hash: -> {
+          code: String,
+          details: ::Hash[Symbol, ::Array[String]]?,
+          doc_url: String?,
+          message: String
+        }
+      end
+
+      type meta = { request_id: String, timestamp: Time, version: String }
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        attr_reader request_id: String?
+
+        def request_id=: (String) -> String
+
+        attr_reader timestamp: Time?
+
+        def timestamp=: (Time) -> Time
+
+        attr_reader version: String?
+
+        def version=: (String) -> String
+
+        def initialize: (
+          ?request_id: String,
+          ?timestamp: Time,
+          ?version: String
+        ) -> void
+
+        def to_hash: -> { request_id: String, timestamp: Time, version: String }
+      end
+    end
+  end
+end