bzapper 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c424228e334385c5d1e747d6951f6c76df26255765678d7748430642cfcb4c1
-  data.tar.gz: 3b27b1c1a0bffffa53937fe6d0f19e8486afa18ecdbe8dd08044160103413ae5
+  metadata.gz: c30f72803594b155b3d1e19c4f375b634de0c9da69ffed8487f598e27e281661
+  data.tar.gz: e303cafe2aea6f5174c67cc11201d52213ec7dd8290cf75357402f475693533f
 SHA512:
-  metadata.gz: c071f315d70aefbaf8eb98933d36c42c2f45d2fee7b3cbdd66db0d7a141b6e978e7d65f7337d6ef2b5cdb744569fd47efe3c91cba05b8525eabf9f9234908025
-  data.tar.gz: b7e9fed41f47242ba1c0fd659c5dc0255ae3ac48a6db969be4ed38806c047ebb72b4f63800c5224f1a389d2b9e32efd374e73f9341399c0326f0c68c088c35b0
+  metadata.gz: 634a810f034b09f0389c1f2dc4ff95de5c13fee9c5cd1196eee55d83b644e7df03178a313a1165fde6f090556195a1ec428c8df1b18c5b8f9c7ba9439cd040c1
+  data.tar.gz: 8045dda0d3906b6c43bc60f4750891d5e754464d80fea1fdc277e7ff253cab428a5125e255faf68bb06fe43da49b18c13617f1fe016ec835c40241dcf2e49f99

data/README.md

@@ -10,13 +10,13 @@ Zero dependências de runtime (só biblioteca padrão: `net/http`, `json`, `open
 ## Instalação
 
 ```bash
-gem install bzapper -v 0.7.0
+gem install bzapper -v 0.7.1
 ```
 
 Ou no `Gemfile` — **fixe a versão exata** (cada release declara se muda a superfície pública):
 
 ```ruby
-gem "bzapper", "0.7.0"
+gem "bzapper", "0.7.1"
 ```
 
 ## Hello world

data/lib/bzapper/resources/accounts.rb

@@ -34,7 +34,7 @@ module Bzapper
 
       # Revoke a tenant API key. Admin only. `DELETE /keys/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] API key ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -198,7 +198,7 @@ module Bzapper
       #
       # `api_mode` is immutable and is ignored here.
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Project ID (UUID).
       # @param name [String] (corpo)
       # @param logo_url [String, nil] (corpo)
       # @param color [String, nil] (corpo)
@@ -223,7 +223,7 @@ module Bzapper
 
       # Delete a project (admin). `DELETE /projects/{id}`
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Project ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -238,7 +238,7 @@ module Bzapper
 
       # Identity of the numbers of a specific project. `GET /projects/{id}/brand`
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Project ID (UUID).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
       # @raise [Bzapper::Error] resposta fora de 2xx ou falha de rede.
@@ -249,7 +249,7 @@ module Bzapper
 
       # Save the identity of a specific project's numbers (admin). `PUT /projects/{id}/brand`
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Project ID (UUID).
       # @param about [String, nil] (corpo) "About"/status — applied to all numbers.
       # @param display_name [String, nil] (corpo) Business name (kit).
       # @param logo_url [String, nil] (corpo) Logo URL (kit).
@@ -286,7 +286,7 @@ module Bzapper
       # Upload the project logo (multipart, PNG/JPEG/WebP up to 5 MB) — admin. `POST
       # /projects/{id}/logo`
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Project ID (UUID).
       # @param file [String, IO, Pathname] conteúdo do arquivo (bytes), um IO ou o caminho no disco.
       # @param filename [String, nil] nome do arquivo (padrão: o do caminho, senão "file").
       # @param content_type [String, nil] tipo MIME (padrão: application/octet-stream).
@@ -337,7 +337,7 @@ module Bzapper
       #
       # Demoting the last administrator of the account is refused (409 last_admin).
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Account user ID (UUID).
       # @param role [String] (corpo) agent = member (no billing)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
@@ -359,7 +359,7 @@ module Bzapper
       #
       # You cannot remove yourself (409 self_remove) nor the last administrator (409 last_admin).
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Account user ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/advanced.rb

