mailslurp_client 11.9.0 → 11.9.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a71ed75df545930dc62b3579bc134fa293d36c746fcd4471a738c1a2c1f29bcf
4
- data.tar.gz: 416cd46b4cffb6f3a61fbd9fdc5543800c62670a68652621674ae450f5428daf
3
+ metadata.gz: 5a7170ea201d4a298ba5b6b0849e258ae06e38805e56882f7b478debd341745d
4
+ data.tar.gz: 5fe4ccf57eaf5e65a1291b3c0714c094e512c6d1599f6190ad4dae787b86c845
5
5
  SHA512:
6
- metadata.gz: '069aca4edc0db8dc46187d2796ba0a012b4f4c6ee6b684188147ebbf037ddab7362224db8512084cd13e4fe975aee83ec78c6bf897134ca265e276a9b1846cf5'
7
- data.tar.gz: 0e65f158ed5b1bb606cf50b31736768109d836ceca535bee7552e038e8fcbca20aef2c6d06c21f78d64836b454a78559d72af3e6cb2af54c12eecf6c90591263
6
+ metadata.gz: d8e43add6138188ae58691f6c8607e2c2a91efd2308579918473d12a912ac6f34d482dd2786daa21b840880774d2fe75cec5f99583742cddc6d84fa2d5fe4442
7
+ data.tar.gz: edcc020a32184faf3452069aeb18df5be485d7ff366a007ccc85b511e0cf9dea5510d9e2da72edbecc7afc1293e5bfd45b9751ef3732396957870d51660ccfb2
@@ -19,7 +19,7 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get email attachment as base64 encoded string (alternative to binary responses). To read the content decode the Base64 encoded contents.
22
+ # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
23
23
  # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
24
24
  # @param attachment_id [String] ID of attachment
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module MailSlurpClient
29
29
  data
30
30
  end
31
31
 
32
- # Get email attachment as base64 encoded string (alternative to binary responses). To read the content decode the Base64 encoded contents.
32
+ # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
33
33
  # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
34
34
  # @param attachment_id [String] ID of attachment
35
35
  # @param [Hash] opts the optional parameters
@@ -19,7 +19,7 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete all emails
22
+ # Delete all emails in all inboxes.
23
23
  # Deletes all emails in your account. Be careful as emails cannot be recovered
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [nil]
@@ -28,7 +28,7 @@ module MailSlurpClient
28
28
  nil
29
29
  end
30
30
 
31
- # Delete all emails
31
+ # Delete all emails in all inboxes.
32
32
  # Deletes all emails in your account. Be careful as emails cannot be recovered
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -133,7 +133,7 @@ module MailSlurpClient
133
133
  return data, status_code, headers
134
134
  end
135
135
 
136
- # Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
136
+ # Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
137
137
  # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
138
138
  # @param attachment_id [String] ID of attachment
139
139
  # @param email_id [String] ID of email
@@ -145,7 +145,7 @@ module MailSlurpClient
145
145
  data
146
146
  end
147
147
 
148
- # Get email attachment bytes. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints.
148
+ # Get email attachment bytes. Returned as &#x60;octet-stream&#x60; with content type header. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints and convert the base 64 encoded content to a file or string.
149
149
  # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
150
150
  # @param attachment_id [String] ID of attachment
151
151
  # @param email_id [String] ID of email
@@ -204,7 +204,7 @@ module MailSlurpClient
204
204
  return data, status_code, headers
205
205
  end
206
206
 
207
- # Get email attachment as base64 encoded string (alternative to binary responses)
207
+ # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
208
208
  # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
209
209
  # @param attachment_id [String] ID of attachment
210
210
  # @param email_id [String] ID of email
@@ -215,7 +215,7 @@ module MailSlurpClient
215
215
  data
216
216
  end
217
217
 
218
- # Get email attachment as base64 encoded string (alternative to binary responses)
218
+ # Get email attachment as base64 encoded string alternative to binary responses. Decode the &#x60;base64FileContents&#x60; as a &#x60;utf-8&#x60; encoded string or array of bytes depending on the &#x60;contentType&#x60;.
219
219
  # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the &#x60;downloadAttachment&#x60; method but allows some clients to get around issues with binary responses.
220
220
  # @param attachment_id [String] ID of attachment
221
221
  # @param email_id [String] ID of email
@@ -272,7 +272,7 @@ module MailSlurpClient
272
272
  return data, status_code, headers
273
273
  end
274
274
 
275
- # Forward email
275
+ # Forward email to recipients
276
276
  # Forward an existing email to new recipients.
277
277
  # @param email_id [String] ID of email
278
278
  # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
@@ -283,7 +283,7 @@ module MailSlurpClient
283
283
  nil
284
284
  end
285
285
 
286
- # Forward email
286
+ # Forward email to recipients
287
287
  # Forward an existing email to new recipients.
288
288
  # @param email_id [String] ID of email
289
289
  # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
@@ -340,7 +340,7 @@ module MailSlurpClient
340
340
  return data, status_code, headers
341
341
  end
342
342
 
343
- # Get email attachment metadata
343
+ # Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
344
344
  # Returns the metadata such as name and content-type for a given attachment and email.
345
345
  # @param attachment_id [String] ID of attachment
346
346
  # @param email_id [String] ID of email
@@ -351,7 +351,7 @@ module MailSlurpClient
351
351
  data
352
352
  end
353
353
 
354
- # Get email attachment metadata
354
+ # Get email attachment metadata. This is the &#x60;contentType&#x60; and &#x60;contentLength&#x60; of an attachment. To get the individual attachments use the &#x60;downloadAttachment&#x60; methods.
355
355
  # Returns the metadata such as name and content-type for a given attachment and email.
356
356
  # @param attachment_id [String] ID of attachment
357
357
  # @param email_id [String] ID of email
@@ -408,7 +408,7 @@ module MailSlurpClient
408
408
  return data, status_code, headers
409
409
  end
410
410
 
411
- # Get all email attachment metadata
411
+ # Get all email attachment metadata. Metadata includes name and attachment size.
412
412
  # Returns an array of attachment metadata such as name and content-type for a given email if present.
413
413
  # @param email_id [String] ID of email
414
414
  # @param [Hash] opts the optional parameters
@@ -418,7 +418,7 @@ module MailSlurpClient
418
418
  data
419
419
  end
420
420
 
421
- # Get all email attachment metadata
421
+ # Get all email attachment metadata. Metadata includes name and attachment size.
422
422
  # Returns an array of attachment metadata such as name and content-type for a given email if present.
423
423
  # @param email_id [String] ID of email
424
424
  # @param [Hash] opts the optional parameters
@@ -605,7 +605,7 @@ module MailSlurpClient
605
605
  return data, status_code, headers
606
606
  end
607
607
 
608
- # Get email content as HTML
608
+ # Get email content as HTML. For displaying emails in browser context.
609
609
  # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
610
610
  # @param email_id [String] emailId
611
611
  # @param [Hash] opts the optional parameters
@@ -616,7 +616,7 @@ module MailSlurpClient
616
616
  data
617
617
  end
618
618
 
619
- # Get email content as HTML
619
+ # Get email content as HTML. For displaying emails in browser context.
620
620
  # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: &#x60;?apiKey&#x3D;xxx&#x60;
621
621
  # @param email_id [String] emailId
622
622
  # @param [Hash] opts the optional parameters
@@ -878,7 +878,7 @@ module MailSlurpClient
878
878
  return data, status_code, headers
879
879
  end
880
880
 
881
- # Get latest email
881
+ # Get latest email in all inboxes. Most recently received.
882
882
  # Get the newest email in all inboxes or in a passed set of inbox IDs
883
883
  # @param [Hash] opts the optional parameters
884
884
  # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
@@ -888,7 +888,7 @@ module MailSlurpClient
888
888
  data
889
889
  end
890
890
 
891
- # Get latest email
891
+ # Get latest email in all inboxes. Most recently received.
892
892
  # Get the newest email in all inboxes or in a passed set of inbox IDs
893
893
  # @param [Hash] opts the optional parameters
894
894
  # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
@@ -937,7 +937,7 @@ module MailSlurpClient
937
937
  return data, status_code, headers
938
938
  end
939
939
 
940
- # Get latest email
940
+ # Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
941
941
  # Get the newest email in all inboxes or in a passed set of inbox IDs
942
942
  # @param [Hash] opts the optional parameters
943
943
  # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
@@ -947,7 +947,7 @@ module MailSlurpClient
947
947
  data
948
948
  end
949
949
 
950
- # Get latest email
950
+ # Get latest email in an inbox. Use &#x60;WaitForController&#x60; to get emails that may not have arrived yet.
951
951
  # Get the newest email in all inboxes or in a passed set of inbox IDs
952
952
  # @param [Hash] opts the optional parameters
953
953
  # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
@@ -1071,7 +1071,7 @@ module MailSlurpClient
1071
1071
  return data, status_code, headers
1072
1072
  end
1073
1073
 
1074
- # Get raw email string
1074
+ # Get raw email string. Returns unparsed raw SMTP message with headers and body.
1075
1075
  # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
1076
1076
  # @param email_id [String] ID of email
1077
1077
  # @param [Hash] opts the optional parameters
@@ -1081,7 +1081,7 @@ module MailSlurpClient
1081
1081
  data
1082
1082
  end
1083
1083
 
1084
- # Get raw email string
1084
+ # Get raw email string. Returns unparsed raw SMTP message with headers and body.
1085
1085
  # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
1086
1086
  # @param email_id [String] ID of email
1087
1087
  # @param [Hash] opts the optional parameters
@@ -1133,7 +1133,7 @@ module MailSlurpClient
1133
1133
  return data, status_code, headers
1134
1134
  end
1135
1135
 
1136
- # Get raw email in JSON
1136
+ # Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
1137
1137
  # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
1138
1138
  # @param email_id [String] ID of email
1139
1139
  # @param [Hash] opts the optional parameters
@@ -1143,7 +1143,7 @@ module MailSlurpClient
1143
1143
  data
1144
1144
  end
1145
1145
 
1146
- # Get raw email in JSON
1146
+ # Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
1147
1147
  # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
1148
1148
  # @param email_id [String] ID of email
1149
1149
  # @param [Hash] opts the optional parameters
@@ -1321,7 +1321,7 @@ module MailSlurpClient
1321
1321
  return data, status_code, headers
1322
1322
  end
1323
1323
 
1324
- # Validate email
1324
+ # Validate email HTML contents
1325
1325
  # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
1326
1326
  # @param email_id [String] ID of email
1327
1327
  # @param [Hash] opts the optional parameters
@@ -1331,7 +1331,7 @@ module MailSlurpClient
1331
1331
  data
1332
1332
  end
1333
1333
 
1334
- # Validate email
1334
+ # Validate email HTML contents
1335
1335
  # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
1336
1336
  # @param email_id [String] ID of email
1337
1337
  # @param [Hash] opts the optional parameters
@@ -19,7 +19,7 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create an Inbox (email address)
22
+ # Create an inbox email address. An inbox has a real email address and can send and receive emails.
23
23
  # Create a new inbox and with a randomized 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.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
@@ -37,7 +37,7 @@ module MailSlurpClient
37
37
  data
38
38
  end
39
39
 
40
- # Create an Inbox (email address)
40
+ # Create an inbox email address. An inbox has a real email address and can send and receive emails.
41
41
  # Create a new inbox and with a randomized 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.
42
42
  # @param [Hash] opts the optional parameters
43
43
  # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
@@ -102,7 +102,61 @@ module MailSlurpClient
102
102
  return data, status_code, headers
103
103
  end
104
104
 
105
- # Create an inbox with additional options
105
+ # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
106
+ # @param [Hash] opts the optional parameters
107
+ # @return [Inbox]
108
+ def create_inbox_with_defaults(opts = {})
109
+ data, _status_code, _headers = create_inbox_with_defaults_with_http_info(opts)
110
+ data
111
+ end
112
+
113
+ # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
114
+ # @param [Hash] opts the optional parameters
115
+ # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
116
+ def create_inbox_with_defaults_with_http_info(opts = {})
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_defaults ...'
119
+ end
120
+ # resource path
121
+ local_var_path = '/inboxes/withDefaults'
122
+
123
+ # query parameters
124
+ query_params = opts[:query_params] || {}
125
+
126
+ # header parameters
127
+ header_params = opts[:header_params] || {}
128
+ # HTTP header 'Accept' (if needed)
129
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
130
+
131
+ # form parameters
132
+ form_params = opts[:form_params] || {}
133
+
134
+ # http body (model)
135
+ post_body = opts[:body]
136
+
137
+ # return_type
138
+ return_type = opts[:return_type] || 'Inbox'
139
+
140
+ # auth_names
141
+ auth_names = opts[:auth_names] || ['API_KEY']
142
+
143
+ new_options = opts.merge(
144
+ :header_params => header_params,
145
+ :query_params => query_params,
146
+ :form_params => form_params,
147
+ :body => post_body,
148
+ :auth_names => auth_names,
149
+ :return_type => return_type
150
+ )
151
+
152
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox_with_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
155
+ end
156
+ return data, status_code, headers
157
+ end
158
+
159
+ # Create an inbox with options. Extended options for inbox creation.
106
160
  # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
107
161
  # @param create_inbox_dto [CreateInboxDto] createInboxDto
108
162
  # @param [Hash] opts the optional parameters
@@ -112,7 +166,7 @@ module MailSlurpClient
112
166
  data
113
167
  end
114
168
 
115
- # Create an inbox with additional options
169
+ # Create an inbox with options. Extended options for inbox creation.
116
170
  # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
117
171
  # @param create_inbox_dto [CreateInboxDto] createInboxDto
118
172
  # @param [Hash] opts the optional parameters
@@ -445,7 +499,7 @@ module MailSlurpClient
445
499
  return data, status_code, headers
446
500
  end
447
501
 
448
- # Get Inbox
502
+ # Get Inbox. Returns properties of an inbox.
449
503
  # Returns an inbox's properties, including its email address and ID.
450
504
  # @param inbox_id [String] inboxId
451
505
  # @param [Hash] opts the optional parameters
@@ -455,7 +509,7 @@ module MailSlurpClient
455
509
  data
456
510
  end
457
511
 
458
- # Get Inbox
512
+ # Get Inbox. Returns properties of an inbox.
459
513
  # Returns an inbox&#39;s properties, including its email address and ID.
460
514
  # @param inbox_id [String] inboxId
461
515
  # @param [Hash] opts the optional parameters
@@ -713,7 +767,7 @@ module MailSlurpClient
713
767
  return data, status_code, headers
714
768
  end
715
769
 
716
- # List Inboxes / Email Addresses
770
+ # List Inboxes and email eddresses
717
771
  # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended. You can provide a limit and sort parameter.
718
772
  # @param [Hash] opts the optional parameters
719
773
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
@@ -724,7 +778,7 @@ module MailSlurpClient
724
778
  data
725
779
  end
726
780
 
727
- # List Inboxes / Email Addresses
781
+ # List Inboxes and email eddresses
728
782
  # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended. You can provide a limit and sort parameter.
729
783
  # @param [Hash] opts the optional parameters
730
784
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
@@ -913,7 +967,7 @@ module MailSlurpClient
913
967
  end
914
968
 
915
969
  # Send email and return sent confirmation
916
- # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
970
+ # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
917
971
  # @param inbox_id [String] ID of the inbox you want to send the email from
918
972
  # @param [Hash] opts the optional parameters
919
973
  # @option opts [SendEmailOptions] :send_email_options Options for the email
@@ -924,7 +978,7 @@ module MailSlurpClient
924
978
  end
925
979
 
926
980
  # Send email and return sent confirmation
927
- # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with link the the sent object created for it.
981
+ # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with a link to the sent object created for it.
928
982
  # @param inbox_id [String] ID of the inbox you want to send the email from
929
983
  # @param [Hash] opts the optional parameters
930
984
  # @option opts [SendEmailOptions] :send_email_options Options for the email
@@ -1048,7 +1102,7 @@ module MailSlurpClient
1048
1102
  return data, status_code, headers
1049
1103
  end
1050
1104
 
1051
- # Update Inbox
1105
+ # Update Inbox. Change name and description. Email address is not editable.
1052
1106
  # Update editable fields on an inbox
1053
1107
  # @param inbox_id [String] inboxId
1054
1108
  # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions
@@ -1059,7 +1113,7 @@ module MailSlurpClient
1059
1113
  data
1060
1114
  end
1061
1115
 
1062
- # Update Inbox
1116
+ # Update Inbox. Change name and description. Email address is not editable.
1063
1117
  # Update editable fields on an inbox
1064
1118
  # @param inbox_id [String] inboxId
1065
1119
  # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions
@@ -19,20 +19,20 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Wait for conditions to be met
22
+ # Wait for an email to match the provided filter conditions such as subject contains keyword.
23
23
  # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
25
+ # @option opts [WaitForConditions] :wait_for_conditions Conditions to apply to emails that you are waiting for
26
26
  # @return [Array<EmailPreview>]
27
27
  def wait_for(opts = {})
28
28
  data, _status_code, _headers = wait_for_with_http_info(opts)
29
29
  data
30
30
  end
31
31
 
32
- # Wait for conditions to be met
32
+ # Wait for an email to match the provided filter conditions such as subject contains keyword.
33
33
  # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
34
34
  # @param [Hash] opts the optional parameters
35
- # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
35
+ # @option opts [WaitForConditions] :wait_for_conditions Conditions to apply to emails that you are waiting for
36
36
  # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
37
37
  def wait_for_with_http_info(opts = {})
38
38
  if @api_client.config.debugging
@@ -79,7 +79,7 @@ module MailSlurpClient
79
79
  return data, status_code, headers
80
80
  end
81
81
 
82
- # Wait for and return count number of emails
82
+ # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
83
83
  # 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.
84
84
  # @param [Hash] opts the optional parameters
85
85
  # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -92,7 +92,7 @@ module MailSlurpClient
92
92
  data
93
93
  end
94
94
 
95
- # Wait for and return count number of emails
95
+ # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
96
96
  # 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.
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -361,7 +361,7 @@ module MailSlurpClient
361
361
  return data, status_code, headers
362
362
  end
363
363
 
364
- # Wait for or fetch the email with a given index in the inbox specified
364
+ # Wait for or fetch the email with a given index in the inbox specified. IF indx doesn't exist waits for it to exist or timeout to occur.
365
365
  # 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.
366
366
  # @param [Hash] opts the optional parameters
367
367
  # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
@@ -374,7 +374,7 @@ module MailSlurpClient
374
374
  data
375
375
  end
376
376
 
377
- # Wait for or fetch the email with a given index in the inbox specified
377
+ # Wait for or fetch the email with a given index in the inbox specified. IF indx doesn&#39;t exist waits for it to exist or timeout to occur.
378
378
  # 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.
379
379
  # @param [Hash] opts the optional parameters
380
380
  # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
13
13
  require 'date'
14
14
 
15
15
  module MailSlurpClient
