mailchimp_transactional 1.0.0

data/docs/Body8.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body8
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**domain** | **String** | an existing inbound domain | 
+
+

data/docs/Body80.md

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

data/docs/Body81.md

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

data/docs/Body82.md

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

data/docs/Body83.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::Body83
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**url** | **String** | the URL to POST batches of events | 
+**description** | **String** | an optional description of the webhook | [optional] 
+**events** | **Array<String>** | an optional list of events that will be posted to the webhook | [optional] 
+
+

data/docs/Body84.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body84
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **Integer** | the unique identifier of a webhook belonging to this account | 
+
+

data/docs/Body85.md

@@ -0,0 +1,12 @@
+# MailchimpTransactional::Body85
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **Float** | the unique identifier of a webhook belonging to this account | 
+**url** | **String** | the URL to POST batches of events. Requires webhook to exist. | 
+**description** | **String** | an optional description of the webhook | [optional] 
+**events** | **Array<String>** | an optional list of events that will be posted to the webhook | [optional] 
+
+

data/docs/Body86.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body86
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**id** | **Integer** | the unique identifier of a webhook belonging to this account | 
+
+

data/docs/Body87.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::Body87
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**email** | **String** | an email address to add to the whitelist | 
+**comment** | **String** | an optional description of why the email was whitelisted | [optional] 
+
+

data/docs/Body88.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body88
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**email** | **String** | an optional email address or prefix to search by | [optional] 
+
+

data/docs/Body89.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body89
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**email** | **String** | the email address to remove from the whitelist | 
+
+

data/docs/Body9.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::Body9
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | a valid api key | 
+**domain** | **String** | the domain to check | 
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | the unique identifier for this Export. Use this identifier when checking the export job's status | [optional] 
+**created_at** | **DateTime** | the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**type** | **String** | the type of the export job - activity, reject, or whitelist | [optional] 
+**finished_at** | **DateTime** | the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**state** | **String** | the export job's state - waiting, working, complete, error, or expired. | [optional] 
+**result_url** | **String** | the url for the export job's results, if the job is completed. | [optional] 
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | the unique identifier for this Export. Use this identifier when checking the export job's status | [optional] 
+**created_at** | **DateTime** | the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**type** | **String** | the type of the export job - activity, reject, or whitelist | [optional] 
+**finished_at** | **DateTime** | the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**state** | **String** | the export job's state - waiting, working, complete, error, or expired. | [optional] 
+**result_url** | **String** | the url for the export job's results, if the job is completed. | [optional] 
+
+

data/docs/InlineResponse20010.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::InlineResponse20010
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | the unique identifier of the route | [optional] 
+**pattern** | **String** | the search pattern that the mailbox name should match | [optional] 
+**url** | **String** | the webhook URL where inbound messages will be published | [optional] 
+
+

data/docs/InlineResponse20011.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::InlineResponse20011
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | the unique identifier of the route | [optional] 
+**pattern** | **String** | the search pattern that the mailbox name should match | [optional] 
+**url** | **String** | the webhook URL where inbound messages will be published | [optional] 
+
+

data/docs/InlineResponse20012.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::InlineResponse20012
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | the unique identifier of the route | [optional] 
+**pattern** | **String** | the search pattern that the mailbox name should match | [optional] 
+**url** | **String** | the webhook URL where inbound messages will be published | [optional] 
+
+

data/docs/InlineResponse20013.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::InlineResponse20013
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | the email address of the matching recipient | [optional] 
+**pattern** | **String** | the mailbox route pattern that the recipient matched | [optional] 
+**url** | **String** | the webhook URL that the message was posted to | [optional] 
+
+

data/docs/InlineResponse20014.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse20014
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | the ip address | [optional] 
+**created_at** | **DateTime** | the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**pool** | **String** | the name of the pool that this dedicated IP belongs to | [optional] 
+**domain** | **String** | the domain name (reverse dns) of this dedicated IP | [optional] 
+**custom_dns** | [**IpslistCustomDns**](IpslistCustomDns.md) |  | [optional] 
+**warmup** | [**IpslistWarmup**](IpslistWarmup.md) |  | [optional] 
+
+

