vonage 7.21.0 → 7.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8839127b442d9de3ee98bfc35f38bf76c967389bcf02136a28c8232f497f94bb
-  data.tar.gz: c52b8d863d3326153f6678a9234457eb945b155f6fdfa2b782e45abbc4c5d16b
+  metadata.gz: 508c457f8278aae1d8cc3951a8b4c38423ab63307917c4bbc09960f45cbafa9f
+  data.tar.gz: '00329df94f3ab44d6ab8d2552931438358f92ad59c121db87e1668bd1c336814'
 SHA512:
-  metadata.gz: bf2d3ae171d5278f8c8d9c68129e3ba70b1edce0d16fb414bf0ecae7995c27620fbaca284f40c121dc128e6388f1485fa4bfa069f52e38b029d2f76397a73b0e
-  data.tar.gz: 49897746fc8dc49fd67b01e3366215cc6298a59f771c1544b0004d2dcdac07c5d4b2263f383ac6c17e9d9bf7ca483bb4922bcc4ebdcdb0167a4823ac4387f627
+  metadata.gz: 80d9743779edc4dca5c4c9babb6a8591d616e4ac2f393ca4932a5a8640574561b28c61c803dc7c397c99221f0a086bd4604f62e8b36b97c7fd2b7da85ddc88d0
+  data.tar.gz: 40756daa0add532dead58f6d7d057e5bfc8f5d39a9bd84515bcdc08f9a6686eb983b6859f45b71fde9e11b8f474dbecb8a2973ff7270fe8256d813e281783341

data/README.md

@@ -525,6 +525,7 @@ The following is a list of Vonage APIs for which the Ruby SDK currently provides
 
 * [Account API](https://developer.vonage.com/en/account/overview)
 * [Application API](https://developer.vonage.com/en/application/overview)
+* [Conversation API](https://developer.vonage.com/en/conversation/overview)
 * [Meetings API](https://developer.vonage.com/en/meetings/overview)
 * [Messages API](https://developer.vonage.com/en/messages/overview)
 * [Number Insight API](https://developer.vonage.com/en/number-insight/overview)

data/lib/vonage/client.rb

@@ -40,8 +40,17 @@ module Vonage
       @applications ||= T.let(Applications.new(config), T.nilable(Vonage::Applications))
     end
 
+    # @return [Conversation]
+    #
+    sig { returns(T.nilable(Vonage::Conversation)) }
+    def conversation
+      @conversation ||= T.let(Conversation.new(config), T.nilable(Vonage::Conversation))
+    end
+
     # @return [Conversations]
     #
+    # @deprecated Please use {#conversation} instead
+    #
     sig { returns(T.nilable(Vonage::Conversations)) }
     def conversations
       @conversations ||= T.let(Conversations.new(config), T.nilable(Vonage::Conversations))

data/lib/vonage/conversation/event/list_response.rb

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

data/lib/vonage/conversation/event.rb

@@ -0,0 +1,108 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Conversation::Event < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # List conversation events
+    #
+    # @example
+    #   response = client.conversation.event.list(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation to list events for
+    #
+    # @param [String] :start_id
+    #   The ID to start returning events at
+    #
+    # @param [String] :end_id
+    #   The ID to end returning events at
+    #
+    # @param [String] :event_type
+    #  The type of event to search for. Does not currently support custom events
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #
+    # @return [Conversation::Member::ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getEvents
+    #
+    def list(conversation_id:, **params)  
+      request("/v1/conversations/#{conversation_id}/events", params: params, response_class: ListResponse)
+    end
+
+    # Create an event
+    # @example
+    #   response = client.conversation.event.create(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     type: 'message',
+    #     body: {
+    #       message_type: 'text',
+    #       text: 'Hello World'
+    #     }
+    #   )  
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation to create the event for
+    #
+    # @param [required, String] :type
+    #   Event type.
+    #
+    # @param [String] :from
+    #
+    # @option params [required, String] :from
+    #
+    # @param [Hash] :body
+    #   The body of the event. There are many possible properties depending on the event type and message_type
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#createEvent
+    #
+    def create(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}/events", params: params, type: Post)
+    end
+
+    # Get details of a specific event
+    #
+    # @example
+    #   response = client.conversation.event.find(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a', event_id: 1) 
+    #
+    # @param [required, String] :conversation_id
+    #
+    # @param [required, String] :event_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getEvent
+    #
+    def find(conversation_id:, event_id:)
+      request("/v1/conversations/#{conversation_id}/events/#{event_id}")
+    end
+
+    # Delete an event.
+    #
+    # @example
+    #   response = client.conversation.event.delete(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a', event_id: 1)
+    #
+    # @param [String] :conversation_id
+    #
+    # @param [String] :event_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#deleteEvent
+    #
+    def delete(conversation_id:, event_id:)
+      request("/v1/conversations/#{conversation_id}/events/#{event_id}", type: Delete)
+    end
+  end
+end

data/lib/vonage/conversation/list_response.rb

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

data/lib/vonage/conversation/member/list_response.rb

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

data/lib/vonage/conversation/member.rb

@@ -0,0 +1,134 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Conversation::Member < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # List members of a conversation
+    #
+    # @example
+    #   response = client.conversation.member.list(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation to list members for
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #
+    # @return [Conversation::Member::ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getMembers
+    #
+    def list(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}/members", params: params, response_class: ListResponse)
+    end
+
+    # Create a member.
+    #
+    # @example
+    #   response = client.conversation.member.create(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     user: {
+    #       id: 'USR-82e028d9-5201-4f1e-8188-604b2d3471ec'
+    #     }
+    #   )
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation for which to create the member
+    #
+    # @param [String] :state Must be one of ['invited', 'joined']
+    #
+    # @param [Hash] :user (Either :id or :name is required)
+    #   - @option user [String] :id The user_id of the user to add to the conversation
+    #   - @option user [String] :name The name of the user to add to the conversation
+    #
+    # @param [Hash] :channel
+    #   - @option channel [required, String] :type The type of channel
+    #   - @option channel [Hash] :from
+    #     - @option from [String] :type
+    #     - @option from [String] :number
+    #     - @option from [String] :id
+    #   - @option channel [Hash] :to
+    #     - @option from [String] :type 
+    #     - @option from [String] :user
+    #     - @option from [String] :number
+    #     - @option from [String] :id
+    #
+    # @param [Hash] :media
+    #   - @option media [Boolean] :audio
+    #   - @option media [Hash] :audio_settings
+    #     - @option audio_settings [Boolean] :enabled
+    #     - @option audio_settings [Boolean] :earmuffed
+    #     - @option audio_settings [Boolean] :muted
+    #
+    # @param [String] :knocking_id
+    #
+    # @param [String] :member_id_inviting
+    #
+    # @param [String] :from
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#createMember
+    #
+    def create(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}/members", params: params, type: Post)
+    end
+
+    # Retrieve a member
+    #
+    # @example
+    #   response = client.conversation.member.find(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     member_id: 'MEM-63f61863-4a51-4f6b-86e1-46edebio0391'
+    #   )  
+    #
+    # @param [required, String] :conversation_id
+    #
+    # @param [required, String] :member_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getMember
+    #
+    def find(conversation_id:, member_id:)   
+      request("/v1/conversations/#{conversation_id}/members/#{member_id}", response_class: Vonage::Response)
+    end
+
+    # Update a member
+    #
+    # @example
+    #   response = client.conversation.member.update(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     member_id: 'MEM-63f61863-4a51-4f6b-86e1-46edebio0391',
+    #     state: 'left'
+    #   )  
+    #
+    # @param [required, String] :conversation_id
+    #
+    # @param [required, String] :member_id
+    #
+    # @param [String] :state Must be one of ['joined', 'left']
+    #
+    # @param [String] :from
+    #
+    # @param [Hash] :reason
+    #  - @option reason [String] :code
+    #  - @option reason [String] :text
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#updateMember
+    #
+    def update(conversation_id:, member_id:, **params)
+      request("/v1/conversations/#{conversation_id}/members/#{member_id}", params: params, type: Patch)
+    end
+  end
+end

data/lib/vonage/conversation/user/conversations_list_response.rb

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

data/lib/vonage/conversation/user/sessions_list_response.rb

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

data/lib/vonage/conversation/user.rb

@@ -0,0 +1,67 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Conversation::User < Namespace
+    self.authentication = BearerToken
+
+    # List conversations associated with a user.
+    #
+    # @example
+    #   response = client.conversation.user.list_conversations(user_id: 'USR-82e028d9-5201-4f1e-8188-604b2d3471ec')
+    #
+    # @param [required, String] :user_id The user_id of the user to list conversations for
+    #
+    # @param [String] :state Must be one of ['INVITED', 'JOINED', 'LEFT']
+    #
+    # @param [String] :order_by Must be one of ['created', 'custom_sort_key']
+    #
+    # @param [Boolean] :include_custom_data
+    # @param [String] :date_start
+    #   Return the records that occurred after this point in time.
+    #
+    # @param [String] :date_start
+    #   Return the records that occurred after this point in time.
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #
+    # @return [Conversation::User::ConversationsListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getuserConversations
+    #
+    def list_conversations(user_id:, **params)
+      request("/v1/users/#{user_id}/conversations", params: params, response_class: ConversationsListResponse)
+    end
+
+    # List conversations associated with a user.
+    #
+    # @example
+    #   response = client.conversation.user.list_sessions(user_id: 'USR-82e028d9-5201-4f1e-8188-604b2d3471ec')
+    #
+    # @param [required, String] :user_id The user_id of the user to list sessions for
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #
+    # @return [Conversation::User::SessionsListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getuserSessions
+    #
+    def list_sessions(user_id:, **params)
+      request("/v1/users/#{user_id}/sessions", params: params, response_class: SessionsListResponse)
+    end
+  end
+end

data/lib/vonage/conversation.rb

@@ -0,0 +1,164 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Conversation < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # List conversations associated with a Vonage application.
+    #
+    # @example
+    #   response = client.conversation.list
+    #
+    # @param [String] :date_start
+    #   Return the records that occurred after this point in time.
+    #
+    # @param [String] :date_end
+    #   Return the records that occurred before this point in time.
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #  
+    # @return [Conversation::ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#listConversations
+    #
+    def list(**params)
+      request('/v1/conversations', params: params, response_class: ListResponse)
+    end
+
+    # Create a conversation.
+    #
+    # @example
+    #   response = client.conversation.create(name: 'Example Conversation', display_name: 'Example Display Name')
+    #
+    # @param [String] :name
+    #   Your internal conversation name. Must be unique.
+    #
+    # @param [String] :display_name
+    #   The public facing name of the conversation.
+    #
+    # @param [String] :image_url
+    #   An image URL that you associate with the conversation
+    #
+    # @param [Hash] :properties
+    #   - :ttl (Integer) After how many seconds an empty conversation is deleted
+    #   - :type (String)
+    #   - :custom_sort_key (String)
+    #   - :custom_data (Hash) Custom key/value pairs to be included with conversation data
+    #
+    # @option params [Array] :numbers An array of Hashes containing number information for different channels.
+    #
+    # @option params [Hash] :callback
+    #   - @option callback :url (String)
+    #   - @option callback :event_mask (String)
+    #   - @option callback :params (Hash)
+    #     - @option params :applicationId (String)
+    #     - @option params :ncco_url (String)
+    #   - @option callback :method (String) Must be one of ['POST', 'GET']
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#createConversation
+    #
+    def create(**params)
+      request('/v1/conversations', params: params, type: Post)
+    end
+
+    # Retrieve a conversation.
+    #
+    # @example
+    #   response = client.conversation.find(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
+    #
+    # @param [String] :conversation_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#retrieveConversation
+    #
+    def find(conversation_id:)
+      request("/v1/conversations/#{conversation_id}")
+    end
+
+    # Update a conversation.
+    #
+    # @example
+    #   response = client.conversation.update(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a', display_name: 'Updated conversation')
+    #
+    # @param [String] :name
+    #   Your internal conversation name. Must be unique.
+    #
+    # @param [String] :display_name
+    #   The public facing name of the conversation.
+    #
+    # @param [String] :image_url
+    #   An image URL that you associate with the conversation
+    #
+    # @param [Hash] :properties
+    #   - @option properties :ttl (Integer) After how many seconds an empty conversation is deleted
+    #   - @option properties :type (String)
+    #   - @option properties :custom_sort_key (String)
+    #   - @option properties :custom_data (Hash) Custom key/value pairs to be included with conversation data
+    #
+    # @param [Array] :numbers An array of Hashes containing number information for different channels.
+    #
+    # @option params [Hash] :callback
+    #   - @option callback :url (String)
+    #   - @option callback :event_mask (String)
+    #   - @option callback :params (Hash)
+    #     - @option params :applicationId (String)
+    #     - @option params :ncco_url (String)
+    #   - @option callback :method (String) Must be one of ['POST', 'GET']
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#replaceConversation
+    #
+    def update(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}", params: params, type: Put)
+    end
+
+    # Delete a conversation.
+    #
+    # @example
+    #   response = client.conversation.delete(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
+    #
+    # @param [String] :conversation_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#deleteConversation
+    #
+    def delete(conversation_id:)
+      request("/v1/conversations/#{conversation_id}", type: Delete)
+    end
+
+    # @return [Conversation::User]
+    sig { returns(T.nilable(Vonage::Conversation::User)) }
+    def user
+      @user ||= User.new(@config)
+    end
+
+    # @return [Conversation::Member]
+    sig { returns(T.nilable(Vonage::Conversation::Member)) }
+    def member
+      @member ||= Member.new(@config)
+    end
+
+    # @return [Conversation::Event]
+    sig { returns(T.nilable(Vonage::Conversation::Event)) }
+    def event
+      @event ||= Event.new(@config)
+    end
+  end
+end

data/lib/vonage/conversations/events.rb

@@ -9,6 +9,8 @@ module Vonage
 
     # Create an event.
     #
+    # @deprecated Please use {Vonage::Conversation::Event#create} instead
+    #
     # @option params [required, String] :type
     #   Event type.
     #
@@ -29,11 +31,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#createEvent
     #
     def create(conversation_id, params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#create` instead.')
       request('/beta/conversations/' + conversation_id + '/events', params: params, type: Post)
     end
 
     # List events.
     #
+    # @deprecated Please use {Vonage::Conversation::Event#list} instead
+    #
     # @param [String] conversation_id
     #
     # @option params [Boolean] :auto_advance
@@ -45,11 +50,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#getEvents
     #
     def list(conversation_id, params = nil, auto_advance = true)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#list` instead.')
       request('/beta/conversations/' + conversation_id + '/events', params: params)
     end
 
     # Retrieve an event.
     #
+    # @deprecated Please use {Vonage::Conversation::Event#find} instead
+    #
     # @param [String] conversation_id
     # @param [String] event_id
     #
@@ -58,11 +66,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#getEvent
     #
     def get(conversation_id, event_id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#find` instead.')
       request('/beta/conversations/' + conversation_id + '/events/' + event_id.to_s)
     end
 
     # Delete an event.
     #
+    # @deprecated Please use {Vonage::Conversation::Event#delete} instead
+    #
     # @param [String] conversation_id
     # @param [String] event_id
     #
@@ -71,6 +82,7 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#deleteEvent
     #
     def delete(conversation_id, event_id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#delete` instead.')
       request('/beta/conversations/' + conversation_id + '/events/' + event_id.to_s, type: Delete)
     end
   end

data/lib/vonage/conversations/legs.rb

@@ -7,6 +7,8 @@ module Vonage
 
     # List legs.
     #
+    # @deprecated
+    #
     # @option params [Boolean] :auto_advance
     #   Set this to `false` to not auto-advance through all the pages in the record
     #   and collect all the data. The default is `true`.     
@@ -16,11 +18,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#listLegs
     #
     def list(params = nil, auto_advance = true)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request('/beta/legs', params: params)
     end
 
     # Delete a leg.
     #
+    # @deprecated
+    #
     # @param [String] leg_id
     #
     # @return [Response]
@@ -28,6 +33,7 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#deleteLeg
     #
     def delete(leg_id)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request('/beta/legs/' + leg_id, type: Delete)
     end
   end