vonage 7.28.0 → 8.0.0.beta

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,71 +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
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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,116 +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
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v0.1/bulk/lists/#{list_id}/items/#{item_id}")
-    end
-
-    # Update list item
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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,116 +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
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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
-    #
-    # @deprecated
-    #
-    # @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)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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
-    #
-    # @deprecated
-    #
-    # @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:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      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

data/lib/vonage/proactive_connect/list.rb

@@ -1,186 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect::List < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    self.request_body = JSON
-
-    # Create list
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.list.create(name: 'List Number 1')
-    #
-    # @param [required, String] :name
-    #   A name for the list
-    #
-    # @param [optional, String] :description
-    #   A description of the list
-    #
-    # @param [optional, Array] :tags
-    #   An Array of up to 10 Strings assigining tags to the list. Each String must be between 1 and 15 characters
-    #
-    # @param [optional, Array] :attributes
-    #   Array of Hash objects. Each Hash represents an attribute for the list.
-    #
-    # @option attributes [required, String] :name
-    #   The name of the attribute
-    #
-    # @option attributes [optional, String] :alias
-    #   Alternative name to use for this attribute.
-    #   Use when you wish to correlate between 2 or more list that are using different attribute names for the same semantic data
-    #
-    # @option attributes [optional, Boolean] :key
-    #   Set to `true` if this attribute should be used to correlate between 2 or more lists. Default is `false`
-    #
-    # @param [optional, Hash] :datasource
-    #   Datasource for the list
-    #
-    # @option datasource [required, String] :type
-    #   Must be set to `manual`, which is the default
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#listsCreate
-    #
-    def create(name:, **params)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v0.1/bulk/lists",
-        params: params.merge({ name: name }),
-        type: Post
-      )
-    end
-
-    # Get list by id
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.list.find(id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
-    #
-    # @param [required, String] :id
-    #   Unique identifier for the list
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#listsGet
-    #
-    def find(id:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request("/v0.1/bulk/lists/#{id}")
-    end
-
-    # Update list
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.list.update(name: 'List Number 1')
-    #
-    # @param [required, String] :id
-    #   The id of the list to update
-    #
-    # @param [required, String] :name
-    #   The name of the list
-    #
-    # @param [optional, String] :description
-    #   A description of the list
-    #
-    # @param [optional, Array] :tags
-    #   An Array of up to 10 Strings assigining tags to the list. Each String must be between 1 and 15 characters
-    #
-    # @param [optional, Array] :attributes
-    #   Array of Hash objects. Each Hash represents an attribute for the list.
-    #
-    # @option attributes [required, String] :name
-    #   The name of the attribute
-    #
-    # @option attributes [optional, String] :alias
-    #   Alternative name to use for this attribute.
-    #   Use when you wish to correlate between 2 or more list that are using different attribute names for the same semantic data
-    #
-    # @option attributes [optional, Boolean] :key
-    #   Set to `true` if this attribute should be used to correlate between 2 or more lists. Default is `false`
-    #
-    # @param [optional, Hash] :datasource
-    #   Datasource for the list
-    #
-    # @option datasource [required, String] :type
-    #   Must be set to `manual`, which is the default
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#listsUpdate
-    #
-    def update(id:, name:, **params)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v0.1/bulk/lists/#{id}",
-        params: params.merge({ name: name }),
-        type: Put
-      )
-    end
-
-    # Delete a list by id
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.list.delete(id: '74ea1ecf-06c9-4072-a285-61677bd353e8')
-    #
-    # @param [required, String] :id
-    #   Unique identifier for the list
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#listsDelete
-    #
-    def delete(id:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v0.1/bulk/lists/#{id}",
-        type: Delete
-      )
-    end
-
-    # Clear list by deleting all items
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.list.clear_items(id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
-    #
-    # @param [required, String] :id
-    #   Unique identifier for the list
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#listsClear
-    #
-    def clear_items(id:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v0.1/bulk/lists/#{id}/clear",
-        type: Post
-      )
-    end
-
-    # Fetch and replace all items from datasource
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.list.fetch_and_replace_items(id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
-    #
-    # @param [required, String] :id
-    #   Unique identifier for the list
-    #
-    # @see https://developer.vonage.com/en/api/proactive-connect#listsFetch
-    #
-    def fetch_and_replace_items(id:)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      request(
-        "/v0.1/bulk/lists/#{id}/fetch",
-        type: Post
-      )
-    end
-  end
-end

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

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

data/lib/vonage/proactive_connect/lists.rb

@@ -1,38 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect::Lists < Namespace
-    extend T::Sig
-
-    self.authentication = BearerToken
-
-    self.host = :vonage_host
-
-    # Find all lists
-    #
-    # @deprecated
-    #
-    # @example
-    #   response = proactive_connect.lists.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#listsFindAll
-    #
-    def list(**params)
-      logger.info('This method is deprecated and will be removed in a future release.')
-      path = "/v0.1/bulk/lists"
-      path += "?#{Params.encode(params)}" unless params.empty?
-
-      request(path, response_class: ListResponse)
-    end
-  end
-end

data/lib/vonage/proactive_connect.rb

@@ -1,43 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect < Namespace
-    extend T::Sig
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Lists)) }
-    def lists
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @lists ||= Lists.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::ProactiveConnect::List)) }
-    def list
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @list ||= List.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Items)) }
-    def items
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @items ||= Items.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Item)) }
-    def item
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @item ||= Item.new(@config)
-    end
-
-    # @deprecated
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Events)) }
-    def events
-      logger.info('This method is deprecated and will be removed in a future release.')
-      @events ||= Events.new(@config)
-    end
-  end
-end

data/lib/vonage/subaccounts/balance_transfers/list_response.rb

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