trycourier 2.0.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/audiences.rb +0 -45
  311. data/lib/trycourier/audit_events.rb +0 -27
  312. data/lib/trycourier/auth_tokens.rb +0 -23
  313. data/lib/trycourier/automations.rb +0 -67
  314. data/lib/trycourier/brands.rb +0 -70
  315. data/lib/trycourier/bulk.rb +0 -79
  316. data/lib/trycourier/events.rb +0 -35
  317. data/lib/trycourier/exceptions.rb +0 -39
  318. data/lib/trycourier/lists.rb +0 -109
  319. data/lib/trycourier/messages.rb +0 -57
  320. data/lib/trycourier/profiles.rb +0 -64
  321. data/lib/trycourier/session.rb +0 -80
  322. data/lib/trycourier/tenants.rb +0 -43
  323. data/lib/trycourier/version.rb +0 -3
  324. data/trycourier.gemspec +0 -32
@@ -0,0 +1,281 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../requests"
4
+ require_relative "types/brand_parameters"
5
+ require_relative "types/brand"
6
+ require_relative "types/brands_response"
7
+ require_relative "types/brand_settings"
8
+ require_relative "types/brand_snippets"
9
+ require "async"
10
+
11
+ module Courier
12
+ class BrandsClient
13
+ attr_reader :request_client
14
+
15
+ # @param request_client [RequestClient]
16
+ # @return [BrandsClient]
17
+ def initialize(request_client:)
18
+ # @type [RequestClient]
19
+ @request_client = request_client
20
+ end
21
+
22
+ # @param request [Hash] Request of type Brands::BrandParameters, as a Hash
23
+ # * :id (String)
24
+ # * :name (String)
25
+ # * :settings (Hash)
26
+ # * :colors (Hash)
27
+ # * :primary (String)
28
+ # * :secondary (String)
29
+ # * :tertiary (String)
30
+ # * :inapp (Object)
31
+ # * :email (Hash)
32
+ # * :footer (Object)
33
+ # * :header (Object)
34
+ # * :snippets (Hash)
35
+ # * :items (Array<Brands::BrandSnippet>)
36
+ # @param request_options [IdempotencyRequestOptions]
37
+ # @return [Brands::Brand]
38
+ def create(request:, request_options: nil)
39
+ response = @request_client.conn.post("/brands") do |req|
40
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
41
+ unless request_options&.authorization_token.nil?
42
+ req.headers["Authorization"] =
43
+ request_options.authorization_token
44
+ end
45
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
46
+ unless request_options&.idempotency_expiry.nil?
47
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
48
+ end
49
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
50
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
51
+ end
52
+ Brands::Brand.from_json(json_object: response.body)
53
+ end
54
+
55
+ # Fetch a specific brand by brand ID.
56
+ #
57
+ # @param brand_id [String] A unique identifier associated with the brand you wish to retrieve.
58
+ # @param request_options [RequestOptions]
59
+ # @return [Brands::Brand]
60
+ def get(brand_id:, request_options: nil)
61
+ response = @request_client.conn.get("/brands/#{brand_id}") do |req|
62
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
63
+ unless request_options&.authorization_token.nil?
64
+ req.headers["Authorization"] =
65
+ request_options.authorization_token
66
+ end
67
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
68
+ end
69
+ Brands::Brand.from_json(json_object: response.body)
70
+ end
71
+
72
+ # Get the list of brands.
73
+ #
74
+ # @param cursor [String] A unique identifier that allows for fetching the next set of brands.
75
+ # @param request_options [RequestOptions]
76
+ # @return [Brands::BrandsResponse]
77
+ def list(cursor: nil, request_options: nil)
78
+ response = @request_client.conn.get("/brands") do |req|
79
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
80
+ unless request_options&.authorization_token.nil?
81
+ req.headers["Authorization"] =
82
+ request_options.authorization_token
83
+ end
84
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
85
+ req.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
86
+ end
87
+ Brands::BrandsResponse.from_json(json_object: response.body)
88
+ end
89
+
90
+ # Delete a brand by brand ID.
91
+ #
92
+ # @param brand_id [String] A unique identifier associated with the brand you wish to retrieve.
93
+ # @param request_options [RequestOptions]
94
+ # @return [Void]
95
+ def delete(brand_id:, request_options: nil)
96
+ @request_client.conn.delete("/brands/#{brand_id}") do |req|
97
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
98
+ unless request_options&.authorization_token.nil?
99
+ req.headers["Authorization"] =
100
+ request_options.authorization_token
101
+ end
102
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
103
+ end
104
+ end
105
+
106
+ # Replace an existing brand with the supplied values.
107
+ #
108
+ # @param brand_id [String] A unique identifier associated with the brand you wish to update.
109
+ # @param name [String] The name of the brand.
110
+ # @param settings [Hash] Request of type Brands::BrandSettings, as a Hash
111
+ # * :colors (Hash)
112
+ # * :primary (String)
113
+ # * :secondary (String)
114
+ # * :tertiary (String)
115
+ # * :inapp (Object)
116
+ # * :email (Hash)
117
+ # * :footer (Object)
118
+ # * :header (Object)
119
+ # @param snippets [Hash] Request of type Brands::BrandSnippets, as a Hash
120
+ # * :items (Array<Brands::BrandSnippet>)
121
+ # @param request_options [RequestOptions]
122
+ # @return [Brands::Brand]
123
+ def replace(brand_id:, name:, settings: nil, snippets: nil, request_options: nil)
124
+ response = @request_client.conn.put("/brands/#{brand_id}") do |req|
125
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
126
+ unless request_options&.authorization_token.nil?
127
+ req.headers["Authorization"] =
128
+ request_options.authorization_token
129
+ end
130
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
131
+ req.body = {
132
+ **(request_options&.additional_body_parameters || {}),
133
+ name: name,
134
+ settings: settings,
135
+ snippets: snippets
136
+ }.compact
137
+ end
138
+ Brands::Brand.from_json(json_object: response.body)
139
+ end
140
+ end
141
+
142
+ class AsyncBrandsClient
143
+ attr_reader :request_client
144
+
145
+ # @param request_client [AsyncRequestClient]
146
+ # @return [AsyncBrandsClient]
147
+ def initialize(request_client:)
148
+ # @type [AsyncRequestClient]
149
+ @request_client = request_client
150
+ end
151
+
152
+ # @param request [Hash] Request of type Brands::BrandParameters, as a Hash
153
+ # * :id (String)
154
+ # * :name (String)
155
+ # * :settings (Hash)
156
+ # * :colors (Hash)
157
+ # * :primary (String)
158
+ # * :secondary (String)
159
+ # * :tertiary (String)
160
+ # * :inapp (Object)
161
+ # * :email (Hash)
162
+ # * :footer (Object)
163
+ # * :header (Object)
164
+ # * :snippets (Hash)
165
+ # * :items (Array<Brands::BrandSnippet>)
166
+ # @param request_options [IdempotencyRequestOptions]
167
+ # @return [Brands::Brand]
168
+ def create(request:, request_options: nil)
169
+ Async do
170
+ response = @request_client.conn.post("/brands") do |req|
171
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
172
+ unless request_options&.authorization_token.nil?
173
+ req.headers["Authorization"] =
174
+ request_options.authorization_token
175
+ end
176
+ req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
177
+ unless request_options&.idempotency_expiry.nil?
178
+ req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
179
+ end
180
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
181
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
182
+ end
183
+ Brands::Brand.from_json(json_object: response.body)
184
+ end
185
+ end
186
+
187
+ # Fetch a specific brand by brand ID.
188
+ #
189
+ # @param brand_id [String] A unique identifier associated with the brand you wish to retrieve.
190
+ # @param request_options [RequestOptions]
191
+ # @return [Brands::Brand]
192
+ def get(brand_id:, request_options: nil)
193
+ Async do
194
+ response = @request_client.conn.get("/brands/#{brand_id}") do |req|
195
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
196
+ unless request_options&.authorization_token.nil?
197
+ req.headers["Authorization"] =
198
+ request_options.authorization_token
199
+ end
200
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
201
+ end
202
+ Brands::Brand.from_json(json_object: response.body)
203
+ end
204
+ end
205
+
206
+ # Get the list of brands.
207
+ #
208
+ # @param cursor [String] A unique identifier that allows for fetching the next set of brands.
209
+ # @param request_options [RequestOptions]
210
+ # @return [Brands::BrandsResponse]
211
+ def list(cursor: nil, request_options: nil)
212
+ Async do
213
+ response = @request_client.conn.get("/brands") do |req|
214
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
215
+ unless request_options&.authorization_token.nil?
216
+ req.headers["Authorization"] =
217
+ request_options.authorization_token
218
+ end
219
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
220
+ req.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
221
+ end
222
+ Brands::BrandsResponse.from_json(json_object: response.body)
223
+ end
224
+ end
225
+
226
+ # Delete a brand by brand ID.
227
+ #
228
+ # @param brand_id [String] A unique identifier associated with the brand you wish to retrieve.
229
+ # @param request_options [RequestOptions]
230
+ # @return [Void]
231
+ def delete(brand_id:, request_options: nil)
232
+ Async do
233
+ @request_client.conn.delete("/brands/#{brand_id}") do |req|
234
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
235
+ unless request_options&.authorization_token.nil?
236
+ req.headers["Authorization"] =
237
+ request_options.authorization_token
238
+ end
239
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
240
+ end
241
+ end
242
+ end
243
+
244
+ # Replace an existing brand with the supplied values.
245
+ #
246
+ # @param brand_id [String] A unique identifier associated with the brand you wish to update.
247
+ # @param name [String] The name of the brand.
248
+ # @param settings [Hash] Request of type Brands::BrandSettings, as a Hash
249
+ # * :colors (Hash)
250
+ # * :primary (String)
251
+ # * :secondary (String)
252
+ # * :tertiary (String)
253
+ # * :inapp (Object)
254
+ # * :email (Hash)
255
+ # * :footer (Object)
256
+ # * :header (Object)
257
+ # @param snippets [Hash] Request of type Brands::BrandSnippets, as a Hash
258
+ # * :items (Array<Brands::BrandSnippet>)
259
+ # @param request_options [RequestOptions]
260
+ # @return [Brands::Brand]
261
+ def replace(brand_id:, name:, settings: nil, snippets: nil, request_options: nil)
262
+ Async do
263
+ response = @request_client.conn.put("/brands/#{brand_id}") do |req|
264
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
265
+ unless request_options&.authorization_token.nil?
266
+ req.headers["Authorization"] =
267
+ request_options.authorization_token
268
+ end
269
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
270
+ req.body = {
271
+ **(request_options&.additional_body_parameters || {}),
272
+ name: name,
273
+ settings: settings,
274
+ snippets: snippets
275
+ }.compact
276
+ end
277
+ Brands::Brand.from_json(json_object: response.body)
278
+ end
279
+ end
280
+ end
281
+ end
@@ -0,0 +1,105 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "brand_settings"
4
+ require_relative "brand_snippets"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Brands
9
+ class Brand
10
+ attr_reader :created, :id, :name, :published, :settings, :updated, :snippets, :version, :additional_properties
11
+
12
+ # @param created [Integer] The date/time of when the brand was created. Represented in milliseconds since Unix epoch.
13
+ # @param id [String] Brand Identifier
14
+ # @param name [String] Brand name
15
+ # @param published [Integer] The date/time of when the brand was published. Represented in milliseconds since Unix epoch.
16
+ # @param settings [Brands::BrandSettings]
17
+ # @param updated [Integer] The date/time of when the brand was updated. Represented in milliseconds since Unix epoch.
18
+ # @param snippets [Brands::BrandSnippets]
19
+ # @param version [String] The version identifier for the brand
20
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
21
+ # @return [Brands::Brand]
22
+ def initialize(created:, name:, published:, settings:, updated:, version:, id: nil, snippets: nil,
23
+ additional_properties: nil)
24
+ # @type [Integer] The date/time of when the brand was created. Represented in milliseconds since Unix epoch.
25
+ @created = created
26
+ # @type [String] Brand Identifier
27
+ @id = id
28
+ # @type [String] Brand name
29
+ @name = name
30
+ # @type [Integer] The date/time of when the brand was published. Represented in milliseconds since Unix epoch.
31
+ @published = published
32
+ # @type [Brands::BrandSettings]
33
+ @settings = settings
34
+ # @type [Integer] The date/time of when the brand was updated. Represented in milliseconds since Unix epoch.
35
+ @updated = updated
36
+ # @type [Brands::BrandSnippets]
37
+ @snippets = snippets
38
+ # @type [String] The version identifier for the brand
39
+ @version = version
40
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
41
+ @additional_properties = additional_properties
42
+ end
43
+
44
+ # Deserialize a JSON object to an instance of Brand
45
+ #
46
+ # @param json_object [JSON]
47
+ # @return [Brands::Brand]
48
+ def self.from_json(json_object:)
49
+ struct = JSON.parse(json_object, object_class: OpenStruct)
50
+ parsed_json = JSON.parse(json_object)
51
+ created = struct.created
52
+ id = struct.id
53
+ name = struct.name
54
+ published = struct.published
55
+ if parsed_json["settings"].nil?
56
+ settings = nil
57
+ else
58
+ settings = parsed_json["settings"].to_json
59
+ settings = Brands::BrandSettings.from_json(json_object: settings)
60
+ end
61
+ updated = struct.updated
62
+ if parsed_json["snippets"].nil?
63
+ snippets = nil
64
+ else
65
+ snippets = parsed_json["snippets"].to_json
66
+ snippets = Brands::BrandSnippets.from_json(json_object: snippets)
67
+ end
68
+ version = struct.version
69
+ new(created: created, id: id, name: name, published: published, settings: settings, updated: updated,
70
+ snippets: snippets, version: version, additional_properties: struct)
71
+ end
72
+
73
+ # Serialize an instance of Brand to a JSON object
74
+ #
75
+ # @return [JSON]
76
+ def to_json(*_args)
77
+ {
78
+ "created": @created,
79
+ "id": @id,
80
+ "name": @name,
81
+ "published": @published,
82
+ "settings": @settings,
83
+ "updated": @updated,
84
+ "snippets": @snippets,
85
+ "version": @version
86
+ }.to_json
87
+ end
88
+
89
+ # 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.
90
+ #
91
+ # @param obj [Object]
92
+ # @return [Void]
93
+ def self.validate_raw(obj:)
94
+ obj.created.is_a?(Integer) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
95
+ obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
96
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
97
+ obj.published.is_a?(Integer) != false || raise("Passed value for field obj.published is not the expected type, validation failed.")
98
+ Brands::BrandSettings.validate_raw(obj: obj.settings)
99
+ obj.updated.is_a?(Integer) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
100
+ obj.snippets.nil? || Brands::BrandSnippets.validate_raw(obj: obj.snippets)
101
+ obj.version.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
102
+ end
103
+ end
104
+ end
105
+ end
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class Brands
7
+ class BrandColors
8
+ attr_reader :primary, :secondary, :tertiary, :additional_properties
9
+
10
+ # @param primary [String]
11
+ # @param secondary [String]
12
+ # @param tertiary [String]
13
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
14
+ # @return [Brands::BrandColors]
15
+ def initialize(primary: nil, secondary: nil, tertiary: nil, additional_properties: nil)
16
+ # @type [String]
17
+ @primary = primary
18
+ # @type [String]
19
+ @secondary = secondary
20
+ # @type [String]
21
+ @tertiary = tertiary
22
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
23
+ @additional_properties = additional_properties
24
+ end
25
+
26
+ # Deserialize a JSON object to an instance of BrandColors
27
+ #
28
+ # @param json_object [JSON]
29
+ # @return [Brands::BrandColors]
30
+ def self.from_json(json_object:)
31
+ struct = JSON.parse(json_object, object_class: OpenStruct)
32
+ JSON.parse(json_object)
33
+ primary = struct.primary
34
+ secondary = struct.secondary
35
+ tertiary = struct.tertiary
36
+ new(primary: primary, secondary: secondary, tertiary: tertiary, additional_properties: struct)
37
+ end
38
+
39
+ # Serialize an instance of BrandColors to a JSON object
40
+ #
41
+ # @return [JSON]
42
+ def to_json(*_args)
43
+ { "primary": @primary, "secondary": @secondary, "tertiary": @tertiary }.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.primary&.is_a?(String) != false || raise("Passed value for field obj.primary is not the expected type, validation failed.")
52
+ obj.secondary&.is_a?(String) != false || raise("Passed value for field obj.secondary is not the expected type, validation failed.")
53
+ obj.tertiary&.is_a?(String) != false || raise("Passed value for field obj.tertiary is not the expected type, validation failed.")
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../commons/types/paging"
4
+ require_relative "brand"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Brands
9
+ class BrandGetAllResponse
10
+ attr_reader :paging, :results, :additional_properties
11
+
12
+ # @param paging [Commons::Paging]
13
+ # @param results [Array<Brands::Brand>]
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [Brands::BrandGetAllResponse]
16
+ def initialize(paging:, results:, additional_properties: nil)
17
+ # @type [Commons::Paging]
18
+ @paging = paging
19
+ # @type [Array<Brands::Brand>]
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 BrandGetAllResponse
26
+ #
27
+ # @param json_object [JSON]
28
+ # @return [Brands::BrandGetAllResponse]
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
+ Brands::Brand.from_json(json_object: v)
41
+ end
42
+ new(paging: paging, results: results, additional_properties: struct)
43
+ end
44
+
45
+ # Serialize an instance of BrandGetAllResponse 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,74 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "brand_settings"
4
+ require_relative "brand_snippets"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Brands
9
+ class BrandParameters
10
+ attr_reader :id, :name, :settings, :snippets, :additional_properties
11
+
12
+ # @param id [String]
13
+ # @param name [String] The name of the brand.
14
+ # @param settings [Brands::BrandSettings]
15
+ # @param snippets [Brands::BrandSnippets]
16
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
17
+ # @return [Brands::BrandParameters]
18
+ def initialize(name:, settings:, id: nil, snippets: nil, additional_properties: nil)
19
+ # @type [String]
20
+ @id = id
21
+ # @type [String] The name of the brand.
22
+ @name = name
23
+ # @type [Brands::BrandSettings]
24
+ @settings = settings
25
+ # @type [Brands::BrandSnippets]
26
+ @snippets = snippets
27
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
28
+ @additional_properties = additional_properties
29
+ end
30
+
31
+ # Deserialize a JSON object to an instance of BrandParameters
32
+ #
33
+ # @param json_object [JSON]
34
+ # @return [Brands::BrandParameters]
35
+ def self.from_json(json_object:)
36
+ struct = JSON.parse(json_object, object_class: OpenStruct)
37
+ parsed_json = JSON.parse(json_object)
38
+ id = struct.id
39
+ name = struct.name
40
+ if parsed_json["settings"].nil?
41
+ settings = nil
42
+ else
43
+ settings = parsed_json["settings"].to_json
44
+ settings = Brands::BrandSettings.from_json(json_object: settings)
45
+ end
46
+ if parsed_json["snippets"].nil?
47
+ snippets = nil
48
+ else
49
+ snippets = parsed_json["snippets"].to_json
50
+ snippets = Brands::BrandSnippets.from_json(json_object: snippets)
51
+ end
52
+ new(id: id, name: name, settings: settings, snippets: snippets, additional_properties: struct)
53
+ end
54
+
55
+ # Serialize an instance of BrandParameters to a JSON object
56
+ #
57
+ # @return [JSON]
58
+ def to_json(*_args)
59
+ { "id": @id, "name": @name, "settings": @settings, "snippets": @snippets }.to_json
60
+ end
61
+
62
+ # 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.
63
+ #
64
+ # @param obj [Object]
65
+ # @return [Void]
66
+ def self.validate_raw(obj:)
67
+ obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
68
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
69
+ Brands::BrandSettings.validate_raw(obj: obj.settings)
70
+ obj.snippets.nil? || Brands::BrandSnippets.validate_raw(obj: obj.snippets)
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,69 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "brand_colors"
4
+ require_relative "../../commons/types/email"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Brands
9
+ class BrandSettings
10
+ attr_reader :colors, :inapp, :email, :additional_properties
11
+
12
+ # @param colors [Brands::BrandColors]
13
+ # @param inapp [Object]
14
+ # @param email [Commons::Email]
15
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
16
+ # @return [Brands::BrandSettings]
17
+ def initialize(colors: nil, inapp: nil, email: nil, additional_properties: nil)
18
+ # @type [Brands::BrandColors]
19
+ @colors = colors
20
+ # @type [Object]
21
+ @inapp = inapp
22
+ # @type [Commons::Email]
23
+ @email = email
24
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
25
+ @additional_properties = additional_properties
26
+ end
27
+
28
+ # Deserialize a JSON object to an instance of BrandSettings
29
+ #
30
+ # @param json_object [JSON]
31
+ # @return [Brands::BrandSettings]
32
+ def self.from_json(json_object:)
33
+ struct = JSON.parse(json_object, object_class: OpenStruct)
34
+ parsed_json = JSON.parse(json_object)
35
+ if parsed_json["colors"].nil?
36
+ colors = nil
37
+ else
38
+ colors = parsed_json["colors"].to_json
39
+ colors = Brands::BrandColors.from_json(json_object: colors)
40
+ end
41
+ inapp = struct.inapp
42
+ if parsed_json["email"].nil?
43
+ email = nil
44
+ else
45
+ email = parsed_json["email"].to_json
46
+ email = Commons::Email.from_json(json_object: email)
47
+ end
48
+ new(colors: colors, inapp: inapp, email: email, additional_properties: struct)
49
+ end
50
+
51
+ # Serialize an instance of BrandSettings to a JSON object
52
+ #
53
+ # @return [JSON]
54
+ def to_json(*_args)
55
+ { "colors": @colors, "inapp": @inapp, "email": @email }.to_json
56
+ end
57
+
58
+ # 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.
59
+ #
60
+ # @param obj [Object]
61
+ # @return [Void]
62
+ def self.validate_raw(obj:)
63
+ obj.colors.nil? || Brands::BrandColors.validate_raw(obj: obj.colors)
64
+ obj.inapp&.is_a?(Object) != false || raise("Passed value for field obj.inapp is not the expected type, validation failed.")
65
+ obj.email.nil? || Commons::Email.validate_raw(obj: obj.email)
66
+ end
67
+ end
68
+ end
69
+ end