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,116 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "i_alignment"
4
+ require_relative "i_action_button_style"
5
+ require_relative "locales"
6
+ require "json"
7
+
8
+ module Courier
9
+ class Send
10
+ # Allows the user to execute an action. Can be a button or a link.
11
+ class ElementalActionNode
12
+ attr_reader :content, :href, :action_id, :align, :background_color, :style, :locales, :channels, :ref, :if_,
13
+ :loop, :additional_properties
14
+
15
+ # @param content [String] The text content of the action shown to the user.
16
+ # @param href [String] The target URL of the action.
17
+ # @param action_id [String] A unique id used to identify the action when it is executed.
18
+ # @param align [Send::IAlignment] The alignment of the action button. Defaults to "center".
19
+ # @param background_color [String] The background color of the action button.
20
+ # @param style [Send::IActionButtonStyle] Defaults to `button`.
21
+ # @param locales [Send::LOCALES] Region specific content. See [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/) for more details.
22
+ # @param channels [Array<String>]
23
+ # @param ref [String]
24
+ # @param if_ [String]
25
+ # @param loop [String]
26
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
27
+ # @return [Send::ElementalActionNode]
28
+ def initialize(content:, href:, locales:, action_id: nil, align: nil, background_color: nil, style: nil,
29
+ channels: nil, ref: nil, if_: nil, loop: nil, additional_properties: nil)
30
+ # @type [String] The text content of the action shown to the user.
31
+ @content = content
32
+ # @type [String] The target URL of the action.
33
+ @href = href
34
+ # @type [String] A unique id used to identify the action when it is executed.
35
+ @action_id = action_id
36
+ # @type [Send::IAlignment] The alignment of the action button. Defaults to "center".
37
+ @align = align
38
+ # @type [String] The background color of the action button.
39
+ @background_color = background_color
40
+ # @type [Send::IActionButtonStyle] Defaults to `button`.
41
+ @style = style
42
+ # @type [Send::LOCALES] Region specific content. See [locales docs](https://www.courier.com/docs/platform/content/elemental/locales/) for more details.
43
+ @locales = locales
44
+ # @type [Array<String>]
45
+ @channels = channels
46
+ # @type [String]
47
+ @ref = ref
48
+ # @type [String]
49
+ @if_ = if_
50
+ # @type [String]
51
+ @loop = loop
52
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
53
+ @additional_properties = additional_properties
54
+ end
55
+
56
+ # Deserialize a JSON object to an instance of ElementalActionNode
57
+ #
58
+ # @param json_object [JSON]
59
+ # @return [Send::ElementalActionNode]
60
+ def self.from_json(json_object:)
61
+ struct = JSON.parse(json_object, object_class: OpenStruct)
62
+ JSON.parse(json_object)
63
+ content = struct.content
64
+ href = struct.href
65
+ action_id = struct.action_id
66
+ align = struct.align
67
+ background_color = struct.background_color
68
+ style = struct.style
69
+ locales = struct.locales
70
+ channels = struct.channels
71
+ ref = struct.ref
72
+ if_ = struct.if
73
+ loop = struct.loop
74
+ new(content: content, href: href, action_id: action_id, align: align, background_color: background_color,
75
+ style: style, locales: locales, channels: channels, ref: ref, if_: if_, loop: loop, additional_properties: struct)
76
+ end
77
+
78
+ # Serialize an instance of ElementalActionNode to a JSON object
79
+ #
80
+ # @return [JSON]
81
+ def to_json(*_args)
82
+ {
83
+ "content": @content,
84
+ "href": @href,
85
+ "action_id": @action_id,
86
+ "align": @align,
87
+ "background_color": @background_color,
88
+ "style": @style,
89
+ "locales": @locales,
90
+ "channels": @channels,
91
+ "ref": @ref,
92
+ "if": @if_,
93
+ "loop": @loop
94
+ }.to_json
95
+ end
96
+
97
+ # 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.
98
+ #
99
+ # @param obj [Object]
100
+ # @return [Void]
101
+ def self.validate_raw(obj:)
102
+ obj.content.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
103
+ obj.href.is_a?(String) != false || raise("Passed value for field obj.href is not the expected type, validation failed.")
104
+ obj.action_id&.is_a?(String) != false || raise("Passed value for field obj.action_id is not the expected type, validation failed.")
105
+ obj.align&.is_a?(Send::IAlignment) != false || raise("Passed value for field obj.align is not the expected type, validation failed.")
106
+ obj.background_color&.is_a?(String) != false || raise("Passed value for field obj.background_color is not the expected type, validation failed.")
107
+ obj.style&.is_a?(Send::IActionButtonStyle) != false || raise("Passed value for field obj.style is not the expected type, validation failed.")
108
+ obj.locales.is_a?(Hash) != false || raise("Passed value for field obj.locales is not the expected type, validation failed.")
109
+ obj.channels&.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
110
+ obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
111
+ obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
112
+ obj.loop&.is_a?(String) != false || raise("Passed value for field obj.loop is not the expected type, validation failed.")
113
+ end
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class Send
7
+ class ElementalBaseNode
8
+ attr_reader :channels, :ref, :if_, :loop, :additional_properties
9
+
10
+ # @param channels [Array<String>]
11
+ # @param ref [String]
12
+ # @param if_ [String]
13
+ # @param loop [String]
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [Send::ElementalBaseNode]
16
+ def initialize(channels: nil, ref: nil, if_: nil, loop: nil, additional_properties: nil)
17
+ # @type [Array<String>]
18
+ @channels = channels
19
+ # @type [String]
20
+ @ref = ref
21
+ # @type [String]
22
+ @if_ = if_
23
+ # @type [String]
24
+ @loop = loop
25
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
26
+ @additional_properties = additional_properties
27
+ end
28
+
29
+ # Deserialize a JSON object to an instance of ElementalBaseNode
30
+ #
31
+ # @param json_object [JSON]
32
+ # @return [Send::ElementalBaseNode]
33
+ def self.from_json(json_object:)
34
+ struct = JSON.parse(json_object, object_class: OpenStruct)
35
+ JSON.parse(json_object)
36
+ channels = struct.channels
37
+ ref = struct.ref
38
+ if_ = struct.if
39
+ loop = struct.loop
40
+ new(channels: channels, ref: ref, if_: if_, loop: loop, additional_properties: struct)
41
+ end
42
+
43
+ # Serialize an instance of ElementalBaseNode to a JSON object
44
+ #
45
+ # @return [JSON]
46
+ def to_json(*_args)
47
+ { "channels": @channels, "ref": @ref, "if": @if_, "loop": @loop }.to_json
48
+ end
49
+
50
+ # 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.
51
+ #
52
+ # @param obj [Object]
53
+ # @return [Void]
54
+ def self.validate_raw(obj:)
55
+ obj.channels&.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
56
+ obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
57
+ obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
58
+ obj.loop&.is_a?(String) != false || raise("Passed value for field obj.loop is not the expected type, validation failed.")
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,105 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "elemental_node"
4
+ require "json"
5
+
6
+ module Courier
7
+ class Send
8
+ # The channel element allows a notification to be customized based on which channel it is sent through.
9
+ # For example, you may want to display a detailed message when the notification is sent through email,
10
+ # and a more concise message in a push notification. Channel elements are only valid as top-level
11
+ # elements; you cannot nest channel elements. If there is a channel element specified at the top-level
12
+ # of the document, all sibling elements must be channel elements.
13
+ # Note: As an alternative, most elements support a `channel` property. Which allows you to selectively
14
+ # display an individual element on a per channel basis. See the
15
+ # [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/) for more details.
16
+ class ElementalChannelNode
17
+ attr_reader :channel, :elements, :raw, :channels, :ref, :if_, :loop, :additional_properties
18
+
19
+ # @param channel [String] The channel the contents of this element should be applied to. Can be `email`,
20
+ # `push`, `direct_message`, `sms` or a provider such as slack
21
+ # @param elements [Array<Send::ElementalNode>] An array of elements to apply to the channel. If `raw` has not been
22
+ # specified, `elements` is `required`.
23
+ # @param raw [Hash{String => String}] Raw data to apply to the channel. If `elements` has not been
24
+ # specified, `raw` is `required`.
25
+ # @param channels [Array<String>]
26
+ # @param ref [String]
27
+ # @param if_ [String]
28
+ # @param loop [String]
29
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
+ # @return [Send::ElementalChannelNode]
31
+ def initialize(channel:, elements: nil, raw: nil, channels: nil, ref: nil, if_: nil, loop: nil,
32
+ additional_properties: nil)
33
+ # @type [String] The channel the contents of this element should be applied to. Can be `email`,
34
+ # `push`, `direct_message`, `sms` or a provider such as slack
35
+ @channel = channel
36
+ # @type [Array<Send::ElementalNode>] An array of elements to apply to the channel. If `raw` has not been
37
+ # specified, `elements` is `required`.
38
+ @elements = elements
39
+ # @type [Hash{String => String}] Raw data to apply to the channel. If `elements` has not been
40
+ # specified, `raw` is `required`.
41
+ @raw = raw
42
+ # @type [Array<String>]
43
+ @channels = channels
44
+ # @type [String]
45
+ @ref = ref
46
+ # @type [String]
47
+ @if_ = if_
48
+ # @type [String]
49
+ @loop = loop
50
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
51
+ @additional_properties = additional_properties
52
+ end
53
+
54
+ # Deserialize a JSON object to an instance of ElementalChannelNode
55
+ #
56
+ # @param json_object [JSON]
57
+ # @return [Send::ElementalChannelNode]
58
+ def self.from_json(json_object:)
59
+ struct = JSON.parse(json_object, object_class: OpenStruct)
60
+ parsed_json = JSON.parse(json_object)
61
+ channel = struct.channel
62
+ elements = parsed_json["elements"]&.map do |v|
63
+ v = v.to_json
64
+ Send::ElementalNode.from_json(json_object: v)
65
+ end
66
+ raw = struct.raw
67
+ channels = struct.channels
68
+ ref = struct.ref
69
+ if_ = struct.if
70
+ loop = struct.loop
71
+ new(channel: channel, elements: elements, raw: raw, channels: channels, ref: ref, if_: if_, loop: loop,
72
+ additional_properties: struct)
73
+ end
74
+
75
+ # Serialize an instance of ElementalChannelNode to a JSON object
76
+ #
77
+ # @return [JSON]
78
+ def to_json(*_args)
79
+ {
80
+ "channel": @channel,
81
+ "elements": @elements,
82
+ "raw": @raw,
83
+ "channels": @channels,
84
+ "ref": @ref,
85
+ "if": @if_,
86
+ "loop": @loop
87
+ }.to_json
88
+ end
89
+
90
+ # 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.
91
+ #
92
+ # @param obj [Object]
93
+ # @return [Void]
94
+ def self.validate_raw(obj:)
95
+ obj.channel.is_a?(String) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
96
+ obj.elements&.is_a?(Array) != false || raise("Passed value for field obj.elements is not the expected type, validation failed.")
97
+ obj.raw&.is_a?(Hash) != false || raise("Passed value for field obj.raw is not the expected type, validation failed.")
98
+ obj.channels&.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
99
+ obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
100
+ obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
101
+ obj.loop&.is_a?(String) != false || raise("Passed value for field obj.loop is not the expected type, validation failed.")
102
+ end
103
+ end
104
+ end
105
+ end
@@ -0,0 +1,61 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "elemental_node"
4
+ require "json"
5
+
6
+ module Courier
7
+ class Send
8
+ class ElementalContent
9
+ attr_reader :version, :brand, :elements, :additional_properties
10
+
11
+ # @param version [String] For example, "2022-01-01"
12
+ # @param brand [Object]
13
+ # @param elements [Array<Send::ElementalNode>]
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [Send::ElementalContent]
16
+ def initialize(version:, elements:, brand: nil, additional_properties: nil)
17
+ # @type [String] For example, "2022-01-01"
18
+ @version = version
19
+ # @type [Object]
20
+ @brand = brand
21
+ # @type [Array<Send::ElementalNode>]
22
+ @elements = elements
23
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
24
+ @additional_properties = additional_properties
25
+ end
26
+
27
+ # Deserialize a JSON object to an instance of ElementalContent
28
+ #
29
+ # @param json_object [JSON]
30
+ # @return [Send::ElementalContent]
31
+ def self.from_json(json_object:)
32
+ struct = JSON.parse(json_object, object_class: OpenStruct)
33
+ parsed_json = JSON.parse(json_object)
34
+ version = struct.version
35
+ brand = struct.brand
36
+ elements = parsed_json["elements"]&.map do |v|
37
+ v = v.to_json
38
+ Send::ElementalNode.from_json(json_object: v)
39
+ end
40
+ new(version: version, brand: brand, elements: elements, additional_properties: struct)
41
+ end
42
+
43
+ # Serialize an instance of ElementalContent to a JSON object
44
+ #
45
+ # @return [JSON]
46
+ def to_json(*_args)
47
+ { "version": @version, "brand": @brand, "elements": @elements }.to_json
48
+ end
49
+
50
+ # 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.
51
+ #
52
+ # @param obj [Object]
53
+ # @return [Void]
54
+ def self.validate_raw(obj:)
55
+ obj.version.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
56
+ obj.brand&.is_a?(Object) != false || raise("Passed value for field obj.brand is not the expected type, validation failed.")
57
+ obj.elements.is_a?(Array) != false || raise("Passed value for field obj.elements is not the expected type, validation failed.")
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class Send
7
+ # Syntatic Sugar to provide a fast shorthand for Courier Elemental Blocks.
8
+ class ElementalContentSugar
9
+ attr_reader :title, :body, :additional_properties
10
+
11
+ # @param title [String] The title to be displayed by supported channels i.e. push, email (as subject)
12
+ # @param body [String] The text content displayed in the notification.
13
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
14
+ # @return [Send::ElementalContentSugar]
15
+ def initialize(title:, body:, additional_properties: nil)
16
+ # @type [String] The title to be displayed by supported channels i.e. push, email (as subject)
17
+ @title = title
18
+ # @type [String] The text content displayed in the notification.
19
+ @body = body
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 ElementalContentSugar
25
+ #
26
+ # @param json_object [JSON]
27
+ # @return [Send::ElementalContentSugar]
28
+ def self.from_json(json_object:)
29
+ struct = JSON.parse(json_object, object_class: OpenStruct)
30
+ JSON.parse(json_object)
31
+ title = struct.title
32
+ body = struct.body
33
+ new(title: title, body: body, additional_properties: struct)
34
+ end
35
+
36
+ # Serialize an instance of ElementalContentSugar to a JSON object
37
+ #
38
+ # @return [JSON]
39
+ def to_json(*_args)
40
+ { "title": @title, "body": @body }.to_json
41
+ end
42
+
43
+ # 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.
44
+ #
45
+ # @param obj [Object]
46
+ # @return [Void]
47
+ def self.validate_raw(obj:)
48
+ obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
49
+ obj.body.is_a?(String) != false || raise("Passed value for field obj.body is not the expected type, validation failed.")
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class Send
7
+ # Renders a dividing line between elements.
8
+ class ElementalDividerNode
9
+ attr_reader :color, :channels, :ref, :if_, :loop, :additional_properties
10
+
11
+ # @param color [String] The CSS color to render the line with. For example, `#fff`
12
+ # @param channels [Array<String>]
13
+ # @param ref [String]
14
+ # @param if_ [String]
15
+ # @param loop [String]
16
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
17
+ # @return [Send::ElementalDividerNode]
18
+ def initialize(color: nil, channels: nil, ref: nil, if_: nil, loop: nil, additional_properties: nil)
19
+ # @type [String] The CSS color to render the line with. For example, `#fff`
20
+ @color = color
21
+ # @type [Array<String>]
22
+ @channels = channels
23
+ # @type [String]
24
+ @ref = ref
25
+ # @type [String]
26
+ @if_ = if_
27
+ # @type [String]
28
+ @loop = loop
29
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
30
+ @additional_properties = additional_properties
31
+ end
32
+
33
+ # Deserialize a JSON object to an instance of ElementalDividerNode
34
+ #
35
+ # @param json_object [JSON]
36
+ # @return [Send::ElementalDividerNode]
37
+ def self.from_json(json_object:)
38
+ struct = JSON.parse(json_object, object_class: OpenStruct)
39
+ JSON.parse(json_object)
40
+ color = struct.color
41
+ channels = struct.channels
42
+ ref = struct.ref
43
+ if_ = struct.if
44
+ loop = struct.loop
45
+ new(color: color, channels: channels, ref: ref, if_: if_, loop: loop, additional_properties: struct)
46
+ end
47
+
48
+ # Serialize an instance of ElementalDividerNode to a JSON object
49
+ #
50
+ # @return [JSON]
51
+ def to_json(*_args)
52
+ { "color": @color, "channels": @channels, "ref": @ref, "if": @if_, "loop": @loop }.to_json
53
+ end
54
+
55
+ # 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.
56
+ #
57
+ # @param obj [Object]
58
+ # @return [Void]
59
+ def self.validate_raw(obj:)
60
+ obj.color&.is_a?(String) != false || raise("Passed value for field obj.color is not the expected type, validation failed.")
61
+ obj.channels&.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
62
+ obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
63
+ obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
64
+ obj.loop&.is_a?(String) != false || raise("Passed value for field obj.loop is not the expected type, validation failed.")
65
+ end
66
+ end
67
+ end
68
+ end
@@ -0,0 +1,72 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "elemental_node"
4
+ require "json"
5
+
6
+ module Courier
7
+ class Send
8
+ # Allows you to group elements together. This can be useful when used in combination with "if" or "loop". See [control flow docs](https://www.courier.com/docs/platform/content/elemental/control-flow/) for more details.
9
+ class ElementalGroupNode
10
+ attr_reader :elements, :channels, :ref, :if_, :loop, :additional_properties
11
+
12
+ # @param elements [Array<Send::ElementalNode>] Sub elements to render.
13
+ # @param channels [Array<String>]
14
+ # @param ref [String]
15
+ # @param if_ [String]
16
+ # @param loop [String]
17
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
18
+ # @return [Send::ElementalGroupNode]
19
+ def initialize(elements:, channels: nil, ref: nil, if_: nil, loop: nil, additional_properties: nil)
20
+ # @type [Array<Send::ElementalNode>] Sub elements to render.
21
+ @elements = elements
22
+ # @type [Array<String>]
23
+ @channels = channels
24
+ # @type [String]
25
+ @ref = ref
26
+ # @type [String]
27
+ @if_ = if_
28
+ # @type [String]
29
+ @loop = loop
30
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
31
+ @additional_properties = additional_properties
32
+ end
33
+
34
+ # Deserialize a JSON object to an instance of ElementalGroupNode
35
+ #
36
+ # @param json_object [JSON]
37
+ # @return [Send::ElementalGroupNode]
38
+ def self.from_json(json_object:)
39
+ struct = JSON.parse(json_object, object_class: OpenStruct)
40
+ parsed_json = JSON.parse(json_object)
41
+ elements = parsed_json["elements"]&.map do |v|
42
+ v = v.to_json
43
+ Send::ElementalNode.from_json(json_object: v)
44
+ end
45
+ channels = struct.channels
46
+ ref = struct.ref
47
+ if_ = struct.if
48
+ loop = struct.loop
49
+ new(elements: elements, channels: channels, ref: ref, if_: if_, loop: loop, additional_properties: struct)
50
+ end
51
+
52
+ # Serialize an instance of ElementalGroupNode to a JSON object
53
+ #
54
+ # @return [JSON]
55
+ def to_json(*_args)
56
+ { "elements": @elements, "channels": @channels, "ref": @ref, "if": @if_, "loop": @loop }.to_json
57
+ end
58
+
59
+ # 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.
60
+ #
61
+ # @param obj [Object]
62
+ # @return [Void]
63
+ def self.validate_raw(obj:)
64
+ obj.elements.is_a?(Array) != false || raise("Passed value for field obj.elements is not the expected type, validation failed.")
65
+ obj.channels&.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
66
+ obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
67
+ obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
68
+ obj.loop&.is_a?(String) != false || raise("Passed value for field obj.loop is not the expected type, validation failed.")
69
+ end
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,101 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "i_alignment"
4
+ require "json"
5
+
6
+ module Courier
7
+ class Send
8
+ # Used to embed an image into the notification.
9
+ class ElementalImageNode
10
+ attr_reader :src, :href, :align, :alt_text, :width, :channels, :ref, :if_, :loop, :additional_properties
11
+
12
+ # @param src [String] The source of the image.
13
+ # @param href [String] A URL to link to when the image is clicked.
14
+ # @param align [Send::IAlignment] The alignment of the image.
15
+ # @param alt_text [String] Alternate text for the image.
16
+ # @param width [String] CSS width properties to apply to the image. For example, 50px
17
+ # @param channels [Array<String>]
18
+ # @param ref [String]
19
+ # @param if_ [String]
20
+ # @param loop [String]
21
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
+ # @return [Send::ElementalImageNode]
23
+ def initialize(src:, href: nil, align: nil, alt_text: nil, width: nil, channels: nil, ref: nil, if_: nil,
24
+ loop: nil, additional_properties: nil)
25
+ # @type [String] The source of the image.
26
+ @src = src
27
+ # @type [String] A URL to link to when the image is clicked.
28
+ @href = href
29
+ # @type [Send::IAlignment] The alignment of the image.
30
+ @align = align
31
+ # @type [String] Alternate text for the image.
32
+ @alt_text = alt_text
33
+ # @type [String] CSS width properties to apply to the image. For example, 50px
34
+ @width = width
35
+ # @type [Array<String>]
36
+ @channels = channels
37
+ # @type [String]
38
+ @ref = ref
39
+ # @type [String]
40
+ @if_ = if_
41
+ # @type [String]
42
+ @loop = loop
43
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
44
+ @additional_properties = additional_properties
45
+ end
46
+
47
+ # Deserialize a JSON object to an instance of ElementalImageNode
48
+ #
49
+ # @param json_object [JSON]
50
+ # @return [Send::ElementalImageNode]
51
+ def self.from_json(json_object:)
52
+ struct = JSON.parse(json_object, object_class: OpenStruct)
53
+ JSON.parse(json_object)
54
+ src = struct.src
55
+ href = struct.href
56
+ align = struct.align
57
+ alt_text = struct.altText
58
+ width = struct.width
59
+ channels = struct.channels
60
+ ref = struct.ref
61
+ if_ = struct.if
62
+ loop = struct.loop
63
+ new(src: src, href: href, align: align, alt_text: alt_text, width: width, channels: channels, ref: ref,
64
+ if_: if_, loop: loop, additional_properties: struct)
65
+ end
66
+
67
+ # Serialize an instance of ElementalImageNode to a JSON object
68
+ #
69
+ # @return [JSON]
70
+ def to_json(*_args)
71
+ {
72
+ "src": @src,
73
+ "href": @href,
74
+ "align": @align,
75
+ "altText": @alt_text,
76
+ "width": @width,
77
+ "channels": @channels,
78
+ "ref": @ref,
79
+ "if": @if_,
80
+ "loop": @loop
81
+ }.to_json
82
+ end
83
+
84
+ # 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.
85
+ #
86
+ # @param obj [Object]
87
+ # @return [Void]
88
+ def self.validate_raw(obj:)
89
+ obj.src.is_a?(String) != false || raise("Passed value for field obj.src is not the expected type, validation failed.")
90
+ obj.href&.is_a?(String) != false || raise("Passed value for field obj.href is not the expected type, validation failed.")
91
+ obj.align&.is_a?(Send::IAlignment) != false || raise("Passed value for field obj.align is not the expected type, validation failed.")
92
+ obj.alt_text&.is_a?(String) != false || raise("Passed value for field obj.alt_text is not the expected type, validation failed.")
93
+ obj.width&.is_a?(String) != false || raise("Passed value for field obj.width is not the expected type, validation failed.")
94
+ obj.channels&.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
95
+ obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
96
+ obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
97
+ obj.loop&.is_a?(String) != false || raise("Passed value for field obj.loop is not the expected type, validation failed.")
98
+ end
99
+ end
100
+ end
101
+ end