constant_contact_client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (406) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +56 -0
  3. data/Gemfile +9 -0
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +29 -0
  6. data/README.md +201 -0
  7. data/Rakefile +10 -0
  8. data/constant_contact_client.gemspec +39 -0
  9. data/docs/AccountServicesApi.md +593 -0
  10. data/docs/BulkActivitiesApi.md +1035 -0
  11. data/docs/ContactListsApi.md +461 -0
  12. data/docs/ContactTagsApi.md +382 -0
  13. data/docs/ContactsApi.md +701 -0
  14. data/docs/ContactsCustomFieldsApi.md +375 -0
  15. data/docs/ContactsReportingApi.md +244 -0
  16. data/docs/EmailCampaignsABTestsApi.md +227 -0
  17. data/docs/EmailCampaignsApi.md +826 -0
  18. data/docs/EmailReportingApi.md +925 -0
  19. data/docs/EmailSchedulingApi.md +447 -0
  20. data/docs/LandingPagesReportingApi.md +481 -0
  21. data/docs/SegmentsApi.md +452 -0
  22. data/lib/constant_contact_client/api/account_services_api.rb +546 -0
  23. data/lib/constant_contact_client/api/bulk_activities_api.rb +983 -0
  24. data/lib/constant_contact_client/api/contact_lists_api.rb +449 -0
  25. data/lib/constant_contact_client/api/contact_tags_api.rb +356 -0
  26. data/lib/constant_contact_client/api/contacts_api.rb +676 -0
  27. data/lib/constant_contact_client/api/contacts_custom_fields_api.rb +356 -0
  28. data/lib/constant_contact_client/api/contacts_reporting_api.rb +255 -0
  29. data/lib/constant_contact_client/api/email_campaigns_ab_tests_api.rb +220 -0
  30. data/lib/constant_contact_client/api/email_campaigns_api.rb +766 -0
  31. data/lib/constant_contact_client/api/email_reporting_api.rb +812 -0
  32. data/lib/constant_contact_client/api/email_scheduling_api.rb +418 -0
  33. data/lib/constant_contact_client/api/landing_pages_reporting_api.rb +436 -0
  34. data/lib/constant_contact_client/api/segments_api.rb +425 -0
  35. data/lib/constant_contact_client/api_client.rb +394 -0
  36. data/lib/constant_contact_client/api_error.rb +58 -0
  37. data/lib/constant_contact_client/configuration.rb +305 -0
  38. data/lib/constant_contact_client/models/ab_test_data.rb +256 -0
  39. data/lib/constant_contact_client/models/access_token_response.rb +265 -0
  40. data/lib/constant_contact_client/models/account_cancellation.rb +226 -0
  41. data/lib/constant_contact_client/models/account_email_create_response.rb +273 -0
  42. data/lib/constant_contact_client/models/account_email_input.rb +234 -0
  43. data/lib/constant_contact_client/models/account_physical_address.rb +409 -0
  44. data/lib/constant_contact_client/models/account_suspension.rb +289 -0
  45. data/lib/constant_contact_client/models/activities.rb +226 -0
  46. data/lib/constant_contact_client/models/activity.rb +316 -0
  47. data/lib/constant_contact_client/models/activity_delete_custom_fields.rb +297 -0
  48. data/lib/constant_contact_client/models/activity_delete_list_response.rb +276 -0
  49. data/lib/constant_contact_client/models/activity_delete_lists_response.rb +305 -0
  50. data/lib/constant_contact_client/models/activity_delete_status.rb +306 -0
  51. data/lib/constant_contact_client/models/activity_errors.rb +215 -0
  52. data/lib/constant_contact_client/models/activity_export_status.rb +306 -0
  53. data/lib/constant_contact_client/models/activity_generic.rb +299 -0
  54. data/lib/constant_contact_client/models/activity_generic_status.rb +225 -0
  55. data/lib/constant_contact_client/models/activity_import.rb +316 -0
  56. data/lib/constant_contact_client/models/activity_links.rb +223 -0
  57. data/lib/constant_contact_client/models/activity_lists_membership.rb +305 -0
  58. data/lib/constant_contact_client/models/activity_reference.rb +225 -0
  59. data/lib/constant_contact_client/models/activity_status.rb +275 -0
  60. data/lib/constant_contact_client/models/activity_status_export_link.rb +223 -0
  61. data/lib/constant_contact_client/models/activity_status_link.rb +214 -0
  62. data/lib/constant_contact_client/models/activity_tagging.rb +319 -0
  63. data/lib/constant_contact_client/models/activity_tagging_status.rb +226 -0
  64. data/lib/constant_contact_client/models/add_account_email_address201_response.rb +273 -0
  65. data/lib/constant_contact_client/models/add_account_email_address_request.rb +234 -0
  66. data/lib/constant_contact_client/models/api_error_schema_inner.rb +225 -0
  67. data/lib/constant_contact_client/models/authorization_error_schema.rb +225 -0
  68. data/lib/constant_contact_client/models/bounces_tracking_activities_page.rb +240 -0
  69. data/lib/constant_contact_client/models/bounces_tracking_activity.rb +347 -0
  70. data/lib/constant_contact_client/models/bulk_email_campaign_summaries_page.rb +249 -0
  71. data/lib/constant_contact_client/models/bulk_email_campaign_summaries_percents.rb +255 -0
  72. data/lib/constant_contact_client/models/bulk_email_campaign_summary.rb +272 -0
  73. data/lib/constant_contact_client/models/campaign_activity_stats_query_result_email.rb +229 -0
  74. data/lib/constant_contact_client/models/campaign_activity_stats_result_generic_stats_email_activity.rb +244 -0
  75. data/lib/constant_contact_client/models/campaign_activity_summary.rb +341 -0
  76. data/lib/constant_contact_client/models/campaign_stats_query_result_email.rb +229 -0
  77. data/lib/constant_contact_client/models/campaign_stats_result_generic_stats_email_percents_email.rb +243 -0
  78. data/lib/constant_contact_client/models/clicks_tracking_activities_page.rb +233 -0
  79. data/lib/constant_contact_client/models/clicks_tracking_activity.rb +364 -0
  80. data/lib/constant_contact_client/models/company_logo.rb +235 -0
  81. data/lib/constant_contact_client/models/contact_campaign_activities_summary.rb +250 -0
  82. data/lib/constant_contact_client/models/contact_create_or_update_input.rb +503 -0
  83. data/lib/constant_contact_client/models/contact_create_or_update_response.rb +225 -0
  84. data/lib/constant_contact_client/models/contact_custom_field.rb +259 -0
  85. data/lib/constant_contact_client/models/contact_delete.rb +267 -0
  86. data/lib/constant_contact_client/models/contact_list.rb +301 -0
  87. data/lib/constant_contact_client/models/contact_list_array.rb +235 -0
  88. data/lib/constant_contact_client/models/contact_list_put_post.rb +291 -0
  89. data/lib/constant_contact_client/models/contact_open_and_click_rates.rb +274 -0
  90. data/lib/constant_contact_client/models/contact_post_request.rb +575 -0
  91. data/lib/constant_contact_client/models/contact_put_request.rb +582 -0
  92. data/lib/constant_contact_client/models/contact_resource.rb +635 -0
  93. data/lib/constant_contact_client/models/contact_tracking_activities_page.rb +227 -0
  94. data/lib/constant_contact_client/models/contact_tracking_activity.rb +270 -0
  95. data/lib/constant_contact_client/models/contact_xref.rb +226 -0
  96. data/lib/constant_contact_client/models/contact_xrefs.rb +236 -0
  97. data/lib/constant_contact_client/models/contacts.rb +246 -0
  98. data/lib/constant_contact_client/models/contacts_counts.rb +265 -0
  99. data/lib/constant_contact_client/models/contacts_export.rb +300 -0
  100. data/lib/constant_contact_client/models/contacts_json_import.rb +281 -0
  101. data/lib/constant_contact_client/models/create_contact_request.rb +575 -0
  102. data/lib/constant_contact_client/models/create_contact_request_email_address.rb +252 -0
  103. data/lib/constant_contact_client/models/create_csv_import_activity201_response.rb +316 -0
  104. data/lib/constant_contact_client/models/create_csv_import_activity201_response_links.rb +214 -0
  105. data/lib/constant_contact_client/models/create_csv_import_activity201_response_status.rb +255 -0
  106. data/lib/constant_contact_client/models/create_delete_activity201_response.rb +306 -0
  107. data/lib/constant_contact_client/models/create_delete_activity201_response_links.rb +214 -0
  108. data/lib/constant_contact_client/models/create_delete_activity201_response_links_self.rb +215 -0
  109. data/lib/constant_contact_client/models/create_delete_activity201_response_status.rb +235 -0
  110. data/lib/constant_contact_client/models/create_delete_activity_request.rb +267 -0
  111. data/lib/constant_contact_client/models/create_email_campaign200_response.rb +306 -0
  112. data/lib/constant_contact_client/models/create_email_campaign200_response_campaign_activities_inner.rb +225 -0
  113. data/lib/constant_contact_client/models/create_email_campaign_request.rb +260 -0
  114. data/lib/constant_contact_client/models/create_email_campaign_request_email_campaign_activities_inner.rb +402 -0
  115. data/lib/constant_contact_client/models/create_email_campaign_request_email_campaign_activities_inner_physical_address_in_footer.rb +347 -0
  116. data/lib/constant_contact_client/models/create_export_activity201_response.rb +306 -0
  117. data/lib/constant_contact_client/models/create_export_activity201_response_status.rb +225 -0
  118. data/lib/constant_contact_client/models/create_export_activity_request.rb +300 -0
  119. data/lib/constant_contact_client/models/create_import_json_activity_request.rb +281 -0
  120. data/lib/constant_contact_client/models/create_import_json_activity_request_import_data_inner.rb +1315 -0
  121. data/lib/constant_contact_client/models/create_list_add_activity_request.rb +268 -0
  122. data/lib/constant_contact_client/models/create_list_add_activity_request_exclude.rb +217 -0
  123. data/lib/constant_contact_client/models/create_list_add_activity_request_source.rb +331 -0
  124. data/lib/constant_contact_client/models/create_list_delete_activity201_response.rb +305 -0
  125. data/lib/constant_contact_client/models/create_list_delete_activity201_response_links.rb +214 -0
  126. data/lib/constant_contact_client/models/create_list_delete_activity201_response_links_self.rb +215 -0
  127. data/lib/constant_contact_client/models/create_list_delete_activity201_response_status.rb +215 -0
  128. data/lib/constant_contact_client/models/create_list_delete_activity_request.rb +243 -0
  129. data/lib/constant_contact_client/models/create_list_remove_activity201_response.rb +305 -0
  130. data/lib/constant_contact_client/models/create_list_remove_activity201_response_status.rb +235 -0
  131. data/lib/constant_contact_client/models/create_list_remove_activity_request.rb +268 -0
  132. data/lib/constant_contact_client/models/create_list_remove_activity_request_exclude.rb +217 -0
  133. data/lib/constant_contact_client/models/create_list_remove_activity_request_source.rb +321 -0
  134. data/lib/constant_contact_client/models/create_or_update_contact200_response.rb +225 -0
  135. data/lib/constant_contact_client/models/create_or_update_contact_custom_field.rb +244 -0
  136. data/lib/constant_contact_client/models/create_or_update_contact_request.rb +503 -0
  137. data/lib/constant_contact_client/models/create_or_update_contact_request_custom_fields_inner.rb +244 -0
  138. data/lib/constant_contact_client/models/create_or_update_contact_request_street_address.rb +367 -0
  139. data/lib/constant_contact_client/models/create_resend_email_campaign201_response.rb +255 -0
  140. data/lib/constant_contact_client/models/create_resend_email_campaign_request.rb +242 -0
  141. data/lib/constant_contact_client/models/create_segment201_response.rb +274 -0
  142. data/lib/constant_contact_client/models/create_segment_request.rb +258 -0
  143. data/lib/constant_contact_client/models/create_tag_delete_activity_request.rb +243 -0
  144. data/lib/constant_contact_client/models/create_tag_remove_activity201_response.rb +319 -0
  145. data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links.rb +223 -0
  146. data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links_results.rb +215 -0
  147. data/lib/constant_contact_client/models/create_tag_remove_activity201_response_links_self.rb +214 -0
  148. data/lib/constant_contact_client/models/create_tag_remove_activity201_response_status.rb +226 -0
  149. data/lib/constant_contact_client/models/create_tag_remove_activity_request.rb +268 -0
  150. data/lib/constant_contact_client/models/create_tag_remove_activity_request_exclude.rb +218 -0
  151. data/lib/constant_contact_client/models/create_tag_remove_activity_request_source.rb +319 -0
  152. data/lib/constant_contact_client/models/cross_reference.rb +235 -0
  153. data/lib/constant_contact_client/models/cross_reference_response.rb +217 -0
  154. data/lib/constant_contact_client/models/custom_field_id100.rb +243 -0
  155. data/lib/constant_contact_client/models/custom_field_input.rb +258 -0
  156. data/lib/constant_contact_client/models/custom_field_resource.rb +318 -0
  157. data/lib/constant_contact_client/models/custom_fields.rb +245 -0
  158. data/lib/constant_contact_client/models/customer.rb +352 -0
  159. data/lib/constant_contact_client/models/customer_put.rb +334 -0
  160. data/lib/constant_contact_client/models/delete_list202_response.rb +276 -0
  161. data/lib/constant_contact_client/models/delete_tag202_response.rb +299 -0
  162. data/lib/constant_contact_client/models/delete_tag202_response_activity_errors_inner.rb +215 -0
  163. data/lib/constant_contact_client/models/delete_tag202_response_links.rb +214 -0
  164. data/lib/constant_contact_client/models/delete_tag202_response_links_self.rb +215 -0
  165. data/lib/constant_contact_client/models/delete_tag202_response_status.rb +225 -0
  166. data/lib/constant_contact_client/models/device_flow_response.rb +265 -0
  167. data/lib/constant_contact_client/models/did_not_opens_tracking_activities_page.rb +233 -0
  168. data/lib/constant_contact_client/models/did_not_opens_tracking_activity.rb +320 -0
  169. data/lib/constant_contact_client/models/email_address.rb +351 -0
  170. data/lib/constant_contact_client/models/email_address_post.rb +252 -0
  171. data/lib/constant_contact_client/models/email_address_put.rb +341 -0
  172. data/lib/constant_contact_client/models/email_campaign.rb +306 -0
  173. data/lib/constant_contact_client/models/email_campaign_activity.rb +405 -0
  174. data/lib/constant_contact_client/models/email_campaign_activity_input.rb +402 -0
  175. data/lib/constant_contact_client/models/email_campaign_activity_preview.rb +285 -0
  176. data/lib/constant_contact_client/models/email_campaign_complete.rb +260 -0
  177. data/lib/constant_contact_client/models/email_campaign_name.rb +241 -0
  178. data/lib/constant_contact_client/models/email_campaigns.rb +294 -0
  179. data/lib/constant_contact_client/models/email_link_click_count.rb +265 -0
  180. data/lib/constant_contact_client/models/email_links.rb +227 -0
  181. data/lib/constant_contact_client/models/email_physical_address.rb +346 -0
  182. data/lib/constant_contact_client/models/email_schedule_input.rb +222 -0
  183. data/lib/constant_contact_client/models/email_test_send_input.rb +253 -0
  184. data/lib/constant_contact_client/models/emails_link.rb +214 -0
  185. data/lib/constant_contact_client/models/emails_paging_links.rb +214 -0
  186. data/lib/constant_contact_client/models/file_object.rb +384 -0
  187. data/lib/constant_contact_client/models/file_status_array_inner.rb +235 -0
  188. data/lib/constant_contact_client/models/forwards_tracking_activities_page.rb +233 -0
  189. data/lib/constant_contact_client/models/forwards_tracking_activity.rb +320 -0
  190. data/lib/constant_contact_client/models/get_ab_test_email_campaign200_response.rb +256 -0
  191. data/lib/constant_contact_client/models/get_account_details200_response.rb +352 -0
  192. data/lib/constant_contact_client/models/get_account_details200_response_company_logo.rb +236 -0
  193. data/lib/constant_contact_client/models/get_account_details200_response_physical_address.rb +409 -0
  194. data/lib/constant_contact_client/models/get_activity_by_id200_response.rb +316 -0
  195. data/lib/constant_contact_client/models/get_all_account_email_addresses200_response_inner.rb +317 -0
  196. data/lib/constant_contact_client/models/get_all_activities200_response.rb +226 -0
  197. data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner.rb +316 -0
  198. data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links.rb +223 -0
  199. data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links_results.rb +215 -0
  200. data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_links_self.rb +215 -0
  201. data/lib/constant_contact_client/models/get_all_activities200_response_activities_inner_status.rb +275 -0
  202. data/lib/constant_contact_client/models/get_all_activities200_response_links.rb +214 -0
  203. data/lib/constant_contact_client/models/get_all_activities200_response_links_next.rb +214 -0
  204. data/lib/constant_contact_client/models/get_all_contacts200_response.rb +246 -0
  205. data/lib/constant_contact_client/models/get_all_custom_fields200_response.rb +245 -0
  206. data/lib/constant_contact_client/models/get_all_email_campaigns200_response.rb +225 -0
  207. data/lib/constant_contact_client/models/get_all_email_campaigns200_response_campaigns_inner.rb +294 -0
  208. data/lib/constant_contact_client/models/get_all_email_campaigns200_response_links.rb +214 -0
  209. data/lib/constant_contact_client/models/get_all_lists200_response.rb +235 -0
  210. data/lib/constant_contact_client/models/get_all_segments200_response.rb +233 -0
  211. data/lib/constant_contact_client/models/get_all_segments200_response_links.rb +222 -0
  212. data/lib/constant_contact_client/models/get_all_segments200_response_links_next.rb +223 -0
  213. data/lib/constant_contact_client/models/get_all_segments200_response_segments_inner.rb +245 -0
  214. data/lib/constant_contact_client/models/get_all_tags200_response.rb +226 -0
  215. data/lib/constant_contact_client/models/get_all_tags200_response_links.rb +215 -0
  216. data/lib/constant_contact_client/models/get_all_tags200_response_links_next.rb +224 -0
  217. data/lib/constant_contact_client/models/get_all_tags200_response_links_next_next.rb +223 -0
  218. data/lib/constant_contact_client/models/get_bounces_report200_response.rb +240 -0
  219. data/lib/constant_contact_client/models/get_bounces_report200_response_links.rb +222 -0
  220. data/lib/constant_contact_client/models/get_bounces_report200_response_tracking_activities_inner.rb +347 -0
  221. data/lib/constant_contact_client/models/get_campaign_activity_link_report200_response.rb +227 -0
  222. data/lib/constant_contact_client/models/get_campaign_activity_link_report200_response_link_click_counts_inner.rb +265 -0
  223. data/lib/constant_contact_client/models/get_clicks_report200_response.rb +233 -0
  224. data/lib/constant_contact_client/models/get_clicks_report200_response_links.rb +222 -0
  225. data/lib/constant_contact_client/models/get_clicks_report200_response_tracking_activities_inner.rb +364 -0
  226. data/lib/constant_contact_client/models/get_contact_adds200_response.rb +240 -0
  227. data/lib/constant_contact_client/models/get_contact_adds200_response_tracking_activities_inner.rb +329 -0
  228. data/lib/constant_contact_client/models/get_contact_by_id200_response.rb +635 -0
  229. data/lib/constant_contact_client/models/get_contact_by_id200_response_custom_fields_inner.rb +259 -0
  230. data/lib/constant_contact_client/models/get_contact_by_id200_response_email_address.rb +351 -0
  231. data/lib/constant_contact_client/models/get_contact_by_id200_response_notes_inner.rb +255 -0
  232. data/lib/constant_contact_client/models/get_contact_by_id200_response_phone_numbers_inner.rb +294 -0
  233. data/lib/constant_contact_client/models/get_contact_by_id200_response_sms_channel.rb +278 -0
  234. data/lib/constant_contact_client/models/get_contact_by_id200_response_sms_channel_sms_channel_consents_inner.rb +285 -0
  235. data/lib/constant_contact_client/models/get_contact_by_id200_response_street_addresses_inner.rb +397 -0
  236. data/lib/constant_contact_client/models/get_contact_counts200_response.rb +265 -0
  237. data/lib/constant_contact_client/models/get_contact_id_xrefs200_response.rb +236 -0
  238. data/lib/constant_contact_client/models/get_contact_id_xrefs200_response_xrefs_inner.rb +226 -0
  239. data/lib/constant_contact_client/models/get_contact_open_click_rate_report200_response.rb +274 -0
  240. data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response.rb +250 -0
  241. data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response_campaign_activities_inner.rb +341 -0
  242. data/lib/constant_contact_client/models/get_contact_tracking_count_report200_response_links.rb +222 -0
  243. data/lib/constant_contact_client/models/get_contact_tracking_report200_response.rb +227 -0
  244. data/lib/constant_contact_client/models/get_contact_tracking_report200_response_links.rb +222 -0
  245. data/lib/constant_contact_client/models/get_contact_tracking_report200_response_links_next.rb +223 -0
  246. data/lib/constant_contact_client/models/get_contact_tracking_report200_response_tracking_activities_inner.rb +270 -0
  247. data/lib/constant_contact_client/models/get_custom_field200_response.rb +318 -0
  248. data/lib/constant_contact_client/models/get_did_not_opens_report200_response.rb +233 -0
  249. data/lib/constant_contact_client/models/get_did_not_opens_report200_response_tracking_activities_inner.rb +320 -0
  250. data/lib/constant_contact_client/models/get_email_campaign_activity200_response.rb +405 -0
  251. data/lib/constant_contact_client/models/get_email_campaign_activity200_response_document_properties.rb +520 -0
  252. data/lib/constant_contact_client/models/get_email_campaign_activity200_response_physical_address_in_footer.rb +347 -0
  253. data/lib/constant_contact_client/models/get_email_campaign_activity_preview200_response.rb +285 -0
  254. data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response.rb +229 -0
  255. data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response_results_inner.rb +244 -0
  256. data/lib/constant_contact_client/models/get_email_campaign_activity_report200_response_results_inner_stats.rb +476 -0
  257. data/lib/constant_contact_client/models/get_email_campaign_activity_schedule200_response_inner.rb +215 -0
  258. data/lib/constant_contact_client/models/get_email_campaign_activity_send_history200_response_inner.rb +298 -0
  259. data/lib/constant_contact_client/models/get_email_campaign_report200_response.rb +249 -0
  260. data/lib/constant_contact_client/models/get_email_campaign_report200_response_aggregate_percents.rb +256 -0
  261. data/lib/constant_contact_client/models/get_email_campaign_report200_response_bulk_email_campaign_summaries_inner.rb +272 -0
  262. data/lib/constant_contact_client/models/get_email_campaign_report200_response_bulk_email_campaign_summaries_inner_unique_counts.rb +342 -0
  263. data/lib/constant_contact_client/models/get_email_campaign_xrefs200_response.rb +217 -0
  264. data/lib/constant_contact_client/models/get_email_campaign_xrefs200_response_xrefs_inner.rb +235 -0
  265. data/lib/constant_contact_client/models/get_email_opens_report200_response.rb +233 -0
  266. data/lib/constant_contact_client/models/get_email_opens_report200_response_tracking_activities_inner.rb +330 -0
  267. data/lib/constant_contact_client/models/get_email_sends_report200_response.rb +233 -0
  268. data/lib/constant_contact_client/models/get_email_sends_report200_response_links.rb +222 -0
  269. data/lib/constant_contact_client/models/get_email_sends_report200_response_tracking_activities_inner.rb +320 -0
  270. data/lib/constant_contact_client/models/get_email_stats_report200_response.rb +229 -0
  271. data/lib/constant_contact_client/models/get_email_stats_report200_response_errors_inner.rb +225 -0
  272. data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner.rb +243 -0
  273. data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_percents.rb +296 -0
  274. data/lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb +396 -0
  275. data/lib/constant_contact_client/models/get_forwards_report200_response.rb +233 -0
  276. data/lib/constant_contact_client/models/get_forwards_report200_response_tracking_activities_inner.rb +320 -0
  277. data/lib/constant_contact_client/models/get_list200_response.rb +301 -0
  278. data/lib/constant_contact_client/models/get_list_id_xrefs200_response.rb +236 -0
  279. data/lib/constant_contact_client/models/get_list_id_xrefs200_response_xrefs_inner.rb +226 -0
  280. data/lib/constant_contact_client/models/get_optouts_report200_response.rb +240 -0
  281. data/lib/constant_contact_client/models/get_optouts_report200_response_tracking_activities_inner.rb +330 -0
  282. data/lib/constant_contact_client/models/get_resend_email_campaign200_response_inner.rb +265 -0
  283. data/lib/constant_contact_client/models/get_sms_engagement_history200_response_inner.rb +255 -0
  284. data/lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb +316 -0
  285. data/lib/constant_contact_client/models/get_tag200_response.rb +265 -0
  286. data/lib/constant_contact_client/models/get_unique_contact_clicks200_response.rb +240 -0
  287. data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_links.rb +222 -0
  288. data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_links_next.rb +223 -0
  289. data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_tracking_activities_inner.rb +366 -0
  290. data/lib/constant_contact_client/models/get_unique_contact_clicks200_response_tracking_activities_inner_sms_channel.rb +246 -0
  291. data/lib/constant_contact_client/models/get_unique_contact_opens200_response.rb +240 -0
  292. data/lib/constant_contact_client/models/get_unique_contact_opens200_response_tracking_activities_inner.rb +339 -0
  293. data/lib/constant_contact_client/models/get_unique_contact_sms_opt_ins200_response.rb +240 -0
  294. data/lib/constant_contact_client/models/get_unique_contact_sms_opt_ins200_response_tracking_activities_inner.rb +329 -0
  295. data/lib/constant_contact_client/models/get_unique_contact_updates200_response.rb +240 -0
  296. data/lib/constant_contact_client/models/get_unique_contact_updates200_response_tracking_activities_inner.rb +329 -0
  297. data/lib/constant_contact_client/models/get_user_privileges200_response_inner.rb +225 -0
  298. data/lib/constant_contact_client/models/headers_object.rb +225 -0
  299. data/lib/constant_contact_client/models/history_details.rb +316 -0
  300. data/lib/constant_contact_client/models/json_import_contact.rb +1315 -0
  301. data/lib/constant_contact_client/models/link.rb +214 -0
  302. data/lib/constant_contact_client/models/links.rb +221 -0
  303. data/lib/constant_contact_client/models/list_activity_add_contacts.rb +268 -0
  304. data/lib/constant_contact_client/models/list_activity_remove_contacts.rb +268 -0
  305. data/lib/constant_contact_client/models/list_id_list100.rb +243 -0
  306. data/lib/constant_contact_client/models/list_input.rb +263 -0
  307. data/lib/constant_contact_client/models/list_xref.rb +226 -0
  308. data/lib/constant_contact_client/models/list_xrefs.rb +236 -0
  309. data/lib/constant_contact_client/models/lpreporting_links.rb +221 -0
  310. data/lib/constant_contact_client/models/lpreporting_next.rb +222 -0
  311. data/lib/constant_contact_client/models/model_next.rb +222 -0
  312. data/lib/constant_contact_client/models/my_library_file_collection_inner.rb +384 -0
  313. data/lib/constant_contact_client/models/my_library_file_collection_inner_thumbnail.rb +235 -0
  314. data/lib/constant_contact_client/models/note.rb +255 -0
  315. data/lib/constant_contact_client/models/o_auth_error.rb +223 -0
  316. data/lib/constant_contact_client/models/opens_tracking_activities_page.rb +233 -0
  317. data/lib/constant_contact_client/models/opens_tracking_activity.rb +330 -0
  318. data/lib/constant_contact_client/models/optouts_tracking_activities_page.rb +240 -0
  319. data/lib/constant_contact_client/models/optouts_tracking_activity.rb +330 -0
  320. data/lib/constant_contact_client/models/p_contact_add_tracking_activities_page.rb +240 -0
  321. data/lib/constant_contact_client/models/p_contact_add_tracking_activity.rb +329 -0
  322. data/lib/constant_contact_client/models/p_contact_click_tracking_activities_page.rb +240 -0
  323. data/lib/constant_contact_client/models/p_contact_click_tracking_activity.rb +366 -0
  324. data/lib/constant_contact_client/models/p_contact_open_tracking_activity.rb +339 -0
  325. data/lib/constant_contact_client/models/p_contact_opens_tracking_activities_page.rb +240 -0
  326. data/lib/constant_contact_client/models/p_contact_sms_opt_in_tracking_activities_page.rb +240 -0
  327. data/lib/constant_contact_client/models/p_contact_sms_opt_in_tracking_activity.rb +329 -0
  328. data/lib/constant_contact_client/models/p_contact_update_tracking_activities_page.rb +240 -0
  329. data/lib/constant_contact_client/models/p_contact_update_tracking_activity.rb +329 -0
  330. data/lib/constant_contact_client/models/paged_email_campaign_response.rb +225 -0
  331. data/lib/constant_contact_client/models/pagination_links.rb +214 -0
  332. data/lib/constant_contact_client/models/pagination_links_next.rb +215 -0
  333. data/lib/constant_contact_client/models/paging_links.rb +214 -0
  334. data/lib/constant_contact_client/models/partner_account.rb +233 -0
  335. data/lib/constant_contact_client/models/partner_account_links.rb +215 -0
  336. data/lib/constant_contact_client/models/partner_account_operations_request.rb +286 -0
  337. data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_headers_inner.rb +225 -0
  338. data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_path_parameters_inner.rb +225 -0
  339. data/lib/constant_contact_client/models/partner_account_operations_request_account_operation_query_parameters_inner.rb +225 -0
  340. data/lib/constant_contact_client/models/partner_account_site_owner_list_inner.rb +265 -0
  341. data/lib/constant_contact_client/models/partners_link.rb +214 -0
  342. data/lib/constant_contact_client/models/patch_email_campaign_name_request.rb +241 -0
  343. data/lib/constant_contact_client/models/path_param_object.rb +225 -0
  344. data/lib/constant_contact_client/models/percents_email.rb +295 -0
  345. data/lib/constant_contact_client/models/phone_number.rb +294 -0
  346. data/lib/constant_contact_client/models/phone_number_put.rb +244 -0
  347. data/lib/constant_contact_client/models/plan_info.rb +236 -0
  348. data/lib/constant_contact_client/models/plan_tiers_object.rb +248 -0
  349. data/lib/constant_contact_client/models/plan_tiers_object_current_tiers_inner.rb +278 -0
  350. data/lib/constant_contact_client/models/post_custom_field_delete201_response.rb +297 -0
  351. data/lib/constant_contact_client/models/post_custom_field_delete_request.rb +243 -0
  352. data/lib/constant_contact_client/models/post_tag_request.rb +260 -0
  353. data/lib/constant_contact_client/models/provision.rb +723 -0
  354. data/lib/constant_contact_client/models/provision_response.rb +225 -0
  355. data/lib/constant_contact_client/models/put_tag_request.rb +250 -0
  356. data/lib/constant_contact_client/models/query_param_object.rb +225 -0
  357. data/lib/constant_contact_client/models/reporting_links.rb +221 -0
  358. data/lib/constant_contact_client/models/reporting_next.rb +222 -0
  359. data/lib/constant_contact_client/models/resend_to_non_openers_input.rb +242 -0
  360. data/lib/constant_contact_client/models/resend_to_non_openers_object.rb +255 -0
  361. data/lib/constant_contact_client/models/schedule_email_campaign_activity_request.rb +222 -0
  362. data/lib/constant_contact_client/models/segment_data.rb +258 -0
  363. data/lib/constant_contact_client/models/segment_detail.rb +274 -0
  364. data/lib/constant_contact_client/models/segment_master.rb +245 -0
  365. data/lib/constant_contact_client/models/segment_name.rb +222 -0
  366. data/lib/constant_contact_client/models/segments_dto.rb +233 -0
  367. data/lib/constant_contact_client/models/sends_tracking_activities_page.rb +233 -0
  368. data/lib/constant_contact_client/models/sends_tracking_activity.rb +320 -0
  369. data/lib/constant_contact_client/models/sms_channel_consent_details.rb +285 -0
  370. data/lib/constant_contact_client/models/sso_user.rb +439 -0
  371. data/lib/constant_contact_client/models/stats_email.rb +395 -0
  372. data/lib/constant_contact_client/models/stats_email_activity.rb +475 -0
  373. data/lib/constant_contact_client/models/stats_error.rb +225 -0
  374. data/lib/constant_contact_client/models/street_address.rb +397 -0
  375. data/lib/constant_contact_client/models/street_address_put.rb +367 -0
  376. data/lib/constant_contact_client/models/tag.rb +265 -0
  377. data/lib/constant_contact_client/models/tag_add_remove_contacts.rb +268 -0
  378. data/lib/constant_contact_client/models/tag_id_list500_limit.rb +243 -0
  379. data/lib/constant_contact_client/models/tag_post.rb +260 -0
  380. data/lib/constant_contact_client/models/tag_put.rb +250 -0
  381. data/lib/constant_contact_client/models/tags.rb +226 -0
  382. data/lib/constant_contact_client/models/tags_activity_links.rb +214 -0
  383. data/lib/constant_contact_client/models/tags_links.rb +223 -0
  384. data/lib/constant_contact_client/models/tags_paging_links.rb +214 -0
  385. data/lib/constant_contact_client/models/test_send_email_campaign_activity_request.rb +253 -0
  386. data/lib/constant_contact_client/models/tier_object.rb +278 -0
  387. data/lib/constant_contact_client/models/tracking_activity_sms_channel_dto.rb +245 -0
  388. data/lib/constant_contact_client/models/unique_email_counts.rb +341 -0
  389. data/lib/constant_contact_client/models/update_account_request.rb +334 -0
  390. data/lib/constant_contact_client/models/update_contact_request.rb +582 -0
  391. data/lib/constant_contact_client/models/update_contact_request_email_address.rb +341 -0
  392. data/lib/constant_contact_client/models/update_contact_request_phone_numbers_inner.rb +244 -0
  393. data/lib/constant_contact_client/models/update_contact_request_street_addresses_inner.rb +367 -0
  394. data/lib/constant_contact_client/models/update_custom_field_request.rb +258 -0
  395. data/lib/constant_contact_client/models/update_list200_response.rb +291 -0
  396. data/lib/constant_contact_client/models/update_list_request.rb +263 -0
  397. data/lib/constant_contact_client/models/update_segment_name_request.rb +222 -0
  398. data/lib/constant_contact_client/models/webhooks_subscription_body.rb +215 -0
  399. data/lib/constant_contact_client/models/webhooks_subscription_collection_inner.rb +245 -0
  400. data/lib/constant_contact_client/models/webhooks_subscription_put_resp.rb +225 -0
  401. data/lib/constant_contact_client/models/webhooks_subscription_response.rb +245 -0
  402. data/lib/constant_contact_client/models/webhooks_test_send.rb +245 -0
  403. data/lib/constant_contact_client/version.rb +15 -0
  404. data/lib/constant_contact_client.rb +417 -0
  405. data/spec/spec_helper.rb +111 -0
  406. metadata +488 -0
@@ -0,0 +1,983 @@
1
+ =begin
2
+ #Constant Contact API v3
3
+
4
+ #Swagger build version 3.0.2475
5
+
6
+ The version of the OpenAPI document: 1.0.101
7
+ Contact: webservices@constantcontact.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.2.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module ConstantContactClient
16
+ class BulkActivitiesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Import Contacts using a CSV File
23
+ # This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method. Importing a new contact automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB). Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
24
+ # @param file [File] The CSV file you are importing. The column headings that you can use in the file are: `first_name`, `last_name`, `email`, `phone`, `job_title`, `anniversary`, `birthday_day`, `birthday_month`, `company_name`, `street`, `street2`, `city`, `state`, `zip`, and `country`. The only required column heading is `email`. You can also use custom fields as column headings. Enter the custom field name prefixed with `cf:` as the column heading. For example, use `cf:first_name` as the header name if you have a custom field named \\\"first_name\\\". The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
25
+ # @param list_ids [Array<String>] Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact &#x60;list_id&#x60; values.
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [CreateCSVImportActivity201Response]
28
+ def create_csv_import_activity(file, list_ids, opts = {})
29
+ data, _status_code, _headers = create_csv_import_activity_with_http_info(file, list_ids, opts)
30
+ data
31
+ end
32
+
33
+ # Import Contacts using a CSV File
34
+ # This multipart method creates an asynchronous background job that adds or updates contacts by importing a CSV file containing contact information. Do not use a Content-Type header value with this method. Importing a new contact automatically sets the contact&#39;s &#x60;permission_to_send&#x60; property as &#x60;implicit&#x60; and the &#x60;opt_in_source&#x60; property as &#x60;Account&#x60;. Importing an existing contact only updates the contact properties you include in the request. The CSV file has a maximum of 40,000 lines including the header row (39,999 contacts) and a maximum file size of 4 megabytes (MB). Lines above the 40,000 line maximum are not processed. If the request body exceeds 4 MB, only the contacts contained in the first 4 MB are imported and the remaining data is dropped.
35
+ # @param file [File] The CSV file you are importing. The column headings that you can use in the file are: &#x60;first_name&#x60;, &#x60;last_name&#x60;, &#x60;email&#x60;, &#x60;phone&#x60;, &#x60;job_title&#x60;, &#x60;anniversary&#x60;, &#x60;birthday_day&#x60;, &#x60;birthday_month&#x60;, &#x60;company_name&#x60;, &#x60;street&#x60;, &#x60;street2&#x60;, &#x60;city&#x60;, &#x60;state&#x60;, &#x60;zip&#x60;, and &#x60;country&#x60;. The only required column heading is &#x60;email&#x60;. You can also use custom fields as column headings. Enter the custom field name prefixed with &#x60;cf:&#x60; as the column heading. For example, use &#x60;cf:first_name&#x60; as the header name if you have a custom field named \\\&quot;first_name\\\&quot;. The custom field must already exist in the Constant Contact account you are using. Depending on the custom field data type, you can enter dates or strings as the value of the custom field. Each contact can contain up to 25 different custom fields.
36
+ # @param list_ids [Array<String>] Specify which contact lists you are adding all imported contacts to as an array of up to 50 contact &#x60;list_id&#x60; values.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(CreateCSVImportActivity201Response, Integer, Hash)>] CreateCSVImportActivity201Response data, response status code and response headers
39
+ def create_csv_import_activity_with_http_info(file, list_ids, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_csv_import_activity ...'
42
+ end
43
+ # verify the required parameter 'file' is set
44
+ if @api_client.config.client_side_validation && file.nil?
45
+ fail ArgumentError, "Missing the required parameter 'file' when calling BulkActivitiesApi.create_csv_import_activity"
46
+ end
47
+ # verify the required parameter 'list_ids' is set
48
+ if @api_client.config.client_side_validation && list_ids.nil?
49
+ fail ArgumentError, "Missing the required parameter 'list_ids' when calling BulkActivitiesApi.create_csv_import_activity"
50
+ end
51
+ if @api_client.config.client_side_validation && list_ids.length > 50
52
+ fail ArgumentError, 'invalid value for "list_ids" when calling BulkActivitiesApi.create_csv_import_activity, number of items must be less than or equal to 50.'
53
+ end
54
+
55
+ # resource path
56
+ local_var_path = '/activities/contacts_file_import'
57
+
58
+ # query parameters
59
+ query_params = opts[:query_params] || {}
60
+
61
+ # header parameters
62
+ header_params = opts[:header_params] || {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+ # HTTP header 'Content-Type'
66
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
67
+ if !content_type.nil?
68
+ header_params['Content-Type'] = content_type
69
+ end
70
+
71
+ # form parameters
72
+ form_params = opts[:form_params] || {}
73
+ form_params['file'] = file
74
+ form_params['list_ids'] = @api_client.build_collection_param(list_ids, :csv)
75
+
76
+ # http body (model)
77
+ post_body = opts[:debug_body]
78
+
79
+ # return_type
80
+ return_type = opts[:debug_return_type] || 'CreateCSVImportActivity201Response'
81
+
82
+ # auth_names
83
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
84
+
85
+ new_options = opts.merge(
86
+ :operation => :"BulkActivitiesApi.create_csv_import_activity",
87
+ :header_params => header_params,
88
+ :query_params => query_params,
89
+ :form_params => form_params,
90
+ :body => post_body,
91
+ :auth_names => auth_names,
92
+ :return_type => return_type
93
+ )
94
+
95
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
96
+ if @api_client.config.debugging
97
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_csv_import_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
98
+ end
99
+ return data, status_code, headers
100
+ end
101
+
102
+ # Delete Contacts in Bulk
103
+ # Use this endpoint to bulk delete contacts in an account. Contacts to delete are specified by contact_id (up to 500), or by list_id (up to 50 lists); all contacts that are members of the list_ids are deleted. Deleted contacts won’t receive email from you, and they don’t count as active contacts. Unlike unsubscribed contacts, deleted contacts can be added back to an account. [Learn how to revive deleted contacts](/api_guide/contacts_delete.html#revive).
104
+ # @param create_delete_activity_request [CreateDeleteActivityRequest] The request body contains an array of contact_ids &lt;em&gt;or&lt;/em&gt; list_ids. All contact_ids provided are deleted, or all members of each specified list_id are deleted.
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [CreateDeleteActivity201Response]
107
+ def create_delete_activity(create_delete_activity_request, opts = {})
108
+ data, _status_code, _headers = create_delete_activity_with_http_info(create_delete_activity_request, opts)
109
+ data
110
+ end
111
+
112
+ # Delete Contacts in Bulk
113
+ # Use this endpoint to bulk delete contacts in an account. Contacts to delete are specified by contact_id (up to 500), or by list_id (up to 50 lists); all contacts that are members of the list_ids are deleted. Deleted contacts won’t receive email from you, and they don’t count as active contacts. Unlike unsubscribed contacts, deleted contacts can be added back to an account. [Learn how to revive deleted contacts](/api_guide/contacts_delete.html#revive).
114
+ # @param create_delete_activity_request [CreateDeleteActivityRequest] The request body contains an array of contact_ids &lt;em&gt;or&lt;/em&gt; list_ids. All contact_ids provided are deleted, or all members of each specified list_id are deleted.
115
+ # @param [Hash] opts the optional parameters
116
+ # @return [Array<(CreateDeleteActivity201Response, Integer, Hash)>] CreateDeleteActivity201Response data, response status code and response headers
117
+ def create_delete_activity_with_http_info(create_delete_activity_request, opts = {})
118
+ if @api_client.config.debugging
119
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_delete_activity ...'
120
+ end
121
+ # verify the required parameter 'create_delete_activity_request' is set
122
+ if @api_client.config.client_side_validation && create_delete_activity_request.nil?
123
+ fail ArgumentError, "Missing the required parameter 'create_delete_activity_request' when calling BulkActivitiesApi.create_delete_activity"
124
+ end
125
+ # resource path
126
+ local_var_path = '/activities/contact_delete'
127
+
128
+ # query parameters
129
+ query_params = opts[:query_params] || {}
130
+
131
+ # header parameters
132
+ header_params = opts[:header_params] || {}
133
+ # HTTP header 'Accept' (if needed)
134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
135
+ # HTTP header 'Content-Type'
136
+ content_type = @api_client.select_header_content_type(['application/json'])
137
+ if !content_type.nil?
138
+ header_params['Content-Type'] = content_type
139
+ end
140
+
141
+ # form parameters
142
+ form_params = opts[:form_params] || {}
143
+
144
+ # http body (model)
145
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_delete_activity_request)
146
+
147
+ # return_type
148
+ return_type = opts[:debug_return_type] || 'CreateDeleteActivity201Response'
149
+
150
+ # auth_names
151
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
152
+
153
+ new_options = opts.merge(
154
+ :operation => :"BulkActivitiesApi.create_delete_activity",
155
+ :header_params => header_params,
156
+ :query_params => query_params,
157
+ :form_params => form_params,
158
+ :body => post_body,
159
+ :auth_names => auth_names,
160
+ :return_type => return_type
161
+ )
162
+
163
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
164
+ if @api_client.config.debugging
165
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_delete_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
166
+ end
167
+ return data, status_code, headers
168
+ end
169
+
170
+ # Export Contacts to a File
171
+ # Use this method to create an activity that exports contacts and contact details to a CSV file. By default, all contacts are exported. To filter contacts to export, specify the source to use, `contact_id`, `list_id`, or `segment_id` (all mutually exclusive). By default, all contact related fields are exported. Use the fields array to only export specific contact fields. You must export `email_address` to successfully export `email_optin_source`, `email_optin_date`, `email_optout_source`, `email_optout_date`, or `email_optout_reason`. After Constant Contact finishes processing the activity, use the `results` link in the response body to retrieve the CSV file.
172
+ # @param create_export_activity_request [CreateExportActivityRequest] A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
173
+ # @param [Hash] opts the optional parameters
174
+ # @return [CreateExportActivity201Response]
175
+ def create_export_activity(create_export_activity_request, opts = {})
176
+ data, _status_code, _headers = create_export_activity_with_http_info(create_export_activity_request, opts)
177
+ data
178
+ end
179
+
180
+ # Export Contacts to a File
181
+ # Use this method to create an activity that exports contacts and contact details to a CSV file. By default, all contacts are exported. To filter contacts to export, specify the source to use, &#x60;contact_id&#x60;, &#x60;list_id&#x60;, or &#x60;segment_id&#x60; (all mutually exclusive). By default, all contact related fields are exported. Use the fields array to only export specific contact fields. You must export &#x60;email_address&#x60; to successfully export &#x60;email_optin_source&#x60;, &#x60;email_optin_date&#x60;, &#x60;email_optout_source&#x60;, &#x60;email_optout_date&#x60;, or &#x60;email_optout_reason&#x60;. After Constant Contact finishes processing the activity, use the &#x60;results&#x60; link in the response body to retrieve the CSV file.
182
+ # @param create_export_activity_request [CreateExportActivityRequest] A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
183
+ # @param [Hash] opts the optional parameters
184
+ # @return [Array<(CreateExportActivity201Response, Integer, Hash)>] CreateExportActivity201Response data, response status code and response headers
185
+ def create_export_activity_with_http_info(create_export_activity_request, opts = {})
186
+ if @api_client.config.debugging
187
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_export_activity ...'
188
+ end
189
+ # verify the required parameter 'create_export_activity_request' is set
190
+ if @api_client.config.client_side_validation && create_export_activity_request.nil?
191
+ fail ArgumentError, "Missing the required parameter 'create_export_activity_request' when calling BulkActivitiesApi.create_export_activity"
192
+ end
193
+ # resource path
194
+ local_var_path = '/activities/contact_exports'
195
+
196
+ # query parameters
197
+ query_params = opts[:query_params] || {}
198
+
199
+ # header parameters
200
+ header_params = opts[:header_params] || {}
201
+ # HTTP header 'Accept' (if needed)
202
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
203
+ # HTTP header 'Content-Type'
204
+ content_type = @api_client.select_header_content_type(['application/json'])
205
+ if !content_type.nil?
206
+ header_params['Content-Type'] = content_type
207
+ end
208
+
209
+ # form parameters
210
+ form_params = opts[:form_params] || {}
211
+
212
+ # http body (model)
213
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_export_activity_request)
214
+
215
+ # return_type
216
+ return_type = opts[:debug_return_type] || 'CreateExportActivity201Response'
217
+
218
+ # auth_names
219
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
220
+
221
+ new_options = opts.merge(
222
+ :operation => :"BulkActivitiesApi.create_export_activity",
223
+ :header_params => header_params,
224
+ :query_params => query_params,
225
+ :form_params => form_params,
226
+ :body => post_body,
227
+ :auth_names => auth_names,
228
+ :return_type => return_type
229
+ )
230
+
231
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
232
+ if @api_client.config.debugging
233
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_export_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
234
+ end
235
+ return data, status_code, headers
236
+ end
237
+
238
+ # Import Contacts using a JSON Payload
239
+ # Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. Importing a new contact automatically sets the contact's `permission_to_send` property as `implicit` and the `opt_in_source` property as `Account`. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported. To import custom fields, prefix the custom field name with `cf:` and add it as a contact property. For example, use the property name `cf:first_name` if you have a custom field named first_name. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields. The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
240
+ # @param create_import_json_activity_request [CreateImportJSONActivityRequest] The JSON request payload that contains the contact data and contact lists for the import.
241
+ # @param [Hash] opts the optional parameters
242
+ # @return [CreateCSVImportActivity201Response]
243
+ def create_import_json_activity(create_import_json_activity_request, opts = {})
244
+ data, _status_code, _headers = create_import_json_activity_with_http_info(create_import_json_activity_request, opts)
245
+ data
246
+ end
247
+
248
+ # Import Contacts using a JSON Payload
249
+ # Use this method to create an asynchronous background job that adds new contacts or updates existing contacts by importing a JSON payload. This method requires a request body that contains the contact data you are importing and the contact lists to which you want to add the imported contacts. Importing a new contact automatically sets the contact&#39;s &#x60;permission_to_send&#x60; property as &#x60;implicit&#x60; and the &#x60;opt_in_source&#x60; property as &#x60;Account&#x60;. Importing an existing contact only updates the contact properties you include in the request. For each contact, you can import up to three addresses and three phone numbers. International phone numbers are currently not supported. To import custom fields, prefix the custom field name with &#x60;cf:&#x60; and add it as a contact property. For example, use the property name &#x60;cf:first_name&#x60; if you have a custom field named first_name. The custom field must already exist in the Constant Contact account you are using. Each contact can contain up to 25 custom fields. The request body payload has a maximum size of 4 megabytes (MB). If the request body exceeds 4 MB, this method only imports the first 4 MB and drops the remaining data. Use the activity URL to check the status of the import activity request.
250
+ # @param create_import_json_activity_request [CreateImportJSONActivityRequest] The JSON request payload that contains the contact data and contact lists for the import.
251
+ # @param [Hash] opts the optional parameters
252
+ # @return [Array<(CreateCSVImportActivity201Response, Integer, Hash)>] CreateCSVImportActivity201Response data, response status code and response headers
253
+ def create_import_json_activity_with_http_info(create_import_json_activity_request, opts = {})
254
+ if @api_client.config.debugging
255
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_import_json_activity ...'
256
+ end
257
+ # verify the required parameter 'create_import_json_activity_request' is set
258
+ if @api_client.config.client_side_validation && create_import_json_activity_request.nil?
259
+ fail ArgumentError, "Missing the required parameter 'create_import_json_activity_request' when calling BulkActivitiesApi.create_import_json_activity"
260
+ end
261
+ # resource path
262
+ local_var_path = '/activities/contacts_json_import'
263
+
264
+ # query parameters
265
+ query_params = opts[:query_params] || {}
266
+
267
+ # header parameters
268
+ header_params = opts[:header_params] || {}
269
+ # HTTP header 'Accept' (if needed)
270
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
271
+ # HTTP header 'Content-Type'
272
+ content_type = @api_client.select_header_content_type(['application/json'])
273
+ if !content_type.nil?
274
+ header_params['Content-Type'] = content_type
275
+ end
276
+
277
+ # form parameters
278
+ form_params = opts[:form_params] || {}
279
+
280
+ # http body (model)
281
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_import_json_activity_request)
282
+
283
+ # return_type
284
+ return_type = opts[:debug_return_type] || 'CreateCSVImportActivity201Response'
285
+
286
+ # auth_names
287
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
288
+
289
+ new_options = opts.merge(
290
+ :operation => :"BulkActivitiesApi.create_import_json_activity",
291
+ :header_params => header_params,
292
+ :query_params => query_params,
293
+ :form_params => form_params,
294
+ :body => post_body,
295
+ :auth_names => auth_names,
296
+ :return_type => return_type
297
+ )
298
+
299
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
300
+ if @api_client.config.debugging
301
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_import_json_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
302
+ end
303
+ return data, status_code, headers
304
+ end
305
+
306
+ # Add Contacts to Lists
307
+ # Use this method to create an activity that adds contacts to one or more lists. Each contact can be a member of up to 50 lists. Use the properties in the `source` object to specify the contacts you want to add to lists. Use the `list_ids` array to specify which lists you want to add your source contacts to.
308
+ # @param create_list_add_activity_request [CreateListAddActivityRequest] The JSON payload used to create the &#39;add contacts to lists&#39; activity
309
+ # @param [Hash] opts the optional parameters
310
+ # @return [CreateListRemoveActivity201Response]
311
+ def create_list_add_activity(create_list_add_activity_request, opts = {})
312
+ data, _status_code, _headers = create_list_add_activity_with_http_info(create_list_add_activity_request, opts)
313
+ data
314
+ end
315
+
316
+ # Add Contacts to Lists
317
+ # Use this method to create an activity that adds contacts to one or more lists. Each contact can be a member of up to 50 lists. Use the properties in the &#x60;source&#x60; object to specify the contacts you want to add to lists. Use the &#x60;list_ids&#x60; array to specify which lists you want to add your source contacts to.
318
+ # @param create_list_add_activity_request [CreateListAddActivityRequest] The JSON payload used to create the &#39;add contacts to lists&#39; activity
319
+ # @param [Hash] opts the optional parameters
320
+ # @return [Array<(CreateListRemoveActivity201Response, Integer, Hash)>] CreateListRemoveActivity201Response data, response status code and response headers
321
+ def create_list_add_activity_with_http_info(create_list_add_activity_request, opts = {})
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_list_add_activity ...'
324
+ end
325
+ # verify the required parameter 'create_list_add_activity_request' is set
326
+ if @api_client.config.client_side_validation && create_list_add_activity_request.nil?
327
+ fail ArgumentError, "Missing the required parameter 'create_list_add_activity_request' when calling BulkActivitiesApi.create_list_add_activity"
328
+ end
329
+ # resource path
330
+ local_var_path = '/activities/add_list_memberships'
331
+
332
+ # query parameters
333
+ query_params = opts[:query_params] || {}
334
+
335
+ # header parameters
336
+ header_params = opts[:header_params] || {}
337
+ # HTTP header 'Accept' (if needed)
338
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
339
+ # HTTP header 'Content-Type'
340
+ content_type = @api_client.select_header_content_type(['application/json'])
341
+ if !content_type.nil?
342
+ header_params['Content-Type'] = content_type
343
+ end
344
+
345
+ # form parameters
346
+ form_params = opts[:form_params] || {}
347
+
348
+ # http body (model)
349
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_list_add_activity_request)
350
+
351
+ # return_type
352
+ return_type = opts[:debug_return_type] || 'CreateListRemoveActivity201Response'
353
+
354
+ # auth_names
355
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
356
+
357
+ new_options = opts.merge(
358
+ :operation => :"BulkActivitiesApi.create_list_add_activity",
359
+ :header_params => header_params,
360
+ :query_params => query_params,
361
+ :form_params => form_params,
362
+ :body => post_body,
363
+ :auth_names => auth_names,
364
+ :return_type => return_type
365
+ )
366
+
367
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
368
+ if @api_client.config.debugging
369
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_list_add_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
370
+ end
371
+ return data, status_code, headers
372
+ end
373
+
374
+ # Delete Contact Lists
375
+ # Use this endpoint to delete up to 100 contact lists in an account.
376
+ # @param create_list_delete_activity_request [CreateListDeleteActivityRequest] An array of &#x60;list_id&#x60;&#39;s to delete.
377
+ # @param [Hash] opts the optional parameters
378
+ # @return [CreateListDeleteActivity201Response]
379
+ def create_list_delete_activity(create_list_delete_activity_request, opts = {})
380
+ data, _status_code, _headers = create_list_delete_activity_with_http_info(create_list_delete_activity_request, opts)
381
+ data
382
+ end
383
+
384
+ # Delete Contact Lists
385
+ # Use this endpoint to delete up to 100 contact lists in an account.
386
+ # @param create_list_delete_activity_request [CreateListDeleteActivityRequest] An array of &#x60;list_id&#x60;&#39;s to delete.
387
+ # @param [Hash] opts the optional parameters
388
+ # @return [Array<(CreateListDeleteActivity201Response, Integer, Hash)>] CreateListDeleteActivity201Response data, response status code and response headers
389
+ def create_list_delete_activity_with_http_info(create_list_delete_activity_request, opts = {})
390
+ if @api_client.config.debugging
391
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_list_delete_activity ...'
392
+ end
393
+ # verify the required parameter 'create_list_delete_activity_request' is set
394
+ if @api_client.config.client_side_validation && create_list_delete_activity_request.nil?
395
+ fail ArgumentError, "Missing the required parameter 'create_list_delete_activity_request' when calling BulkActivitiesApi.create_list_delete_activity"
396
+ end
397
+ # resource path
398
+ local_var_path = '/activities/list_delete'
399
+
400
+ # query parameters
401
+ query_params = opts[:query_params] || {}
402
+
403
+ # header parameters
404
+ header_params = opts[:header_params] || {}
405
+ # HTTP header 'Accept' (if needed)
406
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
407
+ # HTTP header 'Content-Type'
408
+ content_type = @api_client.select_header_content_type(['application/json'])
409
+ if !content_type.nil?
410
+ header_params['Content-Type'] = content_type
411
+ end
412
+
413
+ # form parameters
414
+ form_params = opts[:form_params] || {}
415
+
416
+ # http body (model)
417
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_list_delete_activity_request)
418
+
419
+ # return_type
420
+ return_type = opts[:debug_return_type] || 'CreateListDeleteActivity201Response'
421
+
422
+ # auth_names
423
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
424
+
425
+ new_options = opts.merge(
426
+ :operation => :"BulkActivitiesApi.create_list_delete_activity",
427
+ :header_params => header_params,
428
+ :query_params => query_params,
429
+ :form_params => form_params,
430
+ :body => post_body,
431
+ :auth_names => auth_names,
432
+ :return_type => return_type
433
+ )
434
+
435
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
436
+ if @api_client.config.debugging
437
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_list_delete_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
+ end
439
+ return data, status_code, headers
440
+ end
441
+
442
+ # Remove Contacts from Lists
443
+ # Use this method to create an activity that removes contacts from one or more contact lists. Use the properties in the `source` object to remove specific contacts from your lists. Use the `list_ids` array to specify the target lists from which contacts are removed. Optionally, if the source is `all_active_contacts` (billable) or `list_ids`, use the `exclude` object to exclude specific contacts from being removed from the destination lists.
444
+ # @param create_list_remove_activity_request [CreateListRemoveActivityRequest] The JSON payload used to create the Remove Contacts from Lists&#39; activity
445
+ # @param [Hash] opts the optional parameters
446
+ # @return [CreateListRemoveActivity201Response]
447
+ def create_list_remove_activity(create_list_remove_activity_request, opts = {})
448
+ data, _status_code, _headers = create_list_remove_activity_with_http_info(create_list_remove_activity_request, opts)
449
+ data
450
+ end
451
+
452
+ # Remove Contacts from Lists
453
+ # Use this method to create an activity that removes contacts from one or more contact lists. Use the properties in the &#x60;source&#x60; object to remove specific contacts from your lists. Use the &#x60;list_ids&#x60; array to specify the target lists from which contacts are removed. Optionally, if the source is &#x60;all_active_contacts&#x60; (billable) or &#x60;list_ids&#x60;, use the &#x60;exclude&#x60; object to exclude specific contacts from being removed from the destination lists.
454
+ # @param create_list_remove_activity_request [CreateListRemoveActivityRequest] The JSON payload used to create the Remove Contacts from Lists&#39; activity
455
+ # @param [Hash] opts the optional parameters
456
+ # @return [Array<(CreateListRemoveActivity201Response, Integer, Hash)>] CreateListRemoveActivity201Response data, response status code and response headers
457
+ def create_list_remove_activity_with_http_info(create_list_remove_activity_request, opts = {})
458
+ if @api_client.config.debugging
459
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_list_remove_activity ...'
460
+ end
461
+ # verify the required parameter 'create_list_remove_activity_request' is set
462
+ if @api_client.config.client_side_validation && create_list_remove_activity_request.nil?
463
+ fail ArgumentError, "Missing the required parameter 'create_list_remove_activity_request' when calling BulkActivitiesApi.create_list_remove_activity"
464
+ end
465
+ # resource path
466
+ local_var_path = '/activities/remove_list_memberships'
467
+
468
+ # query parameters
469
+ query_params = opts[:query_params] || {}
470
+
471
+ # header parameters
472
+ header_params = opts[:header_params] || {}
473
+ # HTTP header 'Accept' (if needed)
474
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
475
+ # HTTP header 'Content-Type'
476
+ content_type = @api_client.select_header_content_type(['application/json'])
477
+ if !content_type.nil?
478
+ header_params['Content-Type'] = content_type
479
+ end
480
+
481
+ # form parameters
482
+ form_params = opts[:form_params] || {}
483
+
484
+ # http body (model)
485
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_list_remove_activity_request)
486
+
487
+ # return_type
488
+ return_type = opts[:debug_return_type] || 'CreateListRemoveActivity201Response'
489
+
490
+ # auth_names
491
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
492
+
493
+ new_options = opts.merge(
494
+ :operation => :"BulkActivitiesApi.create_list_remove_activity",
495
+ :header_params => header_params,
496
+ :query_params => query_params,
497
+ :form_params => form_params,
498
+ :body => post_body,
499
+ :auth_names => auth_names,
500
+ :return_type => return_type
501
+ )
502
+
503
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
504
+ if @api_client.config.debugging
505
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_list_remove_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
506
+ end
507
+ return data, status_code, headers
508
+ end
509
+
510
+ # Add Tags to Contacts
511
+ # Use this method to create an asynchronous activity that adds one or more tags to all contacts meeting your contact filtering criteria. Use the `source` type to identify contacts from which the specified tags (`tag_id`) are added. Source criteria are mutually exclusive. If the source is `all_active_contacts` or `list_ids`, you can optionally choose to `exclude` contacts by `contact_id`. Use the activity link in the results to check the status of your request. For more use case information, see \"[Add Tags to Contacts](/api_guide/add_tagging_activity.html)
512
+ # @param create_tag_remove_activity_request [CreateTagRemoveActivityRequest] The JSON payload used to create an asynchronous activity that adds tags to contacts that meet your specified contact filtering criteria.
513
+ # @param [Hash] opts the optional parameters
514
+ # @return [CreateTagRemoveActivity201Response]
515
+ def create_tag_add_contact_activity(create_tag_remove_activity_request, opts = {})
516
+ data, _status_code, _headers = create_tag_add_contact_activity_with_http_info(create_tag_remove_activity_request, opts)
517
+ data
518
+ end
519
+
520
+ # Add Tags to Contacts
521
+ # Use this method to create an asynchronous activity that adds one or more tags to all contacts meeting your contact filtering criteria. Use the &#x60;source&#x60; type to identify contacts from which the specified tags (&#x60;tag_id&#x60;) are added. Source criteria are mutually exclusive. If the source is &#x60;all_active_contacts&#x60; or &#x60;list_ids&#x60;, you can optionally choose to &#x60;exclude&#x60; contacts by &#x60;contact_id&#x60;. Use the activity link in the results to check the status of your request. For more use case information, see \&quot;[Add Tags to Contacts](/api_guide/add_tagging_activity.html)
522
+ # @param create_tag_remove_activity_request [CreateTagRemoveActivityRequest] The JSON payload used to create an asynchronous activity that adds tags to contacts that meet your specified contact filtering criteria.
523
+ # @param [Hash] opts the optional parameters
524
+ # @return [Array<(CreateTagRemoveActivity201Response, Integer, Hash)>] CreateTagRemoveActivity201Response data, response status code and response headers
525
+ def create_tag_add_contact_activity_with_http_info(create_tag_remove_activity_request, opts = {})
526
+ if @api_client.config.debugging
527
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_tag_add_contact_activity ...'
528
+ end
529
+ # verify the required parameter 'create_tag_remove_activity_request' is set
530
+ if @api_client.config.client_side_validation && create_tag_remove_activity_request.nil?
531
+ fail ArgumentError, "Missing the required parameter 'create_tag_remove_activity_request' when calling BulkActivitiesApi.create_tag_add_contact_activity"
532
+ end
533
+ # resource path
534
+ local_var_path = '/activities/contacts_taggings_add'
535
+
536
+ # query parameters
537
+ query_params = opts[:query_params] || {}
538
+
539
+ # header parameters
540
+ header_params = opts[:header_params] || {}
541
+ # HTTP header 'Accept' (if needed)
542
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
543
+ # HTTP header 'Content-Type'
544
+ content_type = @api_client.select_header_content_type(['application/json'])
545
+ if !content_type.nil?
546
+ header_params['Content-Type'] = content_type
547
+ end
548
+
549
+ # form parameters
550
+ form_params = opts[:form_params] || {}
551
+
552
+ # http body (model)
553
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_tag_remove_activity_request)
554
+
555
+ # return_type
556
+ return_type = opts[:debug_return_type] || 'CreateTagRemoveActivity201Response'
557
+
558
+ # auth_names
559
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
560
+
561
+ new_options = opts.merge(
562
+ :operation => :"BulkActivitiesApi.create_tag_add_contact_activity",
563
+ :header_params => header_params,
564
+ :query_params => query_params,
565
+ :form_params => form_params,
566
+ :body => post_body,
567
+ :auth_names => auth_names,
568
+ :return_type => return_type
569
+ )
570
+
571
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
572
+ if @api_client.config.debugging
573
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_tag_add_contact_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
574
+ end
575
+ return data, status_code, headers
576
+ end
577
+
578
+ # Delete Tags
579
+ # Use this method to create an asynchronous activity that deletes up to 500 tags. Deleted tags are automatically removed from tagged contacts. Use the `tag_ids` array of string values in the request body to specify which tags to delete.
580
+ # @param create_tag_delete_activity_request [CreateTagDeleteActivityRequest] An array of string values (&#x60;tag_id&#x60;s) to delete.
581
+ # @param [Hash] opts the optional parameters
582
+ # @return [CreateTagRemoveActivity201Response]
583
+ def create_tag_delete_activity(create_tag_delete_activity_request, opts = {})
584
+ data, _status_code, _headers = create_tag_delete_activity_with_http_info(create_tag_delete_activity_request, opts)
585
+ data
586
+ end
587
+
588
+ # Delete Tags
589
+ # Use this method to create an asynchronous activity that deletes up to 500 tags. Deleted tags are automatically removed from tagged contacts. Use the &#x60;tag_ids&#x60; array of string values in the request body to specify which tags to delete.
590
+ # @param create_tag_delete_activity_request [CreateTagDeleteActivityRequest] An array of string values (&#x60;tag_id&#x60;s) to delete.
591
+ # @param [Hash] opts the optional parameters
592
+ # @return [Array<(CreateTagRemoveActivity201Response, Integer, Hash)>] CreateTagRemoveActivity201Response data, response status code and response headers
593
+ def create_tag_delete_activity_with_http_info(create_tag_delete_activity_request, opts = {})
594
+ if @api_client.config.debugging
595
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_tag_delete_activity ...'
596
+ end
597
+ # verify the required parameter 'create_tag_delete_activity_request' is set
598
+ if @api_client.config.client_side_validation && create_tag_delete_activity_request.nil?
599
+ fail ArgumentError, "Missing the required parameter 'create_tag_delete_activity_request' when calling BulkActivitiesApi.create_tag_delete_activity"
600
+ end
601
+ # resource path
602
+ local_var_path = '/activities/contacts_tags_delete'
603
+
604
+ # query parameters
605
+ query_params = opts[:query_params] || {}
606
+
607
+ # header parameters
608
+ header_params = opts[:header_params] || {}
609
+ # HTTP header 'Accept' (if needed)
610
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
611
+ # HTTP header 'Content-Type'
612
+ content_type = @api_client.select_header_content_type(['application/json'])
613
+ if !content_type.nil?
614
+ header_params['Content-Type'] = content_type
615
+ end
616
+
617
+ # form parameters
618
+ form_params = opts[:form_params] || {}
619
+
620
+ # http body (model)
621
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_tag_delete_activity_request)
622
+
623
+ # return_type
624
+ return_type = opts[:debug_return_type] || 'CreateTagRemoveActivity201Response'
625
+
626
+ # auth_names
627
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
628
+
629
+ new_options = opts.merge(
630
+ :operation => :"BulkActivitiesApi.create_tag_delete_activity",
631
+ :header_params => header_params,
632
+ :query_params => query_params,
633
+ :form_params => form_params,
634
+ :body => post_body,
635
+ :auth_names => auth_names,
636
+ :return_type => return_type
637
+ )
638
+
639
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
640
+ if @api_client.config.debugging
641
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_tag_delete_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
642
+ end
643
+ return data, status_code, headers
644
+ end
645
+
646
+ # Remove Tags from Contacts
647
+ # Use this method to create an asynchronous activity that removes one or more tags from all contacts meeting your contact filtering criteria. Filtering criteria must include the `source` type used to identify contacts from which the specified tags (`tag_id`) are removed. Source types are mutually exclusive. If the specified source is either `all_active_contacts` or `list_ids`, you can optionally choose to `exclude` specified contacts by `contact_id`. Use the activity link in the results to check the status of your request.\" For more use case information, see \"[Remove Tags from Contacts](/api_guide/remove_tagging_activity.html)
648
+ # @param create_tag_remove_activity_request [CreateTagRemoveActivityRequest] The JSON payload used to create an asynchronous activity that removes tags from contacts meeting your specified contact filtering criteria.
649
+ # @param [Hash] opts the optional parameters
650
+ # @return [CreateTagRemoveActivity201Response]
651
+ def create_tag_remove_activity(create_tag_remove_activity_request, opts = {})
652
+ data, _status_code, _headers = create_tag_remove_activity_with_http_info(create_tag_remove_activity_request, opts)
653
+ data
654
+ end
655
+
656
+ # Remove Tags from Contacts
657
+ # Use this method to create an asynchronous activity that removes one or more tags from all contacts meeting your contact filtering criteria. Filtering criteria must include the &#x60;source&#x60; type used to identify contacts from which the specified tags (&#x60;tag_id&#x60;) are removed. Source types are mutually exclusive. If the specified source is either &#x60;all_active_contacts&#x60; or &#x60;list_ids&#x60;, you can optionally choose to &#x60;exclude&#x60; specified contacts by &#x60;contact_id&#x60;. Use the activity link in the results to check the status of your request.\&quot; For more use case information, see \&quot;[Remove Tags from Contacts](/api_guide/remove_tagging_activity.html)
658
+ # @param create_tag_remove_activity_request [CreateTagRemoveActivityRequest] The JSON payload used to create an asynchronous activity that removes tags from contacts meeting your specified contact filtering criteria.
659
+ # @param [Hash] opts the optional parameters
660
+ # @return [Array<(CreateTagRemoveActivity201Response, Integer, Hash)>] CreateTagRemoveActivity201Response data, response status code and response headers
661
+ def create_tag_remove_activity_with_http_info(create_tag_remove_activity_request, opts = {})
662
+ if @api_client.config.debugging
663
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.create_tag_remove_activity ...'
664
+ end
665
+ # verify the required parameter 'create_tag_remove_activity_request' is set
666
+ if @api_client.config.client_side_validation && create_tag_remove_activity_request.nil?
667
+ fail ArgumentError, "Missing the required parameter 'create_tag_remove_activity_request' when calling BulkActivitiesApi.create_tag_remove_activity"
668
+ end
669
+ # resource path
670
+ local_var_path = '/activities/contacts_taggings_remove'
671
+
672
+ # query parameters
673
+ query_params = opts[:query_params] || {}
674
+
675
+ # header parameters
676
+ header_params = opts[:header_params] || {}
677
+ # HTTP header 'Accept' (if needed)
678
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
679
+ # HTTP header 'Content-Type'
680
+ content_type = @api_client.select_header_content_type(['application/json'])
681
+ if !content_type.nil?
682
+ header_params['Content-Type'] = content_type
683
+ end
684
+
685
+ # form parameters
686
+ form_params = opts[:form_params] || {}
687
+
688
+ # http body (model)
689
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_tag_remove_activity_request)
690
+
691
+ # return_type
692
+ return_type = opts[:debug_return_type] || 'CreateTagRemoveActivity201Response'
693
+
694
+ # auth_names
695
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
696
+
697
+ new_options = opts.merge(
698
+ :operation => :"BulkActivitiesApi.create_tag_remove_activity",
699
+ :header_params => header_params,
700
+ :query_params => query_params,
701
+ :form_params => form_params,
702
+ :body => post_body,
703
+ :auth_names => auth_names,
704
+ :return_type => return_type
705
+ )
706
+
707
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
708
+ if @api_client.config.debugging
709
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#create_tag_remove_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
710
+ end
711
+ return data, status_code, headers
712
+ end
713
+
714
+ # GET an Activity Status
715
+ # This endpoint returns an activity status report.
716
+ # @param activity_id [String] The unique ID of the activity to GET
717
+ # @param [Hash] opts the optional parameters
718
+ # @return [GetActivityById200Response]
719
+ def get_activity_by_id(activity_id, opts = {})
720
+ data, _status_code, _headers = get_activity_by_id_with_http_info(activity_id, opts)
721
+ data
722
+ end
723
+
724
+ # GET an Activity Status
725
+ # This endpoint returns an activity status report.
726
+ # @param activity_id [String] The unique ID of the activity to GET
727
+ # @param [Hash] opts the optional parameters
728
+ # @return [Array<(GetActivityById200Response, Integer, Hash)>] GetActivityById200Response data, response status code and response headers
729
+ def get_activity_by_id_with_http_info(activity_id, opts = {})
730
+ if @api_client.config.debugging
731
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.get_activity_by_id ...'
732
+ end
733
+ # verify the required parameter 'activity_id' is set
734
+ if @api_client.config.client_side_validation && activity_id.nil?
735
+ fail ArgumentError, "Missing the required parameter 'activity_id' when calling BulkActivitiesApi.get_activity_by_id"
736
+ end
737
+ # resource path
738
+ local_var_path = '/activities/{activity_id}'.sub('{' + 'activity_id' + '}', CGI.escape(activity_id.to_s))
739
+
740
+ # query parameters
741
+ query_params = opts[:query_params] || {}
742
+
743
+ # header parameters
744
+ header_params = opts[:header_params] || {}
745
+ # HTTP header 'Accept' (if needed)
746
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
747
+
748
+ # form parameters
749
+ form_params = opts[:form_params] || {}
750
+
751
+ # http body (model)
752
+ post_body = opts[:debug_body]
753
+
754
+ # return_type
755
+ return_type = opts[:debug_return_type] || 'GetActivityById200Response'
756
+
757
+ # auth_names
758
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
759
+
760
+ new_options = opts.merge(
761
+ :operation => :"BulkActivitiesApi.get_activity_by_id",
762
+ :header_params => header_params,
763
+ :query_params => query_params,
764
+ :form_params => form_params,
765
+ :body => post_body,
766
+ :auth_names => auth_names,
767
+ :return_type => return_type
768
+ )
769
+
770
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
771
+ if @api_client.config.debugging
772
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#get_activity_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
773
+ end
774
+ return data, status_code, headers
775
+ end
776
+
777
+ # GET Activity Status Collection
778
+ # This endpoint returns a collection of activities. Use the state query parameter to include only activities with a specific status (processing, completed, cancelled, failed, or time_out). Use the limit query parameter to define the number of activities returned per page. Learn [more](/api_guide/activity_status.html).
779
+ # @param [Hash] opts the optional parameters
780
+ # @option opts [Integer] :limit Specifies the number of results displayed per page of output, from 1 - 500, default &#x3D; 50. (default to 50)
781
+ # @option opts [String] :state Use this parameter to filter the response to include only activities in one of the following states: cancelled, completed, failed, processing, or timed_out.
782
+ # @return [GetAllActivities200Response]
783
+ def get_all_activities(opts = {})
784
+ data, _status_code, _headers = get_all_activities_with_http_info(opts)
785
+ data
786
+ end
787
+
788
+ # GET Activity Status Collection
789
+ # This endpoint returns a collection of activities. Use the state query parameter to include only activities with a specific status (processing, completed, cancelled, failed, or time_out). Use the limit query parameter to define the number of activities returned per page. Learn [more](/api_guide/activity_status.html).
790
+ # @param [Hash] opts the optional parameters
791
+ # @option opts [Integer] :limit Specifies the number of results displayed per page of output, from 1 - 500, default &#x3D; 50. (default to 50)
792
+ # @option opts [String] :state Use this parameter to filter the response to include only activities in one of the following states: cancelled, completed, failed, processing, or timed_out.
793
+ # @return [Array<(GetAllActivities200Response, Integer, Hash)>] GetAllActivities200Response data, response status code and response headers
794
+ def get_all_activities_with_http_info(opts = {})
795
+ if @api_client.config.debugging
796
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.get_all_activities ...'
797
+ end
798
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
799
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BulkActivitiesApi.get_all_activities, must be smaller than or equal to 500.'
800
+ end
801
+
802
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
803
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BulkActivitiesApi.get_all_activities, must be greater than or equal to 1.'
804
+ end
805
+
806
+ allowable_values = ["processing", "completed", "cancelled", "failed", "timed_out"]
807
+ if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
808
+ fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
809
+ end
810
+ # resource path
811
+ local_var_path = '/activities'
812
+
813
+ # query parameters
814
+ query_params = opts[:query_params] || {}
815
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
816
+ query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
817
+
818
+ # header parameters
819
+ header_params = opts[:header_params] || {}
820
+ # HTTP header 'Accept' (if needed)
821
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
822
+
823
+ # form parameters
824
+ form_params = opts[:form_params] || {}
825
+
826
+ # http body (model)
827
+ post_body = opts[:debug_body]
828
+
829
+ # return_type
830
+ return_type = opts[:debug_return_type] || 'GetAllActivities200Response'
831
+
832
+ # auth_names
833
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
834
+
835
+ new_options = opts.merge(
836
+ :operation => :"BulkActivitiesApi.get_all_activities",
837
+ :header_params => header_params,
838
+ :query_params => query_params,
839
+ :form_params => form_params,
840
+ :body => post_body,
841
+ :auth_names => auth_names,
842
+ :return_type => return_type
843
+ )
844
+
845
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
846
+ if @api_client.config.debugging
847
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#get_all_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
848
+ end
849
+ return data, status_code, headers
850
+ end
851
+
852
+ # Retrieve Exported Contacts File
853
+ # Use this endpoint to retrieve (GET) a CSV file containing exported contacts by providing the `activity_id` of a completed CSV export activity.
854
+ # @param file_export_id [String] The unique ID of the exported file provided in the results: section of the export contacts activity response.
855
+ # @param [Hash] opts the optional parameters
856
+ # @return [String]
857
+ def get_csv_export_file(file_export_id, opts = {})
858
+ data, _status_code, _headers = get_csv_export_file_with_http_info(file_export_id, opts)
859
+ data
860
+ end
861
+
862
+ # Retrieve Exported Contacts File
863
+ # Use this endpoint to retrieve (GET) a CSV file containing exported contacts by providing the &#x60;activity_id&#x60; of a completed CSV export activity.
864
+ # @param file_export_id [String] The unique ID of the exported file provided in the results: section of the export contacts activity response.
865
+ # @param [Hash] opts the optional parameters
866
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
867
+ def get_csv_export_file_with_http_info(file_export_id, opts = {})
868
+ if @api_client.config.debugging
869
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.get_csv_export_file ...'
870
+ end
871
+ # verify the required parameter 'file_export_id' is set
872
+ if @api_client.config.client_side_validation && file_export_id.nil?
873
+ fail ArgumentError, "Missing the required parameter 'file_export_id' when calling BulkActivitiesApi.get_csv_export_file"
874
+ end
875
+ # resource path
876
+ local_var_path = '/contact_exports/{file_export_id}'.sub('{' + 'file_export_id' + '}', CGI.escape(file_export_id.to_s))
877
+
878
+ # query parameters
879
+ query_params = opts[:query_params] || {}
880
+
881
+ # header parameters
882
+ header_params = opts[:header_params] || {}
883
+ # HTTP header 'Accept' (if needed)
884
+ header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
885
+
886
+ # form parameters
887
+ form_params = opts[:form_params] || {}
888
+
889
+ # http body (model)
890
+ post_body = opts[:debug_body]
891
+
892
+ # return_type
893
+ return_type = opts[:debug_return_type] || 'String'
894
+
895
+ # auth_names
896
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
897
+
898
+ new_options = opts.merge(
899
+ :operation => :"BulkActivitiesApi.get_csv_export_file",
900
+ :header_params => header_params,
901
+ :query_params => query_params,
902
+ :form_params => form_params,
903
+ :body => post_body,
904
+ :auth_names => auth_names,
905
+ :return_type => return_type
906
+ )
907
+
908
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
909
+ if @api_client.config.debugging
910
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#get_csv_export_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
911
+ end
912
+ return data, status_code, headers
913
+ end
914
+
915
+ # Delete Custom Fields
916
+ # Use this endpoint to delete up to 100 custom fields for an account.
917
+ # @param post_custom_field_delete_request [PostCustomFieldDeleteRequest] An array of &#x60;custom_field_id&#x60;&#39;s to delete.
918
+ # @param [Hash] opts the optional parameters
919
+ # @return [PostCustomFieldDelete201Response]
920
+ def post_custom_field_delete(post_custom_field_delete_request, opts = {})
921
+ data, _status_code, _headers = post_custom_field_delete_with_http_info(post_custom_field_delete_request, opts)
922
+ data
923
+ end
924
+
925
+ # Delete Custom Fields
926
+ # Use this endpoint to delete up to 100 custom fields for an account.
927
+ # @param post_custom_field_delete_request [PostCustomFieldDeleteRequest] An array of &#x60;custom_field_id&#x60;&#39;s to delete.
928
+ # @param [Hash] opts the optional parameters
929
+ # @return [Array<(PostCustomFieldDelete201Response, Integer, Hash)>] PostCustomFieldDelete201Response data, response status code and response headers
930
+ def post_custom_field_delete_with_http_info(post_custom_field_delete_request, opts = {})
931
+ if @api_client.config.debugging
932
+ @api_client.config.logger.debug 'Calling API: BulkActivitiesApi.post_custom_field_delete ...'
933
+ end
934
+ # verify the required parameter 'post_custom_field_delete_request' is set
935
+ if @api_client.config.client_side_validation && post_custom_field_delete_request.nil?
936
+ fail ArgumentError, "Missing the required parameter 'post_custom_field_delete_request' when calling BulkActivitiesApi.post_custom_field_delete"
937
+ end
938
+ # resource path
939
+ local_var_path = '/activities/custom_fields_delete'
940
+
941
+ # query parameters
942
+ query_params = opts[:query_params] || {}
943
+
944
+ # header parameters
945
+ header_params = opts[:header_params] || {}
946
+ # HTTP header 'Accept' (if needed)
947
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
948
+ # HTTP header 'Content-Type'
949
+ content_type = @api_client.select_header_content_type(['application/json'])
950
+ if !content_type.nil?
951
+ header_params['Content-Type'] = content_type
952
+ end
953
+
954
+ # form parameters
955
+ form_params = opts[:form_params] || {}
956
+
957
+ # http body (model)
958
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(post_custom_field_delete_request)
959
+
960
+ # return_type
961
+ return_type = opts[:debug_return_type] || 'PostCustomFieldDelete201Response'
962
+
963
+ # auth_names
964
+ auth_names = opts[:debug_auth_names] || ['oauth2_access_code', 'oauth2_implicit']
965
+
966
+ new_options = opts.merge(
967
+ :operation => :"BulkActivitiesApi.post_custom_field_delete",
968
+ :header_params => header_params,
969
+ :query_params => query_params,
970
+ :form_params => form_params,
971
+ :body => post_body,
972
+ :auth_names => auth_names,
973
+ :return_type => return_type
974
+ )
975
+
976
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
977
+ if @api_client.config.debugging
978
+ @api_client.config.logger.debug "API called: BulkActivitiesApi#post_custom_field_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
979
+ end
980
+ return data, status_code, headers
981
+ end
982
+ end
983
+ end