vonage 7.35.0 → 8.0.0.beta

data/lib/vonage/conversation.rb

@@ -1,164 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Vonage
-  class Conversation < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    # List conversations associated with a Vonage application.
-    #
-    # @example
-    #   response = client.conversation.list
-    #
-    # @param [String] :date_start
-    #   Return the records that occurred after this point in time.
-    #
-    # @param [String] :date_end
-    #   Return the records that occurred before this point in time.
-    #
-    # @param [Integer] :page_size
-    #   Return this amount of records in the response.
-    #
-    # @param ['asc', 'desc'] :order
-    #   Return the records in ascending or descending order.
-    #
-    # @param [String] :cursor
-    #   The cursor to start returning results from.
-    #  
-    # @return [Conversation::ListResponse]
-    #
-    # @see https://developer.vonage.com/en/api/conversation#listConversations
-    #
-    def list(**params)
-      request('/v1/conversations', params: params, response_class: ListResponse)
-    end
-
-    # Create a conversation.
-    #
-    # @example
-    #   response = client.conversation.create(name: 'Example Conversation', display_name: 'Example Display Name')
-    #
-    # @param [String] :name
-    #   Your internal conversation name. Must be unique.
-    #
-    # @param [String] :display_name
-    #   The public facing name of the conversation.
-    #
-    # @param [String] :image_url
-    #   An image URL that you associate with the conversation
-    #
-    # @param [Hash] :properties
-    #   - :ttl (Integer) After how many seconds an empty conversation is deleted
-    #   - :type (String)
-    #   - :custom_sort_key (String)
-    #   - :custom_data (Hash) Custom key/value pairs to be included with conversation data
-    #
-    # @option params [Array] :numbers An array of Hashes containing number information for different channels.
-    #
-    # @option params [Hash] :callback
-    #   - @option callback :url (String)
-    #   - @option callback :event_mask (String)
-    #   - @option callback :params (Hash)
-    #     - @option params :applicationId (String)
-    #     - @option params :ncco_url (String)
-    #   - @option callback :method (String) Must be one of ['POST', 'GET']
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/conversation#createConversation
-    #
-    def create(**params)
-      request('/v1/conversations', params: params, type: Post)
-    end
-
-    # Retrieve a conversation.
-    #
-    # @example
-    #   response = client.conversation.find(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
-    #
-    # @param [String] :conversation_id
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/conversation#retrieveConversation
-    #
-    def find(conversation_id:)
-      request("/v1/conversations/#{conversation_id}")
-    end
-
-    # Update a conversation.
-    #
-    # @example
-    #   response = client.conversation.update(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a', display_name: 'Updated conversation')
-    #
-    # @param [String] :name
-    #   Your internal conversation name. Must be unique.
-    #
-    # @param [String] :display_name
-    #   The public facing name of the conversation.
-    #
-    # @param [String] :image_url
-    #   An image URL that you associate with the conversation
-    #
-    # @param [Hash] :properties
-    #   - @option properties :ttl (Integer) After how many seconds an empty conversation is deleted
-    #   - @option properties :type (String)
-    #   - @option properties :custom_sort_key (String)
-    #   - @option properties :custom_data (Hash) Custom key/value pairs to be included with conversation data
-    #
-    # @param [Array] :numbers An array of Hashes containing number information for different channels.
-    #
-    # @option params [Hash] :callback
-    #   - @option callback :url (String)
-    #   - @option callback :event_mask (String)
-    #   - @option callback :params (Hash)
-    #     - @option params :applicationId (String)
-    #     - @option params :ncco_url (String)
-    #   - @option callback :method (String) Must be one of ['POST', 'GET']
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/conversation#replaceConversation
-    #
-    def update(conversation_id:, **params)
-      request("/v1/conversations/#{conversation_id}", params: params, type: Put)
-    end
-
-    # Delete a conversation.
-    #
-    # @example
-    #   response = client.conversation.delete(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
-    #
-    # @param [String] :conversation_id
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/conversation#deleteConversation
-    #
-    def delete(conversation_id:)
-      request("/v1/conversations/#{conversation_id}", type: Delete)
-    end
-
-    # @return [Conversation::User]
-    sig { returns(T.nilable(Vonage::Conversation::User)) }
-    def user
-      @user ||= User.new(@config)
-    end
-
-    # @return [Conversation::Member]
-    sig { returns(T.nilable(Vonage::Conversation::Member)) }
-    def member
-      @member ||= Member.new(@config)
-    end
-
-    # @return [Conversation::Event]
-    sig { returns(T.nilable(Vonage::Conversation::Event)) }
-    def event
-      @event ||= Event.new(@config)
-    end
-  end
-end

