vonage 7.29.1 → 8.0.0.beta

data/lib/vonage/verify2/start_verification_options.rb

@@ -1,63 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2::StartVerificationOptions
-    VALID_OPTS = [:locale, :channel_timeout, :client_ref, :code_length, :code, :fraud_check].freeze
-
-    MIN_CHANNEL_TIMEOUT, MAX_CHANNEL_TIMEOUT = [15, 900]
-
-    MIN_CODE_LENGTH, MAX_CODE_LENGTH = [4, 10]
-
-    attr_reader(*VALID_OPTS)
-
-    def initialize(**opts)
-      VALID_OPTS.each do |opt|
-        send("#{opt}=", opts[opt]) unless opts[opt].nil?
-      end
-    end
-
-    def locale=(locale)
-      @locale = locale
-    end
-
-    def channel_timeout=(channel_timeout)
-      raise ArgumentError, "Invalid 'channel_timeout' #{channel_timeout}. Must be an integer" unless channel_timeout.is_a?(Integer)
-      unless channel_timeout.between?(MIN_CHANNEL_TIMEOUT, MAX_CHANNEL_TIMEOUT)
-        raise ArgumentError, "Invalid 'channel_timeout' #{channel_timeout}. Must be between #{MIN_CHANNEL_TIMEOUT} and #{MAX_CHANNEL_TIMEOUT} (inclusive)"
-      end
-
-      @channel_timeout = channel_timeout
-    end
-
-    def client_ref=(client_ref)
-      @client_ref = client_ref
-    end
-
-    def code_length=(code_length)
-      unless code_length.between?(MIN_CODE_LENGTH, MAX_CODE_LENGTH)
-        raise ArgumentError, "Invalid 'code_length' #{code_length}. Must be between #{MIN_CODE_LENGTH} and #{MAX_CODE_LENGTH} (inclusive)"
-      end
-
-      @code_length = code_length
-    end
-
-    def code=(code)
-      @code = code
-    end
-
-    def fraud_check=(fraud_check)
-      raise ArgumentError, "Invalid 'fraud_check' #{fraud_check}. Must be `false`" unless fraud_check == false
-
-      @fraud_check = fraud_check
-    end
-
-    def to_h
-      hash = Hash.new
-      self.instance_variables.each do |ivar|
-        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
-      end
-      hash
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# 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

@@ -1,125 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

@@ -1,86 +0,0 @@
-# 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/workflow.rb

@@ -1,39 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2::Workflow
-    CHANNELS = {
-      sms: Verify2::Channels::SMS,
-      whatsapp: Verify2::Channels::WhatsApp,
-      whatsapp_interactive: Verify2::Channels::WhatsAppInteractive,
-      voice: Verify2::Channels::Voice,
-      email: Verify2::Channels::Email,
-      silent_auth: Verify2::Channels::SilentAuth
-    }
-
-    CHANNELS.keys.each do |method|
-      define_method method do |attributes|
-        CHANNELS[method].new(**attributes)
-      end
-    end
-
-    def self.method_missing(method)
-      raise ClientError.new("Workflow channel must be one of the valid options. Please refer to https://developer.vonage.com/en/api/verify.v2#newRequest for a complete list.")
-    end
-
-    attr_reader :list
-
-    def initialize
-      @list = []
-    end
-
-    def <<(workflow)
-      list << workflow
-    end
-
-    def hashified_list
-      list.map(&:to_h)
-    end
-  end
-end

data/lib/vonage/verify2/workflow_builder.rb

@@ -1,25 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2::WorkflowBuilder
-
-    def self.build
-      builder = self.new
-      yield builder if block_given?
-      builder.workflow
-    end
-
-    attr_reader :workflow
-
-    def initialize
-      @workflow = Vonage::Verify2::Workflow.new
-    end
-
-    Vonage::Verify2::Workflow::CHANNELS.keys.each do |channel|
-      define_method "add_#{channel.to_s}" do |args|
-        workflow << workflow.send(channel, **args)
-      end
-    end
-  end
-end

data/lib/vonage/verify2.rb

@@ -1,112 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2 < Namespace
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    # Request a verification be sent to a user.
-    #
-    # @example
-    #   verification_request = client.verify2.start_verification(
-    #     brand: 'Acme',
-    #     workflow: [{channel: 'sms', to: '447000000000'}],
-    #     code_length: 6
-    #   )
-    #
-    # @param [required, String] :brand The brand that is sending the verification request
-    #   - Must be between 1 and 16 characters in length
-    #
-    # @param [required, Array<Hash>] :workflow An array of hashes for channels in the workflow
-    #
-    # @param [optional, Hash] opts the options for the verification request.
-    #   @option opts [Integer] :code_length The length of the one-time code provided to the end-user
-    #   @option opts [String] :code An optional alphanumeric custom code to use instead of an auto-generated code
-    #   @option opts [String] :locale The language to use for the verification message (where applicable)
-    #   @option opts [Integer] :channel_timeout Wait time in seconds before trying the next channel in the workflow
-    #   @option opts [String] :client_ref Reference to be included in callbacks
-    #   @option opts [Boolean] If used, must be set to `false`. Will bypass a network block for a single Verify V2 request
-    #
-    # @return Vonage::Response
-    # @see https://developer.vonage.com/en/api/verify.v2#newRequest
-    #
-    def start_verification(brand:, workflow:, **opts)
-      raise ArgumentError, ':brand must be a String' unless brand.is_a?(String)
-      raise ArgumentError, "Invalid 'brand' value #{brand}. Length must be between 1 and 16 characters." unless brand.length.between?(1, 16)
-      raise ArgumentError, ':workflow must be an Array' unless workflow.is_a?(Array)
-      raise ArgumentError, ':workflow must not be empty' if workflow.empty?
-
-      request('/v2/verify/', params: opts.merge(brand: brand, workflow: workflow), type: Post)
-    end
-
-    # Check a supplied code against a request to see if it is valid.
-    #
-    # @example
-    #   code_check = client.verify2.check_code(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2', code: '1234')
-    #
-    # @param [required, String] :request_id The request_id of the verification request being checked
-    #
-    # @param [required, String] :code The code supplied to the end-user by the verification request
-    #
-    # @see https://developer.vonage.com/en/api/verify.v2#checkCode
-    #
-    def check_code(request_id:, code:)
-      request('/v2/verify/' + request_id, params: {code: code}, type: Post)
-    end
-
-    # Cancel a verifiction. If a verification request is still active, calling this method aborts the workflow.
-    #
-    # @example
-    #   client.verify2.cancel_verification_request(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2')
-    #
-    # @param [required, String] :request_id The request_id of the verification request to be cancelled
-    #
-    # @see https://developer.vonage.com/en/api/verify.v2#cancelRequest
-    #
-    def cancel_verification_request(request_id:)
-      request('/v2/verify/' + request_id, type: Delete)
-    end
-
-    def next_workflow(request_id:)
-      request('/v2/verify/' + request_id + '/next-workflow', type: Post)
-    end
-
-    # Instantiate a new Vonage::Verify2::StartVerificationOptions object
-    #
-    # @param [optional, Hash] opts the options for the verification request.
-    #   @option opts [Integer] :code_length The length of the one-time code provided to the end-user
-    #   @option opts [String] :code An optional alphanumeric custom code to use instead of an auto-generated code
-    #   @option opts [String] :locale The language to use for the verification message (where applicable)
-    #   @option opts [Integer] :channel_timeout Wait time in seconds before trying the next channel in the workflow
-    #   @option opts [String] :client_ref Reference to be included in callbacks
-    #   @option opts [Boolean] If used, must be set to `false`. Will bypass a network block for a single Verify V2 request
-    #
-    def start_verification_options(**opts)
-      StartVerificationOptions.new(**opts)
-    end
-
-    # Instantiate a new Vonage::Verify2::Workflow object
-    def workflow
-      Workflow.new
-    end
-
-    # Return the Vonage::Verify2::WorkflowBuilder class
-    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/video/archives/list_response.rb

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

data/lib/vonage/video/broadcasts/list_response.rb

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

data/lib/vonage/video/broadcasts.rb

