sendly 3.33.0 → 3.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d643b13d3d51b1ce011b394a31a7fb722c26110e12a87d717e407709bdfd687b
-  data.tar.gz: e17abd7c0fa512116b06fb02927e9f8b3c41d2e082f214b48657b15fb0e327e3
+  metadata.gz: '09a32581d4ce1256ffd2bf348216cf42877665720fd31f7eab4ff50ba9eb30be'
+  data.tar.gz: f713cd2607feeeab90f997a66580d888c2da4bc7b6cf427c4fd77b27dadd866b
 SHA512:
-  metadata.gz: 9a5808b5f638300369e98c7746a049cb5633e727f70648e16f40486564bdb5920731feb3a7a97ebec1580f92bff8ceddca4c8795a224e0ce1c1873f51d9dd3cc
-  data.tar.gz: 1523973847432c7aa50947f6bf46763987d8be1130df68c318fdae466680d18477dece25cfb56200d4f4120cd772f157046b3410cb3284355634bd851efeda3e
+  metadata.gz: 4c0e5cf78135e5e1571d724084aeb850928fdf96fb1bdb9ada800835574816ea54b5bb5cca17298c3aac26d456b0704cce9a3a177e797f800af65c538533a5ff
+  data.tar.gz: 9ad05417089aeb02dff49dc4e33a66484cf6cc1ffd03aefa35e21b7d7b7d9745de7bc7ddbcf2330bc7d57a625e208c0778ce37fe0efd410536391fe2ef178d71

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # sendly (Ruby)
 
+## 3.33.0
+
+### Minor Changes
+
+- New `client.conversations.suggest_replies(id)` method — `POST /api/v1/conversations/:id/suggest-replies`. Returns AI-generated reply suggestions for a conversation based on its recent message history, mirroring the Node SDK's `conversations.suggestReplies()` and the equivalent methods on the other Sendly SDKs (closes a feature parity gap). Returns a `Sendly::SuggestRepliesResponse`, which is `Enumerable` over its `SuggestedReply` entries and also exposes `#suggestions`, `#based_on_message_id`, and `#model`.
+
+  ```ruby
+  client = Sendly::Client.new("sk_live_v1_xxx")
+
+  result = client.conversations.suggest_replies("conv_abc123")
+  result.suggestions.each do |reply|
+    puts "[#{reply.tone}] #{reply.text}"
+  end
+  ```
+
 ## 3.32.0
 
 ### Minor Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sendly (3.33.0)
+    sendly (3.35.0)
       faraday (~> 2.0)
       faraday-retry (~> 2.0)
 

data/README.md

@@ -291,6 +291,47 @@ puts "New key: #{result['key']}"  # Only shown once!
 client.account.revoke_api_key('key_xxx')
 ```
 
+## Numbers
+
+Search for, list, and purchase phone numbers. Requires an API key with the
+`numbers:read` / `numbers:write` scopes.
+
+```ruby
+# List supported countries and the number types available in each
+client.numbers.list_countries[:countries].each do |country|
+  puts "#{country.code} #{country.name}: #{country.number_types.join(', ')}"
+end
+
+# Find available numbers (monthly_cost is already customer-priced)
+result = client.numbers.list_available(country: 'GB', type: 'mobile', contains: '777')
+number = result[:numbers].first
+puts "#{number.phone_number} — #{number.monthly_cost} #{number.currency}/mo"
+
+# List numbers you already own
+client.numbers.list[:numbers].each do |n|
+  puts "#{n.phone_number} (#{n.status})"
+end
+
+# Buy a number
+purchase = client.numbers.buy(
+  phone_number: number.phone_number,
+  country_code: number.country,
+  phone_number_type: number.number_type,
+  monthly_cost: number.monthly_cost
+)
+
+case purchase.status
+when 'provisioning'
+  puts "Provisioning #{purchase.number.phone_number}"
+when 'documents_required', 'payment_required'
+  # Hand the user the hosted page + code, wait for them to finish, then
+  # re-call buy with the SAME arguments plus the completed action's code.
+  puts "Visit #{purchase.action_url} and enter code #{purchase.action_code}"
+  # ...after the action completes:
+  # client.numbers.buy(..., action_code: purchase.action_code)
+end
+```
+
 ## Error Handling
 
 ```ruby

