Class: MailSlurpClient::AliasControllerApi
- Inherits:
-
Object
- Object
- MailSlurpClient::AliasControllerApi
- Defined in:
- lib/mailslurp_client/api/alias_controller_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_alias(create_owned_alias_options, opts = {}) ⇒ nil
Create an email alias Create an email alias belonging to a user ID.
-
#create_alias_with_http_info(create_owned_alias_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create an email alias Create an email alias belonging to a user ID.
-
#create_anonymous_alias(create_anonymous_alias_options, opts = {}) ⇒ ModelAlias
Create an anonymous email alias.
-
#create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts = {}) ⇒ Array<(ModelAlias, Integer, Hash)>
Create an anonymous email alias.
-
#delete_alias(alias_id, opts = {}) ⇒ nil
Delete an owned alias.
-
#delete_alias_with_http_info(alias_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete an owned alias.
-
#get_alias(alias_id, opts = {}) ⇒ ModelAlias
Get an email alias Get an email alias by ID.
-
#get_alias_with_http_info(alias_id, opts = {}) ⇒ Array<(ModelAlias, Integer, Hash)>
Get an email alias Get an email alias by ID.
-
#get_aliases(opts = {}) ⇒ PageAlias
Get all email aliases Get all email aliases in paginated form.
-
#get_aliases_with_http_info(opts = {}) ⇒ Array<(PageAlias, Integer, Hash)>
Get all email aliases Get all email aliases in paginated form.
-
#initialize(api_client = ApiClient.default) ⇒ AliasControllerApi
constructor
A new instance of AliasControllerApi.
-
#update_alias(alias_id, create_owned_alias_options, opts = {}) ⇒ nil
Update an owned alias.
-
#update_alias_with_http_info(alias_id, create_owned_alias_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update an owned alias.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AliasControllerApi
Returns a new instance of AliasControllerApi.
19 20 21 |
# File 'lib/mailslurp_client/api/alias_controller_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/mailslurp_client/api/alias_controller_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_alias(create_owned_alias_options, opts = {}) ⇒ nil
Create an email alias Create an email alias belonging to a user ID. To create anonymous aliases use the ‘createAnonymousAlias` method.
27 28 29 30 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 27 def create_alias(, opts = {}) create_alias_with_http_info(, opts) nil end |
#create_alias_with_http_info(create_owned_alias_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create an email alias Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.
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 83 84 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 37 def create_alias_with_http_info(, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_alias ...' end # verify the required parameter 'create_owned_alias_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'create_owned_alias_options' when calling AliasControllerApi.create_alias" end # resource path local_var_path = '/aliases' # 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() # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = 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: AliasControllerApi#create_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_anonymous_alias(create_anonymous_alias_options, opts = {}) ⇒ ModelAlias
Create an anonymous email alias
90 91 92 93 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 90 def create_anonymous_alias(, opts = {}) data, _status_code, _headers = create_anonymous_alias_with_http_info(, opts) data end |
#create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts = {}) ⇒ Array<(ModelAlias, Integer, Hash)>
Create an anonymous email alias
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 143 144 145 146 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 99 def create_anonymous_alias_with_http_info(, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_anonymous_alias ...' end # verify the required parameter 'create_anonymous_alias_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'create_anonymous_alias_options' when calling AliasControllerApi.create_anonymous_alias" end # resource path local_var_path = '/aliases/anonymous' # 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() # return_type return_type = opts[:return_type] || 'ModelAlias' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = 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: AliasControllerApi#create_anonymous_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_alias(alias_id, opts = {}) ⇒ nil
Delete an owned alias
152 153 154 155 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 152 def delete_alias(alias_id, opts = {}) delete_alias_with_http_info(alias_id, opts) nil end |
#delete_alias_with_http_info(alias_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete an owned alias
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 197 198 199 200 201 202 203 204 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 161 def delete_alias_with_http_info(alias_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasControllerApi.delete_alias ...' end # verify the required parameter 'alias_id' is set if @api_client.config.client_side_validation && alias_id.nil? fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.delete_alias" end # resource path local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # 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] || ['API_KEY'] = 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: AliasControllerApi#delete_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_alias(alias_id, opts = {}) ⇒ ModelAlias
Get an email alias Get an email alias by ID
211 212 213 214 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 211 def get_alias(alias_id, opts = {}) data, _status_code, _headers = get_alias_with_http_info(alias_id, opts) data end |
#get_alias_with_http_info(alias_id, opts = {}) ⇒ Array<(ModelAlias, Integer, Hash)>
Get an email alias Get an email alias by ID
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 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 221 def get_alias_with_http_info(alias_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_alias ...' end # verify the required parameter 'alias_id' is set if @api_client.config.client_side_validation && alias_id.nil? fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.get_alias" end # resource path local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.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] || 'ModelAlias' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = 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: AliasControllerApi#get_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_aliases(opts = {}) ⇒ PageAlias
Get all email aliases Get all email aliases in paginated form
275 276 277 278 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 275 def get_aliases(opts = {}) data, _status_code, _headers = get_aliases_with_http_info(opts) data end |
#get_aliases_with_http_info(opts = {}) ⇒ Array<(PageAlias, Integer, Hash)>
Get all email aliases Get all email aliases in paginated form
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 287 def get_aliases_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_aliases ...' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/aliases' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # 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] || 'PageAlias' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = 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: AliasControllerApi#get_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_alias(alias_id, create_owned_alias_options, opts = {}) ⇒ nil
Update an owned alias
342 343 344 345 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 342 def update_alias(alias_id, , opts = {}) update_alias_with_http_info(alias_id, , opts) nil end |
#update_alias_with_http_info(alias_id, create_owned_alias_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update an owned alias
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'lib/mailslurp_client/api/alias_controller_api.rb', line 352 def update_alias_with_http_info(alias_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasControllerApi.update_alias ...' end # verify the required parameter 'alias_id' is set if @api_client.config.client_side_validation && alias_id.nil? fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.update_alias" end # verify the required parameter 'create_owned_alias_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'create_owned_alias_options' when calling AliasControllerApi.update_alias" end # resource path local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.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']) # 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() # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AliasControllerApi#update_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |