surge_api 0.1.0

data/rbi/surge_api/models/verification_check.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class VerificationCheck < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::VerificationCheck, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The result of the code check.
+      sig do
+        returns(T.nilable(SurgeAPI::VerificationCheck::Result::TaggedSymbol))
+      end
+      attr_reader :result
+
+      sig { params(result: SurgeAPI::VerificationCheck::Result::OrSymbol).void }
+      attr_writer :result
+
+      # A phone number verification
+      sig { returns(T.nilable(SurgeAPI::Verification)) }
+      attr_reader :verification
+
+      sig { params(verification: SurgeAPI::Verification::OrHash).void }
+      attr_writer :verification
+
+      # The result of checking a Verification code
+      sig do
+        params(
+          result: SurgeAPI::VerificationCheck::Result::OrSymbol,
+          verification: SurgeAPI::Verification::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The result of the code check.
+        result: nil,
+        # A phone number verification
+        verification: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            result: SurgeAPI::VerificationCheck::Result::TaggedSymbol,
+            verification: SurgeAPI::Verification
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The result of the code check.
+      module Result
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::VerificationCheck::Result) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OK = T.let(:ok, SurgeAPI::VerificationCheck::Result::TaggedSymbol)
+        INCORRECT =
+          T.let(:incorrect, SurgeAPI::VerificationCheck::Result::TaggedSymbol)
+        EXHAUSTED =
+          T.let(:exhausted, SurgeAPI::VerificationCheck::Result::TaggedSymbol)
+        EXPIRED =
+          T.let(:expired, SurgeAPI::VerificationCheck::Result::TaggedSymbol)
+        ALREADY_VERIFIED =
+          T.let(
+            :already_verified,
+            SurgeAPI::VerificationCheck::Result::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::VerificationCheck::Result::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/verification_check_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class VerificationCheckParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::VerificationCheckParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The Verification code that was received.
+      sig { returns(String) }
+      attr_accessor :code
+
+      sig do
+        params(
+          code: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Verification code that was received.
+        code:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { code: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/verification_create_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class VerificationCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::VerificationCreateParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The phone number to be verified. In E.164 format.
+      sig { returns(String) }
+      attr_accessor :phone_number
+
+      sig do
+        params(
+          phone_number: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The phone number to be verified. In E.164 format.
+        phone_number:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { phone_number: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/webhook_unwrap_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class WebhookUnwrapParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::WebhookUnwrapParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models.rbi

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

data/rbi/surge_api/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < SurgeAPI::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(SurgeAPI::RequestOptions, SurgeAPI::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: SurgeAPI::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: SurgeAPI::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/surge_api/resources/accounts.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Accounts
+      # Creates a new Account within the calling Platform.
+      sig do
+        params(
+          name: String,
+          brand_name: T.nilable(String),
+          organization: SurgeAPI::AccountCreateParams::Organization::OrHash,
+          time_zone: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Account)
+      end
+      def create(
+        # The name of the account that will be visible for your internal organizational
+        # purposes. This will also be the default public-facing brand name unless you also
+        # set a `brand_name`, but otherwise the account name will never be displayed
+        # anywhere outside of Surge HQ, and may include your ID for the account or
+        # anything else that may help you.
+        name:,
+        # The name by which the people this account communicates with know it. If not
+        # provided, this will match the name field.
+        brand_name: nil,
+        # Parameters describing the legal entity on whose behalf the account will be
+        # operated.
+        organization: nil,
+        # This is the time zone in which the account is headquartered. This time zone may
+        # be used for compliance with TCPA restrictions on when messages may be sent.
+        time_zone: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates an Account
+      sig do
+        params(
+          id: String,
+          brand_name: String,
+          name: String,
+          organization: SurgeAPI::AccountUpdateParams::Organization::OrHash,
+          time_zone: T.nilable(String),
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Account)
+      end
+      def update(
+        # The ID for the account to update.
+        id,
+        # The name by which the people this account communicates with know it. If not
+        # provided, this will match the name field.
+        brand_name: nil,
+        # The name of the account that will be visible for your internal organizational
+        # purposes. This will also be the default public-facing brand name unless you also
+        # set a `brand_name`, but otherwise the account name will never be displayed
+        # anywhere outside of Surge HQ, and may include your ID for the account or
+        # anything else that may help you.
+        name: nil,
+        # Parameters describing the legal entity on whose behalf the account will be
+        # operated.
+        organization: nil,
+        # The time zone for the account
+        time_zone: nil,
+        request_options: {}
+      )
+      end
+
+      # Check an account's status and capabilities
+      sig do
+        params(
+          account_id: String,
+          capabilities:
+            T::Array[
+              SurgeAPI::AccountRetrieveStatusParams::Capability::OrSymbol
+            ],
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::AccountStatus)
+      end
+      def retrieve_status(
+        # ID of the account to check
+        account_id,
+        # capabilities about which to check the status
+        capabilities: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/surge_api/resources/blasts.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Blasts
+      # Sends a Blast.
+      sig do
+        params(
+          account_id: String,
+          attachments:
+            T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
+          body: String,
+          contacts: T::Array[String],
+          name: String,
+          segments: T::Array[String],
+          send_at: Time,
+          to: T::Array[String],
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Blast)
+      end
+      def create(
+        # The account for which the blast should be sent.
+        account_id,
+        attachments: nil,
+        # The message body.
+        body: nil,
+        # Deprecated. Use `to` instead.
+        contacts: nil,
+        # Optional name for the blast.
+        name: nil,
+        # Deprecated. Use `to` instead.
+        segments: nil,
+        # When to send the blast. If not provided, sends immediately.
+        send_at: nil,
+        # List of recipients to whom the blast should be sent. This can be a combination
+        # of contact IDs, segment IDs, and phone numbers.
+        to: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/surge_api/resources/campaigns.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Campaigns
+      # Creates a campaign to register account to send text messages.
+      sig do
+        params(
+          account_id: String,
+          consent_flow: String,
+          description: String,
+          message_samples: T::Array[String],
+          privacy_policy_url: String,
+          use_cases:
+            T::Array[SurgeAPI::CampaignCreateParams::UseCase::OrSymbol],
+          volume: SurgeAPI::CampaignCreateParams::Volume::OrSymbol,
+          includes: T::Array[SurgeAPI::CampaignCreateParams::Include::OrSymbol],
+          link_sample: String,
+          terms_and_conditions_url: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Campaign)
+      end
+      def create(
+        # The account for which the campaign should be created.
+        account_id,
+        # A string explaining the method through which end users will opt in to receive
+        # messages from the brand. Typically this should include URLs for opt-in forms or
+        # screenshots that might be helpful in explaining the flow to someone unfamiliar
+        # with the organization's purpose.
+        consent_flow:,
+        # An explanation of the organization's purpose and how it will be using text
+        # messaging to accomplish that purpose.
+        description:,
+        # An array of 2-5 strings with examples of the messages that will be sent from
+        # this campaign. Typically the first sample should be a compliance message like
+        # `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
+        # These samples don't necessarily need to be the only templates that will be used
+        # for the campaign, but they should reflect the purpose of the messages that will
+        # be sent. Any variable content can be reflected by wrapping it in square brackets
+        # like `[customer name]`.
+        message_samples:,
+        # The URL of the privacy policy for the brand in question. This may be a shared
+        # privacy policy if it's the policy that is displayed to end users when they opt
+        # in to messaging.
+        privacy_policy_url:,
+        # A list containing 1-5 types of messages that will be sent with this campaign.
+        #
+        # The following use cases are typically available to all brands:
+        #
+        # - `account_notification` - For sending reminders, alerts, and general
+        #   account-related notifications like booking confirmations or appointment
+        #   reminders.
+        # - `customer_care` - For account support, troubleshooting, and general customer
+        #   service communication.
+        # - `delivery_notification` - For notifying customers about the status of product
+        #   or service deliveries.
+        # - `fraud_alert` - For warning customers about suspicious or potentially
+        #   fraudulent activity.
+        # - `higher_education` - For messaging related to colleges, universities, and
+        #   school districts outside of K–12.
+        # - `marketing` - For promotional or advertising messages intended to market
+        #   products or services.
+        # - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
+        # - `public_service_announcement` - For raising awareness about social issues or
+        #   important public information.
+        # - `security_alert` - For alerts related to potential security breaches or
+        #   compromised systems requiring user action.
+        # - `two_factor_authentication` - For sending one-time passwords or verification
+        #   codes for login or password reset.
+        #
+        # For access to special use cases not shown here, reach out to support@surge.app.
+        use_cases:,
+        # This will be one of the following:
+        #
+        # - `low` - The campaign will be allowed to send up to 2000 SMS segments to
+        #   T-Mobile customers each day. In this case your platform will be charged for
+        #   the setup fee for a low volume number upon receipt of the API request.
+        # - `high` - The campaign will be allowed to send up to 200k SMS segments to
+        #   T-Mobile customers each day, depending on the trust score assigned by The
+        #   Campaign Registry. Your platform will be charged for the setup fee for a high
+        #   volume number upon receipt of the API request, and phone numbers will be
+        #   charged as high volume numbers going forward.
+        volume:,
+        # A list of properties that this campaign should include. These properties can be
+        # any of the following values:
+        #
+        # - `links` - whether the campaign might send links in messages
+        # - `phone_numbers` - whether the campaign might send phone numbers in messages
+        # - `age_gated` - whether the campaign contains age gated content (controlled
+        #   substances or adult content)
+        # - `direct_lending` - whether the campaign contains content related to direct
+        #   lending or other loan arrangements
+        includes: nil,
+        # A sample link that might be sent by this campaign. If links from other domains
+        # are sent through this campaign, they are much more likely to be filtered by the
+        # carriers. If link shortening is enabled for the account, the link shortener URL
+        # will be used instead of what is provided. Reach out to support if you would like
+        # to disable automatic link shortening.
+        link_sample: nil,
+        # The URL of the terms and conditions presented to end users when they opt in to
+        # messaging. These terms and conditions may be shared among all of a platform's
+        # customers if they're the terms that are presented to end users when they opt in
+        # to messaging.
+        terms_and_conditions_url: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/surge_api/resources/contacts.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Contacts
+      # Creates a new Contact object.
+      sig do
+        params(
+          account_id: String,
+          phone_number: String,
+          email: String,
+          first_name: String,
+          last_name: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Contact)
+      end
+      def create(
+        # The account for which the contact should be created.
+        account_id,
+        # The contact's phone number in E.164 format.
+        phone_number:,
+        # The contact's email address.
+        email: nil,
+        # The contact's first name.
+        first_name: nil,
+        # The contact's last name.
+        last_name: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a Contact object.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Contact)
+      end
+      def retrieve(
+        # The ID of the contact to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates the specified contact by setting the values of the parameters passed.
+      # Any parameters not provided will be left unchanged.
+      sig do
+        params(
+          id: String,
+          phone_number: String,
+          email: String,
+          first_name: String,
+          last_name: String,
+          metadata: T::Hash[Symbol, String],
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Contact)
+      end
+      def update(
+        # The ID of the contact to update.
+        id,
+        # The contact's phone number in E.164 format.
+        phone_number:,
+        # The contact's email address.
+        email: nil,
+        # The contact's first name.
+        first_name: nil,
+        # The contact's last name.
+        last_name: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end