sendly 3.12.3 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3411e6ff88aa6e65422703ce8c630a1f114ad43e9b8ebbcae67e0f26b82d599c
-  data.tar.gz: 502f2fac031f7f9d9af111020d10d4fe5ea1628d90a8c3b9ad9b889afc86f13e
+  metadata.gz: a1468fb0c87212a7d6f930ad557fc6b9546eca11a292ac8c7873c9db1d209ac1
+  data.tar.gz: bf62a3866fa8c02557d5925d175fe06c0de554c00d0bb371b1178d2eff84f5a0
 SHA512:
-  metadata.gz: c2bef1c5b6835f20201cb236236fbcaff13f6e84b64bb0781ec9f6259f394473851fd7ec33d271c1250fcb4895e3390481574bf129f3b0b4f91e201dcc13b627
-  data.tar.gz: 76d95f0e6397731868ba8d38d4a557fbce5dce849125631aac794739b918da28da2dde502724d5f24d34dfaf55fb9261fec5d2ac78fe45b533afdc77821bb08c
+  metadata.gz: acc02947f862c3de0dd2122a44438fee340398d091a9066eab33e8929e153f545b385f906c3831185760d90afefe6e0c2f6464f5357c8ba185e617833f1ff6d8
+  data.tar.gz: 97843f126f57e6ce43e75c3d7f9a6658acd2b3b74b805fee08561f0e57ad55664bcb1f5e95cbad2f920dd927ec0d04e71b20ebde5e628ec6ba28ff729010ba01

data/Gemfile.lock

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

data/lib/sendly/campaigns_resource.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Sendly
+  class Campaign
+    attr_reader :id, :name, :text, :template_id, :contact_list_ids, :status,
+                :recipient_count, :sent_count, :delivered_count, :failed_count,
+                :estimated_credits, :credits_used, :scheduled_at, :timezone,
+                :started_at, :completed_at, :created_at, :updated_at
+
+    STATUSES = %w[draft scheduled sending sent paused cancelled failed].freeze
+
+    def initialize(data)
+      @id = data["id"]
+      @name = data["name"]
+      @text = data["text"]
+      @template_id = data["template_id"] || data["templateId"]
+      @contact_list_ids = data["contact_list_ids"] || data["contactListIds"] || []
+      @status = data["status"]
+      @recipient_count = data["recipient_count"] || data["recipientCount"] || 0
+      @sent_count = data["sent_count"] || data["sentCount"] || 0
+      @delivered_count = data["delivered_count"] || data["deliveredCount"] || 0
+      @failed_count = data["failed_count"] || data["failedCount"] || 0
+      @estimated_credits = data["estimated_credits"] || data["estimatedCredits"] || 0
+      @credits_used = data["credits_used"] || data["creditsUsed"] || 0
+      @scheduled_at = parse_time(data["scheduled_at"] || data["scheduledAt"])
+      @timezone = data["timezone"]
+      @started_at = parse_time(data["started_at"] || data["startedAt"])
+      @completed_at = parse_time(data["completed_at"] || data["completedAt"])
+      @created_at = parse_time(data["created_at"] || data["createdAt"])
+      @updated_at = parse_time(data["updated_at"] || data["updatedAt"])
+    end
+
+    def draft?
+      status == "draft"
+    end
+
+    def scheduled?
+      status == "scheduled"
+    end
+
+    def sending?
+      status == "sending"
+    end
+
+    def sent?
+      status == "sent"
+    end
+
+    def cancelled?
+      status == "cancelled"
+    end
+
+    def to_h
+      {
+        id: id, name: name, text: text, template_id: template_id,
+        contact_list_ids: contact_list_ids, status: status,
+        recipient_count: recipient_count, sent_count: sent_count,
+        delivered_count: delivered_count, failed_count: failed_count,
+        estimated_credits: estimated_credits, credits_used: credits_used,
+        scheduled_at: scheduled_at&.iso8601, timezone: timezone,
+        started_at: started_at&.iso8601, completed_at: completed_at&.iso8601,
+        created_at: created_at&.iso8601, updated_at: updated_at&.iso8601
+      }.compact
+    end
+
+    private
+
+    def parse_time(value)
+      return nil if value.nil?
+      Time.parse(value)
+    rescue ArgumentError
+      nil
+    end
+  end
+
+  class CampaignPreview
+    attr_reader :id, :recipient_count, :estimated_segments, :estimated_credits,
+                :current_balance, :has_enough_credits, :breakdown
+
+    def initialize(data)
+      @id = data["id"]
+      @recipient_count = data["recipient_count"] || data["recipientCount"] || 0
+      @estimated_segments = data["estimated_segments"] || data["estimatedSegments"] || 0
+      @estimated_credits = data["estimated_credits"] || data["estimatedCredits"] || 0
+      @current_balance = data["current_balance"] || data["currentBalance"] || 0
+      @has_enough_credits = data["has_enough_credits"] || data["hasEnoughCredits"] || false
+      @breakdown = data["breakdown"]
+    end
+
+    def enough_credits?
+      has_enough_credits
+    end
+  end
+
+  class CampaignsResource
+    def initialize(client)
+      @client = client
+    end
+
+    def create(name:, text:, contact_list_ids:, template_id: nil)
+      body = {
+        name: name,
+        text: text,
+        contactListIds: contact_list_ids
+      }
+      body[:templateId] = template_id if template_id
+
+      response = @client.post("/campaigns", body)
+      Campaign.new(response)
+    end
+
+    def list(limit: nil, offset: nil, status: nil)
+      params = {}
+      params[:limit] = limit if limit
+      params[:offset] = offset if offset
+      params[:status] = status if status
+
+      response = @client.get("/campaigns", params)
+      campaigns = (response["campaigns"] || []).map { |c| Campaign.new(c) }
+      {
+        campaigns: campaigns,
+        total: response["total"],
+        limit: response["limit"],
+        offset: response["offset"]
+      }
+    end
+
+    def get(id)
+      response = @client.get("/campaigns/#{id}")
+      Campaign.new(response)
+    end
+
+    def update(id, name: nil, text: nil, template_id: nil, contact_list_ids: nil)
+      body = {}
+      body[:name] = name if name
+      body[:text] = text if text
+      body[:templateId] = template_id unless template_id.nil?
+      body[:contactListIds] = contact_list_ids if contact_list_ids
+
+      response = @client.patch("/campaigns/#{id}", body)
+      Campaign.new(response)
+    end
+
+    def delete(id)
+      @client.delete("/campaigns/#{id}")
+    end
+
+    def preview(id)
+      response = @client.get("/campaigns/#{id}/preview")
+      CampaignPreview.new(response)
+    end
+
+    def send_campaign(id)
+      response = @client.post("/campaigns/#{id}/send")
+      Campaign.new(response)
+    end
+
+    def schedule(id, scheduled_at:, timezone: nil)
+      body = { scheduledAt: scheduled_at }
+      body[:timezone] = timezone if timezone
+
+      response = @client.post("/campaigns/#{id}/schedule", body)
+      Campaign.new(response)
+    end
+
+    def cancel(id)
+      response = @client.post("/campaigns/#{id}/cancel")
+      Campaign.new(response)
+    end
+
+    def clone(id)
+      response = @client.post("/campaigns/#{id}/clone")
+      Campaign.new(response)
+    end
+  end
+end

