surge_api 0.1.0

data/sig/surge_api/models/user_create_params.rbs

@@ -0,0 +1,47 @@
+module SurgeAPI
+  module Models
+    type user_create_params =
+      {
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String],
+        photo_url: String
+      }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class UserCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_accessor first_name: 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]
+
+      attr_reader photo_url: String?
+
+      def photo_url=: (String) -> String
+
+      def initialize: (
+        first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String],
+        ?photo_url: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String],
+        photo_url: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/user_create_token_params.rbs

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

data/sig/surge_api/models/user_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type user_retrieve_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class UserRetrieveParams < 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/user_token_response.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type user_token_response = { token: String }
+
+    class UserTokenResponse < SurgeAPI::Internal::Type::BaseModel
+      attr_reader token: String?
+
+      def token=: (String) -> String
+
+      def initialize: (?token: String) -> void
+
+      def to_hash: -> { token: String }
+    end
+  end
+end

data/sig/surge_api/models/user_update_params.rbs

@@ -0,0 +1,47 @@
+module SurgeAPI
+  module Models
+    type user_update_params =
+      {
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String],
+        photo_url: String
+      }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class UserUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_accessor first_name: 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]
+
+      attr_reader photo_url: String?
+
+      def photo_url=: (String) -> String
+
+      def initialize: (
+        first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String],
+        ?photo_url: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        first_name: String,
+        last_name: String,
+        metadata: ::Hash[Symbol, String],
+        photo_url: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/verification.rbs

@@ -0,0 +1,48 @@
+module SurgeAPI
+  module Models
+    type verification =
+      {
+        id: String,
+        attempt_count: Integer,
+        phone_number: String,
+        status: SurgeAPI::Models::Verification::status
+      }
+
+    class Verification < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor attempt_count: Integer
+
+      attr_accessor phone_number: String
+
+      attr_accessor status: SurgeAPI::Models::Verification::status
+
+      def initialize: (
+        id: String,
+        attempt_count: Integer,
+        phone_number: String,
+        status: SurgeAPI::Models::Verification::status
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        attempt_count: Integer,
+        phone_number: String,
+        status: SurgeAPI::Models::Verification::status
+      }
+
+      type status = :pending | :verified | :exhausted | :expired
+
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        PENDING: :pending
+        VERIFIED: :verified
+        EXHAUSTED: :exhausted
+        EXPIRED: :expired
+
+        def self?.values: -> ::Array[SurgeAPI::Models::Verification::status]
+      end
+    end
+  end
+end

data/sig/surge_api/models/verification_check.rbs

@@ -0,0 +1,45 @@
+module SurgeAPI
+  module Models
+    type verification_check =
+      {
+        result: SurgeAPI::Models::VerificationCheck::result,
+        verification: SurgeAPI::Verification
+      }
+
+    class VerificationCheck < SurgeAPI::Internal::Type::BaseModel
+      attr_reader result: SurgeAPI::Models::VerificationCheck::result?
+
+      def result=: (
+        SurgeAPI::Models::VerificationCheck::result
+      ) -> SurgeAPI::Models::VerificationCheck::result
+
+      attr_reader verification: SurgeAPI::Verification?
+
+      def verification=: (SurgeAPI::Verification) -> SurgeAPI::Verification
+
+      def initialize: (
+        ?result: SurgeAPI::Models::VerificationCheck::result,
+        ?verification: SurgeAPI::Verification
+      ) -> void
+
+      def to_hash: -> {
+        result: SurgeAPI::Models::VerificationCheck::result,
+        verification: SurgeAPI::Verification
+      }
+
+      type result = :ok | :incorrect | :exhausted | :expired | :already_verified
+
+      module Result
+        extend SurgeAPI::Internal::Type::Enum
+
+        OK: :ok
+        INCORRECT: :incorrect
+        EXHAUSTED: :exhausted
+        EXPIRED: :expired
+        ALREADY_VERIFIED: :already_verified
+
+        def self?.values: -> ::Array[SurgeAPI::Models::VerificationCheck::result]
+      end
+    end
+  end
+end

data/sig/surge_api/models/verification_check_params.rbs

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

data/sig/surge_api/models/verification_create_params.rbs

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

data/sig/surge_api/models/webhook_unwrap_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type webhook_unwrap_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class WebhookUnwrapParams < 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.rbs

@@ -0,0 +1,77 @@
+module SurgeAPI
+  class Account = SurgeAPI::Models::Account
+
+  class AccountCreateParams = SurgeAPI::Models::AccountCreateParams
+
+  class AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
+
+  class AccountStatus = SurgeAPI::Models::AccountStatus
+
+  class AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
+
+  class Blast = SurgeAPI::Models::Blast
+
+  class BlastCreateParams = SurgeAPI::Models::BlastCreateParams
+
+  class CallEndedWebhookEvent = SurgeAPI::Models::CallEndedWebhookEvent
+
+  class Campaign = SurgeAPI::Models::Campaign
+
+  class CampaignApprovedWebhookEvent = SurgeAPI::Models::CampaignApprovedWebhookEvent
+
+  class CampaignCreateParams = SurgeAPI::Models::CampaignCreateParams
+
+  class Contact = SurgeAPI::Models::Contact
+
+  class ContactCreateParams = SurgeAPI::Models::ContactCreateParams
+
+  class ContactRetrieveParams = SurgeAPI::Models::ContactRetrieveParams
+
+  class ContactUpdateParams = SurgeAPI::Models::ContactUpdateParams
+
+  class ConversationCreatedWebhookEvent = SurgeAPI::Models::ConversationCreatedWebhookEvent
+
+  class Error = SurgeAPI::Models::Error
+
+  class Message = SurgeAPI::Models::Message
+
+  class MessageCreateParams = SurgeAPI::Models::MessageCreateParams
+
+  class MessageDeliveredWebhookEvent = SurgeAPI::Models::MessageDeliveredWebhookEvent
+
+  class MessageFailedWebhookEvent = SurgeAPI::Models::MessageFailedWebhookEvent
+
+  class MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
+
+  class MessageSentWebhookEvent = SurgeAPI::Models::MessageSentWebhookEvent
+
+  class Organization = SurgeAPI::Models::Organization
+
+  class PhoneNumber = SurgeAPI::Models::PhoneNumber
+
+  class PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
+
+  module UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
+
+  class User = SurgeAPI::Models::User
+
+  class UserCreateParams = SurgeAPI::Models::UserCreateParams
+
+  class UserCreateTokenParams = SurgeAPI::Models::UserCreateTokenParams
+
+  class UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
+
+  class UserTokenResponse = SurgeAPI::Models::UserTokenResponse
+
+  class UserUpdateParams = SurgeAPI::Models::UserUpdateParams
+
+  class Verification = SurgeAPI::Models::Verification
+
+  class VerificationCheck = SurgeAPI::Models::VerificationCheck
+
+  class VerificationCheckParams = SurgeAPI::Models::VerificationCheckParams
+
+  class VerificationCreateParams = SurgeAPI::Models::VerificationCreateParams
+
+  class WebhookUnwrapParams = SurgeAPI::Models::WebhookUnwrapParams
+end

data/sig/surge_api/request_options.rbs

@@ -0,0 +1,34 @@
+module SurgeAPI
+  type request_opts =
+    SurgeAPI::RequestOptions | SurgeAPI::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < SurgeAPI::Internal::Type::BaseModel
+    def self.validate!: (SurgeAPI::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?SurgeAPI::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/surge_api/resources/accounts.rbs

@@ -0,0 +1,30 @@
+module SurgeAPI
+  module Resources
+    class Accounts
+      def create: (
+        name: String,
+        ?brand_name: String?,
+        ?organization: SurgeAPI::AccountCreateParams::Organization,
+        ?time_zone: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Account
+
+      def update: (
+        String id,
+        ?brand_name: String,
+        ?name: String,
+        ?organization: SurgeAPI::AccountUpdateParams::Organization,
+        ?time_zone: String?,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Account
+
+      def retrieve_status: (
+        String account_id,
+        ?capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability],
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::AccountStatus
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/blasts.rbs

@@ -0,0 +1,19 @@
+module SurgeAPI
+  module Resources
+    class Blasts
+      def create: (
+        String account_id,
+        ?attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
+        ?body: String,
+        ?contacts: ::Array[String],
+        ?name: String,
+        ?segments: ::Array[String],
+        ?send_at: Time,
+        ?to: ::Array[String],
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Blast
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/campaigns.rbs

@@ -0,0 +1,21 @@
+module SurgeAPI
+  module Resources
+    class Campaigns
+      def create: (
+        String account_id,
+        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
+      ) -> SurgeAPI::Campaign
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/contacts.rbs

@@ -0,0 +1,32 @@
+module SurgeAPI
+  module Resources
+    class Contacts
+      def create: (
+        String account_id,
+        phone_number: String,
+        ?email: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String],
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Contact
+
+      def retrieve: (
+        String id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Contact
+
+      def update: (
+        String id,
+        phone_number: String,
+        ?email: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String],
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Contact
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/messages.rbs

@@ -0,0 +1,18 @@
+module SurgeAPI
+  module Resources
+    class Messages
+      def create: (
+        String account_id,
+        conversation: SurgeAPI::MessageCreateParams::Conversation,
+        to: String,
+        ?attachments: ::Array[SurgeAPI::MessageCreateParams::Attachment],
+        ?body: String,
+        ?send_at: Time,
+        ?from: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Message
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/phone_numbers.rbs

@@ -0,0 +1,16 @@
+module SurgeAPI
+  module Resources
+    class PhoneNumbers
+      def purchase: (
+        String account_id,
+        ?area_code: String,
+        ?latitude: Float,
+        ?longitude: Float,
+        ?type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::PhoneNumber
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/users.rbs

@@ -0,0 +1,36 @@
+module SurgeAPI
+  module Resources
+    class Users
+      def create: (
+        String account_id,
+        first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String],
+        ?photo_url: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::User
+
+      def retrieve: (
+        String id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::User
+
+      def update: (
+        String id,
+        first_name: String,
+        ?last_name: String,
+        ?metadata: ::Hash[Symbol, String],
+        ?photo_url: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::User
+
+      def create_token: (
+        String user_id,
+        ?duration_seconds: Integer,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::UserTokenResponse
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/verifications.rbs

@@ -0,0 +1,18 @@
+module SurgeAPI
+  module Resources
+    class Verifications
+      def create: (
+        phone_number: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Verification
+
+      def check: (
+        String id,
+        code: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::VerificationCheck
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/webhooks.rbs

@@ -0,0 +1,17 @@
+module SurgeAPI
+  module Resources
+    class Webhooks
+      def unwrap: (
+        String payload
+      ) -> (SurgeAPI::CallEndedWebhookEvent
+      | SurgeAPI::CampaignApprovedWebhookEvent
+      | SurgeAPI::ConversationCreatedWebhookEvent
+      | SurgeAPI::MessageDeliveredWebhookEvent
+      | SurgeAPI::MessageFailedWebhookEvent
+      | SurgeAPI::MessageReceivedWebhookEvent
+      | SurgeAPI::MessageSentWebhookEvent)
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/version.rbs

@@ -0,0 +1,3 @@
+module SurgeAPI
+  VERSION: String
+end