surge_api 0.1.0

data/lib/surge_api/models/contact.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Contacts#create
+    class Contact < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute phone_number
+      #   The contact's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute email
+      #   The contact's email address.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute first_name
+      #   The contact's first name.
+      #
+      #   @return [String, nil]
+      optional :first_name, String
+
+      # @!attribute last_name
+      #   The contact's last name.
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+      # @!method initialize(id:, phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil)
+      #   A contact who has consented to receive messages
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param phone_number [String] The contact's phone number in E.164 format.
+      #
+      #   @param email [String] The contact's email address.
+      #
+      #   @param first_name [String] The contact's first name.
+      #
+      #   @param last_name [String] The contact's last name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+    end
+  end
+end

data/lib/surge_api/models/contact_create_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Contacts#create
+    class ContactCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   The contact's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute email
+      #   The contact's email address.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute first_name
+      #   The contact's first name.
+      #
+      #   @return [String, nil]
+      optional :first_name, String
+
+      # @!attribute last_name
+      #   The contact's last name.
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+      # @!method initialize(phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil, request_options: {})
+      #   @param phone_number [String] The contact's phone number in E.164 format.
+      #
+      #   @param email [String] The contact's email address.
+      #
+      #   @param first_name [String] The contact's first name.
+      #
+      #   @param last_name [String] The contact's last name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/contact_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Contacts#retrieve
+    class ContactRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/contact_update_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Contacts#update
+    class ContactUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   The contact's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute email
+      #   The contact's email address.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute first_name
+      #   The contact's first name.
+      #
+      #   @return [String, nil]
+      optional :first_name, String
+
+      # @!attribute last_name
+      #   The contact's last name.
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+      # @!method initialize(phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil, request_options: {})
+      #   @param phone_number [String] The contact's phone number in E.164 format.
+      #
+      #   @param email [String] The contact's email address.
+      #
+      #   @param first_name [String] The contact's first name.
+      #
+      #   @param last_name [String] The contact's last name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/conversation_created_webhook_event.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class ConversationCreatedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::ConversationCreatedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::ConversationCreatedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `conversation.created` for this event.
+      #
+      #   @return [Symbol, :"conversation.created"]
+      required :type, const: :"conversation.created"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"conversation.created")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::ConversationCreatedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"conversation.created"] The type of the event. Always `conversation.created` for this event.
+
+      # @see SurgeAPI::Models::ConversationCreatedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the conversation
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute contact
+        #   A contact who has consented to receive messages
+        #
+        #   @return [SurgeAPI::Models::Contact]
+        required :contact, -> { SurgeAPI::Contact }
+
+        # @!attribute phone_number
+        #   A phone number that can be used to send and receive messages and calls
+        #
+        #   @return [SurgeAPI::Models::PhoneNumber]
+        required :phone_number, -> { SurgeAPI::PhoneNumber }
+
+        # @!method initialize(id:, contact:, phone_number:)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the conversation
+        #
+        #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+        #
+        #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
+      end
+    end
+  end
+end

data/lib/surge_api/models/error.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class Error < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute message
+      #   A human-readable error message.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute type
+      #   A unique error code.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute detail
+      #   Additional details about the error.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :detail, SurgeAPI::Internal::Type::HashOf[SurgeAPI::Internal::Type::Unknown]
+
+      # @!method initialize(message:, type:, detail: nil)
+      #   An error response
+      #
+      #   @param message [String] A human-readable error message.
+      #
+      #   @param type [String] A unique error code.
+      #
+      #   @param detail [Hash{Symbol=>Object}] Additional details about the error.
+    end
+  end
+end

