surge_api 0.1.0

data/rbi/surge_api/models/phone_number.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::PhoneNumber, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Unique identifier for the phone number
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The phone number in E.164 format
+      sig { returns(String) }
+      attr_accessor :number
+
+      # Whether the phone number is local, toll-free, or short code
+      sig { returns(SurgeAPI::PhoneNumber::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # A phone number that can be used to send and receive messages and calls
+      sig do
+        params(
+          id: String,
+          number: String,
+          type: SurgeAPI::PhoneNumber::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the phone number
+        id:,
+        # The phone number in E.164 format
+        number:,
+        # Whether the phone number is local, toll-free, or short code
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            number: String,
+            type: SurgeAPI::PhoneNumber::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether the phone number is local, toll-free, or short code
+      module Type
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::PhoneNumber::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCAL = T.let(:local, SurgeAPI::PhoneNumber::Type::TaggedSymbol)
+        TOLL_FREE = T.let(:toll_free, SurgeAPI::PhoneNumber::Type::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[SurgeAPI::PhoneNumber::Type::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberPurchaseParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::PhoneNumberPurchaseParams,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The desired area code for this phone number. If provided without type, the type
+      # will be inferred.
+      sig { returns(T.nilable(String)) }
+      attr_reader :area_code
+
+      sig { params(area_code: String).void }
+      attr_writer :area_code
+
+      # Latitude to search for nearby phone numbers. Must be used with longitude. If
+      # provided without type, type will be inferred as 'local'.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :latitude
+
+      sig { params(latitude: Float).void }
+      attr_writer :latitude
+
+      # Longitude to search for nearby phone numbers. Must be used with latitude. If
+      # provided without type, type will be inferred as 'local'.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :longitude
+
+      sig { params(longitude: Float).void }
+      attr_writer :longitude
+
+      # Whether the phone number is local or toll-free. Can be omitted if area_code or
+      # latitude/longitude are provided.
+      sig do
+        returns(T.nilable(SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          area_code: String,
+          latitude: Float,
+          longitude: Float,
+          type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The desired area code for this phone number. If provided without type, the type
+        # will be inferred.
+        area_code: nil,
+        # Latitude to search for nearby phone numbers. Must be used with longitude. If
+        # provided without type, type will be inferred as 'local'.
+        latitude: nil,
+        # Longitude to search for nearby phone numbers. Must be used with latitude. If
+        # provided without type, type will be inferred as 'local'.
+        longitude: nil,
+        # Whether the phone number is local or toll-free. Can be omitted if area_code or
+        # latitude/longitude are provided.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            area_code: String,
+            latitude: Float,
+            longitude: Float,
+            type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether the phone number is local or toll-free. Can be omitted if area_code or
+      # latitude/longitude are provided.
+      module Type
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, SurgeAPI::PhoneNumberPurchaseParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCAL =
+          T.let(:local, SurgeAPI::PhoneNumberPurchaseParams::Type::TaggedSymbol)
+        TOLL_FREE =
+          T.let(
+            :toll_free,
+            SurgeAPI::PhoneNumberPurchaseParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::PhoneNumberPurchaseParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/unwrap_webhook_event.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    module UnwrapWebhookEvent
+      extend SurgeAPI::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            SurgeAPI::CallEndedWebhookEvent,
+            SurgeAPI::CampaignApprovedWebhookEvent,
+            SurgeAPI::ConversationCreatedWebhookEvent,
+            SurgeAPI::MessageDeliveredWebhookEvent,
+            SurgeAPI::MessageFailedWebhookEvent,
+            SurgeAPI::MessageReceivedWebhookEvent,
+            SurgeAPI::MessageSentWebhookEvent
+          )
+        end
+
+      sig { override.returns(T::Array[SurgeAPI::UnwrapWebhookEvent::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/surge_api/models/user.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class User < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(SurgeAPI::User, SurgeAPI::Internal::AnyHash) }
+
+      # The user's first name.
+      sig { returns(String) }
+      attr_accessor :first_name
+
+      # Unique identifier for the object.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # The user's last name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # URL of a photo to be used as the user's avatar.
+      sig { returns(T.nilable(String)) }
+      attr_reader :photo_url
+
+      sig { params(photo_url: String).void }
+      attr_writer :photo_url
+
+      # A user of the app
+      sig do
+        params(
+          first_name: String,
+          id: String,
+          last_name: String,
+          metadata: T::Hash[Symbol, String],
+          photo_url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The user's first name.
+        first_name:,
+        # Unique identifier for the object.
+        id: nil,
+        # The user's last name.
+        last_name: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
+        # URL of a photo to be used as the user's avatar.
+        photo_url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            first_name: String,
+            id: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, String],
+            photo_url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/user_create_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class UserCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::UserCreateParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The user's first name.
+      sig { returns(String) }
+      attr_accessor :first_name
+
+      # The user's last name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # URL of a photo to be used as the user's avatar.
+      sig { returns(T.nilable(String)) }
+      attr_reader :photo_url
+
+      sig { params(photo_url: String).void }
+      attr_writer :photo_url
+
+      sig do
+        params(
+          first_name: String,
+          last_name: String,
+          metadata: T::Hash[Symbol, String],
+          photo_url: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The user's first name.
+        first_name:,
+        # The user's last name.
+        last_name: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
+        # URL of a photo to be used as the user's avatar.
+        photo_url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            first_name: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, String],
+            photo_url: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/user_create_token_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class UserCreateTokenParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::UserCreateTokenParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # For how many seconds the token should be accepted. Defaults to 15 minutes.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :duration_seconds
+
+      sig { params(duration_seconds: Integer).void }
+      attr_writer :duration_seconds
+
+      sig do
+        params(
+          duration_seconds: Integer,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # For how many seconds the token should be accepted. Defaults to 15 minutes.
+        duration_seconds: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            duration_seconds: Integer,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/user_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class UserRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::UserRetrieveParams, 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/user_token_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class UserTokenResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::UserTokenResponse, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The created token.
+      sig { returns(T.nilable(String)) }
+      attr_reader :token
+
+      sig { params(token: String).void }
+      attr_writer :token
+
+      # Response when token has been created successfully
+      sig { params(token: String).returns(T.attached_class) }
+      def self.new(
+        # The created token.
+        token: nil
+      )
+      end
+
+      sig { override.returns({ token: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/user_update_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class UserUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::UserUpdateParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The user's first name.
+      sig { returns(String) }
+      attr_accessor :first_name
+
+      # The user's last name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # URL of a photo to be used as the user's avatar.
+      sig { returns(T.nilable(String)) }
+      attr_reader :photo_url
+
+      sig { params(photo_url: String).void }
+      attr_writer :photo_url
+
+      sig do
+        params(
+          first_name: String,
+          last_name: String,
+          metadata: T::Hash[Symbol, String],
+          photo_url: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The user's first name.
+        first_name:,
+        # The user's last name.
+        last_name: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
+        # URL of a photo to be used as the user's avatar.
+        photo_url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            first_name: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, String],
+            photo_url: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/verification.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class Verification < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::Verification, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The number of times the code has been attempted.
+      sig { returns(Integer) }
+      attr_accessor :attempt_count
+
+      # The phone number being verified. In E.164 format.
+      sig { returns(String) }
+      attr_accessor :phone_number
+
+      # The current status of the verification.
+      sig { returns(SurgeAPI::Verification::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # A phone number verification
+      sig do
+        params(
+          id: String,
+          attempt_count: Integer,
+          phone_number: String,
+          status: SurgeAPI::Verification::Status::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # The number of times the code has been attempted.
+        attempt_count:,
+        # The phone number being verified. In E.164 format.
+        phone_number:,
+        # The current status of the verification.
+        status:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            attempt_count: Integer,
+            phone_number: String,
+            status: SurgeAPI::Verification::Status::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The current status of the verification.
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::Verification::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING = T.let(:pending, SurgeAPI::Verification::Status::TaggedSymbol)
+        VERIFIED =
+          T.let(:verified, SurgeAPI::Verification::Status::TaggedSymbol)
+        EXHAUSTED =
+          T.let(:exhausted, SurgeAPI::Verification::Status::TaggedSymbol)
+        EXPIRED = T.let(:expired, SurgeAPI::Verification::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::Verification::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end