plivo 0.3.19 → 4.20.0

data/examples/multi_party_call.rb

@@ -0,0 +1,295 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+client = Phlo.new(AUTH_ID, AUTH_TOKEN)
+
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = Phlo.new
+
+# provide the phlo_id in params
+phlo = client.phlo.get('phlo_id')
+
+# provide multi_party_call node id in params:
+begin
+  multi_party_call = phlo.multi_party_call('node_id')
+  puts multi_party_call
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+#------------------------------------------------------------------------
+
+# 1. Agent makes outbound call to customer:
+#
+# 'trigger_source' => Caller Id to be set when an outbound call is made to the users to be added to the multi-party call
+# 'to' => 'phone number/SIP endpoint to which an outbound call should be initiated'
+# 'role' => 'customer'/'agent'/'supervisor'
+# multi_party_call.call(<trigger_source>, <to>, <role>)
+
+begin
+  response = multi_party_call.call('9999999999', '0000000000', 'customer')
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 2. Agent initiates warm transfer:
+#
+# 'trigger_source' => number of the agent initiating warm transfer
+# 'to' => number of another agent to be added to the multi-party call
+#
+# multi_party_call.warm_transfer(<trigger_source>, <to>)
+
+begin
+  response = multi_party_call.warm_transfer('9999999999', '0000000000')
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 3. Agent initiates cold transfer:
+#
+# 'trigger_source' => number of the agent initiating cold transfer
+# 'to' => number of another agent to be added to the multi-party call
+#
+# multi_party_call.cold_transfer(<trigger_source>, <to>)
+
+begin
+  response = multi_party_call.cold_transfer('9999999999', '0000000000')
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 4. Agent abort transfer:
+#
+# agent_address => number of the agent
+#
+# multi_party_call.member(<agent_address>).abort_transfer
+
+
+begin
+  response = multi_party_call.member('0000000000').abort_transfer
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '0000000000',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 5. Agent places customer on hold:
+#
+# member_address => phone number of the member who is being put on hold
+#
+# multi_party_call.member(<member_address>).hold
+
+begin
+  response = multi_party_call.member('9999999999').hold
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 6. Resume call after hold:
+#
+# member_address => phone number of the member
+#
+# multi_party_call.member(<member_address>).unhold
+
+begin
+  response = multi_party_call.member('9999999999').unhold
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 7. Agent initiates voicemail drop:
+#
+# member_address => customer's number/endpoint
+#
+# multi_party_call.member(<member_address>).voicemail_drop
+
+begin
+  response = multi_party_call.member('9999999999').voicemail_drop
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 8. Rejoin call on warm transfer:
+#
+# agent_address => number of the agent to be added to the original conference on completion of call between agents
+#
+# multi_party_call.member(<agent_address>).resume_call
+
+begin
+  response = multi_party_call.member('0000000000').resume_call
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 9. Agent leaves of the call [HANGUP]:
+#
+# agent_address => phone number of the agent
+#
+# multi_party_call.member(<agent_address>).hangup
+
+begin
+  response = multi_party_call.member('0000000000').hangup
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 10. Customer is removed from the conference call [HANGUP]:
+#
+# customer_address => phone number of the customer
+#
+# multi_party_call.member(<customer_address>).hangup
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 11. Remove a member from the multi-party call:
+#
+# member_address => phone number of the member
+#
+# multi_party_call.member(<member_address>).remove
+
+begin
+  response = multi_party_call.member('9999999999').remove
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "id": "9999999999"
+# }

data/examples/phlos.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+client = Phlo.new(AUTH_ID, AUTH_TOKEN)
+
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = Phlo.new
+#
+
+# provide the phlo_id in params
+begin
+  phlo = client.phlo.get('phlo_id')
+  puts phlo
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Sample Response:
+# {
+#   "api_id": '36989807-a76f-4555-84d1-9dfdccca7a80',
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "name": 'assignment_mpc',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# initiate phlo via API request:
+begin
+  #optional parameter - params
+  params = {
+     from: '9999999999',
+     to: '0000000000'
+  }
+  response = phlo.run(params)
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Sample Response:
+# {
+#     :api_id=>"ff25223a-1c9f-11e4-80aa-12313f048015",
+#     :phlo_id=>"ff25223a-1c9f-11e4-80aa-12313f048015",
+#     :name=>"assignment_mpc",
+#     :created_on=>"2018-11-03 19:32:33.210714+00:00",
+#     :phlo_run_id=>"ff25223a-1c9f-11e4-80aa-12313f048015"
+# }

data/examples/regulatory_compliance.rb