data/lib/surge_api/models/message.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Messages#create
+    class Message < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute attachments
+      #
+      #   @return [Array<SurgeAPI::Models::Message::Attachment>, nil]
+      optional :attachments, -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::Message::Attachment] }
+
+      # @!attribute body
+      #   The message body.
+      #
+      #   @return [String, nil]
+      optional :body, String
+
+      # @!attribute conversation
+      #   A conversation with a Contact
+      #
+      #   @return [SurgeAPI::Models::Message::Conversation, nil]
+      optional :conversation, -> { SurgeAPI::Message::Conversation }
+
+      # @!method initialize(id: nil, attachments: nil, body: nil, conversation: nil)
+      #   A Message is a communication sent to a Contact.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param attachments [Array<SurgeAPI::Models::Message::Attachment>]
+      #
+      #   @param body [String] The message body.
+      #
+      #   @param conversation [SurgeAPI::Models::Message::Conversation] A conversation with a Contact
+
+      class Attachment < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute type
+        #   The type of attachment.
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!attribute url
+        #   The URL of the attachment.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(id: nil, type: nil, url: nil)
+        #   An Attachment is a file that can be sent with a message.
+        #
+        #   @param id [String] Unique identifier for the object.
+        #
+        #   @param type [String] The type of attachment.
+        #
+        #   @param url [String] The URL of the attachment.
+      end
+
+      # @see SurgeAPI::Models::Message#conversation
+      class Conversation < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute contact
+        #   A contact who has consented to receive messages
+        #
+        #   @return [SurgeAPI::Models::Contact]
+        required :contact, -> { SurgeAPI::Contact }
+
+        # @!attribute phone_number
+        #   This is the phone number tied to the Surge account.
+        #
+        #   @return [SurgeAPI::Models::Message::Conversation::PhoneNumber, nil]
+        optional :phone_number, -> { SurgeAPI::Message::Conversation::PhoneNumber }
+
+        # @!method initialize(id:, contact:, phone_number: nil)
+        #   A conversation with a Contact
+        #
+        #   @param id [String] Unique identifier for the object.
+        #
+        #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+        #
+        #   @param phone_number [SurgeAPI::Models::Message::Conversation::PhoneNumber] This is the phone number tied to the Surge account.
+
+        # @see SurgeAPI::Models::Message::Conversation#phone_number
+        class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the phone number
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute number
+          #   The canonical format of the phone number.
+          #
+          #   @return [String]
+          required :number, String
+
+          # @!attribute type
+          #   Whether the phone number is local, toll-free, or short code
+          #
+          #   @return [Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type]
+          required :type, enum: -> { SurgeAPI::Message::Conversation::PhoneNumber::Type }
+
+          # @!method initialize(id:, number:, type:)
+          #   This is the phone number tied to the Surge account.
+          #
+          #   @param id [String] Unique identifier for the phone number
+          #
+          #   @param number [String] The canonical format of the phone number.
+          #
+          #   @param type [Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type] Whether the phone number is local, toll-free, or short code
+
+          # Whether the phone number is local, toll-free, or short code
+          #
+          # @see SurgeAPI::Models::Message::Conversation::PhoneNumber#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            LOCAL = :local
+            TOLL_FREE = :toll_free
+            SHORT_CODE = :short_code
+            DEMO = :demo
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/message_create_params.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Messages#create
+    class MessageCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute conversation
+      #   Params for selecting or creating a new conversation. Either the id or the
+      #   Contact must be given.
+      #
+      #   @return [SurgeAPI::Models::MessageCreateParams::Conversation]
+      required :conversation, -> { SurgeAPI::MessageCreateParams::Conversation }
+
+      # @!attribute attachments
+      #
+      #   @return [Array<SurgeAPI::Models::MessageCreateParams::Attachment>, nil]
+      optional :attachments, -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageCreateParams::Attachment] }
+
+      # @!attribute body
+      #   The message body.
+      #
+      #   @return [String, nil]
+      optional :body, String
+
+      # @!attribute send_at
+      #   An optional datetime for scheduling message up to a couple of months in the
+      #   future.
+      #
+      #   @return [Time, nil]
+      optional :send_at, Time
+
+      # @!attribute to
+      #   The recipient's phone number in E.164 format. Cannot be used together with
+      #   'conversation'.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute from
+      #   The sender's phone number in E.164 format or phone number ID. If omitted, uses
+      #   the account's default phone number. Cannot be used together with 'conversation'.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!method initialize(conversation:, to:, attachments: nil, body: nil, send_at: nil, from: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::MessageCreateParams} for more details.
+      #
+      #   @param conversation [SurgeAPI::Models::MessageCreateParams::Conversation] Params for selecting or creating a new conversation. Either the id or the Contac
+      #
+      #   @param to [String] The recipient's phone number in E.164 format. Cannot be used together with 'conv
+      #
+      #   @param attachments [Array<SurgeAPI::Models::MessageCreateParams::Attachment>]
+      #
+      #   @param body [String] The message body.
+      #
+      #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
+      #
+      #   @param from [String] The sender's phone number in E.164 format or phone number ID. If omitted, uses t
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      class Conversation < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute contact
+        #   Parameters for creating a contact
+        #
+        #   @return [SurgeAPI::Models::MessageCreateParams::Conversation::Contact]
+        required :contact, -> { SurgeAPI::MessageCreateParams::Conversation::Contact }
+
+        # @!attribute phone_number
+        #   The phone number from which to send the message. This can be either the phone
+        #   number in E.164 format or a Surge phone number id.
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!method initialize(contact:, phone_number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageCreateParams::Conversation} for more details.
+        #
+        #   Params for selecting or creating a new conversation. Either the id or the
+        #   Contact must be given.
+        #
+        #   @param contact [SurgeAPI::Models::MessageCreateParams::Conversation::Contact] Parameters for creating a contact
+        #
+        #   @param phone_number [String] The phone number from which to send the message. This can be either the phone nu
+
+        # @see SurgeAPI::Models::MessageCreateParams::Conversation#contact
+        class Contact < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute phone_number
+          #   The contact's phone number in E.164 format.
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!attribute email
+          #   The contact's email address.
+          #
+          #   @return [String, nil]
+          optional :email, String
+
+          # @!attribute first_name
+          #   The contact's first name.
+          #
+          #   @return [String, nil]
+          optional :first_name, String
+
+          # @!attribute last_name
+          #   The contact's last name.
+          #
+          #   @return [String, nil]
+          optional :last_name, String
+
+          # @!attribute metadata
+          #   Set of key-value pairs that will be stored with the object.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+          # @!method initialize(phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil)
+          #   Parameters for creating a contact
+          #
+          #   @param phone_number [String] The contact's phone number in E.164 format.
+          #
+          #   @param email [String] The contact's email address.
+          #
+          #   @param first_name [String] The contact's first name.
+          #
+          #   @param last_name [String] The contact's last name.
+          #
+          #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        end
+      end
+
+      class Attachment < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute url
+        #   The URL of the attachment.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(url:)
+        #   Params for creating an attachment
+        #
+        #   @param url [String] The URL of the attachment.
+      end
+    end
+  end
+end