16
- # Email model (also referred to as EmailDto). Represents an email that was received by an inbox. If you want the original SMTP message see the `getRawEmail` endpoint.
16
+ # Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The `body` contains the email content. If you want the original SMTP message see the `getRawEmail` endpoints. The attachments can be fetched using the AttachmentController
17
17
  class Email
18
18
  attr_accessor :analysis
19
19
 
@@ -41,21 +41,22 @@ module MailSlurpClient
41
41
  # Who the email was sent from
42
42
  attr_accessor :from
43
43
 
44
+ # Collection of SMTP headers attached to email
44
45
  attr_accessor :headers
45
46
 
46
- # ID of the email
47
+ # ID of the email entity
47
48
  attr_accessor :id
48
49
 
49
50
  # ID of the inbox that received the email
50
51
  attr_accessor :inbox_id
51
52
 
52
- # Was HTML sent in the email body
53
+ # Is the email body HTML
53
54
  attr_accessor :is_html
54
55
 
55
- # Has the email been viewed ever. This means viewed in the dashboard or requested via the full email entity endpoints
56
+ # Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.
56
57
  attr_accessor :read
57
58
 
58
- # The replyTo field on the received email
59
+ # The `replyTo` field on the received email message
59
60
  attr_accessor :reply_to
60
61
 
61
62
  # The subject line of the email message
@@ -64,13 +65,13 @@ module MailSlurpClient
64
65
  # Can the email be accessed by organization team members
65
66
  attr_accessor :team_access
66
67
 
67
- # List of `To` recipients email was addressed to
68
+ # List of `To` recipients that email was addressed to
68
69
  attr_accessor :to
69
70
 
70
71
  # When was the email last updated
71
72
  attr_accessor :updated_at
72
73
 
73
- # ID of user that email belongs
74
+ # ID of user that email belongs to
74
75
  attr_accessor :user_id
75
76
 
76
77
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -30,16 +30,16 @@ module MailSlurpClient
30
30
  # Who the email was sent from
31
31
  attr_accessor :from
32
32
 
33
- # ID of the email
33
+ # ID of the email entity
34
34
  attr_accessor :id
35
35
 
36
- # Has the email been viewed ever. This means viewed in the dashboard or requested via the full email entity endpoints
36
+ # Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.
37
37
  attr_accessor :read
38
38
 
39
39
  # The subject line of the email message
40
40
  attr_accessor :subject
41
41
 
42
- # List of `To` recipients email was addressed to
42
+ # List of `To` recipients that email was addressed to
43
43
  attr_accessor :to
44
44
 
45
45
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
13
13
  require 'date'
14
14
 
15
15
  module MailSlurpClient
16
- # Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox.
16
+ # Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://api.mailslurp.com/schemas/webhook-payload for the payload schema.
17
17
  class WebhookDto
18
18
  # Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.
19
19
  attr_accessor :basic_auth
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
13
13
  require 'date'
14
14
 
15
15
  module MailSlurpClient
16
- # MailSlurp webhook payload schema. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.
16
+ # MailSlurp webhook payload schema is available at https://api.mailslurp.com/schemas/webhook-payload. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.
17
17
  class WebhookPayload
18
18
  # List of attachment meta data objects if attachments present
19
19
  attr_accessor :attachment_meta_datas
@@ -45,7 +45,7 @@ module MailSlurpClient
45
45
  # The subject line of the email message
46
46
  attr_accessor :subject
47
47
 
48
- # List of `To` recipients email was addressed to
48
+ # List of `To` recipients that email was addressed to
49
49
  attr_accessor :to
50
50
 
51
51
  # ID of webhook entity being triggered
@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
11
11
  =end
12
12
 
13
13
  module MailSlurpClient
14
- VERSION = '11.9.0'
14
+ VERSION = '11.9.1'
15
15
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mailslurp_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 11.9.0
4
+ version: 11.9.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - mailslurp