surge_api 0.1.0 → 0.2.1

data/sig/surge_api/models/campaign_create_params.rbs

@@ -1,127 +1,28 @@
 module SurgeAPI
   module Models
     type campaign_create_params =
-      {
-        consent_flow: String,
-        description: String,
-        message_samples: ::Array[String],
-        privacy_policy_url: String,
-        use_cases: ::Array[SurgeAPI::Models::CampaignCreateParams::use_case],
-        volume: SurgeAPI::Models::CampaignCreateParams::volume,
-        includes: ::Array[SurgeAPI::Models::CampaignCreateParams::include_],
-        link_sample: String,
-        terms_and_conditions_url: String
-      }
+      { campaign_params: SurgeAPI::Models::campaign_params }
       & SurgeAPI::Internal::Type::request_parameters
 
     class CampaignCreateParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      attr_accessor consent_flow: String
-
-      attr_accessor description: String
-
-      attr_accessor message_samples: ::Array[String]
-
-      attr_accessor privacy_policy_url: String
-
-      attr_accessor use_cases: ::Array[SurgeAPI::Models::CampaignCreateParams::use_case]
-
-      attr_accessor volume: SurgeAPI::Models::CampaignCreateParams::volume
+      def campaign_params: -> SurgeAPI::Models::campaign_params
 
-      attr_reader includes: ::Array[SurgeAPI::Models::CampaignCreateParams::include_]?
-
-      def includes=: (
-        ::Array[SurgeAPI::Models::CampaignCreateParams::include_]
-      ) -> ::Array[SurgeAPI::Models::CampaignCreateParams::include_]
-
-      attr_reader link_sample: String?
-
-      def link_sample=: (String) -> String
-
-      attr_reader terms_and_conditions_url: String?
-
-      def terms_and_conditions_url=: (String) -> String
+      def campaign_params=: (
+        SurgeAPI::Models::campaign_params _
+      ) -> SurgeAPI::Models::campaign_params
 
       def initialize: (
-        consent_flow: String,
-        description: String,
-        message_samples: ::Array[String],
-        privacy_policy_url: String,
-        use_cases: ::Array[SurgeAPI::Models::CampaignCreateParams::use_case],
-        volume: SurgeAPI::Models::CampaignCreateParams::volume,
-        ?includes: ::Array[SurgeAPI::Models::CampaignCreateParams::include_],
-        ?link_sample: String,
-        ?terms_and_conditions_url: String,
+        campaign_params: SurgeAPI::Models::campaign_params,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
-        consent_flow: String,
-        description: String,
-        message_samples: ::Array[String],
-        privacy_policy_url: String,
-        use_cases: ::Array[SurgeAPI::Models::CampaignCreateParams::use_case],
-        volume: SurgeAPI::Models::CampaignCreateParams::volume,
-        includes: ::Array[SurgeAPI::Models::CampaignCreateParams::include_],
-        link_sample: String,
-        terms_and_conditions_url: String,
+        campaign_params: SurgeAPI::Models::campaign_params,
         request_options: SurgeAPI::RequestOptions
       }
-
-      type use_case =
-        :account_notification
-        | :customer_care
-        | :delivery_notification
-        | :fraud_alert
-        | :higher_education
-        | :marketing
-        | :polling_voting
-        | :public_service_announcement
-        | :security_alert
-        | :two_factor_authentication
-
-      module UseCase
-        extend SurgeAPI::Internal::Type::Enum
-
-        ACCOUNT_NOTIFICATION: :account_notification
-        CUSTOMER_CARE: :customer_care
-        DELIVERY_NOTIFICATION: :delivery_notification
-        FRAUD_ALERT: :fraud_alert
-        HIGHER_EDUCATION: :higher_education
-        MARKETING: :marketing
-        POLLING_VOTING: :polling_voting
-        PUBLIC_SERVICE_ANNOUNCEMENT: :public_service_announcement
-        SECURITY_ALERT: :security_alert
-        TWO_FACTOR_AUTHENTICATION: :two_factor_authentication
-
-        def self?.values: -> ::Array[SurgeAPI::Models::CampaignCreateParams::use_case]
-      end
-
-      type volume = :high | :low
-
-      module Volume
-        extend SurgeAPI::Internal::Type::Enum
-
-        HIGH: :high
-        LOW: :low
-
-        def self?.values: -> ::Array[SurgeAPI::Models::CampaignCreateParams::volume]
-      end
-
-      type include_ = :links | :phone_numbers | :age_gated | :direct_lending
-
-      module Include
-        extend SurgeAPI::Internal::Type::Enum
-
-        LINKS: :links
-        PHONE_NUMBERS: :phone_numbers
-        AGE_GATED: :age_gated
-        DIRECT_LENDING: :direct_lending
-
-        def self?.values: -> ::Array[SurgeAPI::Models::CampaignCreateParams::include_]
-      end
     end
   end
 end

data/sig/surge_api/models/campaign_params.rbs

@@ -0,0 +1,141 @@
+module SurgeAPI
+  module Models
+    type campaign_params =
+      SurgeAPI::CampaignParams::StandardCampaignParams
+      | SurgeAPI::CampaignParams::ExternalCampaignParams
+
+    module CampaignParams
+      extend SurgeAPI::Internal::Type::Union
+
+      type standard_campaign_params =
+        {
+          consent_flow: String,
+          description: String,
+          message_samples: ::Array[String],
+          privacy_policy_url: String,
+          use_cases: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::use_case],
+          volume: SurgeAPI::Models::CampaignParams::StandardCampaignParams::volume,
+          includes: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_],
+          link_sample: String,
+          terms_and_conditions_url: String
+        }
+
+      class StandardCampaignParams < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor consent_flow: String
+
+        attr_accessor description: String
+
+        attr_accessor message_samples: ::Array[String]
+
+        attr_accessor privacy_policy_url: String
+
+        attr_accessor use_cases: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::use_case]
+
+        attr_accessor volume: SurgeAPI::Models::CampaignParams::StandardCampaignParams::volume
+
+        attr_reader includes: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_]?
+
+        def includes=: (
+          ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_]
+        ) -> ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_]
+
+        attr_reader link_sample: String?
+
+        def link_sample=: (String) -> String
+
+        attr_reader terms_and_conditions_url: String?
+
+        def terms_and_conditions_url=: (String) -> String
+
+        def initialize: (
+          consent_flow: String,
+          description: String,
+          message_samples: ::Array[String],
+          privacy_policy_url: String,
+          use_cases: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::use_case],
+          volume: SurgeAPI::Models::CampaignParams::StandardCampaignParams::volume,
+          ?includes: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_],
+          ?link_sample: String,
+          ?terms_and_conditions_url: String
+        ) -> void
+
+        def to_hash: -> {
+          consent_flow: String,
+          description: String,
+          message_samples: ::Array[String],
+          privacy_policy_url: String,
+          use_cases: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::use_case],
+          volume: SurgeAPI::Models::CampaignParams::StandardCampaignParams::volume,
+          includes: ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_],
+          link_sample: String,
+          terms_and_conditions_url: String
+        }
+
+        type use_case =
+          :account_notification
+          | :customer_care
+          | :delivery_notification
+          | :fraud_alert
+          | :higher_education
+          | :marketing
+          | :polling_voting
+          | :public_service_announcement
+          | :security_alert
+          | :two_factor_authentication
+
+        module UseCase
+          extend SurgeAPI::Internal::Type::Enum
+
+          ACCOUNT_NOTIFICATION: :account_notification
+          CUSTOMER_CARE: :customer_care
+          DELIVERY_NOTIFICATION: :delivery_notification
+          FRAUD_ALERT: :fraud_alert
+          HIGHER_EDUCATION: :higher_education
+          MARKETING: :marketing
+          POLLING_VOTING: :polling_voting
+          PUBLIC_SERVICE_ANNOUNCEMENT: :public_service_announcement
+          SECURITY_ALERT: :security_alert
+          TWO_FACTOR_AUTHENTICATION: :two_factor_authentication
+
+          def self?.values: -> ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::use_case]
+        end
+
+        type volume = :high | :low
+
+        module Volume
+          extend SurgeAPI::Internal::Type::Enum
+
+          HIGH: :high
+          LOW: :low
+
+          def self?.values: -> ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::volume]
+        end
+
+        type include_ = :links | :phone_numbers | :age_gated | :direct_lending
+
+        module Include
+          extend SurgeAPI::Internal::Type::Enum
+
+          LINKS: :links
+          PHONE_NUMBERS: :phone_numbers
+          AGE_GATED: :age_gated
+          DIRECT_LENDING: :direct_lending
+
+          def self?.values: -> ::Array[SurgeAPI::Models::CampaignParams::StandardCampaignParams::include_]
+        end
+      end
+
+      type external_campaign_params = { tcr_id: String }
+
+      class ExternalCampaignParams < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor tcr_id: String
+
+        def initialize: (tcr_id: String) -> void
+
+        def to_hash: -> { tcr_id: String }
+      end
+
+      def self?.variants: -> ::Array[SurgeAPI::Models::campaign_params]
+    end
+  end
+end