@@ -8,7 +8,7 @@ module Bzapper
     class Advanced < Base
       # Edit the text of a sent message. `PATCH /messages/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] bZapper message ID (UUID) — the `id` returned when the message was queued.
       # @param text [String] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
@@ -28,7 +28,7 @@ module Bzapper
 
       # Revoke a message (delete for everyone). `DELETE /messages/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] bZapper message ID (UUID) — the `id` returned when the message was queued.
       # @param for_everyone [Boolean, nil] (query)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
@@ -121,7 +121,7 @@ module Bzapper
 
       # Archive/unarchive a chat. `POST /chats/{jid}/archive`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Chat JID — contact (…@s.whatsapp.net / …@lid) or group (…@g.us).
       # @param instance_id [String] (corpo)
       # @param on [Boolean] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
@@ -143,7 +143,7 @@ module Bzapper
 
       # Pin/unpin a chat. `POST /chats/{jid}/pin`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Chat JID — contact (…@s.whatsapp.net / …@lid) or group (…@g.us).
       # @param instance_id [String] (corpo)
       # @param on [Boolean] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
@@ -165,7 +165,7 @@ module Bzapper
 
       # Mark a chat read/unread. `POST /chats/{jid}/read`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Chat JID — contact (…@s.whatsapp.net / …@lid) or group (…@g.us).
       # @param instance_id [String] (corpo)
       # @param on [Boolean] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
@@ -187,7 +187,7 @@ module Bzapper
 
       # Mute/unmute a chat. `POST /chats/{jid}/mute`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Chat JID — contact (…@s.whatsapp.net / …@lid) or group (…@g.us).
       # @param instance_id [String] (corpo)
       # @param on [Boolean] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
@@ -209,7 +209,7 @@ module Bzapper
 
       # Apply/remove a label on a chat (experimental). `POST /chats/{jid}/labels`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Chat JID — contact (…@s.whatsapp.net / …@lid) or group (…@g.us).
       # @param instance_id [String] (corpo)
       # @param label_id [String] (corpo)
       # @param apply [Boolean, nil] (corpo) true = apply, false = remove.
@@ -289,7 +289,7 @@ module Bzapper
 
       # Block a contact. `POST /contacts/{jid}/block`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Contact JID (…@s.whatsapp.net) to block/unblock.
       # @param instance_id [String] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
@@ -309,7 +309,7 @@ module Bzapper
 
       # Unblock a contact. `POST /contacts/{jid}/unblock`
       #
-      # @param jid [String] Group JID (…@g.us).
+      # @param jid [String] Contact JID (…@s.whatsapp.net) to block/unblock.
       # @param instance_id [String] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).

data/lib/bzapper/resources/advisories.rb

@@ -22,7 +22,7 @@ module Bzapper
       #
       # Marks the advisory as handled; it stops being returned by `GET /advisories`.
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Advisory ID.
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/campaigns.rb

@@ -107,7 +107,7 @@ module Bzapper
 
       # Get a campaign with stats and variations. `GET /campaigns/{id}`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
       # @raise [Bzapper::Error] resposta fora de 2xx ou falha de rede.
@@ -121,7 +121,7 @@ module Bzapper
       # Updates name, pacing, schedule and (if sent) replaces the variations. Only allowed while
       # draft/scheduled — 409 once started.
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param name [String, nil] (corpo)
       # @param pacing_profile [String, nil] (corpo)
       # @param start_at [Time, String, nil] (corpo) Future start = scheduled campaign.
@@ -148,7 +148,7 @@ module Bzapper
 
       # List recipients with per-contact delivery. `GET /campaigns/{id}/recipients`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param limit [Integer, nil] (query)
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -163,7 +163,7 @@ module Bzapper
 
       # Add (or replace) recipients. `POST /campaigns/{id}/recipients`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param recipients [Array<Hash>, nil] (corpo)
       # @param contacts [Hash, nil] (corpo) Map of phone → payload, e.g. {"+5551999198087": {"name":
       #   "Vinicius"}}.
@@ -196,7 +196,7 @@ module Bzapper
 
       # Start (or schedule) a campaign. `POST /campaigns/{id}/start`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -211,7 +211,7 @@ module Bzapper
 
       # Pause a campaign. `POST /campaigns/{id}/pause`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -226,7 +226,7 @@ module Bzapper
 
       # Resume a campaign. `POST /campaigns/{id}/resume`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -241,7 +241,7 @@ module Bzapper
 
       # Cancel a campaign. `POST /campaigns/{id}/cancel`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -256,7 +256,7 @@ module Bzapper
 
       # Simulate a campaign without sending. `POST /campaigns/{id}/dry-run`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Campaign ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/connect.rb

