sentdm 0.2.0 → 0.3.1

data/sig/sentdm/models/brands/campaign_data.rbs

@@ -0,0 +1,82 @@
+module Sentdm
+  module Models
+    module Brands
+      type campaign_data =
+        {
+          description: String,
+          name: String,
+          type: String,
+          use_cases: ::Array[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData],
+          help_keywords: String?,
+          help_message: String?,
+          message_flow: String?,
+          optin_keywords: String?,
+          optin_message: String?,
+          optout_keywords: String?,
+          optout_message: String?,
+          privacy_policy_link: String?,
+          terms_and_conditions_link: String?
+        }
+
+      class CampaignData < Sentdm::Internal::Type::BaseModel
+        attr_accessor description: String
+
+        attr_accessor name: String
+
+        attr_accessor type: String
+
+        attr_accessor use_cases: ::Array[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData]
+
+        attr_accessor help_keywords: String?
+
+        attr_accessor help_message: String?
+
+        attr_accessor message_flow: String?
+
+        attr_accessor optin_keywords: String?
+
+        attr_accessor optin_message: String?
+
+        attr_accessor optout_keywords: String?
+
+        attr_accessor optout_message: String?
+
+        attr_accessor privacy_policy_link: String?
+
+        attr_accessor terms_and_conditions_link: String?
+
+        def initialize: (
+          description: String,
+          name: String,
+          type: String,
+          use_cases: ::Array[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData],
+          ?help_keywords: String?,
+          ?help_message: String?,
+          ?message_flow: String?,
+          ?optin_keywords: String?,
+          ?optin_message: String?,
+          ?optout_keywords: String?,
+          ?optout_message: String?,
+          ?privacy_policy_link: String?,
+          ?terms_and_conditions_link: String?
+        ) -> void
+
+        def to_hash: -> {
+          description: String,
+          name: String,
+          type: String,
+          use_cases: ::Array[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData],
+          help_keywords: String?,
+          help_message: String?,
+          message_flow: String?,
+          optin_keywords: String?,
+          optin_message: String?,
+          optout_keywords: String?,
+          optout_message: String?,
+          privacy_policy_link: String?,
+          terms_and_conditions_link: String?
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/campaign_delete_params.rbs

@@ -0,0 +1,46 @@
+module Sentdm
+  module Models
+    module Brands
+      type campaign_delete_params =
+        {
+          brand_id: String,
+          campaign_id: String,
+          body: Sentdm::Brands::CampaignDeleteParams::Body
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor brand_id: String
+
+        attr_accessor campaign_id: String
+
+        attr_accessor body: Sentdm::Brands::CampaignDeleteParams::Body
+
+        def initialize: (
+          brand_id: String,
+          campaign_id: String,
+          body: Sentdm::Brands::CampaignDeleteParams::Body,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          campaign_id: String,
+          body: Sentdm::Brands::CampaignDeleteParams::Body,
+          request_options: Sentdm::RequestOptions
+        }
+
+        type body = {  }
+
+        class Body < Sentdm::Models::MutationRequest
+          def initialize: -> void
+
+          def to_hash: -> {  }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/campaign_list_params.rbs

@@ -0,0 +1,25 @@
+module Sentdm
+  module Models
+    module Brands
+      type campaign_list_params =
+        { brand_id: String } & Sentdm::Internal::Type::request_parameters
+
+      class CampaignListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor brand_id: String
+
+        def initialize: (
+          brand_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/campaign_list_response.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Models
+    module Brands
+      type campaign_list_response =
+        {
+          data: ::Array[Sentdm::Brands::TcrCampaignWithUseCases]?,
+          error: Sentdm::APIError?,
+          meta: Sentdm::APIMeta,
+          success: bool
+        }
+
+      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+        attr_accessor data: ::Array[Sentdm::Brands::TcrCampaignWithUseCases]?
+
+        attr_accessor error: Sentdm::APIError?
+
+        attr_reader meta: Sentdm::APIMeta?
+
+        def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
+
+        attr_reader success: bool?
+
+        def success=: (bool) -> bool
+
+        def initialize: (
+          ?data: ::Array[Sentdm::Brands::TcrCampaignWithUseCases]?,
+          ?error: Sentdm::APIError?,
+          ?meta: Sentdm::APIMeta,
+          ?success: bool
+        ) -> void
+
+        def to_hash: -> {
+          data: ::Array[Sentdm::Brands::TcrCampaignWithUseCases]?,
+          error: Sentdm::APIError?,
+          meta: Sentdm::APIMeta,
+          success: bool
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/campaign_update_params.rbs

@@ -0,0 +1,52 @@
+module Sentdm
+  module Models
+    module Brands
+      type campaign_update_params =
+        {
+          brand_id: String,
+          campaign_id: String,
+          campaign: Sentdm::Brands::CampaignData,
+          test_mode: bool,
+          idempotency_key: String
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class CampaignUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor brand_id: String
+
+        attr_accessor campaign_id: String
+
+        attr_accessor campaign: Sentdm::Brands::CampaignData
+
+        attr_reader test_mode: bool?
+
+        def test_mode=: (bool) -> bool
+
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
+        def initialize: (
+          brand_id: String,
+          campaign_id: String,
+          campaign: Sentdm::Brands::CampaignData,
+          ?test_mode: bool,
+          ?idempotency_key: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          campaign_id: String,
+          campaign: Sentdm::Brands::CampaignData,
+          test_mode: bool,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/messaging_use_case_us.rbs

@@ -0,0 +1,40 @@
+module Sentdm
+  module Models
+    module Brands
+      type messaging_use_case_us =
+        :MARKETING
+        | :ACCOUNT_NOTIFICATION
+        | :CUSTOMER_CARE
+        | :FRAUD_ALERT
+        | :TWO_FA
+        | :DELIVERY_NOTIFICATION
+        | :SECURITY_ALERT
+        | :M2M
+        | :MIXED
+        | :HIGHER_EDUCATION
+        | :POLLING_VOTING
+        | :PUBLIC_SERVICE_ANNOUNCEMENT
+        | :LOW_VOLUME
+
+      module MessagingUseCaseUs
+        extend Sentdm::Internal::Type::Enum
+
+        MARKETING: :MARKETING
+        ACCOUNT_NOTIFICATION: :ACCOUNT_NOTIFICATION
+        CUSTOMER_CARE: :CUSTOMER_CARE
+        FRAUD_ALERT: :FRAUD_ALERT
+        TWO_FA: :TWO_FA
+        DELIVERY_NOTIFICATION: :DELIVERY_NOTIFICATION
+        SECURITY_ALERT: :SECURITY_ALERT
+        M2_M: :M2M
+        MIXED: :MIXED
+        HIGHER_EDUCATION: :HIGHER_EDUCATION
+        POLLING_VOTING: :POLLING_VOTING
+        PUBLIC_SERVICE_ANNOUNCEMENT: :PUBLIC_SERVICE_ANNOUNCEMENT
+        LOW_VOLUME: :LOW_VOLUME
+
+        def self?.values: -> ::Array[Sentdm::Models::Brands::messaging_use_case_us]
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs

@@ -0,0 +1,27 @@
+module Sentdm
+  module Models
+    module Brands
+      type sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data =
+        {
+          messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us,
+          sample_messages: ::Array[String]
+        }
+
+      class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+        attr_accessor messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us
+
+        attr_accessor sample_messages: ::Array[String]
+
+        def initialize: (
+          messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us,
+          sample_messages: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us,
+          sample_messages: ::Array[String]
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/brands/tcr_campaign_with_use_cases.rbs

@@ -0,0 +1,285 @@
+module Sentdm
+  module Models
+    module Brands
+      type tcr_campaign_with_use_cases =
+        {
+          billed_date: Time?,
+          brand_id: String?,
+          cost: Float?,
+          csp_id: String?,
+          customer_id: String,
+          description: String,
+          help_keywords: String?,
+          help_message: String?,
+          kyc_submission_form_id: String?,
+          message_flow: String?,
+          name: String,
+          optin_keywords: String?,
+          optin_message: String?,
+          optout_keywords: String?,
+          optout_message: String?,
+          privacy_policy_link: String?,
+          reseller_id: String?,
+          sharing_status: Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status?,
+          status: Sentdm::Models::Brands::TcrCampaignWithUseCases::status?,
+          submitted_at: Time?,
+          submitted_to_tcr: bool,
+          tcr_campaign_id: String?,
+          tcr_sync_error: String?,
+          telnyx_campaign_id: String?,
+          terms_and_conditions_link: String?,
+          type: String,
+          upstream_cnp_id: String?,
+          use_cases: ::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]
+        }
+
+      class TcrCampaignWithUseCases < Sentdm::Models::Brands::BaseDto
+        def billed_date: -> Time?
+
+        def billed_date=: (Time? _) -> Time?
+
+        def brand_id: -> String?
+
+        def brand_id=: (String? _) -> String?
+
+        def cost: -> Float?
+
+        def cost=: (Float? _) -> Float?
+
+        def csp_id: -> String?
+
+        def csp_id=: (String? _) -> String?
+
+        def customer_id: -> String?
+
+        def customer_id=: (String _) -> String
+
+        def description: -> String?
+
+        def description=: (String _) -> String
+
+        def help_keywords: -> String?
+
+        def help_keywords=: (String? _) -> String?
+
+        def help_message: -> String?
+
+        def help_message=: (String? _) -> String?
+
+        def kyc_submission_form_id: -> String?
+
+        def kyc_submission_form_id=: (String? _) -> String?
+
+        def message_flow: -> String?
+
+        def message_flow=: (String? _) -> String?
+
+        def name: -> String?
+
+        def name=: (String _) -> String
+
+        def optin_keywords: -> String?
+
+        def optin_keywords=: (String? _) -> String?
+
+        def optin_message: -> String?
+
+        def optin_message=: (String? _) -> String?
+
+        def optout_keywords: -> String?
+
+        def optout_keywords=: (String? _) -> String?
+
+        def optout_message: -> String?
+
+        def optout_message=: (String? _) -> String?
+
+        def privacy_policy_link: -> String?
+
+        def privacy_policy_link=: (String? _) -> String?
+
+        def reseller_id: -> String?
+
+        def reseller_id=: (String? _) -> String?
+
+        def sharing_status: -> Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status?
+
+        def sharing_status=: (
+          Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status? _
+        ) -> Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status?
+
+        def status: -> Sentdm::Models::Brands::TcrCampaignWithUseCases::status?
+
+        def status=: (
+          Sentdm::Models::Brands::TcrCampaignWithUseCases::status? _
+        ) -> Sentdm::Models::Brands::TcrCampaignWithUseCases::status?
+
+        def submitted_at: -> Time?
+
+        def submitted_at=: (Time? _) -> Time?
+
+        def submitted_to_tcr: -> bool?
+
+        def submitted_to_tcr=: (bool _) -> bool
+
+        def tcr_campaign_id: -> String?
+
+        def tcr_campaign_id=: (String? _) -> String?
+
+        def tcr_sync_error: -> String?
+
+        def tcr_sync_error=: (String? _) -> String?
+
+        def telnyx_campaign_id: -> String?
+
+        def telnyx_campaign_id=: (String? _) -> String?
+
+        def terms_and_conditions_link: -> String?
+
+        def terms_and_conditions_link=: (String? _) -> String?
+
+        def `type`: -> String?
+
+        def type=: (String _) -> String
+
+        def upstream_cnp_id: -> String?
+
+        def upstream_cnp_id=: (String? _) -> String?
+
+        def use_cases: -> ::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]?
+
+        def use_cases=: (
+          ::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase] _
+        ) -> ::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]
+
+        def initialize: (
+          ?billed_date: Time?,
+          ?brand_id: String?,
+          ?cost: Float?,
+          ?csp_id: String?,
+          ?customer_id: String,
+          ?description: String,
+          ?help_keywords: String?,
+          ?help_message: String?,
+          ?kyc_submission_form_id: String?,
+          ?message_flow: String?,
+          ?name: String,
+          ?optin_keywords: String?,
+          ?optin_message: String?,
+          ?optout_keywords: String?,
+          ?optout_message: String?,
+          ?privacy_policy_link: String?,
+          ?reseller_id: String?,
+          ?sharing_status: Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status?,
+          ?status: Sentdm::Models::Brands::TcrCampaignWithUseCases::status?,
+          ?submitted_at: Time?,
+          ?submitted_to_tcr: bool,
+          ?tcr_campaign_id: String?,
+          ?tcr_sync_error: String?,
+          ?telnyx_campaign_id: String?,
+          ?terms_and_conditions_link: String?,
+          ?type: String,
+          ?upstream_cnp_id: String?,
+          ?use_cases: ::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]
+        ) -> void
+
+        def to_hash: -> {
+          billed_date: Time?,
+          brand_id: String?,
+          cost: Float?,
+          csp_id: String?,
+          customer_id: String,
+          description: String,
+          help_keywords: String?,
+          help_message: String?,
+          kyc_submission_form_id: String?,
+          message_flow: String?,
+          name: String,
+          optin_keywords: String?,
+          optin_message: String?,
+          optout_keywords: String?,
+          optout_message: String?,
+          privacy_policy_link: String?,
+          reseller_id: String?,
+          sharing_status: Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status?,
+          status: Sentdm::Models::Brands::TcrCampaignWithUseCases::status?,
+          submitted_at: Time?,
+          submitted_to_tcr: bool,
+          tcr_campaign_id: String?,
+          tcr_sync_error: String?,
+          telnyx_campaign_id: String?,
+          terms_and_conditions_link: String?,
+          type: String,
+          upstream_cnp_id: String?,
+          use_cases: ::Array[Sentdm::Brands::TcrCampaignWithUseCases::UseCase]
+        }
+
+        type sharing_status = :PENDING | :ACCEPTED | :DECLINED
+
+        module SharingStatus
+          extend Sentdm::Internal::Type::Enum
+
+          PENDING: :PENDING
+          ACCEPTED: :ACCEPTED
+          DECLINED: :DECLINED
+
+          def self?.values: -> ::Array[Sentdm::Models::Brands::TcrCampaignWithUseCases::sharing_status]
+        end
+
+        type status = :SENT_CREATED | :ACTIVE | :EXPIRED
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          SENT_CREATED: :SENT_CREATED
+          ACTIVE: :ACTIVE
+          EXPIRED: :EXPIRED
+
+          def self?.values: -> ::Array[Sentdm::Models::Brands::TcrCampaignWithUseCases::status]
+        end
+
+        type use_case =
+          {
+            campaign_id: String,
+            customer_id: String,
+            messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us,
+            sample_messages: ::Array[String]
+          }
+
+        class UseCase < Sentdm::Models::Brands::BaseDto
+          def campaign_id: -> String?
+
+          def campaign_id=: (String _) -> String
+
+          def customer_id: -> String?
+
+          def customer_id=: (String _) -> String
+
+          def messaging_use_case_us: -> Sentdm::Models::Brands::messaging_use_case_us?
+
+          def messaging_use_case_us=: (
+            Sentdm::Models::Brands::messaging_use_case_us _
+          ) -> Sentdm::Models::Brands::messaging_use_case_us
+
+          def sample_messages: -> ::Array[String]?
+
+          def sample_messages=: (::Array[String] _) -> ::Array[String]
+
+          def initialize: (
+            ?campaign_id: String,
+            ?customer_id: String,
+            ?messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us,
+            ?sample_messages: ::Array[String]
+          ) -> void
+
+          def to_hash: -> {
+            campaign_id: String,
+            customer_id: String,
+            messaging_use_case_us: Sentdm::Models::Brands::messaging_use_case_us,
+            sample_messages: ::Array[String]
+          }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/{contact_list_item.rbs → contact.rbs}

@@ -1,20 +1,24 @@
 module Sentdm
   module Models
-    type contact_list_item =
+    type contact =
       {
         id: String,
         available_channels: String,
         country_code: String,
+        created_at: Time,
         default_channel: String,
         :format_e164 => String,
         format_international: String,
         format_national: String,
         format_rfc: String,
+        is_inherited: bool,
+        opt_out: bool,
         phone_number: String,
-        region_code: String
+        region_code: String,
+        updated_at: Time?
       }
 
-    class ContactListItem < Sentdm::Internal::Type::BaseModel
+    class Contact < Sentdm::Internal::Type::BaseModel
       attr_reader id: String?
 
       def id=: (String) -> String
@@ -27,6 +31,10 @@ module Sentdm
 
       def country_code=: (String) -> String
 
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
       attr_reader default_channel: String?
 
       def default_channel=: (String) -> String
@@ -47,6 +55,14 @@ module Sentdm
 
       def format_rfc=: (String) -> String
 
+      attr_reader is_inherited: bool?
+
+      def is_inherited=: (bool) -> bool
+
+      attr_reader opt_out: bool?
+
+      def opt_out=: (bool) -> bool
+
       attr_reader phone_number: String?
 
       def phone_number=: (String) -> String
@@ -55,30 +71,40 @@ module Sentdm
 
       def region_code=: (String) -> String
 
+      attr_accessor updated_at: Time?
+
       def initialize: (
         ?id: String,
         ?available_channels: String,
         ?country_code: String,
+        ?created_at: Time,
         ?default_channel: String,
         ?format_e164: String,
         ?format_international: String,
         ?format_national: String,
         ?format_rfc: String,
+        ?is_inherited: bool,
+        ?opt_out: bool,
         ?phone_number: String,
-        ?region_code: String
+        ?region_code: String,
+        ?updated_at: Time?
       ) -> void
 
       def to_hash: -> {
         id: String,
         available_channels: String,
         country_code: String,
+        created_at: Time,
         default_channel: String,
         :format_e164 => String,
         format_international: String,
         format_national: String,
         format_rfc: String,
+        is_inherited: bool,
+        opt_out: bool,
         phone_number: String,
-        region_code: String
+        region_code: String,
+        updated_at: Time?
       }
     end
   end