data/lib/sendly/client.rb

@@ -157,6 +157,13 @@ module Sendly
       @business_upgrade ||= BusinessUpgradeResource.new(self)
     end
 
+    # Access the Numbers resource
+    #
+    # @return [Sendly::NumbersResource]
+    def numbers
+      @numbers ||= NumbersResource.new(self)
+    end
+
     # Make a GET request
     #
     # @param path [String] API path

data/lib/sendly/conversations_resource.rb

@@ -107,6 +107,14 @@ module Sendly
       ConversationContext.new(response)
     end
 
+    def suggest_replies(id)
+      raise ValidationError, "Conversation ID is required" if id.nil? || id.empty?
+
+      encoded_id = URI.encode_www_form_component(id)
+      response = @client.post("/conversations/#{encoded_id}/suggest-replies")
+      SuggestRepliesResponse.new(response)
+    end
+
     def each(status: nil, batch_size: 100, &block)
       return enum_for(:each, status: status, batch_size: batch_size) unless block_given?
 

data/lib/sendly/messages.rb

@@ -14,6 +14,7 @@ module Sendly
     #
     # @param to [String] Recipient phone number in E.164 format
     # @param text [String] Message content (max 1600 characters)
+    # @param from [String] Sender ID or phone number (optional)
     # @param message_type [String] Message type: "marketing" (default) or "transactional"
     # @param metadata [Hash] Custom JSON metadata to attach to the message (max 4KB)
     # @return [Sendly::Message] The sent message
@@ -36,11 +37,12 @@ module Sendly
     #     text: "Your verification code is 123456",
     #     message_type: "transactional"
     #   )
-    def send(to:, text:, message_type: nil, metadata: nil, media_urls: nil)
+    def send(to:, text:, from: nil, message_type: nil, metadata: nil, media_urls: nil)
       validate_phone!(to)
       validate_text!(text)
 
       body = { to: to, text: text }
+      body[:from] = from if from
       body[:messageType] = message_type if message_type
       body[:metadata] = metadata if metadata
       body[:mediaUrls] = media_urls if media_urls

