sendly 3.30.0 → 3.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa8097776c931f504cc3f006783ed8232691fc48c35c93b8930437c9f5480b5
-  data.tar.gz: 74cfe38cea2edefae5a4173dbbae2ff4df2a3364e69de2329191ef95fd26195b
+  metadata.gz: 80748f70518bf065b5c3aec3495bbc69ef4641793a57186757ea1f10957de933
+  data.tar.gz: b98259199daccc2948950da3a6058b4b66140ff72b4c8a9b1ad5fae6a59a639c
 SHA512:
-  metadata.gz: 40d6bb9e8df8757fa585253b39b49e85973f7959f1278b8354c803b293047bb0dbf279dafd5c5550e61d4b6a26ed78ada5295ab686a312dc32f026d46ff7203f
-  data.tar.gz: b4ee727e07b7fc3fa75326e36ae073c62d50e6d3c98b5905c745444c80d6dd358ab19a5ed36c0853af3c07eba7fbba50d6db7389f469c3555abf15d6960b5742
+  metadata.gz: 796976f6e39f8bb3fad45e86b9bdb5256521c46dbe566ace7c14ccb72192ea4902c79965b93cdf757eb23677e254166cbdc0ba2195ef51c0c90d85c7365984c6
+  data.tar.gz: 32b41bc79313a7f26d6cd6dac95125ad210168be1dcd8ca9e2389a7d1beb2c4678fa7f32769e4263c102cdf1b94ed68276bb8c84b84d5dc67c992c9238a1f230

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # sendly (Ruby)
 
+## 3.31.0
+
+### Patch Changes
+
+- **`Sendly::Client.new` now accepts the API key positionally** in addition to as a keyword argument. Every code sample in our docs used positional, so `Sendly::Client.new("sk_live_...")` previously raised `ArgumentError: missing keyword: :api_key`. Both styles now work and produce identical clients:
+
+  ```ruby
+  # Positional (matches our docs)
+  client = Sendly::Client.new("sk_live_v1_xxx")
+  client = Sendly::Client.new("sk_live_v1_xxx", timeout: 60)
+
+  # Keyword (existing v3.30.0 signature — unchanged)
+  client = Sendly::Client.new(api_key: "sk_live_v1_xxx")
+  ```
+
+  Passing `api_key` both positionally and as a keyword raises `ArgumentError`; passing more than one positional argument also raises. Backward-compatible with all v3.30.0 callers.
+
+## 3.30.0
+
+### Minor Changes
+
+- `enterprise.workspaces.submit_verification(workspace_id, **fields)`: rewritten to match the actual API shape (camelCase keys on the wire, nested `address`/`contact` hashes, `entity_type` + `brn`/`brn_type`/`brn_country` instead of `business_type`/`ein`). The previous shape didn't match the server endpoint — calls were always returning 400.
+- **Partial-update friendly:** for resubmits on existing workspaces, send only the fields you want to change — everything else is filled from the existing record. Hosted page URLs (`/biz/`, `/opt-in/`, `/legal/`) generated during provision are auto-preserved.
+- `enterprise.workspaces.resubmit_verification(workspace_id, **partial_updates)`: convenience alias for resubmits — same as `submit_verification` but reads more naturally for one-field-change use cases.
+- All top-level keys are accepted as snake_case Ruby keyword arguments (`business_name`, `use_case`, `opt_in_workflow`, etc.) and transformed to the camelCase keys the API expects. Nested `address` and `contact` hashes are passed through verbatim and should already use camelCase keys (e.g. `firstName`, `lastName`).
+
+### Server-side fixes paired with this release
+
+- `/api/v1/enterprise/workspaces/:id/verification/submit` now returns specific missing-field errors (e.g. `"Missing required fields: website"`) instead of listing every required field whether present or not.
+- Endpoint accepts both flat and `{ verification: {...} }` wrapped shapes (matches `/enterprise/provision`).
+- `use_case` validation expanded from 23 entries to the full 43-value Telnyx enum.
+
 ## 3.29.0
 
 ### Minor Changes

