Class: MessenteApi::BlacklistApi
- Inherits:
-
Object
- Object
- MessenteApi::BlacklistApi
- Defined in:
- lib/messente_api/api/blacklist_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_to_blacklist(number_to_blacklist, opts = {}) ⇒ nil
Adds a phone number to the blacklist.
-
#add_to_blacklist_with_http_info(number_to_blacklist, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Adds a phone number to the blacklist.
-
#delete_from_blacklist(phone, opts = {}) ⇒ nil
Deletes a phone number from the blacklist.
-
#delete_from_blacklist_with_http_info(phone, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Deletes a phone number from the blacklist.
-
#fetch_blacklist(opts = {}) ⇒ FetchBlacklistSuccess
Returns all blacklisted phone numbers.
-
#fetch_blacklist_with_http_info(opts = {}) ⇒ Array<(FetchBlacklistSuccess, Integer, Hash)>
Returns all blacklisted phone numbers.
-
#initialize(api_client = ApiClient.default) ⇒ BlacklistApi
constructor
A new instance of BlacklistApi.
-
#is_blacklisted(phone, opts = {}) ⇒ nil
Checks if a phone number is blacklisted.
-
#is_blacklisted_with_http_info(phone, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Checks if a phone number is blacklisted.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BlacklistApi
Returns a new instance of BlacklistApi.
19 20 21 |
# File 'lib/messente_api/api/blacklist_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/messente_api/api/blacklist_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_to_blacklist(number_to_blacklist, opts = {}) ⇒ nil
Adds a phone number to the blacklist
26 27 28 29 |
# File 'lib/messente_api/api/blacklist_api.rb', line 26 def add_to_blacklist(number_to_blacklist, opts = {}) add_to_blacklist_with_http_info(number_to_blacklist, opts) nil end |
#add_to_blacklist_with_http_info(number_to_blacklist, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Adds a phone number to the blacklist
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 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 |
# File 'lib/messente_api/api/blacklist_api.rb', line 35 def add_to_blacklist_with_http_info(number_to_blacklist, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BlacklistApi.add_to_blacklist ...' end # verify the required parameter 'number_to_blacklist' is set if @api_client.config.client_side_validation && number_to_blacklist.nil? fail ArgumentError, "Missing the required parameter 'number_to_blacklist' when calling BlacklistApi.add_to_blacklist" end # resource path local_var_path = '/phonebook/blacklist' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(number_to_blacklist) # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BlacklistApi#add_to_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_from_blacklist(phone, opts = {}) ⇒ nil
Deletes a phone number from the blacklist
88 89 90 91 |
# File 'lib/messente_api/api/blacklist_api.rb', line 88 def delete_from_blacklist(phone, opts = {}) delete_from_blacklist_with_http_info(phone, opts) nil end |
#delete_from_blacklist_with_http_info(phone, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Deletes a phone number from the blacklist
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/messente_api/api/blacklist_api.rb', line 97 def delete_from_blacklist_with_http_info(phone, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BlacklistApi.delete_from_blacklist ...' end # verify the required parameter 'phone' is set if @api_client.config.client_side_validation && phone.nil? fail ArgumentError, "Missing the required parameter 'phone' when calling BlacklistApi.delete_from_blacklist" end # resource path local_var_path = '/phonebook/blacklist/{phone}'.sub('{' + 'phone' + '}', CGI.escape(phone.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BlacklistApi#delete_from_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#fetch_blacklist(opts = {}) ⇒ FetchBlacklistSuccess
Returns all blacklisted phone numbers
147 148 149 150 |
# File 'lib/messente_api/api/blacklist_api.rb', line 147 def fetch_blacklist(opts = {}) data, _status_code, _headers = fetch_blacklist_with_http_info(opts) data end |
#fetch_blacklist_with_http_info(opts = {}) ⇒ Array<(FetchBlacklistSuccess, Integer, Hash)>
Returns all blacklisted phone numbers
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/messente_api/api/blacklist_api.rb', line 155 def fetch_blacklist_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BlacklistApi.fetch_blacklist ...' end # resource path local_var_path = '/phonebook/blacklist' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'FetchBlacklistSuccess' # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BlacklistApi#fetch_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#is_blacklisted(phone, opts = {}) ⇒ nil
Checks if a phone number is blacklisted
202 203 204 205 |
# File 'lib/messente_api/api/blacklist_api.rb', line 202 def is_blacklisted(phone, opts = {}) is_blacklisted_with_http_info(phone, opts) nil end |
#is_blacklisted_with_http_info(phone, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Checks if a phone number is blacklisted
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/messente_api/api/blacklist_api.rb', line 211 def is_blacklisted_with_http_info(phone, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BlacklistApi.is_blacklisted ...' end # verify the required parameter 'phone' is set if @api_client.config.client_side_validation && phone.nil? fail ArgumentError, "Missing the required parameter 'phone' when calling BlacklistApi.is_blacklisted" end # resource path local_var_path = '/phonebook/blacklist/{phone}'.sub('{' + 'phone' + '}', CGI.escape(phone.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['basicAuth'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BlacklistApi#is_blacklisted\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |