whatsapp_sdk 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17de6b59f97c39b0d49c911d4e153d241f60d7f92727a10ec895ff4dc4d9822b
-  data.tar.gz: f2f25357ffa9d35972e157f57abfaa4a3ac2b2a9debb0f86fdb15230581c6ce6
+  metadata.gz: 5a1704465f5fbbe203905c5d63ac14944838fb6617ffb24f7ca6727dba2cdd49
+  data.tar.gz: 2359c3c077eab75ac9281a70134744eaf7703e765a4932ac6fa677287a143669
 SHA512:
-  metadata.gz: 1ef8af8f454441f188633dab7295b20da476d8692af1bf6602032b7504c08d1931bc9fbb9544452f981b3b58111ed0bec034de6138540c3445d6379a50f813ac
-  data.tar.gz: ead1a38b14a8d5d16539e61ba4b65c36c6652525ca10d7aab554dd3b83a8cd1b11fff52dc38e0c121f574db108ce3ea64546bf62a386b46078dfc369dd559710
+  metadata.gz: 067f3899b14284af61f426b1cf7f04d1e5fda2d3abb135a51bdac9fe1060427b270a2c4a2796855ed222c96a8794513377878b7bed56021bed2fe81eafc7c93c
+  data.tar.gz: 1789fd6e89f858e0a60996d462af11fcad70dfd48cf4bf6c76bacf736be725f3cf255b72d6cd731f959bf1715becac6a4fb4668f08c020e0004ae60aefda9db1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+# v 1.1.0
+- Add support for pagination in template_analytics with 'after' cursor @osvaldo-santos [190](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/190) 
+- Add template_analytics feature @osvaldo-santos [189](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/189) 
+- Add Business Account API support @osvaldo-santos [187](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/187) 
+
 # v 1.0.5
 - Added GET template endpoint. @osvaldo-santos [185](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/185)
 - Adding support for named paremeters in Templates API. @osvaldo-santos [184](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/184)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (1.0.5)
+    whatsapp_sdk (1.1.0)
       faraday (~> 2.0, > 2.0.1)
       faraday-multipart (~> 1)
       zeitwerk (~> 2)
@@ -16,7 +16,7 @@ GEM
     coderay (1.1.3)
     crack (0.4.5)
       rexml
-    faraday (2.14.0)
+    faraday (2.14.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -25,7 +25,7 @@ GEM
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
     hashdiff (1.0.1)
-    json (2.18.0)
+    json (2.18.1)
     logger (1.7.0)
     method_source (1.0.0)
     minitest (5.16.1)
@@ -71,7 +71,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.4)
+    zeitwerk (2.7.5)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -17,6 +17,7 @@ Send stickers, messages, audio, videos, locations, react and reply to messages o
 - [APIs](#apis)
   - [Templates](#templates)
   - [Business Profile API](#business-profile-api)
+  - [Business Account API](#business-account-api)
   - [Phone numbers API](#phone-numbers-api)
   - [Media API](#media-api)
   - [Messages API](#messages-api)
@@ -207,6 +208,12 @@ client.templates.create(
 
 # Delete a template
 client.templates.delete(business_id: BUSINESS_ID, name: "my_name") # delete by name
+
+# Get templates analytics
+client.templates.template_analytics(
+  business_id: BUSINESS_ID, start_timestamp: 1767236400,
+  end_timestamp: 1767322799, template_ids: [id]
+)
 ```
 </details>
 
@@ -223,6 +230,22 @@ client.business_profiles.update(phone_number_id: SENDER_ID, params: { about: "A
 ```
 </details>
 
+### Business Account API
+<details>
+
+```ruby
+# Get the details of your business account
+client.business_accounts.get(BUSINESS_ID)
+
+# Get some fields of your business account
+client.business_accounts.get(BUSINESS_ID, fields: ["id", "name"])
+
+# Update your business account
+# Note: You can only update the `name` and `timezone_id` fields of your business account.
+client.business_accounts.update(business_id: BUSINESS_ID, params: { name: "My new business name", timezone_id: "1" })
+```
+</details>
+
 ### Phone numbers API
 
 <details>

data/example.rb

@@ -142,6 +142,12 @@ end
 
 # client.templates.delete(business_id: BUSINESS_ID, name: "name2", hsm_id: "243213188351928") # delete by name and id
 
+## Get template analytics
+analytics = client.templates.template_analytics(
+  business_id: BUSINESS_ID, start_timestamp: 1767236400,
+  end_timestamp: 1767322799, template_ids: [id, new_template.id]
+)
+puts "GET template analytics: #{analytics.records.first}"
 
 
 # ############################## Business API ##############################
@@ -158,6 +164,22 @@ run_and_catch_error("Update business profile") do
   updated_bp = client.business_profiles.update(phone_number_id: SENDER_ID, params: { about: "A cool business" } )
 end
 
+# ############################## Business Account API ##############################
+puts "\n\n\n ------------------ Testing Business Account API -----------------------"
+
+business_account = client.business_accounts.get(BUSINESS_ID)
+puts "GET Business Account by id: #{business_account.name}"
+
+business_account = client.business_accounts.get(BUSINESS_ID, fields: %w[id name account_review_status message_template_namespace] )
+puts "GET Business Account with fields by id: #{business_account.name}, #{business_account.account_review_status}, #{business_account.message_template_namespace}"
+
+updated_ba = client.business_accounts.update(business_id: BUSINESS_ID, params: { name: 'A cool updated business' } )
+puts "UPDATE Business Account by id: #{updated_ba} }"
+
+run_and_catch_error("Update business account") do
+  # message_template_namespace can't be set
+  client.business_accounts.update(business_id: BUSINESS_ID, params: { message_template_namespace: "namespace" } )
+end
 
 
 ############################## Phone Numbers API ##############################

data/lib/whatsapp_sdk/api/business_account.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "request"
+require_relative "../resource/business_account"
+
+module WhatsappSdk
+  module Api
+    class BusinessAccount < Request
+      DEFAULT_FIELDS = %w[id name timezone_id message_template_namespace account_review_status
+                          business_verification_status country ownership_type primary_business_location]
+                       .join(',')
+                       .freeze
+
+      # Get the details of business account.
+      #
+      # @param business_id [Integer] Business Account Id.
+      # @param fields [Array<String>] Optional list of fields to include in the response. Defaults to 'id,name'.
+      # @return [Resource::BusinessAccount] Response object.
+      def get(business_id, fields: nil)
+        fields = if fields
+                   fields.join(',')
+                 else
+                   DEFAULT_FIELDS
+                 end
+
+        response = send_request(
+          http_method: "get",
+          endpoint: "#{business_id}?fields=#{fields}"
+        )
+
+        Resource::BusinessAccount.from_hash(response)
+      end
+
+      # Update the details of business account.
+      #
+      # @param business_id [Integer] Business Account Id.
+      # @param params [Hash] Params to update. The possible attributes to update are: `name`, `timezone_id`.
+      # @return [Boolean] Whether the update was successful.
+      def update(business_id:, params:)
+        raise ArgumentError, "Params must be a hash." unless params.is_a?(Hash)
+
+        # Only name and timezone_id can be updated. If other keys are present, they will be ignored.
+        filtered_params = params.transform_keys(&:to_sym).slice(:name, :timezone_id)
+
+        if filtered_params.empty?
+          raise ArgumentError, "No valid parameters provided. Only 'name' and 'timezone_id' can be updated."
+        end
+
+        response = send_request(
+          http_method: "post",
+          endpoint: business_id.to_s,
+          params: filtered_params
+        )
+
+        Api::Responses::SuccessResponse.success_response?(response: response)
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/client.rb

@@ -43,6 +43,10 @@ module WhatsappSdk
         @business_profiles ||= WhatsappSdk::Api::BusinessProfile.new(self)
       end
 
+      def business_accounts
+        @business_accounts ||= WhatsappSdk::Api::BusinessAccount.new(self)
+      end
+
       def templates
         @templates ||= WhatsappSdk::Api::Templates.new(self)
       end

data/lib/whatsapp_sdk/api/templates.rb

@@ -175,6 +175,50 @@ module WhatsappSdk
         Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
+      # Get Template Analytics
+      #
+      # Get analytics data for message templates over a specified time range.
+      # @param business_id [Integer] The business ID.
+      # @param start_timestamp [Integer] The start of the time range to retrieve analytics data, in Unix timestamp.
+      # @param end_timestamp [Integer] The end of the time range to retrieve analytics data, in Unix timestamp.
+      # @param template_ids [Array<String>] An array of template IDs for which to retrieve analytics data.
+      # @param metric_types [Array<String>] An array of metric types to retrieve.
+      def template_analytics(
+        business_id:, start_timestamp:, end_timestamp:, template_ids:, metric_types: [],
+        granularity: WhatsappSdk::Resource::TemplateAnalytic::Granularity::DAILY,
+        after: nil
+      )
+        if !metric_types.empty? && !valid_metric_types?(metric_types)
+          valid_types = WhatsappSdk::Resource::TemplateAnalytic::MetricType::METRIC_TYPES.join(', ')
+
+          raise ArgumentError, "Invalid metric type. Valid types are: #{valid_types}."
+        end
+
+        if granularity != WhatsappSdk::Resource::TemplateAnalytic::Granularity::DAILY
+          raise ArgumentError, "Invalid granularity. The only supported granularity is DAILY."
+        end
+
+        query_params = {
+          start: start_timestamp,
+          end: end_timestamp,
+          template_ids: template_ids.join(","),
+          metric_types: metric_types.join(","),
+          granularity: granularity
+        }
+        query_params[:after] = after if after
+
+        response = send_request(
+          endpoint: "#{business_id}/template_analytics?#{URI.encode_www_form(query_params)}",
+          http_method: "get"
+        )
+
+        Api::Responses::PaginationRecords.new(
+          records: parse_template_analytics(response['data']),
+          before: response.dig('paging', 'cursors', 'before'),
+          after: response.dig('paging', 'cursors', 'after')
+        )
+      end
+
       private
 
       def parse_templates(templates_data)
@@ -182,6 +226,18 @@ module WhatsappSdk
           Resource::Template.from_hash(template)
         end
       end
+
+      def parse_template_analytics(analytics_data)
+        analytics_data.map do |analytic|
+          Resource::TemplateAnalytic.from_hash(analytic)
+        end
+      end
+
+      def valid_metric_types?(metric_types)
+        metric_types.all? do |type|
+          WhatsappSdk::Resource::TemplateAnalytic::MetricType.valid?(type)
+        end
+      end
     end
   end
 end

data/lib/whatsapp_sdk/resource/business_account.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class BusinessAccount
+      attr_accessor :id, :name, :timezone_id, :message_template_namespace, :account_review_status,
+                    :business_verification_status, :country, :ownership_type, :primary_business_location,
+                    :analytics, :conversation_analytics, :pricing_analytics, :call_analytics
+
+      def self.from_hash(hash)
+        business_account = BusinessAccount.new
+        business_account.id = hash["id"]
+        business_account.name = hash["name"]
+        business_account.timezone_id = hash["timezone_id"]
+        business_account.message_template_namespace = hash["message_template_namespace"]
+        business_account.account_review_status = hash["account_review_status"]
+        business_account.business_verification_status = hash["business_verification_status"]
+        business_account.country = hash["country"]
+        business_account.ownership_type = hash["ownership_type"]
+        business_account.primary_business_location = hash["primary_business_location"]
+        business_account.analytics = hash["analytics"]
+        business_account.conversation_analytics = hash["conversation_analytics"]
+        business_account.pricing_analytics = hash["pricing_analytics"]
+        business_account.call_analytics = hash["call_analytics"]
+
+        business_account
+      end
+
+      def ==(other)
+        return false unless other.is_a?(WhatsappSdk::Resource::BusinessAccount)
+
+        %i[id name timezone_id message_template_namespace account_review_status
+           business_verification_status country ownership_type primary_business_location].all? do |field|
+          send(field) == other.send(field)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/template_analytic.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class TemplateAnalytic
+      module Granularity
+        DAILY = "DAILY"
+      end
+
+      module MetricType
+        COST = "COST"
+        CLICKED = "CLICKED"
+        DELIVERED = "DELIVERED"
+        READ = "READ"
+        SENT = "SENT"
+
+        # (MM API for WhatsApp only)
+        APP_ACTIVATIONS = "APP_ACTIVATIONS"
+        APP_ADD_TO_CART = "APP_ADD_TO_CART"
+        APP_CHECKOUTS_INITIATED = "APP_CHECKOUTS_INITIATED"
+        APP_PURCHASES = "APP_PURCHASES"
+        APP_PURCHASES_CONVERSION_VALUE = "APP_PURCHASES_CONVERSION_VALUE"
+        WEBSITE_ADD_TO_CART = "WEBSITE_ADD_TO_CART"
+        WEBSITE_CHECKOUTS_INITIATED = "WEBSITE_CHECKOUTS_INITIATED"
+        WEBSITE_PURCHASES = "WEBSITE_PURCHASES"
+        WEBSITE_PURCHASES_CONVERSION_VALUE = "WEBSITE_PURCHASES_CONVERSION_VALUE"
+
+        METRIC_TYPES = [COST, CLICKED, DELIVERED, READ, SENT, APP_ACTIVATIONS, APP_ADD_TO_CART, APP_CHECKOUTS_INITIATED,
+                        APP_PURCHASES, APP_PURCHASES_CONVERSION_VALUE, WEBSITE_ADD_TO_CART, WEBSITE_CHECKOUTS_INITIATED,
+                        WEBSITE_PURCHASES, WEBSITE_PURCHASES_CONVERSION_VALUE].freeze
+
+        def self.valid?(metric_type)
+          METRIC_TYPES.include?(metric_type)
+        end
+      end
+
+      attr_accessor :granularity, :product_type, :data_points
+
+      def initialize(granularity:, product_type:, data_points:)
+        @granularity = granularity
+        @product_type = product_type
+        @data_points = data_points
+      end
+
+      def self.from_hash(hash)
+        new(
+          granularity: hash["granularity"],
+          product_type: hash["product_type"],
+          data_points: hash["data_points"]
+        )
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhatsappSdk
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-22 00:00:00.000000000 Z
+date: 2026-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - example.rb
 - lib/whatsapp_sdk.rb
 - lib/whatsapp_sdk/api/api_configuration.rb
+- lib/whatsapp_sdk/api/business_account.rb
 - lib/whatsapp_sdk/api/business_profile.rb
 - lib/whatsapp_sdk/api/client.rb
 - lib/whatsapp_sdk/api/medias.rb
@@ -151,6 +152,7 @@ files:
 - lib/whatsapp_sdk/error.rb
 - lib/whatsapp_sdk/resource/address.rb
 - lib/whatsapp_sdk/resource/address_type.rb
+- lib/whatsapp_sdk/resource/business_account.rb
 - lib/whatsapp_sdk/resource/business_profile.rb
 - lib/whatsapp_sdk/resource/button_parameter.rb
 - lib/whatsapp_sdk/resource/component.rb
@@ -181,6 +183,7 @@ files:
 - lib/whatsapp_sdk/resource/phone_number.rb
 - lib/whatsapp_sdk/resource/phone_number_component.rb
 - lib/whatsapp_sdk/resource/template.rb
+- lib/whatsapp_sdk/resource/template_analytic.rb
 - lib/whatsapp_sdk/resource/url.rb
 - lib/whatsapp_sdk/version.rb
 - tmp/whatsapp.png