surge_api 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2108433baa320b26048ee5f2141841a98866a135e46330a3cee4b4555eb85b67
-  data.tar.gz: 853d2d48b5b8981ba46ab3ab589bca43fd599ed8b6d9aa63cfcbe80eb5be2b7e
+  metadata.gz: 3e8128de1b743d0dfdea80a3444fe70781bb029f32061761b09b749cd8a1abf7
+  data.tar.gz: 543611ed65fb81164bd534cd91af8a0c6bc2bf96e5efda155aec5204a57c63ce
 SHA512:
-  metadata.gz: 075d2964cab7711b2edc152d89314b5d323bcf9fd5d645409d9cd7c7ccfccf7c5ddab2c471d828bff6ff61a78ededa51e34bc2bbcd6ab298444c79f5d8ffec50
-  data.tar.gz: 6c171b025eeaa2be398b7315e5280129e198917ca5477aba3d7ca4d570def52c0d3b59a7935057ccb2aa93e35184e13989daa0d5e26461efcbc045aa6c9b36ff
+  metadata.gz: 4b124f0da4f0ee63a4e0d418a16059b1f049b26ca9c1361f712e1bd8890fc73d51d9a930818345e753bb22850442085000c293d4a39f9df891582e87b2b31ff3
+  data.tar.gz: b1a17edfc1c13106f82f11cd1732984f20e2ec7c5afa0ae055c5f31e795c77c9f307520ba38b411c9dda6687f11f91dcefa4cf61cd2b26a1c0a433b43ab54970

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.7.0 (2026-01-18)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/surgeapi/ruby-sdk/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** api update ([3eaef18](https://github.com/surgeapi/ruby-sdk/commit/3eaef1827965563c4aba448425c32a7850d8d5ba))
+
 ## 0.6.0 (2026-01-18)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/surgeapi/ruby-sdk/compare/v0.5.0...v0.6.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "surge_api", "~> 0.6.0"
+gem "surge_api", "~> 0.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/models/message.rb

@@ -27,7 +27,13 @@ module SurgeAPI
       #   @return [SurgeAPI::Models::Message::Conversation, nil]
       optional :conversation, -> { SurgeAPI::Message::Conversation }
 
-      # @!method initialize(id: nil, attachments: nil, body: nil, conversation: nil)
+      # @!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: nil, attachments: nil, body: nil, conversation: nil, metadata: nil)
       #   A Message is a communication sent to a Contact.
       #
       #   @param id [String] Unique identifier for the object.
@@ -37,6 +43,8 @@ module SurgeAPI
       #   @param body [String] The message body.
       #
       #   @param conversation [SurgeAPI::Models::Message::Conversation] A conversation with a Contact
+      #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
 
       class Attachment < SurgeAPI::Internal::Type::BaseModel
         # @!attribute id

data/lib/surge_api/models/message_params.rb

@@ -34,6 +34,12 @@ module SurgeAPI
         #   @return [String, nil]
         optional :body, 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]
+
         # @!attribute send_at
         #   An optional datetime for scheduling message up to a couple of months in the
         #   future.
@@ -41,7 +47,7 @@ module SurgeAPI
         #   @return [Time, nil]
         optional :send_at, Time
 
-        # @!method initialize(conversation:, attachments: nil, body: nil, send_at: nil)
+        # @!method initialize(conversation:, attachments: nil, body: nil, metadata: nil, send_at: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageParams::MessageParamsWithConversation} for more
         #   details.
@@ -55,6 +61,8 @@ module SurgeAPI
         #
         #   @param body [String] The message body.
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
 
         # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation#conversation
@@ -172,6 +180,12 @@ module SurgeAPI
         #   @return [String, nil]
         optional :from, 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]
+
         # @!attribute send_at
         #   An optional datetime for scheduling message up to a couple of months in the
         #   future.
@@ -179,7 +193,7 @@ module SurgeAPI
         #   @return [Time, nil]
         optional :send_at, Time
 
-        # @!method initialize(to:, attachments: nil, body: nil, from: nil, send_at: nil)
+        # @!method initialize(to:, attachments: nil, body: nil, from: nil, metadata: nil, send_at: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageParams::SimpleMessageParams} for more details.
         #
@@ -193,6 +207,8 @@ module SurgeAPI
         #
         #   @param from [String] The sender's phone number in E.164 format or phone number ID. If omitted, uses t
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
 
         class Attachment < SurgeAPI::Internal::Type::BaseModel

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/rbi/surge_api/models/message.rbi

@@ -37,13 +37,21 @@ module SurgeAPI
       sig { params(conversation: SurgeAPI::Message::Conversation::OrHash).void }
       attr_writer :conversation
 
+      # 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
+
       # A Message is a communication sent to a Contact.
       sig do
         params(
           id: String,
           attachments: T::Array[SurgeAPI::Message::Attachment::OrHash],
           body: String,
-          conversation: SurgeAPI::Message::Conversation::OrHash
+          conversation: SurgeAPI::Message::Conversation::OrHash,
+          metadata: T::Hash[Symbol, String]
         ).returns(T.attached_class)
       end
       def self.new(
@@ -53,7 +61,9 @@ module SurgeAPI
         # The message body.
         body: nil,
         # A conversation with a Contact
-        conversation: nil
+        conversation: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil
       )
       end
 