data/sig/surge_api/models/contact_opted_in_webhook_event.rbs

@@ -0,0 +1,45 @@
+module SurgeAPI
+  module Models
+    type contact_opted_in_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::ContactOptedInWebhookEvent::Data,
+        timestamp: Time,
+        type: :"contact.opted_in"
+      }
+
+    class ContactOptedInWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::ContactOptedInWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"contact.opted_in"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::ContactOptedInWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"contact.opted_in"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::ContactOptedInWebhookEvent::Data,
+        timestamp: Time,
+        type: :"contact.opted_in"
+      }
+
+      type data = { id: String }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> { id: String }
+      end
+    end
+  end
+end

data/sig/surge_api/models/contact_opted_out_webhook_event.rbs

@@ -0,0 +1,45 @@
+module SurgeAPI
+  module Models
+    type contact_opted_out_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::ContactOptedOutWebhookEvent::Data,
+        timestamp: Time,
+        type: :"contact.opted_out"
+      }
+
+    class ContactOptedOutWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::ContactOptedOutWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"contact.opted_out"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::ContactOptedOutWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"contact.opted_out"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::ContactOptedOutWebhookEvent::Data,
+        timestamp: Time,
+        type: :"contact.opted_out"
+      }
+
+      type data = { id: String }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> { id: String }
+      end
+    end
+  end
+end

data/sig/surge_api/models/message_create_params.rbs

@@ -1,140 +1,28 @@
 module SurgeAPI
   module Models
     type message_create_params =
-      {
-        conversation: SurgeAPI::MessageCreateParams::Conversation,
-        attachments: ::Array[SurgeAPI::MessageCreateParams::Attachment],
-        body: String,
-        send_at: Time,
-        to: String,
-        from: String
-      }
+      { message_params: SurgeAPI::Models::message_params }
       & SurgeAPI::Internal::Type::request_parameters
 
     class MessageCreateParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      attr_accessor conversation: SurgeAPI::MessageCreateParams::Conversation
-
-      attr_reader attachments: ::Array[SurgeAPI::MessageCreateParams::Attachment]?
-
-      def attachments=: (
-        ::Array[SurgeAPI::MessageCreateParams::Attachment]
-      ) -> ::Array[SurgeAPI::MessageCreateParams::Attachment]
-
-      attr_reader body: String?
-
-      def body=: (String) -> String
-
-      attr_reader send_at: Time?
-
-      def send_at=: (Time) -> Time
-
-      attr_accessor to: String
+      def message_params: -> SurgeAPI::Models::message_params
 
-      attr_reader from: String?
-
-      def from=: (String) -> String
+      def message_params=: (
+        SurgeAPI::Models::message_params _
+      ) -> SurgeAPI::Models::message_params
 
       def initialize: (
-        conversation: SurgeAPI::MessageCreateParams::Conversation,
-        to: String,
-        ?attachments: ::Array[SurgeAPI::MessageCreateParams::Attachment],
-        ?body: String,
-        ?send_at: Time,
-        ?from: String,
+        message_params: SurgeAPI::Models::message_params,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
-        conversation: SurgeAPI::MessageCreateParams::Conversation,
-        attachments: ::Array[SurgeAPI::MessageCreateParams::Attachment],
-        body: String,
-        send_at: Time,
-        to: String,
-        from: String,
+        message_params: SurgeAPI::Models::message_params,
         request_options: SurgeAPI::RequestOptions
       }
-
-      type conversation =
-        {
-          contact: SurgeAPI::MessageCreateParams::Conversation::Contact,
-          phone_number: String
-        }
-
-      class Conversation < SurgeAPI::Internal::Type::BaseModel
-        attr_accessor contact: SurgeAPI::MessageCreateParams::Conversation::Contact
-
-        attr_reader phone_number: String?
-
-        def phone_number=: (String) -> String
-
-        def initialize: (
-          contact: SurgeAPI::MessageCreateParams::Conversation::Contact,
-          ?phone_number: String
-        ) -> void
-
-        def to_hash: -> {
-          contact: SurgeAPI::MessageCreateParams::Conversation::Contact,
-          phone_number: String
-        }
-
-        type contact =
-          {
-            phone_number: String,
-            email: String,
-            first_name: String,
-            last_name: String,
-            metadata: ::Hash[Symbol, String]
-          }
-
-        class Contact < SurgeAPI::Internal::Type::BaseModel
-          attr_accessor phone_number: String
-
-          attr_reader email: String?
-
-          def email=: (String) -> String
-
-          attr_reader first_name: String?
-
-          def first_name=: (String) -> String
-
-          attr_reader last_name: String?
-
-          def last_name=: (String) -> String
-
-          attr_reader metadata: ::Hash[Symbol, String]?
-
-          def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
-
-          def initialize: (
-            phone_number: String,
-            ?email: String,
-            ?first_name: String,
-            ?last_name: String,
-            ?metadata: ::Hash[Symbol, String]
-          ) -> void
-
-          def to_hash: -> {
-            phone_number: String,
-            email: String,
-            first_name: String,
-            last_name: String,
-            metadata: ::Hash[Symbol, String]
-          }
-        end
-      end
-
-      type attachment = { url: String }
-
-      class Attachment < SurgeAPI::Internal::Type::BaseModel
-        attr_accessor url: String
-
-        def initialize: (url: String) -> void
-
-        def to_hash: -> { url: String }
-      end
     end
   end
 end

data/sig/surge_api/models/message_params.rbs

@@ -0,0 +1,189 @@
+module SurgeAPI
+  module Models
+    type message_params =
+      SurgeAPI::MessageParams::MessageParamsWithConversation
+      | SurgeAPI::MessageParams::SimpleMessageParams
+
+    module MessageParams
+      extend SurgeAPI::Internal::Type::Union
+
+      type message_params_with_conversation =
+        {
+          conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
+          attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
+          body: String,
+          send_at: Time
+        }
+
+      class MessageParamsWithConversation < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation
+
+        attr_reader attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment]?
+
+        def attachments=: (
+          ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment]
+        ) -> ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment]
+
+        attr_reader body: String?
+
+        def body=: (String) -> String
+
+        attr_reader send_at: Time?
+
+        def send_at=: (Time) -> Time
+
+        def initialize: (
+          conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
+          ?attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
+          ?body: String,
+          ?send_at: Time
+        ) -> void
+
+        def to_hash: -> {
+          conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
+          attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
+          body: String,
+          send_at: Time
+        }
+
+        type conversation =
+          {
+            contact: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact,
+            phone_number: String
+          }
+
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor contact: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact
+
+          attr_reader phone_number: String?
+
+          def phone_number=: (String) -> String
+
+          def initialize: (
+            contact: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact,
+            ?phone_number: String
+          ) -> void
+
+          def to_hash: -> {
+            contact: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact,
+            phone_number: String
+          }
+
+          type contact =
+            {
+              phone_number: String,
+              email: String,
+              first_name: String,
+              last_name: String,
+              metadata: ::Hash[Symbol, String]
+            }
+
+          class Contact < SurgeAPI::Internal::Type::BaseModel
+            attr_accessor phone_number: String
+
+            attr_reader email: String?
+
+            def email=: (String) -> String
+
+            attr_reader first_name: String?
+
+            def first_name=: (String) -> String
+
+            attr_reader last_name: String?
+
+            def last_name=: (String) -> String
+
+            attr_reader metadata: ::Hash[Symbol, String]?
+
+            def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+            def initialize: (
+              phone_number: String,
+              ?email: String,
+              ?first_name: String,
+              ?last_name: String,
+              ?metadata: ::Hash[Symbol, String]
+            ) -> void
+
+            def to_hash: -> {
+              phone_number: String,
+              email: String,
+              first_name: String,
+              last_name: String,
+              metadata: ::Hash[Symbol, String]
+            }
+          end
+        end
+
+        type attachment = { url: String }
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor url: String
+
+          def initialize: (url: String) -> void
+
+          def to_hash: -> { url: String }
+        end
+      end
+
+      type simple_message_params =
+        {
+          to: String,
+          attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
+          body: String,
+          from: String,
+          send_at: Time
+        }
+
+      class SimpleMessageParams < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor to: String
+
+        attr_reader attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment]?
+
+        def attachments=: (
+          ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment]
+        ) -> ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment]
+
+        attr_reader body: String?
+
+        def body=: (String) -> String
+
+        attr_reader from: String?
+
+        def from=: (String) -> String
+
+        attr_reader send_at: Time?
+
+        def send_at=: (Time) -> Time
+
+        def initialize: (
+          to: String,
+          ?attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
+          ?body: String,
+          ?from: String,
+          ?send_at: Time
+        ) -> void
+
+        def to_hash: -> {
+          to: String,
+          attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
+          body: String,
+          from: String,
+          send_at: Time
+        }
+
+        type attachment = { url: String }
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor url: String
+
+          def initialize: (url: String) -> void
+
+          def to_hash: -> { url: String }
+        end
+      end
+
+      def self?.variants: -> ::Array[SurgeAPI::Models::message_params]
+    end
+  end
+end