trycourier 1.10.0 → 3.0.0.pre.beta1

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