vonage 7.20.0 → 8.0.0.beta

data/lib/vonage/meetings/rooms.rb

@@ -1,155 +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.
-    #
-    # @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 = "/v1/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("/v1/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: `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)
-      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.
-    #
-    # @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(
-        "/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,28 +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.
-    #
-    # @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(
-        "/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,218 +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.
-    #
-    # @return [ListResponse]
-    #
-    # @see https://developer.vonage.com/en/api/meetings#getThemes
-    def list
-      request("/v1/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("/v1/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(
-        "/v1/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(
-        "/v1/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(
-        "/v1/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 = "/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.
-    #
-    # @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("/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,38 +0,0 @@
-# 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/number_insight_2.rb

@@ -1,36 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Vonage
-  class NumberInsight2 < Namespace
-    extend T::Sig
-
-    self.authentication = Basic
-
-    self.request_body = JSON
-
-    # Make fraud check requests with a phone number by looking up fraud score and/or by checking sim swap status.
-    #
-    # @example
-    #   response = client.number_insight_2.fraud_check(type: 'phone', phone: '447900000000', insights: ['fraud_score'])
-    #
-    # @param [required, String] :type The type of number to check.
-    #   Accepted value is “phone” when a phone number is provided.
-    #
-    # @param [required, String] :phone A single phone number that you need insight about in the E.164 format.
-    #
-    # @param [required, Array] :insights An array of strings indicating the fraud check insights required for the number.
-    #   Must be least one of: `fraud_score`, `sim_swap`
-    #
-    # @return [Response]
-    #
-    # @see https://developer.vonage.com/en/api/number-insight.v2#fraud_check
-    #
-    sig { params(type: String, phone: String, insights: T::Array[String]).returns(Vonage::Response) }
-    def fraud_check(type:, phone:, insights:)
-      raise ArgumentError.new("`insights` must not be an empty") if insights.empty?
-
-      request('/v2/ni', params: {type: type, phone: phone, insights: insights}, type: Post)
-    end
-  end
-end

data/lib/vonage/proactive_connect/events/list_response.rb

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

data/lib/vonage/proactive_connect/events.rb

@@ -1,68 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect::Events < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    # Find all events
-    #
-    # @example
-    #   response = proactive_connect.events.list
-    #
-    # @param [optional, String] :page
-    #   Page of results to jump to
-    #
-    # @param [optional, String] :page_size
-    #   Number of results per page
-    #
-    # @param [optional, String] order
-    #   Sort in either ascending (asc, the default) or descending (desc) order
-    #
-    # @param [optional, String] :run_id
-    #   Run IDs to filter by, if not specified, returns events for any run id
-    #
-    # @param [optional, String] :type
-    #   Event types to filter by
-    #
-    # @param [optional, String] action_id
-    #   Action IDs to filter by.
-    #
-    # @param [optional, String] :invocation_id
-    #   Invocation IDs to filter by
-    #
-    # @param [optional, String] :recipient_id
-    #   Recipient IDs to filter by
-    #
-    # @param [optional, String] :run_item_id
-    #   Run item IDs to filter by
-    #
-    # @param [optional, String] src_ctx
-    #   The name of the segment / matcher the item / event to filter by (exact string)
-    #
-    # @param [optional, String] :src_type
-    #   Source types to filter by
-    #
-    # @param [optional, String] :trace_id
-    #   Trace IDs to filter events by
-    #
-    # @param [optional, String] date_start
-    #   ISO-8601 formatted date for when to begin events filter
-    #
-    # @param [optional, String] :date_end
-    #   ISO-8601 formatted date for when to end events filter
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#eventsFindAll
-    #
-    def list(**params)
-      path = "/v0.1/bulk/events"
-      path += "?#{Params.encode(params)}" unless params.empty?
-
-      request(path, response_class: ListResponse)
-    end
-  end
-end

data/lib/vonage/proactive_connect/item.rb

@@ -1,104 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect::Item < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    self.request_body = JSON
-
-    # Create a list item
-    #
-    # @example
-    #   response = proactive_connect.item.create(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', data: {name: 'Joe Bloggs', email: 'joe@email.com'})
-    #
-    # @param [required, String] :list_id
-    #   Unique identifier for the list
-    #
-    # @param [required, Hash] :data
-    #   A hash of data containing the item's data attributes and values
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsCreate
-    #
-    def create(list_id:, data:)
-      raise ArgumentError.new(":data must be a Hash") unless data.is_a? Hash
-      request(
-        "/v0.1/bulk/lists/#{list_id}/items",
-        params: { data: data },
-        type: Post
-      )
-    end
-
-    # Get list item by id
-    #
-    # @example
-    #   response = proactive_connect.item.find(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', item_id: 'd97ebf20-e4de-4e50-921a-7bb4dceb373a')
-    #
-    # @param [required, String] :list_id
-    #   Unique identifier for the list
-    #
-    # @param [required, String] :item_id
-    #   Unique identifier for the item
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsGet
-    #
-    def find(list_id:, item_id:)
-      request("/v0.1/bulk/lists/#{list_id}/items/#{item_id}")
-    end
-
-    # Update list item
-    #
-    # @example
-    #   response = proactive_connect.item.create(
-    #     list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865',
-    #     item_id: 'd97ebf20-e4de-4e50-921a-7bb4dceb373a',
-    #     data: {name: 'Jane Bloggs', email: 'joe@email.com'}
-    #   )
-    #
-    # @param [required, String] :list_id
-    #   Unique identifier for the list
-    #
-    # @param [required, String] :item_id
-    #   Unique identifier for the item
-    #
-    # @param [required, Hash] :data
-    #   A hash of data containing the item's data attributes and values
-    #   All attributes for the item must be passed, even ones for which the value is not changing.
-    #     If an attribute is omitted, existing data for that attribute will be deleted.
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsUpdate
-    #
-    def update(list_id:, item_id:, data:)
-      raise ArgumentError.new(":data must be a Hash") unless data.is_a? Hash
-      request(
-        "/v0.1/bulk/lists/#{list_id}/items/#{item_id}",
-        params: { data: data },
-        type: Put
-      )
-    end
-
-    #  Delete list item
-    #
-    # @example
-    #   response = proactive_connect.item.delete(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', item_id: 'd97ebf20-e4de-4e50-921a-7bb4dceb373a')
-    #
-    # @param [required, String] :list_id
-    #   Unique identifier for the list
-    #
-    # @param [required, String] :item_id
-    #   Unique identifier for the item
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsDelete
-    #
-    def delete(list_id:, item_id:)
-      request(
-        "/v0.1/bulk/lists/#{list_id}/items/#{item_id}",
-        type: Delete
-      )
-    end
-  end
-end