vonage 7.28.0 → 8.0.0.beta

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

data/lib/vonage/meetings/themes.rb

@@ -1,239 +0,0 @@
-# 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.
-    #
-    # @deprecated
-    #
-    # @return [ListResponse]
-    #
-    # @see https://developer.vonage.com/en/api/meetings#getThemes
-    def list
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/meetings/themes", response_class: ListResponse)
-    end
-
-    # Return information for specified theme.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v1/meetings/themes/" + theme_id)
-    end
-
-    # Create a new theme.
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v1/meetings/themes",
-        params: params.merge(main_color: main_color, brand_text: brand_text),
-        type: Post
-      )
-    end
-
-    # Update an existing theme.
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v1/meetings/themes/" + theme_id,
-        params: {
-          update_details: params
-        },
-        type: Patch
-      )
-    end
-
-    # Delete an existing theme.
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v1/meetings/themes/" + theme_id + "?force=#{force}",
-        type: Delete
-      )
-    end
-
-    # Get a list of rooms that are associated with a theme id.
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      path = "/v1/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.
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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("/v1/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(
-        "/v1/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

@@ -1,50 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Vonage
-  class Meetings < Namespace
-    extend T::Sig
-    
-    # @deprecated
-    sig { returns(T.nilable(Vonage::Meetings::Rooms)) }
-    def rooms
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @rooms ||= Rooms.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::Meetings::Recordings)) }
-    def recordings
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @recordings ||= Recordings.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::Meetings::Sessions)) }
-    def sessions
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @sessions ||= Sessions.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::Meetings::Themes)) }
-    def themes
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @themes ||= Themes.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::Meetings::Applications)) }
-    def applications
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @applications ||= Applications.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::Meetings::DialInNumbers)) }
-    def dial_in_numbers
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @dial_in_numbers ||= DialInNumbers.new(@config)
-    end
-  end
-end

data/lib/vonage/messaging/channels/rcs.rb

@@ -1,42 +0,0 @@
-# typed: true
-
-module Vonage
-  class Messaging::Channels::RCS < Messaging::Message
-    MESSAGE_TYPES = ['text', 'image', 'video', 'file', 'custom']
-
-    attr_reader :data
-
-    def initialize(attributes = {})
-      @type = attributes.fetch(:type, nil)
-      @message = attributes.fetch(:message, nil)
-      @opts = attributes.fetch(:opts, {})
-      @data = {}
-
-      after_initialize!
-    end
-
-    private
-
-    def build
-      data[:channel] = 'rcs'
-      super
-    end
-
-    def verify_type
-      raise ClientError.new("Invalid message type") unless MESSAGE_TYPES.include?(type)
-    end
-
-    def verify_message
-      case type
-      when 'text'
-        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a String") unless message.is_a? String
-      when 'custom'
-        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a Hash") unless message.is_a? Hash
-        raise Vonage::ClientError.new("Invalid parameter content. `:message` must not be empty") if message.empty?
-      else
-        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a Hash") unless message.is_a? Hash
-        raise Vonage::ClientError.new("Missing parameter. `:message` must contain a `:url` key") unless message[:url]
-      end
-    end
-  end
-end

data/lib/vonage/network_authentication/client_authentication.rb

@@ -1,39 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class NetworkAuthentication::ClientAuthentication < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    self.request_headers['Content-Type'] = 'application/x-www-form-urlencoded'
-
-    def token(oidc_auth_code:, redirect_uri:, **params)
-      request(
-        '/oauth2/token',
-        params: {
-          grant_type: 'authorization_code',
-          code: oidc_auth_code,
-          redirect_uri: redirect_uri
-        },
-        type: Post
-      ).access_token
-    end
-
-    def generate_oidc_uri(purpose:, api_scope:, login_hint:, redirect_uri:, state:)
-      scope = "openid%20dpv:#{purpose}%23#{api_scope}"
-      uri = "https://oidc.idp.vonage.com/oauth2/auth?" +
-        "client_id=#{@config.application_id}" +
-        "&response_type=code" +
-        "&scope=#{scope}" +
-        "&login_hint=#{login_hint}" +
-        "&redirect_uri=#{redirect_uri}" +
-        "&state=#{state}"
-
-      uri
-    end
-  end
-end

data/lib/vonage/network_authentication/server_authentication.rb

@@ -1,47 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class NetworkAuthentication::ServerAuthentication < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    self.request_headers['Content-Type'] = 'application/x-www-form-urlencoded'
-
-    def token(purpose:, api_scope:, login_hint:, **params)
-      auth_req_id = bc_authorize(
-        purpose: purpose,
-        api_scope: api_scope,
-        login_hint: login_hint
-      ).auth_req_id
-
-      request_access_token(auth_req_id: auth_req_id).access_token
-    end
-
-    def bc_authorize(purpose:, api_scope:, login_hint:)
-      scope = "openid dpv:#{purpose}##{api_scope}"
-      request(
-        "/oauth2/bc-authorize",
-        params: {
-          scope: scope,
-          login_hint: login_hint
-        },
-        type: Post
-      )
-    end
-
-    def request_access_token(auth_req_id:)
-      request(
-        "/oauth2/token",
-        params: {
-          grant_type: 'urn:openid:params:grant-type:ciba',
-          auth_req_id: auth_req_id
-        },
-        type: Post
-      )
-    end
-  end
-end

data/lib/vonage/network_authentication.rb

@@ -1,22 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class NetworkAuthentication < AbstractAuthentication
-    def update(object, data)
-      return unless object.is_a?(Net::HTTPRequest)
-
-      token = self.public_send(data[:auth_flow]).token(**data)
-
-      object['Authorization'] = 'Bearer ' + token
-    end
-
-    def client_authentication
-      @client_authentication ||= ClientAuthentication.new(@config)
-    end
-
-    def server_authentication
-      @server_authentication ||= ServerAuthentication.new(@config)
-    end
-  end
-end

data/lib/vonage/network_number_verification.rb

@@ -1,92 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-require 'phonelib'
-
-module Vonage
-  class NetworkNumberVerification < Namespace
-    extend T::Sig
-    include Keys
-
-    self.authentication = NetworkAuthentication
-
-    self.host = :vonage_host
-
-    self.request_body = JSON
-
-    # Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using.
-    #
-    # @example
-    #   response = client.network_number_verification.verify(
-    #     phone_number: '+447900000000',
-    #     auth_data: {
-    #       oidc_auth_code: '0dadaeb4-7c79-4d39-b4b0-5a6cc08bf537',
-    #       redirect_uri: 'https://example.com/callback'
-    #     }
-    #   )
-    #
-    # @param [required, String] :phone_number The phone number to check, in the E.164 format, prepended with a `+`.
-    #
-    # @param [required, Hash] :auth_data A hash of authentication data required for the client token request. Must contain the following keys:
-    # @option auth_data [required, String] :oidc_auth_code The OIDC auth code.
-    # @option auth_data [required, String] :redirect_uri The redirect URI.
-    # @see https://developer.vonage.com/en/getting-started-network/authentication#client-authentication-flow
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/camara/number-verification#verifyNumberVerification
-    #
-    sig { params(phone_number: String, auth_data: Hash).returns(Vonage::Response) }
-    def verify(phone_number:, auth_data:)
-      raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid?
-      raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+')
-      raise ArgumentError.new("`auth_data` must contain key `:oidc_auth_code`") unless auth_data.has_key?(:oidc_auth_code)
-      raise ArgumentError.new("`auth_data[:oidc_auth_code]` must be a String") unless auth_data[:oidc_auth_code].is_a?(String)
-      raise ArgumentError.new("`auth_data` must contain key `:redirect_uri`") unless auth_data.has_key?(:redirect_uri)
-      raise ArgumentError.new("`auth_data[:redirect_uri]` must be a String") unless auth_data[:redirect_uri].is_a?(String)
-
-      params = {phone_number: phone_number}
-
-      request(
-        '/camara/number-verification/v031/verify',
-        params: camelcase(params),
-        type: Post,
-        auth_data: {
-          oidc_auth_code: auth_data[:oidc_auth_code],
-          redirect_uri: auth_data[:redirect_uri],
-          auth_flow: :client_authentication
-        }
-      )
-    end
-
-    # Creates a URL for a client-side OIDC request.
-    #
-    # @example
-    #   response = client.network_number_verification.generate_oidc_uri(
-    #     phone_number: '+447900000000',
-    #     redirect_uri: 'https://example.com/callback'
-    #   )
-    #
-    # @param [required, String] :phone_number The phone number that will be checked during the verification request.
-    #
-    # @param [required, String] :redirect_uri The URI that will receive the callback containing the OIDC auth code.
-    #
-    # @param [required, String] :state A string that you can use for tracking. 
-    #   Used to set a unique identifier for each access token you generate.
-    #
-    # @return [String]
-    #
-    # @see https://developer.vonage.com/en/getting-started-network/authentication#1-make-an-oidc-request
-    sig { params(phone_number: String, redirect_uri: String, state: String).returns(String) }
-    def generate_oidc_uri(phone_number:, redirect_uri:, state:)
-      params = {
-        purpose: 'FraudPreventionAndDetection',
-        api_scope: 'number-verification-verify-read',
-        login_hint: phone_number,
-        redirect_uri: redirect_uri,
-        state: state
-      }
-
-      Vonage::NetworkAuthentication::ClientAuthentication.new(@config).generate_oidc_uri(**params)
-    end
-  end
-end

data/lib/vonage/network_sim_swap.rb

@@ -1,84 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-require 'phonelib'
-
-module Vonage
-  class NetworkSIMSwap < Namespace
-    extend T::Sig
-    include Keys
-
-    self.authentication = NetworkAuthentication
-
-    self.host = :vonage_host
-
-    self.request_body = JSON
-
-    # Check if SIM swap has been performed during a past period.
-    #
-    # @example
-    #   response = client.network_sim_swap.check(phone_number: '+447900000000')
-    #
-    # @param [required, String] :phone_number The phone number to check, in the E.164 format, prepended with a `+`.
-    #
-    # @param [optional, Integer] :max_age Period in hours to be checked for SIM swap
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/camara/sim-swap#checkSimSwap
-    #
-    sig { params(phone_number: String, max_age: T.nilable(Integer)).returns(Vonage::Response) }
-    def check(phone_number:, max_age: nil)
-      raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid?
-      raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+')
-      if max_age
-        raise ArgumentError.new("`max_age` must between 1 and 2400") unless max_age.between?(1, 2400)
-      end
-
-      params = {phone_number: phone_number}
-      params[:max_age] = max_age if max_age
-
-      request(
-        '/camara/sim-swap/v040/check',
-        params: camelcase(params),
-        type: Post,
-        auth_data: {
-          login_hint: phone_number,
-          purpose: 'FraudPreventionAndDetection',
-          api_scope: 'check-sim-swap',
-          auth_flow: :server_authentication
-        }
-      )
-    end
-
-    # Get timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.
-    #
-    # @example
-    #   response = client.network_sim_swap.retrieve_date(phone_number: '+447900000000')
-    #
-    # @param [required, String] :phone_number The phone number to check, in the E.164 format, prepended with a `+`.
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/camara/sim-swap#retrieveSimSwapDate
-    #
-    sig { params(phone_number: String).returns(Vonage::Response) }
-    def retrieve_date(phone_number:)
-      raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid?
-      raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+')
-
-      params = {phone_number: phone_number}
-
-      request(
-        '/camara/sim-swap/v040/retrieve-date',
-        params: camelcase(params),
-        type: Post,
-        auth_data: {
-          login_hint: phone_number,
-          purpose: 'FraudPreventionAndDetection',
-          api_scope: 'retrieve-sim-swap-date',
-          auth_flow: :server_authentication
-        }
-      )
-    end
-  end
-end