tango-api-client 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88450e3c1efb08e7e580777f396ba0204c799c2085f00c9fa0aaa3e8bb88ba3b
-  data.tar.gz: 3f293079d5ca3722ef14c6a25a605e86abfe3e69ca42618e7ee0ab94900c41e3
+  metadata.gz: f7475c292cfcb29d85404d80d86cb94f47c4d0497dcfd97743366be0af176933
+  data.tar.gz: 69d61b9a8d860fd5734557d61aec61ae8d969634803c3a97e87f23db9ead35e1
 SHA512:
-  metadata.gz: 58cf36892477434d0e0aad46e2e89dfe82cd87e450d6644693d2f710f4117670c9d995297c0a0589ba605dc479458123943911bd12491cfd308a3d9ed1b30d7f
-  data.tar.gz: 1d183742be3c3599f7df9e7fa5000e65f6f260ad99cd1e5bb77d8335ac2d862b75019bad430ee96d0efcdd459865056ebbc7791133d1a86b9891f9acc4d4e939
+  metadata.gz: 1243790a92ce6dba4870e506fb86e00a9436bf7c9c6e206e6d7d908b7011a0a06139ee0ba2decd3f6d0b4dd1341bd856484b66c7ad252886b88f091cb0faebc3
+  data.tar.gz: 6205cc363c7e1d2ef985b31fedb377a53c242d9d7339568d1bb5480be0aa8aecfc249fb1b71dc3b05efc4d208ef8e65311c405cb40244f31b0029404fa2262be

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 - Nothing yet.
 
+## [0.2.0] - 2026-11-09
+- Add Webhooks resource for subscription management: `create`, `list`, `get`, `update`, `delete`, `renew`
+- Add webhook event history and redelivery: `events` (cursor paging, revision range) and `replay` (`fromRevision`/`toRevision` query params)
+- Add `test` to trigger Tango's test deliveries (`ConnectivityTest`, or an event type such as `ItemAvailability` in the sandbox)
+- `Resources::Base#post_without_body` for POST action endpoints that take only path and query parameters
+
 ## [0.1.2] - 2025-11-12
 - Add Brand Categories resource: `get` method for `/brandCategories` endpoint
 

data/README.md

@@ -115,6 +115,19 @@ client.orders.create(
 
 # Resend with Idempotency-Key (prevents duplicate resends)
 client.orders.resend('ORDER-123', idempotency_key: idempotency)
+
+# Webhook subscriptions (HMAC-signed ItemAvailability events)
+sub = client.webhooks.create(
+  url: 'https://example.com/v1/tango/webhooks',
+  eventTypes: ['ItemAvailability'],
+  headers: [{ name: 'X-Subscription-Generation', value: '1' }],
+  payloadVerificationMethod: 'HMAC',
+  hmacSharedSecretKey: Base64.strict_encode64(SecureRandom.bytes(32))
+)
+client.webhooks.renew(sub['webhookId'])                       # => { 'webhookId', 'expiresAt' }
+client.webhooks.events(sub['webhookId'], fromRevision: 0, maxResults: 100)
+client.webhooks.replay(sub['webhookId'], from_revision: 0)    # redeliver up to 3 months back
+client.webhooks.test(sub['webhookId'], 'ItemAvailability')     # sandbox only
 ```
 
 ### Resources overview
@@ -130,6 +143,7 @@ client.orders.resend('ORDER-123', idempotency_key: idempotency)
 | Status    | `Tango::Api::Resources::Status`   | `get`                                                                                  | GET `/status`                                      |
 | Exchange Rates | `Tango::Api::Resources::ExchangeRates` | `get(params = {})`, `get_for_utid(utid, params = {})`                            | GET `/exchangeRates`; GET `/exchangeRates/{utid}`  |
 | Choice Products | `Tango::Api::Resources::ChoiceProducts` | `get(params = {})`, `get_for_utid(utid)`, `catalog(choice_product_utid, params = {})` | GET `/choiceProducts`; GET `/choiceProducts/{utid}`; GET `/choiceProducts/{utid}/catalog` |
+| Webhooks | `Tango::Api::Resources::Webhooks` | `create(body)`, `list(params = {})`, `get(webhook_id)`, `update(webhook_id, body)`, `delete(webhook_id)`, `renew(webhook_id)`, `events(webhook_id, params = {})`, `replay(webhook_id, from_revision:, to_revision: nil)`, `test(webhook_id, test_name)` | POST/GET `/webhooks`; GET/PATCH/DELETE `/webhooks/{webhookId}`; POST `/webhooks/{webhookId}/renew`; GET `/webhooks/{webhookId}/events`; POST `/webhooks/{webhookId}/replay`; POST `/webhooks/{webhookId}/tests/{testName}` |
 
 ### Smoke test
 

data/lib/tango/api/client/version.rb

@@ -3,7 +3,7 @@
 module Tango
   module Api
     class Client
-      VERSION = "0.1.2"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/tango/api/client.rb

@@ -20,6 +20,7 @@ require_relative "resources/status"
 require_relative "resources/exchange_rates"
 require_relative "resources/choice_products"
 require_relative "resources/brand_categories"
+require_relative "resources/webhooks"
 
 module Tango
   module Api
@@ -83,6 +84,10 @@ module Tango
         Resources::BrandCategories.new(@conn)
       end
 
+      def webhooks
+        Resources::Webhooks.new(@conn)
+      end
+
       private
 
       def build_connection

data/lib/tango/api/resources/base.rb

@@ -53,6 +53,19 @@ module Tango
           raise map_faraday_error(e)
         end
 
+        # POST with no request body, for action endpoints that take only path and query
+        # parameters (e.g. webhook renew, replay, tests). Empty or non-JSON success bodies
+        # such as "OK" are returned as {} or { "raw" => body }.
+        def post_without_body(path, params = nil)
+          response = @conn.post(path) { |req| req.params.update(params) if params }
+          ensure_success_or_raise(response)
+          return {} if response.body.to_s.strip.empty?
+
+          parse_json_response(response)
+        rescue Faraday::Error => e
+          raise map_faraday_error(e)
+        end
+
         def delete_json(path)
           response = @conn.delete(path)
           ensure_success_or_raise(response)

data/lib/tango/api/resources/webhooks.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Tango
+  module Api
+    module Resources
+      # Webhook subscriptions: create, manage, renew, and read or redeliver past events.
+      class Webhooks < Base
+        # POST /webhooks
+        # Body keys: url (required), eventTypes and/or categories, headers ([{ name:, value: }]),
+        # payloadVerificationMethod ("HMAC", "X509" or "NONE"), hmacSharedSecretKey (base64),
+        # signingCertificate (base64).
+        # Returns { "webhookId" => ..., "expiresAt" => ... }.
+        def create(body)
+          post_json("webhooks", body)
+        end
+
+        # GET /webhooks
+        # Params may include: prevCursor, nextCursor, maxResults (default 10, max 200), url,
+        # headerName, headerValue, categories, eventTypes, expiresAtFrom/To, createdAtFrom/To.
+        def list(params = {})
+          get_json("webhooks", params)
+        end
+
+        # GET /webhooks/{webhookId}
+        def get(webhook_id)
+          get_json("webhooks/#{webhook_id}")
+        end
+
+        # PATCH /webhooks/{webhookId}
+        # Body keys as for #create; all optional.
+        def update(webhook_id, body)
+          patch_json("webhooks/#{webhook_id}", body)
+        end
+
+        # DELETE /webhooks/{webhookId}
+        def delete(webhook_id)
+          delete_json("webhooks/#{webhook_id}")
+        end
+
+        # POST /webhooks/{webhookId}/renew
+        # Returns { "webhookId" => ..., "expiresAt" => ... }.
+        def renew(webhook_id)
+          post_without_body("webhooks/#{webhook_id}/renew")
+        end
+
+        # GET /webhooks/{webhookId}/events
+        # Params may include: fromRevision, toRevision, prevCursor, nextCursor, maxResults.
+        # Returns a page: { "items" => [...], "nextCursor", "nextPageAvailable", ... }.
+        def events(webhook_id, params = {})
+          get_json("webhooks/#{webhook_id}/events", params)
+        end
+
+        # POST /webhooks/{webhookId}/replay?fromRevision=&toRevision=
+        # Redelivers past events (up to three months old). Omitting to_revision replays
+        # through the latest event.
+        def replay(webhook_id, from_revision:, to_revision: nil)
+          params = { fromRevision: from_revision }
+          params[:toRevision] = to_revision unless to_revision.nil?
+          post_without_body("webhooks/#{webhook_id}/replay", params)
+        end
+
+        # POST /webhooks/{webhookId}/tests/{testName}
+        # testName: ConnectivityTest (any environment) or, in the sandbox only, an event type
+        # such as ItemAvailability.
+        def test(webhook_id, test_name)
+          post_without_body("webhooks/#{webhook_id}/tests/#{test_name}")
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tango-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Puneeth Kumar DN
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -96,6 +95,7 @@ files:
 - lib/tango/api/resources/funds.rb
 - lib/tango/api/resources/orders.rb
 - lib/tango/api/resources/status.rb
+- lib/tango/api/resources/webhooks.rb
 - sig/tango/api/client.rbs
 homepage: https://github.com/Engagedly-Inc/tango-api-client
 licenses:
@@ -105,7 +105,6 @@ metadata:
   source_code_uri: https://github.com/Engagedly-Inc/tango-api-client
   changelog_uri: https://github.com/Engagedly-Inc/tango-api-client/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for Tango (BHN) API with dual auth and robust errors.
 test_files: []