data/docs/InlineResponse20015.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse20015
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | the ip address | [optional] 
+**created_at** | **DateTime** | the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**pool** | **String** | the name of the pool that this dedicated IP belongs to | [optional] 
+**domain** | **String** | the domain name (reverse dns) of this dedicated IP | [optional] 
+**custom_dns** | [**IpslistCustomDns**](IpslistCustomDns.md) |  | [optional] 
+**warmup** | [**IpslistWarmup**](IpslistWarmup.md) |  | [optional] 
+
+

data/docs/InlineResponse20016.md

@@ -0,0 +1,8 @@
+# MailchimpTransactional::InlineResponse20016
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_at** | **DateTime** | the date and time that the request was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format | [optional] 
+
+

data/docs/InlineResponse20017.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse20017
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | the ip address | [optional] 
+**created_at** | **DateTime** | the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**pool** | **String** | the name of the pool that this dedicated IP belongs to | [optional] 
+**domain** | **String** | the domain name (reverse dns) of this dedicated IP | [optional] 
+**custom_dns** | [**IpslistCustomDns**](IpslistCustomDns.md) |  | [optional] 
+**warmup** | [**IpslistWarmup**](IpslistWarmup.md) |  | [optional] 
+
+

data/docs/InlineResponse20018.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse20018
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | the ip address | [optional] 
+**created_at** | **DateTime** | the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**pool** | **String** | the name of the pool that this dedicated IP belongs to | [optional] 
+**domain** | **String** | the domain name (reverse dns) of this dedicated IP | [optional] 
+**custom_dns** | [**IpslistCustomDns**](IpslistCustomDns.md) |  | [optional] 
+**warmup** | [**IpslistWarmup**](IpslistWarmup.md) |  | [optional] 
+
+

data/docs/InlineResponse20019.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::InlineResponse20019
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | the ip address | [optional] 
+**deleted** | **String** | a boolean indicating whether the ip was successfully deleted | [optional] 
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse2002
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | the unique identifier for this Export. Use this identifier when checking the export job's status | [optional] 
+**created_at** | **DateTime** | the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**type** | **String** | the type of the export job - activity, reject, or whitelist | [optional] 
+**finished_at** | **DateTime** | the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**state** | **String** | the export job's state - waiting, working, complete, error, or expired. | [optional] 
+**result_url** | **String** | the url for the export job's results, if the job is completed. | [optional] 
+
+

data/docs/InlineResponse20020.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::InlineResponse20020
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | this pool's name | [optional] 
+**created_at** | **DateTime** | the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format | [optional] 
+**ips** | [**Array<IpslistpoolsIps>**](IpslistpoolsIps.md) | the dedicated IPs in this pool | [optional] 
+
+

data/docs/InlineResponse20021.md

@@ -0,0 +1,10 @@
+# MailchimpTransactional::InlineResponse20021
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | this pool's name | [optional] 
+**created_at** | **DateTime** | the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format | [optional] 
+**ips** | [**Array<IpslistpoolsIps>**](IpslistpoolsIps.md) | the dedicated IPs in this pool | [optional] 
+
+

data/docs/InlineResponse20022.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::InlineResponse20022
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pool** | **String** | the name of the pool | [optional] 
+**deleted** | **BOOLEAN** | whether the pool was deleted | [optional] 
+
+

data/docs/InlineResponse20023.md

@@ -0,0 +1,9 @@
+# MailchimpTransactional::InlineResponse20023
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid** | **String** | whether the domain name has a correctly-configured A record pointing to the ip address | [optional] 
+**error** | **String** | if valid is false, this will contain details about why the domain's A record is incorrect | [optional] 
+
+

data/docs/InlineResponse20024.md

@@ -0,0 +1,13 @@
+# MailchimpTransactional::InlineResponse20024
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | the ip address | [optional] 
+**created_at** | **DateTime** | the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**pool** | **String** | the name of the pool that this dedicated IP belongs to | [optional] 
+**domain** | **String** | the domain name (reverse dns) of this dedicated IP | [optional] 
+**custom_dns** | [**IpslistCustomDns**](IpslistCustomDns.md) |  | [optional] 
+**warmup** | [**IpslistWarmup**](IpslistWarmup.md) |  | [optional] 
+
+