data/lib/vonage/identity_insights/insights_builder.rb

@@ -1,75 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class IdentityInsights::InsightsBuilder
-    def initialize
-      @insights = {}
-    end
-
-    # Add a Format insight.
-    # @example
-    #   builder = Vonage::IdentityInsights::InsightsBuilder.new
-    #   builder.add_format
-    # @return [InsightsBuilder] The InsightsBuilder instance.
-    #
-    def add_format
-      @insights[:format] = {}
-      self
-    end
-
-    # Add a Sim Swap insight.
-    # @example
-    #   builder = Vonage::IdentityInsights::InsightsBuilder.new
-    #   builder.add_sim_swap(period: 180)
-    # @param period [Integer] The period for the sim swap insight.
-    #   - Optional. If provided, must be between 1 and 2400.
-    # @return [InsightsBuilder] The InsightsBuilder instance.
-    #
-    def add_sim_swap(period: nil)
-      params = {}
-      if period
-        validate_sim_swap_period(period)
-        params[:period] = period 
-      end
-      @insights[:sim_swap] = params
-      self
-    end
-
-    # Add a Current Carrier insight.
-    # @example
-    #   builder = Vonage::IdentityInsights::InsightsBuilder.new
-    #   builder.add_current_carrier
-    # @return [InsightsBuilder] The InsightsBuilder instance.
-    #
-    def add_current_carrier
-      @insights[:current_carrier] = {}
-      self
-    end
-
-    # Add an Original Carrier insight.
-    # @example
-    #   builder = Vonage::IdentityInsights::InsightsBuilder.new
-    #   builder.add_original_carrier
-    # @return [InsightsBuilder] The InsightsBuilder instance.
-    #
-    def add_original_carrier
-      @insights[:original_carrier] = {}
-      self
-    end
-
-    # Convert the InsightsBuilder to a Hash.
-    # @return [Hash] The insights as a Hash.
-    #
-    def to_h
-      @insights
-    end
-
-    private
-
-    def validate_sim_swap_period(period)
-      raise ArgumentError, 'Period must be an Integer' unless period.is_a?(Integer)
-      raise ArgumentError, 'Period must be between 1 and 2400' unless period.between?(1, 2400)
-    end
-  end
-end

data/lib/vonage/identity_insights.rb

@@ -1,75 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Vonage
-  class IdentityInsights < Namespace
-    VALID_INSIGHT_TYPES = %i[format sim_swap original_carrier current_carrier].freeze
-    
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    self.request_body = JSON
-
-    # Submit an Identity Insights request.
-    #  The SDK currently supports the following insight types: `format`, `sim_swap`, `current_carrier`, and `original_carrier`.
-    #
-    # @example with `insights` as a Hash
-    #   response = client.identity_insights.requests(phone_number: '447900000000', insights: { format: {} })
-    #
-    # @example with `insights` as an InsightsBuilder
-    #   insights = client.identity_insights.insights_builder.add_format.add_sim_swap(period: 180)
-    #   response = client.identity_insights.requests(phone_number: '447900000000', insights: insights)
-    #
-    # @example with a block to build `insights`
-    #   response = client.identity_insights.requests(phone_number: '447900000000') do |builder|
-    #     builder.add_format
-    #     builder.add_sim_swap(period: 180)
-    #   end
-    #
-    # @option params [required, String] :phone_number The phone number to request insights for.
-    #
-    # @option params [String] :purpose The purpose for requesting the insights.
-    #
-    # @option params [Hash, InsightsBuilder] :insights
-    #   A Hash or InsightsBuilder instance specifying the types of insights to request.
-    #   See the Vonage developer documentation for any parameters supported by each insight type.
-    #
-    # for block {|builder| ... }
-    # @yield [builder] passes a InsightsBuilder instance to the block
-    # @yieldreturn [required, InsightsBuilder] expects the block to return a InsightsBuilder instance
-    #
-    # @return [Vonage::Response] The API response.
-    #
-    # @see https://developer.vonage.com/en/api/identity-insights#getInsights
-    #
-    def requests(phone_number:, insights: {}, **options)
-      insights = yield insights_builder if block_given?
-      validate_insights(insights)
-
-      params = {
-        phone_number: phone_number,
-        insights: insights.to_h
-      }.merge(options)
-
-      request('/identity-insights/v1/requests', params: params, type: Post)
-    end
-
-    # Instantiate an InsightsBuilder.
-    # @return [InsightsBuilder] A new InsightsBuilder instance.
-    #
-    def insights_builder
-      InsightsBuilder.new
-    end
-
-    private
-
-    def validate_insights(insights)
-      raise ArgumentError.new("`insights` must be a Hash or instance of InsightsBuilder") unless insights.is_a?(Hash) || insights.is_a?(InsightsBuilder)
-      raise ArgumentError.new("`insights` cannot be empty") if insights.to_h.empty?
-
-      invalid_insights = insights.to_h.keys - VALID_INSIGHT_TYPES
-      raise ArgumentError.new("`insights` contains the following invalid or unsupported insight types: #{invalid_insights.join(', ')}") unless invalid_insights.empty?
-    end
-  end
-end

data/lib/vonage/meetings/applications.rb

@@ -1,28 +0,0 @@
-# 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.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/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

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

@@ -1,26 +0,0 @@
-# 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.
-    #
-    # @deprecated
-    #
-    # @return [ListResponse]
-    #
-    # @see https://developer.vonage.com/en/api/meetings#getDialInNumbers
-    def list
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/meetings/dial-in-numbers", response_class: ListResponse)
-    end
-  end
-end

data/lib/vonage/meetings/recordings.rb

@@ -1,42 +0,0 @@
-# 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.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/meetings/recordings/" + recording_id)
-    end
-
-    # Delete a specified recording.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/meetings/recordings/" + recording_id, type: Delete)
-    end
-  end
-end

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

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

@@ -1,167 +0,0 @@
-# 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.
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      path = "/v1/meetings/rooms"
-      path += "?#{Params.encode(params)}" unless params.empty?
-
-      request(path, response_class: ListResponse)
-    end
-
-    # Return information for specified room.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/meetings/rooms/" + room_id)
-    end
-
-    # Create a new room.
-    #
-    # @deprecated
-    #
-    # @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: `ar`, `pt-br`, `ca`, `zh-tw`, `zh-cn`, `en`, `fr`, `de`, `he`, `it`, `es`
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/meetings#createRoom
-    def create(display_name:, **params)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v1/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.
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      raise ArgumentError, 'must provide at least one other param in addition to :room_id' if params.empty?
-      request(
-        "/v1/meetings/rooms/" + room_id,
-        params: {
-          update_details: params
-        },
-        type: Patch
-      )
-    end
-  end
-end

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

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

data/lib/vonage/meetings/sessions.rb

@@ -1,31 +0,0 @@
-# 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.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v1/meetings/sessions/" + session_id + "/recordings",
-        response_class: ListResponse
-      )
-    end
-  end
-end

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

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