data/lib/sendly/client.rb

@@ -73,6 +73,20 @@ module Sendly
       @templates ||= TemplatesResource.new(self)
     end
 
+    # Access the Campaigns resource
+    #
+    # @return [Sendly::CampaignsResource]
+    def campaigns
+      @campaigns ||= CampaignsResource.new(self)
+    end
+
+    # Access the Contacts resource
+    #
+    # @return [Sendly::ContactsResource]
+    def contacts
+      @contacts ||= ContactsResource.new(self)
+    end
+
     # Make a GET request
     #
     # @param path [String] API path

data/lib/sendly/contacts_resource.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Sendly
+  class Contact
+    attr_reader :id, :phone_number, :name, :email, :metadata, :opted_out,
+                :created_at, :updated_at, :lists
+
+    def initialize(data)
+      @id = data["id"]
+      @phone_number = data["phone_number"] || data["phoneNumber"]
+      @name = data["name"]
+      @email = data["email"]
+      @metadata = data["metadata"] || {}
+      @opted_out = data["opted_out"] || data["optedOut"] || false
+      @created_at = parse_time(data["created_at"] || data["createdAt"])
+      @updated_at = parse_time(data["updated_at"] || data["updatedAt"])
+      @lists = data["lists"]&.map { |l| { id: l["id"], name: l["name"] } }
+    end
+
+    def opted_out?
+      opted_out
+    end
+
+    def to_h
+      {
+        id: id, phone_number: phone_number, name: name, email: email,
+        metadata: metadata, opted_out: opted_out,
+        created_at: created_at&.iso8601, updated_at: updated_at&.iso8601,
+        lists: lists
+      }.compact
+    end
+
+    private
+
+    def parse_time(value)
+      return nil if value.nil?
+      Time.parse(value)
+    rescue ArgumentError
+      nil
+    end
+  end
+
+  class ContactList
+    attr_reader :id, :name, :description, :contact_count, :created_at,
+                :updated_at, :contacts, :contacts_total
+
+    def initialize(data)
+      @id = data["id"]
+      @name = data["name"]
+      @description = data["description"]
+      @contact_count = data["contact_count"] || data["contactCount"] || 0
+      @created_at = parse_time(data["created_at"] || data["createdAt"])
+      @updated_at = parse_time(data["updated_at"] || data["updatedAt"])
+      @contacts = data["contacts"]&.map do |c|
+        {
+          id: c["id"],
+          phone_number: c["phone_number"] || c["phoneNumber"],
+          name: c["name"],
+          email: c["email"]
+        }
+      end
+      @contacts_total = data["contacts_total"] || data["contactsTotal"]
+    end
+
+    def to_h
+      {
+        id: id, name: name, description: description,
+        contact_count: contact_count, created_at: created_at&.iso8601,
+        updated_at: updated_at&.iso8601, contacts: contacts,
+        contacts_total: contacts_total
+      }.compact
+    end
+
+    private
+
+    def parse_time(value)
+      return nil if value.nil?
+      Time.parse(value)
+    rescue ArgumentError
+      nil
+    end
+  end
+
+  class ContactListsResource
+    def initialize(client)
+      @client = client
+    end
+
+    def list
+      response = @client.get("/contact-lists")
+      lists = (response["lists"] || []).map { |l| ContactList.new(l) }
+      { lists: lists }
+    end
+
+    def get(id, limit: nil, offset: nil)
+      params = {}
+      params[:limit] = limit if limit
+      params[:offset] = offset if offset
+
+      response = @client.get("/contact-lists/#{id}", params)
+      ContactList.new(response)
+    end
+
+    def create(name:, description: nil)
+      body = { name: name }
+      body[:description] = description if description
+
+      response = @client.post("/contact-lists", body)
+      ContactList.new(response)
+    end
+
+    def update(id, name: nil, description: nil)
+      body = {}
+      body[:name] = name if name
+      body[:description] = description unless description.nil?
+
+      response = @client.patch("/contact-lists/#{id}", body)
+      ContactList.new(response)
+    end
+
+    def delete(id)
+      @client.delete("/contact-lists/#{id}")
+    end
+
+    def add_contacts(list_id, contact_ids)
+      response = @client.post("/contact-lists/#{list_id}/contacts", { contact_ids: contact_ids })
+      { added_count: response["added_count"] || response["addedCount"] }
+    end
+
+    def remove_contact(list_id, contact_id)
+      @client.delete("/contact-lists/#{list_id}/contacts/#{contact_id}")
+    end
+  end
+
+  class ContactsResource
+    attr_reader :lists
+
+    def initialize(client)
+      @client = client
+      @lists = ContactListsResource.new(client)
+    end
+
+    def list(limit: nil, offset: nil, search: nil, list_id: nil)
+      params = {}
+      params[:limit] = limit if limit
+      params[:offset] = offset if offset
+      params[:search] = search if search
+      params[:list_id] = list_id if list_id
+
+      response = @client.get("/contacts", params)
+      contacts = (response["contacts"] || []).map { |c| Contact.new(c) }
+      {
+        contacts: contacts,
+        total: response["total"],
+        limit: response["limit"],
+        offset: response["offset"]
+      }
+    end
+
+    def get(id)
+      response = @client.get("/contacts/#{id}")
+      Contact.new(response)
+    end
+
+    def create(phone_number:, name: nil, email: nil, metadata: nil)
+      body = { phone_number: phone_number }
+      body[:name] = name if name
+      body[:email] = email if email
+      body[:metadata] = metadata if metadata
+
+      response = @client.post("/contacts", body)
+      Contact.new(response)
+    end
+
+    def update(id, name: nil, email: nil, metadata: nil)
+      body = {}
+      body[:name] = name unless name.nil?
+      body[:email] = email unless email.nil?
+      body[:metadata] = metadata unless metadata.nil?
+
+      response = @client.patch("/contacts/#{id}", body)
+      Contact.new(response)
+    end
+
+    def delete(id)
+      @client.delete("/contacts/#{id}")
+    end
+  end
+end

data/lib/sendly/templates_resource.rb

@@ -104,5 +104,12 @@ module Sendly
       response = @client.post("/verify/templates/#{id}/unpublish")
       Template.new(response)
     end
+
+    def clone(id, name: nil)
+      body = {}
+      body[:name] = name if name
+      response = @client.post("/templates/#{id}/clone", body)
+      Template.new(response)
+    end
   end
 end

data/lib/sendly/version.rb

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

data/lib/sendly.rb

@@ -13,6 +13,8 @@ require_relative "sendly/webhooks_resource"
 require_relative "sendly/account_resource"
 require_relative "sendly/verify"
 require_relative "sendly/templates_resource"
+require_relative "sendly/campaigns_resource"
+require_relative "sendly/contacts_resource"
 
 # Sendly Ruby SDK
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendly
 version: !ruby/object:Gem::Version
-  version: 3.12.3
+  version: 3.13.0
 platform: ruby
 authors:
 - Sendly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-01-15 00:00:00.000000000 Z
+date: 2026-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -124,7 +124,9 @@ files:
 - examples/send_sms.rb
 - lib/sendly.rb
 - lib/sendly/account_resource.rb
+- lib/sendly/campaigns_resource.rb
 - lib/sendly/client.rb
+- lib/sendly/contacts_resource.rb
 - lib/sendly/errors.rb
 - lib/sendly/messages.rb
 - lib/sendly/templates_resource.rb