mailslurp_client 5.0.0 → 7.0.7

data/docs/InboxProjection.md

@@ -0,0 +1,29 @@
+# MailSlurpClient::InboxProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **DateTime** |  | 
+**email_address** | **String** |  | [optional] 
+**expires_at** | **DateTime** |  | [optional] 
+**favourite** | **Boolean** |  | [optional] 
+**id** | **String** |  | 
+**name** | **String** |  | [optional] 
+**tags** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::InboxProjection.new(created_at: null,
+                                 email_address: null,
+                                 expires_at: null,
+                                 favourite: null,
+                                 id: null,
+                                 name: null,
+                                 tags: null)
+```
+
+

data/docs/JsonNode.md

@@ -0,0 +1,59 @@
+# MailSlurpClient::JsonNode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**array** | **Boolean** |  | [optional] 
+**big_decimal** | **Boolean** |  | [optional] 
+**big_integer** | **Boolean** |  | [optional] 
+**binary** | **Boolean** |  | [optional] 
+**boolean** | **Boolean** |  | [optional] 
+**container_node** | **Boolean** |  | [optional] 
+**double** | **Boolean** |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**float** | **Boolean** |  | [optional] 
+**floating_point_number** | **Boolean** |  | [optional] 
+**int** | **Boolean** |  | [optional] 
+**integral_number** | **Boolean** |  | [optional] 
+**long** | **Boolean** |  | [optional] 
+**missing_node** | **Boolean** |  | [optional] 
+**node_type** | **String** |  | [optional] 
+**null** | **Boolean** |  | [optional] 
+**number** | **Boolean** |  | [optional] 
+**object** | **Boolean** |  | [optional] 
+**pojo** | **Boolean** |  | [optional] 
+**short** | **Boolean** |  | [optional] 
+**textual** | **Boolean** |  | [optional] 
+**value_node** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::JsonNode.new(array: null,
+                                 big_decimal: null,
+                                 big_integer: null,
+                                 binary: null,
+                                 boolean: null,
+                                 container_node: null,
+                                 double: null,
+                                 empty: null,
+                                 float: null,
+                                 floating_point_number: null,
+                                 int: null,
+                                 integral_number: null,
+                                 long: null,
+                                 missing_node: null,
+                                 node_type: null,
+                                 null: null,
+                                 number: null,
+                                 object: null,
+                                 pojo: null,
+                                 short: null,
+                                 textual: null,
+                                 value_node: null)
+```
+
+

data/docs/MatchOption.md

@@ -1,10 +1,21 @@
 # MailSlurpClient::MatchOption
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **field** | **String** | The email property to match on. One of SUBJECT, TO, BCC, CC or FROM | [optional] 
-**should** | **String** | What criteria to apply. CONTAIN or EQUAL. Note CONTAIN is recommended due to some SMTP servers adding new lines | [optional] 
-**value** | **String** | The value to compare to the field using EQUAL or CONTAIN | [optional] 
+**should** | **String** | What criteria to apply. CONTAIN or EQUAL. Note CONTAIN is recommended due to some SMTP servers adding new lines to fields and body content. | [optional] 
+**value** | **String** | The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::MatchOption.new(field: null,
+                                 should: null,
+                                 value: null)
+```
 
 

data/docs/MatchOptions.md

@@ -1,8 +1,17 @@
 # MailSlurpClient::MatchOptions
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **matches** | [**Array<MatchOption>**](MatchOption.md) | 1 or more match options. Options are additive so if one does not match the email is excluded from results | [optional] 
 
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::MatchOptions.new(matches: null)
+```
+
 

data/docs/PageContactProjection.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageContactProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<ContactProjection>**](ContactProjection.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageContactProjection.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/PageEmailPreview.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageEmailPreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<EmailPreview>**](EmailPreview.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageEmailPreview.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/PageEmailProjection.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageEmailProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<EmailProjection>**](EmailProjection.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageEmailProjection.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/PageGroupProjection.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageGroupProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<GroupProjection>**](GroupProjection.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageGroupProjection.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/PageInboxProjection.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageInboxProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<InboxProjection>**](InboxProjection.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageInboxProjection.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/PageTemplateProjection.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageTemplateProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<TemplateProjection>**](TemplateProjection.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageTemplateProjection.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/PageWebhookProjection.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageWebhookProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<WebhookProjection>**](WebhookProjection.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageWebhookProjection.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+

data/docs/Pageable.md

@@ -0,0 +1,27 @@
+# MailSlurpClient::Pageable
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**offset** | **Integer** |  | [optional] 
+**page_number** | **Integer** |  | [optional] 
+**page_size** | **Integer** |  | [optional] 
+**paged** | **Boolean** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**unpaged** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::Pageable.new(offset: null,
+                                 page_number: null,
+                                 page_size: null,
+                                 paged: null,
+                                 sort: null,
+                                 unpaged: null)
+```
+
+

data/docs/RawEmailJson.md

@@ -0,0 +1,17 @@
+# MailSlurpClient::RawEmailJson
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::RawEmailJson.new(content: null)
+```
+
+