sendly 4.5.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 511e36e32d4475552b4000a026856bde62c06bd7f43a52b59646c347d7ff4b0c
-  data.tar.gz: 92531f77aa366320d2887a3b9a0ac9793c6562d507f3863577352830097f4d32
+  metadata.gz: e684d2e1e6cb9addd168326d6874152b070b68ab599ba9370eca565a8a70d3ce
+  data.tar.gz: 13ddbe1ae8aed4e2683515a8a7de05f135c037dd12984974a92e173158cf2843
 SHA512:
-  metadata.gz: 000020f0a21c87fb3f4b33ca84fad93e36a73abaa936ca602b22c3065e7fbc3d09b2c0fe62b02f2080dbab1f2b4d37d8ad60648d08e0a0d022a71bbcd64b1ee6
-  data.tar.gz: fbc1718f201afe7895d433d989bf41e7c0938fac6c029dca8380b2d88620ef56d65851a258b9d3e39ad683652023e8468ef534c8a459ce930fcf35cc6d07ddba
+  metadata.gz: dab32a1714f5fbe937f3d109d03b4e634311ac890c7f3126dc98653eaa88631ddb2ba6591697f5be9b59595530e5e85d1932b951e645675b79e89b677adbc2db
+  data.tar.gz: 53bf4c50b966f79ca3221292ffd2095e6d21007e50421fbd0aa6e7f4c3067060c63ec6ff0524fe87ceeee62690cd83aaafd0bceb83534658d5243677e44d91b1

data/Gemfile.lock

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

data/README.md

@@ -1153,11 +1153,13 @@ puts status.disabled?
 
 Connect a number you own to WhatsApp, create Meta-reviewed message
 templates, and send via `client.messages.send(channel: "whatsapp", ...)`.
-Connecting is free (no monthly fee either). The first number always
-ends with a human step: the signup returns a connect URL a person must open in
-a browser and log in with Facebook to link their WhatsApp Business Account.
-More numbers can then be added to that account with a 6-digit code Meta sends
-to the number, with no Facebook step (also free).
+Connecting costs a one-time $9.99 fee per number (no monthly fee), charged to
+your card when you start connecting it, refunded automatically if the
+connection fails, and not refundable once the number is connected. The first
+number always ends with a human step: the signup returns a connect URL a person
+must open in a browser and log in with Facebook to link their WhatsApp Business
+Account. More numbers can then be added to that account with a 6-digit code Meta sends
+to the number, with no Facebook step (same $9.99 fee, refunded if it fails).
 
 Sends go through `messages.send(channel: "whatsapp")` and need `sms:send`,
 not `whatsapp:write`. Reads (`signup.get`, templates, the window, senders and
@@ -1191,14 +1193,16 @@ gives its slot back. Note: Meta
 has paused marketing template delivery to US (+1) numbers.
 
 ```ruby
-# 1. Connect a number (free; a human must open the connect URL)
+# 1. Connect a number ($9.99 one-time; a human must open the connect URL)
 signup = client.whatsapp.signup.create(phone_number: "+15125550123")
 puts "Have your user open: #{signup.connect_url}"
 
 # 2. Poll until active. After the Facebook step the signup is "registering"
 # while WhatsApp activates the number. Activation usually takes a few minutes
 # but can take hours. If it hasn't finished about 6 hours after the session
-# began, the session fails with registration_timeout.
+# began, the session fails with registration_timeout and the fee is refunded.
+# If the connection fails, the $9.99 fee is refunded automatically; once a
+# number has connected, a later disconnect gets nothing back.
 status = client.whatsapp.signup.get(signup.id)
 puts status.failure_reasons if status.failed?  # e.g. ["waba_mismatch"]
 
@@ -1322,7 +1326,7 @@ WhatsApp errors map onto the usual classes:
   while WhatsApp connections are unavailable. Only signup returns it; no send
   does. Nothing is charged, the response carries a `Retry-After: 3600` header,
   and `e.response_body["retryAfter"]` (3600) says how many seconds to wait; the client
-  retries it like any 5xx before raising. After 5 failed signups in
+  retries it like any 5xx before raising. After 5 failed, charged signups in
   24 hours it raises `Sendly::RateLimitError` for 429
   `whatsapp_signup_limit_reached`, which is not retried: try again the next
   day.
@@ -1366,18 +1370,17 @@ WhatsApp errors map onto the usual classes:
   `whatsapp_signup_in_progress` and `whatsapp_already_enabled`, and
   `Sendly::ServerError` for 503 `whatsapp_verification_start_failed` (WhatsApp
   couldn't start verifying the number; start again). Either failure fails the
-  session. With `business_account_id:` the client never retries a 5xx, a
-  timeout or a dropped connection, because each retry would start a new
-  session. A
-  Facebook signup for a number
+  session and refunds its fee. With `business_account_id:` the client never
+  retries a 5xx, a timeout or a dropped connection, because each retry would
+  start a new charged session. A Facebook signup for a number
   that is being added by code gets 409 `whatsapp_verification_in_progress`,
   with that session's id in `e.response_body["id"]`.
 - `signup.verify` raises `Sendly::ValidationError` for 400
   `invalid_verification_code` (not 6 digits) and 422
   `whatsapp_verification_code_invalid` (a wrong code, with
   `e.response_body["attemptsRemaining"]`); `Sendly::APIError` (409) for
-  `whatsapp_verification_failed` (after 5 wrong codes the session fails),
-  `whatsapp_verification_busy` (try again) and
+  `whatsapp_verification_failed` (after 5 wrong codes the session fails and
+  the fee is refunded), `whatsapp_verification_busy` (try again) and
   `signup_not_active`; and `Sendly::ServerError` for 503
   `whatsapp_verification_unavailable` (the attempt isn't counted) and
   `whatsapp_activation_pending` (the code was accepted but connecting didn't

data/lib/sendly/version.rb

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

data/lib/sendly/whatsapp_resource.rb

@@ -63,8 +63,8 @@ module Sendly
   # The status of a WhatsApp signup. +status+ is +"initiated"+,
   # +"registering"+ (WhatsApp is activating the number; activation usually
   # takes a few minutes but can take hours, and a session that hasn't
-  # finished about 6 hours after it began fails with +registration_timeout+),
-  # +"verifying"+ (a number being added to an
+  # finished about 6 hours after it began fails with +registration_timeout+
+  # and the fee is refunded), +"verifying"+ (a number being added to an
   # already-connected account, waiting for its code), +"active"+ or
   # +"failed"+. The API does not send +"expired"+,
   # so {#expired?} is never true; it stays for compatibility.
@@ -72,8 +72,7 @@ module Sendly
   # +"active"+ (from the start for a number added by code); it is nil while
   # +"initiated"+ or +"registering"+ and after a failure.
   # +failure_reasons+ is set when the status is +"failed"+, with one code:
-  # +setup_fee_payment_failed+ (the connection couldn't be started),
-  # +signup_abandoned+, +meta_exchange_failed+,
+  # +setup_fee_payment_failed+, +signup_abandoned+, +meta_exchange_failed+,
   # +registration_failed+, +waba_already_connected+, +waba_mismatch+ (the
   # WhatsApp Business Account chosen in the Facebook step doesn't hold the
   # verified number), +registration_timeout+ (activation hadn't finished
@@ -81,6 +80,7 @@ module Sendly
   # +verification_start_failed+ (WhatsApp couldn't start verifying an added
   # number), +verification_failed+ (too many wrong codes) or
   # +verification_expired+ (a verifying session left untouched for an hour).
+  # If the connection fails, the $9.99 fee is refunded automatically.
   #
   # While the status is +"verifying"+, +verification_method+ (+"sms"+ or
   # +"voice"+) and +verification_attempts_remaining+ are set, and on
@@ -533,31 +533,35 @@ module Sendly
 
     # Start connecting a number to WhatsApp.
     #
-    # Connecting a number is free (no setup or monthly fee). Returns a
+    # Charges a one-time $9.99 connection fee per number (no monthly fee) to
+    # your card when the connection starts, and returns a
     # +connect_url+. Completing the connection requires a human: hand the
     # URL to your user — they open it in a browser and log in with Facebook
     # to link their WhatsApp Business Account. Then poll {#get} until the
     # status is +"active"+.
     #
     # Calling again for a number with an in-flight signup returns the
-    # existing signup (same +connect_url+). Requires
+    # existing signup (same +connect_url+) without charging again. Requires
     # a live API key with the +whatsapp:write+ scope (a test key gets 403
     # +whatsapp_requires_live_key+) and, in a team workspace, an owner or
     # admin (+settings:write+). After the Facebook step the signup stays
     # +"registering"+ while WhatsApp activates the number. Activation usually
     # takes a few minutes but can take hours. If it hasn't finished about 6
     # hours after the session began, the session fails with
-    # +registration_timeout+.
+    # +registration_timeout+ and the fee is refunded. If the connection
+    # fails, the $9.99 fee is refunded automatically; once the number has
+    # connected it is not refundable, and a later disconnect gets nothing
+    # back.
     #
     # To add a number to a WhatsApp Business Account this workspace has
     # already connected, pass its +business_account_id+ (as shown on
     # {WhatsAppSender#business_account_id}). There is no Facebook step and no
-    # +connect_url+: it is free too, Meta sends the number a
+    # +connect_url+: the same $9.99 fee is charged, Meta sends the number a
     # 6-digit code by text or voice call, and the session is +"verifying"+
     # until you submit the code with {#verify}. Calling again for a number
-    # that is verifying returns the same session without sending a second
-    # code; a verifying session older than 3 hours is expired and a new one
-    # is started.
+    # that is verifying returns the same session without charging again or
+    # sending a second code; a verifying session older than 3 hours is
+    # expired (and refunded) and a new one is started.
     #
     # @param phone_number [String] The number to connect, in E.164 format.
     #   Must be an active number in your workspace.
@@ -572,12 +576,12 @@ module Sendly
     #   +business_account_id+.
     # @return [WhatsAppSignupSession]
     # @raise [Sendly::ServerError] +whatsapp_unavailable+ (503) while
-    #   WhatsApp connections are unavailable. Only
+    #   WhatsApp connections are unavailable. Nothing is charged. Only
     #   signup returns it, with +retryAfter+ 3600 in the body
     #   (+e.response_body["retryAfter"]+) and a +Retry-After: 3600+ header.
     #   The client retries it like any 5xx before raising.
     # @raise [Sendly::RateLimitError] +whatsapp_signup_limit_reached+ (429)
-    #   after 5 failed signups (or 20 cancelled) in 24 hours. Not retried;
+    #   after 5 failed, charged signups (or 20 cancelled) in 24 hours. Not retried;
     #   try again the next day.
     # @raise [Sendly::NotFoundError] +whatsapp_business_account_not_found+
     #   (404) when +business_account_id+ isn't connected in this workspace
@@ -585,7 +589,7 @@ module Sendly
     # @raise [Sendly::ValidationError] +display_name_required+ (400) when no
     #   display name is given and the account has none to reuse, and
     #   +whatsapp_verification_start_failed+ (422) when WhatsApp refused to
-    #   verify the number: final, the session failed.
+    #   verify the number: final, the session failed and the fee is refunded.
     # @raise [Sendly::APIError] 409 +whatsapp_signup_in_progress+ (a Facebook
     #   connection for the number is in flight; +e.response_body["id"]+ is
     #   that session), 409 +whatsapp_verification_in_progress+ (a Facebook
@@ -594,14 +598,14 @@ module Sendly
     #   still being added, so try again in a moment) or 409
     #   +whatsapp_already_enabled+.
     # @raise [Sendly::InsufficientCreditsError] 402 +payment_method_required+
-    #   or +payment_failed+: not returned while connecting a number is free.
+    #   or +payment_failed+ when the $9.99 fee can't be charged.
     # @raise [Sendly::ServerError] +whatsapp_verification_start_failed+ (503)
-    #   when WhatsApp couldn't start verifying the number: the session failed,
-    #   so start again. With +business_account_id+, a 5xx is raised at once
-    #   and never retried by the client, because each retry would start a
-    #   new session (a timeout or dropped connection is never retried
-    #   either). Without it the client retries a 5xx before raising, as
-    #   before.
+    #   when WhatsApp couldn't start verifying the number: the session failed
+    #   and its fee is refunded, so start again. With +business_account_id+,
+    #   a 5xx is raised at once and never retried by the client, because
+    #   each retry would start a new charged session (a timeout or dropped
+    #   connection is never retried either). Without it the client retries a
+    #   5xx before raising, as before.
     #
     # @example
     #   signup = client.whatsapp.signup.create(phone_number: "+15559876543")
@@ -646,7 +650,7 @@ module Sendly
     #   (422) for a wrong code, with the attempts left in
     #   +e.response_body["attemptsRemaining"]+
     # @raise [Sendly::APIError] 409 +whatsapp_verification_failed+ after 5
-    #   wrong codes (the session failed and
+    #   wrong codes (the session failed, the fee is refunded and
     #   +whatsapp_account.failed+ fires), 409 +whatsapp_verification_busy+
     #   while another code for the number is being checked (try again), or
     #   409 +signup_not_active+ when the signup isn't waiting for a code or is
@@ -1150,7 +1154,7 @@ module Sendly
   # create Meta-reviewed message templates, and send via
   # +client.messages.send(channel: "whatsapp", ...)+.
   #
-  # Connecting a number is free (no setup or monthly fee). The first
+  # Connecting a number costs a one-time $9.99 fee (no monthly fee). The first
   # number always ends with a human step: {WhatsAppSignupResource#create}
   # returns a +connect_url+ that a person must open in a browser and log in
   # with Facebook to link their WhatsApp Business Account. More numbers can
@@ -1192,7 +1196,7 @@ module Sendly
   # every method on this resource gets 404 +not_found+.
   #
   # @example Connect a number, create a template, then send
-  #   # 1. Connect (free; a human must open the connect URL)
+  #   # 1. Connect ($9.99 one-time; a human must open the connect URL)
   #   signup = client.whatsapp.signup.create(phone_number: "+15559876543")
   #   puts "Have your user open: #{signup.connect_url}"
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendly
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.1
 platform: ruby
 authors:
 - Sendly
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-18 00:00:00.000000000 Z
+date: 2026-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday