Class: Plivo::Resources::RecordingInterface
Constant Summary
Constants included
from Utils
Utils::TYPE_WHITELIST
Instance Method Summary
collapse
Methods included from Utils
GetSortedQueryParamString?, compute_signatureV3?, expected_type?, expected_value?, generate_url?, getMapFromQueryString?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_signatureV3?, valid_subaccount?
Constructor Details
#initialize(client, resource_list_json = nil) ⇒ RecordingInterface
Returns a new instance of RecordingInterface.
35
36
37
38
39
40
41
|
# File 'lib/plivo/resources/recordings.rb', line 35
def initialize(client, resource_list_json = nil)
@_name = 'Recording'
@_resource_type = Recording
@_identifier_string = 'recording_id'
super
@_is_voice_request = true
end
|
Instance Method Details
#delete(recording_id) ⇒ Object
109
110
111
112
113
|
# File 'lib/plivo/resources/recordings.rb', line 109
def delete(recording_id)
valid_param?(:recording_id, recording_id, [String, Symbol], true)
raise_invalid_request('Invalid recording_id passed') if recording_id.empty?
Recording.new(@_client, resource_id: recording_id).delete
end
|
#each ⇒ Object
98
99
100
101
102
103
104
105
106
|
# File 'lib/plivo/resources/recordings.rb', line 98
def each
offset = 0
loop do
recording_list = list(offset: offset)
recording_list[:objects].each { |recording| yield recording }
offset += 20
return unless recording_list.length == 20
end
end
|
#get(recording_id) ⇒ Object
92
93
94
95
96
|
# File 'lib/plivo/resources/recordings.rb', line 92
def get(recording_id)
valid_param?(:recording_id, recording_id, [String, Symbol], true)
raise_invalid_request('Invalid recording_id passed') if recording_id.empty?
perform_get(recording_id)
end
|
#list(options = nil) ⇒ Object
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# File 'lib/plivo/resources/recordings.rb', line 54
def list(options = nil)
return perform_list if options.nil?
valid_param?(:options, options, Hash, true)
params = {}
params_expected = %i[
call_uuid add_time__gt add_time__gte
add_time__lt add_time__lte
]
params_expected.each do |param|
if options.key?(param) && valid_param?(param, options[param], [String, Symbol], true)
params[param] = options[param]
end
end
if options.key?(:subaccount) &&
valid_subaccount?(options[:subaccount], true)
params[:subaccount] = options[:subaccount]
end
%i[offset limit].each do |param|
if options.key?(param) && valid_param?(param, options[param], [Integer, Integer], true)
params[param] = options[param]
end
end
if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
raise_invalid_request('The maximum number of results that can be fetched'\
" is 20. limit can't be more than 20 or less than 1")
end
raise_invalid_request("Offset can't be negative") if options.key?(:offset) && options[:offset] < 0
perform_list(params)
end
|