Class: Plivo::Resources::TollfreeVerificationsInterface
- Inherits:
-
Base::ResourceInterface
- Object
- Base::ResourceInterface
- Plivo::Resources::TollfreeVerificationsInterface
- Defined in:
- lib/plivo/resources/tollfree_verification.rb
Constant Summary
Constants included from Utils
Instance Method Summary collapse
-
#create(number, usecase, usecase_summary, profile_uuid, optin_type, optin_image_url, volume, message_sample, callback_url = nil, callback_method = nil, extra_data = nil, additional_information = nil) ⇒ Object
Create an TollfreeVerification return [TollfreeVerification] TollfreeVerification.
-
#delete(uuid) ⇒ Object
Delete an TollfreeVerification.
-
#get(uuid) ⇒ Object
Get an TollfreeVerification return [TollfreeVerification].
-
#initialize(client, resource_list_json = nil) ⇒ TollfreeVerificationsInterface
constructor
A new instance of TollfreeVerificationsInterface.
-
#list(options = nil) ⇒ Hash
List all TollfreeVerification.
-
#update(uuid, options = nil) ⇒ Object
Update an TollfreeVerification return [TollfreeVerification].
Methods included from Utils
GetSortedQueryParamString?, compute_signatureV3?, expected_type?, expected_value?, generate_url?, getMapFromQueryString?, is_one_among_string_url?, multi_valid_param?, raise_invalid_request, valid_account?, valid_date_format?, valid_mainaccount?, valid_multiple_destination_integers?, valid_multiple_destination_nos?, valid_param?, valid_range?, valid_signature?, valid_signatureV3?, valid_subaccount?, valid_url?
Constructor Details
#initialize(client, resource_list_json = nil) ⇒ TollfreeVerificationsInterface
Returns a new instance of TollfreeVerificationsInterface.
58 59 60 61 62 63 |
# File 'lib/plivo/resources/tollfree_verification.rb', line 58 def initialize(client, resource_list_json = nil) @_name = 'TollfreeVerification' @_resource_type = TollfreeVerification @_identifier_string = 'tollfree_verification' super end |
Instance Method Details
#create(number, usecase, usecase_summary, profile_uuid, optin_type, optin_image_url, volume, message_sample, callback_url = nil, callback_method = nil, extra_data = nil, additional_information = nil) ⇒ Object
Create an TollfreeVerification return [TollfreeVerification] TollfreeVerification
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/plivo/resources/tollfree_verification.rb', line 125 def create(number, usecase, usecase_summary, profile_uuid, optin_type, optin_image_url, volume, , callback_url = nil, callback_method = nil, extra_data = nil, additional_information = nil) valid_param?(:number, number, [String, Symbol], true) valid_param?(:usecase, usecase, [String, Symbol], true) valid_param?(:usecase_summary, usecase_summary, [String, Symbol], true) valid_param?(:profile_uuid, profile_uuid, [String, Symbol], true) valid_param?(:optin_type, optin_type, [String, Symbol], true) valid_param?(:optin_image_url, optin_image_url, [String, Symbol], true) valid_param?(:volume, volume, [String, Symbol], true) valid_param?(:message_sample, , [String, Symbol], true) valid_param?(:callback_url, callback_url, [String, Symbol], false) valid_param?(:callback_method, callback_method, [String, Symbol], false) valid_param?(:extra_data, extra_data, [String, Symbol], false) valid_param?(:additional_information, additional_information, [String, Symbol], false) params = { number: number, usecase: usecase, usecase_summary: usecase_summary, profile_uuid: profile_uuid, optin_type: optin_type, optin_image_url: optin_image_url, volume: volume, message_sample: , callback_url: callback_url, callback_method: callback_method, extra_data: extra_data, additional_information: additional_information }.delete_if { |key, value| value.nil? } return perform_create(params) end |
#delete(uuid) ⇒ Object
Delete an TollfreeVerification.
171 172 173 174 175 |
# File 'lib/plivo/resources/tollfree_verification.rb', line 171 def delete(uuid) valid_param?(:uuid, uuid, [String, Symbol], true) TollfreeVerification.new(@_client, resource_id: uuid).delete end |
#get(uuid) ⇒ Object
Get an TollfreeVerification return [TollfreeVerification]
69 70 71 72 |
# File 'lib/plivo/resources/tollfree_verification.rb', line 69 def get(uuid) valid_param?(:uuid, uuid, [String, Symbol], true) perform_get(uuid) end |
#list(options = nil) ⇒ Hash
List all TollfreeVerification
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/plivo/resources/tollfree_verification.rb', line 80 def list( = nil) return perform_list if .nil? valid_param?(:options, , Hash, true) params = {} params_expected = %i[ profile_uuid number status created__lt created__gt usecase created__lte created__gte ] params_expected.each do |param| if .key?(param) && valid_param?(param, [param], [String, Symbol], true) params[param] = [param] end end %i[offset limit].each do |param| if .key?(param) && valid_param?(param, [param], [Integer], true) params[param] = [param] end end raise_invalid_request("Offset can't be negative") if .key?(:offset) && [:offset] < 0 if .key?(:limit) && ([:limit] > 20 || [: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 perform_list(params) end |
#update(uuid, options = nil) ⇒ Object
Update an TollfreeVerification return [TollfreeVerification]
162 163 164 165 166 |
# File 'lib/plivo/resources/tollfree_verification.rb', line 162 def update(uuid, = nil) valid_param?(:uuid, uuid, [String, Symbol], true) TollfreeVerification.new(@_client, resource_id: uuid).update() end |