vonage 7.12.0 → 7.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d5bfc879e0b399da415f92a0f65313c3aa3f22760945c7832996290e7cbebb
-  data.tar.gz: be7e53025cad9a1fa877d9749e82ff22fa4c6ec4cb2da63ecefef136269fc810
+  metadata.gz: c6681bf0608f283c8404c19838cae08679bed799b0d793622ba6863fbafddb2e
+  data.tar.gz: 7c60d5f1ae1207a1404f705ce20b38cfe3ccbc5f549151f8367f346bb823b9e8
 SHA512:
-  metadata.gz: 29f033e6795e3d52bdef207656a7230925037b04dbdbd57bbdbce4cf74b91842cb9cfcd7e04b9061a5267210905d14b68961dc4daab26bf349dff0ece9a6e659
-  data.tar.gz: 43c52d578923fd7a5a7b04b243b040df2ba1cef5dd0c38c37007820207a5ab411a9976a0b42a2dff653b19d6e856ade248163a8856ac93c88dd49209d4cd6b4f
+  metadata.gz: 5c6ac59f07a9a94979ceca1e170bec5e67a0706b66d6b45cffe027505bf0280f3bad83041e6b09e1fec70afafb3edc47ea4f40a01894d9927ee7c19cae023247
+  data.tar.gz: fbe93fa8fe2dd36b3ea498a5b48ad61ff9cfd6494435b1c3120cd47e3a0d9b1c3feffe2c847e619c716cbcb37688073bf5834cde1caf13b79c530d72661addf7

data/lib/vonage/client.rb

@@ -61,6 +61,13 @@ module Vonage
       @files ||= T.let(Files.new(config), T.nilable(Vonage::Files))
     end
 
+    # @return [Meetings]
+    #
+    sig { returns(T.nilable(Vonage::Meetings)) }
+    def meetings
+      @meetings ||= T.let(Meetings.new(config), T.nilable(Vonage::Meetings))
+    end
+
     # @return [Messages]
     #
     sig { returns(T.nilable(Vonage::Messages)) }
@@ -96,6 +103,13 @@ module Vonage
       @pricing ||= T.let(PricingTypes.new(config), T.nilable(Vonage::PricingTypes))
     end
 
+    # @return [ProactiveConnect]
+    #
+    sig { returns(T.nilable(Vonage::ProactiveConnect)) }
+    def proactive_connect
+      @proactive_connect ||= T.let(ProactiveConnect.new(config), T.nilable(Vonage::ProactiveConnect))
+    end
+
     # @return [Redact]
     #
     sig { returns(T.nilable(Vonage::Redact)) }

data/lib/vonage/config.rb

@@ -18,6 +18,7 @@ module Vonage
       self.signature_secret = ENV['VONAGE_SIGNATURE_SECRET']
       self.signature_method = ENV['VONAGE_SIGNATURE_METHOD'] || 'md5hash'
       self.token = T.let(nil, T.nilable(String))
+      self.vonage_host = 'api-eu.vonage.com'
     end
 
     # Merges the config with the given options hash.
