mailslurp_client 7.0.8 → 8.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client.rb +12 -3
- metadata +11 -372
- data/Gemfile +0 -9
- data/LICENSE +0 -22
- data/Makefile +0 -3
- data/README.md +0 -239
- data/Rakefile +0 -10
- data/docs/AliasControllerApi.md +0 -337
- data/docs/AttachmentControllerApi.md +0 -126
- data/docs/AttachmentMetaData.md +0 -23
- data/docs/BasicAuthOptions.md +0 -19
- data/docs/BulkActionsControllerApi.md +0 -165
- data/docs/BulkSendEmailOptions.md +0 -19
- data/docs/CommonActionsControllerApi.md +0 -218
- data/docs/ContactControllerApi.md +0 -274
- data/docs/ContactDto.md +0 -31
- data/docs/ContactProjection.md +0 -27
- data/docs/CreateAnonymousAliasOptions.md +0 -17
- data/docs/CreateContactOptions.md +0 -31
- data/docs/CreateDomainOptions.md +0 -17
- data/docs/CreateGroupOptions.md +0 -19
- data/docs/CreateOwnedAliasOptions.md +0 -23
- data/docs/CreateTemplateOptions.md +0 -19
- data/docs/CreateWebhookOptions.md +0 -21
- data/docs/DomainControllerApi.md +0 -223
- data/docs/DomainDto.md +0 -29
- data/docs/DomainPreview.md +0 -21
- data/docs/Email.md +0 -49
- data/docs/EmailAnalysis.md +0 -25
- data/docs/EmailControllerApi.md +0 -740
- data/docs/EmailPreview.md +0 -31
- data/docs/EmailProjection.md +0 -33
- data/docs/FormControllerApi.md +0 -79
- data/docs/ForwardEmailOptions.md +0 -23
- data/docs/GroupContactsDto.md +0 -19
- data/docs/GroupControllerApi.md +0 -437
- data/docs/GroupDto.md +0 -23
- data/docs/GroupProjection.md +0 -23
- data/docs/HTMLValidationResult.md +0 -21
- data/docs/Inbox.md +0 -33
- data/docs/InboxControllerApi.md +0 -705
- data/docs/InboxProjection.md +0 -29
- data/docs/JsonNode.md +0 -59
- data/docs/MatchOption.md +0 -21
- data/docs/MatchOptions.md +0 -17
- data/docs/ModelAlias.md +0 -31
- data/docs/PageAlias.md +0 -37
- data/docs/PageContactProjection.md +0 -37
- data/docs/PageEmailPreview.md +0 -37
- data/docs/PageEmailProjection.md +0 -37
- data/docs/PageGroupProjection.md +0 -37
- data/docs/PageInboxProjection.md +0 -37
- data/docs/PageTemplateProjection.md +0 -37
- data/docs/PageWebhookProjection.md +0 -37
- data/docs/Pageable.md +0 -27
- data/docs/RawEmailJson.md +0 -17
- data/docs/SendEmailOptions.md +0 -45
- data/docs/SetInboxFavouritedOptions.md +0 -17
- data/docs/SimpleSendEmailOptions.md +0 -23
- data/docs/Sort.md +0 -21
- data/docs/TemplateControllerApi.md +0 -274
- data/docs/TemplateDto.md +0 -25
- data/docs/TemplateProjection.md +0 -25
- data/docs/TemplateVariable.md +0 -19
- data/docs/UnreadCount.md +0 -17
- data/docs/UpdateGroupContacts.md +0 -17
- data/docs/UpdateInboxOptions.md +0 -25
- data/docs/UploadAttachmentOptions.md +0 -21
- data/docs/ValidationDto.md +0 -19
- data/docs/ValidationMessage.md +0 -19
- data/docs/WaitForConditions.md +0 -29
- data/docs/WaitForControllerApi.md +0 -317
- data/docs/WebhookControllerApi.md +0 -339
- data/docs/WebhookDto.md +0 -33
- data/docs/WebhookProjection.md +0 -27
- data/docs/WebhookTestRequest.md +0 -23
- data/docs/WebhookTestResponse.md +0 -19
- data/docs/WebhookTestResult.md +0 -21
- data/git_push.sh +0 -58
- data/lib/mailslurp_client/api/alias_controller_api.rb +0 -405
- data/lib/mailslurp_client/api/attachment_controller_api.rb +0 -160
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -257
- data/lib/mailslurp_client/api/contact_controller_api.rb +0 -323
- data/lib/mailslurp_client/api/domain_controller_api.rb +0 -264
- data/lib/mailslurp_client/api/email_controller_api.rb +0 -852
- data/lib/mailslurp_client/api/form_controller_api.rb +0 -104
- data/lib/mailslurp_client/api/group_controller_api.rb +0 -519
- data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -822
- data/lib/mailslurp_client/api/template_controller_api.rb +0 -323
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +0 -359
- data/lib/mailslurp_client/api/webhook_controller_api.rb +0 -405
- data/lib/mailslurp_client/api_client.rb +0 -386
- data/lib/mailslurp_client/api_error.rb +0 -57
- data/lib/mailslurp_client/configuration.rb +0 -248
- data/lib/mailslurp_client/models/attachment_meta_data.rb +0 -238
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -219
- data/lib/mailslurp_client/models/contact_dto.rb +0 -288
- data/lib/mailslurp_client/models/contact_projection.rb +0 -261
- data/lib/mailslurp_client/models/create_anonymous_alias_options.rb +0 -208
- data/lib/mailslurp_client/models/create_contact_options.rb +0 -277
- data/lib/mailslurp_client/models/create_domain_options.rb +0 -208
- data/lib/mailslurp_client/models/create_group_options.rb +0 -220
- data/lib/mailslurp_client/models/create_owned_alias_options.rb +0 -238
- data/lib/mailslurp_client/models/create_template_options.rb +0 -225
- data/lib/mailslurp_client/models/create_webhook_options.rb +0 -227
- data/lib/mailslurp_client/models/domain_dto.rb +0 -296
- data/lib/mailslurp_client/models/domain_preview.rb +0 -240
- data/lib/mailslurp_client/models/email.rb +0 -376
- data/lib/mailslurp_client/models/email_analysis.rb +0 -248
- data/lib/mailslurp_client/models/email_preview.rb +0 -286
- data/lib/mailslurp_client/models/email_projection.rb +0 -307
- data/lib/mailslurp_client/models/forward_email_options.rb +0 -244
- data/lib/mailslurp_client/models/group_contacts_dto.rb +0 -227
- data/lib/mailslurp_client/models/group_dto.rb +0 -248
- data/lib/mailslurp_client/models/group_projection.rb +0 -248
- data/lib/mailslurp_client/models/html_validation_result.rb +0 -243
- data/lib/mailslurp_client/models/inbox.rb +0 -290
- data/lib/mailslurp_client/models/inbox_projection.rb +0 -272
- data/lib/mailslurp_client/models/json_node.rb +0 -429
- data/lib/mailslurp_client/models/match_option.rb +0 -274
- data/lib/mailslurp_client/models/match_options.rb +0 -210
- data/lib/mailslurp_client/models/model_alias.rb +0 -284
- data/lib/mailslurp_client/models/page_alias.rb +0 -298
- data/lib/mailslurp_client/models/page_contact_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_email_preview.rb +0 -298
- data/lib/mailslurp_client/models/page_email_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_group_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_inbox_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_template_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_webhook_projection.rb +0 -298
- data/lib/mailslurp_client/models/pageable.rb +0 -251
- data/lib/mailslurp_client/models/raw_email_json.rb +0 -211
- data/lib/mailslurp_client/models/send_email_options.rb +0 -392
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +0 -208
- data/lib/mailslurp_client/models/simple_send_email_options.rb +0 -237
- data/lib/mailslurp_client/models/sort.rb +0 -224
- data/lib/mailslurp_client/models/template_dto.rb +0 -269
- data/lib/mailslurp_client/models/template_projection.rb +0 -269
- data/lib/mailslurp_client/models/template_variable.rb +0 -259
- data/lib/mailslurp_client/models/unread_count.rb +0 -211
- data/lib/mailslurp_client/models/update_group_contacts.rb +0 -213
- data/lib/mailslurp_client/models/update_inbox_options.rb +0 -250
- data/lib/mailslurp_client/models/upload_attachment_options.rb +0 -228
- data/lib/mailslurp_client/models/validation_dto.rb +0 -217
- data/lib/mailslurp_client/models/validation_message.rb +0 -220
- data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -316
- data/lib/mailslurp_client/models/webhook_dto.rb +0 -326
- data/lib/mailslurp_client/models/webhook_projection.rb +0 -277
- data/lib/mailslurp_client/models/webhook_test_request.rb +0 -284
- data/lib/mailslurp_client/models/webhook_test_response.rb +0 -215
- data/lib/mailslurp_client/models/webhook_test_result.rb +0 -235
- data/lib/mailslurp_client/version.rb +0 -15
- data/mailslurp_client.gemspec +0 -39
- data/spec/api/alias_controller_api_spec.rb +0 -107
- data/spec/api/attachment_controller_api_spec.rb +0 -61
- data/spec/api/bulk_actions_controller_api_spec.rb +0 -68
- data/spec/api/common_actions_controller_api_spec.rb +0 -129
- data/spec/api/contact_controller_api_spec.rb +0 -91
- data/spec/api/domain_controller_api_spec.rb +0 -82
- data/spec/api/email_controller_api_spec.rb +0 -162
- data/spec/api/form_controller_api_spec.rb +0 -54
- data/spec/api/group_controller_api_spec.rb +0 -126
- data/spec/api/inbox_controller_api_spec.rb +0 -172
- data/spec/api/template_controller_api_spec.rb +0 -91
- data/spec/api/wait_for_controller_api_spec.rb +0 -107
- data/spec/api/webhook_controller_api_spec.rb +0 -107
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/attachment_meta_data_spec.rb +0 -59
- data/spec/models/basic_auth_options_spec.rb +0 -47
- data/spec/models/bulk_send_email_options_spec.rb +0 -47
- data/spec/models/contact_dto_spec.rb +0 -83
- data/spec/models/contact_projection_spec.rb +0 -71
- data/spec/models/create_anonymous_alias_options_spec.rb +0 -41
- data/spec/models/create_contact_options_spec.rb +0 -83
- data/spec/models/create_domain_options_spec.rb +0 -41
- data/spec/models/create_group_options_spec.rb +0 -47
- data/spec/models/create_owned_alias_options_spec.rb +0 -59
- data/spec/models/create_template_options_spec.rb +0 -47
- data/spec/models/create_webhook_options_spec.rb +0 -53
- data/spec/models/domain_dto_spec.rb +0 -77
- data/spec/models/domain_preview_spec.rb +0 -53
- data/spec/models/email_analysis_spec.rb +0 -65
- data/spec/models/email_preview_spec.rb +0 -83
- data/spec/models/email_projection_spec.rb +0 -89
- data/spec/models/email_spec.rb +0 -137
- data/spec/models/forward_email_options_spec.rb +0 -59
- data/spec/models/group_contacts_dto_spec.rb +0 -47
- data/spec/models/group_dto_spec.rb +0 -59
- data/spec/models/group_projection_spec.rb +0 -59
- data/spec/models/html_validation_result_spec.rb +0 -53
- data/spec/models/inbox_projection_spec.rb +0 -77
- data/spec/models/inbox_spec.rb +0 -89
- data/spec/models/json_node_spec.rb +0 -171
- data/spec/models/match_option_spec.rb +0 -61
- data/spec/models/match_options_spec.rb +0 -41
- data/spec/models/model_alias_spec.rb +0 -83
- data/spec/models/page_alias_spec.rb +0 -101
- data/spec/models/page_contact_projection_spec.rb +0 -101
- data/spec/models/page_email_preview_spec.rb +0 -101
- data/spec/models/page_email_projection_spec.rb +0 -101
- data/spec/models/page_group_projection_spec.rb +0 -101
- data/spec/models/page_inbox_projection_spec.rb +0 -101
- data/spec/models/page_template_projection_spec.rb +0 -101
- data/spec/models/page_webhook_projection_spec.rb +0 -101
- data/spec/models/pageable_spec.rb +0 -71
- data/spec/models/raw_email_json_spec.rb +0 -41
- data/spec/models/send_email_options_spec.rb +0 -129
- data/spec/models/set_inbox_favourited_options_spec.rb +0 -41
- data/spec/models/simple_send_email_options_spec.rb +0 -59
- data/spec/models/sort_spec.rb +0 -53
- data/spec/models/template_dto_spec.rb +0 -65
- data/spec/models/template_projection_spec.rb +0 -65
- data/spec/models/template_variable_spec.rb +0 -51
- data/spec/models/unread_count_spec.rb +0 -41
- data/spec/models/update_group_contacts_spec.rb +0 -41
- data/spec/models/update_inbox_options_spec.rb +0 -65
- data/spec/models/upload_attachment_options_spec.rb +0 -53
- data/spec/models/validation_dto_spec.rb +0 -47
- data/spec/models/validation_message_spec.rb +0 -47
- data/spec/models/wait_for_conditions_spec.rb +0 -85
- data/spec/models/webhook_dto_spec.rb +0 -93
- data/spec/models/webhook_projection_spec.rb +0 -71
- data/spec/models/webhook_test_request_spec.rb +0 -63
- data/spec/models/webhook_test_response_spec.rb +0 -47
- data/spec/models/webhook_test_result_spec.rb +0 -53
- data/spec/spec_helper.rb +0 -111
@@ -1,104 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
|
-
|
6
|
-
The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'cgi'
|
14
|
-
|
15
|
-
module MailSlurpClient
|
16
|
-
class FormControllerApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
# Submit a form to be parsed and sent as an email to an address determined by the form fields
|
23
|
-
# This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a `_to` email address or a `_toAlias` email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com` The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types. #### HTML Example ```html <form action=\"https://api.mailslurp.com/forms\" method=\"post\" > <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/> <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` #### URL Example ```html <form action=\"https://api.mailslurp.com/forms?_toAlias=test@example.com\" method=\"post\" > <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.
|
24
|
-
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
|
26
|
-
# @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
|
27
|
-
# @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
|
28
|
-
# @option opts [String] :_subject Optional subject of the email that will be sent.
|
29
|
-
# @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
|
30
|
-
# @option opts [String] :_to The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
|
31
|
-
# @option opts [String] :_to_alias ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
|
32
|
-
# @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
|
33
|
-
# @return [String]
|
34
|
-
def submit_form(opts = {})
|
35
|
-
data, _status_code, _headers = submit_form_with_http_info(opts)
|
36
|
-
data
|
37
|
-
end
|
38
|
-
|
39
|
-
# Submit a form to be parsed and sent as an email to an address determined by the form fields
|
40
|
-
# This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a `_to` email address or a `_toAlias` email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com` The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types. #### HTML Example ```html <form action=\"https://api.mailslurp.com/forms\" method=\"post\" > <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/> <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` #### URL Example ```html <form action=\"https://api.mailslurp.com/forms?_toAlias=test@example.com\" method=\"post\" > <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.
|
41
|
-
# @param [Hash] opts the optional parameters
|
42
|
-
# @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
|
43
|
-
# @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
|
44
|
-
# @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
|
45
|
-
# @option opts [String] :_subject Optional subject of the email that will be sent.
|
46
|
-
# @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
|
47
|
-
# @option opts [String] :_to The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
|
48
|
-
# @option opts [String] :_to_alias ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
|
49
|
-
# @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
|
50
|
-
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
51
|
-
def submit_form_with_http_info(opts = {})
|
52
|
-
if @api_client.config.debugging
|
53
|
-
@api_client.config.logger.debug 'Calling API: FormControllerApi.submit_form ...'
|
54
|
-
end
|
55
|
-
# resource path
|
56
|
-
local_var_path = '/forms'
|
57
|
-
|
58
|
-
# query parameters
|
59
|
-
query_params = opts[:query_params] || {}
|
60
|
-
|
61
|
-
# header parameters
|
62
|
-
header_params = opts[:header_params] || {}
|
63
|
-
# HTTP header 'Accept' (if needed)
|
64
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
65
|
-
# HTTP header 'Content-Type'
|
66
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
|
67
|
-
|
68
|
-
# form parameters
|
69
|
-
form_params = opts[:form_params] || {}
|
70
|
-
form_params['_emailAddress'] = opts[:'_email_address'] if !opts[:'_email_address'].nil?
|
71
|
-
form_params['_redirectTo'] = opts[:'_redirect_to'] if !opts[:'_redirect_to'].nil?
|
72
|
-
form_params['_spamCheck'] = opts[:'_spam_check'] if !opts[:'_spam_check'].nil?
|
73
|
-
form_params['_subject'] = opts[:'_subject'] if !opts[:'_subject'].nil?
|
74
|
-
form_params['_successMessage'] = opts[:'_success_message'] if !opts[:'_success_message'].nil?
|
75
|
-
form_params['_to'] = opts[:'_to'] if !opts[:'_to'].nil?
|
76
|
-
form_params['_toAlias'] = opts[:'_to_alias'] if !opts[:'_to_alias'].nil?
|
77
|
-
form_params['otherParameters'] = opts[:'other_parameters'] if !opts[:'other_parameters'].nil?
|
78
|
-
|
79
|
-
# http body (model)
|
80
|
-
post_body = opts[:body]
|
81
|
-
|
82
|
-
# return_type
|
83
|
-
return_type = opts[:return_type] || 'String'
|
84
|
-
|
85
|
-
# auth_names
|
86
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
87
|
-
|
88
|
-
new_options = opts.merge(
|
89
|
-
:header_params => header_params,
|
90
|
-
:query_params => query_params,
|
91
|
-
:form_params => form_params,
|
92
|
-
:body => post_body,
|
93
|
-
:auth_names => auth_names,
|
94
|
-
:return_type => return_type
|
95
|
-
)
|
96
|
-
|
97
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
98
|
-
if @api_client.config.debugging
|
99
|
-
@api_client.config.logger.debug "API called: FormControllerApi#submit_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
100
|
-
end
|
101
|
-
return data, status_code, headers
|
102
|
-
end
|
103
|
-
end
|
104
|
-
end
|
@@ -1,519 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
|
-
|
6
|
-
The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'cgi'
|
14
|
-
|
15
|
-
module MailSlurpClient
|
16
|
-
class GroupControllerApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
# Add contacts to a group
|
23
|
-
# @param group_id [String] groupId
|
24
|
-
# @param update_group_contacts_option [UpdateGroupContacts] updateGroupContactsOption
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [GroupContactsDto]
|
27
|
-
def add_contacts_to_group(group_id, update_group_contacts_option, opts = {})
|
28
|
-
data, _status_code, _headers = add_contacts_to_group_with_http_info(group_id, update_group_contacts_option, opts)
|
29
|
-
data
|
30
|
-
end
|
31
|
-
|
32
|
-
# Add contacts to a group
|
33
|
-
# @param group_id [String] groupId
|
34
|
-
# @param update_group_contacts_option [UpdateGroupContacts] updateGroupContactsOption
|
35
|
-
# @param [Hash] opts the optional parameters
|
36
|
-
# @return [Array<(GroupContactsDto, Integer, Hash)>] GroupContactsDto data, response status code and response headers
|
37
|
-
def add_contacts_to_group_with_http_info(group_id, update_group_contacts_option, opts = {})
|
38
|
-
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.add_contacts_to_group ...'
|
40
|
-
end
|
41
|
-
# verify the required parameter 'group_id' is set
|
42
|
-
if @api_client.config.client_side_validation && group_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.add_contacts_to_group"
|
44
|
-
end
|
45
|
-
# verify the required parameter 'update_group_contacts_option' is set
|
46
|
-
if @api_client.config.client_side_validation && update_group_contacts_option.nil?
|
47
|
-
fail ArgumentError, "Missing the required parameter 'update_group_contacts_option' when calling GroupControllerApi.add_contacts_to_group"
|
48
|
-
end
|
49
|
-
# resource path
|
50
|
-
local_var_path = '/groups/{groupId}/contacts'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
51
|
-
|
52
|
-
# query parameters
|
53
|
-
query_params = opts[:query_params] || {}
|
54
|
-
|
55
|
-
# header parameters
|
56
|
-
header_params = opts[:header_params] || {}
|
57
|
-
# HTTP header 'Accept' (if needed)
|
58
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
59
|
-
# HTTP header 'Content-Type'
|
60
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
61
|
-
|
62
|
-
# form parameters
|
63
|
-
form_params = opts[:form_params] || {}
|
64
|
-
|
65
|
-
# http body (model)
|
66
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_group_contacts_option)
|
67
|
-
|
68
|
-
# return_type
|
69
|
-
return_type = opts[:return_type] || 'GroupContactsDto'
|
70
|
-
|
71
|
-
# auth_names
|
72
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
73
|
-
|
74
|
-
new_options = opts.merge(
|
75
|
-
:header_params => header_params,
|
76
|
-
:query_params => query_params,
|
77
|
-
:form_params => form_params,
|
78
|
-
:body => post_body,
|
79
|
-
:auth_names => auth_names,
|
80
|
-
:return_type => return_type
|
81
|
-
)
|
82
|
-
|
83
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
84
|
-
if @api_client.config.debugging
|
85
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#add_contacts_to_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
-
end
|
87
|
-
return data, status_code, headers
|
88
|
-
end
|
89
|
-
|
90
|
-
# Create a group
|
91
|
-
# @param create_group_options [CreateGroupOptions] createGroupOptions
|
92
|
-
# @param [Hash] opts the optional parameters
|
93
|
-
# @return [GroupDto]
|
94
|
-
def create_group(create_group_options, opts = {})
|
95
|
-
data, _status_code, _headers = create_group_with_http_info(create_group_options, opts)
|
96
|
-
data
|
97
|
-
end
|
98
|
-
|
99
|
-
# Create a group
|
100
|
-
# @param create_group_options [CreateGroupOptions] createGroupOptions
|
101
|
-
# @param [Hash] opts the optional parameters
|
102
|
-
# @return [Array<(GroupDto, Integer, Hash)>] GroupDto data, response status code and response headers
|
103
|
-
def create_group_with_http_info(create_group_options, opts = {})
|
104
|
-
if @api_client.config.debugging
|
105
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.create_group ...'
|
106
|
-
end
|
107
|
-
# verify the required parameter 'create_group_options' is set
|
108
|
-
if @api_client.config.client_side_validation && create_group_options.nil?
|
109
|
-
fail ArgumentError, "Missing the required parameter 'create_group_options' when calling GroupControllerApi.create_group"
|
110
|
-
end
|
111
|
-
# resource path
|
112
|
-
local_var_path = '/groups'
|
113
|
-
|
114
|
-
# query parameters
|
115
|
-
query_params = opts[:query_params] || {}
|
116
|
-
|
117
|
-
# header parameters
|
118
|
-
header_params = opts[:header_params] || {}
|
119
|
-
# HTTP header 'Accept' (if needed)
|
120
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
121
|
-
# HTTP header 'Content-Type'
|
122
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
123
|
-
|
124
|
-
# form parameters
|
125
|
-
form_params = opts[:form_params] || {}
|
126
|
-
|
127
|
-
# http body (model)
|
128
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_group_options)
|
129
|
-
|
130
|
-
# return_type
|
131
|
-
return_type = opts[:return_type] || 'GroupDto'
|
132
|
-
|
133
|
-
# auth_names
|
134
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
135
|
-
|
136
|
-
new_options = opts.merge(
|
137
|
-
:header_params => header_params,
|
138
|
-
:query_params => query_params,
|
139
|
-
:form_params => form_params,
|
140
|
-
:body => post_body,
|
141
|
-
:auth_names => auth_names,
|
142
|
-
:return_type => return_type
|
143
|
-
)
|
144
|
-
|
145
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
146
|
-
if @api_client.config.debugging
|
147
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
148
|
-
end
|
149
|
-
return data, status_code, headers
|
150
|
-
end
|
151
|
-
|
152
|
-
# Delete group
|
153
|
-
# @param group_id [String] groupId
|
154
|
-
# @param [Hash] opts the optional parameters
|
155
|
-
# @return [nil]
|
156
|
-
def delete_group(group_id, opts = {})
|
157
|
-
delete_group_with_http_info(group_id, opts)
|
158
|
-
nil
|
159
|
-
end
|
160
|
-
|
161
|
-
# Delete group
|
162
|
-
# @param group_id [String] groupId
|
163
|
-
# @param [Hash] opts the optional parameters
|
164
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
165
|
-
def delete_group_with_http_info(group_id, opts = {})
|
166
|
-
if @api_client.config.debugging
|
167
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.delete_group ...'
|
168
|
-
end
|
169
|
-
# verify the required parameter 'group_id' is set
|
170
|
-
if @api_client.config.client_side_validation && group_id.nil?
|
171
|
-
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.delete_group"
|
172
|
-
end
|
173
|
-
# resource path
|
174
|
-
local_var_path = '/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
175
|
-
|
176
|
-
# query parameters
|
177
|
-
query_params = opts[:query_params] || {}
|
178
|
-
|
179
|
-
# header parameters
|
180
|
-
header_params = opts[:header_params] || {}
|
181
|
-
|
182
|
-
# form parameters
|
183
|
-
form_params = opts[:form_params] || {}
|
184
|
-
|
185
|
-
# http body (model)
|
186
|
-
post_body = opts[:body]
|
187
|
-
|
188
|
-
# return_type
|
189
|
-
return_type = opts[:return_type]
|
190
|
-
|
191
|
-
# auth_names
|
192
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
193
|
-
|
194
|
-
new_options = opts.merge(
|
195
|
-
:header_params => header_params,
|
196
|
-
:query_params => query_params,
|
197
|
-
:form_params => form_params,
|
198
|
-
:body => post_body,
|
199
|
-
:auth_names => auth_names,
|
200
|
-
:return_type => return_type
|
201
|
-
)
|
202
|
-
|
203
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
204
|
-
if @api_client.config.debugging
|
205
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#delete_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
206
|
-
end
|
207
|
-
return data, status_code, headers
|
208
|
-
end
|
209
|
-
|
210
|
-
# Get all Contact Groups in paginated format
|
211
|
-
# @param [Hash] opts the optional parameters
|
212
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
|
213
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
|
214
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
215
|
-
# @return [PageGroupProjection]
|
216
|
-
def get_all_groups(opts = {})
|
217
|
-
data, _status_code, _headers = get_all_groups_with_http_info(opts)
|
218
|
-
data
|
219
|
-
end
|
220
|
-
|
221
|
-
# Get all Contact Groups in paginated format
|
222
|
-
# @param [Hash] opts the optional parameters
|
223
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination
|
224
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination
|
225
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
226
|
-
# @return [Array<(PageGroupProjection, Integer, Hash)>] PageGroupProjection data, response status code and response headers
|
227
|
-
def get_all_groups_with_http_info(opts = {})
|
228
|
-
if @api_client.config.debugging
|
229
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.get_all_groups ...'
|
230
|
-
end
|
231
|
-
allowable_values = ["ASC", "DESC"]
|
232
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
233
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
234
|
-
end
|
235
|
-
# resource path
|
236
|
-
local_var_path = '/groups/paginated'
|
237
|
-
|
238
|
-
# query parameters
|
239
|
-
query_params = opts[:query_params] || {}
|
240
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
241
|
-
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
242
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
243
|
-
|
244
|
-
# header parameters
|
245
|
-
header_params = opts[:header_params] || {}
|
246
|
-
# HTTP header 'Accept' (if needed)
|
247
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
248
|
-
|
249
|
-
# form parameters
|
250
|
-
form_params = opts[:form_params] || {}
|
251
|
-
|
252
|
-
# http body (model)
|
253
|
-
post_body = opts[:body]
|
254
|
-
|
255
|
-
# return_type
|
256
|
-
return_type = opts[:return_type] || 'PageGroupProjection'
|
257
|
-
|
258
|
-
# auth_names
|
259
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
260
|
-
|
261
|
-
new_options = opts.merge(
|
262
|
-
:header_params => header_params,
|
263
|
-
:query_params => query_params,
|
264
|
-
:form_params => form_params,
|
265
|
-
:body => post_body,
|
266
|
-
:auth_names => auth_names,
|
267
|
-
:return_type => return_type
|
268
|
-
)
|
269
|
-
|
270
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
271
|
-
if @api_client.config.debugging
|
272
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#get_all_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
273
|
-
end
|
274
|
-
return data, status_code, headers
|
275
|
-
end
|
276
|
-
|
277
|
-
# Get group
|
278
|
-
# @param group_id [String] groupId
|
279
|
-
# @param [Hash] opts the optional parameters
|
280
|
-
# @return [GroupDto]
|
281
|
-
def get_group(group_id, opts = {})
|
282
|
-
data, _status_code, _headers = get_group_with_http_info(group_id, opts)
|
283
|
-
data
|
284
|
-
end
|
285
|
-
|
286
|
-
# Get group
|
287
|
-
# @param group_id [String] groupId
|
288
|
-
# @param [Hash] opts the optional parameters
|
289
|
-
# @return [Array<(GroupDto, Integer, Hash)>] GroupDto data, response status code and response headers
|
290
|
-
def get_group_with_http_info(group_id, opts = {})
|
291
|
-
if @api_client.config.debugging
|
292
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.get_group ...'
|
293
|
-
end
|
294
|
-
# verify the required parameter 'group_id' is set
|
295
|
-
if @api_client.config.client_side_validation && group_id.nil?
|
296
|
-
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.get_group"
|
297
|
-
end
|
298
|
-
# resource path
|
299
|
-
local_var_path = '/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
300
|
-
|
301
|
-
# query parameters
|
302
|
-
query_params = opts[:query_params] || {}
|
303
|
-
|
304
|
-
# header parameters
|
305
|
-
header_params = opts[:header_params] || {}
|
306
|
-
# HTTP header 'Accept' (if needed)
|
307
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
308
|
-
|
309
|
-
# form parameters
|
310
|
-
form_params = opts[:form_params] || {}
|
311
|
-
|
312
|
-
# http body (model)
|
313
|
-
post_body = opts[:body]
|
314
|
-
|
315
|
-
# return_type
|
316
|
-
return_type = opts[:return_type] || 'GroupDto'
|
317
|
-
|
318
|
-
# auth_names
|
319
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
320
|
-
|
321
|
-
new_options = opts.merge(
|
322
|
-
:header_params => header_params,
|
323
|
-
:query_params => query_params,
|
324
|
-
:form_params => form_params,
|
325
|
-
:body => post_body,
|
326
|
-
:auth_names => auth_names,
|
327
|
-
:return_type => return_type
|
328
|
-
)
|
329
|
-
|
330
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
331
|
-
if @api_client.config.debugging
|
332
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
333
|
-
end
|
334
|
-
return data, status_code, headers
|
335
|
-
end
|
336
|
-
|
337
|
-
# Get group and contacts belonging to it
|
338
|
-
# @param group_id [String] groupId
|
339
|
-
# @param [Hash] opts the optional parameters
|
340
|
-
# @return [GroupContactsDto]
|
341
|
-
def get_group_with_contacts(group_id, opts = {})
|
342
|
-
data, _status_code, _headers = get_group_with_contacts_with_http_info(group_id, opts)
|
343
|
-
data
|
344
|
-
end
|
345
|
-
|
346
|
-
# Get group and contacts belonging to it
|
347
|
-
# @param group_id [String] groupId
|
348
|
-
# @param [Hash] opts the optional parameters
|
349
|
-
# @return [Array<(GroupContactsDto, Integer, Hash)>] GroupContactsDto data, response status code and response headers
|
350
|
-
def get_group_with_contacts_with_http_info(group_id, opts = {})
|
351
|
-
if @api_client.config.debugging
|
352
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.get_group_with_contacts ...'
|
353
|
-
end
|
354
|
-
# verify the required parameter 'group_id' is set
|
355
|
-
if @api_client.config.client_side_validation && group_id.nil?
|
356
|
-
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.get_group_with_contacts"
|
357
|
-
end
|
358
|
-
# resource path
|
359
|
-
local_var_path = '/groups/{groupId}/contacts'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
360
|
-
|
361
|
-
# query parameters
|
362
|
-
query_params = opts[:query_params] || {}
|
363
|
-
|
364
|
-
# header parameters
|
365
|
-
header_params = opts[:header_params] || {}
|
366
|
-
# HTTP header 'Accept' (if needed)
|
367
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
368
|
-
|
369
|
-
# form parameters
|
370
|
-
form_params = opts[:form_params] || {}
|
371
|
-
|
372
|
-
# http body (model)
|
373
|
-
post_body = opts[:body]
|
374
|
-
|
375
|
-
# return_type
|
376
|
-
return_type = opts[:return_type] || 'GroupContactsDto'
|
377
|
-
|
378
|
-
# auth_names
|
379
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
380
|
-
|
381
|
-
new_options = opts.merge(
|
382
|
-
:header_params => header_params,
|
383
|
-
:query_params => query_params,
|
384
|
-
:form_params => form_params,
|
385
|
-
:body => post_body,
|
386
|
-
:auth_names => auth_names,
|
387
|
-
:return_type => return_type
|
388
|
-
)
|
389
|
-
|
390
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
391
|
-
if @api_client.config.debugging
|
392
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#get_group_with_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
393
|
-
end
|
394
|
-
return data, status_code, headers
|
395
|
-
end
|
396
|
-
|
397
|
-
# Get all groups
|
398
|
-
# @param [Hash] opts the optional parameters
|
399
|
-
# @return [Array<GroupProjection>]
|
400
|
-
def get_groups(opts = {})
|
401
|
-
data, _status_code, _headers = get_groups_with_http_info(opts)
|
402
|
-
data
|
403
|
-
end
|
404
|
-
|
405
|
-
# Get all groups
|
406
|
-
# @param [Hash] opts the optional parameters
|
407
|
-
# @return [Array<(Array<GroupProjection>, Integer, Hash)>] Array<GroupProjection> data, response status code and response headers
|
408
|
-
def get_groups_with_http_info(opts = {})
|
409
|
-
if @api_client.config.debugging
|
410
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.get_groups ...'
|
411
|
-
end
|
412
|
-
# resource path
|
413
|
-
local_var_path = '/groups'
|
414
|
-
|
415
|
-
# query parameters
|
416
|
-
query_params = opts[:query_params] || {}
|
417
|
-
|
418
|
-
# header parameters
|
419
|
-
header_params = opts[:header_params] || {}
|
420
|
-
# HTTP header 'Accept' (if needed)
|
421
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
422
|
-
|
423
|
-
# form parameters
|
424
|
-
form_params = opts[:form_params] || {}
|
425
|
-
|
426
|
-
# http body (model)
|
427
|
-
post_body = opts[:body]
|
428
|
-
|
429
|
-
# return_type
|
430
|
-
return_type = opts[:return_type] || 'Array<GroupProjection>'
|
431
|
-
|
432
|
-
# auth_names
|
433
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
434
|
-
|
435
|
-
new_options = opts.merge(
|
436
|
-
:header_params => header_params,
|
437
|
-
:query_params => query_params,
|
438
|
-
:form_params => form_params,
|
439
|
-
:body => post_body,
|
440
|
-
:auth_names => auth_names,
|
441
|
-
:return_type => return_type
|
442
|
-
)
|
443
|
-
|
444
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
445
|
-
if @api_client.config.debugging
|
446
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
447
|
-
end
|
448
|
-
return data, status_code, headers
|
449
|
-
end
|
450
|
-
|
451
|
-
# Remove contacts from a group
|
452
|
-
# @param group_id [String] groupId
|
453
|
-
# @param update_group_contacts_option [UpdateGroupContacts] updateGroupContactsOption
|
454
|
-
# @param [Hash] opts the optional parameters
|
455
|
-
# @return [GroupContactsDto]
|
456
|
-
def remove_contacts_from_group(group_id, update_group_contacts_option, opts = {})
|
457
|
-
data, _status_code, _headers = remove_contacts_from_group_with_http_info(group_id, update_group_contacts_option, opts)
|
458
|
-
data
|
459
|
-
end
|
460
|
-
|
461
|
-
# Remove contacts from a group
|
462
|
-
# @param group_id [String] groupId
|
463
|
-
# @param update_group_contacts_option [UpdateGroupContacts] updateGroupContactsOption
|
464
|
-
# @param [Hash] opts the optional parameters
|
465
|
-
# @return [Array<(GroupContactsDto, Integer, Hash)>] GroupContactsDto data, response status code and response headers
|
466
|
-
def remove_contacts_from_group_with_http_info(group_id, update_group_contacts_option, opts = {})
|
467
|
-
if @api_client.config.debugging
|
468
|
-
@api_client.config.logger.debug 'Calling API: GroupControllerApi.remove_contacts_from_group ...'
|
469
|
-
end
|
470
|
-
# verify the required parameter 'group_id' is set
|
471
|
-
if @api_client.config.client_side_validation && group_id.nil?
|
472
|
-
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.remove_contacts_from_group"
|
473
|
-
end
|
474
|
-
# verify the required parameter 'update_group_contacts_option' is set
|
475
|
-
if @api_client.config.client_side_validation && update_group_contacts_option.nil?
|
476
|
-
fail ArgumentError, "Missing the required parameter 'update_group_contacts_option' when calling GroupControllerApi.remove_contacts_from_group"
|
477
|
-
end
|
478
|
-
# resource path
|
479
|
-
local_var_path = '/groups/{groupId}/contacts'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))
|
480
|
-
|
481
|
-
# query parameters
|
482
|
-
query_params = opts[:query_params] || {}
|
483
|
-
|
484
|
-
# header parameters
|
485
|
-
header_params = opts[:header_params] || {}
|
486
|
-
# HTTP header 'Accept' (if needed)
|
487
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
488
|
-
# HTTP header 'Content-Type'
|
489
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
490
|
-
|
491
|
-
# form parameters
|
492
|
-
form_params = opts[:form_params] || {}
|
493
|
-
|
494
|
-
# http body (model)
|
495
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_group_contacts_option)
|
496
|
-
|
497
|
-
# return_type
|
498
|
-
return_type = opts[:return_type] || 'GroupContactsDto'
|
499
|
-
|
500
|
-
# auth_names
|
501
|
-
auth_names = opts[:auth_names] || ['API_KEY']
|
502
|
-
|
503
|
-
new_options = opts.merge(
|
504
|
-
:header_params => header_params,
|
505
|
-
:query_params => query_params,
|
506
|
-
:form_params => form_params,
|
507
|
-
:body => post_body,
|
508
|
-
:auth_names => auth_names,
|
509
|
-
:return_type => return_type
|
510
|
-
)
|
511
|
-
|
512
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
513
|
-
if @api_client.config.debugging
|
514
|
-
@api_client.config.logger.debug "API called: GroupControllerApi#remove_contacts_from_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
515
|
-
end
|
516
|
-
return data, status_code, headers
|
517
|
-
end
|
518
|
-
end
|
519
|
-
end
|