mailslurp_client 7.0.7 → 8.0.1
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 +19 -3
- metadata +14 -345
- data/Gemfile +0 -9
- data/LICENSE +0 -22
- data/README.md +0 -226
- data/Rakefile +0 -10
- data/docs/AttachmentControllerApi.md +0 -124
- 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 -167
- data/docs/ContactControllerApi.md +0 -274
- data/docs/ContactDto.md +0 -31
- data/docs/ContactProjection.md +0 -27
- data/docs/CreateContactOptions.md +0 -31
- data/docs/CreateDomainOptions.md +0 -17
- data/docs/CreateGroupOptions.md +0 -19
- 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/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 -652
- 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/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/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/attachment_controller_api.rb +0 -157
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -201
- 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/group_controller_api.rb +0 -519
- data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -763
- 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 -253
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -224
- 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_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_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 -243
- data/lib/mailslurp_client/models/email_preview.rb +0 -286
- data/lib/mailslurp_client/models/email_projection.rb +0 -306
- data/lib/mailslurp_client/models/forward_email_options.rb +0 -245
- 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/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/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 -225
- data/lib/mailslurp_client/models/validation_message.rb +0 -220
- data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -315
- 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/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/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_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_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/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/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,172 +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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::InboxControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'InboxControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::InboxControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of InboxControllerApi' do
|
30
|
-
it 'should create an instance of InboxControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::InboxControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for create_inbox
|
36
|
-
# Create an Inbox (email address)
|
37
|
-
# Create a new inbox and with a ranmdomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [String] :description Optional description for an inbox.
|
40
|
-
# @option opts [String] :email_address Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or `createDomain` method.
|
41
|
-
# @option opts [DateTime] :expires_at Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates
|
42
|
-
# @option opts [Boolean] :favourite Is inbox favourited.
|
43
|
-
# @option opts [String] :name Optional name for an inbox.
|
44
|
-
# @option opts [Array<String>] :tags Optional tags for an inbox. Can be used for searching and filtering inboxes.
|
45
|
-
# @return [Inbox]
|
46
|
-
describe 'create_inbox test' do
|
47
|
-
it 'should work' do
|
48
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
-
end
|
50
|
-
end
|
51
|
-
|
52
|
-
# unit tests for delete_all_inboxes
|
53
|
-
# Delete all inboxes
|
54
|
-
# Permanently delete all inboxes and associated email addresses and all emails within the given inboxes
|
55
|
-
# @param [Hash] opts the optional parameters
|
56
|
-
# @return [nil]
|
57
|
-
describe 'delete_all_inboxes test' do
|
58
|
-
it 'should work' do
|
59
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
60
|
-
end
|
61
|
-
end
|
62
|
-
|
63
|
-
# unit tests for delete_inbox
|
64
|
-
# Delete Inbox / Email Address
|
65
|
-
# Permanently delete an inbox and associated email address and all emails within the given inboxes
|
66
|
-
# @param inbox_id inboxId
|
67
|
-
# @param [Hash] opts the optional parameters
|
68
|
-
# @return [nil]
|
69
|
-
describe 'delete_inbox test' do
|
70
|
-
it 'should work' do
|
71
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
72
|
-
end
|
73
|
-
end
|
74
|
-
|
75
|
-
# unit tests for get_all_inboxes
|
76
|
-
# List Inboxes Paginated
|
77
|
-
# List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
|
78
|
-
# @param [Hash] opts the optional parameters
|
79
|
-
# @option opts [Boolean] :favourite Optionally filter results for favourites only
|
80
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination
|
81
|
-
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
82
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination
|
83
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
84
|
-
# @return [PageInboxProjection]
|
85
|
-
describe 'get_all_inboxes test' do
|
86
|
-
it 'should work' do
|
87
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
88
|
-
end
|
89
|
-
end
|
90
|
-
|
91
|
-
# unit tests for get_emails
|
92
|
-
# Get emails in an Inbox
|
93
|
-
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
94
|
-
# @param inbox_id Id of inbox that emails belongs to
|
95
|
-
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction
|
97
|
-
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
98
|
-
# @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
|
99
|
-
# @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
|
100
|
-
# @option opts [String] :sort Sort the results by received date and direction ASC or DESC
|
101
|
-
# @return [Array<EmailPreview>]
|
102
|
-
describe 'get_emails test' do
|
103
|
-
it 'should work' do
|
104
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
105
|
-
end
|
106
|
-
end
|
107
|
-
|
108
|
-
# unit tests for get_inbox
|
109
|
-
# Get Inbox / EmailAddress
|
110
|
-
# Returns an inbox's properties, including its email address and ID.
|
111
|
-
# @param inbox_id inboxId
|
112
|
-
# @param [Hash] opts the optional parameters
|
113
|
-
# @return [Inbox]
|
114
|
-
describe 'get_inbox test' do
|
115
|
-
it 'should work' do
|
116
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
117
|
-
end
|
118
|
-
end
|
119
|
-
|
120
|
-
# unit tests for get_inbox_emails_paginated
|
121
|
-
# Get inbox emails paginated
|
122
|
-
# Get a paginated list of emails in an inbox. Does not hold connections open.
|
123
|
-
# @param inbox_id Id of inbox that emails belongs to
|
124
|
-
# @param [Hash] opts the optional parameters
|
125
|
-
# @option opts [Integer] :page Optional page index in inbox emails list pagination
|
126
|
-
# @option opts [Integer] :size Optional page size in inbox emails list pagination
|
127
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
128
|
-
# @return [PageEmailPreview]
|
129
|
-
describe 'get_inbox_emails_paginated test' do
|
130
|
-
it 'should work' do
|
131
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
132
|
-
end
|
133
|
-
end
|
134
|
-
|
135
|
-
# unit tests for get_inboxes
|
136
|
-
# List Inboxes / Email Addresses
|
137
|
-
# List the inboxes you have created
|
138
|
-
# @param [Hash] opts the optional parameters
|
139
|
-
# @return [Array<Inbox>]
|
140
|
-
describe 'get_inboxes test' do
|
141
|
-
it 'should work' do
|
142
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
143
|
-
end
|
144
|
-
end
|
145
|
-
|
146
|
-
# unit tests for send_email
|
147
|
-
# Send Email
|
148
|
-
# Send an email from the inbox's email address. Specify the email recipients and contents in the request body. See the `SendEmailOptions` for more information. Note the `inboxId` refers to the inbox's id NOT its email address
|
149
|
-
# @param inbox_id ID of the inbox you want to send the email from
|
150
|
-
# @param [Hash] opts the optional parameters
|
151
|
-
# @option opts [SendEmailOptions] :send_email_options Options for the email
|
152
|
-
# @return [nil]
|
153
|
-
describe 'send_email test' do
|
154
|
-
it 'should work' do
|
155
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
156
|
-
end
|
157
|
-
end
|
158
|
-
|
159
|
-
# unit tests for set_inbox_favourited
|
160
|
-
# Set inbox favourited state
|
161
|
-
# Set and return new favourite state for an inbox
|
162
|
-
# @param inbox_id inboxId
|
163
|
-
# @param set_inbox_favourited_options setInboxFavouritedOptions
|
164
|
-
# @param [Hash] opts the optional parameters
|
165
|
-
# @return [Inbox]
|
166
|
-
describe 'set_inbox_favourited test' do
|
167
|
-
it 'should work' do
|
168
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
169
|
-
end
|
170
|
-
end
|
171
|
-
|
172
|
-
end
|
@@ -1,91 +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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::TemplateControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'TemplateControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::TemplateControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of TemplateControllerApi' do
|
30
|
-
it 'should create an instance of TemplateControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::TemplateControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for create_template
|
36
|
-
# Create a Template
|
37
|
-
# @param create_template_options createTemplateOptions
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @return [TemplateDto]
|
40
|
-
describe 'create_template test' do
|
41
|
-
it 'should work' do
|
42
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
-
end
|
44
|
-
end
|
45
|
-
|
46
|
-
# unit tests for delete_template
|
47
|
-
# Delete Template
|
48
|
-
# @param template_id TemplateId
|
49
|
-
# @param [Hash] opts the optional parameters
|
50
|
-
# @return [nil]
|
51
|
-
describe 'delete_template test' do
|
52
|
-
it 'should work' do
|
53
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
54
|
-
end
|
55
|
-
end
|
56
|
-
|
57
|
-
# unit tests for get_all_templates
|
58
|
-
# Get all Templates in paginated format
|
59
|
-
# @param [Hash] opts the optional parameters
|
60
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination
|
61
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination
|
62
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
63
|
-
# @return [PageTemplateProjection]
|
64
|
-
describe 'get_all_templates test' do
|
65
|
-
it 'should work' do
|
66
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
67
|
-
end
|
68
|
-
end
|
69
|
-
|
70
|
-
# unit tests for get_template
|
71
|
-
# Get Template
|
72
|
-
# @param template_id TemplateId
|
73
|
-
# @param [Hash] opts the optional parameters
|
74
|
-
# @return [TemplateDto]
|
75
|
-
describe 'get_template test' do
|
76
|
-
it 'should work' do
|
77
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
78
|
-
end
|
79
|
-
end
|
80
|
-
|
81
|
-
# unit tests for get_templates
|
82
|
-
# Get all Templates
|
83
|
-
# @param [Hash] opts the optional parameters
|
84
|
-
# @return [Array<TemplateProjection>]
|
85
|
-
describe 'get_templates test' do
|
86
|
-
it 'should work' do
|
87
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
88
|
-
end
|
89
|
-
end
|
90
|
-
|
91
|
-
end
|
@@ -1,107 +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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::WaitForControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'WaitForControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::WaitForControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of WaitForControllerApi' do
|
30
|
-
it 'should create an instance of WaitForControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::WaitForControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for wait_for
|
36
|
-
# Wait for conditions to be met
|
37
|
-
# Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
|
40
|
-
# @return [Array<EmailPreview>]
|
41
|
-
describe 'wait_for test' do
|
42
|
-
it 'should work' do
|
43
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
-
end
|
45
|
-
end
|
46
|
-
|
47
|
-
# unit tests for wait_for_email_count
|
48
|
-
# Wait for and return count number of emails
|
49
|
-
# If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
|
50
|
-
# @param [Hash] opts the optional parameters
|
51
|
-
# @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
|
52
|
-
# @option opts [String] :inbox_id Id of the inbox we are fetching emails from
|
53
|
-
# @option opts [Integer] :timeout Max milliseconds to wait
|
54
|
-
# @option opts [Boolean] :unread_only Optional filter for unread only
|
55
|
-
# @return [Array<EmailPreview>]
|
56
|
-
describe 'wait_for_email_count test' do
|
57
|
-
it 'should work' do
|
58
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
59
|
-
end
|
60
|
-
end
|
61
|
-
|
62
|
-
# unit tests for wait_for_latest_email
|
63
|
-
# Fetch inbox's latest email or if empty wait for an email to arrive
|
64
|
-
# Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox see the other receive methods such as waitForNthEmail or waitForEmailCount.
|
65
|
-
# @param [Hash] opts the optional parameters
|
66
|
-
# @option opts [String] :inbox_id Id of the inbox we are fetching emails from
|
67
|
-
# @option opts [Integer] :timeout Max milliseconds to wait
|
68
|
-
# @option opts [Boolean] :unread_only Optional filter for unread only
|
69
|
-
# @return [Email]
|
70
|
-
describe 'wait_for_latest_email test' do
|
71
|
-
it 'should work' do
|
72
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
73
|
-
end
|
74
|
-
end
|
75
|
-
|
76
|
-
# unit tests for wait_for_matching_email
|
77
|
-
# Wait or return list of emails that match simple matching patterns
|
78
|
-
# Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options.
|
79
|
-
# @param match_options matchOptions
|
80
|
-
# @param [Hash] opts the optional parameters
|
81
|
-
# @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
|
82
|
-
# @option opts [String] :inbox_id Id of the inbox we are fetching emails from
|
83
|
-
# @option opts [Integer] :timeout Max milliseconds to wait
|
84
|
-
# @option opts [Boolean] :unread_only Optional filter for unread only
|
85
|
-
# @return [Array<EmailPreview>]
|
86
|
-
describe 'wait_for_matching_email test' do
|
87
|
-
it 'should work' do
|
88
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
89
|
-
end
|
90
|
-
end
|
91
|
-
|
92
|
-
# unit tests for wait_for_nth_email
|
93
|
-
# Wait for or fetch the email with a given index in the inbox specified
|
94
|
-
# If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
|
95
|
-
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [String] :inbox_id Id of the inbox you are fetching emails from
|
97
|
-
# @option opts [Integer] :index Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1
|
98
|
-
# @option opts [Integer] :timeout Max milliseconds to wait for the nth email if not already present
|
99
|
-
# @option opts [Boolean] :unread_only Optional filter for unread only
|
100
|
-
# @return [Email]
|
101
|
-
describe 'wait_for_nth_email test' do
|
102
|
-
it 'should work' do
|
103
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
104
|
-
end
|
105
|
-
end
|
106
|
-
|
107
|
-
end
|
@@ -1,107 +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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::WebhookControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'WebhookControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::WebhookControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of WebhookControllerApi' do
|
30
|
-
it 'should create an instance of WebhookControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::WebhookControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for create_webhook
|
36
|
-
# Attach a WebHook URL to an inbox
|
37
|
-
# Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
|
38
|
-
# @param inbox_id inboxId
|
39
|
-
# @param webhook_options webhookOptions
|
40
|
-
# @param [Hash] opts the optional parameters
|
41
|
-
# @return [WebhookDto]
|
42
|
-
describe 'create_webhook test' do
|
43
|
-
it 'should work' do
|
44
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
-
end
|
46
|
-
end
|
47
|
-
|
48
|
-
# unit tests for delete_webhook
|
49
|
-
# Delete and disable a Webhook for an Inbox
|
50
|
-
# @param inbox_id inboxId
|
51
|
-
# @param webhook_id webhookId
|
52
|
-
# @param [Hash] opts the optional parameters
|
53
|
-
# @return [nil]
|
54
|
-
describe 'delete_webhook test' do
|
55
|
-
it 'should work' do
|
56
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
57
|
-
end
|
58
|
-
end
|
59
|
-
|
60
|
-
# unit tests for get_all_webhooks
|
61
|
-
# List Webhooks Paginated
|
62
|
-
# List webhooks in paginated form. Allows for page index, page size, and sort direction.
|
63
|
-
# @param [Hash] opts the optional parameters
|
64
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination
|
65
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination
|
66
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
67
|
-
# @return [PageWebhookProjection]
|
68
|
-
describe 'get_all_webhooks test' do
|
69
|
-
it 'should work' do
|
70
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
-
end
|
72
|
-
end
|
73
|
-
|
74
|
-
# unit tests for get_webhook
|
75
|
-
# Get a webhook for an Inbox
|
76
|
-
# @param webhook_id webhookId
|
77
|
-
# @param [Hash] opts the optional parameters
|
78
|
-
# @return [WebhookDto]
|
79
|
-
describe 'get_webhook test' do
|
80
|
-
it 'should work' do
|
81
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
82
|
-
end
|
83
|
-
end
|
84
|
-
|
85
|
-
# unit tests for get_webhooks
|
86
|
-
# Get all Webhooks for an Inbox
|
87
|
-
# @param inbox_id inboxId
|
88
|
-
# @param [Hash] opts the optional parameters
|
89
|
-
# @return [Array<WebhookDto>]
|
90
|
-
describe 'get_webhooks test' do
|
91
|
-
it 'should work' do
|
92
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
93
|
-
end
|
94
|
-
end
|
95
|
-
|
96
|
-
# unit tests for send_test_data
|
97
|
-
# Send webhook test data
|
98
|
-
# @param webhook_id webhookId
|
99
|
-
# @param [Hash] opts the optional parameters
|
100
|
-
# @return [WebhookTestResult]
|
101
|
-
describe 'send_test_data test' do
|
102
|
-
it 'should work' do
|
103
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
104
|
-
end
|
105
|
-
end
|
106
|
-
|
107
|
-
end
|