vonage 7.18.0 → 8.0.0.beta

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/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

data/lib/vonage/proactive_connect/items/file_response.rb

@@ -1,32 +0,0 @@
-# typed: true
-
-class Vonage::ProactiveConnect::Items::FileResponse < Vonage::Response
-  DEFAULT_FILENAME = 'vonage-proactive-connect-list-items.csv'
-
-  attr_accessor :filename
-
-  def initialize(entity=nil, http_response=nil)
-    super
-    self.filename = initial_filename
-  end
-
-  def save(filepath:)
-    pn = Pathname.new(filepath)
-    raise ArgumentError, ':filepath not a directory' unless pn.directory?
-    raise ArgumentError, ':filepath not absolute' unless pn.absolute?
-    raise ArgumentError, ':filepath not writable' unless pn.writable?
-
-    File.open("#{pn.cleanpath}/#{filename}", 'w') {|f| f.write(http_response.body) }
-  end
-
-  def data
-    http_response ? http_response.body : nil
-  end
-
-  private
-
-  def initial_filename
-    match_data = http_response['Content-Disposition'].match(/filename=(\"?)(.+)\1/)
-    match_data ? match_data[2] : DEFAULT_FILENAME
-  end
-end

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

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

data/lib/vonage/proactive_connect/items.rb

@@ -1,107 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect::Items < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    # Find all list items
-    #
-    # @example
-    #   response = proactive_connect.items.list(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
-    #
-    # @param [required, String] :list_id
-    #   Unique identifier for the 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
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsFindAll
-    #
-    def list(list_id:, **params)
-      path = "/v0.1/bulk/lists/#{list_id}/items"
-      path += "?#{Params.encode(params)}" unless params.empty?
-
-      request(path, response_class: ListResponse)
-    end
-
-    # Download list items as a CSV file format
-    #
-    # @example
-    #   response = proactive_connect.items.download_csv(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
-    #
-    # @param [required, String] :list_id
-    #   ID for the list to download
-    #
-    # @param [optional, String] order
-    #   Sort in either ascending (asc, the default) or descending (desc) order
-    #
-    # @param [optional, String] :filename
-    #   A name to set for the returned File object. If not set, the File object will use the actual filename (if available)
-    #     or a default of `download.csv` if the actual filename is not available.
-    #
-    # @param [optional, String] :filepath
-    #   A filepath to a directory where the file should be written.
-    #   If not set, the file is not written, though the the file can be written at any time by calling `save` on the returned
-    #     object and passing in `:filepath` as an argument to the `save` method, for example:
-    #       response = proactive_connect.items.download_csv(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
-    #       response.save('/files/downloads/')
-    #   If set, the filepath must be:
-    #     - An absolute path
-    #     - For a valid directory
-    #     - The directory must be writable
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsDownload
-    #
-    def download_csv(list_id:, order: 'asc', **params)
-      response = request("/v0.1/bulk/lists/#{list_id}/items/download?order=#{order}", response_class: FileResponse)
-
-      response.filename = params[:filename] if params[:filename]
-      response.save(filepath: params[:filepath]) if params[:filepath]
-
-      response
-    end
-
-    # Import list items from a CSV file
-    #
-    # @example
-    #   response = proactive_connect.items.upload_csv(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', filepath: '/files/import.csv')
-    #
-    # @param [required, String] :list_id
-    #   ID for the list to download
-    #
-    # @param [optional, String] order
-    #   Sort in either ascending (asc, the default) or descending (desc) order
-    #
-    # @param [optional, String] :filename
-    #   A name to set for the returned File object. If not set, the File object will use the actual filename (if available)
-    #     or a default of `download.csv` if the actual filename is not available.
-    #
-    # @param [required, String] :filepath
-    #   A filepath for the file to import. The file must be:
-    #     - A valid file
-    #     - Readable
-    #     - Must have a `.csv` extension
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#itemsImport
-    #
-    def upload_csv(list_id:, filepath:)
-      pn = Pathname.new(filepath)
-      raise ArgumentError, ':filepath not for a file' unless pn.file?
-      raise ArgumentError, 'file at :filepath not readable' unless pn.readable?
-      raise ArgumentError, 'file at :filepath not csv' unless pn.extname == '.csv'
-
-      multipart_post_request("/v0.1/bulk/lists/#{list_id}/items/import", filepath: filepath, file_name: pn.basename, mime_type: 'text/csv')
-    end
-  end
-end