@@ -198,6 +199,9 @@ module Vonage
     sig { params(token: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :token
 
+    sig { returns(String) }
+    attr_accessor :vonage_host
+
     protected
 
     sig { params(name: Symbol, value: T.untyped).void }

data/lib/vonage/errors.rb

@@ -1,14 +1,25 @@
 # typed: strict
 # frozen_string_literal: true
-require 'json'
+require "json"
 
 module Vonage
   module Errors
     extend T::Sig
 
-    sig {params(response: T.any(Net::HTTPUnauthorized, Net::HTTPClientError, Net::HTTPServerError, T.untyped)).returns(Vonage::Error)}
+    sig do
+      params(
+        response:
+          T.any(
+            Net::HTTPUnauthorized,
+            Net::HTTPClientError,
+            Net::HTTPServerError,
+            T.untyped
+          )
+      ).returns(Vonage::Error)
+    end
     def self.parse(response)
-      exception_class = case response
+      exception_class =
+        case response
         when Net::HTTPUnauthorized
           AuthenticationError
         when Net::HTTPClientError
@@ -19,31 +30,34 @@ module Vonage
           Error
         end
 
-      message = if response.content_type == 'application/json'
-        hash = ::JSON.parse(response.body)
-
-        if hash.key?('error_title')
-          hash['error_title']
-        elsif hash.key?('error-code-label')
-          hash['error-code-label']
-        elsif hash.key?('description')
-          hash['description']
-        elsif problem_details?(hash)
-          problem_details_message(hash)
+      message =
+        if response.content_type == "application/json"
+          hash = ::JSON.parse(response.body)
+
+          if hash.key?("error_title")
+            hash["error_title"]
+          elsif hash.key?("error-code-label")
+            hash["error-code-label"]
+          elsif hash.key?("description")
+            hash["description"]
+          elsif hash.key?("message")
+            hash["message"]
+          elsif problem_details?(hash)
+            problem_details_message(hash)
+          end
         end
-      end
 
       exception_class.new(message)
     end
 
     sig { params(hash: T::Hash[String, T.untyped]).returns(T::Boolean) }
     def self.problem_details?(hash)
-      hash.key?('title') && hash.key?('detail') && hash.key?('type')
+      hash.key?("title") && hash.key?("detail") && hash.key?("type")
     end
 
     sig { params(hash: T::Hash[String, T.untyped]).returns(String) }
     def self.problem_details_message(hash)
-      "#{hash['title']}. #{hash['detail']} See #{hash['type']} for more info, or email support@nexmo.com if you have any questions."
+      "#{hash["title"]}. #{hash["detail"]} See #{hash["type"]} for more info, or email support@nexmo.com if you have any questions."
     end
   end
 

data/lib/vonage/meetings/applications.rb

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Applications < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # Update an existing application.
+    #
+    # @param [required, String] :default_theme_id The id of the theme to set as application default theme
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#updateApplication
+    def update(default_theme_id:)
+      request("/meetings/applications", params: {update_details: {default_theme_id: default_theme_id}}, type: Patch)
+    end
+  end
+end

data/lib/vonage/meetings/dial_in_numbers/list_response.rb

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

data/lib/vonage/meetings/dial_in_numbers.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::DialInNumbers < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # Get numbers that can be used to dial into a meeting.
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getDialInNumbers
+    def list
+      request("/meetings/dial-in-numbers", response_class: ListResponse)
+    end
+  end
+end

data/lib/vonage/meetings/recordings.rb

@@ -0,0 +1,36 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Recordings < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # Return information for specified recording.
+    #
+    # @param [required, String] recording_id The id of the recoring for which the info should be returned
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getRecording
+    def info(recording_id:)
+      request("/meetings/recordings/" + recording_id)
+    end
+
+    # Delete a specified recording.
+    #
+    # @param [required, String] recording_id The id of the recoring to be deleted
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#deleteRecording
+    def delete(recording_id:)
+      request("/meetings/recordings/" + recording_id, type: Delete)
+    end
+  end
+end

data/lib/vonage/meetings/rooms/list_response.rb

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

data/lib/vonage/meetings/rooms.rb

@@ -0,0 +1,155 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Rooms < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # Get a list of rooms associated with the Vonage application.
+    #
+    # @param [optional, Integer] :start_id
+    #
+    # @param [optional, Integer] :end_id
+    #
+    # @param [optional, Integer] :page_size
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getRooms
+    def list(**params)
+      path = "/meetings/rooms"
+      path += "?#{Params.encode(params)}" unless params.empty?
+
+      request(path, response_class: ListResponse)
+    end
+
+    # Return information for specified room.
+    #
+    # @param [required, String] room_id
+    #   The id of the room for which the info should be returned
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getRoom
+    def info(room_id:)
+      request("/meetings/rooms/" + room_id)
+    end
+
+    # Create a new room.
+    #
+    # @param [required, String] :display_name
+    #
+    # @param [optional, String] :metadata
+    #   Free text that can be attached to a room. This will be passed in the form of a header in events related to this room.
+    #
+    # @param [optional, String] :type
+    #   The type of room. Must be one of `instant` (the default) or `long_term`.
+    #
+    # @param [String(date)] :expires_at
+    #   The time for when the room will be expired, expressed in ISO 8601 format.
+    #   The value must be greater than 10 minutes from now.
+    #   Must be set if `type` is `long_term`. Should not be set if `type` is `instant`
+    #
+    # @param [optional, Boolean] :expire_after_use
+    #   Close the room after a session ends. Only relevant for rooms where the `type` is `long_term`
+    #
+    # @param [optional, string(uuid)] :theme_id
+    #   When specified, the meeting room will use the theme indicated by the ID.
+    #
+    # @param [optional, String] :join_approval_level
+    #   The level of approval needed to join the meeting in the room. Must be one of: `none`, `after_owner_only`, `explicit_approval`
+    #
+    # @param [optional, Hash] :recording_options
+    #   @option :recording_options [Boolean] :auto_record Automatically record all sessions in this room. Recording cannot be stopped when this is set to `true`.
+    #   @option :recording_options [Boolean] :record_only_owner Record only the owner screen or any share screen of the video.
+    #
+    # @param [optional, Hash] :initial_join_options
+    #   @option :initial_join_options [String] :microphone_state
+    #     Set the default microphone option for users in the pre-join screen of this room.
+    #     Must be one of: `on`, `off`, `default`
+    #
+    # @param [optional, Hash] :callback_urls Provides callback URLs to listen to events. If specified, over-rides the callback URLs specified at Application-level
+    #   @option :callback_urls [String] :rooms_callback_url Callback url for rooms events
+    #   @option :callback_urls [String] :sessions_callback_url Callback url for sessions events
+    #   @option :callback_urls [String] :recordings_callback_url Callback url for recordings events
+    #
+    # @param [optional, Hash] :available_features
+    #   @option :available_features [Boolean] :is_recording_available Determine if recording feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_chat_available Determine if chat feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_whiteboard_available Determine if whiteboard feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_locale_switcher_available Determine if locale switche feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_captions_available Determine if captions feature is available in the UI
+    #
+    # @param [optional, Hash] :ui_settings Provides options to customize the user interface
+    #   @option :ui_settings [String] :language
+    #     The desired language of the UI. The default is `en` (English).
+    #     Must be one of: `en`, `fr`, `de`, `es`, `pt`, `ca`, `he`
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#createRoom
+    def create(display_name:, **params)
+      request(
+        "/meetings/rooms",
+        params: params.merge({ display_name: display_name }),
+        type: Post
+      )
+    end
+
+    # Update an existing room.
+    # Although paramaters (other than `room_id`) are optional, at least one other parameter must be provided or an error
+    #   response will be received.
+    #
+    # @param [required, String] room_id The ID of the Room to be updated
+    #
+    # @param [optional, String(date)] :expires_at
+    #   The time for when the room will be expired, expressed in ISO 8601 format.
+    #   Only relevant for rooms where the `type` is `long_term``
+    #
+    # @param [optional, Boolean] :expire_after_use
+    #   Close the room after a session ends. Only relevant for rooms where the `type` is `long_term`
+    #
+    # @param [optional, string(uuid)] :theme_id
+    #   When specified, the meeting room will use the theme indicated by the ID.
+    #
+    # @param [optional, String] :join_approval_level
+    #   The level of approval needed to join the meeting in the room. Must be one of: `none`, `after_owner_only`, `explicit_approval`
+    #
+    # @param [optional, Hash] :initial_join_options
+    #   @option :initial_join_options [String] :microphone_state
+    #     Set the default microphone option for users in the pre-join screen of this room.
+    #     Must be one of: `on`, `off`, `default`
+    #
+    # @param [optional, Hash] :callback_urls Provides callback URLs to listen to events. If specified, over-rides the callback URLs specified at Application-level
+    #   @option :callback_urls [String] :rooms_callback_url Callback url for rooms events
+    #   @option :callback_urls [String] :sessions_callback_url Callback url for sessions events
+    #   @option :callback_urls [String] :recordings_callback_url Callback url for recordings events
+    #
+    # @param [optional, Hash] :available_features
+    #   @option :available_features [Boolean] :is_recording_available Determine if recording feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_chat_available Determine if chat feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_whiteboard_available Determine if whiteboard feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_locale_switcher_available Determine if locale switche feature is available in the UI (default `true`)
+    #   @option :available_features [Boolean] :is_captions_available Determine if captions feature is available in the UI
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#updateRoom
+    def update(room_id:, **params)
+      raise ArgumentError, 'must provide at least one other param in addition to :room_id' if params.empty?
+      request(
+        "/meetings/rooms/" + room_id,
+        params: {
+          update_details: params
+        },
+        type: Patch
+      )
+    end
+  end
+end

data/lib/vonage/meetings/sessions/list_response.rb

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

data/lib/vonage/meetings/sessions.rb

@@ -0,0 +1,28 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Sessions < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # Return a list of recordings for a specified session.
+    #
+    # @param [required, String] session_id The id of the session for which the recordings list should be returned
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getSessionRecordings
+    def list_recordings(session_id:)
+      request(
+        "/meetings/sessions/" + session_id + "/recordings",
+        response_class: ListResponse
+      )
+    end
+  end
+end

data/lib/vonage/meetings/themes/list_response.rb

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

data/lib/vonage/meetings/themes.rb

@@ -0,0 +1,218 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Themes < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # Get a list of themes associated with the Vonage application.
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getThemes
+    def list
+      request("/meetings/themes", response_class: ListResponse)
+    end
+
+    # Return information for specified theme.
+    #
+    # @param [required, String] theme_id The id of the theme for which the info should be returned
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getThemeById
+    def info(theme_id:)
+      request("/meetings/themes/" + theme_id)
+    end
+
+    # Create a new theme.
+    #
+    # @param [required, String] :main_color
+    #   The main color that will be used for the meeting room.
+    #
+    # @param [required, String] :brand_text
+    #   The text that will appear on the meeting homepage, in the case that there is no brand image
+    #
+    # @param [optional, String] :theme_name
+    #   The name of the theme (must be unique). If null, a UUID will automatically be generated
+    #
+    # @param [optional, String] :short_company_url
+    #   The URL that will represent every meeting room with this theme. The value must be unique across Vonage
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#createTheme
+    def create(main_color:, brand_text:, **params)
+      request(
+        "/meetings/themes",
+        params: params.merge(main_color: main_color, brand_text: brand_text),
+        type: Post
+      )
+    end
+
+    # Update an existing theme.
+    #
+    # @param [required, String] theme_id The id of the theme to be updated
+    #
+    # @param [required, String] :main_color
+    #   The main color that will be used for the meeting room.
+    #
+    # @param [required, String] :brand_text
+    #   The text that will appear on the meeting homepage, in the case that there is no brand image
+    #
+    # @param [optional, String] :theme_name
+    #   The name of the theme (must be unique). If null, a UUID will automatically be generated
+    #
+    # @param [optional, String] :short_company_url
+    #   The URL that will represent every meeting room with this theme. The value must be unique across Vonage
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#updateTheme
+    def update(theme_id:, **params)
+      request(
+        "/meetings/themes/" + theme_id,
+        params: {
+          update_details: params
+        },
+        type: Patch
+      )
+    end
+
+    # Delete an existing theme.
+    #
+    # @param [required, String] :theme_id The id of the theme to be deleted
+    #
+    # @param [optional, Boolean] :force. Set to `true` to force delete a theme currently being used for a room, or as
+    # a default theme. (Defaults to `false`)
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#deleteTheme
+    def delete(theme_id:, force: false)
+      request(
+        "/meetings/themes/" + theme_id + "?force=#{force}",
+        type: Delete
+      )
+    end
+
+    # Get a list of rooms that are associated with a theme id.
+    #
+    # @param [required, String] theme_id THe ID of the theme to search for rooms associated with.
+    #
+    # @param [optional, Integer] :start_id
+    #
+    # @param [optional, Integer] :end_id
+    #
+    # @param [optional, Integer] :page_size
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/meetings#getRoomsByThemeId
+    def list_rooms(theme_id:, **params)
+      path = "/meetings/themes/" + theme_id + "/rooms"
+      path += "?#{Params.encode(params)}" unless params.empty?
+
+      request(path, response_class: Meetings::Rooms::ListResponse)
+    end
+
+    # Set a logo for a theme.
+    #
+    # @param [required, String] :theme_id The ID of the theme for which the logo should be set
+    #
+    # @param [required, String] :filepath
+    #   The filepath of the logo file. Logo files must conform to the following requirements:
+    #     - Format: PNG
+    #     - Maximum size: 1MB
+    #     - Background must be transparent
+    #     - Dimensions:
+    #       - 1 px - 300 px (`white` and `colored` logos)
+    #       - 16 x 16 - 32 x 32 and must be square (favicon)
+    #
+    # @param [required, String] :logo_type
+    #   The type of logo to be set. Must be one of `white`, `colored`, `favicon`
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/meetings/guides/theme-management#uploading-icons-and-logos
+    # @see https://developer.vonage.com/en/api/meetings#getUploadUrlsForTheme
+    # @see https://developer.vonage.com/en/api/meetings#finalizeLogosForTheme
+    #
+    # TODO: add type signature
+    def set_logo(theme_id:, filepath:, logo_type:)
+      pn = Pathname.new(filepath)
+      valid_logo_types = ['white', 'colored', 'favicon']
+      raise ArgumentError, ':filepath not for a file' unless pn.file?
+      raise ArgumentError, 'file at :filepath not readable' unless pn.readable?
+      raise ArgumentError, "logo_type: must be one of #{valid_logo_types}" unless valid_logo_types.include?(logo_type)
+
+      logo_upload_credentials = get_logo_upload_credentials
+
+      filtered_logo_upload_credentials = logo_upload_credentials.select {|cred| cred.fields.logo_type == logo_type }.first
+
+      upload_logo_file(filepath: filepath, credentials: filtered_logo_upload_credentials)
+
+      finalize_logos(theme_id: theme_id, keys: [filtered_logo_upload_credentials.fields.key])
+    end
+
+    private
+
+    def get_logo_upload_credentials
+      request("/meetings/themes/logos-upload-urls", response_class: ListResponse)
+    end
+
+    def upload_logo_file(filepath:, credentials:)
+      pn = Pathname.new(filepath)
+
+      params = format_s3_upload_credentials(credentials)
+
+      multipart_post_request(
+        nil,
+        filepath: filepath,
+        file_name: pn.basename,
+        mime_type: credentials.fields.content_type,
+        params: params,
+        override_uri: credentials.url,
+        no_auth: true
+      )
+    end
+
+    def finalize_logos(theme_id:, keys: [])
+      request(
+        "/meetings/themes/" + theme_id + "/finalizeLogos",
+        params: {
+          keys: keys
+        },
+        type: Put
+      )
+    end
+
+    def format_s3_upload_credentials(credentials)
+      credentials_key_map = {
+        content_type: "Content-Type",
+        logo_type: "logoType",
+        x_amz_algorithm: "X-Amz-Algorithm",
+        x_amz_credential: "X-Amz-Credential",
+        x_amz_date: "X-Amz-Date",
+        x_amz_security_token: "X-Amz-Security-Token",
+        policy: "Policy",
+        x_amz_signature: "X-Amz-Signature"
+      }
+
+      params = credentials.fields.attributes
+      params.transform_keys do |k|
+        if credentials_key_map.keys.include?(k)
+          credentials_key_map[k]
+        else
+          k.to_s
+        end
+      end
+    end
+  end
+end