@@ -63,7 +73,8 @@ module SurgeAPI
             id: String,
             attachments: T::Array[SurgeAPI::Message::Attachment],
             body: String,
-            conversation: SurgeAPI::Message::Conversation
+            conversation: SurgeAPI::Message::Conversation,
+            metadata: T::Hash[Symbol, String]
           }
         )
       end

data/rbi/surge_api/models/message_params.rbi

@@ -70,6 +70,13 @@ module SurgeAPI
         sig { params(body: String).void }
         attr_writer :body
 
+        # 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
+
         # An optional datetime for scheduling message up to a couple of months in the
         # future.
         sig { returns(T.nilable(Time)) }
@@ -89,6 +96,7 @@ module SurgeAPI
                 SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment::OrHash
               ],
             body: String,
+            metadata: T::Hash[Symbol, String],
             send_at: Time
           ).returns(T.attached_class)
         end
@@ -99,6 +107,8 @@ module SurgeAPI
           attachments: nil,
           # The message body.
           body: nil,
+          # Set of key-value pairs that will be stored with the object.
+          metadata: nil,
           # An optional datetime for scheduling message up to a couple of months in the
           # future.
           send_at: nil
@@ -115,6 +125,7 @@ module SurgeAPI
                   SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment
                 ],
               body: String,
+              metadata: T::Hash[Symbol, String],
               send_at: Time
             }
           )
@@ -341,6 +352,13 @@ module SurgeAPI
         sig { params(from: String).void }
         attr_writer :from
 
+        # 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
+
         # An optional datetime for scheduling message up to a couple of months in the
         # future.
         sig { returns(T.nilable(Time)) }
@@ -359,6 +377,7 @@ module SurgeAPI
               ],
             body: String,
             from: String,
+            metadata: T::Hash[Symbol, String],
             send_at: Time
           ).returns(T.attached_class)
         end
@@ -372,6 +391,8 @@ module SurgeAPI
           # 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'.
           from: nil,
+          # Set of key-value pairs that will be stored with the object.
+          metadata: nil,
           # An optional datetime for scheduling message up to a couple of months in the
           # future.
           send_at: nil
@@ -388,6 +409,7 @@ module SurgeAPI
                 ],
               body: String,
               from: String,
+              metadata: T::Hash[Symbol, String],
               send_at: Time
             }
           )

data/sig/surge_api/models/message.rbs

@@ -5,7 +5,8 @@ module SurgeAPI
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
         body: String,
-        conversation: SurgeAPI::Message::Conversation
+        conversation: SurgeAPI::Message::Conversation,
+        metadata: ::Hash[Symbol, String]
       }
 
     class Message < SurgeAPI::Internal::Type::BaseModel
@@ -29,18 +30,24 @@ module SurgeAPI
         SurgeAPI::Message::Conversation
       ) -> SurgeAPI::Message::Conversation
 
+      attr_reader metadata: ::Hash[Symbol, String]?
+
+      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
       def initialize: (
         ?id: String,
         ?attachments: ::Array[SurgeAPI::Message::Attachment],
         ?body: String,
-        ?conversation: SurgeAPI::Message::Conversation
+        ?conversation: SurgeAPI::Message::Conversation,
+        ?metadata: ::Hash[Symbol, String]
       ) -> void
 
       def to_hash: -> {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
         body: String,
-        conversation: SurgeAPI::Message::Conversation
+        conversation: SurgeAPI::Message::Conversation,
+        metadata: ::Hash[Symbol, String]
       }
 
       type attachment = { id: String, type: String, url: String }

data/sig/surge_api/models/message_params.rbs

@@ -12,6 +12,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
           attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
           body: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 
@@ -28,6 +29,10 @@ module SurgeAPI
 
         def body=: (String) -> String
 
+        attr_reader metadata: ::Hash[Symbol, String]?
+
+        def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
         attr_reader send_at: Time?
 
         def send_at=: (Time) -> Time
@@ -36,6 +41,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
           ?attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
           ?body: String,
+          ?metadata: ::Hash[Symbol, String],
           ?send_at: Time
         ) -> void
 
@@ -43,6 +49,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
           attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
           body: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 
@@ -132,6 +139,7 @@ module SurgeAPI
           attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
           body: String,
           from: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 
@@ -152,6 +160,10 @@ module SurgeAPI
 
         def from=: (String) -> String
 
+        attr_reader metadata: ::Hash[Symbol, String]?
+
+        def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
         attr_reader send_at: Time?
 
         def send_at=: (Time) -> Time
@@ -161,6 +173,7 @@ module SurgeAPI
           ?attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
           ?body: String,
           ?from: String,
+          ?metadata: ::Hash[Symbol, String],
           ?send_at: Time
         ) -> void
 
@@ -169,6 +182,7 @@ module SurgeAPI
           attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
           body: String,
           from: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Surge