trycourier 1.10.0 → 3.0.0.pre.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (324) hide show
  1. checksums.yaml +4 -4
  2. data/lib/environment.rb +7 -0
  3. data/lib/gemconfig.rb +14 -0
  4. data/lib/requests.rb +121 -0
  5. data/lib/trycourier/audiences/client.rb +235 -0
  6. data/lib/trycourier/audiences/types/audience.rb +86 -0
  7. data/lib/trycourier/audiences/types/audience_list_response.rb +62 -0
  8. data/lib/trycourier/audiences/types/audience_member.rb +74 -0
  9. data/lib/trycourier/audiences/types/audience_member_get_response.rb +53 -0
  10. data/lib/trycourier/audiences/types/audience_member_list_response.rb +62 -0
  11. data/lib/trycourier/audiences/types/audience_update_response.rb +53 -0
  12. data/lib/trycourier/audiences/types/base_filter_config.rb +53 -0
  13. data/lib/trycourier/audiences/types/comparison_operator.rb +21 -0
  14. data/lib/trycourier/audiences/types/filter.rb +50 -0
  15. data/lib/trycourier/audiences/types/filter_config.rb +50 -0
  16. data/lib/trycourier/audiences/types/logical_operator.rb +10 -0
  17. data/lib/trycourier/audiences/types/nested_filter_config.rb +63 -0
  18. data/lib/trycourier/audiences/types/operator.rb +48 -0
  19. data/lib/trycourier/audiences/types/single_filter_config.rb +64 -0
  20. data/lib/trycourier/audit_events/client.rb +104 -0
  21. data/lib/trycourier/audit_events/types/actor.rb +52 -0
  22. data/lib/trycourier/audit_events/types/audit_event.rb +92 -0
  23. data/lib/trycourier/audit_events/types/get_audit_event_params.rb +47 -0
  24. data/lib/trycourier/audit_events/types/list_audit_events_params.rb +47 -0
  25. data/lib/trycourier/audit_events/types/list_audit_events_response.rb +62 -0
  26. data/lib/trycourier/audit_events/types/target.rb +52 -0
  27. data/lib/trycourier/auth_tokens/client.rb +85 -0
  28. data/lib/trycourier/auth_tokens/types/issue_token_response.rb +47 -0
  29. data/lib/trycourier/automations/client.rb +151 -0
  30. data/lib/trycourier/automations/types/automation.rb +56 -0
  31. data/lib/trycourier/automations/types/automation_ad_hoc_invoke_params.rb +88 -0
  32. data/lib/trycourier/automations/types/automation_cancel_step.rb +62 -0
  33. data/lib/trycourier/automations/types/automation_delay_step.rb +62 -0
  34. data/lib/trycourier/automations/types/automation_invoke_params.rb +69 -0
  35. data/lib/trycourier/automations/types/automation_invoke_response.rb +47 -0
  36. data/lib/trycourier/automations/types/automation_invoke_step.rb +62 -0
  37. data/lib/trycourier/automations/types/automation_invoke_template_params.rb +82 -0
  38. data/lib/trycourier/automations/types/automation_run_context.rb +69 -0
  39. data/lib/trycourier/automations/types/automation_send_list_step.rb +93 -0
  40. data/lib/trycourier/automations/types/automation_send_step.rb +99 -0
  41. data/lib/trycourier/automations/types/automation_step.rb +52 -0
  42. data/lib/trycourier/automations/types/automation_step_action.rb +14 -0
  43. data/lib/trycourier/automations/types/automation_step_option.rb +110 -0
  44. data/lib/trycourier/automations/types/automation_update_profile_step.rb +64 -0
  45. data/lib/trycourier/automations/types/automation_v_2_send_step.rb +68 -0
  46. data/lib/trycourier/automations/types/merge_algorithm.rb +12 -0
  47. data/lib/trycourier/automations/types/profile.rb +7 -0
  48. data/lib/trycourier/brands/client.rb +281 -0
  49. data/lib/trycourier/brands/types/brand.rb +105 -0
  50. data/lib/trycourier/brands/types/brand_colors.rb +57 -0
  51. data/lib/trycourier/brands/types/brand_get_all_response.rb +62 -0
  52. data/lib/trycourier/brands/types/brand_parameters.rb +74 -0
  53. data/lib/trycourier/brands/types/brand_settings.rb +69 -0
  54. data/lib/trycourier/brands/types/brand_snippet.rb +57 -0
  55. data/lib/trycourier/brands/types/brand_snippets.rb +51 -0
  56. data/lib/trycourier/brands/types/brands_response.rb +62 -0
  57. data/lib/trycourier/bulk/client.rb +249 -0
  58. data/lib/trycourier/bulk/types/bulk_create_job_response.rb +47 -0
  59. data/lib/trycourier/bulk/types/bulk_get_job_params.rb +47 -0
  60. data/lib/trycourier/bulk/types/bulk_get_job_response.rb +53 -0
  61. data/lib/trycourier/bulk/types/bulk_get_job_users_params.rb +52 -0
  62. data/lib/trycourier/bulk/types/bulk_get_job_users_response.rb +62 -0
  63. data/lib/trycourier/bulk/types/bulk_ingest_error.rb +52 -0
  64. data/lib/trycourier/bulk/types/bulk_ingest_users_params.rb +51 -0
  65. data/lib/trycourier/bulk/types/bulk_ingest_users_response.rb +56 -0
  66. data/lib/trycourier/bulk/types/bulk_job_status.rb +12 -0
  67. data/lib/trycourier/bulk/types/bulk_job_user_status.rb +11 -0
  68. data/lib/trycourier/bulk/types/bulk_message_user_response.rb +100 -0
  69. data/lib/trycourier/bulk/types/inbound_bulk_content_message.rb +165 -0
  70. data/lib/trycourier/bulk/types/inbound_bulk_message.rb +95 -0
  71. data/lib/trycourier/bulk/types/inbound_bulk_message_user.rb +80 -0
  72. data/lib/trycourier/bulk/types/inbound_bulk_message_v_1.rb +75 -0
  73. data/lib/trycourier/bulk/types/inbound_bulk_message_v_2.rb +50 -0
  74. data/lib/trycourier/bulk/types/inbound_bulk_template_message.rb +157 -0
  75. data/lib/trycourier/bulk/types/job_details.rb +81 -0
  76. data/lib/trycourier/commons/types/already_exists.rb +52 -0
  77. data/lib/trycourier/commons/types/bad_request.rb +52 -0
  78. data/lib/trycourier/commons/types/base_error.rb +47 -0
  79. data/lib/trycourier/commons/types/channel_classification.rb +14 -0
  80. data/lib/trycourier/commons/types/channel_preference.rb +48 -0
  81. data/lib/trycourier/commons/types/conflict.rb +52 -0
  82. data/lib/trycourier/commons/types/email.rb +52 -0
  83. data/lib/trycourier/commons/types/message_not_found.rb +52 -0
  84. data/lib/trycourier/commons/types/not_found.rb +52 -0
  85. data/lib/trycourier/commons/types/notification_preference_details.rb +66 -0
  86. data/lib/trycourier/commons/types/notification_preferences.rb +7 -0
  87. data/lib/trycourier/commons/types/paging.rb +52 -0
  88. data/lib/trycourier/commons/types/payment_required.rb +52 -0
  89. data/lib/trycourier/commons/types/preference_status.rb +11 -0
  90. data/lib/trycourier/commons/types/recipient_preferences.rb +53 -0
  91. data/lib/trycourier/commons/types/rule.rb +52 -0
  92. data/lib/trycourier/commons/types/user_tenant_association.rb +62 -0
  93. data/lib/trycourier/lists/client.rb +454 -0
  94. data/lib/trycourier/lists/types/list.rb +62 -0
  95. data/lib/trycourier/lists/types/list_get_all_response.rb +62 -0
  96. data/lib/trycourier/lists/types/list_get_subscriptions_response.rb +62 -0
  97. data/lib/trycourier/lists/types/list_put_params.rb +58 -0
  98. data/lib/trycourier/lists/types/list_subscription_recipient.rb +63 -0
  99. data/lib/trycourier/lists/types/put_subscriptions_recipient.rb +58 -0
  100. data/lib/trycourier/messages/client.rb +300 -0
  101. data/lib/trycourier/messages/types/list_messages_response.rb +62 -0
  102. data/lib/trycourier/messages/types/message_details.rb +120 -0
  103. data/lib/trycourier/messages/types/message_history_response.rb +51 -0
  104. data/lib/trycourier/messages/types/message_status.rb +17 -0
  105. data/lib/trycourier/messages/types/reason.rb +14 -0
  106. data/lib/trycourier/messages/types/render_output.rb +63 -0
  107. data/lib/trycourier/messages/types/render_output_response.rb +51 -0
  108. data/lib/trycourier/messages/types/rendered_message_block.rb +52 -0
  109. data/lib/trycourier/messages/types/rendered_message_content.rb +77 -0
  110. data/lib/trycourier/notifications/client.rb +379 -0
  111. data/lib/trycourier/notifications/types/base_check.rb +58 -0
  112. data/lib/trycourier/notifications/types/block_type.rb +17 -0
  113. data/lib/trycourier/notifications/types/check.rb +63 -0
  114. data/lib/trycourier/notifications/types/check_status.rb +11 -0
  115. data/lib/trycourier/notifications/types/message_routing.rb +57 -0
  116. data/lib/trycourier/notifications/types/message_routing_channel.rb +49 -0
  117. data/lib/trycourier/notifications/types/message_routing_method.rb +10 -0
  118. data/lib/trycourier/notifications/types/notification.rb +63 -0
  119. data/lib/trycourier/notifications/types/notification_block.rb +94 -0
  120. data/lib/trycourier/notifications/types/notification_channel.rb +73 -0
  121. data/lib/trycourier/notifications/types/notification_channel_content.rb +52 -0
  122. data/lib/trycourier/notifications/types/notification_content.rb +49 -0
  123. data/lib/trycourier/notifications/types/notification_content_hierarchy.rb +52 -0
  124. data/lib/trycourier/notifications/types/notification_get_content_response.rb +65 -0
  125. data/lib/trycourier/notifications/types/notification_list_response.rb +62 -0
  126. data/lib/trycourier/notifications/types/submission_checks_get_response.rb +51 -0
  127. data/lib/trycourier/notifications/types/submission_checks_replace_response.rb +51 -0
  128. data/lib/trycourier/profiles/client.rb +325 -0
  129. data/lib/trycourier/profiles/types/address.rb +81 -0
  130. data/lib/trycourier/profiles/types/airship_profile.rb +59 -0
  131. data/lib/trycourier/profiles/types/airship_profile_audience.rb +47 -0
  132. data/lib/trycourier/profiles/types/delete_list_subscription_response.rb +47 -0
  133. data/lib/trycourier/profiles/types/device_type.rb +7 -0
  134. data/lib/trycourier/profiles/types/discord.rb +50 -0
  135. data/lib/trycourier/profiles/types/expo.rb +50 -0
  136. data/lib/trycourier/profiles/types/get_list_subscriptions_list.rb +74 -0
  137. data/lib/trycourier/profiles/types/get_list_subscriptions_response.rb +62 -0
  138. data/lib/trycourier/profiles/types/intercom.rb +58 -0
  139. data/lib/trycourier/profiles/types/intercom_recipient.rb +47 -0
  140. data/lib/trycourier/profiles/types/merge_profile_response.rb +47 -0
  141. data/lib/trycourier/profiles/types/ms_teams.rb +86 -0
  142. data/lib/trycourier/profiles/types/ms_teams_base_properties.rb +52 -0
  143. data/lib/trycourier/profiles/types/multiple_tokens.rb +51 -0
  144. data/lib/trycourier/profiles/types/profile_get_parameters.rb +47 -0
  145. data/lib/trycourier/profiles/types/profile_get_response.rb +58 -0
  146. data/lib/trycourier/profiles/types/replace_profile_response.rb +47 -0
  147. data/lib/trycourier/profiles/types/send_direct_message.rb +47 -0
  148. data/lib/trycourier/profiles/types/send_to_channel.rb +47 -0
  149. data/lib/trycourier/profiles/types/send_to_ms_teams_channel_id.rb +57 -0
  150. data/lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb +68 -0
  151. data/lib/trycourier/profiles/types/send_to_ms_teams_conversation_id.rb +58 -0
  152. data/lib/trycourier/profiles/types/send_to_ms_teams_email.rb +57 -0
  153. data/lib/trycourier/profiles/types/send_to_ms_teams_user_id.rb +57 -0
  154. data/lib/trycourier/profiles/types/send_to_slack_channel.rb +52 -0
  155. data/lib/trycourier/profiles/types/send_to_slack_email.rb +52 -0
  156. data/lib/trycourier/profiles/types/send_to_slack_user_id.rb +52 -0
  157. data/lib/trycourier/profiles/types/slack.rb +62 -0
  158. data/lib/trycourier/profiles/types/slack_base_properties.rb +47 -0
  159. data/lib/trycourier/profiles/types/snooze_rule.rb +58 -0
  160. data/lib/trycourier/profiles/types/snooze_rule_type.rb +9 -0
  161. data/lib/trycourier/profiles/types/subscribe_to_lists_request.rb +51 -0
  162. data/lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb +58 -0
  163. data/lib/trycourier/profiles/types/subscribe_to_lists_response.rb +47 -0
  164. data/lib/trycourier/profiles/types/token.rb +47 -0
  165. data/lib/trycourier/profiles/types/user_profile.rb +274 -0
  166. data/lib/trycourier/send/types/attachment.rb +7 -0
  167. data/lib/trycourier/send/types/audience_filter.rb +57 -0
  168. data/lib/trycourier/send/types/audience_recipient.rb +62 -0
  169. data/lib/trycourier/send/types/base_message.rb +149 -0
  170. data/lib/trycourier/send/types/base_social_presence.rb +47 -0
  171. data/lib/trycourier/send/types/brand_settings_email.rb +87 -0
  172. data/lib/trycourier/send/types/brand_settings_in_app.rb +119 -0
  173. data/lib/trycourier/send/types/brand_settings_social_presence.rb +107 -0
  174. data/lib/trycourier/send/types/brand_template.rb +88 -0
  175. data/lib/trycourier/send/types/brand_template_override.rb +112 -0
  176. data/lib/trycourier/send/types/channel.rb +113 -0
  177. data/lib/trycourier/send/types/channel_metadata.rb +53 -0
  178. data/lib/trycourier/send/types/channel_source.rb +11 -0
  179. data/lib/trycourier/send/types/content.rb +50 -0
  180. data/lib/trycourier/send/types/content_message.rb +177 -0
  181. data/lib/trycourier/send/types/criteria.rb +12 -0
  182. data/lib/trycourier/send/types/delay.rb +47 -0
  183. data/lib/trycourier/send/types/elemental_action_node.rb +116 -0
  184. data/lib/trycourier/send/types/elemental_base_node.rb +62 -0
  185. data/lib/trycourier/send/types/elemental_channel_node.rb +105 -0
  186. data/lib/trycourier/send/types/elemental_content.rb +61 -0
  187. data/lib/trycourier/send/types/elemental_content_sugar.rb +53 -0
  188. data/lib/trycourier/send/types/elemental_divider_node.rb +68 -0
  189. data/lib/trycourier/send/types/elemental_group_node.rb +72 -0
  190. data/lib/trycourier/send/types/elemental_image_node.rb +101 -0
  191. data/lib/trycourier/send/types/elemental_meta_node.rb +70 -0
  192. data/lib/trycourier/send/types/elemental_node.rb +170 -0
  193. data/lib/trycourier/send/types/elemental_quote_node.rb +104 -0
  194. data/lib/trycourier/send/types/elemental_text_node.rb +136 -0
  195. data/lib/trycourier/send/types/email_footer.rb +52 -0
  196. data/lib/trycourier/send/types/email_head.rb +52 -0
  197. data/lib/trycourier/send/types/email_header.rb +63 -0
  198. data/lib/trycourier/send/types/expires_in_type.rb +48 -0
  199. data/lib/trycourier/send/types/expiry.rb +58 -0
  200. data/lib/trycourier/send/types/i_action_button_style.rb +10 -0
  201. data/lib/trycourier/send/types/i_alignment.rb +12 -0
  202. data/lib/trycourier/send/types/i_preferences.rb +7 -0
  203. data/lib/trycourier/send/types/i_profile_preferences.rb +59 -0
  204. data/lib/trycourier/send/types/icons.rb +52 -0
  205. data/lib/trycourier/send/types/in_app_placement.rb +12 -0
  206. data/lib/trycourier/send/types/invalid_list_pattern_recipient.rb +52 -0
  207. data/lib/trycourier/send/types/invalid_list_recipient.rb +52 -0
  208. data/lib/trycourier/send/types/invalid_user_recipient.rb +52 -0
  209. data/lib/trycourier/send/types/list_filter.rb +57 -0
  210. data/lib/trycourier/send/types/list_pattern_recipient.rb +53 -0
  211. data/lib/trycourier/send/types/list_pattern_recipient_type.rb +41 -0
  212. data/lib/trycourier/send/types/list_recipient.rb +62 -0
  213. data/lib/trycourier/send/types/list_recipient_type.rb +41 -0
  214. data/lib/trycourier/send/types/locale.rb +47 -0
  215. data/lib/trycourier/send/types/locales.rb +7 -0
  216. data/lib/trycourier/send/types/logo.rb +52 -0
  217. data/lib/trycourier/send/types/message.rb +50 -0
  218. data/lib/trycourier/send/types/message_channel_email_override.rb +119 -0
  219. data/lib/trycourier/send/types/message_channels.rb +7 -0
  220. data/lib/trycourier/send/types/message_context.rb +49 -0
  221. data/lib/trycourier/send/types/message_data.rb +7 -0
  222. data/lib/trycourier/send/types/message_metadata.rb +68 -0
  223. data/lib/trycourier/send/types/message_providers.rb +7 -0
  224. data/lib/trycourier/send/types/message_providers_type.rb +72 -0
  225. data/lib/trycourier/send/types/message_recipient.rb +54 -0
  226. data/lib/trycourier/send/types/metadata.rb +53 -0
  227. data/lib/trycourier/send/types/ms_teams_recipient.rb +53 -0
  228. data/lib/trycourier/send/types/override.rb +10 -0
  229. data/lib/trycourier/send/types/preference.rb +73 -0
  230. data/lib/trycourier/send/types/preferences.rb +47 -0
  231. data/lib/trycourier/send/types/recipient.rb +98 -0
  232. data/lib/trycourier/send/types/routing.rb +64 -0
  233. data/lib/trycourier/send/types/routing_channel.rb +61 -0
  234. data/lib/trycourier/send/types/routing_method.rb +10 -0
  235. data/lib/trycourier/send/types/routing_strategy_channel.rb +70 -0
  236. data/lib/trycourier/send/types/routing_strategy_provider.rb +68 -0
  237. data/lib/trycourier/send/types/rule_type.rb +11 -0
  238. data/lib/trycourier/send/types/slack_recipient.rb +53 -0
  239. data/lib/trycourier/send/types/template_message.rb +169 -0
  240. data/lib/trycourier/send/types/text_align.rb +11 -0
  241. data/lib/trycourier/send/types/text_style.rb +12 -0
  242. data/lib/trycourier/send/types/timeout.rb +76 -0
  243. data/lib/trycourier/send/types/timeouts.rb +52 -0
  244. data/lib/trycourier/send/types/tracking_override.rb +47 -0
  245. data/lib/trycourier/send/types/user_recipient.rb +115 -0
  246. data/lib/trycourier/send/types/user_recipient_type.rb +41 -0
  247. data/lib/trycourier/send/types/utm.rb +68 -0
  248. data/lib/trycourier/send/types/widget_background.rb +52 -0
  249. data/lib/trycourier/templates/client.rb +67 -0
  250. data/lib/trycourier/templates/types/channel_identifier.rb +7 -0
  251. data/lib/trycourier/templates/types/list_templates_response.rb +62 -0
  252. data/lib/trycourier/templates/types/notification_templates.rb +90 -0
  253. data/lib/trycourier/templates/types/routing_strategy.rb +54 -0
  254. data/lib/trycourier/templates/types/routing_strategy_method.rb +10 -0
  255. data/lib/trycourier/templates/types/tag.rb +51 -0
  256. data/lib/trycourier/templates/types/tag_data.rb +52 -0
  257. data/lib/trycourier/tenants/client.rb +255 -0
  258. data/lib/trycourier/tenants/types/default_preferences.rb +51 -0
  259. data/lib/trycourier/tenants/types/list_users_for_tenant_response.rb +88 -0
  260. data/lib/trycourier/tenants/types/subscription_topic.rb +53 -0
  261. data/lib/trycourier/tenants/types/subscription_topic_status.rb +11 -0
  262. data/lib/trycourier/tenants/types/template_property.rb +7 -0
  263. data/lib/trycourier/tenants/types/tenant.rb +95 -0
  264. data/lib/trycourier/tenants/types/tenant_list_response.rb +86 -0
  265. data/lib/trycourier/translations/client.rb +106 -0
  266. data/lib/trycourier/types/send_message_response.rb +49 -0
  267. data/lib/trycourier/users/client.rb +34 -0
  268. data/lib/trycourier/users/preferences/client.rb +171 -0
  269. data/lib/trycourier/users/preferences/types/topic_preference.rb +86 -0
  270. data/lib/trycourier/users/preferences/types/user_preferences_get_response.rb +55 -0
  271. data/lib/trycourier/users/preferences/types/user_preferences_list_response.rb +64 -0
  272. data/lib/trycourier/users/preferences/types/user_preferences_update_response.rb +49 -0
  273. data/lib/trycourier/users/tenants/client.rb +267 -0
  274. data/lib/trycourier/users/tenants/types/add_user_to_single_tenants_params_profile.rb +76 -0
  275. data/lib/trycourier/users/tenants/types/list_tenants_for_user_response.rb +90 -0
  276. data/lib/trycourier/users/tokens/client.rb +264 -0
  277. data/lib/trycourier/users/tokens/types/delete_user_token_opts.rb +54 -0
  278. data/lib/trycourier/users/tokens/types/device.rb +83 -0
  279. data/lib/trycourier/users/tokens/types/expiry_date.rb +50 -0
  280. data/lib/trycourier/users/tokens/types/get_all_tokens_response.rb +11 -0
  281. data/lib/trycourier/users/tokens/types/get_user_token_opts.rb +54 -0
  282. data/lib/trycourier/users/tokens/types/get_user_token_response.rb +116 -0
  283. data/lib/trycourier/users/tokens/types/get_user_tokens_opts.rb +49 -0
  284. data/lib/trycourier/users/tokens/types/patch_op.rb +16 -0
  285. data/lib/trycourier/users/tokens/types/patch_operation.rb +59 -0
  286. data/lib/trycourier/users/tokens/types/patch_user_token_opts.rb +53 -0
  287. data/lib/trycourier/users/tokens/types/provider_key.rb +14 -0
  288. data/lib/trycourier/users/tokens/types/put_user_token_opts.rb +60 -0
  289. data/lib/trycourier/users/tokens/types/put_user_tokens_opts.rb +58 -0
  290. data/lib/trycourier/users/tokens/types/token_status.rb +14 -0
  291. data/lib/trycourier/users/tokens/types/tracking.rb +64 -0
  292. data/lib/trycourier/users/tokens/types/user_token.rb +102 -0
  293. data/lib/trycourier.rb +114 -138
  294. data/lib/types_export.rb +273 -0
  295. metadata +362 -50
  296. data/.github/ISSUE_TEMPLATE.md +0 -17
  297. data/.github/PULL_REQUEST_TEMPLATE.md +0 -27
  298. data/.github/workflows/gem-push.yml +0 -51
  299. data/.gitignore +0 -67
  300. data/.rspec +0 -3
  301. data/CHANGELOG.md +0 -126
  302. data/CONTRIBUTING.md +0 -28
  303. data/Gemfile +0 -8
  304. data/Gemfile.lock +0 -72
  305. data/LICENSE +0 -21
  306. data/README.md +0 -610
  307. data/Rakefile +0 -7
  308. data/bin/console +0 -14
  309. data/bin/setup +0 -8
  310. data/lib/trycourier/accounts.rb +0 -43
  311. data/lib/trycourier/audiences.rb +0 -45
  312. data/lib/trycourier/audit_events.rb +0 -27
  313. data/lib/trycourier/auth_tokens.rb +0 -23
  314. data/lib/trycourier/automations.rb +0 -67
  315. data/lib/trycourier/brands.rb +0 -70
  316. data/lib/trycourier/bulk.rb +0 -79
  317. data/lib/trycourier/events.rb +0 -35
  318. data/lib/trycourier/exceptions.rb +0 -39
  319. data/lib/trycourier/lists.rb +0 -109
  320. data/lib/trycourier/messages.rb +0 -57
  321. data/lib/trycourier/profiles.rb +0 -64
  322. data/lib/trycourier/session.rb +0 -80
  323. data/lib/trycourier/version.rb +0 -3
  324. data/trycourier.gemspec +0 -32
@@ -0,0 +1,92 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "actor"
4
+ require_relative "target"
5
+ require "json"
6
+
7
+ module Courier
8
+ class AuditEvents
9
+ class AuditEvent
10
+ attr_reader :actor, :target, :audit_event_id, :source, :timestamp, :type, :additional_properties
11
+
12
+ # @param actor [AuditEvents::Actor]
13
+ # @param target [AuditEvents::Target]
14
+ # @param audit_event_id [String]
15
+ # @param source [String]
16
+ # @param timestamp [String]
17
+ # @param type [String]
18
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
19
+ # @return [AuditEvents::AuditEvent]
20
+ def initialize(audit_event_id:, source:, timestamp:, type:, actor: nil, target: nil, additional_properties: nil)
21
+ # @type [AuditEvents::Actor]
22
+ @actor = actor
23
+ # @type [AuditEvents::Target]
24
+ @target = target
25
+ # @type [String]
26
+ @audit_event_id = audit_event_id
27
+ # @type [String]
28
+ @source = source
29
+ # @type [String]
30
+ @timestamp = timestamp
31
+ # @type [String]
32
+ @type = type
33
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
34
+ @additional_properties = additional_properties
35
+ end
36
+
37
+ # Deserialize a JSON object to an instance of AuditEvent
38
+ #
39
+ # @param json_object [JSON]
40
+ # @return [AuditEvents::AuditEvent]
41
+ def self.from_json(json_object:)
42
+ struct = JSON.parse(json_object, object_class: OpenStruct)
43
+ parsed_json = JSON.parse(json_object)
44
+ if parsed_json["actor"].nil?
45
+ actor = nil
46
+ else
47
+ actor = parsed_json["actor"].to_json
48
+ actor = AuditEvents::Actor.from_json(json_object: actor)
49
+ end
50
+ if parsed_json["target"].nil?
51
+ target = nil
52
+ else
53
+ target = parsed_json["target"].to_json
54
+ target = AuditEvents::Target.from_json(json_object: target)
55
+ end
56
+ audit_event_id = struct.auditEventId
57
+ source = struct.source
58
+ timestamp = struct.timestamp
59
+ type = struct.type
60
+ new(actor: actor, target: target, audit_event_id: audit_event_id, source: source, timestamp: timestamp,
61
+ type: type, additional_properties: struct)
62
+ end
63
+
64
+ # Serialize an instance of AuditEvent to a JSON object
65
+ #
66
+ # @return [JSON]
67
+ def to_json(*_args)
68
+ {
69
+ "actor": @actor,
70
+ "target": @target,
71
+ "auditEventId": @audit_event_id,
72
+ "source": @source,
73
+ "timestamp": @timestamp,
74
+ "type": @type
75
+ }.to_json
76
+ end
77
+
78
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
79
+ #
80
+ # @param obj [Object]
81
+ # @return [Void]
82
+ def self.validate_raw(obj:)
83
+ obj.actor.nil? || AuditEvents::Actor.validate_raw(obj: obj.actor)
84
+ obj.target.nil? || AuditEvents::Target.validate_raw(obj: obj.target)
85
+ obj.audit_event_id.is_a?(String) != false || raise("Passed value for field obj.audit_event_id is not the expected type, validation failed.")
86
+ obj.source.is_a?(String) != false || raise("Passed value for field obj.source is not the expected type, validation failed.")
87
+ obj.timestamp.is_a?(String) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
88
+ obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
89
+ end
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class AuditEvents
7
+ class GetAuditEventParams
8
+ attr_reader :audit_event_id, :additional_properties
9
+
10
+ # @param audit_event_id [String]
11
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
12
+ # @return [AuditEvents::GetAuditEventParams]
13
+ def initialize(audit_event_id:, additional_properties: nil)
14
+ # @type [String]
15
+ @audit_event_id = audit_event_id
16
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
17
+ @additional_properties = additional_properties
18
+ end
19
+
20
+ # Deserialize a JSON object to an instance of GetAuditEventParams
21
+ #
22
+ # @param json_object [JSON]
23
+ # @return [AuditEvents::GetAuditEventParams]
24
+ def self.from_json(json_object:)
25
+ struct = JSON.parse(json_object, object_class: OpenStruct)
26
+ JSON.parse(json_object)
27
+ audit_event_id = struct.auditEventId
28
+ new(audit_event_id: audit_event_id, additional_properties: struct)
29
+ end
30
+
31
+ # Serialize an instance of GetAuditEventParams to a JSON object
32
+ #
33
+ # @return [JSON]
34
+ def to_json(*_args)
35
+ { "auditEventId": @audit_event_id }.to_json
36
+ end
37
+
38
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
39
+ #
40
+ # @param obj [Object]
41
+ # @return [Void]
42
+ def self.validate_raw(obj:)
43
+ obj.audit_event_id.is_a?(String) != false || raise("Passed value for field obj.audit_event_id is not the expected type, validation failed.")
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class AuditEvents
7
+ class ListAuditEventsParams
8
+ attr_reader :cursor, :additional_properties
9
+
10
+ # @param cursor [String]
11
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
12
+ # @return [AuditEvents::ListAuditEventsParams]
13
+ def initialize(cursor: nil, additional_properties: nil)
14
+ # @type [String]
15
+ @cursor = cursor
16
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
17
+ @additional_properties = additional_properties
18
+ end
19
+
20
+ # Deserialize a JSON object to an instance of ListAuditEventsParams
21
+ #
22
+ # @param json_object [JSON]
23
+ # @return [AuditEvents::ListAuditEventsParams]
24
+ def self.from_json(json_object:)
25
+ struct = JSON.parse(json_object, object_class: OpenStruct)
26
+ JSON.parse(json_object)
27
+ cursor = struct.cursor
28
+ new(cursor: cursor, additional_properties: struct)
29
+ end
30
+
31
+ # Serialize an instance of ListAuditEventsParams to a JSON object
32
+ #
33
+ # @return [JSON]
34
+ def to_json(*_args)
35
+ { "cursor": @cursor }.to_json
36
+ end
37
+
38
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
39
+ #
40
+ # @param obj [Object]
41
+ # @return [Void]
42
+ def self.validate_raw(obj:)
43
+ obj.cursor&.is_a?(String) != false || raise("Passed value for field obj.cursor is not the expected type, validation failed.")
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../commons/types/paging"
4
+ require_relative "audit_event"
5
+ require "json"
6
+
7
+ module Courier
8
+ class AuditEvents
9
+ class ListAuditEventsResponse
10
+ attr_reader :paging, :results, :additional_properties
11
+
12
+ # @param paging [Commons::Paging]
13
+ # @param results [Array<AuditEvents::AuditEvent>]
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [AuditEvents::ListAuditEventsResponse]
16
+ def initialize(paging:, results:, additional_properties: nil)
17
+ # @type [Commons::Paging]
18
+ @paging = paging
19
+ # @type [Array<AuditEvents::AuditEvent>]
20
+ @results = results
21
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
22
+ @additional_properties = additional_properties
23
+ end
24
+
25
+ # Deserialize a JSON object to an instance of ListAuditEventsResponse
26
+ #
27
+ # @param json_object [JSON]
28
+ # @return [AuditEvents::ListAuditEventsResponse]
29
+ def self.from_json(json_object:)
30
+ struct = JSON.parse(json_object, object_class: OpenStruct)
31
+ parsed_json = JSON.parse(json_object)
32
+ if parsed_json["paging"].nil?
33
+ paging = nil
34
+ else
35
+ paging = parsed_json["paging"].to_json
36
+ paging = Commons::Paging.from_json(json_object: paging)
37
+ end
38
+ results = parsed_json["results"]&.map do |v|
39
+ v = v.to_json
40
+ AuditEvents::AuditEvent.from_json(json_object: v)
41
+ end
42
+ new(paging: paging, results: results, additional_properties: struct)
43
+ end
44
+
45
+ # Serialize an instance of ListAuditEventsResponse to a JSON object
46
+ #
47
+ # @return [JSON]
48
+ def to_json(*_args)
49
+ { "paging": @paging, "results": @results }.to_json
50
+ end
51
+
52
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
53
+ #
54
+ # @param obj [Object]
55
+ # @return [Void]
56
+ def self.validate_raw(obj:)
57
+ Commons::Paging.validate_raw(obj: obj.paging)
58
+ obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class AuditEvents
7
+ class Target
8
+ attr_reader :id, :email, :additional_properties
9
+
10
+ # @param id [String]
11
+ # @param email [String]
12
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
13
+ # @return [AuditEvents::Target]
14
+ def initialize(id: nil, email: nil, additional_properties: nil)
15
+ # @type [String]
16
+ @id = id
17
+ # @type [String]
18
+ @email = email
19
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
20
+ @additional_properties = additional_properties
21
+ end
22
+
23
+ # Deserialize a JSON object to an instance of Target
24
+ #
25
+ # @param json_object [JSON]
26
+ # @return [AuditEvents::Target]
27
+ def self.from_json(json_object:)
28
+ struct = JSON.parse(json_object, object_class: OpenStruct)
29
+ JSON.parse(json_object)
30
+ id = struct.id
31
+ email = struct.email
32
+ new(id: id, email: email, additional_properties: struct)
33
+ end
34
+
35
+ # Serialize an instance of Target to a JSON object
36
+ #
37
+ # @return [JSON]
38
+ def to_json(*_args)
39
+ { "id": @id, "email": @email }.to_json
40
+ end
41
+
42
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
43
+ #
44
+ # @param obj [Object]
45
+ # @return [Void]
46
+ def self.validate_raw(obj:)
47
+ obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
48
+ obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
49
+ end
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../requests"
4
+ require_relative "types/issue_token_response"
5
+ require "async"
6
+
7
+ module Courier
8
+ class AuthTokensClient
9
+ attr_reader :request_client
10
+
11
+ # @param request_client [RequestClient]
12
+ # @return [AuthTokensClient]
13
+ def initialize(request_client:)
14
+ # @type [RequestClient]
15
+ @request_client = request_client
16
+ end
17
+
18
+ # Returns a new access token.
19
+ #
20
+ # @param scope [String]
21
+ # @param expires_in [String]
22
+ # @param request_options [IdempotencyRequestOptions]
23
+ # @return [AuthTokens::IssueTokenResponse]
24
+ def issue_token(scope:, expires_in:, request_options: nil)
25
+ response = @request_client.conn.post("/auth/issue-token") do |req|
26
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
27
+ unless request_options&.authorization_token.nil?
28
+ req.headers["Authorization"] =
29
+ request_options.authorization_token
30
+ end
31
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
32
+ unless request_options&.idempotency_expiry.nil?
33
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
34
+ end
35
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
36
+ req.body = {
37
+ **(request_options&.additional_body_parameters || {}),
38
+ scope: scope,
39
+ expires_in: expires_in
40
+ }.compact
41
+ end
42
+ AuthTokens::IssueTokenResponse.from_json(json_object: response.body)
43
+ end
44
+ end
45
+
46
+ class AsyncAuthTokensClient
47
+ attr_reader :request_client
48
+
49
+ # @param request_client [AsyncRequestClient]
50
+ # @return [AsyncAuthTokensClient]
51
+ def initialize(request_client:)
52
+ # @type [AsyncRequestClient]
53
+ @request_client = request_client
54
+ end
55
+
56
+ # Returns a new access token.
57
+ #
58
+ # @param scope [String]
59
+ # @param expires_in [String]
60
+ # @param request_options [IdempotencyRequestOptions]
61
+ # @return [AuthTokens::IssueTokenResponse]
62
+ def issue_token(scope:, expires_in:, request_options: nil)
63
+ Async do
64
+ response = @request_client.conn.post("/auth/issue-token") do |req|
65
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
66
+ unless request_options&.authorization_token.nil?
67
+ req.headers["Authorization"] =
68
+ request_options.authorization_token
69
+ end
70
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
71
+ unless request_options&.idempotency_expiry.nil?
72
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
73
+ end
74
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
75
+ req.body = {
76
+ **(request_options&.additional_body_parameters || {}),
77
+ scope: scope,
78
+ expires_in: expires_in
79
+ }.compact
80
+ end
81
+ AuthTokens::IssueTokenResponse.from_json(json_object: response.body)
82
+ end
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class AuthTokens
7
+ class IssueTokenResponse
8
+ attr_reader :token, :additional_properties
9
+
10
+ # @param token [String]
11
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
12
+ # @return [AuthTokens::IssueTokenResponse]
13
+ def initialize(token: nil, additional_properties: nil)
14
+ # @type [String]
15
+ @token = token
16
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
17
+ @additional_properties = additional_properties
18
+ end
19
+
20
+ # Deserialize a JSON object to an instance of IssueTokenResponse
21
+ #
22
+ # @param json_object [JSON]
23
+ # @return [AuthTokens::IssueTokenResponse]
24
+ def self.from_json(json_object:)
25
+ struct = JSON.parse(json_object, object_class: OpenStruct)
26
+ JSON.parse(json_object)
27
+ token = struct.token
28
+ new(token: token, additional_properties: struct)
29
+ end
30
+
31
+ # Serialize an instance of IssueTokenResponse to a JSON object
32
+ #
33
+ # @return [JSON]
34
+ def to_json(*_args)
35
+ { "token": @token }.to_json
36
+ end
37
+
38
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
39
+ #
40
+ # @param obj [Object]
41
+ # @return [Void]
42
+ def self.validate_raw(obj:)
43
+ obj.token&.is_a?(String) != false || raise("Passed value for field obj.token is not the expected type, validation failed.")
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,151 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../requests"
4
+ require_relative "types/automation_invoke_params"
5
+ require_relative "types/automation_invoke_response"
6
+ require_relative "types/automation_ad_hoc_invoke_params"
7
+ require "async"
8
+
9
+ module Courier
10
+ class AutomationsClient
11
+ attr_reader :request_client
12
+
13
+ # @param request_client [RequestClient]
14
+ # @return [AutomationsClient]
15
+ def initialize(request_client:)
16
+ # @type [RequestClient]
17
+ @request_client = request_client
18
+ end
19
+
20
+ # Invoke an automation run from an automation template.
21
+ #
22
+ # @param template_id [String] A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias.
23
+ # @param request [Hash] Request of type Automations::AutomationInvokeParams, as a Hash
24
+ # * :brand (String)
25
+ # * :data (Hash{String => String})
26
+ # * :profile (Automations::PROFILE)
27
+ # * :recipient (String)
28
+ # * :template (String)
29
+ # @param request_options [IdempotencyRequestOptions]
30
+ # @return [Automations::AutomationInvokeResponse]
31
+ def invoke_automation_template(template_id:, request:, request_options: nil)
32
+ response = @request_client.conn.post("/automations/#{template_id}/invoke") do |req|
33
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
34
+ unless request_options&.authorization_token.nil?
35
+ req.headers["Authorization"] =
36
+ request_options.authorization_token
37
+ end
38
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
39
+ unless request_options&.idempotency_expiry.nil?
40
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
41
+ end
42
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
43
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
44
+ end
45
+ Automations::AutomationInvokeResponse.from_json(json_object: response.body)
46
+ end
47
+
48
+ # Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
49
+ #
50
+ # @param request [Hash] Request of type Automations::AutomationAdHocInvokeParams, as a Hash
51
+ # * :automation (Hash)
52
+ # * :cancelation_token (String)
53
+ # * :steps (Array<Automations::AutomationStepOption>)
54
+ # * :brand (String)
55
+ # * :data (Hash{String => String})
56
+ # * :profile (Automations::PROFILE)
57
+ # * :recipient (String)
58
+ # * :template (String)
59
+ # @param request_options [IdempotencyRequestOptions]
60
+ # @return [Automations::AutomationInvokeResponse]
61
+ def invoke_ad_hoc_automation(request:, request_options: nil)
62
+ response = @request_client.conn.post("/automations/invoke") do |req|
63
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
64
+ unless request_options&.authorization_token.nil?
65
+ req.headers["Authorization"] =
66
+ request_options.authorization_token
67
+ end
68
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
69
+ unless request_options&.idempotency_expiry.nil?
70
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
71
+ end
72
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
73
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
74
+ end
75
+ Automations::AutomationInvokeResponse.from_json(json_object: response.body)
76
+ end
77
+ end
78
+
79
+ class AsyncAutomationsClient
80
+ attr_reader :request_client
81
+
82
+ # @param request_client [AsyncRequestClient]
83
+ # @return [AsyncAutomationsClient]
84
+ def initialize(request_client:)
85
+ # @type [AsyncRequestClient]
86
+ @request_client = request_client
87
+ end
88
+
89
+ # Invoke an automation run from an automation template.
90
+ #
91
+ # @param template_id [String] A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias.
92
+ # @param request [Hash] Request of type Automations::AutomationInvokeParams, as a Hash
93
+ # * :brand (String)
94
+ # * :data (Hash{String => String})
95
+ # * :profile (Automations::PROFILE)
96
+ # * :recipient (String)
97
+ # * :template (String)
98
+ # @param request_options [IdempotencyRequestOptions]
99
+ # @return [Automations::AutomationInvokeResponse]
100
+ def invoke_automation_template(template_id:, request:, request_options: nil)
101
+ Async do
102
+ response = @request_client.conn.post("/automations/#{template_id}/invoke") do |req|
103
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
104
+ unless request_options&.authorization_token.nil?
105
+ req.headers["Authorization"] =
106
+ request_options.authorization_token
107
+ end
108
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
109
+ unless request_options&.idempotency_expiry.nil?
110
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
111
+ end
112
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
113
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
114
+ end
115
+ Automations::AutomationInvokeResponse.from_json(json_object: response.body)
116
+ end
117
+ end
118
+
119
+ # Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
120
+ #
121
+ # @param request [Hash] Request of type Automations::AutomationAdHocInvokeParams, as a Hash
122
+ # * :automation (Hash)
123
+ # * :cancelation_token (String)
124
+ # * :steps (Array<Automations::AutomationStepOption>)
125
+ # * :brand (String)
126
+ # * :data (Hash{String => String})
127
+ # * :profile (Automations::PROFILE)
128
+ # * :recipient (String)
129
+ # * :template (String)
130
+ # @param request_options [IdempotencyRequestOptions]
131
+ # @return [Automations::AutomationInvokeResponse]
132
+ def invoke_ad_hoc_automation(request:, request_options: nil)
133
+ Async do
134
+ response = @request_client.conn.post("/automations/invoke") do |req|
135
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
136
+ unless request_options&.authorization_token.nil?
137
+ req.headers["Authorization"] =
138
+ request_options.authorization_token
139
+ end
140
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
141
+ unless request_options&.idempotency_expiry.nil?
142
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
143
+ end
144
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
145
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
146
+ end
147
+ Automations::AutomationInvokeResponse.from_json(json_object: response.body)
148
+ end
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "automation_step_option"
4
+ require "json"
5
+
6
+ module Courier
7
+ class Automations
8
+ class Automation
9
+ attr_reader :cancelation_token, :steps, :additional_properties
10
+
11
+ # @param cancelation_token [String]
12
+ # @param steps [Array<Automations::AutomationStepOption>]
13
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
14
+ # @return [Automations::Automation]
15
+ def initialize(steps:, cancelation_token: nil, additional_properties: nil)
16
+ # @type [String]
17
+ @cancelation_token = cancelation_token
18
+ # @type [Array<Automations::AutomationStepOption>]
19
+ @steps = steps
20
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
21
+ @additional_properties = additional_properties
22
+ end
23
+
24
+ # Deserialize a JSON object to an instance of Automation
25
+ #
26
+ # @param json_object [JSON]
27
+ # @return [Automations::Automation]
28
+ def self.from_json(json_object:)
29
+ struct = JSON.parse(json_object, object_class: OpenStruct)
30
+ parsed_json = JSON.parse(json_object)
31
+ cancelation_token = struct.cancelation_token
32
+ steps = parsed_json["steps"]&.map do |v|
33
+ v = v.to_json
34
+ Automations::AutomationStepOption.from_json(json_object: v)
35
+ end
36
+ new(cancelation_token: cancelation_token, steps: steps, additional_properties: struct)
37
+ end
38
+
39
+ # Serialize an instance of Automation to a JSON object
40
+ #
41
+ # @return [JSON]
42
+ def to_json(*_args)
43
+ { "cancelation_token": @cancelation_token, "steps": @steps }.to_json
44
+ end
45
+
46
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
47
+ #
48
+ # @param obj [Object]
49
+ # @return [Void]
50
+ def self.validate_raw(obj:)
51
+ obj.cancelation_token&.is_a?(String) != false || raise("Passed value for field obj.cancelation_token is not the expected type, validation failed.")
52
+ obj.steps.is_a?(Array) != false || raise("Passed value for field obj.steps is not the expected type, validation failed.")
53
+ end
54
+ end
55
+ end
56
+ end