surge_api 0.1.0

data/sig/surge_api/models/campaign.rbs

@@ -0,0 +1,122 @@
+module SurgeAPI
+  module Models
+    type campaign =
+      {
+        id: String,
+        consent_flow: String,
+        description: String,
+        includes: ::Array[SurgeAPI::Models::Campaign::include_],
+        message_samples: ::Array[String],
+        privacy_policy_url: String,
+        use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
+        volume: SurgeAPI::Models::Campaign::volume,
+        link_sample: String,
+        terms_and_conditions_url: String
+      }
+
+    class Campaign < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor consent_flow: String
+
+      attr_accessor description: String
+
+      attr_accessor includes: ::Array[SurgeAPI::Models::Campaign::include_]
+
+      attr_accessor message_samples: ::Array[String]
+
+      attr_accessor privacy_policy_url: String
+
+      attr_accessor use_cases: ::Array[SurgeAPI::Models::Campaign::use_case]
+
+      attr_accessor volume: SurgeAPI::Models::Campaign::volume
+
+      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: (
+        id: String,
+        consent_flow: String,
+        description: String,
+        includes: ::Array[SurgeAPI::Models::Campaign::include_],
+        message_samples: ::Array[String],
+        privacy_policy_url: String,
+        use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
+        volume: SurgeAPI::Models::Campaign::volume,
+        ?link_sample: String,
+        ?terms_and_conditions_url: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        consent_flow: String,
+        description: String,
+        includes: ::Array[SurgeAPI::Models::Campaign::include_],
+        message_samples: ::Array[String],
+        privacy_policy_url: String,
+        use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
+        volume: SurgeAPI::Models::Campaign::volume,
+        link_sample: String,
+        terms_and_conditions_url: String
+      }
+
+      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::Campaign::include_]
+      end
+
+      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::Campaign::use_case]
+      end
+
+      type volume = :high | :low
+
+      module Volume
+        extend SurgeAPI::Internal::Type::Enum
+
+        HIGH: :high
+        LOW: :low
+
+        def self?.values: -> ::Array[SurgeAPI::Models::Campaign::volume]
+      end
+    end
+  end
+end

data/sig/surge_api/models/campaign_approved_webhook_event.rbs

@@ -0,0 +1,67 @@
+module SurgeAPI
+  module Models
+    type campaign_approved_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::CampaignApprovedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"campaign.approved"
+      }
+
+    class CampaignApprovedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::CampaignApprovedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"campaign.approved"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::CampaignApprovedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"campaign.approved"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::CampaignApprovedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"campaign.approved"
+      }
+
+      type data =
+        {
+          id: String,
+          status: SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::status
+        }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor status: SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::status
+
+        def initialize: (
+          id: String,
+          status: SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::status
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          status: SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::status
+        }
+
+        type status = :active
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          ACTIVE: :active
+
+          def self?.values: -> ::Array[SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::status]
+        end
+      end
+    end
+  end
+end

data/sig/surge_api/models/campaign_create_params.rbs

@@ -0,0 +1,127 @@
+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
+      }
+      & 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
+
+      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 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,
+        ?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,
+        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/contact.rbs

@@ -0,0 +1,53 @@
+module SurgeAPI
+  module Models
+    type contact =
+      {
+        id: String,
+        phone_number: String,
+        email: String,
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String]
+      }
+
+    class Contact < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      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: (
+        id: String,
+        phone_number: String,
+        ?email: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        phone_number: String,
+        email: String,
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String]
+      }
+    end
+  end
+end

data/sig/surge_api/models/contact_create_params.rbs

@@ -0,0 +1,54 @@
+module SurgeAPI
+  module Models
+    type contact_create_params =
+      {
+        phone_number: String,
+        email: String,
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String]
+      }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class ContactCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      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],
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        phone_number: String,
+        email: String,
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String],
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/contact_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type contact_retrieve_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class ContactRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+    end
+  end
+end

data/sig/surge_api/models/contact_update_params.rbs

@@ -0,0 +1,54 @@
+module SurgeAPI
+  module Models
+    type contact_update_params =
+      {
+        phone_number: String,
+        email: String,
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String]
+      }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class ContactUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      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],
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        phone_number: String,
+        email: String,
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String],
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/conversation_created_webhook_event.rbs

@@ -0,0 +1,62 @@
+module SurgeAPI
+  module Models
+    type conversation_created_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::ConversationCreatedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"conversation.created"
+      }
+
+    class ConversationCreatedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::ConversationCreatedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"conversation.created"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::ConversationCreatedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"conversation.created"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::ConversationCreatedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"conversation.created"
+      }
+
+      type data =
+        {
+          id: String,
+          contact: SurgeAPI::Contact,
+          phone_number: SurgeAPI::PhoneNumber
+        }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor contact: SurgeAPI::Contact
+
+        attr_accessor phone_number: SurgeAPI::PhoneNumber
+
+        def initialize: (
+          id: String,
+          contact: SurgeAPI::Contact,
+          phone_number: SurgeAPI::PhoneNumber
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          contact: SurgeAPI::Contact,
+          phone_number: SurgeAPI::PhoneNumber
+        }
+      end
+    end
+  end
+end

data/sig/surge_api/models/error.rbs

@@ -0,0 +1,27 @@
+module SurgeAPI
+  module Models
+    type error = { message: String, type: String, detail: ::Hash[Symbol, top] }
+
+    class Error < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor message: String
+
+      attr_accessor type: String
+
+      attr_reader detail: ::Hash[Symbol, top]?
+
+      def detail=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      def initialize: (
+        message: String,
+        type: String,
+        ?detail: ::Hash[Symbol, top]
+      ) -> void
+
+      def to_hash: -> {
+        message: String,
+        type: String,
+        detail: ::Hash[Symbol, top]
+      }
+    end
+  end
+end