vonage 7.14.0 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6681bf0608f283c8404c19838cae08679bed799b0d793622ba6863fbafddb2e
-  data.tar.gz: 7c60d5f1ae1207a1404f705ce20b38cfe3ccbc5f549151f8367f346bb823b9e8
+  metadata.gz: fe42d262916665b0528b89b25fc9094ff4009739cea53ec28a416afe2ec232c8
+  data.tar.gz: d1bb14fcc3e8c862dedd87a32b80034d9914c0cafcc2c53f071b05a9c640a644
 SHA512:
-  metadata.gz: 5c6ac59f07a9a94979ceca1e170bec5e67a0706b66d6b45cffe027505bf0280f3bad83041e6b09e1fec70afafb3edc47ea4f40a01894d9927ee7c19cae023247
-  data.tar.gz: fbe93fa8fe2dd36b3ea498a5b48ad61ff9cfd6494435b1c3120cd47e3a0d9b1c3feffe2c847e619c716cbcb37688073bf5834cde1caf13b79c530d72661addf7
+  metadata.gz: a52f19d149c83ff7cbc2fe73982abaf79901c146fa45d006d19ba9f32b9640bf14065e132362aae591869339109deeafa68e72349a1e6d9f2a6fba173efbf9a6
+  data.tar.gz: 38f8d3a78930e5b13e8ed71e3bce0ee37789a506f053e9f31c543bdac10760f574dc976fca097f64f47419f9d99c4b912ce32484b389243b96c52f5fa6e7ef4c

data/lib/vonage/client.rb

@@ -145,6 +145,13 @@ module Vonage
       @tfa ||= T.let(TFA.new(config), T.nilable(Vonage::TFA))
     end
 
+    # @return [Users]
+    #
+    sig { returns(T.nilable(Vonage::Users)) }
+    def users
+      @users ||= T.let(Users.new(config), T.nilable(Vonage::Users))
+    end
+
     # @return [Verify]
     #
     sig { returns(T.nilable(Vonage::Verify)) }

data/lib/vonage/users/list_response.rb

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,156 @@
+# 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

data/lib/vonage/verify2.rb

@@ -28,7 +28,7 @@ module Vonage
     #   @option opts [String] :client_ref Reference to be included in callbacks
     #   @option opts [Boolean] If used, must be set to `false`. Will bypass a network block for a single Verify V2 request
     #
-    # @return Vomage::Response
+    # @return Vonage::Response
     # @see https://developer.vonage.com/en/api/verify.v2#newRequest
     #
     def start_verification(brand:, workflow:, **opts)

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = "7.14.0"
+  VERSION = "7.15.0"
 end

data/vonage.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary = 'This is the Ruby Server SDK for Vonage APIs. To use it you\'ll need a Vonage account. Sign up for free at https://www.vonage.com'
   s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md vonage.gemspec)
   s.required_ruby_version = '>= 2.5.0'
-  s.add_dependency('vonage-jwt', '~> 0.1.0')
+  s.add_dependency('vonage-jwt', '~> 0.1.3')
   s.add_dependency('zeitwerk', '~> 2', '>= 2.2')
   s.add_dependency('sorbet-runtime', '~> 0.5')
   s.add_dependency('multipart-post', '~> 2.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.14.0
+  version: 7.15.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,8 @@ files:
 - lib/vonage/subaccounts/list_response.rb
 - lib/vonage/tfa.rb
 - lib/vonage/user_agent.rb
+- lib/vonage/users.rb
+- lib/vonage/users/list_response.rb
 - lib/vonage/verify.rb
 - lib/vonage/verify2.rb
 - lib/vonage/verify2/channels/email.rb