@@ -1,75 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Video::Broadcasts < Namespace
-    include Keys
-
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    self.host = :video_host
-
-    # Get a list of live streaming broadcasts for a specified Vonage application.
-    #
-    def list(**params)
-      path = '/v2/project/' + @config.application_id + '/broadcast'
-      path += "?#{Params.encode(camelcase(params))}" unless params.empty?
-
-      request(path, response_class: ListResponse)
-    end
-
-    # Return information for specified broadcast.
-    #
-    def info(broadcast_id:)
-      request('/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id)
-    end
-
-    # Start a new live streaming broadcast.
-    #
-    def start(session_id:, **params)
-      request(
-        '/v2/project/' + @config.application_id + '/broadcast',
-        params: camelcase(params.merge(session_id: session_id)),
-        type: Post
-      )
-    end
-
-    # Stop a specified broadcast.
-    #
-    def stop(broadcast_id:)
-      request('/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/stop', type: Post)
-    end
-
-    # Add a stream to a live streaming broadcast.
-    #
-
-    def add_stream(broadcast_id:, stream_id:, **params)
-      request(
-        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/streams',
-        params: camelcase(params.merge(addStream: stream_id)),
-        type: Patch
-      )
-    end
-
-    # Remove a stream from a live streaming broadcast.
-    #
-    def remove_stream(broadcast_id:, stream_id:)
-      request(
-        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/streams',
-        params: {removeStream: stream_id},
-        type: Patch
-      )
-    end
-
-    # Dynamically change layout of a broadcast.
-    #
-    def change_layout(broadcast_id:, **params)
-      request(
-        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/layout',
-        params: camelcase(params),
-        type: Put)
-    end
-  end
-end

data/lib/vonage/video/captions.rb

@@ -1,67 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Video::Captions < Namespace
-    include Keys
-
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    self.host = :video_host
-
-    # Start Live Captions for a Vonage Video stream
-    #
-    # @example
-    #   response = client.video.captions.start(
-    #     session_id: "12312312-3811-4726-b508-e41a0f96c68f",
-    #     token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJp...",
-    #     language_code: 'en-US',
-    #     max_duration: 300,
-    #     partial_captions: false,
-    #     status_callback_url: 'https://example.com/captions/status'
-    #   )
-    #
-    # @params [required, String] :session_id The id of the session to start captions for
-    #
-    # @param [required, String] :token A valid Vonage Video token with role set to 'moderator'
-    #
-    # @params [optional, String] :language_code The BCP-47 code for a spoken language used on this call. The default value is "en-US"
-    #   - Must be one of: 'en-US', 'en-AU', 'en-GB', 'zh-CN', 'fr-FR', 'fr-CA', 'de-DE', 'hi-IN', 'it-IT', 'ja-JP', 'ko-KR', 'pt-BR', 'th-TH'
-    #
-    # @param [optional, Integer] :max_duration The maximum duration for the audio captioning, in seconds.
-    #   - The default value is 14,400 seconds (4 hours), the maximum duration allowed.
-    #   - The minimum value for maxDuration is 300 (300 seconds, or 5 minutes).
-    #
-    # @param [optional, Boolean] :partial_captions Whether to enable this to faster captioning (true, the default) at the cost of some degree of inaccuracies.
-    #
-    # @param [optional, String] :status_callback_url The URL to send the status of the captions to.
-    #
-    # @return [Response]
-    #
-    # @see TODO: Add document link here
-    #
-    def start(session_id:, token:, **params)
-      request(
-        '/v2/project/' + @config.application_id + '/captions',
-        params: camelcase(params.merge({sessionId: session_id, token: token})),
-        type: Post)
-    end
-
-    # Stop live captions for a session
-    #
-    # @example
-    #   response = client.video.captions.stop(captions_id: "7c0580fc-6274-4de5-a66f-d0648e8d3ac3")
-    #
-    # @params [required, String] :captions_id ID of the connection used for captions
-    #
-    # @return [Response]
-    #
-    # @see TODO: Add document link here
-    #
-    def stop(captions_id:)
-      request('/v2/project/' + @config.application_id + '/captions/' + captions_id + '/stop', type: Post)
-    end
-  end
-end

data/lib/vonage/video/renders/list_response.rb

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