data/lib/sendly/numbers_resource.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+module Sendly
+  # A country in which numbers can be searched and purchased, along with the
+  # number types available there (e.g. "mobile", "local", "toll_free").
+  class NumberCountry
+    attr_reader :code, :name, :number_types
+
+    def initialize(data)
+      @code = data["code"]
+      @name = data["name"]
+      @number_types = data["numberTypes"] || data["number_types"] || []
+    end
+
+    def to_h
+      { code: code, name: name, number_types: number_types }.compact
+    end
+  end
+
+  # A number that is available to purchase. The monthly cost is already
+  # customer-priced and returned as a string in the given currency.
+  class AvailableNumber
+    attr_reader :phone_number, :country, :number_type, :monthly_cost, :currency
+
+    def initialize(data)
+      @phone_number = data["phoneNumber"] || data["phone_number"]
+      @country = data["country"]
+      @number_type = data["numberType"] || data["number_type"]
+      @monthly_cost = data["monthlyCost"] || data["monthly_cost"]
+      @currency = data["currency"]
+    end
+
+    def to_h
+      {
+        phone_number: phone_number, country: country,
+        number_type: number_type, monthly_cost: monthly_cost,
+        currency: currency
+      }.compact
+    end
+  end
+
+  # A number owned by the account.
+  class PhoneNumber
+    attr_reader :id, :phone_number, :status, :source, :country_code,
+                :phone_number_type, :monthly_cost_cents,
+                # ISO-8601 timestamp string, or nil when the number still needs
+                # regulatory documents (a value means docs are under carrier review).
+                :requirements_submitted_at,
+                # true when the number is scheduled for release at period end.
+                :pending_cancellation,
+                # ISO-8601 timestamp string, or nil when no release is scheduled.
+                :scheduled_release_at
+
+    def initialize(data)
+      @id = data["id"]
+      @phone_number = data["phoneNumber"] || data["phone_number"]
+      @status = data["status"]
+      @source = data["source"]
+      @country_code = data["countryCode"] || data["country_code"]
+      @phone_number_type = data["phoneNumberType"] || data["phone_number_type"]
+      @monthly_cost_cents = data["monthlyCostCents"] || data["monthly_cost_cents"]
+      @requirements_submitted_at = data["requirementsSubmittedAt"] || data["requirements_submitted_at"]
+      @pending_cancellation = data.key?("pendingCancellation") ? data["pendingCancellation"] : data["pending_cancellation"]
+      @scheduled_release_at = data["scheduledReleaseAt"] || data["scheduled_release_at"]
+    end
+
+    def to_h
+      {
+        id: id, phone_number: phone_number, status: status, source: source,
+        country_code: country_code, phone_number_type: phone_number_type,
+        monthly_cost_cents: monthly_cost_cents,
+        requirements_submitted_at: requirements_submitted_at,
+        pending_cancellation: pending_cancellation,
+        scheduled_release_at: scheduled_release_at
+      }.compact
+    end
+  end
+
+  # The result of a buy request. The API responds 202 with one of three
+  # statuses:
+  #
+  # - +"provisioning"+: the purchase succeeded and the number is being
+  #   provisioned. +number+ carries the new {PhoneNumber}.
+  # - +"documents_required"+ / +"payment_required"+: the purchase is paused
+  #   pending a hosted Sendly step. +action+ carries the hand-off object,
+  #   which holds TWO distinct identifiers:
+  #   - +actionCode+ — a 32-hex action identifier (read via {#action_identifier}).
+  #     Use THIS to poll the action and to re-call +buy+ (pass it as the
+  #     +action_code:+ argument).
+  #   - +code+ — a short user code (read via {#action_code}). DISPLAY ONLY:
+  #     show it to the human to type on the hosted page to prove terminal
+  #     access. Never pass it back as +action_code:+.
+  #   Hand the user +action_url+ + {#action_code}, wait for completion, then
+  #   re-call +buy+ with the same body plus +action_code:+ set to
+  #   {#action_identifier}. +requirements+ describes what's missing (a JSON
+  #   array).
+  #
+  # The raw parsed response is preserved verbatim on +#raw+ so callers can
+  # read any field the server adds.
+  class NumberPurchase
+    attr_reader :status, :number, :requirements, :action, :raw
+
+    def initialize(data)
+      @raw = data
+      @status = data["status"]
+      @number = data["number"] ? PhoneNumber.new(data["number"]) : nil
+      @requirements = data["requirements"]
+      @action = data["action"]
+    end
+
+    def provisioning?
+      status == "provisioning"
+    end
+
+    def documents_required?
+      status == "documents_required"
+    end
+
+    def payment_required?
+      status == "payment_required"
+    end
+
+    # @return [String, nil] The hosted Sendly page URL the user must visit.
+    def action_url
+      action && (action["url"] || action[:url])
+    end
+
+    # The 32-hex action identifier. Use THIS to poll the action's status and
+    # to re-call +buy+ (pass it as the +action_code:+ argument). NOT for
+    # display.
+    #
+    # @return [String, nil]
+    def action_identifier
+      action && (action["actionCode"] || action["action_code"] || action[:actionCode] || action[:action_code])
+    end
+
+    # The short user code shown to the human to type on the hosted page to
+    # prove terminal access. DISPLAY ONLY — to re-buy/poll, use
+    # {#action_identifier}, not this.
+    #
+    # @return [String, nil]
+    def action_code
+      action && (action["code"] || action[:code])
+    end
+
+    # Expiry of the action, as an epoch-milliseconds number (the server sends
+    # a number, not an ISO-8601 string). Older payloads may carry it under
+    # +expires_at+; both are accepted.
+    #
+    # @return [Integer, String, nil]
+    def action_expires_at
+      action && (action["expiresAt"] || action["expires_at"] || action[:expiresAt] || action[:expires_at])
+    end
+
+    def to_h
+      {
+        status: status, number: number&.to_h,
+        requirements: requirements, action: action
+      }.compact
+    end
+  end
+
+  # Numbers resource — search, list, and purchase phone numbers.
+  #
+  # @example List supported countries
+  #   result = client.numbers.list_countries
+  #   result[:countries].each { |c| puts "#{c.code} #{c.name}" }
+  #
+  # @example Find available mobile numbers in the UK
+  #   result = client.numbers.list_available(country: "GB", type: "mobile")
+  #   number = result[:numbers].first
+  #
+  # @example Buy a number (may pause for a hosted step)
+  #   purchase = client.numbers.buy(
+  #     phone_number: number.phone_number,
+  #     country_code: number.country,
+  #     phone_number_type: number.number_type,
+  #     monthly_cost: number.monthly_cost
+  #   )
+  #   if purchase.documents_required? || purchase.payment_required?
+  #     # Show the user the URL + display code; keep the 32-hex identifier for re-buy
+  #     puts "Visit #{purchase.action_url} and enter code #{purchase.action_code}"
+  #     # ...once they finish, re-call buy with action_code: purchase.action_identifier
+  #   end
+  class NumbersResource
+    def initialize(client)
+      @client = client
+    end
+
+    # List the countries in which numbers can be searched and purchased,
+    # along with the number types available in each.
+    #
+    # @return [Hash] +{ countries: Array<NumberCountry> }+
+    def list_countries
+      response = @client.get("/numbers/countries")
+      countries = (response["countries"] || []).map { |c| NumberCountry.new(c) }
+      { countries: countries }
+    end
+
+    # Search for numbers available to purchase in a country.
+    #
+    # @param country [String] ISO country code (e.g. "GB")
+    # @param type [String] Number type (e.g. "mobile", "local", "toll_free")
+    # @param contains [String, nil] Optional digit/letter filter
+    # @return [Hash] +{ numbers: Array<AvailableNumber> }+
+    def list_available(country:, type:, contains: nil)
+      raise ValidationError, "country is required" if country.nil? || country.to_s.empty?
+      raise ValidationError, "type is required" if type.nil? || type.to_s.empty?
+
+      params = { country: country, type: type }
+      params[:contains] = contains if contains
+
+      response = @client.get("/numbers/available", params)
+      numbers = (response["numbers"] || []).map { |n| AvailableNumber.new(n) }
+      { numbers: numbers }
+    end
+
+    # List the numbers owned by the account.
+    #
+    # @return [Hash] +{ numbers: Array<PhoneNumber> }+
+    def list
+      response = @client.get("/numbers")
+      numbers = (response["numbers"] || []).map { |n| PhoneNumber.new(n) }
+      { numbers: numbers }
+    end
+
+    # Buy a number.
+    #
+    # Returns a {NumberPurchase}. When its status is +documents_required+ or
+    # +payment_required+, hand the user +purchase.action_url+ +
+    # +purchase.action_code+ (the short display code), wait for that hosted
+    # step to complete, then re-call +buy+ with the SAME arguments plus
+    # +action_code:+ set to +purchase.action_identifier+ (the 32-hex action
+    # identifier) — NOT the display code.
+    #
+    # @param phone_number [String]
+    # @param country_code [String]
+    # @param phone_number_type [String]
+    # @param monthly_cost [String] Customer-priced monthly cost (as returned by {#list_available})
+    # @param action_code [String, nil] The 32-hex action identifier of a
+    #   completed hosted action (see {NumberPurchase#action_identifier}), on re-call
+    # @return [NumberPurchase]
+    def buy(phone_number:, country_code:, phone_number_type:, monthly_cost:, action_code: nil)
+      raise ValidationError, "phone_number is required" if phone_number.nil? || phone_number.to_s.empty?
+      raise ValidationError, "country_code is required" if country_code.nil? || country_code.to_s.empty?
+      raise ValidationError, "phone_number_type is required" if phone_number_type.nil? || phone_number_type.to_s.empty?
+      raise ValidationError, "monthly_cost is required" if monthly_cost.nil? || monthly_cost.to_s.empty?
+
+      body = {
+        phoneNumber: phone_number,
+        countryCode: country_code,
+        phoneNumberType: phone_number_type,
+        monthlyCost: monthly_cost
+      }
+      body[:actionCode] = action_code if action_code
+
+      response = @client.post("/numbers/buy", body)
+      NumberPurchase.new(response)
+    end
+  end
+end

