From 25e1378eba0bee5740e60ba762fa44ac1d9043b3 Mon Sep 17 00:00:00 2001 From: Charles Date: Mon, 30 Nov 2020 00:59:23 -0800 Subject: [PATCH] fix mailchimp catalog (#1107) --- .../sample_files/catalog.json | 1486 ++++++++--------- 1 file changed, 743 insertions(+), 743 deletions(-) diff --git a/airbyte-integrations/connectors/source-mailchimp/sample_files/catalog.json b/airbyte-integrations/connectors/source-mailchimp/sample_files/catalog.json index ec58ca06aade3..2f5d60b791ec0 100644 --- a/airbyte-integrations/connectors/source-mailchimp/sample_files/catalog.json +++ b/airbyte-integrations/connectors/source-mailchimp/sample_files/catalog.json @@ -2,800 +2,800 @@ "streams": [ { "name": "Campaigns", + "supported_sync_modes": ["full_refresh", "incremental"], + "source_defined_cursor": true, + "default_cursor_field": "create_time", "json_schema": { - "name": "Campaigns", - "supported_sync_modes": ["full_refresh", "incremental"], - "source_defined_cursor": true, - "default_cursor_field": "create_time", - "json_schema": { - "type": "object", - "title": "Campaign", - "description": "A summary of an individual campaign's settings and content.", - "properties": { - "id": { - "type": "string", - "title": "Campaign ID", - "description": "A string that uniquely identifies this campaign.", - "readOnly": true - }, - "web_id": { - "type": "integer", - "title": "Campaign Web ID", - "description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", - "readOnly": true - }, - "parent_campaign_id": { - "type": "string", - "title": "Parent Campaign ID", - "description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.", - "readOnly": true - }, - "type": { - "$ref": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignType.json" - }, - "create_time": { - "type": "string", - "format": "date-time", - "title": "Create Time", - "description": "The date and time the campaign was created in ISO 8601 format.", - "readOnly": true - }, - "archive_url": { - "type": "string", - "title": "Archive URL", - "description": "The link to the campaign's archive version in ISO 8601 format.", - "readOnly": true - }, - "long_archive_url": { - "type": "string", - "title": "Long Archive URL", - "description": "The original link to the campaign's archive version.", - "readOnly": true - }, - "status": { - "$ref": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignStatus.json" - }, - "emails_sent": { - "type": "integer", - "title": "Emails Sent", - "description": "The total number of emails sent for this campaign.", - "readOnly": true - }, - "send_time": { - "type": "string", - "format": "date-time", - "title": "Send Time", - "description": "The date and time a campaign was sent.", - "readOnly": true - }, - "content_type": { - "type": "string", - "title": "Content Type", - "description": "How the campaign's content is put together.", - "enum": ["template", "html", "url", "multichannel"] - }, - "needs_block_refresh": { - "type": "boolean", - "title": "Needs Block Refresh", - "description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false.", - "readOnly": true - }, - "resendable": { - "type": "boolean", - "title": "Resendable", - "description": "Determines if the campaign qualifies to be resent to non-openers.", - "readOnly": true - }, - "recipients": { - "type": "object", - "title": "List", - "description": "List settings for the campaign.", - "properties": { - "list_id": { - "type": "string", - "title": "List ID", - "description": "The unique list id." - }, - "list_is_active": { - "type": "boolean", - "title": "List Status", - "description": "The status of the list used, namely if it's deleted or disabled.", - "readOnly": true - }, - "list_name": { - "type": "string", - "title": "List Name", - "description": "The name of the list.", - "readOnly": true - }, - "segment_text": { - "type": "string", - "title": "Segment Text", - "description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML.", - "readOnly": true - }, - "recipient_count": { - "type": "integer", - "title": "Recipient Count", - "description": "Count of the recipients on the associated list. Formatted as an integer.", - "readOnly": true - }, - "segment_opts": { - "$ref": "https://us1.api.mailchimp.com/schema/3.0/Definitions/SegmentationOptions.json" + "type": "object", + "title": "Campaign", + "description": "A summary of an individual campaign's settings and content.", + "properties": { + "id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies this campaign.", + "readOnly": true + }, + "web_id": { + "type": "integer", + "title": "Campaign Web ID", + "description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`.", + "readOnly": true + }, + "parent_campaign_id": { + "type": "string", + "title": "Parent Campaign ID", + "description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.", + "readOnly": true + }, + "type": { + "$ref": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignType.json" + }, + "create_time": { + "type": "string", + "format": "date-time", + "title": "Create Time", + "description": "The date and time the campaign was created in ISO 8601 format.", + "readOnly": true + }, + "archive_url": { + "type": "string", + "title": "Archive URL", + "description": "The link to the campaign's archive version in ISO 8601 format.", + "readOnly": true + }, + "long_archive_url": { + "type": "string", + "title": "Long Archive URL", + "description": "The original link to the campaign's archive version.", + "readOnly": true + }, + "status": { + "$ref": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignStatus.json" + }, + "emails_sent": { + "type": "integer", + "title": "Emails Sent", + "description": "The total number of emails sent for this campaign.", + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time a campaign was sent.", + "readOnly": true + }, + "content_type": { + "type": "string", + "title": "Content Type", + "description": "How the campaign's content is put together.", + "enum": ["template", "html", "url", "multichannel"] + }, + "needs_block_refresh": { + "type": "boolean", + "title": "Needs Block Refresh", + "description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false.", + "readOnly": true + }, + "resendable": { + "type": "boolean", + "title": "Resendable", + "description": "Determines if the campaign qualifies to be resent to non-openers.", + "readOnly": true + }, + "recipients": { + "type": "object", + "title": "List", + "description": "List settings for the campaign.", + "properties": { + "list_id": { + "type": "string", + "title": "List ID", + "description": "The unique list id." + }, + "list_is_active": { + "type": "boolean", + "title": "List Status", + "description": "The status of the list used, namely if it's deleted or disabled.", + "readOnly": true + }, + "list_name": { + "type": "string", + "title": "List Name", + "description": "The name of the list.", + "readOnly": true + }, + "segment_text": { + "type": "string", + "title": "Segment Text", + "description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML.", + "readOnly": true + }, + "recipient_count": { + "type": "integer", + "title": "Recipient Count", + "description": "Count of the recipients on the associated list. Formatted as an integer.", + "readOnly": true + }, + "segment_opts": { + "$ref": "https://us1.api.mailchimp.com/schema/3.0/Definitions/SegmentationOptions.json" + } + } + }, + "settings": { + "type": "object", + "title": "Campaign Settings", + "description": "The settings for your campaign, including subject, from name, reply-to address, and more.", + "properties": { + "subject_line": { + "type": "string", + "title": "Campaign Subject Line", + "description": "The subject line for the campaign." + }, + "preview_text": { + "type": "string", + "title": "Campaign Preview Text", + "description": "The preview text for the campaign." + }, + "title": { + "type": "string", + "title": "Campaign Title", + "description": "The title of the campaign." + }, + "from_name": { + "type": "string", + "title": "From Name", + "description": "The 'from' name on the campaign (not an email address)." + }, + "reply_to": { + "type": "string", + "title": "Reply To Address", + "description": "The reply-to email address for the campaign." + }, + "use_conversation": { + "type": "boolean", + "title": "Conversation", + "description": "Use Mailchimp Conversation feature to manage out-of-office replies." + }, + "to_name": { + "type": "string", + "title": "To Name", + "description": "The campaign's custom 'To' name. Typically the first name [merge field](https://mailchimp.com/help/getting-started-with-merge-tags/)." + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "If the campaign is listed in a folder, the id for that folder." + }, + "authenticate": { + "type": "boolean", + "title": "Authentication", + "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`." + }, + "auto_footer": { + "type": "boolean", + "title": "Auto-Footer", + "description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign." + }, + "inline_css": { + "type": "boolean", + "title": "Inline CSS", + "description": "Automatically inline the CSS included with the campaign content." + }, + "auto_tweet": { + "type": "boolean", + "title": "Auto-Tweet", + "description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent." + }, + "auto_fb_post": { + "type": "array", + "title": "Auto Post to Facebook", + "description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to.", + "items": { + "type": "string" } + }, + "fb_comments": { + "type": "boolean", + "title": "Facebook Comments", + "description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`." + }, + "timewarp": { + "type": "boolean", + "title": "Timewarp Send", + "description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/).", + "readOnly": true + }, + "template_id": { + "type": "integer", + "title": "Template ID", + "description": "The id for the template used in this campaign.", + "readOnly": false + }, + "drag_and_drop": { + "type": "boolean", + "title": "Drag And Drop Campaign", + "description": "Whether the campaign uses the drag-and-drop editor.", + "readOnly": true } - }, - "settings": { - "type": "object", - "title": "Campaign Settings", - "description": "The settings for your campaign, including subject, from name, reply-to address, and more.", - "properties": { - "subject_line": { - "type": "string", - "title": "Campaign Subject Line", - "description": "The subject line for the campaign." - }, - "preview_text": { - "type": "string", - "title": "Campaign Preview Text", - "description": "The preview text for the campaign." - }, - "title": { - "type": "string", - "title": "Campaign Title", - "description": "The title of the campaign." - }, - "from_name": { - "type": "string", - "title": "From Name", - "description": "The 'from' name on the campaign (not an email address)." - }, - "reply_to": { - "type": "string", - "title": "Reply To Address", - "description": "The reply-to email address for the campaign." - }, - "use_conversation": { - "type": "boolean", - "title": "Conversation", - "description": "Use Mailchimp Conversation feature to manage out-of-office replies." - }, - "to_name": { - "type": "string", - "title": "To Name", - "description": "The campaign's custom 'To' name. Typically the first name [merge field](https://mailchimp.com/help/getting-started-with-merge-tags/)." - }, - "folder_id": { + } + }, + "variate_settings": { + "type": "object", + "title": "A/B Test Options", + "description": "The settings specific to A/B test campaigns.", + "properties": { + "winning_combination_id": { + "type": "string", + "title": "Winning Combination ID", + "description": "ID for the winning combination.", + "readOnly": true + }, + "winning_campaign_id": { + "type": "string", + "title": "Winning Campaign ID", + "description": "ID of the campaign that was sent to the remaining recipients based on the winning combination.", + "readOnly": true + }, + "winner_criteria": { + "type": "string", + "title": "Winning Criteria", + "description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application.", + "enum": ["opens", "clicks", "manual", "total_revenue"] + }, + "wait_time": { + "type": "integer", + "title": "Wait Time", + "description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes." + }, + "test_size": { + "type": "integer", + "title": "Test Size", + "description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100." + }, + "subject_lines": { + "type": "array", + "title": "Subject Lines", + "description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.", + "items": { + "type": "string" + } + }, + "send_times": { + "type": "array", + "title": "Send Times", + "description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.", + "items": { "type": "string", - "title": "Folder ID", - "description": "If the campaign is listed in a folder, the id for that folder." - }, - "authenticate": { - "type": "boolean", - "title": "Authentication", - "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`." - }, - "auto_footer": { - "type": "boolean", - "title": "Auto-Footer", - "description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign." - }, - "inline_css": { - "type": "boolean", - "title": "Inline CSS", - "description": "Automatically inline the CSS included with the campaign content." - }, - "auto_tweet": { - "type": "boolean", - "title": "Auto-Tweet", - "description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent." + "format": "date-time" + } + }, + "from_names": { + "type": "array", + "title": "From Names", + "description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.", + "items": { + "type": "string" + } + }, + "reply_to_addresses": { + "type": "array", + "title": "Reply To Addresses", + "description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.", + "items": { + "type": "string" + } + }, + "contents": { + "type": "array", + "title": "Content Descriptions", + "description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'.", + "items": { + "type": "string" }, - "auto_fb_post": { - "type": "array", - "title": "Auto Post to Facebook", - "description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to.", - "items": { - "type": "string" + "readOnly": true + }, + "combinations": { + "type": "array", + "title": "Combinations", + "description": "Combinations of possible variables used to build emails.", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "ID", + "description": "Unique ID for the combination." + }, + "subject_line": { + "type": "integer", + "title": "Subject Line", + "description": "The index of `variate_settings.subject_lines` used." + }, + "send_time": { + "type": "integer", + "title": "Send Time", + "description": "The index of `variate_settings.send_times` used." + }, + "from_name": { + "type": "integer", + "title": "From Name", + "description": "The index of `variate_settings.from_names` used." + }, + "reply_to": { + "type": "integer", + "title": "Reply To", + "description": "The index of `variate_settings.reply_to_addresses` used." + }, + "content_description": { + "type": "integer", + "title": "Content Description", + "description": "The index of `variate_settings.contents` used." + }, + "recipients": { + "type": "integer", + "title": "Recipients", + "description": "The number of recipients for this combination." + } } - }, - "fb_comments": { - "type": "boolean", - "title": "Facebook Comments", - "description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`." - }, - "timewarp": { - "type": "boolean", - "title": "Timewarp Send", - "description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/).", - "readOnly": true - }, - "template_id": { - "type": "integer", - "title": "Template ID", - "description": "The id for the template used in this campaign.", - "readOnly": false - }, - "drag_and_drop": { - "type": "boolean", - "title": "Drag And Drop Campaign", - "description": "Whether the campaign uses the drag-and-drop editor.", - "readOnly": true } } - }, - "variate_settings": { - "type": "object", - "title": "A/B Test Options", - "description": "The settings specific to A/B test campaigns.", - "properties": { - "winning_combination_id": { - "type": "string", - "title": "Winning Combination ID", - "description": "ID for the winning combination.", - "readOnly": true - }, - "winning_campaign_id": { - "type": "string", - "title": "Winning Campaign ID", - "description": "ID of the campaign that was sent to the remaining recipients based on the winning combination.", - "readOnly": true - }, - "winner_criteria": { - "type": "string", - "title": "Winning Criteria", - "description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application.", - "enum": ["opens", "clicks", "manual", "total_revenue"] - }, - "wait_time": { - "type": "integer", - "title": "Wait Time", - "description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes." - }, - "test_size": { - "type": "integer", - "title": "Test Size", - "description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100." - }, - "subject_lines": { - "type": "array", - "title": "Subject Lines", - "description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used.", - "items": { - "type": "string" - } - }, - "send_times": { - "type": "array", - "title": "Send Times", - "description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored.", - "items": { - "type": "string", - "format": "date-time" - } - }, - "from_names": { - "type": "array", - "title": "From Names", - "description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used.", - "items": { - "type": "string" + } + }, + "tracking": { + "type": "object", + "title": "Campaign Tracking Options", + "description": "The tracking options for a campaign.", + "properties": { + "opens": { + "type": "boolean", + "title": "Opens", + "description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns." + }, + "html_clicks": { + "type": "boolean", + "title": "HTML Click Tracking", + "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns." + }, + "text_clicks": { + "type": "boolean", + "title": "Plain-Text Click Tracking", + "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns." + }, + "goal_tracking": { + "type": "boolean", + "title": "Mailchimp Goal Tracking", + "description": "Whether to enable [Goal](https://mailchimp.com/help/about-connected-sites/) tracking." + }, + "ecomm360": { + "type": "boolean", + "title": "E-commerce Tracking", + "description": "Whether to enable [eCommerce360](https://mailchimp.com/help/connect-your-online-store-to-mailchimp/) tracking." + }, + "google_analytics": { + "type": "string", + "title": "Google Analytics Tracking", + "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." + }, + "clicktale": { + "type": "string", + "title": "ClickTale Analytics Tracking", + "description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." + }, + "salesforce": { + "type": "object", + "title": "Salesforce CRM Tracking", + "description": "Salesforce tracking options for a campaign. Must be using Mailchimp's built-in [Salesforce integration](https://mailchimp.com/help/integrate-salesforce-with-mailchimp/).", + "properties": { + "campaign": { + "type": "boolean", + "title": "Salesforce Campaign", + "description": "Create a campaign in a connected Salesforce account." + }, + "notes": { + "type": "boolean", + "title": "Salesforce Note", + "description": "Update contact notes for a campaign based on subscriber email addresses." } - }, - "reply_to_addresses": { - "type": "array", - "title": "Reply To Addresses", - "description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used.", - "items": { - "type": "string" + } + }, + "capsule": { + "type": "object", + "title": "Capsule CRM Tracking", + "description": "Capsule tracking options for a campaign. Must be using Mailchimp's built-in Capsule integration.", + "properties": { + "notes": { + "type": "boolean", + "title": "Capsule Note", + "description": "Update contact notes for a campaign based on subscriber email addresses." } - }, - "contents": { - "type": "array", - "title": "Content Descriptions", - "description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'.", - "items": { - "type": "string" + } + } + } + }, + "rss_opts": { + "type": "object", + "title": "RSS Options", + "description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.", + "properties": { + "feed_url": { + "type": "string", + "title": "Feed URL", + "format": "uri", + "description": "The URL for the RSS feed." + }, + "frequency": { + "type": "string", + "title": "Frequency", + "description": "The frequency of the RSS Campaign.", + "enum": ["daily", "weekly", "monthly"] + }, + "schedule": { + "type": "object", + "title": "Sending Schedule", + "description": "The schedule for sending the RSS Campaign.", + "properties": { + "hour": { + "type": "integer", + "minimum": 0, + "maximum": 23, + "title": "Sending Hour", + "description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)." }, - "readOnly": true - }, - "combinations": { - "type": "array", - "title": "Combinations", - "description": "Combinations of possible variables used to build emails.", - "readOnly": true, - "items": { + "daily_send": { "type": "object", + "title": "Daily Sending Days", + "description": "The days of the week to send a daily RSS Campaign.", "properties": { - "id": { - "type": "string", - "title": "ID", - "description": "Unique ID for the combination." + "sunday": { + "type": "boolean", + "title": "Sunday", + "description": "Sends the daily RSS Campaign on Sundays." }, - "subject_line": { - "type": "integer", - "title": "Subject Line", - "description": "The index of `variate_settings.subject_lines` used." + "monday": { + "type": "boolean", + "title": "Monday", + "description": "Sends the daily RSS Campaign on Mondays." }, - "send_time": { - "type": "integer", - "title": "Send Time", - "description": "The index of `variate_settings.send_times` used." + "tuesday": { + "type": "boolean", + "title": "tuesday", + "description": "Sends the daily RSS Campaign on Tuesdays." }, - "from_name": { - "type": "integer", - "title": "From Name", - "description": "The index of `variate_settings.from_names` used." + "wednesday": { + "type": "boolean", + "title": "Monday", + "description": "Sends the daily RSS Campaign on Wednesdays." }, - "reply_to": { - "type": "integer", - "title": "Reply To", - "description": "The index of `variate_settings.reply_to_addresses` used." + "thursday": { + "type": "boolean", + "title": "Thursday", + "description": "Sends the daily RSS Campaign on Thursdays." }, - "content_description": { - "type": "integer", - "title": "Content Description", - "description": "The index of `variate_settings.contents` used." + "friday": { + "type": "boolean", + "title": "Friday", + "description": "Sends the daily RSS Campaign on Fridays." }, - "recipients": { - "type": "integer", - "title": "Recipients", - "description": "The number of recipients for this combination." + "saturday": { + "type": "boolean", + "title": "Saturday", + "description": "Sends the daily RSS Campaign on Saturdays." } } + }, + "weekly_send_day": { + "type": "string", + "enum": [ + "sunday", + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday" + ], + "title": "Weekly Sending Day", + "description": "The day of the week to send a weekly RSS Campaign." + }, + "monthly_send_date": { + "type": "number", + "minimum": 0, + "maximum": 31, + "title": "Monthly Sending Day", + "description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February." } } + }, + "last_sent": { + "type": "string", + "format": "date-time", + "title": "Last Sent", + "description": "The date the campaign was last sent.", + "readOnly": true + }, + "constrain_rss_img": { + "type": "boolean", + "title": "Constrain RSS Images", + "description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns." } - }, - "tracking": { - "type": "object", - "title": "Campaign Tracking Options", - "description": "The tracking options for a campaign.", - "properties": { - "opens": { - "type": "boolean", - "title": "Opens", - "description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns." - }, - "html_clicks": { - "type": "boolean", - "title": "HTML Click Tracking", - "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns." - }, - "text_clicks": { - "type": "boolean", - "title": "Plain-Text Click Tracking", - "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns." - }, - "goal_tracking": { - "type": "boolean", - "title": "Mailchimp Goal Tracking", - "description": "Whether to enable [Goal](https://mailchimp.com/help/about-connected-sites/) tracking." - }, - "ecomm360": { - "type": "boolean", - "title": "E-commerce Tracking", - "description": "Whether to enable [eCommerce360](https://mailchimp.com/help/connect-your-online-store-to-mailchimp/) tracking." - }, - "google_analytics": { - "type": "string", - "title": "Google Analytics Tracking", - "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." - }, - "clicktale": { - "type": "string", - "title": "ClickTale Analytics Tracking", - "description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." - }, - "salesforce": { - "type": "object", - "title": "Salesforce CRM Tracking", - "description": "Salesforce tracking options for a campaign. Must be using Mailchimp's built-in [Salesforce integration](https://mailchimp.com/help/integrate-salesforce-with-mailchimp/).", - "properties": { - "campaign": { - "type": "boolean", - "title": "Salesforce Campaign", - "description": "Create a campaign in a connected Salesforce account." - }, - "notes": { - "type": "boolean", - "title": "Salesforce Note", - "description": "Update contact notes for a campaign based on subscriber email addresses." - } - } - }, - "capsule": { - "type": "object", - "title": "Capsule CRM Tracking", - "description": "Capsule tracking options for a campaign. Must be using Mailchimp's built-in Capsule integration.", - "properties": { - "notes": { - "type": "boolean", - "title": "Capsule Note", - "description": "Update contact notes for a campaign based on subscriber email addresses." - } - } - } + } + }, + "ab_split_opts": { + "type": "object", + "title": "A/B Testing Options", + "description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign.", + "readOnly": true, + "properties": { + "split_test": { + "type": "string", + "title": "Split Test", + "description": "The type of AB split to run.", + "enum": ["subject", "from_name", "schedule"] + }, + "pick_winner": { + "type": "string", + "title": "Pick Winner", + "description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'.", + "enum": ["opens", "clicks", "manual"] + }, + "wait_units": { + "type": "string", + "title": "Wait Time", + "description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent.", + "enum": ["hours", "days"] + }, + "wait_time": { + "type": "integer", + "title": "Wait Time", + "description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent." + }, + "split_size": { + "type": "integer", + "minimum": 1, + "maximum": 50, + "title": "Split Size", + "description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50." + }, + "from_name_a": { + "type": "string", + "title": "From Name Group A", + "description": "For campaigns split on 'From Name', the name for Group A." + }, + "from_name_b": { + "type": "string", + "title": "From Name Group B", + "description": "For campaigns split on 'From Name', the name for Group B." + }, + "reply_email_a": { + "type": "string", + "title": "Reply Email Group A", + "description": "For campaigns split on 'From Name', the reply-to address for Group A." + }, + "reply_email_b": { + "type": "string", + "title": "Reply Email Group B", + "description": "For campaigns split on 'From Name', the reply-to address for Group B." + }, + "subject_a": { + "type": "string", + "title": "Subject Line Group A", + "description": "For campaigns split on 'Subject Line', the subject line for Group A." + }, + "subject_b": { + "type": "string", + "title": "Subject Line Group B", + "description": "For campaigns split on 'Subject Line', the subject line for Group B." + }, + "send_time_a": { + "type": "string", + "format": "date-time", + "title": "Send Time Group A", + "description": "The send time for Group A." + }, + "send_time_b": { + "type": "string", + "format": "date-time", + "title": "Send Time Group B", + "description": "The send time for Group B." + }, + "send_time_winner": { + "type": "string", + "title": "Send Time Winner", + "description": "The send time for the winning version." } - }, - "rss_opts": { - "type": "object", - "title": "RSS Options", - "description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.", - "properties": { - "feed_url": { - "type": "string", - "title": "Feed URL", - "format": "uri", - "description": "The URL for the RSS feed." - }, - "frequency": { - "type": "string", - "title": "Frequency", - "description": "The frequency of the RSS Campaign.", - "enum": ["daily", "weekly", "monthly"] - }, - "schedule": { - "type": "object", - "title": "Sending Schedule", - "description": "The schedule for sending the RSS Campaign.", - "properties": { - "hour": { - "type": "integer", - "minimum": 0, - "maximum": 23, - "title": "Sending Hour", - "description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)." - }, - "daily_send": { - "type": "object", - "title": "Daily Sending Days", - "description": "The days of the week to send a daily RSS Campaign.", - "properties": { - "sunday": { - "type": "boolean", - "title": "Sunday", - "description": "Sends the daily RSS Campaign on Sundays." - }, - "monday": { - "type": "boolean", - "title": "Monday", - "description": "Sends the daily RSS Campaign on Mondays." - }, - "tuesday": { - "type": "boolean", - "title": "tuesday", - "description": "Sends the daily RSS Campaign on Tuesdays." - }, - "wednesday": { - "type": "boolean", - "title": "Monday", - "description": "Sends the daily RSS Campaign on Wednesdays." - }, - "thursday": { - "type": "boolean", - "title": "Thursday", - "description": "Sends the daily RSS Campaign on Thursdays." - }, - "friday": { - "type": "boolean", - "title": "Friday", - "description": "Sends the daily RSS Campaign on Fridays." - }, - "saturday": { - "type": "boolean", - "title": "Saturday", - "description": "Sends the daily RSS Campaign on Saturdays." - } - } - }, - "weekly_send_day": { - "type": "string", - "enum": [ - "sunday", - "monday", - "tuesday", - "wednesday", - "thursday", - "friday", - "saturday" - ], - "title": "Weekly Sending Day", - "description": "The day of the week to send a weekly RSS Campaign." - }, - "monthly_send_date": { - "type": "number", - "minimum": 0, - "maximum": 31, - "title": "Monthly Sending Day", - "description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February." - } + } + }, + "social_card": { + "type": "object", + "title": "Campaign Social Card", + "description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/).", + "properties": { + "image_url": { + "type": "string", + "title": "Image URL", + "description": "The url for the header image for the card." + }, + "description": { + "type": "string", + "title": "Campaign Description", + "description": "A short summary of the campaign to display." + }, + "title": { + "type": "string", + "title": "Title", + "description": "The title for the card. Typically the subject line of the campaign." + } + } + }, + "report_summary": { + "type": "object", + "title": "Campaign Report Summary", + "description": "For sent campaigns, a summary of opens, clicks, and e-commerce data.", + "properties": { + "opens": { + "type": "integer", + "title": "Automation Opens", + "description": "The total number of opens for a campaign.", + "readOnly": true + }, + "unique_opens": { + "type": "integer", + "title": "Unique Opens", + "description": "The number of unique opens.", + "readOnly": true + }, + "open_rate": { + "type": "number", + "title": "Open Rate", + "description": "The number of unique opens divided by the total number of successful deliveries.", + "readOnly": true + }, + "clicks": { + "type": "integer", + "title": "Total Clicks", + "description": "The total number of clicks for an campaign.", + "readOnly": true + }, + "subscriber_clicks": { + "type": "integer", + "title": "Unique Subscriber Clicks", + "description": "The number of unique clicks.", + "readOnly": true + }, + "click_rate": { + "type": "number", + "title": "Click Rate", + "description": "The number of unique clicks divided by the total number of successful deliveries.", + "readOnly": true + }, + "ecommerce": { + "type": "object", + "title": "E-Commerce Report", + "description": "E-Commerce stats for a campaign.", + "properties": { + "total_orders": { + "type": "integer", + "title": "Total Orders", + "description": "The total orders for a campaign.", + "readOnly": true + }, + "total_spent": { + "type": "number", + "title": "Total Spent", + "description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions.", + "readOnly": true + }, + "total_revenue": { + "type": "number", + "title": "Total Revenue", + "description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.", + "readOnly": true } - }, - "last_sent": { - "type": "string", - "format": "date-time", - "title": "Last Sent", - "description": "The date the campaign was last sent.", - "readOnly": true - }, - "constrain_rss_img": { - "type": "boolean", - "title": "Constrain RSS Images", - "description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns." } } - }, - "ab_split_opts": { - "type": "object", - "title": "A/B Testing Options", - "description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign.", - "readOnly": true, - "properties": { - "split_test": { - "type": "string", - "title": "Split Test", - "description": "The type of AB split to run.", - "enum": ["subject", "from_name", "schedule"] - }, - "pick_winner": { - "type": "string", - "title": "Pick Winner", - "description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'.", - "enum": ["opens", "clicks", "manual"] - }, - "wait_units": { - "type": "string", - "title": "Wait Time", - "description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent.", - "enum": ["hours", "days"] - }, - "wait_time": { - "type": "integer", - "title": "Wait Time", - "description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent." - }, - "split_size": { - "type": "integer", - "minimum": 1, - "maximum": 50, - "title": "Split Size", - "description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50." - }, - "from_name_a": { - "type": "string", - "title": "From Name Group A", - "description": "For campaigns split on 'From Name', the name for Group A." - }, - "from_name_b": { - "type": "string", - "title": "From Name Group B", - "description": "For campaigns split on 'From Name', the name for Group B." - }, - "reply_email_a": { - "type": "string", - "title": "Reply Email Group A", - "description": "For campaigns split on 'From Name', the reply-to address for Group A." - }, - "reply_email_b": { - "type": "string", - "title": "Reply Email Group B", - "description": "For campaigns split on 'From Name', the reply-to address for Group B." - }, - "subject_a": { - "type": "string", - "title": "Subject Line Group A", - "description": "For campaigns split on 'Subject Line', the subject line for Group A." - }, - "subject_b": { - "type": "string", - "title": "Subject Line Group B", - "description": "For campaigns split on 'Subject Line', the subject line for Group B." - }, - "send_time_a": { - "type": "string", - "format": "date-time", - "title": "Send Time Group A", - "description": "The send time for Group A." - }, - "send_time_b": { - "type": "string", - "format": "date-time", - "title": "Send Time Group B", - "description": "The send time for Group B." - }, - "send_time_winner": { - "type": "string", - "title": "Send Time Winner", - "description": "The send time for the winning version." - } + } + }, + "delivery_status": { + "type": "object", + "title": "Campaign Delivery Status", + "description": "Updates on campaigns in the process of sending.", + "properties": { + "enabled": { + "type": "boolean", + "title": "Delivery Status Enabled", + "description": "Whether Campaign Delivery Status is enabled for this account and campaign.", + "readOnly": true + }, + "can_cancel": { + "type": "boolean", + "title": "Campaign Cancelable", + "description": "Whether a campaign send can be canceled.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Campaign Delivery Status", + "description": "The current state of a campaign delivery.", + "enum": ["delivering", "delivered", "canceling", "canceled"], + "readOnly": true + }, + "emails_sent": { + "type": "integer", + "title": "Emails Sent", + "description": "The total number of emails confirmed sent for this campaign so far.", + "readOnly": true + }, + "emails_canceled": { + "type": "integer", + "title": "Emails Canceled", + "description": "The total number of emails canceled for this campaign.", + "readOnly": true } - }, - "social_card": { + } + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { "type": "object", - "title": "Campaign Social Card", - "description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/).", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { - "image_url": { - "type": "string", - "title": "Image URL", - "description": "The url for the header image for the card." - }, - "description": { - "type": "string", - "title": "Campaign Description", - "description": "A short summary of the campaign to display." - }, - "title": { + "rel": { "type": "string", - "title": "Title", - "description": "The title for the card. Typically the subject line of the campaign." - } - } - }, - "report_summary": { - "type": "object", - "title": "Campaign Report Summary", - "description": "For sent campaigns, a summary of opens, clicks, and e-commerce data.", - "properties": { - "opens": { - "type": "integer", - "title": "Automation Opens", - "description": "The total number of opens for a campaign.", - "readOnly": true - }, - "unique_opens": { - "type": "integer", - "title": "Unique Opens", - "description": "The number of unique opens.", - "readOnly": true - }, - "open_rate": { - "type": "number", - "title": "Open Rate", - "description": "The number of unique opens divided by the total number of successful deliveries.", - "readOnly": true - }, - "clicks": { - "type": "integer", - "title": "Total Clicks", - "description": "The total number of clicks for an campaign.", - "readOnly": true - }, - "subscriber_clicks": { - "type": "integer", - "title": "Unique Subscriber Clicks", - "description": "The number of unique clicks.", - "readOnly": true - }, - "click_rate": { - "type": "number", - "title": "Click Rate", - "description": "The number of unique clicks divided by the total number of successful deliveries.", - "readOnly": true - }, - "ecommerce": { - "type": "object", - "title": "E-Commerce Report", - "description": "E-Commerce stats for a campaign.", - "properties": { - "total_orders": { - "type": "integer", - "title": "Total Orders", - "description": "The total orders for a campaign.", - "readOnly": true - }, - "total_spent": { - "type": "number", - "title": "Total Spent", - "description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions.", - "readOnly": true - }, - "total_revenue": { - "type": "number", - "title": "Total Revenue", - "description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals.", - "readOnly": true - } - } - } - } - }, - "delivery_status": { - "type": "object", - "title": "Campaign Delivery Status", - "description": "Updates on campaigns in the process of sending.", - "properties": { - "enabled": { - "type": "boolean", - "title": "Delivery Status Enabled", - "description": "Whether Campaign Delivery Status is enabled for this account and campaign.", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, - "can_cancel": { - "type": "boolean", - "title": "Campaign Cancelable", - "description": "Whether a campaign send can be canceled.", + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, - "status": { + "method": { "type": "string", - "title": "Campaign Delivery Status", - "description": "The current state of a campaign delivery.", - "enum": ["delivering", "delivered", "canceling", "canceled"], + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], "readOnly": true }, - "emails_sent": { - "type": "integer", - "title": "Emails Sent", - "description": "The total number of emails confirmed sent for this campaign so far.", + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, - "emails_canceled": { - "type": "integer", - "title": "Emails Canceled", - "description": "The total number of emails canceled for this campaign.", + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } + "readOnly": true } } } }, { "name": "Lists", + "supported_sync_modes": ["full_refresh", "incremental"], + "source_defined_cursor": true, + "default_cursor_field": "date_created", "json_schema": { "type": "object", "title": "Subscriber List",