@@ -0,0 +1,167 @@
+require "rubygems"
+require "plivo"
+
+include Plivo
+include Plivo::Exceptions
+
+AUTH_ID = ""
+AUTH_TOKEN = ""
+
+client = RestClient.new(AUTH_ID, AUTH_TOKEN)
+
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = RestClient.new
+
+# 1. EndUSers
+begin
+  resp = client.end_users.create('Sample First Name',
+   'Sample last name',
+   'individual')
+  puts resp
+rescue PlivoRESTError => e
+  puts "Exception: " + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "end_user_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Sample First Name",
+#   "last_name": 'Sample last name',
+#   "end_user_type": 'individual',
+#   "created_on": '2021-02-08T05:28:49.238152984Z',
+#   "message": "created"
+# }
+
+# 2. Compliance Document Type
+begin
+    resp = client.compliance_document_types.get('6264e9ee-5826-4f9a-80ce-00b00f7a6c0c')
+    puts resp
+  rescue PlivoRESTError => e
+    puts "Exception: " + e.message
+  end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "document_type_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "document_name": "Address Information",
+#   "description": 'End User Residential Address information',
+#   "information": [
+#      {
+#         "enums": [
+#             "Water",
+#             "Electricity",
+#             "Gas",
+#             "Property Rental",
+#             "Others"
+#         ],
+#         "field_name": "type_of_utility",
+#         "field_type": "enum",
+#         "friendly_name": "Type of Utility"
+#      }
+#   ],
+#   "proof_required": "Scanned copy of the Bill",
+#   "created_at": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+# 3. Compliance Documents
+begin
+    resp = client.compliance_documents.list(
+        limit: 5,
+        offset: 0,
+        document_type_id: '15d48097-6fd6-4bbc-97ee-0c3dd0a8fe1a',
+        end_user_id: '4493840308')
+    puts resp
+  rescue PlivoRESTError => e
+    puts "Exception: " + e.message
+  end
+
+# Response
+#  {
+#    "alias": "test alias",
+#    "api_id": "3cfabf1a-6579-11eb-b408-0242ac110005",
+#    "created_at": "2021-02-02 08:08:10.312992 +0000 UTC",
+#    "document_id": "4a9599cc-c58c-4804-8c04-1d4918cb6df7",
+#    "document_type_id": "be903190-cc96-4fd8-b3cd-97832fe7c086",
+#    "end_user_id": "652e1445-1657-4a80-972f-6dbd467b00b5",
+#    "meta_information": {
+#        "use_case_description": "test"
+#    }
+#}
+
+# 4. Compliance Requirements
+begin
+    resp = client.compliance_requirements.list(
+        country_iso2: 'ES',
+        end_user_type: 'business',
+        number_type: 'local')
+    puts resp
+  rescue PlivoRESTError => e
+    puts "Exception: " + e.message
+  end
+
+# Response:
+#{
+#   "acceptable_document_types": [
+#      {
+#         "acceptable_documents": [
+#            {
+#               "document_type_id": "e68cf5fe-cea0-4b6c-a2b1-bef1d9add467",
+#               "document_type_name": "Address Information"
+#            }
+#          ],
+#          "name": "End User Address Details",
+#          "scope": "local"
+#      },
+#      {
+#         "acceptable_documents": [
+#            {
+#               "document_type_id": "e9b0b6fb-fd2f-44c1-9428-ee69afbd808b",
+#               "document_type_name": "Utility Bill"
+#            }
+#          ],
+#          "name": "Proof of Address ",
+#          "scope": "local"
+#        }
+#    ],
+#    "api_id": "75ea8886-6499-11eb-ad59-0242ac110005",
+#    "compliance_requirement_id": "4ae473b0-f154-41a4-aba8-ab76be12f27f",
+#    "country_iso2": "ES",
+#    "end_user_type": "individual",
+#    "number_type": "local"
+#}
+
+# 5. Compliance Applications
+begin
+    resp = client.compliance_applications.create(
+        alias_: 'test',
+        compliance_requirement_id: '4ae473b0-f154-41a4-aba8-ab76be12f27f',
+        end_user_type: 'individual'
+        end_user_id: 'f7ba78e0-1d31-4f75-842c-cd2f91334d9f',
+        document_ids: ["a663bc92-5c8e-4e95-80d5-ba75d3569a98","4a9599cc-c58c-4804-8c04-1d4918cb6df7"],
+        country_iso2: 'FR',
+        number_type: 'mobile'
+    )
+    puts resp
+  rescue PlivoRESTError => e
+    puts "Exception: " + e.message
+  end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "alias": "test",
+#   "compliance_application_id": "7c83fd87-fb5d-4a88-bde0-7c96da35f1e6",
+#   "compliance_requirement_id": "4ae473b0-f154-41a4-aba8-ab76be12f27f",
+#   "country_iso2": "FR",
+#   "documents": [],
+#   "end_user_id": "f7ba78e0-1d31-4f75-842c-cd2f91334d9f",
+#   "end_user_type": "individual",
+#   "message": "created",
+#   "number_type": "local",
+#   "status": "draft",
+#   "created_at": '2021-02-08T19:32:33.240504+00:00'
+# }

data/lib/plivo/base/resource.rb

@@ -0,0 +1,148 @@
+module Plivo
+  module Base
+    class Resource
+      attr_reader :id
+      include Plivo::Utils
+
+      def initialize(client, options = nil)
+        configure_client(client)
+        configure_options(options) if options
+        configure_resource_uri
+        @_is_voice_request = false
+      end
+
+      private
+
+      def configure_client(client)
+        valid_param?(:client, client, [RestClient, Phlo], true)
+        @_client = client
+      end
+
+      def configure_options(options)
+        valid_param?(:options, options, Hash, false)
+        @id = options[:resource_id] if options.key?(:resource_id)
+        parse_and_set(options[:resource_json]) if options.key?(:resource_json)
+      end
+
+      def configure_resource_uri
+        to_join = @id ? [@_client.auth_id, @_name, @id] : [@_client.auth_id, @_name]
+        to_join = ['', 'v1', 'Account'] << to_join
+
+        if @_name == 'Account'
+          @id = @_client.auth_id
+          to_join = ['', 'v1', 'Account', @id]
+        end
+
+        to_join << ''
+        @_resource_uri = to_join.join('/')
+      end
+
+      def parse_and_set(resource_json)
+        return unless resource_json
+
+        valid_param?(:resource_json, resource_json, Hash, true)
+
+        resource_json.each do |k, v|
+          instance_variable_set("@#{k}", v)
+          self.class.send(:attr_reader, k)
+        end
+
+        return unless @_identifier_string && (resource_json.key? @_identifier_string)
+        @id = resource_json[@_identifier_string]
+      end
+
+      def perform_update(params, use_multipart_conn = false)
+        unless @id
+          raise_invalid_request("Cannot update a #{@_name} resource "\
+          'without an identifier')
+        end
+
+        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil, use_multipart_conn, is_voice_request: @_is_voice_request)
+
+        parse_and_set(params)
+        parse_and_set(response_json)
+        self
+      end
+
+      def perform_action(action = nil, method = 'GET', params = nil, parse = false)
+        resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
+        parse ? parse_and_set(response) : self
+        method == 'POST' ? parse_and_set(params) : self
+        self
+      end
+      
+      def perform_custome_action(action = nil, method = 'GET', params = nil, parse = false)
+        resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
+        parse ? parse_and_set(response) : self
+        method == 'POST' ? parse_and_set(params) : self
+        self
+      end
+
+      def perform_action_apiresponse(action = nil, method = 'GET', params = nil, parse = false)
+        resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
+        parse ? parse_and_set(response) : self
+        method == 'POST' ? parse_and_set(params) : self
+        method == 'DELETE' ? parse_and_set(params) : self
+        return response
+      end
+
+      def perform_custom_action_apiresponse(action = nil, method = 'GET', params = nil, parse = false)
+        resource_path = action ? '/v1/Account/' + @_client.auth_id + '/'+ action + '/' : @_resource_uri
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
+        parse ? parse_and_set(response) : self
+        method == 'POST' ? parse_and_set(params) : self
+        method == 'DELETE' ? parse_and_set(params) : self
+        return response
+      end
+
+      def perform_delete(params=nil)
+        unless @id
+          raise_invalid_request("Cannot delete a #{@_name} resource "\
+          'without an identifier')
+        end
+
+        Response.new(@_client.send_request(@_resource_uri, 'DELETE', params, nil, false, is_voice_request: @_is_voice_request),
+                     @_identifier_string)
+      end
+
+      def perform_run(params)
+        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil,false,is_voice_request: @_is_voice_request)
+        parse_and_set(response_json)
+        Response.new(response_json, @_identifier_string)
+      end
+    end
+
+    class SecondaryResource < Resource
+      attr_reader :secondary_id
+      def initialize(client, options = nil)
+        super
+        configure_secondary_options(options) if options
+        configure_secondary_resource_uri
+      end
+
+      def configure_secondary_options(options)
+        valid_param?(:options, options, Hash, false)
+        @secondary_id = options[:member_id] if options.key?(:member_id)
+        secondary_parse_and_set(options[:resource_json]) if options.key?(:resource_json)
+      end
+
+      def secondary_parse_and_set(resource_json)
+        return unless resource_json
+
+        valid_param?(:resource_json, resource_json, Hash, true)
+        return unless @_secondary_identifier_string && (resource_json.key? @_secondary_identifier_string)
+        @secondary_id = resource_json[@_secondary_identifier_string]
+      end
+
+      def configure_secondary_resource_uri
+        to_join = @secondary_id ? [@_client.auth_id, @_name, @id, @_secondary_name, @secondary_id] : [@_client.auth_id, @_name, @id]
+        to_join = ['', 'v1', 'Account'] << to_join
+        to_join << ''
+        @_resource_uri = to_join.join('/')
+      end
+    end
+  end
+end