data/docs/InlineResponse20025.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::InlineResponse20025
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | the email address of the recipient | [optional] 
+**status** | **String** | the sending status of the recipient | [optional] 
+**reject_reason** | **String** | the reason for the rejection if the recipient status is \"rejected\" | [optional] 
+**_id** | **String** | the message's unique id | [optional] 
+
+

data/docs/InlineResponse20026.md

@@ -0,0 +1,11 @@
+# MailchimpTransactional::InlineResponse20026
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | the email address of the recipient | [optional] 
+**status** | **String** | the sending status of the recipient | [optional] 
+**reject_reason** | **String** | the reason for the rejection if the recipient status is \"rejected\" | [optional] 
+**_id** | **String** | the message's unique id | [optional] 
+
+

data/docs/InlineResponse20027.md

@@ -0,0 +1,20 @@
+# MailchimpTransactional::InlineResponse20027
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ts** | **Integer** | the Unix timestamp from when this message was sent | [optional] 
+**_id** | **String** | the message's unique id | [optional] 
+**sender** | **String** | the email address of the sender | [optional] 
+**template** | **String** | the unique name of the template used, if any | [optional] 
+**subject** | **String** | the message's subject line | [optional] 
+**email** | **String** | the recipient email address | [optional] 
+**tags** | **Array<String>** | list of tags on this message | [optional] 
+**opens** | **Integer** | how many times has this message been opened | [optional] 
+**opens_detail** | [**Array<MessagessearchOpensDetail>**](MessagessearchOpensDetail.md) | list of individual opens for the message | [optional] 
+**clicks** | **Integer** | how many times has a link been clicked in this message | [optional] 
+**clicks_detail** | [**Array<MessagessearchClicksDetail>**](MessagessearchClicksDetail.md) | list of individual clicks for the message | [optional] 
+**state** | **String** | sending status of this message | [optional] 
+**metadata** | **Object** | any custom metadata provided when the message was sent | [optional] 
+
+

data/docs/InlineResponse20028.md

@@ -0,0 +1,18 @@
+# MailchimpTransactional::InlineResponse20028
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time** | **DateTime** | the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format | [optional] 
+**sent** | **Integer** | the number of emails that were sent during the hour | [optional] 
+**hard_bounces** | **Integer** | the number of emails that hard bounced during the hour | [optional] 
+**soft_bounces** | **Integer** | the number of emails that soft bounced during the hour | [optional] 
+**rejects** | **Integer** | the number of emails that were rejected during the hour | [optional] 
+**complaints** | **Integer** | the number of spam complaints received during the hour | [optional] 
+**unsubs** | **Integer** | the number of unsubscribes received during the hour | [optional] 
+**opens** | **Integer** | the number of emails opened during the hour | [optional] 
+**unique_opens** | **Integer** | the number of unique opens generated by messages sent during the hour | [optional] 
+**clicks** | **Integer** | the number of tracked URLs clicked during the hour | [optional] 
+**unique_clicks** | **Integer** | the number of unique clicks generated by messages sent during the hour | [optional] 
+
+

data/docs/InlineResponse20029.md

@@ -0,0 +1,21 @@
+# MailchimpTransactional::InlineResponse20029
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ts** | **Integer** | the Unix timestamp from when this message was sent | [optional] 
+**_id** | **String** | the message's unique id | [optional] 
+**sender** | **String** | the email address of the sender | [optional] 
+**template** | **String** | the unique name of the template used, if any | [optional] 
+**subject** | **String** | the message's subject line | [optional] 
+**email** | **String** | the recipient email address | [optional] 
+**tags** | **Array<String>** | list of tags on this message | [optional] 
+**opens** | **Integer** | how many times has this message been opened | [optional] 
+**opens_detail** | [**Array<MessagessearchOpensDetail>**](MessagessearchOpensDetail.md) | list of individual opens for the message | [optional] 
+**clicks** | **Integer** | how many times has a link been clicked in this message | [optional] 
+**clicks_detail** | [**Array<MessagessearchClicksDetail>**](MessagessearchClicksDetail.md) | list of individual clicks for the message | [optional] 
+**state** | **String** | sending status of this message | [optional] 
+**metadata** | **Object** | any custom metadata provided when the message was sent | [optional] 
+**smtp_events** | [**Array<InlineResponse20029SmtpEvents>**](InlineResponse20029SmtpEvents.md) | a log of up to 3 smtp events for the message | [optional] 
+
+