data/Gemfile.lock

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

data/README.md

@@ -164,16 +164,16 @@ scheduled = client.messages.schedule(
 puts scheduled.id
 puts scheduled.scheduled_at
 
-# List scheduled messages
+# List scheduled messages (returns a Hash with "data" array)
 result = client.messages.list_scheduled
-result.data.each { |msg| puts "#{msg.id}: #{msg.scheduled_at}" }
+result["data"].each { |msg| puts "#{msg['id']}: #{msg['scheduledAt']}" }
 
 # Get a specific scheduled message
 msg = client.messages.get_scheduled("sched_xxx")
 
 # Cancel a scheduled message (refunds credits)
 result = client.messages.cancel_scheduled("sched_xxx")
-puts "Refunded: #{result.credits_refunded} credits"
+puts "Refunded: #{result['creditsRefunded']} credits"
 ```
 
 ### Batch Messages
@@ -188,10 +188,10 @@ batch = client.messages.send_batch(
   ]
 )
 
-puts batch.batch_id
-puts "Queued: #{batch.queued}"
-puts "Failed: #{batch.failed}"
-puts "Credits used: #{batch.credits_used}"
+puts batch["batchId"]
+puts "Queued: #{batch['queued']}"
+puts "Failed: #{batch['failed']}"
+puts "Credits used: #{batch['creditsUsed']}"
 
 # Get batch status
 status = client.messages.get_batch("batch_xxx")
@@ -206,8 +206,8 @@ preview = client.messages.preview_batch(
     { to: '+447700900123', text: 'Hello UK!' }
   ]
 )
-puts "Total credits needed: #{preview.total_credits}"
-puts "Valid: #{preview.valid}, Invalid: #{preview.invalid}"
+puts "Credits needed: #{preview['creditsNeeded']}"
+puts "Will send: #{preview['willSend']}, Blocked: #{preview['blocked']}"
 ```
 
 ### Iterate All Messages
@@ -266,30 +266,26 @@ account = client.account.get
 puts account.email
 
 # Check credit balance
-credits = client.account.get_credits
-puts "Available: #{credits.available_balance} credits"
-puts "Reserved: #{credits.reserved_balance} credits"
-puts "Total: #{credits.balance} credits"
+credits = client.account.credits
+puts "Available: #{credits['availableBalance']} credits"
+puts "Reserved: #{credits['reservedBalance']} credits"
+puts "Total: #{credits['balance']} credits"
 
 # View credit transaction history
-result = client.account.get_credit_transactions
-result.data.each do |tx|
-  puts "#{tx.type}: #{tx.amount} credits - #{tx.description}"
+transactions = client.account.transactions
+transactions.each do |tx|
+  puts "#{tx['type']}: #{tx['amount']} credits - #{tx['description']}"
 end
 
 # List API keys
-result = client.account.list_api_keys
-result.data.each do |key|
-  puts "#{key.name}: #{key.prefix}*** (#{key.type})"
+keys = client.account.api_keys
+keys.each do |key|
+  puts "#{key['name']}: #{key['prefix']}*** (#{key['type']})"
 end
 
 # Create a new API key
-new_key = client.account.create_api_key(
-  name: 'Production Key',
-  type: 'live',
-  scopes: ['sms:send', 'sms:read']
-)
-puts "New key: #{new_key.key}"  # Only shown once!
+result = client.account.create_api_key('Production Key')
+puts "New key: #{result['key']}"  # Only shown once!
 
 # Revoke an API key
 client.account.revoke_api_key('key_xxx')
@@ -408,7 +404,7 @@ Three provisioning modes:
 ### Workspace Management
 
 ```ruby
-ws = client.enterprise.workspaces.create("Acme Insurance")
+ws = client.enterprise.workspaces.create(name: "Acme Insurance")
 list = client.enterprise.workspaces.list
 detail = client.enterprise.workspaces.get("ws_xxx")
 client.enterprise.workspaces.delete("ws_xxx")
@@ -430,7 +426,7 @@ client.enterprise.workspaces.revoke_key("ws_xxx", "key_abc")
 ### Webhooks & Analytics
 
 ```ruby
-client.enterprise.webhooks.set("https://yourapp.com/webhooks")
+client.enterprise.webhooks.set(url: "https://yourapp.com/webhooks")
 overview = client.enterprise.analytics.overview
 messages = client.enterprise.analytics.messages(period: "30d")
 delivery = client.enterprise.analytics.delivery

data/lib/sendly/client.rb

@@ -23,18 +23,33 @@ module Sendly
     # @return [String, nil] Organization ID
     attr_accessor :organization_id
 
-    # Create a new Sendly client
+    # Create a new Sendly client.
     #
-    # @param api_key [String] Your Sendly API key
-    # @param base_url [String] API base URL (optional)
+    # Two calling conventions are supported (both produce the same client):
+    #
+    #   # Positional (matches Sendly's published code samples and the
+    #   # idiom of most other Ruby HTTP SDKs):
+    #   client = Sendly::Client.new("sk_live_v1_xxx")
+    #   client = Sendly::Client.new("sk_live_v1_xxx", timeout: 60)
+    #
+    #   # Keyword (existing v3.30.0 signature):
+    #   client = Sendly::Client.new(api_key: "sk_live_v1_xxx")
+    #
+    # @param api_key [String, nil] Your Sendly API key (also accepted as positional)
+    # @param base_url [String, nil] API base URL (optional)
     # @param timeout [Integer] Request timeout in seconds (default: 30)
     # @param max_retries [Integer] Maximum retry attempts (default: 3)
     # @param organization_id [String, nil] Organization ID (optional)
-    #
-    # @example
-    #   client = Sendly::Client.new("sk_live_v1_xxx")
-    #   client = Sendly::Client.new("sk_live_v1_xxx", timeout: 60, max_retries: 5)
-    def initialize(api_key:, base_url: nil, timeout: 30, max_retries: 3, organization_id: nil)
+    def initialize(*args, api_key: nil, base_url: nil, timeout: 30, max_retries: 3, organization_id: nil)
+      # Backward-compatible positional API key. Previously this constructor
+      # only accepted `api_key:` as a keyword; every code sample in our
+      # docs used positional, breaking copy-paste for new users.
+      if !args.empty?
+        raise ArgumentError, "Sendly::Client.new accepts at most one positional argument (api_key)" if args.length > 1
+        raise ArgumentError, "Cannot pass api_key both positionally and as keyword" unless api_key.nil?
+        api_key = args.first
+      end
+
       @api_key = api_key
       @base_url = (base_url || Sendly.base_url).chomp("/")
       @timeout = timeout

data/lib/sendly/enterprise.rb

@@ -31,25 +31,77 @@ module Sendly
       @client.delete("/enterprise/workspaces/#{workspace_id}")
     end
 
-    def submit_verification(workspace_id, business_name:, business_type:, ein:, address:, city:, state:, zip:, use_case:, sample_messages:, monthly_volume: nil)
+    # Submit (or resubmit) a verification for an enterprise workspace.
+    #
+    # Partial-update friendly (May 2026): for resubmit on an existing
+    # workspace, you only need to send the fields you want to change —
+    # everything else is preserved from the existing record. Hosted page
+    # URLs (/biz/, /opt-in/, /legal/) generated during provision are
+    # auto-preserved.
+    #
+    # For sole proprietors, leave brn/brn_type/brn_country nil — the
+    # server strips them before forwarding to the carrier.
+    #
+    # Accepts snake_case keyword arguments which are transformed to the
+    # camelCase keys the API expects. Nested +address+ and +contact+
+    # hashes should already use camelCase keys (e.g. +firstName+,
+    # +lastName+) since they are passed through verbatim.
+    #
+    # Example (full submit):
+    #
+    #   client.enterprise.workspaces.submit_verification(workspace_id,
+    #     business_name: "Acme LLC",
+    #     website: "https://acme.com",
+    #     address: { street: "...", city: "...", state: "California", zip: "90001", country: "US" },
+    #     contact: { firstName: "...", lastName: "...", email: "...", phone: "+15551234567" },
+    #     use_case: "Insurance Services",
+    #     use_case_summary: "...",
+    #     sample_messages: "...",
+    #     opt_in_workflow: "...",
+    #     entity_type: "SOLE_PROPRIETOR")
+    #
+    # Example (partial-update resubmit, only changing email):
+    #
+    #   client.enterprise.workspaces.submit_verification(workspace_id,
+    #     contact: { email: "new@email.com" })
+    def submit_verification(workspace_id, business_name: nil, doing_business_as: nil, website: nil, entity_type: nil, address: nil, contact: nil, brn: nil, brn_type: nil, brn_country: nil, use_case: nil, use_case_summary: nil, sample_messages: nil, opt_in_workflow: nil, opt_in_image_urls: nil, monthly_volume: nil, additional_information: nil, age_gated_content: nil, isv_reseller: nil, privacy_url: nil, terms_url: nil)
       raise ArgumentError, "Workspace ID is required" if workspace_id.nil? || workspace_id.empty?
 
-      body = {
-        business_name: business_name,
-        business_type: business_type,
-        ein: ein,
-        address: address,
-        city: city,
-        state: state,
-        zip: zip,
-        use_case: use_case,
-        sample_messages: sample_messages
-      }
-      body[:monthly_volume] = monthly_volume if monthly_volume
+      body = {}
+      body[:businessName] = business_name unless business_name.nil?
+      body[:doingBusinessAs] = doing_business_as unless doing_business_as.nil?
+      body[:website] = website unless website.nil?
+      body[:entityType] = entity_type unless entity_type.nil?
+      body[:address] = address unless address.nil?
+      body[:contact] = contact unless contact.nil?
+      body[:brn] = brn unless brn.nil?
+      body[:brnType] = brn_type unless brn_type.nil?
+      body[:brnCountry] = brn_country unless brn_country.nil?
+      body[:useCase] = use_case unless use_case.nil?
+      body[:useCaseSummary] = use_case_summary unless use_case_summary.nil?
+      body[:sampleMessages] = sample_messages unless sample_messages.nil?
+      body[:optInWorkflow] = opt_in_workflow unless opt_in_workflow.nil?
+      body[:optInImageUrls] = opt_in_image_urls unless opt_in_image_urls.nil?
+      body[:monthlyVolume] = monthly_volume unless monthly_volume.nil?
+      body[:additionalInformation] = additional_information unless additional_information.nil?
+      body[:ageGatedContent] = age_gated_content unless age_gated_content.nil?
+      body[:isvReseller] = isv_reseller unless isv_reseller.nil?
+      body[:privacyUrl] = privacy_url unless privacy_url.nil?
+      body[:termsUrl] = terms_url unless terms_url.nil?
 
       @client.post("/enterprise/workspaces/#{workspace_id}/verification/submit", body)
     end
 
+    # Convenience alias for resubmits. Identical to +submit_verification+
+    # but reads more naturally when you only want to update a few fields
+    # after a rejection.
+    #
+    #   client.enterprise.workspaces.resubmit_verification(workspace_id,
+    #     contact: { email: "new@email.com" })
+    def resubmit_verification(workspace_id, **partial_updates)
+      submit_verification(workspace_id, **partial_updates)
+    end
+
     def inherit_verification(workspace_id, source_workspace_id:)
       raise ArgumentError, "Workspace ID is required" if workspace_id.nil? || workspace_id.empty?
       raise ArgumentError, "Source workspace ID is required" if source_workspace_id.nil? || source_workspace_id.empty?

data/lib/sendly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendly
 version: !ruby/object:Gem::Version
-  version: 3.30.0
+  version: 3.31.0
 platform: ruby
 authors:
 - Sendly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-05-01 00:00:00.000000000 Z
+date: 2026-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday