mailchimp_transactional 1.0.0

data/docs/Body11.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::Body11
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **String** | the unique identifier of an existing mailbox route | 
+**pattern** | **String** | the search pattern that the mailbox name should match | [optional] 
+**url** | **String** | the webhook URL where the inbound messages will be published; Validation: webhookexists | [optional] 
+
+

data/docs/Body12.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body12
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **String** | the unique identifier of an existing route | 
+
+

data/docs/Body13.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::Body13
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**raw_message** | **String** | the full MIME document of an email message | 
+**to** | **Array<String>** | optionally define the recipients to receive the message - otherwise we'll use the To, Cc, and Bcc headers provided in the document | [optional] 
+**mail_from** | **String** | the address specified in the MAIL FROM stage of the SMTP conversation. Required for the SPF check. | [optional] 
+**helo** | **String** | the identification provided by the client mta in the MTA state of the SMTP conversation. Required for the SPF check. | [optional] 
+**client_address** | **String** | the remote MTA's ip address. Optional; required for the SPF check. | [optional] 
+
+

data/docs/Body14.md

@@ -0,0 +1,8 @@
+# MailchimpTransactional::Body14
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+
+

data/docs/Body15.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body15
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | a dedicated IP address | [optional] 
+
+

data/docs/Body16.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body16
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**warmup** | **BOOLEAN** | whether to enable warmup mode for the ip | [optional] 
+**pool** | **String** | the id of the pool to add the dedicated ip to, or null to use your account's default pool | [optional] 
+
+

data/docs/Body17.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body17
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | a dedicated ip address | 
+
+

data/docs/Body18.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body18
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | a dedicated ip address | 
+
+

data/docs/Body19.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::Body19
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | a dedicated ip address | 
+**pool** | **String** | the name of the new pool to add the dedicated ip to | 
+**create_pool** | **BOOLEAN** | whether to create the pool if it does not exist; if false and the pool does not exist, an Unknown_Pool will be thrown. | [optional] 
+
+

data/docs/Body2.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body2
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**notify_email** | **String** | an optional email address to notify when the export job has finished. | [optional] 
+
+

data/docs/Body20.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body20
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | the dedicated ip to remove from your account | 
+
+

data/docs/Body21.md

@@ -0,0 +1,8 @@
+# MailchimpTransactional::Body21
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+
+

data/docs/Body22.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body22
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**pool** | **String** | a pool name | 
+
+

data/docs/Body23.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body23
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**pool** | **String** | the name of a pool to create | 
+
+

data/docs/Body24.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body24
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**pool** | **String** | the name of the pool to delete | 
+
+

data/docs/Body25.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body25
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | a dedicated ip address | 
+**domain** | **String** | the domain name to test | 
+
+

data/docs/Body26.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body26
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**ip** | **String** | a dedicated ip address | 
+**domain** | **String** | a domain name to set as the dedicated IP's custom dns name. | 
+
+

data/docs/Body27.md

@@ -0,0 +1,12 @@
+# MailchimpTransactional::Body27
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**message** | [**MessagessendMessage**](MessagessendMessage.md) |  | 
+**async** | **BOOLEAN** | enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of \"queued\" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async. | [optional] 
+**ip_pool** | **String** | the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead. | [optional] 
+**send_at** | **DateTime** | when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance. | [optional] 
+
+

data/docs/Body28.md

@@ -0,0 +1,14 @@
+# MailchimpTransactional::Body28
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**template_name** | **String** | the immutable name or slug of a template that exists in the user's account. For backwards-compatibility, the template name may also be used but the immutable slug is preferred. | 
+**template_content** | [**Array<MessagessendtemplateTemplateContent>**](MessagessendtemplateTemplateContent.md) | an array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block | 
+**message** | [**MessagessendtemplateMessage**](MessagessendtemplateMessage.md) |  | 
+**async** | **BOOLEAN** | enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of \"queued\" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async. | [optional] 
+**ip_pool** | **String** | the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead. | [optional] 
+**send_at** | **DateTime** | when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance. | [optional] 
+
+

data/docs/Body29.md

@@ -0,0 +1,15 @@
+# MailchimpTransactional::Body29
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**query** | **String** | search terms to find matching messages | [optional] 
+**date_from** | **DateTime** | start date | [optional] 
+**date_to** | **DateTime** | end date | [optional] 
+**tags** | **Array<String>** | an array of tag names to narrow the search to, will return messages that contain ANY of the tags | [optional] 
+**senders** | **Array<String>** | an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders | [optional] 
+**api_keys** | **Array<String>** | an array of API keys to narrow the search to, will return messages sent by ANY of the keys | [optional] 
+**limit** | **Integer** | the maximum number of results to return, defaults to 100, 1000 is the maximum | [optional] 
+
+

data/docs/Body3.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body3
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**notify_email** | **String** | an optional email address to notify when the export job has finished. | [optional] 
+
+

data/docs/Body30.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::Body30
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**query** | **String** | the search terms to find matching messages for | [optional] 
+**date_from** | **DateTime** | start date | [optional] 
+**date_to** | **DateTime** | end date | [optional] 
+**tags** | **Array<String>** | an array of tag names to narrow the search to, will return messages that contain ANY of the tags | [optional] 
+**senders** | **Array<String>** | an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders | [optional] 
+
+

data/docs/Body31.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body31
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **String** | the unique id of the message to get - passed as the \"_id\" field in webhooks, send calls, or search calls | 
+
+

data/docs/Body32.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body32
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **String** | the unique id of the message to get - passed as the \"_id\" field in webhooks, send calls, or search calls | 
+
+

data/docs/Body33.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body33
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**raw_message** | **String** | the full MIME document of an email message | 
+
+

data/docs/Body34.md

@@ -0,0 +1,16 @@
+# MailchimpTransactional::Body34
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**raw_message** | **String** | the full MIME document of an email message | 
+**from_email** | **String** | optionally define the sender address - otherwise we'll use the address found in the provided headers | [optional] 
+**from_name** | **String** | optionally define the sender alias | [optional] 
+**to** | **Array<String>** | optionally define the recipient to receive the message - otherwise we'll use the To, Cc, and Bcc headers provided in the document | [optional] 
+**async** | **BOOLEAN** | enable a background sending mode that is optimized for bulk sending. In async mode, messages/sendRaw will immediately return a status of \"queued\" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async. | [optional] 
+**ip_pool** | **String** | the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead. | [optional] 
+**send_at** | **DateTime** | when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. | [optional] 
+**return_path_domain** | **String** | a custom domain to use for the messages's return-path | [optional] 
+
+

data/docs/Body35.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body35
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**to** | **String** | an optional recipient address to restrict results to | [optional] 
+
+

data/docs/Body36.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body36
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **String** | a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled | 
+
+

data/docs/Body37.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body37
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **String** | a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled | 
+**send_at** | **DateTime** | the new UTC timestamp when the message should sent. Mandrill can't time travel, so if you specify a time in past the message will be sent immediately | 
+
+

data/docs/Body38.md

@@ -0,0 +1,8 @@
+# MailchimpTransactional::Body38
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+
+

data/docs/Body39.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body39
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**name** | **String** | a unique identifier for the metadata field | 
+**view_template** | **String** | Mustache template to control how the metadata is rendered in your activity log | [optional] 
+
+

data/docs/Body4.md

@@ -0,0 +1,15 @@
+# MailchimpTransactional::Body4
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**notify_email** | **String** | an optional email address to notify when the export job has finished | [optional] 
+**date_from** | **DateTime** | start date as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**date_to** | **DateTime** | end date as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**tags** | **Array<String>** | an array of tag names to narrow the export to; will match messages that contain ANY of the tags | [optional] 
+**senders** | **Array<String>** | an array of senders to narrow the export to | [optional] 
+**states** | **Array<String>** | an array of message states to narrow the export to; messages with ANY of the states will be included | [optional] 
+**api_keys** | **Array<String>** | an array of api keys to narrow the export to; messsagse sent with ANY of the keys will be included | [optional] 
+
+

data/docs/Body40.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body40
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**name** | **String** | the unique identifier of the metadata field to update | 
+**view_template** | **String** | Mustache template to control how the metadata is rendered in your activity log | 
+
+

data/docs/Body41.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body41
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**name** | **String** | the unique identifier of the metadata field to update | 
+
+

data/docs/Body42.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::Body42
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**email** | **String** | an email address to block | 
+**comment** | **String** | an optional comment describing the rejection | [optional] 
+**subaccount** | **String** | an optional unique identifier for the subaccount to limit the blacklist entry | [optional] 
+
+

data/docs/Body43.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::Body43
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**email** | **String** | an optional email address to search by | [optional] 
+**include_expired** | **BOOLEAN** | whether to include rejections that have already expired. | [optional] 
+**subaccount** | **String** | an optional unique identifier for the subaccount to limit the blacklist | [optional] 
+
+