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,67 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../requests"
4
+ require_relative "types/list_templates_response"
5
+ require "async"
6
+
7
+ module Courier
8
+ class TemplatesClient
9
+ attr_reader :request_client
10
+
11
+ # @param request_client [RequestClient]
12
+ # @return [TemplatesClient]
13
+ def initialize(request_client:)
14
+ # @type [RequestClient]
15
+ @request_client = request_client
16
+ end
17
+
18
+ # Returns a list of notification templates
19
+ #
20
+ # @param cursor [String] A unique identifier that allows for fetching the next set of templates
21
+ # @param request_options [RequestOptions]
22
+ # @return [Templates::ListTemplatesResponse]
23
+ def list(cursor: nil, request_options: nil)
24
+ response = @request_client.conn.get("/notifications") do |req|
25
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
26
+ unless request_options&.authorization_token.nil?
27
+ req.headers["Authorization"] =
28
+ request_options.authorization_token
29
+ end
30
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
31
+ req.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
32
+ end
33
+ Templates::ListTemplatesResponse.from_json(json_object: response.body)
34
+ end
35
+ end
36
+
37
+ class AsyncTemplatesClient
38
+ attr_reader :request_client
39
+
40
+ # @param request_client [AsyncRequestClient]
41
+ # @return [AsyncTemplatesClient]
42
+ def initialize(request_client:)
43
+ # @type [AsyncRequestClient]
44
+ @request_client = request_client
45
+ end
46
+
47
+ # Returns a list of notification templates
48
+ #
49
+ # @param cursor [String] A unique identifier that allows for fetching the next set of templates
50
+ # @param request_options [RequestOptions]
51
+ # @return [Templates::ListTemplatesResponse]
52
+ def list(cursor: nil, request_options: nil)
53
+ Async do
54
+ response = @request_client.conn.get("/notifications") do |req|
55
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
56
+ unless request_options&.authorization_token.nil?
57
+ req.headers["Authorization"] =
58
+ request_options.authorization_token
59
+ end
60
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
61
+ req.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
62
+ end
63
+ Templates::ListTemplatesResponse.from_json(json_object: response.body)
64
+ end
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Courier
4
+ class Templates
5
+ CHANNEL_IDENTIFIER = String
6
+ end
7
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../commons/types/paging"
4
+ require_relative "notification_templates"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Templates
9
+ class ListTemplatesResponse
10
+ attr_reader :paging, :results, :additional_properties
11
+
12
+ # @param paging [Commons::Paging]
13
+ # @param results [Array<Templates::NotificationTemplates>] An array of Notification Templates
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [Templates::ListTemplatesResponse]
16
+ def initialize(paging:, results:, additional_properties: nil)
17
+ # @type [Commons::Paging]
18
+ @paging = paging
19
+ # @type [Array<Templates::NotificationTemplates>] An array of Notification Templates
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 ListTemplatesResponse
26
+ #
27
+ # @param json_object [JSON]
28
+ # @return [Templates::ListTemplatesResponse]
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
+ Templates::NotificationTemplates.from_json(json_object: v)
41
+ end
42
+ new(paging: paging, results: results, additional_properties: struct)
43
+ end
44
+
45
+ # Serialize an instance of ListTemplatesResponse 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,90 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "routing_strategy"
4
+ require_relative "tag"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Templates
9
+ class NotificationTemplates
10
+ attr_reader :created_at, :id, :routing, :tags, :title, :updated_at, :additional_properties
11
+
12
+ # @param created_at [Integer] A UTC timestamp at which notification was created. This is stored as a millisecond representation of the Unix epoch (the time passed since January 1, 1970).
13
+ # @param id [String] A unique identifier associated with the notification.
14
+ # @param routing [Templates::RoutingStrategy] Routing strategy used by this notification.
15
+ # @param tags [Array<Templates::Tag>] A list of tags attached to the notification.
16
+ # @param title [String] The title of the notification.
17
+ # @param updated_at [Integer] A UTC timestamp at which notification was updated. This is stored as a millisecond representation of the Unix epoch (the time passed since January 1, 1970).
18
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
19
+ # @return [Templates::NotificationTemplates]
20
+ def initialize(created_at:, id:, routing:, tags:, title:, updated_at:, additional_properties: nil)
21
+ # @type [Integer] A UTC timestamp at which notification was created. This is stored as a millisecond representation of the Unix epoch (the time passed since January 1, 1970).
22
+ @created_at = created_at
23
+ # @type [String] A unique identifier associated with the notification.
24
+ @id = id
25
+ # @type [Templates::RoutingStrategy] Routing strategy used by this notification.
26
+ @routing = routing
27
+ # @type [Array<Templates::Tag>] A list of tags attached to the notification.
28
+ @tags = tags
29
+ # @type [String] The title of the notification.
30
+ @title = title
31
+ # @type [Integer] A UTC timestamp at which notification was updated. This is stored as a millisecond representation of the Unix epoch (the time passed since January 1, 1970).
32
+ @updated_at = updated_at
33
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
34
+ @additional_properties = additional_properties
35
+ end
36
+
37
+ # Deserialize a JSON object to an instance of NotificationTemplates
38
+ #
39
+ # @param json_object [JSON]
40
+ # @return [Templates::NotificationTemplates]
41
+ def self.from_json(json_object:)
42
+ struct = JSON.parse(json_object, object_class: OpenStruct)
43
+ parsed_json = JSON.parse(json_object)
44
+ created_at = struct.created_at
45
+ id = struct.id
46
+ if parsed_json["routing"].nil?
47
+ routing = nil
48
+ else
49
+ routing = parsed_json["routing"].to_json
50
+ routing = Templates::RoutingStrategy.from_json(json_object: routing)
51
+ end
52
+ tags = parsed_json["tags"]&.map do |v|
53
+ v = v.to_json
54
+ Templates::Tag.from_json(json_object: v)
55
+ end
56
+ title = struct.title
57
+ updated_at = struct.updated_at
58
+ new(created_at: created_at, id: id, routing: routing, tags: tags, title: title, updated_at: updated_at,
59
+ additional_properties: struct)
60
+ end
61
+
62
+ # Serialize an instance of NotificationTemplates to a JSON object
63
+ #
64
+ # @return [JSON]
65
+ def to_json(*_args)
66
+ {
67
+ "created_at": @created_at,
68
+ "id": @id,
69
+ "routing": @routing,
70
+ "tags": @tags,
71
+ "title": @title,
72
+ "updated_at": @updated_at
73
+ }.to_json
74
+ end
75
+
76
+ # 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.
77
+ #
78
+ # @param obj [Object]
79
+ # @return [Void]
80
+ def self.validate_raw(obj:)
81
+ obj.created_at.is_a?(Integer) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
82
+ obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
83
+ Templates::RoutingStrategy.validate_raw(obj: obj.routing)
84
+ obj.tags.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
85
+ obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
86
+ obj.updated_at.is_a?(Integer) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
87
+ end
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "routing_strategy_method"
4
+ require_relative "channel_identifier"
5
+ require "json"
6
+
7
+ module Courier
8
+ class Templates
9
+ class RoutingStrategy
10
+ attr_reader :method, :channels, :additional_properties
11
+
12
+ # @param method [Templates::RoutingStrategyMethod] The method for selecting channels to send the message with. Value can be either 'single' or 'all'. If not provided will default to 'single'
13
+ # @param channels [Array<Templates::CHANNEL_IDENTIFIER>] An array of valid channel identifiers (like email, push, sms, etc.) and additional routing nodes.
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [Templates::RoutingStrategy]
16
+ def initialize(method:, channels:, additional_properties: nil)
17
+ # @type [Templates::RoutingStrategyMethod] The method for selecting channels to send the message with. Value can be either 'single' or 'all'. If not provided will default to 'single'
18
+ @method = method
19
+ # @type [Array<Templates::CHANNEL_IDENTIFIER>] An array of valid channel identifiers (like email, push, sms, etc.) and additional routing nodes.
20
+ @channels = channels
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 RoutingStrategy
26
+ #
27
+ # @param json_object [JSON]
28
+ # @return [Templates::RoutingStrategy]
29
+ def self.from_json(json_object:)
30
+ struct = JSON.parse(json_object, object_class: OpenStruct)
31
+ JSON.parse(json_object)
32
+ method = struct.method
33
+ channels = struct.channels
34
+ new(method: method, channels: channels, additional_properties: struct)
35
+ end
36
+
37
+ # Serialize an instance of RoutingStrategy to a JSON object
38
+ #
39
+ # @return [JSON]
40
+ def to_json(*_args)
41
+ { "method": @method, "channels": @channels }.to_json
42
+ end
43
+
44
+ # 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.
45
+ #
46
+ # @param obj [Object]
47
+ # @return [Void]
48
+ def self.validate_raw(obj:)
49
+ obj.method.is_a?(Templates::RoutingStrategyMethod) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
50
+ obj.channels.is_a?(Array) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Courier
4
+ class Templates
5
+ class RoutingStrategyMethod
6
+ ALL = "all"
7
+ SINGLE = "single"
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "tag_data"
4
+ require "json"
5
+
6
+ module Courier
7
+ class Templates
8
+ class Tag
9
+ attr_reader :data, :additional_properties
10
+
11
+ # @param data [Array<Templates::TagData>]
12
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
13
+ # @return [Templates::Tag]
14
+ def initialize(data:, additional_properties: nil)
15
+ # @type [Array<Templates::TagData>]
16
+ @data = data
17
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
18
+ @additional_properties = additional_properties
19
+ end
20
+
21
+ # Deserialize a JSON object to an instance of Tag
22
+ #
23
+ # @param json_object [JSON]
24
+ # @return [Templates::Tag]
25
+ def self.from_json(json_object:)
26
+ struct = JSON.parse(json_object, object_class: OpenStruct)
27
+ parsed_json = JSON.parse(json_object)
28
+ data = parsed_json["data"]&.map do |v|
29
+ v = v.to_json
30
+ Templates::TagData.from_json(json_object: v)
31
+ end
32
+ new(data: data, additional_properties: struct)
33
+ end
34
+
35
+ # Serialize an instance of Tag to a JSON object
36
+ #
37
+ # @return [JSON]
38
+ def to_json(*_args)
39
+ { "data": @data }.to_json
40
+ end
41
+
42
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
43
+ #
44
+ # @param obj [Object]
45
+ # @return [Void]
46
+ def self.validate_raw(obj:)
47
+ obj.data.is_a?(Array) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+
5
+ module Courier
6
+ class Templates
7
+ class TagData
8
+ attr_reader :id, :name, :additional_properties
9
+
10
+ # @param id [String] A unique identifier of the tag.
11
+ # @param name [String] Name of the tag.
12
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
13
+ # @return [Templates::TagData]
14
+ def initialize(id:, name:, additional_properties: nil)
15
+ # @type [String] A unique identifier of the tag.
16
+ @id = id
17
+ # @type [String] Name of the tag.
18
+ @name = name
19
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
20
+ @additional_properties = additional_properties
21
+ end
22
+
23
+ # Deserialize a JSON object to an instance of TagData
24
+ #
25
+ # @param json_object [JSON]
26
+ # @return [Templates::TagData]
27
+ def self.from_json(json_object:)
28
+ struct = JSON.parse(json_object, object_class: OpenStruct)
29
+ JSON.parse(json_object)
30
+ id = struct.id
31
+ name = struct.name
32
+ new(id: id, name: name, additional_properties: struct)
33
+ end
34
+
35
+ # Serialize an instance of TagData to a JSON object
36
+ #
37
+ # @return [JSON]
38
+ def to_json(*_args)
39
+ { "id": @id, "name": @name }.to_json
40
+ end
41
+
42
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
43
+ #
44
+ # @param obj [Object]
45
+ # @return [Void]
46
+ def self.validate_raw(obj:)
47
+ obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
48
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
49
+ end
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,255 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../requests"
4
+ require_relative "types/default_preferences"
5
+ require_relative "types/template_property"
6
+ require_relative "types/tenant"
7
+ require_relative "types/tenant_list_response"
8
+ require_relative "types/list_users_for_tenant_response"
9
+ require "async"
10
+
11
+ module Courier
12
+ class TenantsClient
13
+ attr_reader :request_client
14
+
15
+ # @param request_client [RequestClient]
16
+ # @return [TenantsClient]
17
+ def initialize(request_client:)
18
+ # @type [RequestClient]
19
+ @request_client = request_client
20
+ end
21
+
22
+ # @param tenant_id [String] A unique identifier representing the tenant to be returned.
23
+ # @param name [String] Name of the tenant.
24
+ # @param parent_tenant_id [String] Tenant's parent id (if any).
25
+ # @param default_preferences [Hash] Defines the preferences used for the tenant when the user hasn't specified their own.Request of type Tenants::DefaultPreferences, as a Hash
26
+ # * :items (Array<Tenants::SubscriptionTopic>)
27
+ # @param properties [Array<Tenants::TEMPLATE_PROPERTY>] Arbitrary properties accessible to a template.
28
+ # @param user_profile [Hash{String => String}] A user profile object merged with user profile on send.
29
+ # @param brand_id [String] Brand to be used for the account when one is not specified by the send call.
30
+ # @param request_options [RequestOptions]
31
+ # @return [Tenants::Tenant]
32
+ def create_or_replace(tenant_id:, name:, parent_tenant_id: nil, default_preferences: nil, properties: nil,
33
+ user_profile: nil, brand_id: nil, request_options: nil)
34
+ response = @request_client.conn.put("/tenants/#{tenant_id}") do |req|
35
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
36
+ unless request_options&.authorization_token.nil?
37
+ req.headers["Authorization"] =
38
+ request_options.authorization_token
39
+ end
40
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
41
+ req.body = {
42
+ **(request_options&.additional_body_parameters || {}),
43
+ name: name,
44
+ parent_tenant_id: parent_tenant_id,
45
+ default_preferences: default_preferences,
46
+ properties: properties,
47
+ user_profile: user_profile,
48
+ brand_id: brand_id
49
+ }.compact
50
+ end
51
+ Tenants::Tenant.from_json(json_object: response.body)
52
+ end
53
+
54
+ # @param tenant_id [String] A unique identifier representing the tenant to be returned.
55
+ # @param request_options [RequestOptions]
56
+ # @return [Tenants::Tenant]
57
+ def get(tenant_id:, request_options: nil)
58
+ response = @request_client.conn.get("/tenants/#{tenant_id}") do |req|
59
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
60
+ unless request_options&.authorization_token.nil?
61
+ req.headers["Authorization"] =
62
+ request_options.authorization_token
63
+ end
64
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
65
+ end
66
+ Tenants::Tenant.from_json(json_object: response.body)
67
+ end
68
+
69
+ # @param limit [Integer] The number of accousnts to return
70
+ # (defaults to 20, maximum value of 100)
71
+ # @param cursor [String] Continue the pagination with the next cursor
72
+ # @param request_options [RequestOptions]
73
+ # @return [Tenants::TenantListResponse]
74
+ def list(limit: nil, cursor: nil, request_options: nil)
75
+ response = @request_client.conn.get("/tenants") do |req|
76
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
77
+ unless request_options&.authorization_token.nil?
78
+ req.headers["Authorization"] =
79
+ request_options.authorization_token
80
+ end
81
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
82
+ req.params = {
83
+ **(request_options&.additional_query_parameters || {}),
84
+ "limit": limit,
85
+ "cursor": cursor
86
+ }.compact
87
+ end
88
+ Tenants::TenantListResponse.from_json(json_object: response.body)
89
+ end
90
+
91
+ # @param tenant_id [String] Id of the tenant to be deleted.
92
+ # @param request_options [RequestOptions]
93
+ # @return [Void]
94
+ def delete(tenant_id:, request_options: nil)
95
+ @request_client.conn.delete("/tenants/#{tenant_id}") do |req|
96
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
97
+ unless request_options&.authorization_token.nil?
98
+ req.headers["Authorization"] =
99
+ request_options.authorization_token
100
+ end
101
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
102
+ end
103
+ end
104
+
105
+ # @param tenant_id [String] Id of the tenant for user membership.
106
+ # @param limit [Integer] The number of accounts to return
107
+ # (defaults to 20, maximum value of 100)
108
+ # @param cursor [String] Continue the pagination with the next cursor
109
+ # @param request_options [RequestOptions]
110
+ # @return [Tenants::ListUsersForTenantResponse]
111
+ def get_users_by_tenant(tenant_id:, limit: nil, cursor: nil, request_options: nil)
112
+ response = @request_client.conn.get("/tenants/#{tenant_id}/users") do |req|
113
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
114
+ unless request_options&.authorization_token.nil?
115
+ req.headers["Authorization"] =
116
+ request_options.authorization_token
117
+ end
118
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
119
+ req.params = {
120
+ **(request_options&.additional_query_parameters || {}),
121
+ "limit": limit,
122
+ "cursor": cursor
123
+ }.compact
124
+ end
125
+ Tenants::ListUsersForTenantResponse.from_json(json_object: response.body)
126
+ end
127
+ end
128
+
129
+ class AsyncTenantsClient
130
+ attr_reader :request_client
131
+
132
+ # @param request_client [AsyncRequestClient]
133
+ # @return [AsyncTenantsClient]
134
+ def initialize(request_client:)
135
+ # @type [AsyncRequestClient]
136
+ @request_client = request_client
137
+ end
138
+
139
+ # @param tenant_id [String] A unique identifier representing the tenant to be returned.
140
+ # @param name [String] Name of the tenant.
141
+ # @param parent_tenant_id [String] Tenant's parent id (if any).
142
+ # @param default_preferences [Hash] Defines the preferences used for the tenant when the user hasn't specified their own.Request of type Tenants::DefaultPreferences, as a Hash
143
+ # * :items (Array<Tenants::SubscriptionTopic>)
144
+ # @param properties [Array<Tenants::TEMPLATE_PROPERTY>] Arbitrary properties accessible to a template.
145
+ # @param user_profile [Hash{String => String}] A user profile object merged with user profile on send.
146
+ # @param brand_id [String] Brand to be used for the account when one is not specified by the send call.
147
+ # @param request_options [RequestOptions]
148
+ # @return [Tenants::Tenant]
149
+ def create_or_replace(tenant_id:, name:, parent_tenant_id: nil, default_preferences: nil, properties: nil,
150
+ user_profile: nil, brand_id: nil, request_options: nil)
151
+ Async do
152
+ response = @request_client.conn.put("/tenants/#{tenant_id}") do |req|
153
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
154
+ unless request_options&.authorization_token.nil?
155
+ req.headers["Authorization"] =
156
+ request_options.authorization_token
157
+ end
158
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
159
+ req.body = {
160
+ **(request_options&.additional_body_parameters || {}),
161
+ name: name,
162
+ parent_tenant_id: parent_tenant_id,
163
+ default_preferences: default_preferences,
164
+ properties: properties,
165
+ user_profile: user_profile,
166
+ brand_id: brand_id
167
+ }.compact
168
+ end
169
+ Tenants::Tenant.from_json(json_object: response.body)
170
+ end
171
+ end
172
+
173
+ # @param tenant_id [String] A unique identifier representing the tenant to be returned.
174
+ # @param request_options [RequestOptions]
175
+ # @return [Tenants::Tenant]
176
+ def get(tenant_id:, request_options: nil)
177
+ Async do
178
+ response = @request_client.conn.get("/tenants/#{tenant_id}") do |req|
179
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
180
+ unless request_options&.authorization_token.nil?
181
+ req.headers["Authorization"] =
182
+ request_options.authorization_token
183
+ end
184
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
185
+ end
186
+ Tenants::Tenant.from_json(json_object: response.body)
187
+ end
188
+ end
189
+
190
+ # @param limit [Integer] The number of accousnts to return
191
+ # (defaults to 20, maximum value of 100)
192
+ # @param cursor [String] Continue the pagination with the next cursor
193
+ # @param request_options [RequestOptions]
194
+ # @return [Tenants::TenantListResponse]
195
+ def list(limit: nil, cursor: nil, request_options: nil)
196
+ Async do
197
+ response = @request_client.conn.get("/tenants") do |req|
198
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
199
+ unless request_options&.authorization_token.nil?
200
+ req.headers["Authorization"] =
201
+ request_options.authorization_token
202
+ end
203
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
204
+ req.params = {
205
+ **(request_options&.additional_query_parameters || {}),
206
+ "limit": limit,
207
+ "cursor": cursor
208
+ }.compact
209
+ end
210
+ Tenants::TenantListResponse.from_json(json_object: response.body)
211
+ end
212
+ end
213
+
214
+ # @param tenant_id [String] Id of the tenant to be deleted.
215
+ # @param request_options [RequestOptions]
216
+ # @return [Void]
217
+ def delete(tenant_id:, request_options: nil)
218
+ Async do
219
+ @request_client.conn.delete("/tenants/#{tenant_id}") do |req|
220
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
221
+ unless request_options&.authorization_token.nil?
222
+ req.headers["Authorization"] =
223
+ request_options.authorization_token
224
+ end
225
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
226
+ end
227
+ end
228
+ end
229
+
230
+ # @param tenant_id [String] Id of the tenant for user membership.
231
+ # @param limit [Integer] The number of accounts to return
232
+ # (defaults to 20, maximum value of 100)
233
+ # @param cursor [String] Continue the pagination with the next cursor
234
+ # @param request_options [RequestOptions]
235
+ # @return [Tenants::ListUsersForTenantResponse]
236
+ def get_users_by_tenant(tenant_id:, limit: nil, cursor: nil, request_options: nil)
237
+ Async do
238
+ response = @request_client.conn.get("/tenants/#{tenant_id}/users") do |req|
239
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
240
+ unless request_options&.authorization_token.nil?
241
+ req.headers["Authorization"] =
242
+ request_options.authorization_token
243
+ end
244
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
245
+ req.params = {
246
+ **(request_options&.additional_query_parameters || {}),
247
+ "limit": limit,
248
+ "cursor": cursor
249
+ }.compact
250
+ end
251
+ Tenants::ListUsersForTenantResponse.from_json(json_object: response.body)
252
+ end
253
+ end
254
+ end
255
+ end