vonage 7.13.0 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ab386887cbecc55b2e4c2fe915edb4ec7cac9bfc62d7205d577daf2f451b443
-  data.tar.gz: ba606e264741711abdc23d3109b9a741efd8e6848e0743e48719c7414478d10e
+  metadata.gz: fe42d262916665b0528b89b25fc9094ff4009739cea53ec28a416afe2ec232c8
+  data.tar.gz: d1bb14fcc3e8c862dedd87a32b80034d9914c0cafcc2c53f071b05a9c640a644
 SHA512:
-  metadata.gz: e3d11a57f0782eff2acc885e8edc0243f5acb6f93e27c54dc3ff057a15b3b82c413fb24deda53519e5d3d7b109e22de21244eed798ef8c5cb8abb070117bdac5
-  data.tar.gz: b199fe7cc3e00eb2a7bb13e62f2448c3cda49dfe7c7b476825872074fe71e89d7f930778d75f83f8b1204c6429155bc363e85468a5c71b89849a8037fb37220a
+  metadata.gz: a52f19d149c83ff7cbc2fe73982abaf79901c146fa45d006d19ba9f32b9640bf14065e132362aae591869339109deeafa68e72349a1e6d9f2a6fba173efbf9a6
+  data.tar.gz: 38f8d3a78930e5b13e8ed71e3bce0ee37789a506f053e9f31c543bdac10760f574dc976fca097f64f47419f9d99c4b912ce32484b389243b96c52f5fa6e7ef4c

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)) }
@@ -138,6 +145,13 @@ module Vonage
       @tfa ||= T.let(TFA.new(config), T.nilable(Vonage::TFA))
     end
 
+    # @return [Users]
+    #
+    sig { returns(T.nilable(Vonage::Users)) }
+    def users
+      @users ||= T.let(Users.new(config), T.nilable(Vonage::Users))
+    end
+
     # @return [Verify]
     #
     sig { returns(T.nilable(Vonage::Verify)) }

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

data/lib/vonage/meetings.rb

@@ -0,0 +1,38 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings < Namespace
+    extend T::Sig
+    
+    sig { returns(T.nilable(Vonage::Meetings::Rooms)) }
+    def rooms
+      @rooms ||= Rooms.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Recordings)) }
+    def recordings
+      @recordings ||= Recordings.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Sessions)) }
+    def sessions
+      @sessions ||= Sessions.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Themes)) }
+    def themes
+      @themes ||= Themes.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Applications)) }
+    def applications
+      @applications ||= Applications.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::DialInNumbers)) }
+    def dial_in_numbers
+      @dial_in_numbers ||= DialInNumbers.new(@config)
+    end
+  end
+end

data/lib/vonage/namespace.rb

@@ -1,5 +1,6 @@
 # typed: true
 # frozen_string_literal: true
+
 require 'net/http'
 require 'net/http/post/multipart'
 require 'json'
@@ -9,7 +10,6 @@ module Vonage
     def initialize(config)
       @config = config
 
-      # @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
       @host = set_host
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
@@ -49,6 +49,7 @@ module Vonage
     end
 
     protected
+
     # :nocov:
 
     Get = Net::HTTP::Get
@@ -61,7 +62,7 @@ module Vonage
       authentication = self.class.authentication.new(@config)
       authentication.update(params)
 
-      uri = URI('https://' + @host + path)
+      uri = URI("https://" + @host + path)
       unless type.const_get(:REQUEST_HAS_BODY) || params.empty?
         uri.query = Params.encode(params)
       end
@@ -73,17 +74,20 @@ module Vonage
       request = type.new(uri)
 
       # set headers
-      request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
-      request['Accept'] = 'application/json'
-      self.class.request_headers.each do |key, value|
-        request[key] = value
-      end
+      request["User-Agent"] = UserAgent.string(
+        @config.app_name,
+        @config.app_version
+      )
+      request["Accept"] = "application/json"
+      self.class.request_headers.each { |key, value| request[key] = value }
 
       # Set BearerToken if needed
       authentication.update(request)
 
       # set body
-      self.class.request_body.update(request, params) if type.const_get(:REQUEST_HAS_BODY)
+      if type.const_get(:REQUEST_HAS_BODY)
+        self.class.request_body.update(request, params)
+      end
 
       request
     end
@@ -103,16 +107,31 @@ module Vonage
     end
 
     def request(path, params: nil, type: Get, response_class: Response, &block)
-      auto_advance = !params.nil? && params.key?(:auto_advance) ? params[:auto_advance] : false
+      auto_advance =
+        (
+          if !params.nil? && params.key?(:auto_advance)
+            params[:auto_advance]
+          else
+            false
+          end
+        )
 
-      params = params.tap { |params| params.delete(:auto_advance) } if !params.nil? && params.key?(:auto_advance)
+      params =
+        params.tap { |params| params.delete(:auto_advance) } if !params.nil? &&
+        params.key?(:auto_advance)
 
       request = build_request(path: path, params: params || {}, type: type)
 
       response = make_request!(request, &block)
 
       if auto_advance
-        iterable_request(path, response: response, response_class: response_class, params: params, &block)
+        iterable_request(
+          path,
+          response: response,
+          response_class: response_class,
+          params: params,
+          &block
+        )
       else
         return if block
 
@@ -120,25 +139,29 @@ module Vonage
       end
     end
 
-    def multipart_post_request(path, filepath:, file_name:, mime_type:, response_class: Response, &block)
-      authentication = self.class.authentication.new(@config)
+    def multipart_post_request(path, filepath:, file_name:, mime_type:, params: {}, override_uri: nil, no_auth: false, response_class: Response, &block)
+      authentication = self.class.authentication.new(@config) unless no_auth
 
-      uri = URI('https://' + @host + path)
+      uri = override_uri ? URI(override_uri) : URI('https://' + @host + path)
+
+      http = override_uri ? Net::HTTP.new(uri.host, Net::HTTP.https_default_port, p_addr = nil) : @http
+      http.use_ssl = true
+      http.set_debug_output($stdout)
 
       response = File.open(filepath) do |file|
         request = Net::HTTP::Post::Multipart.new(
           uri,
-          {file: Multipart::Post::UploadIO.new(file, mime_type, file_name)}
+          params.merge(file: Multipart::Post::UploadIO.new(file, mime_type, file_name))
         )
 
         request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
 
         # Set BearerToken if needed
-        authentication.update(request)
+        authentication.update(request) unless no_auth
 
         logger.log_request_info(request)
 
-        @http.request(request, &block)
+        http.request(request, &block)
       end
 
       logger.log_response_info(response, @host)
@@ -156,16 +179,19 @@ module Vonage
       remainder = remaining_count(json_response)
 
       while remainder > 0
-        params = { page_size: json_response['page_size'] }
-
-        if json_response['record_index'] && json_response['record_index'] == 0
-          params[:record_index] = json_response['page_size']
-        elsif json_response['record_index'] && json_response['record_index'] != 0
-          params[:record_index] = (json_response['record_index'] + json_response['page_size'])
+        params = { page_size: json_response["page_size"] }
+
+        if json_response["record_index"] && json_response["record_index"] == 0
+          params[:record_index] = json_response["page_size"]
+        elsif json_response["record_index"] &&
+              json_response["record_index"] != 0
+          params[:record_index] = (
+            json_response["record_index"] + json_response["page_size"]
+          )
         end
 
-        if json_response['total_pages']
-          params[:page] = json_response['page'] + 1
+        if json_response["total_pages"]
+          params[:page] = json_response["page"] + 1
         end
 
         request = build_request(path: path, type: Get, params: params)
@@ -176,11 +202,15 @@ module Vonage
         json_response = ::JSON.parse(paginated_response.body)
         remainder = remaining_count(json_response)
 
-        if response.respond_to?('_embedded')
-          collection_name = collection_name(response['_embedded'])
-          response['_embedded'][collection_name].push(*next_response['_embedded'][collection_name])
+        if response.respond_to?("_embedded")
+          collection_name = collection_name(response["_embedded"])
+          response["_embedded"][collection_name].push(
+            *next_response["_embedded"][collection_name]
+          )
         else
-          response[collection_name(response)].push(*next_response[collection_name(next_response)])
+          response[collection_name(response)].push(
+            *next_response[collection_name(next_response)]
+          )
         end
       end
 
@@ -188,43 +218,51 @@ module Vonage
     end
 
     def remaining_count(params)
-      if params.key?('total_pages')
-        params['total_pages'] - params['page']
-      elsif params.key?('count')
-        params['count'] - (params['record_index'] == 0 ? params['page_size'] : (params['record_index'] + params['page_size']))
+      if params.key?("total_pages")
+        params["total_pages"] - params["page"]
+      elsif params.key?("count")
+        params["count"] -
+          (
+            if params["record_index"] == 0
+              params["page_size"]
+            else
+              (params["record_index"] + params["page_size"])
+            end
+          )
       else
         0
       end
     end
 
     def collection_name(params)
-      @collection_name ||= case
-        when params.respond_to?('calls')
-          'calls'
-        when params.respond_to?('users')
-          'users'
-        when params.respond_to?('legs')
-          'legs'
-        when params.respond_to?('data')
-          'data'
-        when params.respond_to?('conversations')
-          'conversations'
-        when params.respond_to?('applications')
-          'applications'
-        when params.respond_to?('records')
-          'records'
-        when params.respond_to?('reports')
-          'reports'
-        when params.respond_to?('networks')
-          'networks'
-        when params.respond_to?('countries')
-          'countries'
-        when params.respond_to?('media')
-          'media'
-        when params.respond_to?('numbers')
-          'numbers'
-        when params.respond_to?('events')
-          'events'
+      @collection_name ||=
+        case
+        when params.respond_to?("calls")
+          "calls"
+        when params.respond_to?("users")
+          "users"
+        when params.respond_to?("legs")
+          "legs"
+        when params.respond_to?("data")
+          "data"
+        when params.respond_to?("conversations")
+          "conversations"
+        when params.respond_to?("applications")
+          "applications"
+        when params.respond_to?("records")
+          "records"
+        when params.respond_to?("reports")
+          "reports"
+        when params.respond_to?("networks")
+          "networks"
+        when params.respond_to?("countries")
+          "countries"
+        when params.respond_to?("media")
+          "media"
+        when params.respond_to?("numbers")
+          "numbers"
+        when params.respond_to?("events")
+          "events"
         else
           params.entity.attributes.keys[0].to_s
         end

data/lib/vonage/users/list_response.rb

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

data/lib/vonage/users.rb

@@ -0,0 +1,156 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Users < Namespace
+    extend T::Sig
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # Get a list of Users associated with the Vonage Application.
+    #
+    # @param [optional, Integer] :page_size
+    #   Specifies the number of records to be returned in the response.
+    #
+    # @param [optional, String] :order
+    #   Specifies the order in which the records should be returned.
+    #   Must be one of `asc`, `ASC`, `desc`, or `DESC`
+    #
+    # @param [optional, String] :cursor
+    #   Specficy a cursor point from which to start returning results, for example the values of the `next` or `prev`
+    #   `_links` contained in a response.
+    #
+    # @param [optional, String] :name
+    #   Specify a user name with which to filter results
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#getUsers
+    #
+    def list(**params)
+      request('/v1/users', params: params, response_class: ListResponse)
+    end
+
+    # Get a specified User associated with the Vonage Application.
+    #
+    # @param [required, String] :id
+    #   The unique ID or name for the user.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#getUser
+    #
+    def find(id:)
+      request("/v1/users/#{id}")
+    end
+
+    # Create a new User associated with the Vonage Application.
+    #
+    # @param [optional, String] :name
+    #   A unique name for the user. If not provided, a name will be auto-generated.
+    #
+    # @param [optional, String] :display_name
+    #   A string to be displayed as user name. It does not need to be unique.
+    #
+    # @param [optional, String] :image_url
+    #   A publicly accessible URL to an image file for an image to be associated with the user.
+    #
+    # @param [optional, Hash] :properties A hash defining properties for the User.
+    #   @option properties [Hash] :custom_data A hash of custom data as key/value pairs.
+    #
+    # @param [optional, Hash] :channels A hash defining details of various channels.
+    #   @option channels [Array] :pstn An array containing a Hash which defines data for the pstn channel.
+    #     @option pstn [Integer] :number The pstn number.
+    #   @option channels [Array] :sip An array containing a Hash which defines data for the sip channel.
+    #     @option sip [String] :uri The sip uri.
+    #     @option sip [String] :username The sip username.
+    #     @option sip [String] :password The sip password.
+    #   @option channels [Array] :vbc An array containing a Hash which defines data for the vbc channel.
+    #     @option vbc [String] :extension The vbc extension.
+    #   @option channels [Array] :websocket An array containing a Hash which defines data for the websocket channel.
+    #     @option websocket [String] :uri The websocket uri.
+    #     @option websocket [String] :content-type The websocket audio type. Must be one of: `audio/l16;rate=8000`, `audio/l16;rate=16000`.
+    #     @option websocket [Hash] :headers A hash of custom websocket headers provided as key/value pairs.
+    #   @option channels [Array] :sms An array containing a Hash which defines data for the sms channel.
+    #     @option sms [Integer] :number The sms number.
+    #   @option channels [Array] :mms An array containing a Hash which defines data for the mms channel.
+    #     @option mms [Integer] :number The mms number.
+    #   @option channels [Array] :whatsapp An array containing a Hash which defines data for the whatsapp channel.
+    #     @option whatsapp [Integer] :number The whatsapp number.
+    #   @option channels [Array] :viber An array containing a Hash which defines data for the sms channel.
+    #     @option viber [Integer] :number The viber number.
+    #   @option channels [Array] :messenger An array containing a Hash which defines data for the messenger channel.
+    #     @option messenger [Integer] :id The messenger id.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#createUser
+    #
+    def create(**params)
+      request('/v1/users', params: params, type: Post)
+    end
+
+    # Update an existing User associated with the Vonage Application.
+    #
+    # @param [required, String] :id
+    #   The unique ID or name for the user to be updated.
+    #
+    # @param [optional, String] :name
+    #   A unique name for the user.
+    #
+    # @param [optional, String] :display_name
+    #   A string to be displayed as user name. It does not need to be unique.
+    #
+    # @param [optional, String] :image_url
+    #   A publicly accessible URL to an image file for an image to be associated with the user.
+    #
+    # @param [optional, Hash] :properties A hash defining properties for the User.
+    #   @option properties [Hash] :custom_data A hash of custom data as key/value pairs.
+    #
+    # @param [optional, Hash] :channels A hash defining details of various channels.
+    #   @option channels [Array] :pstn An array containing a Hash which defines data for the pstn channel.
+    #     @option pstn [Integer] :number The pstn number.
+    #   @option channels [Array] :sip An array containing a Hash which defines data for the sip channel.
+    #     @option sip [String] :uri The sip uri.
+    #     @option sip [String] :username The sip username.
+    #     @option sip [String] :password The sip password.
+    #   @option channels [Array] :vbc An array containing a Hash which defines data for the vbc channel.
+    #     @option vbc [String] :extension The vbc extension.
+    #   @option channels [Array] :websocket An array containing a Hash which defines data for the websocket channel.
+    #     @option websocket [String] :uri The websocket uri.
+    #     @option websocket [String] :content-type The websocket audio type. Must be one of: `audio/l16;rate=8000`, `audio/l16;rate=16000`.
+    #     @option websocket [Hash] :headers A hash of custom websocket headers provided as key/value pairs.
+    #   @option channels [Array] :sms An array containing a Hash which defines data for the sms channel.
+    #     @option sms [Integer] :number The sms number.
+    #   @option channels [Array] :mms An array containing a Hash which defines data for the mms channel.
+    #     @option mms [Integer] :number The mms number.
+    #   @option channels [Array] :whatsapp An array containing a Hash which defines data for the whatsapp channel.
+    #     @option whatsapp [Integer] :number The whatsapp number.
+    #   @option channels [Array] :viber An array containing a Hash which defines data for the sms channel.
+    #     @option viber [Integer] :number The viber number.
+    #   @option channels [Array] :messenger An array containing a Hash which defines data for the messenger channel.
+    #     @option messenger [Integer] :id The messenger id.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#createUser
+    #
+    def update(id:, **params)
+      request("/v1/users/#{id}", params: params, type: Patch)
+    end
+
+    # Delete a specified User associated with the Vonage Application.
+    #
+    # @param [required, String] :id
+    #   The unique ID or name for the user.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#deleteUser
+    #
+    def delete(id:)
+      request("/v1/users/#{id}", type: Delete)
+    end
+  end
+end

data/lib/vonage/verify2.rb

@@ -28,7 +28,7 @@ module Vonage
     #   @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 Vomage::Response
+    # @return Vonage::Response
     # @see https://developer.vonage.com/en/api/verify.v2#newRequest
     #
     def start_verification(brand:, workflow:, **opts)

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = "7.13.0"
+  VERSION = "7.15.0"
 end

data/vonage.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary = 'This is the Ruby Server SDK for Vonage APIs. To use it you\'ll need a Vonage account. Sign up for free at https://www.vonage.com'
   s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md vonage.gemspec)
   s.required_ruby_version = '>= 2.5.0'
-  s.add_dependency('vonage-jwt', '~> 0.1.0')
+  s.add_dependency('vonage-jwt', '~> 0.1.3')
   s.add_dependency('zeitwerk', '~> 2', '>= 2.2')
   s.add_dependency('sorbet-runtime', '~> 0.5')
   s.add_dependency('multipart-post', '~> 2.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.13.0
+  version: 7.15.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +139,17 @@ files:
 - lib/vonage/key_secret_params.rb
 - lib/vonage/keys.rb
 - lib/vonage/logger.rb
+- lib/vonage/meetings.rb
+- lib/vonage/meetings/applications.rb
+- lib/vonage/meetings/dial_in_numbers.rb
+- lib/vonage/meetings/dial_in_numbers/list_response.rb
+- lib/vonage/meetings/recordings.rb
+- lib/vonage/meetings/rooms.rb
+- lib/vonage/meetings/rooms/list_response.rb
+- lib/vonage/meetings/sessions.rb
+- lib/vonage/meetings/sessions/list_response.rb
+- lib/vonage/meetings/themes.rb
+- lib/vonage/meetings/themes/list_response.rb
 - lib/vonage/messages.rb
 - lib/vonage/messaging.rb
 - lib/vonage/messaging/channels/messenger.rb
@@ -179,6 +190,8 @@ files:
 - lib/vonage/subaccounts/list_response.rb
 - lib/vonage/tfa.rb
 - lib/vonage/user_agent.rb
+- lib/vonage/users.rb
+- lib/vonage/users/list_response.rb
 - lib/vonage/verify.rb
 - lib/vonage/verify2.rb
 - lib/vonage/verify2/channels/email.rb