@@ -18,7 +18,7 @@ module Bzapper
       # Disconnect a partner app (admin). The partner's key stops working immediately. `DELETE
       # /me/connections/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Connected partner app (connection) ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/contacts.rb

@@ -337,7 +337,7 @@ module Bzapper
       #
       # Removes the tag from the dictionary and unlinks it from every contact.
       #
-      # @param id [String] Contact ID (UUID).
+      # @param id [String] Tag ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -389,7 +389,7 @@ module Bzapper
       #
       # Removes the contact group from the dictionary and unlinks it from every contact.
       #
-      # @param id [String] Contact ID (UUID).
+      # @param id [String] Contact group ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/partner.rb

@@ -89,7 +89,7 @@ module Bzapper
 
       # Get one connection (status, account, numbers). `GET /partner/connections/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Partner connection ID (UUID).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
       # @raise [Bzapper::Error] resposta fora de 2xx ou falha de rede.
@@ -101,7 +101,7 @@ module Bzapper
       # End a connection (revokes the key; does NOT cancel the customer's plan). `DELETE
       # /partner/connections/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Partner connection ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -117,7 +117,7 @@ module Bzapper
       # Issue a new API key for a completed connection (the previous key stops working). `POST
       # /partner/connections/{id}/rotate-key`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Partner connection ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/pools.rb

@@ -36,7 +36,7 @@ module Bzapper
 
       # Get a pool (with members). `GET /pools/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Pool ID (UUID).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
       # @raise [Bzapper::Error] resposta fora de 2xx ou falha de rede.
@@ -47,7 +47,7 @@ module Bzapper
 
       # Add a number to the pool. `POST /pools/{id}/numbers`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Pool ID (UUID).
       # @param instance_id [String] (corpo)
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).

data/lib/bzapper/resources/scheduling.rb

@@ -21,7 +21,7 @@ module Bzapper
 
       # Cancel a pending scheduled send. `DELETE /messages/scheduled/{id}`
       #
-      # @param id [String] parâmetro de caminho
+      # @param id [String] Scheduled message ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/resources/webhooks.rb

@@ -47,7 +47,7 @@ module Bzapper
       # = true. With `secret: "regenerate"` a new secret is generated and returned ONCE in the
       # response; any other non-empty `secret` replaces it.
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Webhook ID (UUID).
       # @param url [String] (corpo)
       # @param secret [String, nil] (corpo) Empty = keep. "regenerate" = rotate (returned once).
       # @param event_types [Array<String>, nil] (corpo) Empty = all events.
@@ -76,7 +76,7 @@ module Bzapper
 
       # Remove a webhook. `DELETE /webhooks/{id}`
       #
-      # @param id [String] Instance ID (UUID).
+      # @param id [String] Webhook ID (UUID).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).
@@ -91,7 +91,7 @@ module Bzapper
 
       # Send a signed sample event to this webhook and report the result. `POST /webhooks/{id}/test`
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Webhook ID (UUID).
       # @param event_type [String, nil] (corpo) Event type of the sample (default a generic one).
       # @param idempotency_key [String, nil] chave de idempotência (senão a SDK gera uma).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
@@ -111,7 +111,7 @@ module Bzapper
 
       # Latest deliveries of a webhook. `GET /webhooks/{id}/deliveries`
       #
-      # @param id [String] Resource ID (UUID).
+      # @param id [String] Webhook ID (UUID).
       # @param limit [Integer, nil] (query) 1–200 (default 50).
       # @param timeout [Numeric, nil] segundos por tentativa (padrão: o do cliente).
       # @return [Hash, Array, nil] o JSON da resposta, inteiro (nil em 204).

data/lib/bzapper/version.rb

@@ -3,5 +3,5 @@
 module Bzapper
   # Versão da gem. O `scripts/release-sdks.sh` do monorepo bumpa a linha abaixo por regex
   # (ancorada no início da linha) e o `bzapper.gemspec` lê daqui — não mude o formato dela.
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bzapper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Berni Software