mailchimp_transactional 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +395 -0
- data/Rakefile +8 -0
- data/docs/Body.md +9 -0
- data/docs/Body1.md +8 -0
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +11 -0
- data/docs/Body12.md +9 -0
- data/docs/Body13.md +13 -0
- data/docs/Body14.md +8 -0
- data/docs/Body15.md +9 -0
- data/docs/Body16.md +10 -0
- data/docs/Body17.md +9 -0
- data/docs/Body18.md +9 -0
- data/docs/Body19.md +11 -0
- data/docs/Body2.md +9 -0
- data/docs/Body20.md +9 -0
- data/docs/Body21.md +8 -0
- data/docs/Body22.md +9 -0
- data/docs/Body23.md +9 -0
- data/docs/Body24.md +9 -0
- data/docs/Body25.md +10 -0
- data/docs/Body26.md +10 -0
- data/docs/Body27.md +12 -0
- data/docs/Body28.md +14 -0
- data/docs/Body29.md +15 -0
- data/docs/Body3.md +9 -0
- data/docs/Body30.md +13 -0
- data/docs/Body31.md +9 -0
- data/docs/Body32.md +9 -0
- data/docs/Body33.md +9 -0
- data/docs/Body34.md +16 -0
- data/docs/Body35.md +9 -0
- data/docs/Body36.md +9 -0
- data/docs/Body37.md +10 -0
- data/docs/Body38.md +8 -0
- data/docs/Body39.md +10 -0
- data/docs/Body4.md +15 -0
- data/docs/Body40.md +10 -0
- data/docs/Body41.md +9 -0
- data/docs/Body42.md +11 -0
- data/docs/Body43.md +11 -0
- data/docs/Body44.md +10 -0
- data/docs/Body45.md +8 -0
- data/docs/Body46.md +8 -0
- data/docs/Body47.md +9 -0
- data/docs/Body48.md +9 -0
- data/docs/Body49.md +10 -0
- data/docs/Body5.md +8 -0
- data/docs/Body50.md +9 -0
- data/docs/Body51.md +9 -0
- data/docs/Body52.md +9 -0
- data/docs/Body53.md +12 -0
- data/docs/Body54.md +9 -0
- data/docs/Body55.md +12 -0
- data/docs/Body56.md +9 -0
- data/docs/Body57.md +9 -0
- data/docs/Body58.md +9 -0
- data/docs/Body59.md +8 -0
- data/docs/Body6.md +9 -0
- data/docs/Body60.md +9 -0
- data/docs/Body61.md +9 -0
- data/docs/Body62.md +9 -0
- data/docs/Body63.md +8 -0
- data/docs/Body64.md +16 -0
- data/docs/Body65.md +9 -0
- data/docs/Body66.md +16 -0
- data/docs/Body67.md +9 -0
- data/docs/Body68.md +9 -0
- data/docs/Body69.md +9 -0
- data/docs/Body7.md +9 -0
- data/docs/Body70.md +9 -0
- data/docs/Body71.md +11 -0
- data/docs/Body72.md +8 -0
- data/docs/Body73.md +9 -0
- data/docs/Body74.md +9 -0
- data/docs/Body75.md +8 -0
- data/docs/Body76.md +9 -0
- data/docs/Body77.md +9 -0
- data/docs/Body78.md +8 -0
- data/docs/Body79.md +8 -0
- data/docs/Body8.md +9 -0
- data/docs/Body80.md +8 -0
- data/docs/Body81.md +8 -0
- data/docs/Body82.md +8 -0
- data/docs/Body83.md +11 -0
- data/docs/Body84.md +9 -0
- data/docs/Body85.md +12 -0
- data/docs/Body86.md +9 -0
- data/docs/Body87.md +10 -0
- data/docs/Body88.md +9 -0
- data/docs/Body89.md +9 -0
- data/docs/Body9.md +9 -0
- data/docs/InlineResponse200.md +13 -0
- data/docs/InlineResponse2001.md +13 -0
- data/docs/InlineResponse20010.md +10 -0
- data/docs/InlineResponse20011.md +10 -0
- data/docs/InlineResponse20012.md +10 -0
- data/docs/InlineResponse20013.md +10 -0
- data/docs/InlineResponse20014.md +13 -0
- data/docs/InlineResponse20015.md +13 -0
- data/docs/InlineResponse20016.md +8 -0
- data/docs/InlineResponse20017.md +13 -0
- data/docs/InlineResponse20018.md +13 -0
- data/docs/InlineResponse20019.md +9 -0
- data/docs/InlineResponse2002.md +13 -0
- data/docs/InlineResponse20020.md +10 -0
- data/docs/InlineResponse20021.md +10 -0
- data/docs/InlineResponse20022.md +9 -0
- data/docs/InlineResponse20023.md +9 -0
- data/docs/InlineResponse20024.md +13 -0
- data/docs/InlineResponse20025.md +11 -0
- data/docs/InlineResponse20026.md +11 -0
- data/docs/InlineResponse20027.md +20 -0
- data/docs/InlineResponse20028.md +18 -0
- data/docs/InlineResponse20029.md +21 -0
- data/docs/InlineResponse20029SmtpEvents.md +10 -0
- data/docs/InlineResponse2003.md +13 -0
- data/docs/InlineResponse20030.md +18 -0
- data/docs/InlineResponse20030Attachments.md +10 -0
- data/docs/InlineResponse20030To.md +9 -0
- data/docs/InlineResponse20031.md +16 -0
- data/docs/InlineResponse20031Attachments.md +11 -0
- data/docs/InlineResponse20031Images.md +10 -0
- data/docs/InlineResponse20031To.md +9 -0
- data/docs/InlineResponse20032.md +13 -0
- data/docs/InlineResponse20033.md +10 -0
- data/docs/InlineResponse20034.md +10 -0
- data/docs/InlineResponse20035.md +10 -0
- data/docs/InlineResponse20036.md +10 -0
- data/docs/InlineResponse20037.md +9 -0
- data/docs/InlineResponse20038.md +16 -0
- data/docs/InlineResponse20039.md +10 -0
- data/docs/InlineResponse2004.md +13 -0
- data/docs/InlineResponse20040.md +19 -0
- data/docs/InlineResponse20041.md +14 -0
- data/docs/InlineResponse20042.md +14 -0
- data/docs/InlineResponse20043.md +14 -0
- data/docs/InlineResponse20044.md +10 -0
- data/docs/InlineResponse20045.md +18 -0
- data/docs/InlineResponse20045Stats.md +12 -0
- data/docs/InlineResponse20045StatsLast30Days.md +17 -0
- data/docs/InlineResponse20045StatsLast60Days.md +17 -0
- data/docs/InlineResponse20045StatsLast7Days.md +17 -0
- data/docs/InlineResponse20045StatsLast90Days.md +17 -0
- data/docs/InlineResponse20045StatsToday.md +17 -0
- data/docs/InlineResponse20046.md +17 -0
- data/docs/InlineResponse20047.md +17 -0
- data/docs/InlineResponse20048.md +17 -0
- data/docs/InlineResponse20049.md +21 -0
- data/docs/InlineResponse20049Last30Days.md +17 -0
- data/docs/InlineResponse2005.md +10 -0
- data/docs/InlineResponse20050.md +17 -0
- data/docs/InlineResponse20051.md +17 -0
- data/docs/InlineResponse20052.md +17 -0
- data/docs/InlineResponse20053.md +17 -0
- data/docs/InlineResponse20054.md +19 -0
- data/docs/InlineResponse20055.md +19 -0
- data/docs/InlineResponse20056.md +17 -0
- data/docs/InlineResponse20056Stats.md +12 -0
- data/docs/InlineResponse20056StatsLast30Days.md +17 -0
- data/docs/InlineResponse20056StatsLast60Days.md +17 -0
- data/docs/InlineResponse20056StatsLast7Days.md +17 -0
- data/docs/InlineResponse20056StatsLast90Days.md +17 -0
- data/docs/InlineResponse20056StatsToday.md +17 -0
- data/docs/InlineResponse20057.md +24 -0
- data/docs/InlineResponse20058.md +24 -0
- data/docs/InlineResponse20059.md +24 -0
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse20060.md +24 -0
- data/docs/InlineResponse20061.md +24 -0
- data/docs/InlineResponse20062.md +24 -0
- data/docs/InlineResponse20063.md +8 -0
- data/docs/InlineResponse20064.md +11 -0
- data/docs/InlineResponse20065.md +11 -0
- data/docs/InlineResponse20066.md +11 -0
- data/docs/InlineResponse20067.md +12 -0
- data/docs/InlineResponse20068.md +12 -0
- data/docs/InlineResponse20069.md +14 -0
- data/docs/InlineResponse20069Stats.md +13 -0
- data/docs/InlineResponse20069StatsAllTime.md +17 -0
- data/docs/InlineResponse20069StatsLast30Days.md +17 -0
- data/docs/InlineResponse20069StatsLast60Days.md +17 -0
- data/docs/InlineResponse20069StatsLast7Days.md +17 -0
- data/docs/InlineResponse20069StatsLast90Days.md +17 -0
- data/docs/InlineResponse20069StatsToday.md +17 -0
- data/docs/InlineResponse2007.md +10 -0
- data/docs/InlineResponse20070.md +8 -0
- data/docs/InlineResponse20071.md +17 -0
- data/docs/InlineResponse20072.md +17 -0
- data/docs/InlineResponse20073.md +17 -0
- data/docs/InlineResponse20074.md +17 -0
- data/docs/InlineResponse20075.md +17 -0
- data/docs/InlineResponse20076.md +9 -0
- data/docs/InlineResponse20077.md +10 -0
- data/docs/InlineResponse20078.md +9 -0
- data/docs/InlineResponse2008.md +10 -0
- data/docs/InlineResponse2009.md +10 -0
- data/docs/IpslistCustomDns.md +10 -0
- data/docs/IpslistWarmup.md +10 -0
- data/docs/IpslistpoolsIps.md +13 -0
- data/docs/MessagessearchClicksDetail.md +12 -0
- data/docs/MessagessearchOpensDetail.md +11 -0
- data/docs/MessagessendMessage.md +39 -0
- data/docs/MessagessendMessageAttachments.md +10 -0
- data/docs/MessagessendMessageGlobalMergeVars.md +9 -0
- data/docs/MessagessendMessageImages.md +10 -0
- data/docs/MessagessendMessageMergeVars.md +9 -0
- data/docs/MessagessendMessageMetadata.md +8 -0
- data/docs/MessagessendMessageRecipientMetadata.md +9 -0
- data/docs/MessagessendMessageTo.md +10 -0
- data/docs/MessagessendMessageValues.md +8 -0
- data/docs/MessagessendMessageVars.md +9 -0
- data/docs/MessagessendtemplateMessage.md +39 -0
- data/docs/MessagessendtemplateTemplateContent.md +9 -0
- data/docs/RejectslistSender.md +19 -0
- data/docs/SendersdomainsDkim.md +10 -0
- data/docs/SendersdomainsSpf.md +10 -0
- data/docs/TemplatesrenderMergeVars.md +9 -0
- data/docs/TemplatesrenderTemplateContent.md +9 -0
- data/docs/TransactionalApi.md +4328 -0
- data/docs/UrlstrackingdomainsCname.md +10 -0
- data/git_push.sh +55 -0
- data/lib/mailchimp_transactional/api/transactional_api.rb +4883 -0
- data/lib/mailchimp_transactional/api_client.rb +390 -0
- data/lib/mailchimp_transactional/api_error.rb +38 -0
- data/lib/mailchimp_transactional/configuration.rb +202 -0
- data/lib/mailchimp_transactional/models/body.rb +205 -0
- data/lib/mailchimp_transactional/models/body_1.rb +190 -0
- data/lib/mailchimp_transactional/models/body_10.rb +235 -0
- data/lib/mailchimp_transactional/models/body_11.rb +225 -0
- data/lib/mailchimp_transactional/models/body_12.rb +205 -0
- data/lib/mailchimp_transactional/models/body_13.rb +247 -0
- data/lib/mailchimp_transactional/models/body_14.rb +190 -0
- data/lib/mailchimp_transactional/models/body_15.rb +200 -0
- data/lib/mailchimp_transactional/models/body_16.rb +210 -0
- data/lib/mailchimp_transactional/models/body_17.rb +205 -0
- data/lib/mailchimp_transactional/models/body_18.rb +205 -0
- data/lib/mailchimp_transactional/models/body_19.rb +230 -0
- data/lib/mailchimp_transactional/models/body_2.rb +200 -0
- data/lib/mailchimp_transactional/models/body_20.rb +205 -0
- data/lib/mailchimp_transactional/models/body_21.rb +190 -0
- data/lib/mailchimp_transactional/models/body_22.rb +205 -0
- data/lib/mailchimp_transactional/models/body_23.rb +205 -0
- data/lib/mailchimp_transactional/models/body_24.rb +205 -0
- data/lib/mailchimp_transactional/models/body_25.rb +220 -0
- data/lib/mailchimp_transactional/models/body_26.rb +220 -0
- data/lib/mailchimp_transactional/models/body_27.rb +234 -0
- data/lib/mailchimp_transactional/models/body_28.rb +266 -0
- data/lib/mailchimp_transactional/models/body_29.rb +290 -0
- data/lib/mailchimp_transactional/models/body_3.rb +200 -0
- data/lib/mailchimp_transactional/models/body_30.rb +244 -0
- data/lib/mailchimp_transactional/models/body_31.rb +205 -0
- data/lib/mailchimp_transactional/models/body_32.rb +205 -0
- data/lib/mailchimp_transactional/models/body_33.rb +205 -0
- data/lib/mailchimp_transactional/models/body_34.rb +277 -0
- data/lib/mailchimp_transactional/models/body_35.rb +200 -0
- data/lib/mailchimp_transactional/models/body_36.rb +205 -0
- data/lib/mailchimp_transactional/models/body_37.rb +220 -0
- data/lib/mailchimp_transactional/models/body_38.rb +190 -0
- data/lib/mailchimp_transactional/models/body_39.rb +249 -0
- data/lib/mailchimp_transactional/models/body_4.rb +290 -0
- data/lib/mailchimp_transactional/models/body_40.rb +239 -0
- data/lib/mailchimp_transactional/models/body_41.rb +205 -0
- data/lib/mailchimp_transactional/models/body_42.rb +240 -0
- data/lib/mailchimp_transactional/models/body_43.rb +235 -0
- data/lib/mailchimp_transactional/models/body_44.rb +230 -0
- data/lib/mailchimp_transactional/models/body_45.rb +190 -0
- data/lib/mailchimp_transactional/models/body_46.rb +190 -0
- data/lib/mailchimp_transactional/models/body_47.rb +205 -0
- data/lib/mailchimp_transactional/models/body_48.rb +205 -0
- data/lib/mailchimp_transactional/models/body_49.rb +220 -0
- data/lib/mailchimp_transactional/models/body_5.rb +190 -0
- data/lib/mailchimp_transactional/models/body_50.rb +205 -0
- data/lib/mailchimp_transactional/models/body_51.rb +205 -0
- data/lib/mailchimp_transactional/models/body_52.rb +200 -0
- data/lib/mailchimp_transactional/models/body_53.rb +284 -0
- data/lib/mailchimp_transactional/models/body_54.rb +205 -0
- data/lib/mailchimp_transactional/models/body_55.rb +265 -0
- data/lib/mailchimp_transactional/models/body_56.rb +205 -0
- data/lib/mailchimp_transactional/models/body_57.rb +205 -0
- data/lib/mailchimp_transactional/models/body_58.rb +205 -0
- data/lib/mailchimp_transactional/models/body_59.rb +190 -0
- data/lib/mailchimp_transactional/models/body_6.rb +205 -0
- data/lib/mailchimp_transactional/models/body_60.rb +205 -0
- data/lib/mailchimp_transactional/models/body_61.rb +205 -0
- data/lib/mailchimp_transactional/models/body_62.rb +205 -0
- data/lib/mailchimp_transactional/models/body_63.rb +190 -0
- data/lib/mailchimp_transactional/models/body_64.rb +277 -0
- data/lib/mailchimp_transactional/models/body_65.rb +205 -0
- data/lib/mailchimp_transactional/models/body_66.rb +277 -0
- data/lib/mailchimp_transactional/models/body_67.rb +205 -0
- data/lib/mailchimp_transactional/models/body_68.rb +205 -0
- data/lib/mailchimp_transactional/models/body_69.rb +200 -0
- data/lib/mailchimp_transactional/models/body_7.rb +205 -0
- data/lib/mailchimp_transactional/models/body_70.rb +205 -0
- data/lib/mailchimp_transactional/models/body_71.rb +234 -0
- data/lib/mailchimp_transactional/models/body_72.rb +190 -0
- data/lib/mailchimp_transactional/models/body_73.rb +205 -0
- data/lib/mailchimp_transactional/models/body_74.rb +205 -0
- data/lib/mailchimp_transactional/models/body_75.rb +190 -0
- data/lib/mailchimp_transactional/models/body_76.rb +205 -0
- data/lib/mailchimp_transactional/models/body_77.rb +205 -0
- data/lib/mailchimp_transactional/models/body_78.rb +190 -0
- data/lib/mailchimp_transactional/models/body_79.rb +190 -0
- data/lib/mailchimp_transactional/models/body_8.rb +205 -0
- data/lib/mailchimp_transactional/models/body_80.rb +190 -0
- data/lib/mailchimp_transactional/models/body_81.rb +190 -0
- data/lib/mailchimp_transactional/models/body_82.rb +190 -0
- data/lib/mailchimp_transactional/models/body_83.rb +249 -0
- data/lib/mailchimp_transactional/models/body_84.rb +205 -0
- data/lib/mailchimp_transactional/models/body_85.rb +264 -0
- data/lib/mailchimp_transactional/models/body_86.rb +205 -0
- data/lib/mailchimp_transactional/models/body_87.rb +230 -0
- data/lib/mailchimp_transactional/models/body_88.rb +200 -0
- data/lib/mailchimp_transactional/models/body_89.rb +205 -0
- data/lib/mailchimp_transactional/models/body_9.rb +205 -0
- data/lib/mailchimp_transactional/models/inline_response_200.rb +236 -0
- data/lib/mailchimp_transactional/models/inline_response_200_1.rb +236 -0
- data/lib/mailchimp_transactional/models/inline_response_200_10.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_11.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_12.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_13.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_14.rb +234 -0
- data/lib/mailchimp_transactional/models/inline_response_200_15.rb +234 -0
- data/lib/mailchimp_transactional/models/inline_response_200_16.rb +186 -0
- data/lib/mailchimp_transactional/models/inline_response_200_17.rb +234 -0
- data/lib/mailchimp_transactional/models/inline_response_200_18.rb +234 -0
- data/lib/mailchimp_transactional/models/inline_response_200_19.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_2.rb +236 -0
- data/lib/mailchimp_transactional/models/inline_response_200_20.rb +208 -0
- data/lib/mailchimp_transactional/models/inline_response_200_21.rb +208 -0
- data/lib/mailchimp_transactional/models/inline_response_200_22.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_23.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_24.rb +234 -0
- data/lib/mailchimp_transactional/models/inline_response_200_25.rb +262 -0
- data/lib/mailchimp_transactional/models/inline_response_200_26.rb +262 -0
- data/lib/mailchimp_transactional/models/inline_response_200_27.rb +346 -0
- data/lib/mailchimp_transactional/models/inline_response_200_28.rb +286 -0
- data/lib/mailchimp_transactional/models/inline_response_200_29.rb +358 -0
- data/lib/mailchimp_transactional/models/inline_response_200_29_smtp_events.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_3.rb +236 -0
- data/lib/mailchimp_transactional/models/inline_response_200_30.rb +289 -0
- data/lib/mailchimp_transactional/models/inline_response_200_30_attachments.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_30_to.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_31.rb +272 -0
- data/lib/mailchimp_transactional/models/inline_response_200_31_attachments.rb +216 -0
- data/lib/mailchimp_transactional/models/inline_response_200_31_images.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_31_to.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_32.rb +236 -0
- data/lib/mailchimp_transactional/models/inline_response_200_33.rb +240 -0
- data/lib/mailchimp_transactional/models/inline_response_200_34.rb +240 -0
- data/lib/mailchimp_transactional/models/inline_response_200_35.rb +240 -0
- data/lib/mailchimp_transactional/models/inline_response_200_36.rb +240 -0
- data/lib/mailchimp_transactional/models/inline_response_200_37.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_38.rb +265 -0
- data/lib/mailchimp_transactional/models/inline_response_200_39.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_4.rb +236 -0
- data/lib/mailchimp_transactional/models/inline_response_200_40.rb +296 -0
- data/lib/mailchimp_transactional/models/inline_response_200_41.rb +244 -0
- data/lib/mailchimp_transactional/models/inline_response_200_42.rb +244 -0
- data/lib/mailchimp_transactional/models/inline_response_200_43.rb +244 -0
- data/lib/mailchimp_transactional/models/inline_response_200_44.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45.rb +285 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45_stats.rb +221 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45_stats_last_30_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45_stats_last_60_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45_stats_last_7_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45_stats_last_90_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_45_stats_today.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_46.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_47.rb +334 -0
- data/lib/mailchimp_transactional/models/inline_response_200_48.rb +334 -0
- data/lib/mailchimp_transactional/models/inline_response_200_49.rb +373 -0
- data/lib/mailchimp_transactional/models/inline_response_200_49_last_30_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_5.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_50.rb +334 -0
- data/lib/mailchimp_transactional/models/inline_response_200_51.rb +334 -0
- data/lib/mailchimp_transactional/models/inline_response_200_52.rb +334 -0
- data/lib/mailchimp_transactional/models/inline_response_200_53.rb +334 -0
- data/lib/mailchimp_transactional/models/inline_response_200_54.rb +320 -0
- data/lib/mailchimp_transactional/models/inline_response_200_55.rb +320 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56.rb +275 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56_stats.rb +221 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56_stats_last_30_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56_stats_last_60_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56_stats_last_7_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56_stats_last_90_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_56_stats_today.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_57.rb +348 -0
- data/lib/mailchimp_transactional/models/inline_response_200_58.rb +348 -0
- data/lib/mailchimp_transactional/models/inline_response_200_59.rb +348 -0
- data/lib/mailchimp_transactional/models/inline_response_200_6.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_60.rb +348 -0
- data/lib/mailchimp_transactional/models/inline_response_200_61.rb +348 -0
- data/lib/mailchimp_transactional/models/inline_response_200_62.rb +348 -0
- data/lib/mailchimp_transactional/models/inline_response_200_63.rb +186 -0
- data/lib/mailchimp_transactional/models/inline_response_200_64.rb +216 -0
- data/lib/mailchimp_transactional/models/inline_response_200_65.rb +216 -0
- data/lib/mailchimp_transactional/models/inline_response_200_66.rb +216 -0
- data/lib/mailchimp_transactional/models/inline_response_200_67.rb +225 -0
- data/lib/mailchimp_transactional/models/inline_response_200_68.rb +225 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69.rb +245 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats.rb +230 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats_all_time.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats_last_30_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats_last_60_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats_last_7_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats_last_90_days.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_69_stats_today.rb +276 -0
- data/lib/mailchimp_transactional/models/inline_response_200_7.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_70.rb +186 -0
- data/lib/mailchimp_transactional/models/inline_response_200_71.rb +300 -0
- data/lib/mailchimp_transactional/models/inline_response_200_72.rb +300 -0
- data/lib/mailchimp_transactional/models/inline_response_200_73.rb +300 -0
- data/lib/mailchimp_transactional/models/inline_response_200_74.rb +300 -0
- data/lib/mailchimp_transactional/models/inline_response_200_75.rb +300 -0
- data/lib/mailchimp_transactional/models/inline_response_200_76.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_77.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_78.rb +196 -0
- data/lib/mailchimp_transactional/models/inline_response_200_8.rb +206 -0
- data/lib/mailchimp_transactional/models/inline_response_200_9.rb +206 -0
- data/lib/mailchimp_transactional/models/ipslist_custom_dns.rb +206 -0
- data/lib/mailchimp_transactional/models/ipslist_warmup.rb +206 -0
- data/lib/mailchimp_transactional/models/ipslistpools_ips.rb +234 -0
- data/lib/mailchimp_transactional/models/messagessearch_clicks_detail.rb +226 -0
- data/lib/mailchimp_transactional/models/messagessearch_opens_detail.rb +216 -0
- data/lib/mailchimp_transactional/models/messagessend_message.rb +545 -0
- data/lib/mailchimp_transactional/models/messagessend_message_attachments.rb +206 -0
- data/lib/mailchimp_transactional/models/messagessend_message_global_merge_vars.rb +196 -0
- data/lib/mailchimp_transactional/models/messagessend_message_images.rb +206 -0
- data/lib/mailchimp_transactional/models/messagessend_message_merge_vars.rb +203 -0
- data/lib/mailchimp_transactional/models/messagessend_message_metadata.rb +186 -0
- data/lib/mailchimp_transactional/models/messagessend_message_recipient_metadata.rb +195 -0
- data/lib/mailchimp_transactional/models/messagessend_message_to.rb +245 -0
- data/lib/mailchimp_transactional/models/messagessend_message_values.rb +186 -0
- data/lib/mailchimp_transactional/models/messagessend_message_vars.rb +195 -0
- data/lib/mailchimp_transactional/models/messagessendtemplate_message.rb +545 -0
- data/lib/mailchimp_transactional/models/messagessendtemplate_template_content.rb +196 -0
- data/lib/mailchimp_transactional/models/rejectslist_sender.rb +296 -0
- data/lib/mailchimp_transactional/models/sendersdomains_dkim.rb +206 -0
- data/lib/mailchimp_transactional/models/sendersdomains_spf.rb +206 -0
- data/lib/mailchimp_transactional/models/templatesrender_merge_vars.rb +196 -0
- data/lib/mailchimp_transactional/models/templatesrender_template_content.rb +206 -0
- data/lib/mailchimp_transactional/models/urlstrackingdomains_cname.rb +206 -0
- data/lib/mailchimp_transactional/version.rb +15 -0
- data/lib/mailchimp_transactional.rb +258 -0
- data/mailchimp_transactional.gemspec +45 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +59 -0
- data/spec/models/body_12_spec.rb +47 -0
- data/spec/models/body_13_spec.rb +71 -0
- data/spec/models/body_14_spec.rb +41 -0
- data/spec/models/body_15_spec.rb +47 -0
- data/spec/models/body_16_spec.rb +53 -0
- data/spec/models/body_17_spec.rb +47 -0
- data/spec/models/body_18_spec.rb +47 -0
- data/spec/models/body_19_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +41 -0
- data/spec/models/body_20_spec.rb +47 -0
- data/spec/models/body_21_spec.rb +41 -0
- data/spec/models/body_22_spec.rb +47 -0
- data/spec/models/body_23_spec.rb +47 -0
- data/spec/models/body_24_spec.rb +47 -0
- data/spec/models/body_25_spec.rb +53 -0
- data/spec/models/body_26_spec.rb +53 -0
- data/spec/models/body_27_spec.rb +65 -0
- data/spec/models/body_28_spec.rb +77 -0
- data/spec/models/body_29_spec.rb +83 -0
- data/spec/models/body_2_spec.rb +47 -0
- data/spec/models/body_30_spec.rb +71 -0
- data/spec/models/body_31_spec.rb +47 -0
- data/spec/models/body_32_spec.rb +47 -0
- data/spec/models/body_33_spec.rb +47 -0
- data/spec/models/body_34_spec.rb +89 -0
- data/spec/models/body_35_spec.rb +47 -0
- data/spec/models/body_36_spec.rb +47 -0
- data/spec/models/body_37_spec.rb +53 -0
- data/spec/models/body_38_spec.rb +41 -0
- data/spec/models/body_39_spec.rb +53 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_40_spec.rb +53 -0
- data/spec/models/body_41_spec.rb +47 -0
- data/spec/models/body_42_spec.rb +59 -0
- data/spec/models/body_43_spec.rb +59 -0
- data/spec/models/body_44_spec.rb +53 -0
- data/spec/models/body_45_spec.rb +41 -0
- data/spec/models/body_46_spec.rb +41 -0
- data/spec/models/body_47_spec.rb +47 -0
- data/spec/models/body_48_spec.rb +47 -0
- data/spec/models/body_49_spec.rb +53 -0
- data/spec/models/body_4_spec.rb +87 -0
- data/spec/models/body_50_spec.rb +47 -0
- data/spec/models/body_51_spec.rb +47 -0
- data/spec/models/body_52_spec.rb +47 -0
- data/spec/models/body_53_spec.rb +65 -0
- data/spec/models/body_54_spec.rb +47 -0
- data/spec/models/body_55_spec.rb +65 -0
- data/spec/models/body_56_spec.rb +47 -0
- data/spec/models/body_57_spec.rb +47 -0
- data/spec/models/body_58_spec.rb +47 -0
- data/spec/models/body_59_spec.rb +41 -0
- data/spec/models/body_5_spec.rb +41 -0
- data/spec/models/body_60_spec.rb +47 -0
- data/spec/models/body_61_spec.rb +47 -0
- data/spec/models/body_62_spec.rb +47 -0
- data/spec/models/body_63_spec.rb +41 -0
- data/spec/models/body_64_spec.rb +89 -0
- data/spec/models/body_65_spec.rb +47 -0
- data/spec/models/body_66_spec.rb +89 -0
- data/spec/models/body_67_spec.rb +47 -0
- data/spec/models/body_68_spec.rb +47 -0
- data/spec/models/body_69_spec.rb +47 -0
- data/spec/models/body_6_spec.rb +47 -0
- data/spec/models/body_70_spec.rb +47 -0
- data/spec/models/body_71_spec.rb +59 -0
- data/spec/models/body_72_spec.rb +41 -0
- data/spec/models/body_73_spec.rb +47 -0
- data/spec/models/body_74_spec.rb +47 -0
- data/spec/models/body_75_spec.rb +41 -0
- data/spec/models/body_76_spec.rb +47 -0
- data/spec/models/body_77_spec.rb +47 -0
- data/spec/models/body_78_spec.rb +41 -0
- data/spec/models/body_79_spec.rb +41 -0
- data/spec/models/body_7_spec.rb +47 -0
- data/spec/models/body_80_spec.rb +41 -0
- data/spec/models/body_81_spec.rb +41 -0
- data/spec/models/body_82_spec.rb +41 -0
- data/spec/models/body_83_spec.rb +63 -0
- data/spec/models/body_84_spec.rb +47 -0
- data/spec/models/body_85_spec.rb +69 -0
- data/spec/models/body_86_spec.rb +47 -0
- data/spec/models/body_87_spec.rb +53 -0
- data/spec/models/body_88_spec.rb +47 -0
- data/spec/models/body_89_spec.rb +47 -0
- data/spec/models/body_8_spec.rb +47 -0
- data/spec/models/body_9_spec.rb +47 -0
- data/spec/models/body_spec.rb +47 -0
- data/spec/models/inline_response_200_10_spec.rb +53 -0
- data/spec/models/inline_response_200_11_spec.rb +53 -0
- data/spec/models/inline_response_200_12_spec.rb +53 -0
- data/spec/models/inline_response_200_13_spec.rb +53 -0
- data/spec/models/inline_response_200_14_spec.rb +71 -0
- data/spec/models/inline_response_200_15_spec.rb +71 -0
- data/spec/models/inline_response_200_16_spec.rb +41 -0
- data/spec/models/inline_response_200_17_spec.rb +71 -0
- data/spec/models/inline_response_200_18_spec.rb +71 -0
- data/spec/models/inline_response_200_19_spec.rb +47 -0
- data/spec/models/inline_response_200_1_spec.rb +71 -0
- data/spec/models/inline_response_200_20_spec.rb +53 -0
- data/spec/models/inline_response_200_21_spec.rb +53 -0
- data/spec/models/inline_response_200_22_spec.rb +47 -0
- data/spec/models/inline_response_200_23_spec.rb +47 -0
- data/spec/models/inline_response_200_24_spec.rb +71 -0
- data/spec/models/inline_response_200_25_spec.rb +67 -0
- data/spec/models/inline_response_200_26_spec.rb +67 -0
- data/spec/models/inline_response_200_27_spec.rb +117 -0
- data/spec/models/inline_response_200_28_spec.rb +101 -0
- data/spec/models/inline_response_200_29_smtp_events_spec.rb +53 -0
- data/spec/models/inline_response_200_29_spec.rb +123 -0
- data/spec/models/inline_response_200_2_spec.rb +71 -0
- data/spec/models/inline_response_200_30_attachments_spec.rb +53 -0
- data/spec/models/inline_response_200_30_spec.rb +101 -0
- data/spec/models/inline_response_200_30_to_spec.rb +47 -0
- data/spec/models/inline_response_200_31_attachments_spec.rb +59 -0
- data/spec/models/inline_response_200_31_images_spec.rb +53 -0
- data/spec/models/inline_response_200_31_spec.rb +89 -0
- data/spec/models/inline_response_200_31_to_spec.rb +47 -0
- data/spec/models/inline_response_200_32_spec.rb +71 -0
- data/spec/models/inline_response_200_33_spec.rb +57 -0
- data/spec/models/inline_response_200_34_spec.rb +57 -0
- data/spec/models/inline_response_200_35_spec.rb +57 -0
- data/spec/models/inline_response_200_36_spec.rb +57 -0
- data/spec/models/inline_response_200_37_spec.rb +47 -0
- data/spec/models/inline_response_200_38_spec.rb +89 -0
- data/spec/models/inline_response_200_39_spec.rb +53 -0
- data/spec/models/inline_response_200_3_spec.rb +71 -0
- data/spec/models/inline_response_200_40_spec.rb +107 -0
- data/spec/models/inline_response_200_41_spec.rb +77 -0
- data/spec/models/inline_response_200_42_spec.rb +77 -0
- data/spec/models/inline_response_200_43_spec.rb +77 -0
- data/spec/models/inline_response_200_44_spec.rb +53 -0
- data/spec/models/inline_response_200_45_spec.rb +101 -0
- data/spec/models/inline_response_200_45_stats_last_30_days_spec.rb +95 -0
- data/spec/models/inline_response_200_45_stats_last_60_days_spec.rb +95 -0
- data/spec/models/inline_response_200_45_stats_last_7_days_spec.rb +95 -0
- data/spec/models/inline_response_200_45_stats_last_90_days_spec.rb +95 -0
- data/spec/models/inline_response_200_45_stats_spec.rb +65 -0
- data/spec/models/inline_response_200_45_stats_today_spec.rb +95 -0
- data/spec/models/inline_response_200_46_spec.rb +95 -0
- data/spec/models/inline_response_200_47_spec.rb +99 -0
- data/spec/models/inline_response_200_48_spec.rb +99 -0
- data/spec/models/inline_response_200_49_last_30_days_spec.rb +95 -0
- data/spec/models/inline_response_200_49_spec.rb +123 -0
- data/spec/models/inline_response_200_4_spec.rb +71 -0
- data/spec/models/inline_response_200_50_spec.rb +99 -0
- data/spec/models/inline_response_200_51_spec.rb +99 -0
- data/spec/models/inline_response_200_52_spec.rb +99 -0
- data/spec/models/inline_response_200_53_spec.rb +99 -0
- data/spec/models/inline_response_200_54_spec.rb +107 -0
- data/spec/models/inline_response_200_55_spec.rb +107 -0
- data/spec/models/inline_response_200_56_spec.rb +95 -0
- data/spec/models/inline_response_200_56_stats_last_30_days_spec.rb +95 -0
- data/spec/models/inline_response_200_56_stats_last_60_days_spec.rb +95 -0
- data/spec/models/inline_response_200_56_stats_last_7_days_spec.rb +95 -0
- data/spec/models/inline_response_200_56_stats_last_90_days_spec.rb +95 -0
- data/spec/models/inline_response_200_56_stats_spec.rb +65 -0
- data/spec/models/inline_response_200_56_stats_today_spec.rb +95 -0
- data/spec/models/inline_response_200_57_spec.rb +137 -0
- data/spec/models/inline_response_200_58_spec.rb +137 -0
- data/spec/models/inline_response_200_59_spec.rb +137 -0
- data/spec/models/inline_response_200_5_spec.rb +53 -0
- data/spec/models/inline_response_200_60_spec.rb +137 -0
- data/spec/models/inline_response_200_61_spec.rb +137 -0
- data/spec/models/inline_response_200_62_spec.rb +137 -0
- data/spec/models/inline_response_200_63_spec.rb +41 -0
- data/spec/models/inline_response_200_64_spec.rb +59 -0
- data/spec/models/inline_response_200_65_spec.rb +59 -0
- data/spec/models/inline_response_200_66_spec.rb +59 -0
- data/spec/models/inline_response_200_67_spec.rb +65 -0
- data/spec/models/inline_response_200_68_spec.rb +65 -0
- data/spec/models/inline_response_200_69_spec.rb +77 -0
- data/spec/models/inline_response_200_69_stats_all_time_spec.rb +95 -0
- data/spec/models/inline_response_200_69_stats_last_30_days_spec.rb +95 -0
- data/spec/models/inline_response_200_69_stats_last_60_days_spec.rb +95 -0
- data/spec/models/inline_response_200_69_stats_last_7_days_spec.rb +95 -0
- data/spec/models/inline_response_200_69_stats_last_90_days_spec.rb +95 -0
- data/spec/models/inline_response_200_69_stats_spec.rb +71 -0
- data/spec/models/inline_response_200_69_stats_today_spec.rb +95 -0
- data/spec/models/inline_response_200_6_spec.rb +53 -0
- data/spec/models/inline_response_200_70_spec.rb +41 -0
- data/spec/models/inline_response_200_71_spec.rb +99 -0
- data/spec/models/inline_response_200_72_spec.rb +99 -0
- data/spec/models/inline_response_200_73_spec.rb +99 -0
- data/spec/models/inline_response_200_74_spec.rb +99 -0
- data/spec/models/inline_response_200_75_spec.rb +99 -0
- data/spec/models/inline_response_200_76_spec.rb +47 -0
- data/spec/models/inline_response_200_77_spec.rb +53 -0
- data/spec/models/inline_response_200_78_spec.rb +47 -0
- data/spec/models/inline_response_200_7_spec.rb +53 -0
- data/spec/models/inline_response_200_8_spec.rb +53 -0
- data/spec/models/inline_response_200_9_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +71 -0
- data/spec/models/ipslist_custom_dns_spec.rb +53 -0
- data/spec/models/ipslist_warmup_spec.rb +53 -0
- data/spec/models/ipslistpools_ips_spec.rb +71 -0
- data/spec/models/messagessearch_clicks_detail_spec.rb +65 -0
- data/spec/models/messagessearch_opens_detail_spec.rb +59 -0
- data/spec/models/messagessend_message_attachments_spec.rb +53 -0
- data/spec/models/messagessend_message_global_merge_vars_spec.rb +47 -0
- data/spec/models/messagessend_message_images_spec.rb +53 -0
- data/spec/models/messagessend_message_merge_vars_spec.rb +47 -0
- data/spec/models/messagessend_message_metadata_spec.rb +41 -0
- data/spec/models/messagessend_message_recipient_metadata_spec.rb +47 -0
- data/spec/models/messagessend_message_spec.rb +231 -0
- data/spec/models/messagessend_message_to_spec.rb +57 -0
- data/spec/models/messagessend_message_values_spec.rb +41 -0
- data/spec/models/messagessend_message_vars_spec.rb +47 -0
- data/spec/models/messagessendtemplate_message_spec.rb +231 -0
- data/spec/models/messagessendtemplate_template_content_spec.rb +47 -0
- data/spec/models/rejectslist_sender_spec.rb +107 -0
- data/spec/models/sendersdomains_dkim_spec.rb +53 -0
- data/spec/models/sendersdomains_spf_spec.rb +53 -0
- data/spec/models/templatesrender_merge_vars_spec.rb +47 -0
- data/spec/models/templatesrender_template_content_spec.rb +47 -0
- data/spec/models/urlstrackingdomains_cname_spec.rb +53 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1113 -0
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::InlineResponse2008
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**domain** | **String** | the domain name that is accepting mail | [optional]
|
7
|
+
**created_at** | **DateTime** | the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional]
|
8
|
+
**valid_mx** | **BOOLEAN** | true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::InlineResponse2009
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | the unique identifier of the route | [optional]
|
7
|
+
**pattern** | **String** | the search pattern that the mailbox name should match | [optional]
|
8
|
+
**url** | **String** | the webhook URL where inbound messages will be published | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::IpslistCustomDns
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**enabled** | **BOOLEAN** | a boolean indicating whether custom dns has been configured for this ip | [optional]
|
7
|
+
**valid** | **BOOLEAN** | whether the ip's custom dns is currently valid | [optional]
|
8
|
+
**error** | **String** | if the ip's custom dns is invalid, this will include details about the error | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::IpslistWarmup
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**warming_up** | **BOOLEAN** | whether the ip is currently in warmup mode | [optional]
|
7
|
+
**start_at** | **DateTime** | the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional]
|
8
|
+
**end_at** | **DateTime** | the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# MailchimpTransactional::IpslistpoolsIps
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ip** | **String** | the ip address | [optional]
|
7
|
+
**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]
|
8
|
+
**pool** | **String** | the name of the pool that this dedicated IP belongs to | [optional]
|
9
|
+
**domain** | **String** | the domain name (reverse dns) of this dedicated IP | [optional]
|
10
|
+
**custom_dns** | [**IpslistCustomDns**](IpslistCustomDns.md) | | [optional]
|
11
|
+
**warmup** | [**IpslistWarmup**](IpslistWarmup.md) | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# MailchimpTransactional::MessagessearchClicksDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ts** | **Integer** | the unix timestamp from when the message was clicked | [optional]
|
7
|
+
**url** | **String** | the URL that was clicked on | [optional]
|
8
|
+
**ip** | **String** | the IP address that generated the click | [optional]
|
9
|
+
**location** | **String** | the approximate region and country that the clicking IP is located | [optional]
|
10
|
+
**ua** | **String** | the email client or browser data of the click | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# MailchimpTransactional::MessagessearchOpensDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ts** | **Integer** | the unix timestamp from when the message was opened | [optional]
|
7
|
+
**ip** | **String** | the IP address that generated the open | [optional]
|
8
|
+
**location** | **String** | the approximate region and country that the opening IP is located | [optional]
|
9
|
+
**ua** | **String** | the email client or browser data of the open | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**html** | **String** | the full HTML content to be sent | [optional]
|
7
|
+
**text** | **String** | optional full text content to be sent | [optional]
|
8
|
+
**subject** | **String** | the message subject | [optional]
|
9
|
+
**from_email** | **String** | the sender email address | [optional]
|
10
|
+
**from_name** | **String** | optional from name to be used | [optional]
|
11
|
+
**to** | [**Array<MessagessendMessageTo>**](MessagessendMessageTo.md) | an array of recipient information. | [optional]
|
12
|
+
**headers** | **Object** | optional extra headers to add to the message (most headers are allowed) | [optional]
|
13
|
+
**important** | **BOOLEAN** | whether or not this message is important, and should be delivered ahead of non-important messages | [optional]
|
14
|
+
**track_opens** | **BOOLEAN** | whether or not to turn on open tracking for the message | [optional]
|
15
|
+
**track_clicks** | **BOOLEAN** | whether or not to turn on click tracking for the message | [optional]
|
16
|
+
**auto_text** | **BOOLEAN** | whether or not to automatically generate a text part for messages that are not given text | [optional]
|
17
|
+
**auto_html** | **BOOLEAN** | whether or not to automatically generate an HTML part for messages that are not given HTML | [optional]
|
18
|
+
**inline_css** | **BOOLEAN** | whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size | [optional]
|
19
|
+
**url_strip_qs** | **BOOLEAN** | whether or not to strip the query string from URLs when aggregating tracked URL data | [optional]
|
20
|
+
**preserve_recipients** | **BOOLEAN** | whether or not to expose all recipients in to \"To\" header for each email | [optional]
|
21
|
+
**view_content_link** | **BOOLEAN** | set to false to remove content logging for sensitive emails | [optional]
|
22
|
+
**bcc_address** | **String** | an optional address to receive an exact copy of each recipient's email | [optional]
|
23
|
+
**tracking_domain** | **String** | a custom domain to use for tracking opens and clicks instead of mandrillapp.com | [optional]
|
24
|
+
**signing_domain** | **String** | a custom domain to use for SPF/DKIM signing instead of mandrill (for \"via\" or \"on behalf of\" in email clients) | [optional]
|
25
|
+
**return_path_domain** | **String** | a custom domain to use for the messages's return-path | [optional]
|
26
|
+
**merge** | **BOOLEAN** | whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided. | [optional]
|
27
|
+
**merge_language** | **String** | the merge tag language to use when evaluating merge tags, either mailchimp or handlebars | [optional]
|
28
|
+
**global_merge_vars** | [**Array<MessagessendMessageGlobalMergeVars>**](MessagessendMessageGlobalMergeVars.md) | global merge variables to use for all recipients. You can override these per recipient. | [optional]
|
29
|
+
**merge_vars** | [**Array<MessagessendMessageMergeVars>**](MessagessendMessageMergeVars.md) | per-recipient merge variables, which override global merge variables with the same name. | [optional]
|
30
|
+
**tags** | **Array<String>** | an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors. | [optional]
|
31
|
+
**subaccount** | **String** | the unique id of a subaccount for this message - must already exist or will fail with an error | [optional]
|
32
|
+
**google_analytics_domains** | **Array<String>** | an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically. | [optional]
|
33
|
+
**google_analytics_campaign** | **String** | optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead. | [optional]
|
34
|
+
**metadata** | [**MessagessendMessageMetadata**](MessagessendMessageMetadata.md) | | [optional]
|
35
|
+
**recipient_metadata** | [**Array<MessagessendMessageRecipientMetadata>**](MessagessendMessageRecipientMetadata.md) | Per-recipient metadata that will override the global values specified in the metadata parameter. | [optional]
|
36
|
+
**attachments** | [**Array<MessagessendMessageAttachments>**](MessagessendMessageAttachments.md) | an array of supported attachments to add to the message | [optional]
|
37
|
+
**images** | [**Array<MessagessendMessageImages>**](MessagessendMessageImages.md) | an array of embedded images to add to the message | [optional]
|
38
|
+
|
39
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageAttachments
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | the MIME type of the attachment | [optional]
|
7
|
+
**name** | **String** | the file name of the attachment | [optional]
|
8
|
+
**content** | **String** | the content of the attachment as a base64-encoded string | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageGlobalMergeVars
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | the global merge variable's name. Merge variable names are case-insensitive and may not start with _ | [optional]
|
7
|
+
**content** | **String** | the global merge variable's content | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageImages
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | the MIME type of the image - must start with \"image/\" | [optional]
|
7
|
+
**name** | **String** | the Content ID of the image - use <img src=\"cid:THIS_VALUE\"> to reference the image in your HTML content | [optional]
|
8
|
+
**content** | **String** | the content of the image as a base64-encoded string | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageMergeVars
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**rcpt** | **String** | the email address of the recipient that the merge variables should apply to |
|
7
|
+
**vars** | [**Array<MessagessendMessageVars>**](MessagessendMessageVars.md) | the recipient's merge variables | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageRecipientMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**rcpt** | **String** | the email address of the recipient that the metadata is associated with | [optional]
|
7
|
+
**values** | [**MessagessendMessageValues**](MessagessendMessageValues.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageTo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | the email address of the recipient |
|
7
|
+
**name** | **String** | the optional display name to use for the recipient | [optional]
|
8
|
+
**type** | **String** | the header type to use for the recipient, defaults to \"to\" if not provided | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendMessageVars
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | the merge variable's name. Merge variable names are case-insensitive and may not start with _ | [optional]
|
7
|
+
**content** | **String** | the merge variable's content | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendtemplateMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**html** | **String** | optional full HTML content to be sent if not in template | [optional]
|
7
|
+
**text** | **String** | optional full text content to be sent | [optional]
|
8
|
+
**subject** | **String** | the message subject | [optional]
|
9
|
+
**from_email** | **String** | the sender email address | [optional]
|
10
|
+
**from_name** | **String** | optional from name to be used | [optional]
|
11
|
+
**to** | [**Array<MessagessendMessageTo>**](MessagessendMessageTo.md) | an array of recipient information. | [optional]
|
12
|
+
**headers** | **Object** | optional extra headers to add to the message (most headers are allowed) | [optional]
|
13
|
+
**important** | **BOOLEAN** | whether or not this message is important, and should be delivered ahead of non-important messages | [optional]
|
14
|
+
**track_opens** | **BOOLEAN** | whether or not to turn on open tracking for the message | [optional]
|
15
|
+
**track_clicks** | **BOOLEAN** | whether or not to turn on click tracking for the message | [optional]
|
16
|
+
**auto_text** | **BOOLEAN** | whether or not to automatically generate a text part for messages that are not given text | [optional]
|
17
|
+
**auto_html** | **BOOLEAN** | whether or not to automatically generate an HTML part for messages that are not given HTML | [optional]
|
18
|
+
**inline_css** | **BOOLEAN** | whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size | [optional]
|
19
|
+
**url_strip_qs** | **BOOLEAN** | whether or not to strip the query string from URLs when aggregating tracked URL data | [optional]
|
20
|
+
**preserve_recipients** | **BOOLEAN** | whether or not to expose all recipients in to \"To\" header for each email | [optional]
|
21
|
+
**view_content_link** | **BOOLEAN** | set to false to remove content logging for sensitive emails | [optional]
|
22
|
+
**bcc_address** | **String** | an optional address to receive an exact copy of each recipient's email | [optional]
|
23
|
+
**tracking_domain** | **String** | a custom domain to use for tracking opens and clicks instead of mandrillapp.com | [optional]
|
24
|
+
**signing_domain** | **String** | a custom domain to use for SPF/DKIM signing instead of mandrill (for \"via\" or \"on behalf of\" in email clients) | [optional]
|
25
|
+
**return_path_domain** | **String** | a custom domain to use for the messages's return-path | [optional]
|
26
|
+
**merge** | **BOOLEAN** | whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided. | [optional]
|
27
|
+
**merge_language** | **String** | the merge tag language to use when evaluating merge tags, either mailchimp or handlebars | [optional]
|
28
|
+
**global_merge_vars** | [**Array<MessagessendMessageGlobalMergeVars>**](MessagessendMessageGlobalMergeVars.md) | global merge variables to use for all recipients. You can override these per recipient. | [optional]
|
29
|
+
**merge_vars** | [**Array<MessagessendMessageMergeVars>**](MessagessendMessageMergeVars.md) | per-recipient merge variables, which override global merge variables with the same name. | [optional]
|
30
|
+
**tags** | **Array<String>** | an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors. | [optional]
|
31
|
+
**subaccount** | **String** | the unique id of a subaccount for this message - must already exist or will fail with an error | [optional]
|
32
|
+
**google_analytics_domains** | **Array<String>** | an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically. | [optional]
|
33
|
+
**google_analytics_campaign** | **String** | optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead. | [optional]
|
34
|
+
**metadata** | [**MessagessendMessageMetadata**](MessagessendMessageMetadata.md) | | [optional]
|
35
|
+
**recipient_metadata** | [**Array<MessagessendMessageRecipientMetadata>**](MessagessendMessageRecipientMetadata.md) | Per-recipient metadata that will override the global values specified in the metadata parameter. | [optional]
|
36
|
+
**attachments** | [**Array<MessagessendMessageAttachments>**](MessagessendMessageAttachments.md) | an array of supported attachments to add to the message | [optional]
|
37
|
+
**images** | [**Array<MessagessendMessageImages>**](MessagessendMessageImages.md) | an array of embedded images to add to the message | [optional]
|
38
|
+
|
39
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::MessagessendtemplateTemplateContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | the name of the mc:edit editable region to inject into | [optional]
|
7
|
+
**content** | **String** | the content to inject | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# MailchimpTransactional::RejectslistSender
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**address** | **String** | the sender's email address | [optional]
|
7
|
+
**created_at** | **DateTime** | the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format | [optional]
|
8
|
+
**sent** | **Integer** | the total number of messages sent by this sender | [optional]
|
9
|
+
**hard_bounces** | **Integer** | the total number of hard bounces by messages by this sender | [optional]
|
10
|
+
**soft_bounces** | **Integer** | the total number of soft bounces by messages by this sender | [optional]
|
11
|
+
**rejects** | **Integer** | the total number of rejected messages by this sender | [optional]
|
12
|
+
**complaints** | **Integer** | the total number of spam complaints received for messages by this sender | [optional]
|
13
|
+
**unsubs** | **Integer** | the total number of unsubscribe requests received for messages by this sender | [optional]
|
14
|
+
**opens** | **Integer** | the total number of times messages by this sender have been opened | [optional]
|
15
|
+
**clicks** | **Integer** | the total number of times tracked URLs in messages by this sender have been clicked | [optional]
|
16
|
+
**unique_opens** | **Integer** | the number of unique opens for emails sent for this sender | [optional]
|
17
|
+
**unique_clicks** | **Integer** | the number of unique clicks for emails sent for this sender | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::SendersdomainsDkim
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid** | **BOOLEAN** | whether the domain's DKIM record is valid for use with Mandrill | [optional]
|
7
|
+
**valid_after** | **DateTime** | when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it. | [optional]
|
8
|
+
**error** | **String** | an error describing the DKIM record, or null if the record is correct | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# MailchimpTransactional::SendersdomainsSpf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid** | **BOOLEAN** | whether the domain's SPF record is valid for use with Mandrill | [optional]
|
7
|
+
**valid_after** | **DateTime** | when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it. | [optional]
|
8
|
+
**error** | **String** | an error describing the spf record, or null if the record is correct | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::TemplatesrenderMergeVars
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | the merge variable's name. Merge variable names are case-insensitive and may not start with _ | [optional]
|
7
|
+
**content** | **String** | the merge variable's content | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# MailchimpTransactional::TemplatesrenderTemplateContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | the name of the mc:edit editable region to inject into |
|
7
|
+
**content** | **String** | the content to inject |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,4328 @@
|
|
1
|
+
# MailchimpTransactional::TransactionalApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://mandrillapp.com/api/1.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**post_exports_activity**](TransactionalApi.md#post_exports_activity) | **POST** /exports/activity | /exports/activity
|
8
|
+
[**post_exports_info**](TransactionalApi.md#post_exports_info) | **POST** /exports/info | /exports/info
|
9
|
+
[**post_exports_list**](TransactionalApi.md#post_exports_list) | **POST** /exports/list | /exports/list
|
10
|
+
[**post_exports_rejects**](TransactionalApi.md#post_exports_rejects) | **POST** /exports/rejects | /exports/rejects
|
11
|
+
[**post_exports_whitelist**](TransactionalApi.md#post_exports_whitelist) | **POST** /exports/whitelist | /exports/whitelist
|
12
|
+
[**post_inbound_add_domain**](TransactionalApi.md#post_inbound_add_domain) | **POST** /inbound/add-domain | /inbound/add-domain
|
13
|
+
[**post_inbound_add_route**](TransactionalApi.md#post_inbound_add_route) | **POST** /inbound/add-route | /inbound/add-route
|
14
|
+
[**post_inbound_check_domain**](TransactionalApi.md#post_inbound_check_domain) | **POST** /inbound/check-domain | /inbound/check-domain
|
15
|
+
[**post_inbound_delete_domain**](TransactionalApi.md#post_inbound_delete_domain) | **POST** /inbound/delete-domain | /inbound/delete-domain
|
16
|
+
[**post_inbound_delete_route**](TransactionalApi.md#post_inbound_delete_route) | **POST** /inbound/delete-route | /inbound/delete-route
|
17
|
+
[**post_inbound_domains**](TransactionalApi.md#post_inbound_domains) | **POST** /inbound/domains | /inbound/domains
|
18
|
+
[**post_inbound_routes**](TransactionalApi.md#post_inbound_routes) | **POST** /inbound/routes | /inbound/routes
|
19
|
+
[**post_inbound_send_raw**](TransactionalApi.md#post_inbound_send_raw) | **POST** /inbound/send-raw | /inbound/send-raw
|
20
|
+
[**post_inbound_update_route**](TransactionalApi.md#post_inbound_update_route) | **POST** /inbound/update-route | /inbound/update-route
|
21
|
+
[**post_ips_cancel_warmup**](TransactionalApi.md#post_ips_cancel_warmup) | **POST** /ips/cancel-warmup | /ips/cancel-warmup
|
22
|
+
[**post_ips_check_custom_dns**](TransactionalApi.md#post_ips_check_custom_dns) | **POST** /ips/check-custom-dns | /ips/check-custom-dns
|
23
|
+
[**post_ips_create_pool**](TransactionalApi.md#post_ips_create_pool) | **POST** /ips/create-pool | /ips/create-pool
|
24
|
+
[**post_ips_delete**](TransactionalApi.md#post_ips_delete) | **POST** /ips/delete | /ips/delete
|
25
|
+
[**post_ips_delete_pool**](TransactionalApi.md#post_ips_delete_pool) | **POST** /ips/delete-pool | /ips/delete-pool
|
26
|
+
[**post_ips_info**](TransactionalApi.md#post_ips_info) | **POST** /ips/info | /ips/info
|
27
|
+
[**post_ips_list**](TransactionalApi.md#post_ips_list) | **POST** /ips/list | /ips/list
|
28
|
+
[**post_ips_list_pools**](TransactionalApi.md#post_ips_list_pools) | **POST** /ips/list-pools | /ips/list-pools
|
29
|
+
[**post_ips_pool_info**](TransactionalApi.md#post_ips_pool_info) | **POST** /ips/pool-info | /ips/pool-info
|
30
|
+
[**post_ips_provision**](TransactionalApi.md#post_ips_provision) | **POST** /ips/provision | /ips/provision
|
31
|
+
[**post_ips_set_custom_dns**](TransactionalApi.md#post_ips_set_custom_dns) | **POST** /ips/set-custom-dns | /ips/set-custom-dns
|
32
|
+
[**post_ips_set_pool**](TransactionalApi.md#post_ips_set_pool) | **POST** /ips/set-pool | /ips/set-pool
|
33
|
+
[**post_ips_start_warmup**](TransactionalApi.md#post_ips_start_warmup) | **POST** /ips/start-warmup | /ips/start-warmup
|
34
|
+
[**post_messages_cancel_scheduled**](TransactionalApi.md#post_messages_cancel_scheduled) | **POST** /messages/cancel-scheduled | /messages/cancel-scheduled
|
35
|
+
[**post_messages_content**](TransactionalApi.md#post_messages_content) | **POST** /messages/content | /messages/content
|
36
|
+
[**post_messages_info**](TransactionalApi.md#post_messages_info) | **POST** /messages/info | /messages/info
|
37
|
+
[**post_messages_list_scheduled**](TransactionalApi.md#post_messages_list_scheduled) | **POST** /messages/list-scheduled | /messages/list-scheduled
|
38
|
+
[**post_messages_parse**](TransactionalApi.md#post_messages_parse) | **POST** /messages/parse | /messages/parse
|
39
|
+
[**post_messages_reschedule**](TransactionalApi.md#post_messages_reschedule) | **POST** /messages/reschedule | /messages/reschedule
|
40
|
+
[**post_messages_search**](TransactionalApi.md#post_messages_search) | **POST** /messages/search | /messages/search
|
41
|
+
[**post_messages_search_time_series**](TransactionalApi.md#post_messages_search_time_series) | **POST** /messages/search-time-series | /messages/search-time-series
|
42
|
+
[**post_messages_send**](TransactionalApi.md#post_messages_send) | **POST** /messages/send | /messages/send
|
43
|
+
[**post_messages_send_raw**](TransactionalApi.md#post_messages_send_raw) | **POST** /messages/send-raw | /messages/send-raw
|
44
|
+
[**post_messages_send_template**](TransactionalApi.md#post_messages_send_template) | **POST** /messages/send-template | /messages/send-template
|
45
|
+
[**post_metadata_add**](TransactionalApi.md#post_metadata_add) | **POST** /metadata/add | /metadata/add
|
46
|
+
[**post_metadata_delete**](TransactionalApi.md#post_metadata_delete) | **POST** /metadata/delete | /metadata/delete
|
47
|
+
[**post_metadata_list**](TransactionalApi.md#post_metadata_list) | **POST** /metadata/list | /metadata/list
|
48
|
+
[**post_metadata_update**](TransactionalApi.md#post_metadata_update) | **POST** /metadata/update | /metadata/update
|
49
|
+
[**post_rejects_add**](TransactionalApi.md#post_rejects_add) | **POST** /rejects/add | /rejects/add
|
50
|
+
[**post_rejects_delete**](TransactionalApi.md#post_rejects_delete) | **POST** /rejects/delete | /rejects/delete
|
51
|
+
[**post_rejects_list**](TransactionalApi.md#post_rejects_list) | **POST** /rejects/list | /rejects/list
|
52
|
+
[**post_senders_add_domain**](TransactionalApi.md#post_senders_add_domain) | **POST** /senders/add-domain | /senders/add-domain
|
53
|
+
[**post_senders_check_domain**](TransactionalApi.md#post_senders_check_domain) | **POST** /senders/check-domain | /senders/check-domain
|
54
|
+
[**post_senders_domains**](TransactionalApi.md#post_senders_domains) | **POST** /senders/domains | /senders/domains
|
55
|
+
[**post_senders_info**](TransactionalApi.md#post_senders_info) | **POST** /senders/info | /senders/info
|
56
|
+
[**post_senders_list**](TransactionalApi.md#post_senders_list) | **POST** /senders/list | /senders/list
|
57
|
+
[**post_senders_time_series**](TransactionalApi.md#post_senders_time_series) | **POST** /senders/time-series | /senders/time-series
|
58
|
+
[**post_senders_verify_domain**](TransactionalApi.md#post_senders_verify_domain) | **POST** /senders/verify-domain | /senders/verify-domain
|
59
|
+
[**post_subaccounts_add**](TransactionalApi.md#post_subaccounts_add) | **POST** /subaccounts/add | /subaccounts/add
|
60
|
+
[**post_subaccounts_delete**](TransactionalApi.md#post_subaccounts_delete) | **POST** /subaccounts/delete | /subaccounts/delete
|
61
|
+
[**post_subaccounts_info**](TransactionalApi.md#post_subaccounts_info) | **POST** /subaccounts/info | /subaccounts/info
|
62
|
+
[**post_subaccounts_list**](TransactionalApi.md#post_subaccounts_list) | **POST** /subaccounts/list | /subaccounts/list
|
63
|
+
[**post_subaccounts_pause**](TransactionalApi.md#post_subaccounts_pause) | **POST** /subaccounts/pause | /subaccounts/pause
|
64
|
+
[**post_subaccounts_resume**](TransactionalApi.md#post_subaccounts_resume) | **POST** /subaccounts/resume | /subaccounts/resume
|
65
|
+
[**post_subaccounts_update**](TransactionalApi.md#post_subaccounts_update) | **POST** /subaccounts/update | /subaccounts/update
|
66
|
+
[**post_tags_all_time_series**](TransactionalApi.md#post_tags_all_time_series) | **POST** /tags/all-time-series | /tags/all-time-series
|
67
|
+
[**post_tags_delete**](TransactionalApi.md#post_tags_delete) | **POST** /tags/delete | /tags/delete
|
68
|
+
[**post_tags_info**](TransactionalApi.md#post_tags_info) | **POST** /tags/info | /tags/info
|
69
|
+
[**post_tags_list**](TransactionalApi.md#post_tags_list) | **POST** /tags/list | /tags/list
|
70
|
+
[**post_tags_time_series**](TransactionalApi.md#post_tags_time_series) | **POST** /tags/time-series | /tags/time-series
|
71
|
+
[**post_templates_add**](TransactionalApi.md#post_templates_add) | **POST** /templates/add | /templates/add
|
72
|
+
[**post_templates_delete**](TransactionalApi.md#post_templates_delete) | **POST** /templates/delete | /templates/delete
|
73
|
+
[**post_templates_info**](TransactionalApi.md#post_templates_info) | **POST** /templates/info | /templates/info
|
74
|
+
[**post_templates_list**](TransactionalApi.md#post_templates_list) | **POST** /templates/list | /templates/list
|
75
|
+
[**post_templates_publish**](TransactionalApi.md#post_templates_publish) | **POST** /templates/publish | /templates/publish
|
76
|
+
[**post_templates_render**](TransactionalApi.md#post_templates_render) | **POST** /templates/render | /templates/render
|
77
|
+
[**post_templates_time_series**](TransactionalApi.md#post_templates_time_series) | **POST** /templates/time-series | /templates/time-series
|
78
|
+
[**post_templates_update**](TransactionalApi.md#post_templates_update) | **POST** /templates/update | /templates/update
|
79
|
+
[**post_urls_add_tracking_domain**](TransactionalApi.md#post_urls_add_tracking_domain) | **POST** /urls/add-tracking-domain | /urls/add-tracking-domain
|
80
|
+
[**post_urls_check_tracking_domain**](TransactionalApi.md#post_urls_check_tracking_domain) | **POST** /urls/check-tracking-domain | /urls/check-tracking-domain
|
81
|
+
[**post_urls_list**](TransactionalApi.md#post_urls_list) | **POST** /urls/list | /urls/list
|
82
|
+
[**post_urls_search_deprecated**](TransactionalApi.md#post_urls_search_deprecated) | **POST** /urls/search | /urls/search (deprecated)
|
83
|
+
[**post_urls_time_series**](TransactionalApi.md#post_urls_time_series) | **POST** /urls/time-series | /urls/time-series
|
84
|
+
[**post_urls_tracking_domains**](TransactionalApi.md#post_urls_tracking_domains) | **POST** /urls/tracking-domains | /urls/tracking-domains
|
85
|
+
[**post_users_info**](TransactionalApi.md#post_users_info) | **POST** /users/info | /users/info
|
86
|
+
[**post_users_ping**](TransactionalApi.md#post_users_ping) | **POST** /users/ping | /users/ping
|
87
|
+
[**post_users_ping2**](TransactionalApi.md#post_users_ping2) | **POST** /users/ping2 | /users/ping2
|
88
|
+
[**post_users_senders**](TransactionalApi.md#post_users_senders) | **POST** /users/senders | /users/senders
|
89
|
+
[**post_webhooks_add**](TransactionalApi.md#post_webhooks_add) | **POST** /webhooks/add | /webhooks/add
|
90
|
+
[**post_webhooks_delete**](TransactionalApi.md#post_webhooks_delete) | **POST** /webhooks/delete | /webhooks/delete
|
91
|
+
[**post_webhooks_info**](TransactionalApi.md#post_webhooks_info) | **POST** /webhooks/info | /webhooks/info
|
92
|
+
[**post_webhooks_list**](TransactionalApi.md#post_webhooks_list) | **POST** /webhooks/list | /webhooks/list
|
93
|
+
[**post_webhooks_update**](TransactionalApi.md#post_webhooks_update) | **POST** /webhooks/update | /webhooks/update
|
94
|
+
[**post_whitelists_add**](TransactionalApi.md#post_whitelists_add) | **POST** /whitelists/add | /whitelists/add
|
95
|
+
[**post_whitelists_delete**](TransactionalApi.md#post_whitelists_delete) | **POST** /whitelists/delete | /whitelists/delete
|
96
|
+
[**post_whitelists_list**](TransactionalApi.md#post_whitelists_list) | **POST** /whitelists/list | /whitelists/list
|
97
|
+
|
98
|
+
|
99
|
+
# **post_exports_activity**
|
100
|
+
> InlineResponse2004 post_exports_activity(body)
|
101
|
+
|
102
|
+
/exports/activity
|
103
|
+
|
104
|
+
Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
|
105
|
+
|
106
|
+
### Example
|
107
|
+
```ruby
|
108
|
+
# load the gem
|
109
|
+
require 'mailchimp_transactional'
|
110
|
+
|
111
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
112
|
+
|
113
|
+
body = MailchimpTransactional::Body4.new # Body4 |
|
114
|
+
|
115
|
+
|
116
|
+
begin
|
117
|
+
#/exports/activity
|
118
|
+
result = api_instance.post_exports_activity(body)
|
119
|
+
p result
|
120
|
+
rescue MailchimpTransactional::ApiError => e
|
121
|
+
puts "Exception when calling TransactionalApi->post_exports_activity: #{e}"
|
122
|
+
end
|
123
|
+
```
|
124
|
+
|
125
|
+
### Parameters
|
126
|
+
|
127
|
+
Name | Type | Description | Notes
|
128
|
+
------------- | ------------- | ------------- | -------------
|
129
|
+
**body** | [**Body4**](Body4.md)| |
|
130
|
+
|
131
|
+
### Return type
|
132
|
+
|
133
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
134
|
+
|
135
|
+
### Authorization
|
136
|
+
|
137
|
+
No authorization required
|
138
|
+
|
139
|
+
### HTTP request headers
|
140
|
+
|
141
|
+
- **Content-Type**: application/json
|
142
|
+
- **Accept**: application/json
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
# **post_exports_info**
|
147
|
+
> InlineResponse200 post_exports_info(body)
|
148
|
+
|
149
|
+
/exports/info
|
150
|
+
|
151
|
+
Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
|
152
|
+
|
153
|
+
### Example
|
154
|
+
```ruby
|
155
|
+
# load the gem
|
156
|
+
require 'mailchimp_transactional'
|
157
|
+
|
158
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
159
|
+
|
160
|
+
body = MailchimpTransactional::Body.new # Body |
|
161
|
+
|
162
|
+
|
163
|
+
begin
|
164
|
+
#/exports/info
|
165
|
+
result = api_instance.post_exports_info(body)
|
166
|
+
p result
|
167
|
+
rescue MailchimpTransactional::ApiError => e
|
168
|
+
puts "Exception when calling TransactionalApi->post_exports_info: #{e}"
|
169
|
+
end
|
170
|
+
```
|
171
|
+
|
172
|
+
### Parameters
|
173
|
+
|
174
|
+
Name | Type | Description | Notes
|
175
|
+
------------- | ------------- | ------------- | -------------
|
176
|
+
**body** | [**Body**](Body.md)| |
|
177
|
+
|
178
|
+
### Return type
|
179
|
+
|
180
|
+
[**InlineResponse200**](InlineResponse200.md)
|
181
|
+
|
182
|
+
### Authorization
|
183
|
+
|
184
|
+
No authorization required
|
185
|
+
|
186
|
+
### HTTP request headers
|
187
|
+
|
188
|
+
- **Content-Type**: application/json
|
189
|
+
- **Accept**: application/json
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
# **post_exports_list**
|
194
|
+
> Array<InlineResponse2001> post_exports_list(body)
|
195
|
+
|
196
|
+
/exports/list
|
197
|
+
|
198
|
+
Returns a list of your exports.
|
199
|
+
|
200
|
+
### Example
|
201
|
+
```ruby
|
202
|
+
# load the gem
|
203
|
+
require 'mailchimp_transactional'
|
204
|
+
|
205
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
206
|
+
|
207
|
+
body = MailchimpTransactional::Body1.new # Body1 |
|
208
|
+
|
209
|
+
|
210
|
+
begin
|
211
|
+
#/exports/list
|
212
|
+
result = api_instance.post_exports_list(body)
|
213
|
+
p result
|
214
|
+
rescue MailchimpTransactional::ApiError => e
|
215
|
+
puts "Exception when calling TransactionalApi->post_exports_list: #{e}"
|
216
|
+
end
|
217
|
+
```
|
218
|
+
|
219
|
+
### Parameters
|
220
|
+
|
221
|
+
Name | Type | Description | Notes
|
222
|
+
------------- | ------------- | ------------- | -------------
|
223
|
+
**body** | [**Body1**](Body1.md)| |
|
224
|
+
|
225
|
+
### Return type
|
226
|
+
|
227
|
+
[**Array<InlineResponse2001>**](InlineResponse2001.md)
|
228
|
+
|
229
|
+
### Authorization
|
230
|
+
|
231
|
+
No authorization required
|
232
|
+
|
233
|
+
### HTTP request headers
|
234
|
+
|
235
|
+
- **Content-Type**: application/json
|
236
|
+
- **Accept**: application/json
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
# **post_exports_rejects**
|
241
|
+
> InlineResponse2002 post_exports_rejects(body)
|
242
|
+
|
243
|
+
/exports/rejects
|
244
|
+
|
245
|
+
Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
|
246
|
+
|
247
|
+
### Example
|
248
|
+
```ruby
|
249
|
+
# load the gem
|
250
|
+
require 'mailchimp_transactional'
|
251
|
+
|
252
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
253
|
+
|
254
|
+
body = MailchimpTransactional::Body2.new # Body2 |
|
255
|
+
|
256
|
+
|
257
|
+
begin
|
258
|
+
#/exports/rejects
|
259
|
+
result = api_instance.post_exports_rejects(body)
|
260
|
+
p result
|
261
|
+
rescue MailchimpTransactional::ApiError => e
|
262
|
+
puts "Exception when calling TransactionalApi->post_exports_rejects: #{e}"
|
263
|
+
end
|
264
|
+
```
|
265
|
+
|
266
|
+
### Parameters
|
267
|
+
|
268
|
+
Name | Type | Description | Notes
|
269
|
+
------------- | ------------- | ------------- | -------------
|
270
|
+
**body** | [**Body2**](Body2.md)| |
|
271
|
+
|
272
|
+
### Return type
|
273
|
+
|
274
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
275
|
+
|
276
|
+
### Authorization
|
277
|
+
|
278
|
+
No authorization required
|
279
|
+
|
280
|
+
### HTTP request headers
|
281
|
+
|
282
|
+
- **Content-Type**: application/json
|
283
|
+
- **Accept**: application/json
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
# **post_exports_whitelist**
|
288
|
+
> InlineResponse2003 post_exports_whitelist(body)
|
289
|
+
|
290
|
+
/exports/whitelist
|
291
|
+
|
292
|
+
Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
|
293
|
+
|
294
|
+
### Example
|
295
|
+
```ruby
|
296
|
+
# load the gem
|
297
|
+
require 'mailchimp_transactional'
|
298
|
+
|
299
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
300
|
+
|
301
|
+
body = MailchimpTransactional::Body3.new # Body3 |
|
302
|
+
|
303
|
+
|
304
|
+
begin
|
305
|
+
#/exports/whitelist
|
306
|
+
result = api_instance.post_exports_whitelist(body)
|
307
|
+
p result
|
308
|
+
rescue MailchimpTransactional::ApiError => e
|
309
|
+
puts "Exception when calling TransactionalApi->post_exports_whitelist: #{e}"
|
310
|
+
end
|
311
|
+
```
|
312
|
+
|
313
|
+
### Parameters
|
314
|
+
|
315
|
+
Name | Type | Description | Notes
|
316
|
+
------------- | ------------- | ------------- | -------------
|
317
|
+
**body** | [**Body3**](Body3.md)| |
|
318
|
+
|
319
|
+
### Return type
|
320
|
+
|
321
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
322
|
+
|
323
|
+
### Authorization
|
324
|
+
|
325
|
+
No authorization required
|
326
|
+
|
327
|
+
### HTTP request headers
|
328
|
+
|
329
|
+
- **Content-Type**: application/json
|
330
|
+
- **Accept**: application/json
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
# **post_inbound_add_domain**
|
335
|
+
> InlineResponse2006 post_inbound_add_domain(body)
|
336
|
+
|
337
|
+
/inbound/add-domain
|
338
|
+
|
339
|
+
Add a new template
|
340
|
+
|
341
|
+
### Example
|
342
|
+
```ruby
|
343
|
+
# load the gem
|
344
|
+
require 'mailchimp_transactional'
|
345
|
+
|
346
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
347
|
+
|
348
|
+
body = MailchimpTransactional::Body6.new # Body6 |
|
349
|
+
|
350
|
+
|
351
|
+
begin
|
352
|
+
#/inbound/add-domain
|
353
|
+
result = api_instance.post_inbound_add_domain(body)
|
354
|
+
p result
|
355
|
+
rescue MailchimpTransactional::ApiError => e
|
356
|
+
puts "Exception when calling TransactionalApi->post_inbound_add_domain: #{e}"
|
357
|
+
end
|
358
|
+
```
|
359
|
+
|
360
|
+
### Parameters
|
361
|
+
|
362
|
+
Name | Type | Description | Notes
|
363
|
+
------------- | ------------- | ------------- | -------------
|
364
|
+
**body** | [**Body6**](Body6.md)| |
|
365
|
+
|
366
|
+
### Return type
|
367
|
+
|
368
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
369
|
+
|
370
|
+
### Authorization
|
371
|
+
|
372
|
+
No authorization required
|
373
|
+
|
374
|
+
### HTTP request headers
|
375
|
+
|
376
|
+
- **Content-Type**: application/json
|
377
|
+
- **Accept**: application/json
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
# **post_inbound_add_route**
|
382
|
+
> InlineResponse20010 post_inbound_add_route(body)
|
383
|
+
|
384
|
+
/inbound/add-route
|
385
|
+
|
386
|
+
Add a new mailbox route to an inbound domain
|
387
|
+
|
388
|
+
### Example
|
389
|
+
```ruby
|
390
|
+
# load the gem
|
391
|
+
require 'mailchimp_transactional'
|
392
|
+
|
393
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
394
|
+
|
395
|
+
body = MailchimpTransactional::Body10.new # Body10 |
|
396
|
+
|
397
|
+
|
398
|
+
begin
|
399
|
+
#/inbound/add-route
|
400
|
+
result = api_instance.post_inbound_add_route(body)
|
401
|
+
p result
|
402
|
+
rescue MailchimpTransactional::ApiError => e
|
403
|
+
puts "Exception when calling TransactionalApi->post_inbound_add_route: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
### Parameters
|
408
|
+
|
409
|
+
Name | Type | Description | Notes
|
410
|
+
------------- | ------------- | ------------- | -------------
|
411
|
+
**body** | [**Body10**](Body10.md)| |
|
412
|
+
|
413
|
+
### Return type
|
414
|
+
|
415
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
416
|
+
|
417
|
+
### Authorization
|
418
|
+
|
419
|
+
No authorization required
|
420
|
+
|
421
|
+
### HTTP request headers
|
422
|
+
|
423
|
+
- **Content-Type**: application/json
|
424
|
+
- **Accept**: application/json
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
# **post_inbound_check_domain**
|
429
|
+
> InlineResponse2007 post_inbound_check_domain(body)
|
430
|
+
|
431
|
+
/inbound/check-domain
|
432
|
+
|
433
|
+
Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
|
434
|
+
|
435
|
+
### Example
|
436
|
+
```ruby
|
437
|
+
# load the gem
|
438
|
+
require 'mailchimp_transactional'
|
439
|
+
|
440
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
441
|
+
|
442
|
+
body = MailchimpTransactional::Body7.new # Body7 |
|
443
|
+
|
444
|
+
|
445
|
+
begin
|
446
|
+
#/inbound/check-domain
|
447
|
+
result = api_instance.post_inbound_check_domain(body)
|
448
|
+
p result
|
449
|
+
rescue MailchimpTransactional::ApiError => e
|
450
|
+
puts "Exception when calling TransactionalApi->post_inbound_check_domain: #{e}"
|
451
|
+
end
|
452
|
+
```
|
453
|
+
|
454
|
+
### Parameters
|
455
|
+
|
456
|
+
Name | Type | Description | Notes
|
457
|
+
------------- | ------------- | ------------- | -------------
|
458
|
+
**body** | [**Body7**](Body7.md)| |
|
459
|
+
|
460
|
+
### Return type
|
461
|
+
|
462
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
463
|
+
|
464
|
+
### Authorization
|
465
|
+
|
466
|
+
No authorization required
|
467
|
+
|
468
|
+
### HTTP request headers
|
469
|
+
|
470
|
+
- **Content-Type**: application/json
|
471
|
+
- **Accept**: application/json
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
# **post_inbound_delete_domain**
|
476
|
+
> InlineResponse2008 post_inbound_delete_domain(body)
|
477
|
+
|
478
|
+
/inbound/delete-domain
|
479
|
+
|
480
|
+
Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
|
481
|
+
|
482
|
+
### Example
|
483
|
+
```ruby
|
484
|
+
# load the gem
|
485
|
+
require 'mailchimp_transactional'
|
486
|
+
|
487
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
488
|
+
|
489
|
+
body = MailchimpTransactional::Body8.new # Body8 |
|
490
|
+
|
491
|
+
|
492
|
+
begin
|
493
|
+
#/inbound/delete-domain
|
494
|
+
result = api_instance.post_inbound_delete_domain(body)
|
495
|
+
p result
|
496
|
+
rescue MailchimpTransactional::ApiError => e
|
497
|
+
puts "Exception when calling TransactionalApi->post_inbound_delete_domain: #{e}"
|
498
|
+
end
|
499
|
+
```
|
500
|
+
|
501
|
+
### Parameters
|
502
|
+
|
503
|
+
Name | Type | Description | Notes
|
504
|
+
------------- | ------------- | ------------- | -------------
|
505
|
+
**body** | [**Body8**](Body8.md)| |
|
506
|
+
|
507
|
+
### Return type
|
508
|
+
|
509
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
510
|
+
|
511
|
+
### Authorization
|
512
|
+
|
513
|
+
No authorization required
|
514
|
+
|
515
|
+
### HTTP request headers
|
516
|
+
|
517
|
+
- **Content-Type**: application/json
|
518
|
+
- **Accept**: application/json
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
# **post_inbound_delete_route**
|
523
|
+
> InlineResponse20012 post_inbound_delete_route(body)
|
524
|
+
|
525
|
+
/inbound/delete-route
|
526
|
+
|
527
|
+
Delete an existing inbound mailbox route
|
528
|
+
|
529
|
+
### Example
|
530
|
+
```ruby
|
531
|
+
# load the gem
|
532
|
+
require 'mailchimp_transactional'
|
533
|
+
|
534
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
535
|
+
|
536
|
+
body = MailchimpTransactional::Body12.new # Body12 |
|
537
|
+
|
538
|
+
|
539
|
+
begin
|
540
|
+
#/inbound/delete-route
|
541
|
+
result = api_instance.post_inbound_delete_route(body)
|
542
|
+
p result
|
543
|
+
rescue MailchimpTransactional::ApiError => e
|
544
|
+
puts "Exception when calling TransactionalApi->post_inbound_delete_route: #{e}"
|
545
|
+
end
|
546
|
+
```
|
547
|
+
|
548
|
+
### Parameters
|
549
|
+
|
550
|
+
Name | Type | Description | Notes
|
551
|
+
------------- | ------------- | ------------- | -------------
|
552
|
+
**body** | [**Body12**](Body12.md)| |
|
553
|
+
|
554
|
+
### Return type
|
555
|
+
|
556
|
+
[**InlineResponse20012**](InlineResponse20012.md)
|
557
|
+
|
558
|
+
### Authorization
|
559
|
+
|
560
|
+
No authorization required
|
561
|
+
|
562
|
+
### HTTP request headers
|
563
|
+
|
564
|
+
- **Content-Type**: application/json
|
565
|
+
- **Accept**: application/json
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
# **post_inbound_domains**
|
570
|
+
> Array<InlineResponse2005> post_inbound_domains(body)
|
571
|
+
|
572
|
+
/inbound/domains
|
573
|
+
|
574
|
+
Add an inbound domain to your account
|
575
|
+
|
576
|
+
### Example
|
577
|
+
```ruby
|
578
|
+
# load the gem
|
579
|
+
require 'mailchimp_transactional'
|
580
|
+
|
581
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
582
|
+
|
583
|
+
body = MailchimpTransactional::Body5.new # Body5 |
|
584
|
+
|
585
|
+
|
586
|
+
begin
|
587
|
+
#/inbound/domains
|
588
|
+
result = api_instance.post_inbound_domains(body)
|
589
|
+
p result
|
590
|
+
rescue MailchimpTransactional::ApiError => e
|
591
|
+
puts "Exception when calling TransactionalApi->post_inbound_domains: #{e}"
|
592
|
+
end
|
593
|
+
```
|
594
|
+
|
595
|
+
### Parameters
|
596
|
+
|
597
|
+
Name | Type | Description | Notes
|
598
|
+
------------- | ------------- | ------------- | -------------
|
599
|
+
**body** | [**Body5**](Body5.md)| |
|
600
|
+
|
601
|
+
### Return type
|
602
|
+
|
603
|
+
[**Array<InlineResponse2005>**](InlineResponse2005.md)
|
604
|
+
|
605
|
+
### Authorization
|
606
|
+
|
607
|
+
No authorization required
|
608
|
+
|
609
|
+
### HTTP request headers
|
610
|
+
|
611
|
+
- **Content-Type**: application/json
|
612
|
+
- **Accept**: application/json
|
613
|
+
|
614
|
+
|
615
|
+
|
616
|
+
# **post_inbound_routes**
|
617
|
+
> Array<InlineResponse2009> post_inbound_routes(body)
|
618
|
+
|
619
|
+
/inbound/routes
|
620
|
+
|
621
|
+
List the mailbox routes defined for an inbound domain
|
622
|
+
|
623
|
+
### Example
|
624
|
+
```ruby
|
625
|
+
# load the gem
|
626
|
+
require 'mailchimp_transactional'
|
627
|
+
|
628
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
629
|
+
|
630
|
+
body = MailchimpTransactional::Body9.new # Body9 |
|
631
|
+
|
632
|
+
|
633
|
+
begin
|
634
|
+
#/inbound/routes
|
635
|
+
result = api_instance.post_inbound_routes(body)
|
636
|
+
p result
|
637
|
+
rescue MailchimpTransactional::ApiError => e
|
638
|
+
puts "Exception when calling TransactionalApi->post_inbound_routes: #{e}"
|
639
|
+
end
|
640
|
+
```
|
641
|
+
|
642
|
+
### Parameters
|
643
|
+
|
644
|
+
Name | Type | Description | Notes
|
645
|
+
------------- | ------------- | ------------- | -------------
|
646
|
+
**body** | [**Body9**](Body9.md)| |
|
647
|
+
|
648
|
+
### Return type
|
649
|
+
|
650
|
+
[**Array<InlineResponse2009>**](InlineResponse2009.md)
|
651
|
+
|
652
|
+
### Authorization
|
653
|
+
|
654
|
+
No authorization required
|
655
|
+
|
656
|
+
### HTTP request headers
|
657
|
+
|
658
|
+
- **Content-Type**: application/json
|
659
|
+
- **Accept**: application/json
|
660
|
+
|
661
|
+
|
662
|
+
|
663
|
+
# **post_inbound_send_raw**
|
664
|
+
> Array<InlineResponse20013> post_inbound_send_raw(body)
|
665
|
+
|
666
|
+
/inbound/send-raw
|
667
|
+
|
668
|
+
Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
|
669
|
+
|
670
|
+
### Example
|
671
|
+
```ruby
|
672
|
+
# load the gem
|
673
|
+
require 'mailchimp_transactional'
|
674
|
+
|
675
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
676
|
+
|
677
|
+
body = MailchimpTransactional::Body13.new # Body13 |
|
678
|
+
|
679
|
+
|
680
|
+
begin
|
681
|
+
#/inbound/send-raw
|
682
|
+
result = api_instance.post_inbound_send_raw(body)
|
683
|
+
p result
|
684
|
+
rescue MailchimpTransactional::ApiError => e
|
685
|
+
puts "Exception when calling TransactionalApi->post_inbound_send_raw: #{e}"
|
686
|
+
end
|
687
|
+
```
|
688
|
+
|
689
|
+
### Parameters
|
690
|
+
|
691
|
+
Name | Type | Description | Notes
|
692
|
+
------------- | ------------- | ------------- | -------------
|
693
|
+
**body** | [**Body13**](Body13.md)| |
|
694
|
+
|
695
|
+
### Return type
|
696
|
+
|
697
|
+
[**Array<InlineResponse20013>**](InlineResponse20013.md)
|
698
|
+
|
699
|
+
### Authorization
|
700
|
+
|
701
|
+
No authorization required
|
702
|
+
|
703
|
+
### HTTP request headers
|
704
|
+
|
705
|
+
- **Content-Type**: application/json
|
706
|
+
- **Accept**: application/json
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
# **post_inbound_update_route**
|
711
|
+
> InlineResponse20011 post_inbound_update_route(body)
|
712
|
+
|
713
|
+
/inbound/update-route
|
714
|
+
|
715
|
+
Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
|
716
|
+
|
717
|
+
### Example
|
718
|
+
```ruby
|
719
|
+
# load the gem
|
720
|
+
require 'mailchimp_transactional'
|
721
|
+
|
722
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
723
|
+
|
724
|
+
body = MailchimpTransactional::Body11.new # Body11 |
|
725
|
+
|
726
|
+
|
727
|
+
begin
|
728
|
+
#/inbound/update-route
|
729
|
+
result = api_instance.post_inbound_update_route(body)
|
730
|
+
p result
|
731
|
+
rescue MailchimpTransactional::ApiError => e
|
732
|
+
puts "Exception when calling TransactionalApi->post_inbound_update_route: #{e}"
|
733
|
+
end
|
734
|
+
```
|
735
|
+
|
736
|
+
### Parameters
|
737
|
+
|
738
|
+
Name | Type | Description | Notes
|
739
|
+
------------- | ------------- | ------------- | -------------
|
740
|
+
**body** | [**Body11**](Body11.md)| |
|
741
|
+
|
742
|
+
### Return type
|
743
|
+
|
744
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
745
|
+
|
746
|
+
### Authorization
|
747
|
+
|
748
|
+
No authorization required
|
749
|
+
|
750
|
+
### HTTP request headers
|
751
|
+
|
752
|
+
- **Content-Type**: application/json
|
753
|
+
- **Accept**: application/json
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
# **post_ips_cancel_warmup**
|
758
|
+
> InlineResponse20017 post_ips_cancel_warmup(body)
|
759
|
+
|
760
|
+
/ips/cancel-warmup
|
761
|
+
|
762
|
+
Cancels the warmup process for a dedicated IP.
|
763
|
+
|
764
|
+
### Example
|
765
|
+
```ruby
|
766
|
+
# load the gem
|
767
|
+
require 'mailchimp_transactional'
|
768
|
+
|
769
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
770
|
+
|
771
|
+
body = MailchimpTransactional::Body18.new # Body18 |
|
772
|
+
|
773
|
+
|
774
|
+
begin
|
775
|
+
#/ips/cancel-warmup
|
776
|
+
result = api_instance.post_ips_cancel_warmup(body)
|
777
|
+
p result
|
778
|
+
rescue MailchimpTransactional::ApiError => e
|
779
|
+
puts "Exception when calling TransactionalApi->post_ips_cancel_warmup: #{e}"
|
780
|
+
end
|
781
|
+
```
|
782
|
+
|
783
|
+
### Parameters
|
784
|
+
|
785
|
+
Name | Type | Description | Notes
|
786
|
+
------------- | ------------- | ------------- | -------------
|
787
|
+
**body** | [**Body18**](Body18.md)| |
|
788
|
+
|
789
|
+
### Return type
|
790
|
+
|
791
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
792
|
+
|
793
|
+
### Authorization
|
794
|
+
|
795
|
+
No authorization required
|
796
|
+
|
797
|
+
### HTTP request headers
|
798
|
+
|
799
|
+
- **Content-Type**: application/json
|
800
|
+
- **Accept**: application/json
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
# **post_ips_check_custom_dns**
|
805
|
+
> InlineResponse20023 post_ips_check_custom_dns(body)
|
806
|
+
|
807
|
+
/ips/check-custom-dns
|
808
|
+
|
809
|
+
Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
|
810
|
+
|
811
|
+
### Example
|
812
|
+
```ruby
|
813
|
+
# load the gem
|
814
|
+
require 'mailchimp_transactional'
|
815
|
+
|
816
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
817
|
+
|
818
|
+
body = MailchimpTransactional::Body25.new # Body25 |
|
819
|
+
|
820
|
+
|
821
|
+
begin
|
822
|
+
#/ips/check-custom-dns
|
823
|
+
result = api_instance.post_ips_check_custom_dns(body)
|
824
|
+
p result
|
825
|
+
rescue MailchimpTransactional::ApiError => e
|
826
|
+
puts "Exception when calling TransactionalApi->post_ips_check_custom_dns: #{e}"
|
827
|
+
end
|
828
|
+
```
|
829
|
+
|
830
|
+
### Parameters
|
831
|
+
|
832
|
+
Name | Type | Description | Notes
|
833
|
+
------------- | ------------- | ------------- | -------------
|
834
|
+
**body** | [**Body25**](Body25.md)| |
|
835
|
+
|
836
|
+
### Return type
|
837
|
+
|
838
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
839
|
+
|
840
|
+
### Authorization
|
841
|
+
|
842
|
+
No authorization required
|
843
|
+
|
844
|
+
### HTTP request headers
|
845
|
+
|
846
|
+
- **Content-Type**: application/json
|
847
|
+
- **Accept**: application/json
|
848
|
+
|
849
|
+
|
850
|
+
|
851
|
+
# **post_ips_create_pool**
|
852
|
+
> InlineResponse20021 post_ips_create_pool(body)
|
853
|
+
|
854
|
+
/ips/create-pool
|
855
|
+
|
856
|
+
Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
|
857
|
+
|
858
|
+
### Example
|
859
|
+
```ruby
|
860
|
+
# load the gem
|
861
|
+
require 'mailchimp_transactional'
|
862
|
+
|
863
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
864
|
+
|
865
|
+
body = MailchimpTransactional::Body23.new # Body23 |
|
866
|
+
|
867
|
+
|
868
|
+
begin
|
869
|
+
#/ips/create-pool
|
870
|
+
result = api_instance.post_ips_create_pool(body)
|
871
|
+
p result
|
872
|
+
rescue MailchimpTransactional::ApiError => e
|
873
|
+
puts "Exception when calling TransactionalApi->post_ips_create_pool: #{e}"
|
874
|
+
end
|
875
|
+
```
|
876
|
+
|
877
|
+
### Parameters
|
878
|
+
|
879
|
+
Name | Type | Description | Notes
|
880
|
+
------------- | ------------- | ------------- | -------------
|
881
|
+
**body** | [**Body23**](Body23.md)| |
|
882
|
+
|
883
|
+
### Return type
|
884
|
+
|
885
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
886
|
+
|
887
|
+
### Authorization
|
888
|
+
|
889
|
+
No authorization required
|
890
|
+
|
891
|
+
### HTTP request headers
|
892
|
+
|
893
|
+
- **Content-Type**: application/json
|
894
|
+
- **Accept**: application/json
|
895
|
+
|
896
|
+
|
897
|
+
|
898
|
+
# **post_ips_delete**
|
899
|
+
> InlineResponse20019 post_ips_delete(body)
|
900
|
+
|
901
|
+
/ips/delete
|
902
|
+
|
903
|
+
Deletes a dedicated IP. This is permanent and cannot be undone.
|
904
|
+
|
905
|
+
### Example
|
906
|
+
```ruby
|
907
|
+
# load the gem
|
908
|
+
require 'mailchimp_transactional'
|
909
|
+
|
910
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
911
|
+
|
912
|
+
body = MailchimpTransactional::Body20.new # Body20 |
|
913
|
+
|
914
|
+
|
915
|
+
begin
|
916
|
+
#/ips/delete
|
917
|
+
result = api_instance.post_ips_delete(body)
|
918
|
+
p result
|
919
|
+
rescue MailchimpTransactional::ApiError => e
|
920
|
+
puts "Exception when calling TransactionalApi->post_ips_delete: #{e}"
|
921
|
+
end
|
922
|
+
```
|
923
|
+
|
924
|
+
### Parameters
|
925
|
+
|
926
|
+
Name | Type | Description | Notes
|
927
|
+
------------- | ------------- | ------------- | -------------
|
928
|
+
**body** | [**Body20**](Body20.md)| |
|
929
|
+
|
930
|
+
### Return type
|
931
|
+
|
932
|
+
[**InlineResponse20019**](InlineResponse20019.md)
|
933
|
+
|
934
|
+
### Authorization
|
935
|
+
|
936
|
+
No authorization required
|
937
|
+
|
938
|
+
### HTTP request headers
|
939
|
+
|
940
|
+
- **Content-Type**: application/json
|
941
|
+
- **Accept**: application/json
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
# **post_ips_delete_pool**
|
946
|
+
> InlineResponse20022 post_ips_delete_pool(body)
|
947
|
+
|
948
|
+
/ips/delete-pool
|
949
|
+
|
950
|
+
Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
|
951
|
+
|
952
|
+
### Example
|
953
|
+
```ruby
|
954
|
+
# load the gem
|
955
|
+
require 'mailchimp_transactional'
|
956
|
+
|
957
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
958
|
+
|
959
|
+
body = MailchimpTransactional::Body24.new # Body24 |
|
960
|
+
|
961
|
+
|
962
|
+
begin
|
963
|
+
#/ips/delete-pool
|
964
|
+
result = api_instance.post_ips_delete_pool(body)
|
965
|
+
p result
|
966
|
+
rescue MailchimpTransactional::ApiError => e
|
967
|
+
puts "Exception when calling TransactionalApi->post_ips_delete_pool: #{e}"
|
968
|
+
end
|
969
|
+
```
|
970
|
+
|
971
|
+
### Parameters
|
972
|
+
|
973
|
+
Name | Type | Description | Notes
|
974
|
+
------------- | ------------- | ------------- | -------------
|
975
|
+
**body** | [**Body24**](Body24.md)| |
|
976
|
+
|
977
|
+
### Return type
|
978
|
+
|
979
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
980
|
+
|
981
|
+
### Authorization
|
982
|
+
|
983
|
+
No authorization required
|
984
|
+
|
985
|
+
### HTTP request headers
|
986
|
+
|
987
|
+
- **Content-Type**: application/json
|
988
|
+
- **Accept**: application/json
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
# **post_ips_info**
|
993
|
+
> InlineResponse20015 post_ips_info(body)
|
994
|
+
|
995
|
+
/ips/info
|
996
|
+
|
997
|
+
Retrieves information about a single dedicated ip.
|
998
|
+
|
999
|
+
### Example
|
1000
|
+
```ruby
|
1001
|
+
# load the gem
|
1002
|
+
require 'mailchimp_transactional'
|
1003
|
+
|
1004
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1005
|
+
|
1006
|
+
body = MailchimpTransactional::Body15.new # Body15 |
|
1007
|
+
|
1008
|
+
|
1009
|
+
begin
|
1010
|
+
#/ips/info
|
1011
|
+
result = api_instance.post_ips_info(body)
|
1012
|
+
p result
|
1013
|
+
rescue MailchimpTransactional::ApiError => e
|
1014
|
+
puts "Exception when calling TransactionalApi->post_ips_info: #{e}"
|
1015
|
+
end
|
1016
|
+
```
|
1017
|
+
|
1018
|
+
### Parameters
|
1019
|
+
|
1020
|
+
Name | Type | Description | Notes
|
1021
|
+
------------- | ------------- | ------------- | -------------
|
1022
|
+
**body** | [**Body15**](Body15.md)| |
|
1023
|
+
|
1024
|
+
### Return type
|
1025
|
+
|
1026
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
1027
|
+
|
1028
|
+
### Authorization
|
1029
|
+
|
1030
|
+
No authorization required
|
1031
|
+
|
1032
|
+
### HTTP request headers
|
1033
|
+
|
1034
|
+
- **Content-Type**: application/json
|
1035
|
+
- **Accept**: application/json
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
# **post_ips_list**
|
1040
|
+
> Array<InlineResponse20014> post_ips_list(body)
|
1041
|
+
|
1042
|
+
/ips/list
|
1043
|
+
|
1044
|
+
Lists your dedicated IPs.
|
1045
|
+
|
1046
|
+
### Example
|
1047
|
+
```ruby
|
1048
|
+
# load the gem
|
1049
|
+
require 'mailchimp_transactional'
|
1050
|
+
|
1051
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1052
|
+
|
1053
|
+
body = MailchimpTransactional::Body14.new # Body14 |
|
1054
|
+
|
1055
|
+
|
1056
|
+
begin
|
1057
|
+
#/ips/list
|
1058
|
+
result = api_instance.post_ips_list(body)
|
1059
|
+
p result
|
1060
|
+
rescue MailchimpTransactional::ApiError => e
|
1061
|
+
puts "Exception when calling TransactionalApi->post_ips_list: #{e}"
|
1062
|
+
end
|
1063
|
+
```
|
1064
|
+
|
1065
|
+
### Parameters
|
1066
|
+
|
1067
|
+
Name | Type | Description | Notes
|
1068
|
+
------------- | ------------- | ------------- | -------------
|
1069
|
+
**body** | [**Body14**](Body14.md)| |
|
1070
|
+
|
1071
|
+
### Return type
|
1072
|
+
|
1073
|
+
[**Array<InlineResponse20014>**](InlineResponse20014.md)
|
1074
|
+
|
1075
|
+
### Authorization
|
1076
|
+
|
1077
|
+
No authorization required
|
1078
|
+
|
1079
|
+
### HTTP request headers
|
1080
|
+
|
1081
|
+
- **Content-Type**: application/json
|
1082
|
+
- **Accept**: application/json
|
1083
|
+
|
1084
|
+
|
1085
|
+
|
1086
|
+
# **post_ips_list_pools**
|
1087
|
+
> Array<InlineResponse20020> post_ips_list_pools(body)
|
1088
|
+
|
1089
|
+
/ips/list-pools
|
1090
|
+
|
1091
|
+
Lists your dedicated IP pools.
|
1092
|
+
|
1093
|
+
### Example
|
1094
|
+
```ruby
|
1095
|
+
# load the gem
|
1096
|
+
require 'mailchimp_transactional'
|
1097
|
+
|
1098
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1099
|
+
|
1100
|
+
body = MailchimpTransactional::Body21.new # Body21 |
|
1101
|
+
|
1102
|
+
|
1103
|
+
begin
|
1104
|
+
#/ips/list-pools
|
1105
|
+
result = api_instance.post_ips_list_pools(body)
|
1106
|
+
p result
|
1107
|
+
rescue MailchimpTransactional::ApiError => e
|
1108
|
+
puts "Exception when calling TransactionalApi->post_ips_list_pools: #{e}"
|
1109
|
+
end
|
1110
|
+
```
|
1111
|
+
|
1112
|
+
### Parameters
|
1113
|
+
|
1114
|
+
Name | Type | Description | Notes
|
1115
|
+
------------- | ------------- | ------------- | -------------
|
1116
|
+
**body** | [**Body21**](Body21.md)| |
|
1117
|
+
|
1118
|
+
### Return type
|
1119
|
+
|
1120
|
+
[**Array<InlineResponse20020>**](InlineResponse20020.md)
|
1121
|
+
|
1122
|
+
### Authorization
|
1123
|
+
|
1124
|
+
No authorization required
|
1125
|
+
|
1126
|
+
### HTTP request headers
|
1127
|
+
|
1128
|
+
- **Content-Type**: application/json
|
1129
|
+
- **Accept**: application/json
|
1130
|
+
|
1131
|
+
|
1132
|
+
|
1133
|
+
# **post_ips_pool_info**
|
1134
|
+
> InlineResponse20021 post_ips_pool_info(body)
|
1135
|
+
|
1136
|
+
/ips/pool-info
|
1137
|
+
|
1138
|
+
Describes a single dedicated IP pool.
|
1139
|
+
|
1140
|
+
### Example
|
1141
|
+
```ruby
|
1142
|
+
# load the gem
|
1143
|
+
require 'mailchimp_transactional'
|
1144
|
+
|
1145
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1146
|
+
|
1147
|
+
body = MailchimpTransactional::Body22.new # Body22 |
|
1148
|
+
|
1149
|
+
|
1150
|
+
begin
|
1151
|
+
#/ips/pool-info
|
1152
|
+
result = api_instance.post_ips_pool_info(body)
|
1153
|
+
p result
|
1154
|
+
rescue MailchimpTransactional::ApiError => e
|
1155
|
+
puts "Exception when calling TransactionalApi->post_ips_pool_info: #{e}"
|
1156
|
+
end
|
1157
|
+
```
|
1158
|
+
|
1159
|
+
### Parameters
|
1160
|
+
|
1161
|
+
Name | Type | Description | Notes
|
1162
|
+
------------- | ------------- | ------------- | -------------
|
1163
|
+
**body** | [**Body22**](Body22.md)| |
|
1164
|
+
|
1165
|
+
### Return type
|
1166
|
+
|
1167
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
1168
|
+
|
1169
|
+
### Authorization
|
1170
|
+
|
1171
|
+
No authorization required
|
1172
|
+
|
1173
|
+
### HTTP request headers
|
1174
|
+
|
1175
|
+
- **Content-Type**: application/json
|
1176
|
+
- **Accept**: application/json
|
1177
|
+
|
1178
|
+
|
1179
|
+
|
1180
|
+
# **post_ips_provision**
|
1181
|
+
> InlineResponse20016 post_ips_provision(body)
|
1182
|
+
|
1183
|
+
/ips/provision
|
1184
|
+
|
1185
|
+
Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
|
1186
|
+
|
1187
|
+
### Example
|
1188
|
+
```ruby
|
1189
|
+
# load the gem
|
1190
|
+
require 'mailchimp_transactional'
|
1191
|
+
|
1192
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1193
|
+
|
1194
|
+
body = MailchimpTransactional::Body16.new # Body16 |
|
1195
|
+
|
1196
|
+
|
1197
|
+
begin
|
1198
|
+
#/ips/provision
|
1199
|
+
result = api_instance.post_ips_provision(body)
|
1200
|
+
p result
|
1201
|
+
rescue MailchimpTransactional::ApiError => e
|
1202
|
+
puts "Exception when calling TransactionalApi->post_ips_provision: #{e}"
|
1203
|
+
end
|
1204
|
+
```
|
1205
|
+
|
1206
|
+
### Parameters
|
1207
|
+
|
1208
|
+
Name | Type | Description | Notes
|
1209
|
+
------------- | ------------- | ------------- | -------------
|
1210
|
+
**body** | [**Body16**](Body16.md)| |
|
1211
|
+
|
1212
|
+
### Return type
|
1213
|
+
|
1214
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
1215
|
+
|
1216
|
+
### Authorization
|
1217
|
+
|
1218
|
+
No authorization required
|
1219
|
+
|
1220
|
+
### HTTP request headers
|
1221
|
+
|
1222
|
+
- **Content-Type**: application/json
|
1223
|
+
- **Accept**: application/json
|
1224
|
+
|
1225
|
+
|
1226
|
+
|
1227
|
+
# **post_ips_set_custom_dns**
|
1228
|
+
> InlineResponse20024 post_ips_set_custom_dns(body)
|
1229
|
+
|
1230
|
+
/ips/set-custom-dns
|
1231
|
+
|
1232
|
+
Configures the custom DNS name for a dedicated IP.
|
1233
|
+
|
1234
|
+
### Example
|
1235
|
+
```ruby
|
1236
|
+
# load the gem
|
1237
|
+
require 'mailchimp_transactional'
|
1238
|
+
|
1239
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1240
|
+
|
1241
|
+
body = MailchimpTransactional::Body26.new # Body26 |
|
1242
|
+
|
1243
|
+
|
1244
|
+
begin
|
1245
|
+
#/ips/set-custom-dns
|
1246
|
+
result = api_instance.post_ips_set_custom_dns(body)
|
1247
|
+
p result
|
1248
|
+
rescue MailchimpTransactional::ApiError => e
|
1249
|
+
puts "Exception when calling TransactionalApi->post_ips_set_custom_dns: #{e}"
|
1250
|
+
end
|
1251
|
+
```
|
1252
|
+
|
1253
|
+
### Parameters
|
1254
|
+
|
1255
|
+
Name | Type | Description | Notes
|
1256
|
+
------------- | ------------- | ------------- | -------------
|
1257
|
+
**body** | [**Body26**](Body26.md)| |
|
1258
|
+
|
1259
|
+
### Return type
|
1260
|
+
|
1261
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
1262
|
+
|
1263
|
+
### Authorization
|
1264
|
+
|
1265
|
+
No authorization required
|
1266
|
+
|
1267
|
+
### HTTP request headers
|
1268
|
+
|
1269
|
+
- **Content-Type**: application/json
|
1270
|
+
- **Accept**: application/json
|
1271
|
+
|
1272
|
+
|
1273
|
+
|
1274
|
+
# **post_ips_set_pool**
|
1275
|
+
> InlineResponse20018 post_ips_set_pool(body)
|
1276
|
+
|
1277
|
+
/ips/set-pool
|
1278
|
+
|
1279
|
+
Moves a dedicated IP to a different pool.
|
1280
|
+
|
1281
|
+
### Example
|
1282
|
+
```ruby
|
1283
|
+
# load the gem
|
1284
|
+
require 'mailchimp_transactional'
|
1285
|
+
|
1286
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1287
|
+
|
1288
|
+
body = MailchimpTransactional::Body19.new # Body19 |
|
1289
|
+
|
1290
|
+
|
1291
|
+
begin
|
1292
|
+
#/ips/set-pool
|
1293
|
+
result = api_instance.post_ips_set_pool(body)
|
1294
|
+
p result
|
1295
|
+
rescue MailchimpTransactional::ApiError => e
|
1296
|
+
puts "Exception when calling TransactionalApi->post_ips_set_pool: #{e}"
|
1297
|
+
end
|
1298
|
+
```
|
1299
|
+
|
1300
|
+
### Parameters
|
1301
|
+
|
1302
|
+
Name | Type | Description | Notes
|
1303
|
+
------------- | ------------- | ------------- | -------------
|
1304
|
+
**body** | [**Body19**](Body19.md)| |
|
1305
|
+
|
1306
|
+
### Return type
|
1307
|
+
|
1308
|
+
[**InlineResponse20018**](InlineResponse20018.md)
|
1309
|
+
|
1310
|
+
### Authorization
|
1311
|
+
|
1312
|
+
No authorization required
|
1313
|
+
|
1314
|
+
### HTTP request headers
|
1315
|
+
|
1316
|
+
- **Content-Type**: application/json
|
1317
|
+
- **Accept**: application/json
|
1318
|
+
|
1319
|
+
|
1320
|
+
|
1321
|
+
# **post_ips_start_warmup**
|
1322
|
+
> InlineResponse20017 post_ips_start_warmup(body)
|
1323
|
+
|
1324
|
+
/ips/start-warmup
|
1325
|
+
|
1326
|
+
Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
|
1327
|
+
|
1328
|
+
### Example
|
1329
|
+
```ruby
|
1330
|
+
# load the gem
|
1331
|
+
require 'mailchimp_transactional'
|
1332
|
+
|
1333
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1334
|
+
|
1335
|
+
body = MailchimpTransactional::Body17.new # Body17 |
|
1336
|
+
|
1337
|
+
|
1338
|
+
begin
|
1339
|
+
#/ips/start-warmup
|
1340
|
+
result = api_instance.post_ips_start_warmup(body)
|
1341
|
+
p result
|
1342
|
+
rescue MailchimpTransactional::ApiError => e
|
1343
|
+
puts "Exception when calling TransactionalApi->post_ips_start_warmup: #{e}"
|
1344
|
+
end
|
1345
|
+
```
|
1346
|
+
|
1347
|
+
### Parameters
|
1348
|
+
|
1349
|
+
Name | Type | Description | Notes
|
1350
|
+
------------- | ------------- | ------------- | -------------
|
1351
|
+
**body** | [**Body17**](Body17.md)| |
|
1352
|
+
|
1353
|
+
### Return type
|
1354
|
+
|
1355
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
1356
|
+
|
1357
|
+
### Authorization
|
1358
|
+
|
1359
|
+
No authorization required
|
1360
|
+
|
1361
|
+
### HTTP request headers
|
1362
|
+
|
1363
|
+
- **Content-Type**: application/json
|
1364
|
+
- **Accept**: application/json
|
1365
|
+
|
1366
|
+
|
1367
|
+
|
1368
|
+
# **post_messages_cancel_scheduled**
|
1369
|
+
> Array<InlineResponse20032> post_messages_cancel_scheduled(body)
|
1370
|
+
|
1371
|
+
/messages/cancel-scheduled
|
1372
|
+
|
1373
|
+
Queries your scheduled emails.
|
1374
|
+
|
1375
|
+
### Example
|
1376
|
+
```ruby
|
1377
|
+
# load the gem
|
1378
|
+
require 'mailchimp_transactional'
|
1379
|
+
|
1380
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1381
|
+
|
1382
|
+
body = MailchimpTransactional::Body36.new # Body36 |
|
1383
|
+
|
1384
|
+
|
1385
|
+
begin
|
1386
|
+
#/messages/cancel-scheduled
|
1387
|
+
result = api_instance.post_messages_cancel_scheduled(body)
|
1388
|
+
p result
|
1389
|
+
rescue MailchimpTransactional::ApiError => e
|
1390
|
+
puts "Exception when calling TransactionalApi->post_messages_cancel_scheduled: #{e}"
|
1391
|
+
end
|
1392
|
+
```
|
1393
|
+
|
1394
|
+
### Parameters
|
1395
|
+
|
1396
|
+
Name | Type | Description | Notes
|
1397
|
+
------------- | ------------- | ------------- | -------------
|
1398
|
+
**body** | [**Body36**](Body36.md)| |
|
1399
|
+
|
1400
|
+
### Return type
|
1401
|
+
|
1402
|
+
[**Array<InlineResponse20032>**](InlineResponse20032.md)
|
1403
|
+
|
1404
|
+
### Authorization
|
1405
|
+
|
1406
|
+
No authorization required
|
1407
|
+
|
1408
|
+
### HTTP request headers
|
1409
|
+
|
1410
|
+
- **Content-Type**: application/json
|
1411
|
+
- **Accept**: application/json
|
1412
|
+
|
1413
|
+
|
1414
|
+
|
1415
|
+
# **post_messages_content**
|
1416
|
+
> InlineResponse20030 post_messages_content(body)
|
1417
|
+
|
1418
|
+
/messages/content
|
1419
|
+
|
1420
|
+
Get the full content of a recently sent message
|
1421
|
+
|
1422
|
+
### Example
|
1423
|
+
```ruby
|
1424
|
+
# load the gem
|
1425
|
+
require 'mailchimp_transactional'
|
1426
|
+
|
1427
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1428
|
+
|
1429
|
+
body = MailchimpTransactional::Body32.new # Body32 |
|
1430
|
+
|
1431
|
+
|
1432
|
+
begin
|
1433
|
+
#/messages/content
|
1434
|
+
result = api_instance.post_messages_content(body)
|
1435
|
+
p result
|
1436
|
+
rescue MailchimpTransactional::ApiError => e
|
1437
|
+
puts "Exception when calling TransactionalApi->post_messages_content: #{e}"
|
1438
|
+
end
|
1439
|
+
```
|
1440
|
+
|
1441
|
+
### Parameters
|
1442
|
+
|
1443
|
+
Name | Type | Description | Notes
|
1444
|
+
------------- | ------------- | ------------- | -------------
|
1445
|
+
**body** | [**Body32**](Body32.md)| |
|
1446
|
+
|
1447
|
+
### Return type
|
1448
|
+
|
1449
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
1450
|
+
|
1451
|
+
### Authorization
|
1452
|
+
|
1453
|
+
No authorization required
|
1454
|
+
|
1455
|
+
### HTTP request headers
|
1456
|
+
|
1457
|
+
- **Content-Type**: application/json
|
1458
|
+
- **Accept**: application/json
|
1459
|
+
|
1460
|
+
|
1461
|
+
|
1462
|
+
# **post_messages_info**
|
1463
|
+
> InlineResponse20029 post_messages_info(body)
|
1464
|
+
|
1465
|
+
/messages/info
|
1466
|
+
|
1467
|
+
Get the information for a single recently sent message
|
1468
|
+
|
1469
|
+
### Example
|
1470
|
+
```ruby
|
1471
|
+
# load the gem
|
1472
|
+
require 'mailchimp_transactional'
|
1473
|
+
|
1474
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1475
|
+
|
1476
|
+
body = MailchimpTransactional::Body31.new # Body31 |
|
1477
|
+
|
1478
|
+
|
1479
|
+
begin
|
1480
|
+
#/messages/info
|
1481
|
+
result = api_instance.post_messages_info(body)
|
1482
|
+
p result
|
1483
|
+
rescue MailchimpTransactional::ApiError => e
|
1484
|
+
puts "Exception when calling TransactionalApi->post_messages_info: #{e}"
|
1485
|
+
end
|
1486
|
+
```
|
1487
|
+
|
1488
|
+
### Parameters
|
1489
|
+
|
1490
|
+
Name | Type | Description | Notes
|
1491
|
+
------------- | ------------- | ------------- | -------------
|
1492
|
+
**body** | [**Body31**](Body31.md)| |
|
1493
|
+
|
1494
|
+
### Return type
|
1495
|
+
|
1496
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
1497
|
+
|
1498
|
+
### Authorization
|
1499
|
+
|
1500
|
+
No authorization required
|
1501
|
+
|
1502
|
+
### HTTP request headers
|
1503
|
+
|
1504
|
+
- **Content-Type**: application/json
|
1505
|
+
- **Accept**: application/json
|
1506
|
+
|
1507
|
+
|
1508
|
+
|
1509
|
+
# **post_messages_list_scheduled**
|
1510
|
+
> Array<InlineResponse20032> post_messages_list_scheduled(body)
|
1511
|
+
|
1512
|
+
/messages/list-scheduled
|
1513
|
+
|
1514
|
+
Queries your scheduled emails.
|
1515
|
+
|
1516
|
+
### Example
|
1517
|
+
```ruby
|
1518
|
+
# load the gem
|
1519
|
+
require 'mailchimp_transactional'
|
1520
|
+
|
1521
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1522
|
+
|
1523
|
+
body = MailchimpTransactional::Body35.new # Body35 |
|
1524
|
+
|
1525
|
+
|
1526
|
+
begin
|
1527
|
+
#/messages/list-scheduled
|
1528
|
+
result = api_instance.post_messages_list_scheduled(body)
|
1529
|
+
p result
|
1530
|
+
rescue MailchimpTransactional::ApiError => e
|
1531
|
+
puts "Exception when calling TransactionalApi->post_messages_list_scheduled: #{e}"
|
1532
|
+
end
|
1533
|
+
```
|
1534
|
+
|
1535
|
+
### Parameters
|
1536
|
+
|
1537
|
+
Name | Type | Description | Notes
|
1538
|
+
------------- | ------------- | ------------- | -------------
|
1539
|
+
**body** | [**Body35**](Body35.md)| |
|
1540
|
+
|
1541
|
+
### Return type
|
1542
|
+
|
1543
|
+
[**Array<InlineResponse20032>**](InlineResponse20032.md)
|
1544
|
+
|
1545
|
+
### Authorization
|
1546
|
+
|
1547
|
+
No authorization required
|
1548
|
+
|
1549
|
+
### HTTP request headers
|
1550
|
+
|
1551
|
+
- **Content-Type**: application/json
|
1552
|
+
- **Accept**: application/json
|
1553
|
+
|
1554
|
+
|
1555
|
+
|
1556
|
+
# **post_messages_parse**
|
1557
|
+
> InlineResponse20031 post_messages_parse(body)
|
1558
|
+
|
1559
|
+
/messages/parse
|
1560
|
+
|
1561
|
+
Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
|
1562
|
+
|
1563
|
+
### Example
|
1564
|
+
```ruby
|
1565
|
+
# load the gem
|
1566
|
+
require 'mailchimp_transactional'
|
1567
|
+
|
1568
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1569
|
+
|
1570
|
+
body = MailchimpTransactional::Body33.new # Body33 |
|
1571
|
+
|
1572
|
+
|
1573
|
+
begin
|
1574
|
+
#/messages/parse
|
1575
|
+
result = api_instance.post_messages_parse(body)
|
1576
|
+
p result
|
1577
|
+
rescue MailchimpTransactional::ApiError => e
|
1578
|
+
puts "Exception when calling TransactionalApi->post_messages_parse: #{e}"
|
1579
|
+
end
|
1580
|
+
```
|
1581
|
+
|
1582
|
+
### Parameters
|
1583
|
+
|
1584
|
+
Name | Type | Description | Notes
|
1585
|
+
------------- | ------------- | ------------- | -------------
|
1586
|
+
**body** | [**Body33**](Body33.md)| |
|
1587
|
+
|
1588
|
+
### Return type
|
1589
|
+
|
1590
|
+
[**InlineResponse20031**](InlineResponse20031.md)
|
1591
|
+
|
1592
|
+
### Authorization
|
1593
|
+
|
1594
|
+
No authorization required
|
1595
|
+
|
1596
|
+
### HTTP request headers
|
1597
|
+
|
1598
|
+
- **Content-Type**: application/json
|
1599
|
+
- **Accept**: application/json
|
1600
|
+
|
1601
|
+
|
1602
|
+
|
1603
|
+
# **post_messages_reschedule**
|
1604
|
+
> Array<InlineResponse20032> post_messages_reschedule(body)
|
1605
|
+
|
1606
|
+
/messages/reschedule
|
1607
|
+
|
1608
|
+
Queries your scheduled emails.
|
1609
|
+
|
1610
|
+
### Example
|
1611
|
+
```ruby
|
1612
|
+
# load the gem
|
1613
|
+
require 'mailchimp_transactional'
|
1614
|
+
|
1615
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1616
|
+
|
1617
|
+
body = MailchimpTransactional::Body37.new # Body37 |
|
1618
|
+
|
1619
|
+
|
1620
|
+
begin
|
1621
|
+
#/messages/reschedule
|
1622
|
+
result = api_instance.post_messages_reschedule(body)
|
1623
|
+
p result
|
1624
|
+
rescue MailchimpTransactional::ApiError => e
|
1625
|
+
puts "Exception when calling TransactionalApi->post_messages_reschedule: #{e}"
|
1626
|
+
end
|
1627
|
+
```
|
1628
|
+
|
1629
|
+
### Parameters
|
1630
|
+
|
1631
|
+
Name | Type | Description | Notes
|
1632
|
+
------------- | ------------- | ------------- | -------------
|
1633
|
+
**body** | [**Body37**](Body37.md)| |
|
1634
|
+
|
1635
|
+
### Return type
|
1636
|
+
|
1637
|
+
[**Array<InlineResponse20032>**](InlineResponse20032.md)
|
1638
|
+
|
1639
|
+
### Authorization
|
1640
|
+
|
1641
|
+
No authorization required
|
1642
|
+
|
1643
|
+
### HTTP request headers
|
1644
|
+
|
1645
|
+
- **Content-Type**: application/json
|
1646
|
+
- **Accept**: application/json
|
1647
|
+
|
1648
|
+
|
1649
|
+
|
1650
|
+
# **post_messages_search**
|
1651
|
+
> Array<InlineResponse20027> post_messages_search(body)
|
1652
|
+
|
1653
|
+
/messages/search
|
1654
|
+
|
1655
|
+
Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.
|
1656
|
+
|
1657
|
+
### Example
|
1658
|
+
```ruby
|
1659
|
+
# load the gem
|
1660
|
+
require 'mailchimp_transactional'
|
1661
|
+
|
1662
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1663
|
+
|
1664
|
+
body = MailchimpTransactional::Body29.new # Body29 |
|
1665
|
+
|
1666
|
+
|
1667
|
+
begin
|
1668
|
+
#/messages/search
|
1669
|
+
result = api_instance.post_messages_search(body)
|
1670
|
+
p result
|
1671
|
+
rescue MailchimpTransactional::ApiError => e
|
1672
|
+
puts "Exception when calling TransactionalApi->post_messages_search: #{e}"
|
1673
|
+
end
|
1674
|
+
```
|
1675
|
+
|
1676
|
+
### Parameters
|
1677
|
+
|
1678
|
+
Name | Type | Description | Notes
|
1679
|
+
------------- | ------------- | ------------- | -------------
|
1680
|
+
**body** | [**Body29**](Body29.md)| |
|
1681
|
+
|
1682
|
+
### Return type
|
1683
|
+
|
1684
|
+
[**Array<InlineResponse20027>**](InlineResponse20027.md)
|
1685
|
+
|
1686
|
+
### Authorization
|
1687
|
+
|
1688
|
+
No authorization required
|
1689
|
+
|
1690
|
+
### HTTP request headers
|
1691
|
+
|
1692
|
+
- **Content-Type**: application/json
|
1693
|
+
- **Accept**: application/json
|
1694
|
+
|
1695
|
+
|
1696
|
+
|
1697
|
+
# **post_messages_search_time_series**
|
1698
|
+
> Array<InlineResponse20028> post_messages_search_time_series(body)
|
1699
|
+
|
1700
|
+
/messages/search-time-series
|
1701
|
+
|
1702
|
+
Search the content of recently sent messages and return the aggregated hourly stats for matching messages
|
1703
|
+
|
1704
|
+
### Example
|
1705
|
+
```ruby
|
1706
|
+
# load the gem
|
1707
|
+
require 'mailchimp_transactional'
|
1708
|
+
|
1709
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1710
|
+
|
1711
|
+
body = MailchimpTransactional::Body30.new # Body30 |
|
1712
|
+
|
1713
|
+
|
1714
|
+
begin
|
1715
|
+
#/messages/search-time-series
|
1716
|
+
result = api_instance.post_messages_search_time_series(body)
|
1717
|
+
p result
|
1718
|
+
rescue MailchimpTransactional::ApiError => e
|
1719
|
+
puts "Exception when calling TransactionalApi->post_messages_search_time_series: #{e}"
|
1720
|
+
end
|
1721
|
+
```
|
1722
|
+
|
1723
|
+
### Parameters
|
1724
|
+
|
1725
|
+
Name | Type | Description | Notes
|
1726
|
+
------------- | ------------- | ------------- | -------------
|
1727
|
+
**body** | [**Body30**](Body30.md)| |
|
1728
|
+
|
1729
|
+
### Return type
|
1730
|
+
|
1731
|
+
[**Array<InlineResponse20028>**](InlineResponse20028.md)
|
1732
|
+
|
1733
|
+
### Authorization
|
1734
|
+
|
1735
|
+
No authorization required
|
1736
|
+
|
1737
|
+
### HTTP request headers
|
1738
|
+
|
1739
|
+
- **Content-Type**: application/json
|
1740
|
+
- **Accept**: application/json
|
1741
|
+
|
1742
|
+
|
1743
|
+
|
1744
|
+
# **post_messages_send**
|
1745
|
+
> Array<InlineResponse20025> post_messages_send(body)
|
1746
|
+
|
1747
|
+
/messages/send
|
1748
|
+
|
1749
|
+
Send a new transactional message through Mandrill
|
1750
|
+
|
1751
|
+
### Example
|
1752
|
+
```ruby
|
1753
|
+
# load the gem
|
1754
|
+
require 'mailchimp_transactional'
|
1755
|
+
|
1756
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1757
|
+
|
1758
|
+
body = MailchimpTransactional::Body27.new # Body27 |
|
1759
|
+
|
1760
|
+
|
1761
|
+
begin
|
1762
|
+
#/messages/send
|
1763
|
+
result = api_instance.post_messages_send(body)
|
1764
|
+
p result
|
1765
|
+
rescue MailchimpTransactional::ApiError => e
|
1766
|
+
puts "Exception when calling TransactionalApi->post_messages_send: #{e}"
|
1767
|
+
end
|
1768
|
+
```
|
1769
|
+
|
1770
|
+
### Parameters
|
1771
|
+
|
1772
|
+
Name | Type | Description | Notes
|
1773
|
+
------------- | ------------- | ------------- | -------------
|
1774
|
+
**body** | [**Body27**](Body27.md)| |
|
1775
|
+
|
1776
|
+
### Return type
|
1777
|
+
|
1778
|
+
[**Array<InlineResponse20025>**](InlineResponse20025.md)
|
1779
|
+
|
1780
|
+
### Authorization
|
1781
|
+
|
1782
|
+
No authorization required
|
1783
|
+
|
1784
|
+
### HTTP request headers
|
1785
|
+
|
1786
|
+
- **Content-Type**: application/json
|
1787
|
+
- **Accept**: application/json
|
1788
|
+
|
1789
|
+
|
1790
|
+
|
1791
|
+
# **post_messages_send_raw**
|
1792
|
+
> Object post_messages_send_raw(body)
|
1793
|
+
|
1794
|
+
/messages/send-raw
|
1795
|
+
|
1796
|
+
Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
|
1797
|
+
|
1798
|
+
### Example
|
1799
|
+
```ruby
|
1800
|
+
# load the gem
|
1801
|
+
require 'mailchimp_transactional'
|
1802
|
+
|
1803
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1804
|
+
|
1805
|
+
body = MailchimpTransactional::Body34.new # Body34 |
|
1806
|
+
|
1807
|
+
|
1808
|
+
begin
|
1809
|
+
#/messages/send-raw
|
1810
|
+
result = api_instance.post_messages_send_raw(body)
|
1811
|
+
p result
|
1812
|
+
rescue MailchimpTransactional::ApiError => e
|
1813
|
+
puts "Exception when calling TransactionalApi->post_messages_send_raw: #{e}"
|
1814
|
+
end
|
1815
|
+
```
|
1816
|
+
|
1817
|
+
### Parameters
|
1818
|
+
|
1819
|
+
Name | Type | Description | Notes
|
1820
|
+
------------- | ------------- | ------------- | -------------
|
1821
|
+
**body** | [**Body34**](Body34.md)| |
|
1822
|
+
|
1823
|
+
### Return type
|
1824
|
+
|
1825
|
+
**Object**
|
1826
|
+
|
1827
|
+
### Authorization
|
1828
|
+
|
1829
|
+
No authorization required
|
1830
|
+
|
1831
|
+
### HTTP request headers
|
1832
|
+
|
1833
|
+
- **Content-Type**: application/json
|
1834
|
+
- **Accept**: application/json
|
1835
|
+
|
1836
|
+
|
1837
|
+
|
1838
|
+
# **post_messages_send_template**
|
1839
|
+
> Array<InlineResponse20026> post_messages_send_template(body)
|
1840
|
+
|
1841
|
+
/messages/send-template
|
1842
|
+
|
1843
|
+
Send a new transactional message through Mandrill
|
1844
|
+
|
1845
|
+
### Example
|
1846
|
+
```ruby
|
1847
|
+
# load the gem
|
1848
|
+
require 'mailchimp_transactional'
|
1849
|
+
|
1850
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1851
|
+
|
1852
|
+
body = MailchimpTransactional::Body28.new # Body28 |
|
1853
|
+
|
1854
|
+
|
1855
|
+
begin
|
1856
|
+
#/messages/send-template
|
1857
|
+
result = api_instance.post_messages_send_template(body)
|
1858
|
+
p result
|
1859
|
+
rescue MailchimpTransactional::ApiError => e
|
1860
|
+
puts "Exception when calling TransactionalApi->post_messages_send_template: #{e}"
|
1861
|
+
end
|
1862
|
+
```
|
1863
|
+
|
1864
|
+
### Parameters
|
1865
|
+
|
1866
|
+
Name | Type | Description | Notes
|
1867
|
+
------------- | ------------- | ------------- | -------------
|
1868
|
+
**body** | [**Body28**](Body28.md)| |
|
1869
|
+
|
1870
|
+
### Return type
|
1871
|
+
|
1872
|
+
[**Array<InlineResponse20026>**](InlineResponse20026.md)
|
1873
|
+
|
1874
|
+
### Authorization
|
1875
|
+
|
1876
|
+
No authorization required
|
1877
|
+
|
1878
|
+
### HTTP request headers
|
1879
|
+
|
1880
|
+
- **Content-Type**: application/json
|
1881
|
+
- **Accept**: application/json
|
1882
|
+
|
1883
|
+
|
1884
|
+
|
1885
|
+
# **post_metadata_add**
|
1886
|
+
> InlineResponse20034 post_metadata_add(body)
|
1887
|
+
|
1888
|
+
/metadata/add
|
1889
|
+
|
1890
|
+
Add a new custom metadata field to be indexed for the account.
|
1891
|
+
|
1892
|
+
### Example
|
1893
|
+
```ruby
|
1894
|
+
# load the gem
|
1895
|
+
require 'mailchimp_transactional'
|
1896
|
+
|
1897
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1898
|
+
|
1899
|
+
body = MailchimpTransactional::Body39.new # Body39 |
|
1900
|
+
|
1901
|
+
|
1902
|
+
begin
|
1903
|
+
#/metadata/add
|
1904
|
+
result = api_instance.post_metadata_add(body)
|
1905
|
+
p result
|
1906
|
+
rescue MailchimpTransactional::ApiError => e
|
1907
|
+
puts "Exception when calling TransactionalApi->post_metadata_add: #{e}"
|
1908
|
+
end
|
1909
|
+
```
|
1910
|
+
|
1911
|
+
### Parameters
|
1912
|
+
|
1913
|
+
Name | Type | Description | Notes
|
1914
|
+
------------- | ------------- | ------------- | -------------
|
1915
|
+
**body** | [**Body39**](Body39.md)| |
|
1916
|
+
|
1917
|
+
### Return type
|
1918
|
+
|
1919
|
+
[**InlineResponse20034**](InlineResponse20034.md)
|
1920
|
+
|
1921
|
+
### Authorization
|
1922
|
+
|
1923
|
+
No authorization required
|
1924
|
+
|
1925
|
+
### HTTP request headers
|
1926
|
+
|
1927
|
+
- **Content-Type**: application/json
|
1928
|
+
- **Accept**: application/json
|
1929
|
+
|
1930
|
+
|
1931
|
+
|
1932
|
+
# **post_metadata_delete**
|
1933
|
+
> InlineResponse20036 post_metadata_delete(body)
|
1934
|
+
|
1935
|
+
/metadata/delete
|
1936
|
+
|
1937
|
+
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
|
1938
|
+
|
1939
|
+
### Example
|
1940
|
+
```ruby
|
1941
|
+
# load the gem
|
1942
|
+
require 'mailchimp_transactional'
|
1943
|
+
|
1944
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1945
|
+
|
1946
|
+
body = MailchimpTransactional::Body41.new # Body41 |
|
1947
|
+
|
1948
|
+
|
1949
|
+
begin
|
1950
|
+
#/metadata/delete
|
1951
|
+
result = api_instance.post_metadata_delete(body)
|
1952
|
+
p result
|
1953
|
+
rescue MailchimpTransactional::ApiError => e
|
1954
|
+
puts "Exception when calling TransactionalApi->post_metadata_delete: #{e}"
|
1955
|
+
end
|
1956
|
+
```
|
1957
|
+
|
1958
|
+
### Parameters
|
1959
|
+
|
1960
|
+
Name | Type | Description | Notes
|
1961
|
+
------------- | ------------- | ------------- | -------------
|
1962
|
+
**body** | [**Body41**](Body41.md)| |
|
1963
|
+
|
1964
|
+
### Return type
|
1965
|
+
|
1966
|
+
[**InlineResponse20036**](InlineResponse20036.md)
|
1967
|
+
|
1968
|
+
### Authorization
|
1969
|
+
|
1970
|
+
No authorization required
|
1971
|
+
|
1972
|
+
### HTTP request headers
|
1973
|
+
|
1974
|
+
- **Content-Type**: application/json
|
1975
|
+
- **Accept**: application/json
|
1976
|
+
|
1977
|
+
|
1978
|
+
|
1979
|
+
# **post_metadata_list**
|
1980
|
+
> Array<InlineResponse20033> post_metadata_list(body)
|
1981
|
+
|
1982
|
+
/metadata/list
|
1983
|
+
|
1984
|
+
Get the list of custom metadata fields indexed for the account.
|
1985
|
+
|
1986
|
+
### Example
|
1987
|
+
```ruby
|
1988
|
+
# load the gem
|
1989
|
+
require 'mailchimp_transactional'
|
1990
|
+
|
1991
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
1992
|
+
|
1993
|
+
body = MailchimpTransactional::Body38.new # Body38 |
|
1994
|
+
|
1995
|
+
|
1996
|
+
begin
|
1997
|
+
#/metadata/list
|
1998
|
+
result = api_instance.post_metadata_list(body)
|
1999
|
+
p result
|
2000
|
+
rescue MailchimpTransactional::ApiError => e
|
2001
|
+
puts "Exception when calling TransactionalApi->post_metadata_list: #{e}"
|
2002
|
+
end
|
2003
|
+
```
|
2004
|
+
|
2005
|
+
### Parameters
|
2006
|
+
|
2007
|
+
Name | Type | Description | Notes
|
2008
|
+
------------- | ------------- | ------------- | -------------
|
2009
|
+
**body** | [**Body38**](Body38.md)| |
|
2010
|
+
|
2011
|
+
### Return type
|
2012
|
+
|
2013
|
+
[**Array<InlineResponse20033>**](InlineResponse20033.md)
|
2014
|
+
|
2015
|
+
### Authorization
|
2016
|
+
|
2017
|
+
No authorization required
|
2018
|
+
|
2019
|
+
### HTTP request headers
|
2020
|
+
|
2021
|
+
- **Content-Type**: application/json
|
2022
|
+
- **Accept**: application/json
|
2023
|
+
|
2024
|
+
|
2025
|
+
|
2026
|
+
# **post_metadata_update**
|
2027
|
+
> InlineResponse20035 post_metadata_update(body)
|
2028
|
+
|
2029
|
+
/metadata/update
|
2030
|
+
|
2031
|
+
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
|
2032
|
+
|
2033
|
+
### Example
|
2034
|
+
```ruby
|
2035
|
+
# load the gem
|
2036
|
+
require 'mailchimp_transactional'
|
2037
|
+
|
2038
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2039
|
+
|
2040
|
+
body = MailchimpTransactional::Body40.new # Body40 |
|
2041
|
+
|
2042
|
+
|
2043
|
+
begin
|
2044
|
+
#/metadata/update
|
2045
|
+
result = api_instance.post_metadata_update(body)
|
2046
|
+
p result
|
2047
|
+
rescue MailchimpTransactional::ApiError => e
|
2048
|
+
puts "Exception when calling TransactionalApi->post_metadata_update: #{e}"
|
2049
|
+
end
|
2050
|
+
```
|
2051
|
+
|
2052
|
+
### Parameters
|
2053
|
+
|
2054
|
+
Name | Type | Description | Notes
|
2055
|
+
------------- | ------------- | ------------- | -------------
|
2056
|
+
**body** | [**Body40**](Body40.md)| |
|
2057
|
+
|
2058
|
+
### Return type
|
2059
|
+
|
2060
|
+
[**InlineResponse20035**](InlineResponse20035.md)
|
2061
|
+
|
2062
|
+
### Authorization
|
2063
|
+
|
2064
|
+
No authorization required
|
2065
|
+
|
2066
|
+
### HTTP request headers
|
2067
|
+
|
2068
|
+
- **Content-Type**: application/json
|
2069
|
+
- **Accept**: application/json
|
2070
|
+
|
2071
|
+
|
2072
|
+
|
2073
|
+
# **post_rejects_add**
|
2074
|
+
> InlineResponse20037 post_rejects_add(body)
|
2075
|
+
|
2076
|
+
/rejects/add
|
2077
|
+
|
2078
|
+
Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
|
2079
|
+
|
2080
|
+
### Example
|
2081
|
+
```ruby
|
2082
|
+
# load the gem
|
2083
|
+
require 'mailchimp_transactional'
|
2084
|
+
|
2085
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2086
|
+
|
2087
|
+
body = MailchimpTransactional::Body42.new # Body42 |
|
2088
|
+
|
2089
|
+
|
2090
|
+
begin
|
2091
|
+
#/rejects/add
|
2092
|
+
result = api_instance.post_rejects_add(body)
|
2093
|
+
p result
|
2094
|
+
rescue MailchimpTransactional::ApiError => e
|
2095
|
+
puts "Exception when calling TransactionalApi->post_rejects_add: #{e}"
|
2096
|
+
end
|
2097
|
+
```
|
2098
|
+
|
2099
|
+
### Parameters
|
2100
|
+
|
2101
|
+
Name | Type | Description | Notes
|
2102
|
+
------------- | ------------- | ------------- | -------------
|
2103
|
+
**body** | [**Body42**](Body42.md)| |
|
2104
|
+
|
2105
|
+
### Return type
|
2106
|
+
|
2107
|
+
[**InlineResponse20037**](InlineResponse20037.md)
|
2108
|
+
|
2109
|
+
### Authorization
|
2110
|
+
|
2111
|
+
No authorization required
|
2112
|
+
|
2113
|
+
### HTTP request headers
|
2114
|
+
|
2115
|
+
- **Content-Type**: application/json
|
2116
|
+
- **Accept**: application/json
|
2117
|
+
|
2118
|
+
|
2119
|
+
|
2120
|
+
# **post_rejects_delete**
|
2121
|
+
> InlineResponse20039 post_rejects_delete(body)
|
2122
|
+
|
2123
|
+
/rejects/delete
|
2124
|
+
|
2125
|
+
Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
|
2126
|
+
|
2127
|
+
### Example
|
2128
|
+
```ruby
|
2129
|
+
# load the gem
|
2130
|
+
require 'mailchimp_transactional'
|
2131
|
+
|
2132
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2133
|
+
|
2134
|
+
body = MailchimpTransactional::Body44.new # Body44 |
|
2135
|
+
|
2136
|
+
|
2137
|
+
begin
|
2138
|
+
#/rejects/delete
|
2139
|
+
result = api_instance.post_rejects_delete(body)
|
2140
|
+
p result
|
2141
|
+
rescue MailchimpTransactional::ApiError => e
|
2142
|
+
puts "Exception when calling TransactionalApi->post_rejects_delete: #{e}"
|
2143
|
+
end
|
2144
|
+
```
|
2145
|
+
|
2146
|
+
### Parameters
|
2147
|
+
|
2148
|
+
Name | Type | Description | Notes
|
2149
|
+
------------- | ------------- | ------------- | -------------
|
2150
|
+
**body** | [**Body44**](Body44.md)| |
|
2151
|
+
|
2152
|
+
### Return type
|
2153
|
+
|
2154
|
+
[**InlineResponse20039**](InlineResponse20039.md)
|
2155
|
+
|
2156
|
+
### Authorization
|
2157
|
+
|
2158
|
+
No authorization required
|
2159
|
+
|
2160
|
+
### HTTP request headers
|
2161
|
+
|
2162
|
+
- **Content-Type**: application/json
|
2163
|
+
- **Accept**: application/json
|
2164
|
+
|
2165
|
+
|
2166
|
+
|
2167
|
+
# **post_rejects_list**
|
2168
|
+
> Array<InlineResponse20038> post_rejects_list(body)
|
2169
|
+
|
2170
|
+
/rejects/list
|
2171
|
+
|
2172
|
+
Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
|
2173
|
+
|
2174
|
+
### Example
|
2175
|
+
```ruby
|
2176
|
+
# load the gem
|
2177
|
+
require 'mailchimp_transactional'
|
2178
|
+
|
2179
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2180
|
+
|
2181
|
+
body = MailchimpTransactional::Body43.new # Body43 |
|
2182
|
+
|
2183
|
+
|
2184
|
+
begin
|
2185
|
+
#/rejects/list
|
2186
|
+
result = api_instance.post_rejects_list(body)
|
2187
|
+
p result
|
2188
|
+
rescue MailchimpTransactional::ApiError => e
|
2189
|
+
puts "Exception when calling TransactionalApi->post_rejects_list: #{e}"
|
2190
|
+
end
|
2191
|
+
```
|
2192
|
+
|
2193
|
+
### Parameters
|
2194
|
+
|
2195
|
+
Name | Type | Description | Notes
|
2196
|
+
------------- | ------------- | ------------- | -------------
|
2197
|
+
**body** | [**Body43**](Body43.md)| |
|
2198
|
+
|
2199
|
+
### Return type
|
2200
|
+
|
2201
|
+
[**Array<InlineResponse20038>**](InlineResponse20038.md)
|
2202
|
+
|
2203
|
+
### Authorization
|
2204
|
+
|
2205
|
+
No authorization required
|
2206
|
+
|
2207
|
+
### HTTP request headers
|
2208
|
+
|
2209
|
+
- **Content-Type**: application/json
|
2210
|
+
- **Accept**: application/json
|
2211
|
+
|
2212
|
+
|
2213
|
+
|
2214
|
+
# **post_senders_add_domain**
|
2215
|
+
> InlineResponse20042 post_senders_add_domain(body)
|
2216
|
+
|
2217
|
+
/senders/add-domain
|
2218
|
+
|
2219
|
+
Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
|
2220
|
+
|
2221
|
+
### Example
|
2222
|
+
```ruby
|
2223
|
+
# load the gem
|
2224
|
+
require 'mailchimp_transactional'
|
2225
|
+
|
2226
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2227
|
+
|
2228
|
+
body = MailchimpTransactional::Body47.new # Body47 |
|
2229
|
+
|
2230
|
+
|
2231
|
+
begin
|
2232
|
+
#/senders/add-domain
|
2233
|
+
result = api_instance.post_senders_add_domain(body)
|
2234
|
+
p result
|
2235
|
+
rescue MailchimpTransactional::ApiError => e
|
2236
|
+
puts "Exception when calling TransactionalApi->post_senders_add_domain: #{e}"
|
2237
|
+
end
|
2238
|
+
```
|
2239
|
+
|
2240
|
+
### Parameters
|
2241
|
+
|
2242
|
+
Name | Type | Description | Notes
|
2243
|
+
------------- | ------------- | ------------- | -------------
|
2244
|
+
**body** | [**Body47**](Body47.md)| |
|
2245
|
+
|
2246
|
+
### Return type
|
2247
|
+
|
2248
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
2249
|
+
|
2250
|
+
### Authorization
|
2251
|
+
|
2252
|
+
No authorization required
|
2253
|
+
|
2254
|
+
### HTTP request headers
|
2255
|
+
|
2256
|
+
- **Content-Type**: application/json
|
2257
|
+
- **Accept**: application/json
|
2258
|
+
|
2259
|
+
|
2260
|
+
|
2261
|
+
# **post_senders_check_domain**
|
2262
|
+
> InlineResponse20043 post_senders_check_domain(body)
|
2263
|
+
|
2264
|
+
/senders/check-domain
|
2265
|
+
|
2266
|
+
Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
|
2267
|
+
|
2268
|
+
### Example
|
2269
|
+
```ruby
|
2270
|
+
# load the gem
|
2271
|
+
require 'mailchimp_transactional'
|
2272
|
+
|
2273
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2274
|
+
|
2275
|
+
body = MailchimpTransactional::Body48.new # Body48 |
|
2276
|
+
|
2277
|
+
|
2278
|
+
begin
|
2279
|
+
#/senders/check-domain
|
2280
|
+
result = api_instance.post_senders_check_domain(body)
|
2281
|
+
p result
|
2282
|
+
rescue MailchimpTransactional::ApiError => e
|
2283
|
+
puts "Exception when calling TransactionalApi->post_senders_check_domain: #{e}"
|
2284
|
+
end
|
2285
|
+
```
|
2286
|
+
|
2287
|
+
### Parameters
|
2288
|
+
|
2289
|
+
Name | Type | Description | Notes
|
2290
|
+
------------- | ------------- | ------------- | -------------
|
2291
|
+
**body** | [**Body48**](Body48.md)| |
|
2292
|
+
|
2293
|
+
### Return type
|
2294
|
+
|
2295
|
+
[**InlineResponse20043**](InlineResponse20043.md)
|
2296
|
+
|
2297
|
+
### Authorization
|
2298
|
+
|
2299
|
+
No authorization required
|
2300
|
+
|
2301
|
+
### HTTP request headers
|
2302
|
+
|
2303
|
+
- **Content-Type**: application/json
|
2304
|
+
- **Accept**: application/json
|
2305
|
+
|
2306
|
+
|
2307
|
+
|
2308
|
+
# **post_senders_domains**
|
2309
|
+
> Array<InlineResponse20041> post_senders_domains(body)
|
2310
|
+
|
2311
|
+
/senders/domains
|
2312
|
+
|
2313
|
+
Returns the sender domains that have been added to this account
|
2314
|
+
|
2315
|
+
### Example
|
2316
|
+
```ruby
|
2317
|
+
# load the gem
|
2318
|
+
require 'mailchimp_transactional'
|
2319
|
+
|
2320
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2321
|
+
|
2322
|
+
body = MailchimpTransactional::Body46.new # Body46 |
|
2323
|
+
|
2324
|
+
|
2325
|
+
begin
|
2326
|
+
#/senders/domains
|
2327
|
+
result = api_instance.post_senders_domains(body)
|
2328
|
+
p result
|
2329
|
+
rescue MailchimpTransactional::ApiError => e
|
2330
|
+
puts "Exception when calling TransactionalApi->post_senders_domains: #{e}"
|
2331
|
+
end
|
2332
|
+
```
|
2333
|
+
|
2334
|
+
### Parameters
|
2335
|
+
|
2336
|
+
Name | Type | Description | Notes
|
2337
|
+
------------- | ------------- | ------------- | -------------
|
2338
|
+
**body** | [**Body46**](Body46.md)| |
|
2339
|
+
|
2340
|
+
### Return type
|
2341
|
+
|
2342
|
+
[**Array<InlineResponse20041>**](InlineResponse20041.md)
|
2343
|
+
|
2344
|
+
### Authorization
|
2345
|
+
|
2346
|
+
No authorization required
|
2347
|
+
|
2348
|
+
### HTTP request headers
|
2349
|
+
|
2350
|
+
- **Content-Type**: application/json
|
2351
|
+
- **Accept**: application/json
|
2352
|
+
|
2353
|
+
|
2354
|
+
|
2355
|
+
# **post_senders_info**
|
2356
|
+
> InlineResponse20045 post_senders_info(body)
|
2357
|
+
|
2358
|
+
/senders/info
|
2359
|
+
|
2360
|
+
Return more detailed information about a single sender, including aggregates of recent stats
|
2361
|
+
|
2362
|
+
### Example
|
2363
|
+
```ruby
|
2364
|
+
# load the gem
|
2365
|
+
require 'mailchimp_transactional'
|
2366
|
+
|
2367
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2368
|
+
|
2369
|
+
body = MailchimpTransactional::Body50.new # Body50 |
|
2370
|
+
|
2371
|
+
|
2372
|
+
begin
|
2373
|
+
#/senders/info
|
2374
|
+
result = api_instance.post_senders_info(body)
|
2375
|
+
p result
|
2376
|
+
rescue MailchimpTransactional::ApiError => e
|
2377
|
+
puts "Exception when calling TransactionalApi->post_senders_info: #{e}"
|
2378
|
+
end
|
2379
|
+
```
|
2380
|
+
|
2381
|
+
### Parameters
|
2382
|
+
|
2383
|
+
Name | Type | Description | Notes
|
2384
|
+
------------- | ------------- | ------------- | -------------
|
2385
|
+
**body** | [**Body50**](Body50.md)| |
|
2386
|
+
|
2387
|
+
### Return type
|
2388
|
+
|
2389
|
+
[**InlineResponse20045**](InlineResponse20045.md)
|
2390
|
+
|
2391
|
+
### Authorization
|
2392
|
+
|
2393
|
+
No authorization required
|
2394
|
+
|
2395
|
+
### HTTP request headers
|
2396
|
+
|
2397
|
+
- **Content-Type**: application/json
|
2398
|
+
- **Accept**: application/json
|
2399
|
+
|
2400
|
+
|
2401
|
+
|
2402
|
+
# **post_senders_list**
|
2403
|
+
> Array<InlineResponse20040> post_senders_list(body)
|
2404
|
+
|
2405
|
+
/senders/list
|
2406
|
+
|
2407
|
+
Return the senders that have tried to use this account
|
2408
|
+
|
2409
|
+
### Example
|
2410
|
+
```ruby
|
2411
|
+
# load the gem
|
2412
|
+
require 'mailchimp_transactional'
|
2413
|
+
|
2414
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2415
|
+
|
2416
|
+
body = MailchimpTransactional::Body45.new # Body45 |
|
2417
|
+
|
2418
|
+
|
2419
|
+
begin
|
2420
|
+
#/senders/list
|
2421
|
+
result = api_instance.post_senders_list(body)
|
2422
|
+
p result
|
2423
|
+
rescue MailchimpTransactional::ApiError => e
|
2424
|
+
puts "Exception when calling TransactionalApi->post_senders_list: #{e}"
|
2425
|
+
end
|
2426
|
+
```
|
2427
|
+
|
2428
|
+
### Parameters
|
2429
|
+
|
2430
|
+
Name | Type | Description | Notes
|
2431
|
+
------------- | ------------- | ------------- | -------------
|
2432
|
+
**body** | [**Body45**](Body45.md)| |
|
2433
|
+
|
2434
|
+
### Return type
|
2435
|
+
|
2436
|
+
[**Array<InlineResponse20040>**](InlineResponse20040.md)
|
2437
|
+
|
2438
|
+
### Authorization
|
2439
|
+
|
2440
|
+
No authorization required
|
2441
|
+
|
2442
|
+
### HTTP request headers
|
2443
|
+
|
2444
|
+
- **Content-Type**: application/json
|
2445
|
+
- **Accept**: application/json
|
2446
|
+
|
2447
|
+
|
2448
|
+
|
2449
|
+
# **post_senders_time_series**
|
2450
|
+
> Array<InlineResponse20046> post_senders_time_series(body)
|
2451
|
+
|
2452
|
+
/senders/time-series
|
2453
|
+
|
2454
|
+
Return the recent history (hourly stats for the last 30 days) for a sender
|
2455
|
+
|
2456
|
+
### Example
|
2457
|
+
```ruby
|
2458
|
+
# load the gem
|
2459
|
+
require 'mailchimp_transactional'
|
2460
|
+
|
2461
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2462
|
+
|
2463
|
+
body = MailchimpTransactional::Body51.new # Body51 |
|
2464
|
+
|
2465
|
+
|
2466
|
+
begin
|
2467
|
+
#/senders/time-series
|
2468
|
+
result = api_instance.post_senders_time_series(body)
|
2469
|
+
p result
|
2470
|
+
rescue MailchimpTransactional::ApiError => e
|
2471
|
+
puts "Exception when calling TransactionalApi->post_senders_time_series: #{e}"
|
2472
|
+
end
|
2473
|
+
```
|
2474
|
+
|
2475
|
+
### Parameters
|
2476
|
+
|
2477
|
+
Name | Type | Description | Notes
|
2478
|
+
------------- | ------------- | ------------- | -------------
|
2479
|
+
**body** | [**Body51**](Body51.md)| |
|
2480
|
+
|
2481
|
+
### Return type
|
2482
|
+
|
2483
|
+
[**Array<InlineResponse20046>**](InlineResponse20046.md)
|
2484
|
+
|
2485
|
+
### Authorization
|
2486
|
+
|
2487
|
+
No authorization required
|
2488
|
+
|
2489
|
+
### HTTP request headers
|
2490
|
+
|
2491
|
+
- **Content-Type**: application/json
|
2492
|
+
- **Accept**: application/json
|
2493
|
+
|
2494
|
+
|
2495
|
+
|
2496
|
+
# **post_senders_verify_domain**
|
2497
|
+
> InlineResponse20044 post_senders_verify_domain(body)
|
2498
|
+
|
2499
|
+
/senders/verify-domain
|
2500
|
+
|
2501
|
+
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
|
2502
|
+
|
2503
|
+
### Example
|
2504
|
+
```ruby
|
2505
|
+
# load the gem
|
2506
|
+
require 'mailchimp_transactional'
|
2507
|
+
|
2508
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2509
|
+
|
2510
|
+
body = MailchimpTransactional::Body49.new # Body49 |
|
2511
|
+
|
2512
|
+
|
2513
|
+
begin
|
2514
|
+
#/senders/verify-domain
|
2515
|
+
result = api_instance.post_senders_verify_domain(body)
|
2516
|
+
p result
|
2517
|
+
rescue MailchimpTransactional::ApiError => e
|
2518
|
+
puts "Exception when calling TransactionalApi->post_senders_verify_domain: #{e}"
|
2519
|
+
end
|
2520
|
+
```
|
2521
|
+
|
2522
|
+
### Parameters
|
2523
|
+
|
2524
|
+
Name | Type | Description | Notes
|
2525
|
+
------------- | ------------- | ------------- | -------------
|
2526
|
+
**body** | [**Body49**](Body49.md)| |
|
2527
|
+
|
2528
|
+
### Return type
|
2529
|
+
|
2530
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
2531
|
+
|
2532
|
+
### Authorization
|
2533
|
+
|
2534
|
+
No authorization required
|
2535
|
+
|
2536
|
+
### HTTP request headers
|
2537
|
+
|
2538
|
+
- **Content-Type**: application/json
|
2539
|
+
- **Accept**: application/json
|
2540
|
+
|
2541
|
+
|
2542
|
+
|
2543
|
+
# **post_subaccounts_add**
|
2544
|
+
> InlineResponse20048 post_subaccounts_add(body)
|
2545
|
+
|
2546
|
+
/subaccounts/add
|
2547
|
+
|
2548
|
+
Add a new subaccount
|
2549
|
+
|
2550
|
+
### Example
|
2551
|
+
```ruby
|
2552
|
+
# load the gem
|
2553
|
+
require 'mailchimp_transactional'
|
2554
|
+
|
2555
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2556
|
+
|
2557
|
+
body = MailchimpTransactional::Body53.new # Body53 |
|
2558
|
+
|
2559
|
+
|
2560
|
+
begin
|
2561
|
+
#/subaccounts/add
|
2562
|
+
result = api_instance.post_subaccounts_add(body)
|
2563
|
+
p result
|
2564
|
+
rescue MailchimpTransactional::ApiError => e
|
2565
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_add: #{e}"
|
2566
|
+
end
|
2567
|
+
```
|
2568
|
+
|
2569
|
+
### Parameters
|
2570
|
+
|
2571
|
+
Name | Type | Description | Notes
|
2572
|
+
------------- | ------------- | ------------- | -------------
|
2573
|
+
**body** | [**Body53**](Body53.md)| |
|
2574
|
+
|
2575
|
+
### Return type
|
2576
|
+
|
2577
|
+
[**InlineResponse20048**](InlineResponse20048.md)
|
2578
|
+
|
2579
|
+
### Authorization
|
2580
|
+
|
2581
|
+
No authorization required
|
2582
|
+
|
2583
|
+
### HTTP request headers
|
2584
|
+
|
2585
|
+
- **Content-Type**: application/json
|
2586
|
+
- **Accept**: application/json
|
2587
|
+
|
2588
|
+
|
2589
|
+
|
2590
|
+
# **post_subaccounts_delete**
|
2591
|
+
> InlineResponse20051 post_subaccounts_delete(body)
|
2592
|
+
|
2593
|
+
/subaccounts/delete
|
2594
|
+
|
2595
|
+
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
|
2596
|
+
|
2597
|
+
### Example
|
2598
|
+
```ruby
|
2599
|
+
# load the gem
|
2600
|
+
require 'mailchimp_transactional'
|
2601
|
+
|
2602
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2603
|
+
|
2604
|
+
body = MailchimpTransactional::Body56.new # Body56 |
|
2605
|
+
|
2606
|
+
|
2607
|
+
begin
|
2608
|
+
#/subaccounts/delete
|
2609
|
+
result = api_instance.post_subaccounts_delete(body)
|
2610
|
+
p result
|
2611
|
+
rescue MailchimpTransactional::ApiError => e
|
2612
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_delete: #{e}"
|
2613
|
+
end
|
2614
|
+
```
|
2615
|
+
|
2616
|
+
### Parameters
|
2617
|
+
|
2618
|
+
Name | Type | Description | Notes
|
2619
|
+
------------- | ------------- | ------------- | -------------
|
2620
|
+
**body** | [**Body56**](Body56.md)| |
|
2621
|
+
|
2622
|
+
### Return type
|
2623
|
+
|
2624
|
+
[**InlineResponse20051**](InlineResponse20051.md)
|
2625
|
+
|
2626
|
+
### Authorization
|
2627
|
+
|
2628
|
+
No authorization required
|
2629
|
+
|
2630
|
+
### HTTP request headers
|
2631
|
+
|
2632
|
+
- **Content-Type**: application/json
|
2633
|
+
- **Accept**: application/json
|
2634
|
+
|
2635
|
+
|
2636
|
+
|
2637
|
+
# **post_subaccounts_info**
|
2638
|
+
> InlineResponse20049 post_subaccounts_info(body)
|
2639
|
+
|
2640
|
+
/subaccounts/info
|
2641
|
+
|
2642
|
+
Given the ID of an existing subaccount, return the data about it
|
2643
|
+
|
2644
|
+
### Example
|
2645
|
+
```ruby
|
2646
|
+
# load the gem
|
2647
|
+
require 'mailchimp_transactional'
|
2648
|
+
|
2649
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2650
|
+
|
2651
|
+
body = MailchimpTransactional::Body54.new # Body54 |
|
2652
|
+
|
2653
|
+
|
2654
|
+
begin
|
2655
|
+
#/subaccounts/info
|
2656
|
+
result = api_instance.post_subaccounts_info(body)
|
2657
|
+
p result
|
2658
|
+
rescue MailchimpTransactional::ApiError => e
|
2659
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_info: #{e}"
|
2660
|
+
end
|
2661
|
+
```
|
2662
|
+
|
2663
|
+
### Parameters
|
2664
|
+
|
2665
|
+
Name | Type | Description | Notes
|
2666
|
+
------------- | ------------- | ------------- | -------------
|
2667
|
+
**body** | [**Body54**](Body54.md)| |
|
2668
|
+
|
2669
|
+
### Return type
|
2670
|
+
|
2671
|
+
[**InlineResponse20049**](InlineResponse20049.md)
|
2672
|
+
|
2673
|
+
### Authorization
|
2674
|
+
|
2675
|
+
No authorization required
|
2676
|
+
|
2677
|
+
### HTTP request headers
|
2678
|
+
|
2679
|
+
- **Content-Type**: application/json
|
2680
|
+
- **Accept**: application/json
|
2681
|
+
|
2682
|
+
|
2683
|
+
|
2684
|
+
# **post_subaccounts_list**
|
2685
|
+
> Array<InlineResponse20047> post_subaccounts_list(body)
|
2686
|
+
|
2687
|
+
/subaccounts/list
|
2688
|
+
|
2689
|
+
Get the list of subaccounts defined for the account, optionally filtered by a prefix
|
2690
|
+
|
2691
|
+
### Example
|
2692
|
+
```ruby
|
2693
|
+
# load the gem
|
2694
|
+
require 'mailchimp_transactional'
|
2695
|
+
|
2696
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2697
|
+
|
2698
|
+
body = MailchimpTransactional::Body52.new # Body52 |
|
2699
|
+
|
2700
|
+
|
2701
|
+
begin
|
2702
|
+
#/subaccounts/list
|
2703
|
+
result = api_instance.post_subaccounts_list(body)
|
2704
|
+
p result
|
2705
|
+
rescue MailchimpTransactional::ApiError => e
|
2706
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_list: #{e}"
|
2707
|
+
end
|
2708
|
+
```
|
2709
|
+
|
2710
|
+
### Parameters
|
2711
|
+
|
2712
|
+
Name | Type | Description | Notes
|
2713
|
+
------------- | ------------- | ------------- | -------------
|
2714
|
+
**body** | [**Body52**](Body52.md)| |
|
2715
|
+
|
2716
|
+
### Return type
|
2717
|
+
|
2718
|
+
[**Array<InlineResponse20047>**](InlineResponse20047.md)
|
2719
|
+
|
2720
|
+
### Authorization
|
2721
|
+
|
2722
|
+
No authorization required
|
2723
|
+
|
2724
|
+
### HTTP request headers
|
2725
|
+
|
2726
|
+
- **Content-Type**: application/json
|
2727
|
+
- **Accept**: application/json
|
2728
|
+
|
2729
|
+
|
2730
|
+
|
2731
|
+
# **post_subaccounts_pause**
|
2732
|
+
> InlineResponse20052 post_subaccounts_pause(body)
|
2733
|
+
|
2734
|
+
/subaccounts/pause
|
2735
|
+
|
2736
|
+
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
|
2737
|
+
|
2738
|
+
### Example
|
2739
|
+
```ruby
|
2740
|
+
# load the gem
|
2741
|
+
require 'mailchimp_transactional'
|
2742
|
+
|
2743
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2744
|
+
|
2745
|
+
body = MailchimpTransactional::Body57.new # Body57 |
|
2746
|
+
|
2747
|
+
|
2748
|
+
begin
|
2749
|
+
#/subaccounts/pause
|
2750
|
+
result = api_instance.post_subaccounts_pause(body)
|
2751
|
+
p result
|
2752
|
+
rescue MailchimpTransactional::ApiError => e
|
2753
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_pause: #{e}"
|
2754
|
+
end
|
2755
|
+
```
|
2756
|
+
|
2757
|
+
### Parameters
|
2758
|
+
|
2759
|
+
Name | Type | Description | Notes
|
2760
|
+
------------- | ------------- | ------------- | -------------
|
2761
|
+
**body** | [**Body57**](Body57.md)| |
|
2762
|
+
|
2763
|
+
### Return type
|
2764
|
+
|
2765
|
+
[**InlineResponse20052**](InlineResponse20052.md)
|
2766
|
+
|
2767
|
+
### Authorization
|
2768
|
+
|
2769
|
+
No authorization required
|
2770
|
+
|
2771
|
+
### HTTP request headers
|
2772
|
+
|
2773
|
+
- **Content-Type**: application/json
|
2774
|
+
- **Accept**: application/json
|
2775
|
+
|
2776
|
+
|
2777
|
+
|
2778
|
+
# **post_subaccounts_resume**
|
2779
|
+
> InlineResponse20053 post_subaccounts_resume(body)
|
2780
|
+
|
2781
|
+
/subaccounts/resume
|
2782
|
+
|
2783
|
+
Resume a paused subaccount's sending
|
2784
|
+
|
2785
|
+
### Example
|
2786
|
+
```ruby
|
2787
|
+
# load the gem
|
2788
|
+
require 'mailchimp_transactional'
|
2789
|
+
|
2790
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2791
|
+
|
2792
|
+
body = MailchimpTransactional::Body58.new # Body58 |
|
2793
|
+
|
2794
|
+
|
2795
|
+
begin
|
2796
|
+
#/subaccounts/resume
|
2797
|
+
result = api_instance.post_subaccounts_resume(body)
|
2798
|
+
p result
|
2799
|
+
rescue MailchimpTransactional::ApiError => e
|
2800
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_resume: #{e}"
|
2801
|
+
end
|
2802
|
+
```
|
2803
|
+
|
2804
|
+
### Parameters
|
2805
|
+
|
2806
|
+
Name | Type | Description | Notes
|
2807
|
+
------------- | ------------- | ------------- | -------------
|
2808
|
+
**body** | [**Body58**](Body58.md)| |
|
2809
|
+
|
2810
|
+
### Return type
|
2811
|
+
|
2812
|
+
[**InlineResponse20053**](InlineResponse20053.md)
|
2813
|
+
|
2814
|
+
### Authorization
|
2815
|
+
|
2816
|
+
No authorization required
|
2817
|
+
|
2818
|
+
### HTTP request headers
|
2819
|
+
|
2820
|
+
- **Content-Type**: application/json
|
2821
|
+
- **Accept**: application/json
|
2822
|
+
|
2823
|
+
|
2824
|
+
|
2825
|
+
# **post_subaccounts_update**
|
2826
|
+
> InlineResponse20050 post_subaccounts_update(body)
|
2827
|
+
|
2828
|
+
/subaccounts/update
|
2829
|
+
|
2830
|
+
Update an existing subaccount
|
2831
|
+
|
2832
|
+
### Example
|
2833
|
+
```ruby
|
2834
|
+
# load the gem
|
2835
|
+
require 'mailchimp_transactional'
|
2836
|
+
|
2837
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2838
|
+
|
2839
|
+
body = MailchimpTransactional::Body55.new # Body55 |
|
2840
|
+
|
2841
|
+
|
2842
|
+
begin
|
2843
|
+
#/subaccounts/update
|
2844
|
+
result = api_instance.post_subaccounts_update(body)
|
2845
|
+
p result
|
2846
|
+
rescue MailchimpTransactional::ApiError => e
|
2847
|
+
puts "Exception when calling TransactionalApi->post_subaccounts_update: #{e}"
|
2848
|
+
end
|
2849
|
+
```
|
2850
|
+
|
2851
|
+
### Parameters
|
2852
|
+
|
2853
|
+
Name | Type | Description | Notes
|
2854
|
+
------------- | ------------- | ------------- | -------------
|
2855
|
+
**body** | [**Body55**](Body55.md)| |
|
2856
|
+
|
2857
|
+
### Return type
|
2858
|
+
|
2859
|
+
[**InlineResponse20050**](InlineResponse20050.md)
|
2860
|
+
|
2861
|
+
### Authorization
|
2862
|
+
|
2863
|
+
No authorization required
|
2864
|
+
|
2865
|
+
### HTTP request headers
|
2866
|
+
|
2867
|
+
- **Content-Type**: application/json
|
2868
|
+
- **Accept**: application/json
|
2869
|
+
|
2870
|
+
|
2871
|
+
|
2872
|
+
# **post_tags_all_time_series**
|
2873
|
+
> Array<InlineResponse20028> post_tags_all_time_series(body)
|
2874
|
+
|
2875
|
+
/tags/all-time-series
|
2876
|
+
|
2877
|
+
Return the recent history (hourly stats for the last 30 days) for all tags
|
2878
|
+
|
2879
|
+
### Example
|
2880
|
+
```ruby
|
2881
|
+
# load the gem
|
2882
|
+
require 'mailchimp_transactional'
|
2883
|
+
|
2884
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2885
|
+
|
2886
|
+
body = MailchimpTransactional::Body63.new # Body63 |
|
2887
|
+
|
2888
|
+
|
2889
|
+
begin
|
2890
|
+
#/tags/all-time-series
|
2891
|
+
result = api_instance.post_tags_all_time_series(body)
|
2892
|
+
p result
|
2893
|
+
rescue MailchimpTransactional::ApiError => e
|
2894
|
+
puts "Exception when calling TransactionalApi->post_tags_all_time_series: #{e}"
|
2895
|
+
end
|
2896
|
+
```
|
2897
|
+
|
2898
|
+
### Parameters
|
2899
|
+
|
2900
|
+
Name | Type | Description | Notes
|
2901
|
+
------------- | ------------- | ------------- | -------------
|
2902
|
+
**body** | [**Body63**](Body63.md)| |
|
2903
|
+
|
2904
|
+
### Return type
|
2905
|
+
|
2906
|
+
[**Array<InlineResponse20028>**](InlineResponse20028.md)
|
2907
|
+
|
2908
|
+
### Authorization
|
2909
|
+
|
2910
|
+
No authorization required
|
2911
|
+
|
2912
|
+
### HTTP request headers
|
2913
|
+
|
2914
|
+
- **Content-Type**: application/json
|
2915
|
+
- **Accept**: application/json
|
2916
|
+
|
2917
|
+
|
2918
|
+
|
2919
|
+
# **post_tags_delete**
|
2920
|
+
> InlineResponse20055 post_tags_delete(body)
|
2921
|
+
|
2922
|
+
/tags/delete
|
2923
|
+
|
2924
|
+
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
|
2925
|
+
|
2926
|
+
### Example
|
2927
|
+
```ruby
|
2928
|
+
# load the gem
|
2929
|
+
require 'mailchimp_transactional'
|
2930
|
+
|
2931
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2932
|
+
|
2933
|
+
body = MailchimpTransactional::Body60.new # Body60 |
|
2934
|
+
|
2935
|
+
|
2936
|
+
begin
|
2937
|
+
#/tags/delete
|
2938
|
+
result = api_instance.post_tags_delete(body)
|
2939
|
+
p result
|
2940
|
+
rescue MailchimpTransactional::ApiError => e
|
2941
|
+
puts "Exception when calling TransactionalApi->post_tags_delete: #{e}"
|
2942
|
+
end
|
2943
|
+
```
|
2944
|
+
|
2945
|
+
### Parameters
|
2946
|
+
|
2947
|
+
Name | Type | Description | Notes
|
2948
|
+
------------- | ------------- | ------------- | -------------
|
2949
|
+
**body** | [**Body60**](Body60.md)| |
|
2950
|
+
|
2951
|
+
### Return type
|
2952
|
+
|
2953
|
+
[**InlineResponse20055**](InlineResponse20055.md)
|
2954
|
+
|
2955
|
+
### Authorization
|
2956
|
+
|
2957
|
+
No authorization required
|
2958
|
+
|
2959
|
+
### HTTP request headers
|
2960
|
+
|
2961
|
+
- **Content-Type**: application/json
|
2962
|
+
- **Accept**: application/json
|
2963
|
+
|
2964
|
+
|
2965
|
+
|
2966
|
+
# **post_tags_info**
|
2967
|
+
> InlineResponse20056 post_tags_info(body)
|
2968
|
+
|
2969
|
+
/tags/info
|
2970
|
+
|
2971
|
+
Return more detailed information about a single tag, including aggregates of recent stats
|
2972
|
+
|
2973
|
+
### Example
|
2974
|
+
```ruby
|
2975
|
+
# load the gem
|
2976
|
+
require 'mailchimp_transactional'
|
2977
|
+
|
2978
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
2979
|
+
|
2980
|
+
body = MailchimpTransactional::Body61.new # Body61 |
|
2981
|
+
|
2982
|
+
|
2983
|
+
begin
|
2984
|
+
#/tags/info
|
2985
|
+
result = api_instance.post_tags_info(body)
|
2986
|
+
p result
|
2987
|
+
rescue MailchimpTransactional::ApiError => e
|
2988
|
+
puts "Exception when calling TransactionalApi->post_tags_info: #{e}"
|
2989
|
+
end
|
2990
|
+
```
|
2991
|
+
|
2992
|
+
### Parameters
|
2993
|
+
|
2994
|
+
Name | Type | Description | Notes
|
2995
|
+
------------- | ------------- | ------------- | -------------
|
2996
|
+
**body** | [**Body61**](Body61.md)| |
|
2997
|
+
|
2998
|
+
### Return type
|
2999
|
+
|
3000
|
+
[**InlineResponse20056**](InlineResponse20056.md)
|
3001
|
+
|
3002
|
+
### Authorization
|
3003
|
+
|
3004
|
+
No authorization required
|
3005
|
+
|
3006
|
+
### HTTP request headers
|
3007
|
+
|
3008
|
+
- **Content-Type**: application/json
|
3009
|
+
- **Accept**: application/json
|
3010
|
+
|
3011
|
+
|
3012
|
+
|
3013
|
+
# **post_tags_list**
|
3014
|
+
> Array<InlineResponse20054> post_tags_list(body)
|
3015
|
+
|
3016
|
+
/tags/list
|
3017
|
+
|
3018
|
+
Return all of the user-defined tag information
|
3019
|
+
|
3020
|
+
### Example
|
3021
|
+
```ruby
|
3022
|
+
# load the gem
|
3023
|
+
require 'mailchimp_transactional'
|
3024
|
+
|
3025
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3026
|
+
|
3027
|
+
body = MailchimpTransactional::Body59.new # Body59 |
|
3028
|
+
|
3029
|
+
|
3030
|
+
begin
|
3031
|
+
#/tags/list
|
3032
|
+
result = api_instance.post_tags_list(body)
|
3033
|
+
p result
|
3034
|
+
rescue MailchimpTransactional::ApiError => e
|
3035
|
+
puts "Exception when calling TransactionalApi->post_tags_list: #{e}"
|
3036
|
+
end
|
3037
|
+
```
|
3038
|
+
|
3039
|
+
### Parameters
|
3040
|
+
|
3041
|
+
Name | Type | Description | Notes
|
3042
|
+
------------- | ------------- | ------------- | -------------
|
3043
|
+
**body** | [**Body59**](Body59.md)| |
|
3044
|
+
|
3045
|
+
### Return type
|
3046
|
+
|
3047
|
+
[**Array<InlineResponse20054>**](InlineResponse20054.md)
|
3048
|
+
|
3049
|
+
### Authorization
|
3050
|
+
|
3051
|
+
No authorization required
|
3052
|
+
|
3053
|
+
### HTTP request headers
|
3054
|
+
|
3055
|
+
- **Content-Type**: application/json
|
3056
|
+
- **Accept**: application/json
|
3057
|
+
|
3058
|
+
|
3059
|
+
|
3060
|
+
# **post_tags_time_series**
|
3061
|
+
> Array<InlineResponse20028> post_tags_time_series(body)
|
3062
|
+
|
3063
|
+
/tags/time-series
|
3064
|
+
|
3065
|
+
Return the recent history (hourly stats for the last 30 days) for a tag
|
3066
|
+
|
3067
|
+
### Example
|
3068
|
+
```ruby
|
3069
|
+
# load the gem
|
3070
|
+
require 'mailchimp_transactional'
|
3071
|
+
|
3072
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3073
|
+
|
3074
|
+
body = MailchimpTransactional::Body62.new # Body62 |
|
3075
|
+
|
3076
|
+
|
3077
|
+
begin
|
3078
|
+
#/tags/time-series
|
3079
|
+
result = api_instance.post_tags_time_series(body)
|
3080
|
+
p result
|
3081
|
+
rescue MailchimpTransactional::ApiError => e
|
3082
|
+
puts "Exception when calling TransactionalApi->post_tags_time_series: #{e}"
|
3083
|
+
end
|
3084
|
+
```
|
3085
|
+
|
3086
|
+
### Parameters
|
3087
|
+
|
3088
|
+
Name | Type | Description | Notes
|
3089
|
+
------------- | ------------- | ------------- | -------------
|
3090
|
+
**body** | [**Body62**](Body62.md)| |
|
3091
|
+
|
3092
|
+
### Return type
|
3093
|
+
|
3094
|
+
[**Array<InlineResponse20028>**](InlineResponse20028.md)
|
3095
|
+
|
3096
|
+
### Authorization
|
3097
|
+
|
3098
|
+
No authorization required
|
3099
|
+
|
3100
|
+
### HTTP request headers
|
3101
|
+
|
3102
|
+
- **Content-Type**: application/json
|
3103
|
+
- **Accept**: application/json
|
3104
|
+
|
3105
|
+
|
3106
|
+
|
3107
|
+
# **post_templates_add**
|
3108
|
+
> InlineResponse20057 post_templates_add(body)
|
3109
|
+
|
3110
|
+
/templates/add
|
3111
|
+
|
3112
|
+
Add a new template
|
3113
|
+
|
3114
|
+
### Example
|
3115
|
+
```ruby
|
3116
|
+
# load the gem
|
3117
|
+
require 'mailchimp_transactional'
|
3118
|
+
|
3119
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3120
|
+
|
3121
|
+
body = MailchimpTransactional::Body64.new # Body64 |
|
3122
|
+
|
3123
|
+
|
3124
|
+
begin
|
3125
|
+
#/templates/add
|
3126
|
+
result = api_instance.post_templates_add(body)
|
3127
|
+
p result
|
3128
|
+
rescue MailchimpTransactional::ApiError => e
|
3129
|
+
puts "Exception when calling TransactionalApi->post_templates_add: #{e}"
|
3130
|
+
end
|
3131
|
+
```
|
3132
|
+
|
3133
|
+
### Parameters
|
3134
|
+
|
3135
|
+
Name | Type | Description | Notes
|
3136
|
+
------------- | ------------- | ------------- | -------------
|
3137
|
+
**body** | [**Body64**](Body64.md)| |
|
3138
|
+
|
3139
|
+
### Return type
|
3140
|
+
|
3141
|
+
[**InlineResponse20057**](InlineResponse20057.md)
|
3142
|
+
|
3143
|
+
### Authorization
|
3144
|
+
|
3145
|
+
No authorization required
|
3146
|
+
|
3147
|
+
### HTTP request headers
|
3148
|
+
|
3149
|
+
- **Content-Type**: application/json
|
3150
|
+
- **Accept**: application/json
|
3151
|
+
|
3152
|
+
|
3153
|
+
|
3154
|
+
# **post_templates_delete**
|
3155
|
+
> InlineResponse20061 post_templates_delete(body)
|
3156
|
+
|
3157
|
+
/templates/delete
|
3158
|
+
|
3159
|
+
Delete a template
|
3160
|
+
|
3161
|
+
### Example
|
3162
|
+
```ruby
|
3163
|
+
# load the gem
|
3164
|
+
require 'mailchimp_transactional'
|
3165
|
+
|
3166
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3167
|
+
|
3168
|
+
body = MailchimpTransactional::Body68.new # Body68 |
|
3169
|
+
|
3170
|
+
|
3171
|
+
begin
|
3172
|
+
#/templates/delete
|
3173
|
+
result = api_instance.post_templates_delete(body)
|
3174
|
+
p result
|
3175
|
+
rescue MailchimpTransactional::ApiError => e
|
3176
|
+
puts "Exception when calling TransactionalApi->post_templates_delete: #{e}"
|
3177
|
+
end
|
3178
|
+
```
|
3179
|
+
|
3180
|
+
### Parameters
|
3181
|
+
|
3182
|
+
Name | Type | Description | Notes
|
3183
|
+
------------- | ------------- | ------------- | -------------
|
3184
|
+
**body** | [**Body68**](Body68.md)| |
|
3185
|
+
|
3186
|
+
### Return type
|
3187
|
+
|
3188
|
+
[**InlineResponse20061**](InlineResponse20061.md)
|
3189
|
+
|
3190
|
+
### Authorization
|
3191
|
+
|
3192
|
+
No authorization required
|
3193
|
+
|
3194
|
+
### HTTP request headers
|
3195
|
+
|
3196
|
+
- **Content-Type**: application/json
|
3197
|
+
- **Accept**: application/json
|
3198
|
+
|
3199
|
+
|
3200
|
+
|
3201
|
+
# **post_templates_info**
|
3202
|
+
> InlineResponse20058 post_templates_info(body)
|
3203
|
+
|
3204
|
+
/templates/info
|
3205
|
+
|
3206
|
+
Get the information for an existing template
|
3207
|
+
|
3208
|
+
### Example
|
3209
|
+
```ruby
|
3210
|
+
# load the gem
|
3211
|
+
require 'mailchimp_transactional'
|
3212
|
+
|
3213
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3214
|
+
|
3215
|
+
body = MailchimpTransactional::Body65.new # Body65 |
|
3216
|
+
|
3217
|
+
|
3218
|
+
begin
|
3219
|
+
#/templates/info
|
3220
|
+
result = api_instance.post_templates_info(body)
|
3221
|
+
p result
|
3222
|
+
rescue MailchimpTransactional::ApiError => e
|
3223
|
+
puts "Exception when calling TransactionalApi->post_templates_info: #{e}"
|
3224
|
+
end
|
3225
|
+
```
|
3226
|
+
|
3227
|
+
### Parameters
|
3228
|
+
|
3229
|
+
Name | Type | Description | Notes
|
3230
|
+
------------- | ------------- | ------------- | -------------
|
3231
|
+
**body** | [**Body65**](Body65.md)| |
|
3232
|
+
|
3233
|
+
### Return type
|
3234
|
+
|
3235
|
+
[**InlineResponse20058**](InlineResponse20058.md)
|
3236
|
+
|
3237
|
+
### Authorization
|
3238
|
+
|
3239
|
+
No authorization required
|
3240
|
+
|
3241
|
+
### HTTP request headers
|
3242
|
+
|
3243
|
+
- **Content-Type**: application/json
|
3244
|
+
- **Accept**: application/json
|
3245
|
+
|
3246
|
+
|
3247
|
+
|
3248
|
+
# **post_templates_list**
|
3249
|
+
> Array<InlineResponse20062> post_templates_list(body)
|
3250
|
+
|
3251
|
+
/templates/list
|
3252
|
+
|
3253
|
+
Return a list of all the templates available to this user
|
3254
|
+
|
3255
|
+
### Example
|
3256
|
+
```ruby
|
3257
|
+
# load the gem
|
3258
|
+
require 'mailchimp_transactional'
|
3259
|
+
|
3260
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3261
|
+
|
3262
|
+
body = MailchimpTransactional::Body69.new # Body69 |
|
3263
|
+
|
3264
|
+
|
3265
|
+
begin
|
3266
|
+
#/templates/list
|
3267
|
+
result = api_instance.post_templates_list(body)
|
3268
|
+
p result
|
3269
|
+
rescue MailchimpTransactional::ApiError => e
|
3270
|
+
puts "Exception when calling TransactionalApi->post_templates_list: #{e}"
|
3271
|
+
end
|
3272
|
+
```
|
3273
|
+
|
3274
|
+
### Parameters
|
3275
|
+
|
3276
|
+
Name | Type | Description | Notes
|
3277
|
+
------------- | ------------- | ------------- | -------------
|
3278
|
+
**body** | [**Body69**](Body69.md)| |
|
3279
|
+
|
3280
|
+
### Return type
|
3281
|
+
|
3282
|
+
[**Array<InlineResponse20062>**](InlineResponse20062.md)
|
3283
|
+
|
3284
|
+
### Authorization
|
3285
|
+
|
3286
|
+
No authorization required
|
3287
|
+
|
3288
|
+
### HTTP request headers
|
3289
|
+
|
3290
|
+
- **Content-Type**: application/json
|
3291
|
+
- **Accept**: application/json
|
3292
|
+
|
3293
|
+
|
3294
|
+
|
3295
|
+
# **post_templates_publish**
|
3296
|
+
> InlineResponse20060 post_templates_publish(body)
|
3297
|
+
|
3298
|
+
/templates/publish
|
3299
|
+
|
3300
|
+
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
|
3301
|
+
|
3302
|
+
### Example
|
3303
|
+
```ruby
|
3304
|
+
# load the gem
|
3305
|
+
require 'mailchimp_transactional'
|
3306
|
+
|
3307
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3308
|
+
|
3309
|
+
body = MailchimpTransactional::Body67.new # Body67 |
|
3310
|
+
|
3311
|
+
|
3312
|
+
begin
|
3313
|
+
#/templates/publish
|
3314
|
+
result = api_instance.post_templates_publish(body)
|
3315
|
+
p result
|
3316
|
+
rescue MailchimpTransactional::ApiError => e
|
3317
|
+
puts "Exception when calling TransactionalApi->post_templates_publish: #{e}"
|
3318
|
+
end
|
3319
|
+
```
|
3320
|
+
|
3321
|
+
### Parameters
|
3322
|
+
|
3323
|
+
Name | Type | Description | Notes
|
3324
|
+
------------- | ------------- | ------------- | -------------
|
3325
|
+
**body** | [**Body67**](Body67.md)| |
|
3326
|
+
|
3327
|
+
### Return type
|
3328
|
+
|
3329
|
+
[**InlineResponse20060**](InlineResponse20060.md)
|
3330
|
+
|
3331
|
+
### Authorization
|
3332
|
+
|
3333
|
+
No authorization required
|
3334
|
+
|
3335
|
+
### HTTP request headers
|
3336
|
+
|
3337
|
+
- **Content-Type**: application/json
|
3338
|
+
- **Accept**: application/json
|
3339
|
+
|
3340
|
+
|
3341
|
+
|
3342
|
+
# **post_templates_render**
|
3343
|
+
> InlineResponse20063 post_templates_render(body)
|
3344
|
+
|
3345
|
+
/templates/render
|
3346
|
+
|
3347
|
+
Inject content and optionally merge fields into a template, returning the HTML that results
|
3348
|
+
|
3349
|
+
### Example
|
3350
|
+
```ruby
|
3351
|
+
# load the gem
|
3352
|
+
require 'mailchimp_transactional'
|
3353
|
+
|
3354
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3355
|
+
|
3356
|
+
body = MailchimpTransactional::Body71.new # Body71 |
|
3357
|
+
|
3358
|
+
|
3359
|
+
begin
|
3360
|
+
#/templates/render
|
3361
|
+
result = api_instance.post_templates_render(body)
|
3362
|
+
p result
|
3363
|
+
rescue MailchimpTransactional::ApiError => e
|
3364
|
+
puts "Exception when calling TransactionalApi->post_templates_render: #{e}"
|
3365
|
+
end
|
3366
|
+
```
|
3367
|
+
|
3368
|
+
### Parameters
|
3369
|
+
|
3370
|
+
Name | Type | Description | Notes
|
3371
|
+
------------- | ------------- | ------------- | -------------
|
3372
|
+
**body** | [**Body71**](Body71.md)| |
|
3373
|
+
|
3374
|
+
### Return type
|
3375
|
+
|
3376
|
+
[**InlineResponse20063**](InlineResponse20063.md)
|
3377
|
+
|
3378
|
+
### Authorization
|
3379
|
+
|
3380
|
+
No authorization required
|
3381
|
+
|
3382
|
+
### HTTP request headers
|
3383
|
+
|
3384
|
+
- **Content-Type**: application/json
|
3385
|
+
- **Accept**: application/json
|
3386
|
+
|
3387
|
+
|
3388
|
+
|
3389
|
+
# **post_templates_time_series**
|
3390
|
+
> Array<InlineResponse20046> post_templates_time_series(body)
|
3391
|
+
|
3392
|
+
/templates/time-series
|
3393
|
+
|
3394
|
+
Return the recent history (hourly stats for the last 30 days) for a template
|
3395
|
+
|
3396
|
+
### Example
|
3397
|
+
```ruby
|
3398
|
+
# load the gem
|
3399
|
+
require 'mailchimp_transactional'
|
3400
|
+
|
3401
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3402
|
+
|
3403
|
+
body = MailchimpTransactional::Body70.new # Body70 |
|
3404
|
+
|
3405
|
+
|
3406
|
+
begin
|
3407
|
+
#/templates/time-series
|
3408
|
+
result = api_instance.post_templates_time_series(body)
|
3409
|
+
p result
|
3410
|
+
rescue MailchimpTransactional::ApiError => e
|
3411
|
+
puts "Exception when calling TransactionalApi->post_templates_time_series: #{e}"
|
3412
|
+
end
|
3413
|
+
```
|
3414
|
+
|
3415
|
+
### Parameters
|
3416
|
+
|
3417
|
+
Name | Type | Description | Notes
|
3418
|
+
------------- | ------------- | ------------- | -------------
|
3419
|
+
**body** | [**Body70**](Body70.md)| |
|
3420
|
+
|
3421
|
+
### Return type
|
3422
|
+
|
3423
|
+
[**Array<InlineResponse20046>**](InlineResponse20046.md)
|
3424
|
+
|
3425
|
+
### Authorization
|
3426
|
+
|
3427
|
+
No authorization required
|
3428
|
+
|
3429
|
+
### HTTP request headers
|
3430
|
+
|
3431
|
+
- **Content-Type**: application/json
|
3432
|
+
- **Accept**: application/json
|
3433
|
+
|
3434
|
+
|
3435
|
+
|
3436
|
+
# **post_templates_update**
|
3437
|
+
> InlineResponse20059 post_templates_update(body)
|
3438
|
+
|
3439
|
+
/templates/update
|
3440
|
+
|
3441
|
+
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
|
3442
|
+
|
3443
|
+
### Example
|
3444
|
+
```ruby
|
3445
|
+
# load the gem
|
3446
|
+
require 'mailchimp_transactional'
|
3447
|
+
|
3448
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3449
|
+
|
3450
|
+
body = MailchimpTransactional::Body66.new # Body66 |
|
3451
|
+
|
3452
|
+
|
3453
|
+
begin
|
3454
|
+
#/templates/update
|
3455
|
+
result = api_instance.post_templates_update(body)
|
3456
|
+
p result
|
3457
|
+
rescue MailchimpTransactional::ApiError => e
|
3458
|
+
puts "Exception when calling TransactionalApi->post_templates_update: #{e}"
|
3459
|
+
end
|
3460
|
+
```
|
3461
|
+
|
3462
|
+
### Parameters
|
3463
|
+
|
3464
|
+
Name | Type | Description | Notes
|
3465
|
+
------------- | ------------- | ------------- | -------------
|
3466
|
+
**body** | [**Body66**](Body66.md)| |
|
3467
|
+
|
3468
|
+
### Return type
|
3469
|
+
|
3470
|
+
[**InlineResponse20059**](InlineResponse20059.md)
|
3471
|
+
|
3472
|
+
### Authorization
|
3473
|
+
|
3474
|
+
No authorization required
|
3475
|
+
|
3476
|
+
### HTTP request headers
|
3477
|
+
|
3478
|
+
- **Content-Type**: application/json
|
3479
|
+
- **Accept**: application/json
|
3480
|
+
|
3481
|
+
|
3482
|
+
|
3483
|
+
# **post_urls_add_tracking_domain**
|
3484
|
+
> InlineResponse20068 post_urls_add_tracking_domain(body)
|
3485
|
+
|
3486
|
+
/urls/add-tracking-domain
|
3487
|
+
|
3488
|
+
Add a tracking domain to your account
|
3489
|
+
|
3490
|
+
### Example
|
3491
|
+
```ruby
|
3492
|
+
# load the gem
|
3493
|
+
require 'mailchimp_transactional'
|
3494
|
+
|
3495
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3496
|
+
|
3497
|
+
body = MailchimpTransactional::Body76.new # Body76 |
|
3498
|
+
|
3499
|
+
|
3500
|
+
begin
|
3501
|
+
#/urls/add-tracking-domain
|
3502
|
+
result = api_instance.post_urls_add_tracking_domain(body)
|
3503
|
+
p result
|
3504
|
+
rescue MailchimpTransactional::ApiError => e
|
3505
|
+
puts "Exception when calling TransactionalApi->post_urls_add_tracking_domain: #{e}"
|
3506
|
+
end
|
3507
|
+
```
|
3508
|
+
|
3509
|
+
### Parameters
|
3510
|
+
|
3511
|
+
Name | Type | Description | Notes
|
3512
|
+
------------- | ------------- | ------------- | -------------
|
3513
|
+
**body** | [**Body76**](Body76.md)| |
|
3514
|
+
|
3515
|
+
### Return type
|
3516
|
+
|
3517
|
+
[**InlineResponse20068**](InlineResponse20068.md)
|
3518
|
+
|
3519
|
+
### Authorization
|
3520
|
+
|
3521
|
+
No authorization required
|
3522
|
+
|
3523
|
+
### HTTP request headers
|
3524
|
+
|
3525
|
+
- **Content-Type**: application/json
|
3526
|
+
- **Accept**: application/json
|
3527
|
+
|
3528
|
+
|
3529
|
+
|
3530
|
+
# **post_urls_check_tracking_domain**
|
3531
|
+
> InlineResponse20068 post_urls_check_tracking_domain(body)
|
3532
|
+
|
3533
|
+
/urls/check-tracking-domain
|
3534
|
+
|
3535
|
+
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
|
3536
|
+
|
3537
|
+
### Example
|
3538
|
+
```ruby
|
3539
|
+
# load the gem
|
3540
|
+
require 'mailchimp_transactional'
|
3541
|
+
|
3542
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3543
|
+
|
3544
|
+
body = MailchimpTransactional::Body77.new # Body77 |
|
3545
|
+
|
3546
|
+
|
3547
|
+
begin
|
3548
|
+
#/urls/check-tracking-domain
|
3549
|
+
result = api_instance.post_urls_check_tracking_domain(body)
|
3550
|
+
p result
|
3551
|
+
rescue MailchimpTransactional::ApiError => e
|
3552
|
+
puts "Exception when calling TransactionalApi->post_urls_check_tracking_domain: #{e}"
|
3553
|
+
end
|
3554
|
+
```
|
3555
|
+
|
3556
|
+
### Parameters
|
3557
|
+
|
3558
|
+
Name | Type | Description | Notes
|
3559
|
+
------------- | ------------- | ------------- | -------------
|
3560
|
+
**body** | [**Body77**](Body77.md)| |
|
3561
|
+
|
3562
|
+
### Return type
|
3563
|
+
|
3564
|
+
[**InlineResponse20068**](InlineResponse20068.md)
|
3565
|
+
|
3566
|
+
### Authorization
|
3567
|
+
|
3568
|
+
No authorization required
|
3569
|
+
|
3570
|
+
### HTTP request headers
|
3571
|
+
|
3572
|
+
- **Content-Type**: application/json
|
3573
|
+
- **Accept**: application/json
|
3574
|
+
|
3575
|
+
|
3576
|
+
|
3577
|
+
# **post_urls_list**
|
3578
|
+
> Array<InlineResponse20064> post_urls_list(body)
|
3579
|
+
|
3580
|
+
/urls/list
|
3581
|
+
|
3582
|
+
Get the 100 most clicked URLs
|
3583
|
+
|
3584
|
+
### Example
|
3585
|
+
```ruby
|
3586
|
+
# load the gem
|
3587
|
+
require 'mailchimp_transactional'
|
3588
|
+
|
3589
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3590
|
+
|
3591
|
+
body = MailchimpTransactional::Body72.new # Body72 |
|
3592
|
+
|
3593
|
+
|
3594
|
+
begin
|
3595
|
+
#/urls/list
|
3596
|
+
result = api_instance.post_urls_list(body)
|
3597
|
+
p result
|
3598
|
+
rescue MailchimpTransactional::ApiError => e
|
3599
|
+
puts "Exception when calling TransactionalApi->post_urls_list: #{e}"
|
3600
|
+
end
|
3601
|
+
```
|
3602
|
+
|
3603
|
+
### Parameters
|
3604
|
+
|
3605
|
+
Name | Type | Description | Notes
|
3606
|
+
------------- | ------------- | ------------- | -------------
|
3607
|
+
**body** | [**Body72**](Body72.md)| |
|
3608
|
+
|
3609
|
+
### Return type
|
3610
|
+
|
3611
|
+
[**Array<InlineResponse20064>**](InlineResponse20064.md)
|
3612
|
+
|
3613
|
+
### Authorization
|
3614
|
+
|
3615
|
+
No authorization required
|
3616
|
+
|
3617
|
+
### HTTP request headers
|
3618
|
+
|
3619
|
+
- **Content-Type**: application/json
|
3620
|
+
- **Accept**: application/json
|
3621
|
+
|
3622
|
+
|
3623
|
+
|
3624
|
+
# **post_urls_search_deprecated**
|
3625
|
+
> Array<InlineResponse20065> post_urls_search_deprecated(body)
|
3626
|
+
|
3627
|
+
/urls/search (deprecated)
|
3628
|
+
|
3629
|
+
Return the 100 most clicked URLs that match the search query given
|
3630
|
+
|
3631
|
+
### Example
|
3632
|
+
```ruby
|
3633
|
+
# load the gem
|
3634
|
+
require 'mailchimp_transactional'
|
3635
|
+
|
3636
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3637
|
+
|
3638
|
+
body = MailchimpTransactional::Body73.new # Body73 |
|
3639
|
+
|
3640
|
+
|
3641
|
+
begin
|
3642
|
+
#/urls/search (deprecated)
|
3643
|
+
result = api_instance.post_urls_search_deprecated(body)
|
3644
|
+
p result
|
3645
|
+
rescue MailchimpTransactional::ApiError => e
|
3646
|
+
puts "Exception when calling TransactionalApi->post_urls_search_deprecated: #{e}"
|
3647
|
+
end
|
3648
|
+
```
|
3649
|
+
|
3650
|
+
### Parameters
|
3651
|
+
|
3652
|
+
Name | Type | Description | Notes
|
3653
|
+
------------- | ------------- | ------------- | -------------
|
3654
|
+
**body** | [**Body73**](Body73.md)| |
|
3655
|
+
|
3656
|
+
### Return type
|
3657
|
+
|
3658
|
+
[**Array<InlineResponse20065>**](InlineResponse20065.md)
|
3659
|
+
|
3660
|
+
### Authorization
|
3661
|
+
|
3662
|
+
No authorization required
|
3663
|
+
|
3664
|
+
### HTTP request headers
|
3665
|
+
|
3666
|
+
- **Content-Type**: application/json
|
3667
|
+
- **Accept**: application/json
|
3668
|
+
|
3669
|
+
|
3670
|
+
|
3671
|
+
# **post_urls_time_series**
|
3672
|
+
> Array<InlineResponse20066> post_urls_time_series(body)
|
3673
|
+
|
3674
|
+
/urls/time-series
|
3675
|
+
|
3676
|
+
Return the recent history (hourly stats for the last 30 days) for a url
|
3677
|
+
|
3678
|
+
### Example
|
3679
|
+
```ruby
|
3680
|
+
# load the gem
|
3681
|
+
require 'mailchimp_transactional'
|
3682
|
+
|
3683
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3684
|
+
|
3685
|
+
body = MailchimpTransactional::Body74.new # Body74 |
|
3686
|
+
|
3687
|
+
|
3688
|
+
begin
|
3689
|
+
#/urls/time-series
|
3690
|
+
result = api_instance.post_urls_time_series(body)
|
3691
|
+
p result
|
3692
|
+
rescue MailchimpTransactional::ApiError => e
|
3693
|
+
puts "Exception when calling TransactionalApi->post_urls_time_series: #{e}"
|
3694
|
+
end
|
3695
|
+
```
|
3696
|
+
|
3697
|
+
### Parameters
|
3698
|
+
|
3699
|
+
Name | Type | Description | Notes
|
3700
|
+
------------- | ------------- | ------------- | -------------
|
3701
|
+
**body** | [**Body74**](Body74.md)| |
|
3702
|
+
|
3703
|
+
### Return type
|
3704
|
+
|
3705
|
+
[**Array<InlineResponse20066>**](InlineResponse20066.md)
|
3706
|
+
|
3707
|
+
### Authorization
|
3708
|
+
|
3709
|
+
No authorization required
|
3710
|
+
|
3711
|
+
### HTTP request headers
|
3712
|
+
|
3713
|
+
- **Content-Type**: application/json
|
3714
|
+
- **Accept**: application/json
|
3715
|
+
|
3716
|
+
|
3717
|
+
|
3718
|
+
# **post_urls_tracking_domains**
|
3719
|
+
> Array<InlineResponse20067> post_urls_tracking_domains(body)
|
3720
|
+
|
3721
|
+
/urls/tracking-domains
|
3722
|
+
|
3723
|
+
Get the list of tracking domains set up for this account
|
3724
|
+
|
3725
|
+
### Example
|
3726
|
+
```ruby
|
3727
|
+
# load the gem
|
3728
|
+
require 'mailchimp_transactional'
|
3729
|
+
|
3730
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3731
|
+
|
3732
|
+
body = MailchimpTransactional::Body75.new # Body75 |
|
3733
|
+
|
3734
|
+
|
3735
|
+
begin
|
3736
|
+
#/urls/tracking-domains
|
3737
|
+
result = api_instance.post_urls_tracking_domains(body)
|
3738
|
+
p result
|
3739
|
+
rescue MailchimpTransactional::ApiError => e
|
3740
|
+
puts "Exception when calling TransactionalApi->post_urls_tracking_domains: #{e}"
|
3741
|
+
end
|
3742
|
+
```
|
3743
|
+
|
3744
|
+
### Parameters
|
3745
|
+
|
3746
|
+
Name | Type | Description | Notes
|
3747
|
+
------------- | ------------- | ------------- | -------------
|
3748
|
+
**body** | [**Body75**](Body75.md)| |
|
3749
|
+
|
3750
|
+
### Return type
|
3751
|
+
|
3752
|
+
[**Array<InlineResponse20067>**](InlineResponse20067.md)
|
3753
|
+
|
3754
|
+
### Authorization
|
3755
|
+
|
3756
|
+
No authorization required
|
3757
|
+
|
3758
|
+
### HTTP request headers
|
3759
|
+
|
3760
|
+
- **Content-Type**: application/json
|
3761
|
+
- **Accept**: application/json
|
3762
|
+
|
3763
|
+
|
3764
|
+
|
3765
|
+
# **post_users_info**
|
3766
|
+
> InlineResponse20069 post_users_info(body)
|
3767
|
+
|
3768
|
+
/users/info
|
3769
|
+
|
3770
|
+
Return the information about the API-connected user
|
3771
|
+
|
3772
|
+
### Example
|
3773
|
+
```ruby
|
3774
|
+
# load the gem
|
3775
|
+
require 'mailchimp_transactional'
|
3776
|
+
|
3777
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3778
|
+
|
3779
|
+
body = MailchimpTransactional::Body78.new # Body78 |
|
3780
|
+
|
3781
|
+
|
3782
|
+
begin
|
3783
|
+
#/users/info
|
3784
|
+
result = api_instance.post_users_info(body)
|
3785
|
+
p result
|
3786
|
+
rescue MailchimpTransactional::ApiError => e
|
3787
|
+
puts "Exception when calling TransactionalApi->post_users_info: #{e}"
|
3788
|
+
end
|
3789
|
+
```
|
3790
|
+
|
3791
|
+
### Parameters
|
3792
|
+
|
3793
|
+
Name | Type | Description | Notes
|
3794
|
+
------------- | ------------- | ------------- | -------------
|
3795
|
+
**body** | [**Body78**](Body78.md)| |
|
3796
|
+
|
3797
|
+
### Return type
|
3798
|
+
|
3799
|
+
[**InlineResponse20069**](InlineResponse20069.md)
|
3800
|
+
|
3801
|
+
### Authorization
|
3802
|
+
|
3803
|
+
No authorization required
|
3804
|
+
|
3805
|
+
### HTTP request headers
|
3806
|
+
|
3807
|
+
- **Content-Type**: application/json
|
3808
|
+
- **Accept**: application/json
|
3809
|
+
|
3810
|
+
|
3811
|
+
|
3812
|
+
# **post_users_ping**
|
3813
|
+
> String post_users_ping(body)
|
3814
|
+
|
3815
|
+
/users/ping
|
3816
|
+
|
3817
|
+
Validate an API key and respond to a ping
|
3818
|
+
|
3819
|
+
### Example
|
3820
|
+
```ruby
|
3821
|
+
# load the gem
|
3822
|
+
require 'mailchimp_transactional'
|
3823
|
+
|
3824
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3825
|
+
|
3826
|
+
body = MailchimpTransactional::Body79.new # Body79 |
|
3827
|
+
|
3828
|
+
|
3829
|
+
begin
|
3830
|
+
#/users/ping
|
3831
|
+
result = api_instance.post_users_ping(body)
|
3832
|
+
p result
|
3833
|
+
rescue MailchimpTransactional::ApiError => e
|
3834
|
+
puts "Exception when calling TransactionalApi->post_users_ping: #{e}"
|
3835
|
+
end
|
3836
|
+
```
|
3837
|
+
|
3838
|
+
### Parameters
|
3839
|
+
|
3840
|
+
Name | Type | Description | Notes
|
3841
|
+
------------- | ------------- | ------------- | -------------
|
3842
|
+
**body** | [**Body79**](Body79.md)| |
|
3843
|
+
|
3844
|
+
### Return type
|
3845
|
+
|
3846
|
+
**String**
|
3847
|
+
|
3848
|
+
### Authorization
|
3849
|
+
|
3850
|
+
No authorization required
|
3851
|
+
|
3852
|
+
### HTTP request headers
|
3853
|
+
|
3854
|
+
- **Content-Type**: application/json
|
3855
|
+
- **Accept**: application/json
|
3856
|
+
|
3857
|
+
|
3858
|
+
|
3859
|
+
# **post_users_ping2**
|
3860
|
+
> InlineResponse20070 post_users_ping2(body)
|
3861
|
+
|
3862
|
+
/users/ping2
|
3863
|
+
|
3864
|
+
Validate an API key and respond to a ping (anal JSON parser version)
|
3865
|
+
|
3866
|
+
### Example
|
3867
|
+
```ruby
|
3868
|
+
# load the gem
|
3869
|
+
require 'mailchimp_transactional'
|
3870
|
+
|
3871
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3872
|
+
|
3873
|
+
body = MailchimpTransactional::Body80.new # Body80 |
|
3874
|
+
|
3875
|
+
|
3876
|
+
begin
|
3877
|
+
#/users/ping2
|
3878
|
+
result = api_instance.post_users_ping2(body)
|
3879
|
+
p result
|
3880
|
+
rescue MailchimpTransactional::ApiError => e
|
3881
|
+
puts "Exception when calling TransactionalApi->post_users_ping2: #{e}"
|
3882
|
+
end
|
3883
|
+
```
|
3884
|
+
|
3885
|
+
### Parameters
|
3886
|
+
|
3887
|
+
Name | Type | Description | Notes
|
3888
|
+
------------- | ------------- | ------------- | -------------
|
3889
|
+
**body** | [**Body80**](Body80.md)| |
|
3890
|
+
|
3891
|
+
### Return type
|
3892
|
+
|
3893
|
+
[**InlineResponse20070**](InlineResponse20070.md)
|
3894
|
+
|
3895
|
+
### Authorization
|
3896
|
+
|
3897
|
+
No authorization required
|
3898
|
+
|
3899
|
+
### HTTP request headers
|
3900
|
+
|
3901
|
+
- **Content-Type**: application/json
|
3902
|
+
- **Accept**: application/json
|
3903
|
+
|
3904
|
+
|
3905
|
+
|
3906
|
+
# **post_users_senders**
|
3907
|
+
> Array<InlineResponse20040> post_users_senders(body)
|
3908
|
+
|
3909
|
+
/users/senders
|
3910
|
+
|
3911
|
+
Return the senders that have tried to use this account, both verified and unverified
|
3912
|
+
|
3913
|
+
### Example
|
3914
|
+
```ruby
|
3915
|
+
# load the gem
|
3916
|
+
require 'mailchimp_transactional'
|
3917
|
+
|
3918
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3919
|
+
|
3920
|
+
body = MailchimpTransactional::Body81.new # Body81 |
|
3921
|
+
|
3922
|
+
|
3923
|
+
begin
|
3924
|
+
#/users/senders
|
3925
|
+
result = api_instance.post_users_senders(body)
|
3926
|
+
p result
|
3927
|
+
rescue MailchimpTransactional::ApiError => e
|
3928
|
+
puts "Exception when calling TransactionalApi->post_users_senders: #{e}"
|
3929
|
+
end
|
3930
|
+
```
|
3931
|
+
|
3932
|
+
### Parameters
|
3933
|
+
|
3934
|
+
Name | Type | Description | Notes
|
3935
|
+
------------- | ------------- | ------------- | -------------
|
3936
|
+
**body** | [**Body81**](Body81.md)| |
|
3937
|
+
|
3938
|
+
### Return type
|
3939
|
+
|
3940
|
+
[**Array<InlineResponse20040>**](InlineResponse20040.md)
|
3941
|
+
|
3942
|
+
### Authorization
|
3943
|
+
|
3944
|
+
No authorization required
|
3945
|
+
|
3946
|
+
### HTTP request headers
|
3947
|
+
|
3948
|
+
- **Content-Type**: application/json
|
3949
|
+
- **Accept**: application/json
|
3950
|
+
|
3951
|
+
|
3952
|
+
|
3953
|
+
# **post_webhooks_add**
|
3954
|
+
> InlineResponse20072 post_webhooks_add(body)
|
3955
|
+
|
3956
|
+
/webhooks/add
|
3957
|
+
|
3958
|
+
Add a new webhook
|
3959
|
+
|
3960
|
+
### Example
|
3961
|
+
```ruby
|
3962
|
+
# load the gem
|
3963
|
+
require 'mailchimp_transactional'
|
3964
|
+
|
3965
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
3966
|
+
|
3967
|
+
body = MailchimpTransactional::Body83.new # Body83 |
|
3968
|
+
|
3969
|
+
|
3970
|
+
begin
|
3971
|
+
#/webhooks/add
|
3972
|
+
result = api_instance.post_webhooks_add(body)
|
3973
|
+
p result
|
3974
|
+
rescue MailchimpTransactional::ApiError => e
|
3975
|
+
puts "Exception when calling TransactionalApi->post_webhooks_add: #{e}"
|
3976
|
+
end
|
3977
|
+
```
|
3978
|
+
|
3979
|
+
### Parameters
|
3980
|
+
|
3981
|
+
Name | Type | Description | Notes
|
3982
|
+
------------- | ------------- | ------------- | -------------
|
3983
|
+
**body** | [**Body83**](Body83.md)| |
|
3984
|
+
|
3985
|
+
### Return type
|
3986
|
+
|
3987
|
+
[**InlineResponse20072**](InlineResponse20072.md)
|
3988
|
+
|
3989
|
+
### Authorization
|
3990
|
+
|
3991
|
+
No authorization required
|
3992
|
+
|
3993
|
+
### HTTP request headers
|
3994
|
+
|
3995
|
+
- **Content-Type**: application/json
|
3996
|
+
- **Accept**: application/json
|
3997
|
+
|
3998
|
+
|
3999
|
+
|
4000
|
+
# **post_webhooks_delete**
|
4001
|
+
> InlineResponse20075 post_webhooks_delete(body)
|
4002
|
+
|
4003
|
+
/webhooks/delete
|
4004
|
+
|
4005
|
+
Delete an existing webhook
|
4006
|
+
|
4007
|
+
### Example
|
4008
|
+
```ruby
|
4009
|
+
# load the gem
|
4010
|
+
require 'mailchimp_transactional'
|
4011
|
+
|
4012
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4013
|
+
|
4014
|
+
body = MailchimpTransactional::Body86.new # Body86 |
|
4015
|
+
|
4016
|
+
|
4017
|
+
begin
|
4018
|
+
#/webhooks/delete
|
4019
|
+
result = api_instance.post_webhooks_delete(body)
|
4020
|
+
p result
|
4021
|
+
rescue MailchimpTransactional::ApiError => e
|
4022
|
+
puts "Exception when calling TransactionalApi->post_webhooks_delete: #{e}"
|
4023
|
+
end
|
4024
|
+
```
|
4025
|
+
|
4026
|
+
### Parameters
|
4027
|
+
|
4028
|
+
Name | Type | Description | Notes
|
4029
|
+
------------- | ------------- | ------------- | -------------
|
4030
|
+
**body** | [**Body86**](Body86.md)| |
|
4031
|
+
|
4032
|
+
### Return type
|
4033
|
+
|
4034
|
+
[**InlineResponse20075**](InlineResponse20075.md)
|
4035
|
+
|
4036
|
+
### Authorization
|
4037
|
+
|
4038
|
+
No authorization required
|
4039
|
+
|
4040
|
+
### HTTP request headers
|
4041
|
+
|
4042
|
+
- **Content-Type**: application/json
|
4043
|
+
- **Accept**: application/json
|
4044
|
+
|
4045
|
+
|
4046
|
+
|
4047
|
+
# **post_webhooks_info**
|
4048
|
+
> InlineResponse20073 post_webhooks_info(body)
|
4049
|
+
|
4050
|
+
/webhooks/info
|
4051
|
+
|
4052
|
+
Given the ID of an existing webhook, return the data about it
|
4053
|
+
|
4054
|
+
### Example
|
4055
|
+
```ruby
|
4056
|
+
# load the gem
|
4057
|
+
require 'mailchimp_transactional'
|
4058
|
+
|
4059
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4060
|
+
|
4061
|
+
body = MailchimpTransactional::Body84.new # Body84 |
|
4062
|
+
|
4063
|
+
|
4064
|
+
begin
|
4065
|
+
#/webhooks/info
|
4066
|
+
result = api_instance.post_webhooks_info(body)
|
4067
|
+
p result
|
4068
|
+
rescue MailchimpTransactional::ApiError => e
|
4069
|
+
puts "Exception when calling TransactionalApi->post_webhooks_info: #{e}"
|
4070
|
+
end
|
4071
|
+
```
|
4072
|
+
|
4073
|
+
### Parameters
|
4074
|
+
|
4075
|
+
Name | Type | Description | Notes
|
4076
|
+
------------- | ------------- | ------------- | -------------
|
4077
|
+
**body** | [**Body84**](Body84.md)| |
|
4078
|
+
|
4079
|
+
### Return type
|
4080
|
+
|
4081
|
+
[**InlineResponse20073**](InlineResponse20073.md)
|
4082
|
+
|
4083
|
+
### Authorization
|
4084
|
+
|
4085
|
+
No authorization required
|
4086
|
+
|
4087
|
+
### HTTP request headers
|
4088
|
+
|
4089
|
+
- **Content-Type**: application/json
|
4090
|
+
- **Accept**: application/json
|
4091
|
+
|
4092
|
+
|
4093
|
+
|
4094
|
+
# **post_webhooks_list**
|
4095
|
+
> Array<InlineResponse20071> post_webhooks_list(body)
|
4096
|
+
|
4097
|
+
/webhooks/list
|
4098
|
+
|
4099
|
+
Get the list of all webhooks defined on the account
|
4100
|
+
|
4101
|
+
### Example
|
4102
|
+
```ruby
|
4103
|
+
# load the gem
|
4104
|
+
require 'mailchimp_transactional'
|
4105
|
+
|
4106
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4107
|
+
|
4108
|
+
body = MailchimpTransactional::Body82.new # Body82 |
|
4109
|
+
|
4110
|
+
|
4111
|
+
begin
|
4112
|
+
#/webhooks/list
|
4113
|
+
result = api_instance.post_webhooks_list(body)
|
4114
|
+
p result
|
4115
|
+
rescue MailchimpTransactional::ApiError => e
|
4116
|
+
puts "Exception when calling TransactionalApi->post_webhooks_list: #{e}"
|
4117
|
+
end
|
4118
|
+
```
|
4119
|
+
|
4120
|
+
### Parameters
|
4121
|
+
|
4122
|
+
Name | Type | Description | Notes
|
4123
|
+
------------- | ------------- | ------------- | -------------
|
4124
|
+
**body** | [**Body82**](Body82.md)| |
|
4125
|
+
|
4126
|
+
### Return type
|
4127
|
+
|
4128
|
+
[**Array<InlineResponse20071>**](InlineResponse20071.md)
|
4129
|
+
|
4130
|
+
### Authorization
|
4131
|
+
|
4132
|
+
No authorization required
|
4133
|
+
|
4134
|
+
### HTTP request headers
|
4135
|
+
|
4136
|
+
- **Content-Type**: application/json
|
4137
|
+
- **Accept**: application/json
|
4138
|
+
|
4139
|
+
|
4140
|
+
|
4141
|
+
# **post_webhooks_update**
|
4142
|
+
> InlineResponse20074 post_webhooks_update(body)
|
4143
|
+
|
4144
|
+
/webhooks/update
|
4145
|
+
|
4146
|
+
Update an existing webhook
|
4147
|
+
|
4148
|
+
### Example
|
4149
|
+
```ruby
|
4150
|
+
# load the gem
|
4151
|
+
require 'mailchimp_transactional'
|
4152
|
+
|
4153
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4154
|
+
|
4155
|
+
body = MailchimpTransactional::Body85.new # Body85 |
|
4156
|
+
|
4157
|
+
|
4158
|
+
begin
|
4159
|
+
#/webhooks/update
|
4160
|
+
result = api_instance.post_webhooks_update(body)
|
4161
|
+
p result
|
4162
|
+
rescue MailchimpTransactional::ApiError => e
|
4163
|
+
puts "Exception when calling TransactionalApi->post_webhooks_update: #{e}"
|
4164
|
+
end
|
4165
|
+
```
|
4166
|
+
|
4167
|
+
### Parameters
|
4168
|
+
|
4169
|
+
Name | Type | Description | Notes
|
4170
|
+
------------- | ------------- | ------------- | -------------
|
4171
|
+
**body** | [**Body85**](Body85.md)| |
|
4172
|
+
|
4173
|
+
### Return type
|
4174
|
+
|
4175
|
+
[**InlineResponse20074**](InlineResponse20074.md)
|
4176
|
+
|
4177
|
+
### Authorization
|
4178
|
+
|
4179
|
+
No authorization required
|
4180
|
+
|
4181
|
+
### HTTP request headers
|
4182
|
+
|
4183
|
+
- **Content-Type**: application/json
|
4184
|
+
- **Accept**: application/json
|
4185
|
+
|
4186
|
+
|
4187
|
+
|
4188
|
+
# **post_whitelists_add**
|
4189
|
+
> InlineResponse20076 post_whitelists_add(body)
|
4190
|
+
|
4191
|
+
/whitelists/add
|
4192
|
+
|
4193
|
+
Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
|
4194
|
+
|
4195
|
+
### Example
|
4196
|
+
```ruby
|
4197
|
+
# load the gem
|
4198
|
+
require 'mailchimp_transactional'
|
4199
|
+
|
4200
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4201
|
+
|
4202
|
+
body = MailchimpTransactional::Body87.new # Body87 |
|
4203
|
+
|
4204
|
+
|
4205
|
+
begin
|
4206
|
+
#/whitelists/add
|
4207
|
+
result = api_instance.post_whitelists_add(body)
|
4208
|
+
p result
|
4209
|
+
rescue MailchimpTransactional::ApiError => e
|
4210
|
+
puts "Exception when calling TransactionalApi->post_whitelists_add: #{e}"
|
4211
|
+
end
|
4212
|
+
```
|
4213
|
+
|
4214
|
+
### Parameters
|
4215
|
+
|
4216
|
+
Name | Type | Description | Notes
|
4217
|
+
------------- | ------------- | ------------- | -------------
|
4218
|
+
**body** | [**Body87**](Body87.md)| |
|
4219
|
+
|
4220
|
+
### Return type
|
4221
|
+
|
4222
|
+
[**InlineResponse20076**](InlineResponse20076.md)
|
4223
|
+
|
4224
|
+
### Authorization
|
4225
|
+
|
4226
|
+
No authorization required
|
4227
|
+
|
4228
|
+
### HTTP request headers
|
4229
|
+
|
4230
|
+
- **Content-Type**: application/json
|
4231
|
+
- **Accept**: application/json
|
4232
|
+
|
4233
|
+
|
4234
|
+
|
4235
|
+
# **post_whitelists_delete**
|
4236
|
+
> InlineResponse20078 post_whitelists_delete(body)
|
4237
|
+
|
4238
|
+
/whitelists/delete
|
4239
|
+
|
4240
|
+
Removes an email address from the whitelist.
|
4241
|
+
|
4242
|
+
### Example
|
4243
|
+
```ruby
|
4244
|
+
# load the gem
|
4245
|
+
require 'mailchimp_transactional'
|
4246
|
+
|
4247
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4248
|
+
|
4249
|
+
body = MailchimpTransactional::Body89.new # Body89 |
|
4250
|
+
|
4251
|
+
|
4252
|
+
begin
|
4253
|
+
#/whitelists/delete
|
4254
|
+
result = api_instance.post_whitelists_delete(body)
|
4255
|
+
p result
|
4256
|
+
rescue MailchimpTransactional::ApiError => e
|
4257
|
+
puts "Exception when calling TransactionalApi->post_whitelists_delete: #{e}"
|
4258
|
+
end
|
4259
|
+
```
|
4260
|
+
|
4261
|
+
### Parameters
|
4262
|
+
|
4263
|
+
Name | Type | Description | Notes
|
4264
|
+
------------- | ------------- | ------------- | -------------
|
4265
|
+
**body** | [**Body89**](Body89.md)| |
|
4266
|
+
|
4267
|
+
### Return type
|
4268
|
+
|
4269
|
+
[**InlineResponse20078**](InlineResponse20078.md)
|
4270
|
+
|
4271
|
+
### Authorization
|
4272
|
+
|
4273
|
+
No authorization required
|
4274
|
+
|
4275
|
+
### HTTP request headers
|
4276
|
+
|
4277
|
+
- **Content-Type**: application/json
|
4278
|
+
- **Accept**: application/json
|
4279
|
+
|
4280
|
+
|
4281
|
+
|
4282
|
+
# **post_whitelists_list**
|
4283
|
+
> Array<InlineResponse20077> post_whitelists_list(body)
|
4284
|
+
|
4285
|
+
/whitelists/list
|
4286
|
+
|
4287
|
+
Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.
|
4288
|
+
|
4289
|
+
### Example
|
4290
|
+
```ruby
|
4291
|
+
# load the gem
|
4292
|
+
require 'mailchimp_transactional'
|
4293
|
+
|
4294
|
+
api_instance = MailchimpTransactional::TransactionalApi.new
|
4295
|
+
|
4296
|
+
body = MailchimpTransactional::Body88.new # Body88 |
|
4297
|
+
|
4298
|
+
|
4299
|
+
begin
|
4300
|
+
#/whitelists/list
|
4301
|
+
result = api_instance.post_whitelists_list(body)
|
4302
|
+
p result
|
4303
|
+
rescue MailchimpTransactional::ApiError => e
|
4304
|
+
puts "Exception when calling TransactionalApi->post_whitelists_list: #{e}"
|
4305
|
+
end
|
4306
|
+
```
|
4307
|
+
|
4308
|
+
### Parameters
|
4309
|
+
|
4310
|
+
Name | Type | Description | Notes
|
4311
|
+
------------- | ------------- | ------------- | -------------
|
4312
|
+
**body** | [**Body88**](Body88.md)| |
|
4313
|
+
|
4314
|
+
### Return type
|
4315
|
+
|
4316
|
+
[**Array<InlineResponse20077>**](InlineResponse20077.md)
|
4317
|
+
|
4318
|
+
### Authorization
|
4319
|
+
|
4320
|
+
No authorization required
|
4321
|
+
|
4322
|
+
### HTTP request headers
|
4323
|
+
|
4324
|
+
- **Content-Type**: application/json
|
4325
|
+
- **Accept**: application/json
|
4326
|
+
|
4327
|
+
|
4328
|
+
|