Class: Plivo::Resources::RecordingInterface

Inherits:
Base::ResourceInterface show all
Defined in:
lib/plivo/resources/recordings.rb

Constant Summary

Constants included from Utils

Utils::TYPE_WHITELIST

Instance Method Summary collapse

Methods included from Utils

expected_type?, expected_value?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_subaccount?

Constructor Details

#initialize(client, resource_list_json = nil) ⇒ RecordingInterface

Returns a new instance of RecordingInterface.



34
35
36
37
38
39
 
# File 'lib/plivo/resources/recordings.rb', line 34

def initialize(client, resource_list_json = nil)
  @_name = 'Recording'
  @_resource_type = Recording
  @_identifier_string = 'recording_id'
  super
end

Instance Method Details

#delete(recording_id) ⇒ Object

Parameters:

  • recording_id (String) 


107
108
109
110
111
 
# File 'lib/plivo/resources/recordings.rb', line 107

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 



96
97
98
99
100
101
102
103
104
 
# File 'lib/plivo/resources/recordings.rb', line 96

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

Parameters:

  • recording_id (String) 


90
91
92
93
94
 
# File 'lib/plivo/resources/recordings.rb', line 90

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

Parameters:

  • options (Hash) (defaults to: nil)

Options Hash (options):

  • :subaccount (String) —

    auth_id of the subaccount. Lists only those recordings of the main accounts which are tied to the specified subaccount.

  • :call_uuid (String) —

    Used to filter recordings for a specific call.

  • :add_time (String) —

    Used to filter out recordings according to the time they were added.The add_time filter is a comparative filter that can be used in the following four forms:

    • add_time__gt: gt stands for greater than. The format expected is YYYY-MM-DD HH:MM[:ss]. Eg:- To get all recordings that started after 2012-03-21 11:47, use add_time__gt=2012-03-21 11:47

    • add_time__gte: gte stands for greater than or equal. The format expected is YYYY-MM-DD HH:MM[:ss]. Eg:- To get all recordings that started after or exactly at 2012-03-21 11:47, use add_time__gte=2012-03-21 11:47

    • add_time__lt: lt stands for lesser than. The format expected is YYYY-MM-DD HH:MM[:ss]. Eg:- To get all recordings that started before 2012-03-21 11:47, use add_time__lt=2012-03-21 11:47

    • add_time__gte: lte stands for lesser than or equal. The format expected is YYYY-MM-DD HH:MM[:ss]. Eg:- To get all recordings that started before or exactly at 2012-03-21 11:47, use add_time__lte=2012-03-21 11:47

    • Note: The above filters can be combined to get recordings that started in a particular time range.

  • :limit (Int) —

    Used to display the number of results per page. The maximum number of results that can be fetched is 20.

  • :offset (Int) —

    Denotes the number of value items by which the results should be offset. Eg:- If the result contains a 1000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results.



52
53
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
 
# File 'lib/plivo/resources/recordings.rb', line 52

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