data/lib/sendly/types.rb

@@ -596,6 +596,75 @@ module Sendly
     end
   end
 
+  # ============================================================================
+  # Suggested Replies
+  # ============================================================================
+
+  class SuggestedReply
+    # @return [String] Suggested reply text
+    attr_reader :text
+
+    # @return [String] Tone of the suggestion (professional, friendly, concise)
+    attr_reader :tone
+
+    TONES = %w[professional friendly concise].freeze
+
+    def initialize(data)
+      @text = data["text"]
+      @tone = data["tone"]
+    end
+
+    def to_h
+      { text: text, tone: tone }.compact
+    end
+  end
+
+  class SuggestRepliesResponse
+    include Enumerable
+
+    # @return [Array<SuggestedReply>] AI-generated reply suggestions
+    attr_reader :suggestions
+
+    # @return [String, nil] ID of the inbound message the suggestions are based on
+    attr_reader :based_on_message_id
+
+    # @return [String, nil] Model that generated the suggestions
+    attr_reader :model
+
+    def initialize(data)
+      @suggestions = (data["suggestions"] || []).map { |s| SuggestedReply.new(s) }
+      @based_on_message_id = data["basedOnMessageId"] || data["based_on_message_id"]
+      @model = data["model"]
+    end
+
+    def each(&block)
+      suggestions.each(&block)
+    end
+
+    def count
+      suggestions.length
+    end
+
+    alias size count
+    alias length count
+
+    def empty?
+      suggestions.empty?
+    end
+
+    def first
+      suggestions.first
+    end
+
+    def to_h
+      {
+        suggestions: suggestions.map(&:to_h),
+        based_on_message_id: based_on_message_id,
+        model: model
+      }.compact
+    end
+  end
+
   # ============================================================================
   # Labels
   # ============================================================================

data/lib/sendly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sendly
-  VERSION = "3.33.0"
+  VERSION = "3.35.0"
 end

data/lib/sendly.rb

@@ -22,6 +22,7 @@ require_relative "sendly/drafts_resource"
 require_relative "sendly/rules_resource"
 require_relative "sendly/enterprise"
 require_relative "sendly/business_upgrade_resource"
+require_relative "sendly/numbers_resource"
 
 # Sendly Ruby SDK
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendly
 version: !ruby/object:Gem::Version
-  version: 3.33.0
+  version: 3.35.0
 platform: ruby
 authors:
 - Sendly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-05-26 00:00:00.000000000 Z
+date: 2026-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,7 @@ files:
 - lib/sendly/labels_resource.rb
 - lib/sendly/media.rb
 - lib/sendly/messages.rb
+- lib/sendly/numbers_resource.rb
 - lib/sendly/rules_resource.rb
 - lib/sendly/templates_resource.rb
 - lib/sendly/types.rb