vonage 7.27.0 → 7.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ef29adae44fffb9754118333b6a82cac7172cb536eb2b4ec31644694c6388ef
-  data.tar.gz: 43496b6bcf0db687cdef8bdd4506db140fea685f48a306abc1aac4325f8300f5
+  metadata.gz: cf9fa1d6af062f6e7d75fb963409c9a0f040baed06cddba83bd6fa6898d81277
+  data.tar.gz: 5962037b1656b38a3805bbea7a7b166e99377408700b93d23a268739f2b67b09
 SHA512:
-  metadata.gz: 055f8c7f7e0bcdc9eb8c59f0110b6bbfb850a1d725468f0e23d1e5bf736b5acdf3a9dfdbf0e17e0f4e5b54fabe6415173c2d8f39106b73ca336389f4f8483baa
-  data.tar.gz: 72ad26a1bf8696cd465ea2f89f7ab190803a29ee13dcb3680238504b9c81c6264dc444e2e12c0e078a19dd2042ea8fe31e8988e32162413325fa7be5a56444d4
+  metadata.gz: ed10b77ccd84032ac6aed5a06b4dc0978e49cfcc966b1e2208ee382bfacbd7ee507319470ac8b3e12758fac8571b1d979a25b4231e6ee11c0d1f6ca928bc917f
+  data.tar.gz: 971e7f19c8e151891001e2101cee4ad756e2109c70df5a2c9bee272470909a7f25cb287a09ac10b138c4fff73f930ddde187612aae42f3103bba1df88506c0c9

data/README.md

@@ -14,6 +14,7 @@ need a Vonage account. Sign up [for free at vonage.com][signup].
     * [Logging](#logging)
     * [Exceptions](#exceptions)
     * [Overriding the default hosts](#overriding-the-default-hosts)
+    * [HTTP Client Configuration](#http-client-configuration)
     * [JWT authentication](#jwt-authentication)
     * [Webhook signatures](#webhook-signatures)
     * [Pagination](#pagination)
@@ -179,6 +180,33 @@ client = Vonage::Client.new(
 
 By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respectively.
 
+### HTTP Client Configuration
+
+It is possible to set configuration options on the HTTP client. This can be don in a couple of ways.
+
+1. Using an `:http` key during `Vonage::Client` instantiation, for example:
+    ```ruby
+    client = Vonage::Client.new(
+      api_key: 'YOUR-API-KEY',
+      api_secret: 'YOUR-API-SECRET',
+      http: {
+        max_retries: 1
+      }
+    )
+    ```
+
+2. By using the `http=` setter on the `Vonage::Config` object, for example:
+    ```ruby
+    client = Vonage::Client.new(
+      api_key: 'YOUR-API-KEY',
+      api_secret: 'YOUR-API-SECRET'
+    )
+
+    client.config.http = { max_retries: 1 }
+    ```
+
+The Vonage Ruby SDK uses the [`Net::HTTP::Persistent` library](https://github.com/drbrain/net-http-persistent) as an HTTP client. For available configuration options see [the documentation for that library](https://www.rubydoc.info/gems/net-http-persistent/3.0.0/Net/HTTP/Persistent).
+
 ### Webhook signatures
 
 Certain Vonage APIs provide signed [webhooks](https://developer.vonage.com/en/getting-started/concepts/webhooks) as a means of verifying the origin of the webhooks. The exact signing mechanism varies depending on the API.
@@ -460,6 +488,66 @@ if code_check.http_response.code == '200'
 end
 ```
 
+### Working with Verify Custom Templates and Template Fragments
+
+Verify custom templates allow you to customize the message sent to deliver an OTP to your users, rather than using the default Vonage templates. See the [Template Management Guide document](https://developer.vonage.com/en/verify/guides/custom-templates) for more information.
+
+#### Templates
+
+```ruby
+# Get a list of all templates
+template_list = verify.templates.list
+
+# Get details of a specific template
+template = verify.templates.info(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+
+# Create a new template
+verify.templates.create(name: 'my-template')
+
+# Update an existing template
+verify.templates.update(
+  template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+  name: 'my-updated-template'
+)
+
+# Delete a template
+verify.templates.delete(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+```
+
+#### Template Fragments
+
+```ruby
+# Get a list of template fragments for a specific template
+template_fragment_list = verify.template_fragments.list(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+
+# Get details of a specific template fragment
+template_fragment = verify.template_fragments.info(
+  template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+  template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19'
+)
+
+# Create a new template fragement
+verify.template_fragments.create(
+  template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+  channel: 'sms',
+  locale: 'en-gb',
+  text: 'Your code is: ${code}'
+)
+
+# Update an existing template fragment
+verify.template_fragments.update(
+  template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+  template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc1',
+  text: 'Your one-time code is: ${code}'
+)
+
+# Delete a template fragment
+verify.template_fragments.delete(
+  template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+  template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19'
+)
+```
+
 ## Voice API
 
 The [Vonage Voice API](The [Vonage Verify API v2](https://developer.vonage.com/en/verify/verify-v2/overview) allows you to automate voice interactions by creating calls, streaming audio, playing text to speech, playing DTMF tones, and other actions. See the Vonage Developer Documentation for a [complete API reference](https://developer.vonage.com/en/api/voice) listing all the Voice API capabilities.

data/lib/vonage/http.rb

@@ -1,6 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
-require 'net/http'
+require 'net/http/persistent'
 
 module Vonage
   module HTTP
@@ -21,7 +21,7 @@ module Vonage
         end
       end
 
-      sig { params(http: Net::HTTP).returns(T::Hash[Symbol, T.untyped]) }
+      sig { params(http: Net::HTTP::Persistent).returns(T::Hash[Symbol, T.untyped]) }
       def set(http)
         @hash.each do |name, value|
           http.public_send(defined_options.fetch(name), value)
@@ -34,7 +34,7 @@ module Vonage
       def defined_options
         @defined_options = T.let(@defined_options, T.nilable(T::Hash[Symbol, T.untyped]))
 
-        @defined_options ||= Net::HTTP.instance_methods.grep(/\w=\z/).each_with_object({}) do |name, hash|
+        @defined_options ||= Net::HTTP::Persistent.instance_methods.grep(/\w=\z/).each_with_object({}) do |name, hash|
           hash[name.to_s.chomp('=').to_sym] = name
         end
       end

data/lib/vonage/verify2/template_fragments/list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Verify2::TemplateFragments::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.template_fragments.each { |item| yield item }
+  end
+end

data/lib/vonage/verify2/template_fragments.rb

@@ -0,0 +1,125 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Verify2::TemplateFragments < Namespace
+    CHANNELS = ['sms', 'voice'].freeze
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # Get a list of of template fragments for a specific template.
+    #
+    # @example
+    #   template_fragment_list = client.verify2.template_fragments.list(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+    #
+    # @param [required, String] :template_id. The ID of the template for which to retreive the fragments
+    #
+    # @param [optional, Integer] :page_size. The amount of template fragments to list per page
+    #
+    # @param [optional, Integer] :page. The page number to retrieve
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#listTemplateFragments
+    def list(template_id:, **params)
+      request("/v2/verify/templates/#{template_id}/template_fragments", params: params, response_class: ListResponse)
+    end
+
+    # Get details of a specific template fragment.
+    #
+    # @example
+    #   template_fragment = client.verify2.template_fragments.info(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template for which to retreive the fragment
+    #
+    # @param [required, String] :template_fragment_id. The ID of the fragment to be retreived
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#getTemplateFragment
+    def info(template_id:, template_fragment_id:)
+      request("/v2/verify/templates/#{template_id}/template_fragments/#{template_fragment_id}")
+    end
+
+    # Create a new template fragment.
+    #
+    # @example
+    #   client.verify2.template_fragments.create(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         channel: 'sms',
+    #                         locale: 'en-gb',
+    #                         text: 'Your code is: ${code}'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template for which to create the fragment
+    #
+    # @param [required, String] :channel. The verification channel for which to create the fragment. Must be one of 'sms' or 'voice'
+    #
+    # @param [required, String] :locale. The locale for which to create the fragment.
+    #
+    # @param [required, String] :text. The text to be used in the template fragment.
+    #   There are 4 reserved variables available to use as part of the text: ${code}, ${brand}, ${time-limit} and ${time-limit-unit}
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#addTemplateFragmentToTemplate
+    def create(template_id:, channel:, locale:, text:)
+      raise ArgumentError, "Invalid 'channel' #{channel}. Must be one of #{CHANNELS.join(', ')}" unless CHANNELS.include?(channel)
+      request(
+        "/v2/verify/templates/#{template_id}/template_fragments",
+        params: {
+          channel: channel,
+          locale: locale,
+          text: text
+        },
+        type: Post)
+    end
+
+    # Update an existing template fragment.
+    #
+    # @example
+    #   client.verify2.template_fragments.update(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19',
+    #                         text: 'Your one-time code is: ${code}'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template with which the fragment to be updated is associated
+    #
+    # @param [required, String] :template_fragment_id. The ID of the fragment to be updated
+    #
+    # @param [required, String] :text. The text to be used in the template fragment.
+    #   There are 4 reserved variables available to use as part of the text: ${code}, ${brand}, ${time-limit} and ${time-limit-unit}
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#updateTemplateFragment
+    def update(template_id:, template_fragment_id:, text:)
+      request("/v2/verify/templates/#{template_id}/template_fragments/#{template_fragment_id}", params: {text: text}, type: Patch)
+    end
+
+    # Delete a template fragment.
+    #
+    # @example
+    #   client.verify2.template_fragments.delete(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template with which the fragment to be deleted is associated
+    #
+    # @param [required, String] :template_fragment_id. The ID of the fragment to be deleted
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#deleteTemplateFragment
+    def delete(template_id:, template_fragment_id:)
+      request("/v2/verify/templates/#{template_id}/template_fragments/#{template_fragment_id}", type: Delete)
+    end
+  end
+end

data/lib/vonage/verify2/templates/list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Verify2::Templates::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.templates.each { |item| yield item }
+  end
+end

data/lib/vonage/verify2/templates.rb

@@ -0,0 +1,86 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Verify2::Templates < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # Get a list of all templates.
+    #
+    # @example
+    #   template_list = client.verify2.templates.list
+    #
+    # @param [optional, Integer] :page_size. The amount of templates to list per page
+    #
+    # @param [optional, Integer] :page. The page number to retrieve
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#listTemplates
+    def list(**params)
+      request('/v2/verify/templates', params: params, response_class: ListResponse)
+    end
+
+    # Get details of a specific template.
+    #
+    # @example
+    #   template = client.verify2.templates.info(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+    #
+    # @param [required, String] :template_id. The ID of the template to be retreived
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#getTemplate
+    def info(template_id:)
+      request('/v2/verify/templates/' + template_id)
+    end
+
+    # Create a new template.
+    #
+    # @example
+    #   client.verify2.templates.create(name: 'my-template')
+    #
+    # @param [required, String] :name. The name of the template. The following characters are permitted: [A-Z a-z 0-9 _ -]
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#createTemplate
+    def create(name:)
+      request('/v2/verify/templates', params: { name: name }, type: Post)
+    end
+
+    # Update an existing template.
+    #
+    # @example
+    #   client.verify2.templates.update(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9', name: 'my-updated-template')
+    #
+    # @param [required, String] :template_id. The ID of the template to be updated
+    #
+    # @param [optional, String] :name. The name of the template. The following characters are permitted: [A-Z a-z 0-9 _ -]
+    #
+    # @param [optional, Boolean] :is_default. Whether the template is the default template for a specific locale/channel combination
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#updateTemplate
+    def update(template_id:, **params)
+      request('/v2/verify/templates/' + template_id, params: params, type: Patch)
+    end
+
+    # Delete a template.
+    #
+    # @example
+    #   client.verify2.templates.delete(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+    #
+    # @param [required, String] :template_id. The ID of the template to be deleted
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#deleteTemplate
+    def delete(template_id:)
+      request('/v2/verify/templates/' + template_id, type: Delete)
+    end
+  end
+end

data/lib/vonage/verify2.rb

@@ -96,5 +96,17 @@ module Vonage
     def workflow_builder
       WorkflowBuilder.itself
     end
+
+    # @return [Templates]
+    # Returns existing or instantiates a new Vonage::Verify2::Templates object
+    def templates
+      @templates ||= Templates.new(@config)
+    end
+
+    # @return [TemplateFragments]
+    # Returns existing or instantiates a new Vonage::Verify2::Templates object
+    def template_fragments
+      @template_fragments ||= TemplateFragments.new(@config)
+    end
   end
 end

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.27.0'
+  VERSION = '7.28.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.27.0
+  version: 7.28.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -238,6 +238,10 @@ files:
 - lib/vonage/verify2/channels/whats_app.rb
 - lib/vonage/verify2/channels/whats_app_interactive.rb
 - lib/vonage/verify2/start_verification_options.rb
+- lib/vonage/verify2/template_fragments.rb
+- lib/vonage/verify2/template_fragments/list_response.rb
+- lib/vonage/verify2/templates.rb
+- lib/vonage/verify2/templates/list_response.rb
 - lib/vonage/verify2/workflow.rb
 - lib/vonage/verify2/workflow_builder.rb
 - lib/vonage/version.rb
@@ -293,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: This is the Ruby Server SDK for Vonage APIs. To use it you'll need a Vonage