vonage 7.24.0 → 8.0.0.beta

data/lib/vonage/proactive_connect/list.rb

@@ -1,168 +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
-    #
-    # @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)
-      request(
-        "/v0.1/bulk/lists",
-        params: params.merge({ name: name }),
-        type: Post
-      )
-    end
-
-    # Get list by id
-    #
-    # @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:)
-      request("/v0.1/bulk/lists/#{id}")
-    end
-
-    # Update list
-    #
-    # @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)
-      request(
-        "/v0.1/bulk/lists/#{id}",
-        params: params.merge({ name: name }),
-        type: Put
-      )
-    end
-
-    # Delete a list by id
-    #
-    # @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:)
-      request(
-        "/v0.1/bulk/lists/#{id}",
-        type: Delete
-      )
-    end
-
-    # Clear list by deleting all items
-    #
-    # @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:)
-      request(
-        "/v0.1/bulk/lists/#{id}/clear",
-        type: Post
-      )
-    end
-
-    # Fetch and replace all items from datasource
-    #
-    # @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:)
-      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,35 +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
-    #
-    # @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)
-      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,33 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class ProactiveConnect < Namespace
-    extend T::Sig
-
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Lists)) }
-    def lists
-      @lists ||= Lists.new(@config)
-    end
-
-    sig { returns(T.nilable(Vonage::ProactiveConnect::List)) }
-    def list
-      @list ||= List.new(@config)
-    end
-
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Items)) }
-    def items
-      @items ||= Items.new(@config)
-    end
-
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Item)) }
-    def item
-      @item ||= Item.new(@config)
-    end
-
-    sig { returns(T.nilable(Vonage::ProactiveConnect::Events)) }
-    def events
-      @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

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

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

data/lib/vonage/subaccounts/list_response.rb

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

data/lib/vonage/subaccounts.rb

@@ -1,203 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Vonage
-  class Subaccounts < Namespace
-    self.authentication = Basic
-
-    self.request_body = JSON
-
-    # Retrieve list of subaccounts.
-    #
-    # @example
-    #   response = client.subaccounts.list
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#retrieveSubaccountsList
-    #
-    def list
-      request("/accounts/#{@config.api_key}/subaccounts", response_class: ListResponse)
-    end
-
-    # Retrieve a subaccount.
-    #
-    # @example
-    #   response = client.subaccounts.find(subaccount_key: 'abc123')
-    #
-    # @option params [required, String] :subaccount_key
-    #   The API key for the subaccount you want to retrieve
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#retrieveSubaccount
-    #
-    def find(subaccount_key:)
-      request("/accounts/#{@config.api_key}/subaccounts/#{subaccount_key}")
-    end
-
-    # Create a subaccount.
-    #
-    # @example
-    #   response = client.subaccounts.create(name: 'Foo')
-    #
-    # @option params [required, String] :name
-    #   The name of the subaccount
-    #
-    # @option params [optional, String] :secret
-    #   An account secret for use by the subaccount. Can be used in combination with your API key to authenticate your API requests.
-    #   Requirements:
-    #     - 8 characters and no more than 25
-    #     - 1 lower-case letter
-    #     - 1 capital letter
-    #     - 1 digit
-    #     - must be unique
-    #
-    # @option params [optional, Boolean] :use_primary_account_balance
-    #   Whether the subaccount uses the primary account balance (true, the default) or has its own balance (false).
-    #   Once set to `false` cannot be changed back to `true`
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#createSubAccount
-    #
-    def create(name:, **params)
-      request("/accounts/#{@config.api_key}/subaccounts", params: params.merge(name: name), type: Post)
-    end
-
-    # Modify a subaccount.
-    #
-    # @example
-    #   response = client.subaccounts.update(name: 'Bar')
-    #
-    # @option params [required, String] :subaccount_key
-    #   The API key for the subaccount you want to modify
-    #
-    # @option params [optional, String] :name
-    #   The name of the subaccount
-    #
-    # @option params [optional, Boolean] :use_primary_account_balance
-    #   Whether the subaccount uses the primary account balance (true, the default) or has its own balance (false).
-    #   Once set to `false` cannot be changed back to `true`
-    #
-    # @option params [optional, String] :suspended
-    #   Whether the subaccount is suspended (true) or not (false, the default)
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#modifySubaccount
-    #
-    def update(subaccount_key:, **params)
-      request("/accounts/#{@config.api_key}/subaccounts/#{subaccount_key}", params: params, type: Patch)
-    end
-
-    # Retrieve list of credit transfers.
-    #
-    # @example
-    #   response = client.subaccounts.list_credit_transfers(start_date: "2023-06-15T15:53:50Z")
-    #
-    # @option params [optional, String] :start_date
-    #   The ISO format datetime from which to list transfers. Example: 2019-03-02T16:34:49Z.
-    #   Defaults to "1970-01-01T00:00:00Z" if omitted
-    #
-    # @option params [optional, String] :end_date
-    #   The ISO format datetime to which to list transfers. Example: 2019-03-02T16:34:49Z.
-    #   If absent then all transfers until now is returned.
-    #
-    # @option params [optional, String] :subaccount
-    #   Subaccount to filter by.
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#retrieveCreditTransfers
-    #
-    def list_credit_transfers(start_date: "1970-01-01T00:00:00Z", **params)
-      path = "/accounts/#{@config.api_key}/credit-transfers?#{Params.encode(params.merge(start_date: start_date))}"
-
-      request(path, response_class: CreditTransfers::ListResponse)
-    end
-
-    # Transfer credit.
-    #
-    # @example
-    #   response = client.subaccounts.transfer_credit(from: 'abc123', to: 'def456', amount: 10.00)
-    #
-    # @option params [required, String] :from
-    #   The API key of the account or subaccount to transfer credit from.
-    #
-    # @option params [required, String] :to
-    #   The API key of the account or subaccount to transfer credit to.
-    #
-    # @option params [required, Number] :amount
-    #   The amount to transfer
-    #
-    # @option params [optional, String] :reference
-    #   A reference for the transfer.
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#transferCredit
-    #
-    def transfer_credit(from:, to:, amount:, **params)
-      request("/accounts/#{@config.api_key}/credit-transfers", params: params.merge(from: from, to: to, amount: amount), type: Post)
-    end
-
-    # Retrieve list of balance transfers.
-    #
-    # @example
-    #   response = client.subaccounts.list_balance_transfers(start_date: "2023-06-15T15:53:50Z")
-    #
-    # @option params [optional, String] :start_date
-    #   The ISO format datetime from which to list transfers. Example: 2019-03-02T16:34:49Z.
-    #   Defaults to "1970-01-01T00:00:00Z" if omitted
-    #
-    # @option params [optional, String] :end_date
-    #   The ISO format datetime to which to list transfers. Example: 2019-03-02T16:34:49Z.
-    #   If absent then all transfers until now is returned.
-    #
-    # @option params [optional, String] :subaccount
-    #   Subaccount to filter by.
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#retrieveBalanceTransfers
-    #
-    def list_balance_transfers(start_date: "1970-01-01T00:00:00Z", **params)
-      path = "/accounts/#{@config.api_key}/balance-transfers?#{Params.encode(params.merge(start_date: start_date))}"
-
-      request(path, response_class: BalanceTransfers::ListResponse)
-    end
-
-    # Transfer balance.
-    #
-    # @example
-    #   response = client.subaccounts.transfer_balance(from: 'abc123', to: 'def456', amount: 10.00)
-    #
-    # @option params [required, String] :from
-    #   The API key of the account or subaccount to transfer balance from.
-    #
-    # @option params [required, String] :to
-    #   The API key of the account or subaccount to transfer balance to.
-    #
-    # @option params [required, Number] :amount
-    #   The amount to transfer
-    #
-    # @option params [optional, String] :reference
-    #   A reference for the transfer.
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#transferBalance
-    #
-    def transfer_balance(from:, to:, amount:, **params)
-      request("/accounts/#{@config.api_key}/balance-transfers", params: params.merge(from: from, to: to, amount: amount), type: Post)
-    end
-
-    # Transfer number.
-    #
-    # @example
-    #   response = client.subaccounts.transfer_number(from: 'abc123', to: 'def456', number: 447900000000, country: 'GB')
-    #
-    # @option params [required, String] :from
-    #   The API key of the account or subaccount to transfer the number from.
-    #
-    # @option params [required, String] :to
-    #   The API key of the account or subaccount to transfer the number to.
-    #
-    # @option params [required, Number] :number
-    #   The number to transfer
-    #
-    # @option params [required, String] :country
-    #   An ISO-3166-1 alpha 2 code representing the country for the number, e.g. GB.
-    #
-    # @see https://developer.vonage.com/en/api/subaccounts#transferNumber
-    #
-    def transfer_number(from:, to:, number:, country:)
-      request("/accounts/#{@config.api_key}/transfer-number", params: {from: from, to: to, number: number, country: country}, type: Post)
-    end
-  end
-end

data/lib/vonage/users/list_response.rb

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

data/lib/vonage/users.rb

@@ -1,156 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Vonage
-  class Users < Namespace
-    extend T::Sig
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    # Get a list of Users associated with the Vonage Application.
-    #
-    # @param [optional, Integer] :page_size
-    #   Specifies the number of records to be returned in the response.
-    #
-    # @param [optional, String] :order
-    #   Specifies the order in which the records should be returned.
-    #   Must be one of `asc`, `ASC`, `desc`, or `DESC`
-    #
-    # @param [optional, String] :cursor
-    #   Specficy a cursor point from which to start returning results, for example the values of the `next` or `prev`
-    #   `_links` contained in a response.
-    #
-    # @param [optional, String] :name
-    #   Specify a user name with which to filter results
-    #
-    # @return [ListResponse]
-    #
-    # @see https://developer.vonage.com/en/api/application.v2#getUsers
-    #
-    def list(**params)
-      request('/v1/users', params: params, response_class: ListResponse)
-    end
-
-    # Get a specified User associated with the Vonage Application.
-    #
-    # @param [required, String] :id
-    #   The unique ID or name for the user.
-    #
-    # @return [Vonage::Response]
-    #
-    # @see https://developer.vonage.com/en/api/application.v2#getUser
-    #
-    def find(id:)
-      request("/v1/users/#{id}")
-    end
-
-    # Create a new User associated with the Vonage Application.
-    #
-    # @param [optional, String] :name
-    #   A unique name for the user. If not provided, a name will be auto-generated.
-    #
-    # @param [optional, String] :display_name
-    #   A string to be displayed as user name. It does not need to be unique.
-    #
-    # @param [optional, String] :image_url
-    #   A publicly accessible URL to an image file for an image to be associated with the user.
-    #
-    # @param [optional, Hash] :properties A hash defining properties for the User.
-    #   @option properties [Hash] :custom_data A hash of custom data as key/value pairs.
-    #
-    # @param [optional, Hash] :channels A hash defining details of various channels.
-    #   @option channels [Array] :pstn An array containing a Hash which defines data for the pstn channel.
-    #     @option pstn [Integer] :number The pstn number.
-    #   @option channels [Array] :sip An array containing a Hash which defines data for the sip channel.
-    #     @option sip [String] :uri The sip uri.
-    #     @option sip [String] :username The sip username.
-    #     @option sip [String] :password The sip password.
-    #   @option channels [Array] :vbc An array containing a Hash which defines data for the vbc channel.
-    #     @option vbc [String] :extension The vbc extension.
-    #   @option channels [Array] :websocket An array containing a Hash which defines data for the websocket channel.
-    #     @option websocket [String] :uri The websocket uri.
-    #     @option websocket [String] :content-type The websocket audio type. Must be one of: `audio/l16;rate=8000`, `audio/l16;rate=16000`.
-    #     @option websocket [Hash] :headers A hash of custom websocket headers provided as key/value pairs.
-    #   @option channels [Array] :sms An array containing a Hash which defines data for the sms channel.
-    #     @option sms [Integer] :number The sms number.
-    #   @option channels [Array] :mms An array containing a Hash which defines data for the mms channel.
-    #     @option mms [Integer] :number The mms number.
-    #   @option channels [Array] :whatsapp An array containing a Hash which defines data for the whatsapp channel.
-    #     @option whatsapp [Integer] :number The whatsapp number.
-    #   @option channels [Array] :viber An array containing a Hash which defines data for the sms channel.
-    #     @option viber [Integer] :number The viber number.
-    #   @option channels [Array] :messenger An array containing a Hash which defines data for the messenger channel.
-    #     @option messenger [Integer] :id The messenger id.
-    #
-    # @return [Vonage::Response]
-    #
-    # @see https://developer.vonage.com/en/api/application.v2#createUser
-    #
-    def create(**params)
-      request('/v1/users', params: params, type: Post)
-    end
-
-    # Update an existing User associated with the Vonage Application.
-    #
-    # @param [required, String] :id
-    #   The unique ID or name for the user to be updated.
-    #
-    # @param [optional, String] :name
-    #   A unique name for the user.
-    #
-    # @param [optional, String] :display_name
-    #   A string to be displayed as user name. It does not need to be unique.
-    #
-    # @param [optional, String] :image_url
-    #   A publicly accessible URL to an image file for an image to be associated with the user.
-    #
-    # @param [optional, Hash] :properties A hash defining properties for the User.
-    #   @option properties [Hash] :custom_data A hash of custom data as key/value pairs.
-    #
-    # @param [optional, Hash] :channels A hash defining details of various channels.
-    #   @option channels [Array] :pstn An array containing a Hash which defines data for the pstn channel.
-    #     @option pstn [Integer] :number The pstn number.
-    #   @option channels [Array] :sip An array containing a Hash which defines data for the sip channel.
-    #     @option sip [String] :uri The sip uri.
-    #     @option sip [String] :username The sip username.
-    #     @option sip [String] :password The sip password.
-    #   @option channels [Array] :vbc An array containing a Hash which defines data for the vbc channel.
-    #     @option vbc [String] :extension The vbc extension.
-    #   @option channels [Array] :websocket An array containing a Hash which defines data for the websocket channel.
-    #     @option websocket [String] :uri The websocket uri.
-    #     @option websocket [String] :content-type The websocket audio type. Must be one of: `audio/l16;rate=8000`, `audio/l16;rate=16000`.
-    #     @option websocket [Hash] :headers A hash of custom websocket headers provided as key/value pairs.
-    #   @option channels [Array] :sms An array containing a Hash which defines data for the sms channel.
-    #     @option sms [Integer] :number The sms number.
-    #   @option channels [Array] :mms An array containing a Hash which defines data for the mms channel.
-    #     @option mms [Integer] :number The mms number.
-    #   @option channels [Array] :whatsapp An array containing a Hash which defines data for the whatsapp channel.
-    #     @option whatsapp [Integer] :number The whatsapp number.
-    #   @option channels [Array] :viber An array containing a Hash which defines data for the sms channel.
-    #     @option viber [Integer] :number The viber number.
-    #   @option channels [Array] :messenger An array containing a Hash which defines data for the messenger channel.
-    #     @option messenger [Integer] :id The messenger id.
-    #
-    # @return [Vonage::Response]
-    #
-    # @see https://developer.vonage.com/en/api/application.v2#createUser
-    #
-    def update(id:, **params)
-      request("/v1/users/#{id}", params: params, type: Patch)
-    end
-
-    # Delete a specified User associated with the Vonage Application.
-    #
-    # @param [required, String] :id
-    #   The unique ID or name for the user.
-    #
-    # @return [Vonage::Response]
-    #
-    # @see https://developer.vonage.com/en/api/application.v2#deleteUser
-    #
-    def delete(id:)
-      request("/v1/users/#{id}", type: Delete)
-    end
-  end
-end