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.
- checksums.yaml +4 -4
- data/lib/environment.rb +7 -0
- data/lib/gemconfig.rb +14 -0
- data/lib/requests.rb +121 -0
- data/lib/trycourier/audiences/client.rb +235 -0
- data/lib/trycourier/audiences/types/audience.rb +86 -0
- data/lib/trycourier/audiences/types/audience_list_response.rb +62 -0
- data/lib/trycourier/audiences/types/audience_member.rb +74 -0
- data/lib/trycourier/audiences/types/audience_member_get_response.rb +53 -0
- data/lib/trycourier/audiences/types/audience_member_list_response.rb +62 -0
- data/lib/trycourier/audiences/types/audience_update_response.rb +53 -0
- data/lib/trycourier/audiences/types/base_filter_config.rb +53 -0
- data/lib/trycourier/audiences/types/comparison_operator.rb +21 -0
- data/lib/trycourier/audiences/types/filter.rb +50 -0
- data/lib/trycourier/audiences/types/filter_config.rb +50 -0
- data/lib/trycourier/audiences/types/logical_operator.rb +10 -0
- data/lib/trycourier/audiences/types/nested_filter_config.rb +63 -0
- data/lib/trycourier/audiences/types/operator.rb +48 -0
- data/lib/trycourier/audiences/types/single_filter_config.rb +64 -0
- data/lib/trycourier/audit_events/client.rb +104 -0
- data/lib/trycourier/audit_events/types/actor.rb +52 -0
- data/lib/trycourier/audit_events/types/audit_event.rb +92 -0
- data/lib/trycourier/audit_events/types/get_audit_event_params.rb +47 -0
- data/lib/trycourier/audit_events/types/list_audit_events_params.rb +47 -0
- data/lib/trycourier/audit_events/types/list_audit_events_response.rb +62 -0
- data/lib/trycourier/audit_events/types/target.rb +52 -0
- data/lib/trycourier/auth_tokens/client.rb +85 -0
- data/lib/trycourier/auth_tokens/types/issue_token_response.rb +47 -0
- data/lib/trycourier/automations/client.rb +151 -0
- data/lib/trycourier/automations/types/automation.rb +56 -0
- data/lib/trycourier/automations/types/automation_ad_hoc_invoke_params.rb +88 -0
- data/lib/trycourier/automations/types/automation_cancel_step.rb +62 -0
- data/lib/trycourier/automations/types/automation_delay_step.rb +62 -0
- data/lib/trycourier/automations/types/automation_invoke_params.rb +69 -0
- data/lib/trycourier/automations/types/automation_invoke_response.rb +47 -0
- data/lib/trycourier/automations/types/automation_invoke_step.rb +62 -0
- data/lib/trycourier/automations/types/automation_invoke_template_params.rb +82 -0
- data/lib/trycourier/automations/types/automation_run_context.rb +69 -0
- data/lib/trycourier/automations/types/automation_send_list_step.rb +93 -0
- data/lib/trycourier/automations/types/automation_send_step.rb +99 -0
- data/lib/trycourier/automations/types/automation_step.rb +52 -0
- data/lib/trycourier/automations/types/automation_step_action.rb +14 -0
- data/lib/trycourier/automations/types/automation_step_option.rb +110 -0
- data/lib/trycourier/automations/types/automation_update_profile_step.rb +64 -0
- data/lib/trycourier/automations/types/automation_v_2_send_step.rb +68 -0
- data/lib/trycourier/automations/types/merge_algorithm.rb +12 -0
- data/lib/trycourier/automations/types/profile.rb +7 -0
- data/lib/trycourier/brands/client.rb +281 -0
- data/lib/trycourier/brands/types/brand.rb +105 -0
- data/lib/trycourier/brands/types/brand_colors.rb +57 -0
- data/lib/trycourier/brands/types/brand_get_all_response.rb +62 -0
- data/lib/trycourier/brands/types/brand_parameters.rb +74 -0
- data/lib/trycourier/brands/types/brand_settings.rb +69 -0
- data/lib/trycourier/brands/types/brand_snippet.rb +57 -0
- data/lib/trycourier/brands/types/brand_snippets.rb +51 -0
- data/lib/trycourier/brands/types/brands_response.rb +62 -0
- data/lib/trycourier/bulk/client.rb +249 -0
- data/lib/trycourier/bulk/types/bulk_create_job_response.rb +47 -0
- data/lib/trycourier/bulk/types/bulk_get_job_params.rb +47 -0
- data/lib/trycourier/bulk/types/bulk_get_job_response.rb +53 -0
- data/lib/trycourier/bulk/types/bulk_get_job_users_params.rb +52 -0
- data/lib/trycourier/bulk/types/bulk_get_job_users_response.rb +62 -0
- data/lib/trycourier/bulk/types/bulk_ingest_error.rb +52 -0
- data/lib/trycourier/bulk/types/bulk_ingest_users_params.rb +51 -0
- data/lib/trycourier/bulk/types/bulk_ingest_users_response.rb +56 -0
- data/lib/trycourier/bulk/types/bulk_job_status.rb +12 -0
- data/lib/trycourier/bulk/types/bulk_job_user_status.rb +11 -0
- data/lib/trycourier/bulk/types/bulk_message_user_response.rb +100 -0
- data/lib/trycourier/bulk/types/inbound_bulk_content_message.rb +165 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message.rb +95 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message_user.rb +80 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message_v_1.rb +75 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message_v_2.rb +50 -0
- data/lib/trycourier/bulk/types/inbound_bulk_template_message.rb +157 -0
- data/lib/trycourier/bulk/types/job_details.rb +81 -0
- data/lib/trycourier/commons/types/already_exists.rb +52 -0
- data/lib/trycourier/commons/types/bad_request.rb +52 -0
- data/lib/trycourier/commons/types/base_error.rb +47 -0
- data/lib/trycourier/commons/types/channel_classification.rb +14 -0
- data/lib/trycourier/commons/types/channel_preference.rb +48 -0
- data/lib/trycourier/commons/types/conflict.rb +52 -0
- data/lib/trycourier/commons/types/email.rb +52 -0
- data/lib/trycourier/commons/types/message_not_found.rb +52 -0
- data/lib/trycourier/commons/types/not_found.rb +52 -0
- data/lib/trycourier/commons/types/notification_preference_details.rb +66 -0
- data/lib/trycourier/commons/types/notification_preferences.rb +7 -0
- data/lib/trycourier/commons/types/paging.rb +52 -0
- data/lib/trycourier/commons/types/payment_required.rb +52 -0
- data/lib/trycourier/commons/types/preference_status.rb +11 -0
- data/lib/trycourier/commons/types/recipient_preferences.rb +53 -0
- data/lib/trycourier/commons/types/rule.rb +52 -0
- data/lib/trycourier/commons/types/user_tenant_association.rb +62 -0
- data/lib/trycourier/lists/client.rb +454 -0
- data/lib/trycourier/lists/types/list.rb +62 -0
- data/lib/trycourier/lists/types/list_get_all_response.rb +62 -0
- data/lib/trycourier/lists/types/list_get_subscriptions_response.rb +62 -0
- data/lib/trycourier/lists/types/list_put_params.rb +58 -0
- data/lib/trycourier/lists/types/list_subscription_recipient.rb +63 -0
- data/lib/trycourier/lists/types/put_subscriptions_recipient.rb +58 -0
- data/lib/trycourier/messages/client.rb +300 -0
- data/lib/trycourier/messages/types/list_messages_response.rb +62 -0
- data/lib/trycourier/messages/types/message_details.rb +120 -0
- data/lib/trycourier/messages/types/message_history_response.rb +51 -0
- data/lib/trycourier/messages/types/message_status.rb +17 -0
- data/lib/trycourier/messages/types/reason.rb +14 -0
- data/lib/trycourier/messages/types/render_output.rb +63 -0
- data/lib/trycourier/messages/types/render_output_response.rb +51 -0
- data/lib/trycourier/messages/types/rendered_message_block.rb +52 -0
- data/lib/trycourier/messages/types/rendered_message_content.rb +77 -0
- data/lib/trycourier/notifications/client.rb +379 -0
- data/lib/trycourier/notifications/types/base_check.rb +58 -0
- data/lib/trycourier/notifications/types/block_type.rb +17 -0
- data/lib/trycourier/notifications/types/check.rb +63 -0
- data/lib/trycourier/notifications/types/check_status.rb +11 -0
- data/lib/trycourier/notifications/types/message_routing.rb +57 -0
- data/lib/trycourier/notifications/types/message_routing_channel.rb +49 -0
- data/lib/trycourier/notifications/types/message_routing_method.rb +10 -0
- data/lib/trycourier/notifications/types/notification.rb +63 -0
- data/lib/trycourier/notifications/types/notification_block.rb +94 -0
- data/lib/trycourier/notifications/types/notification_channel.rb +73 -0
- data/lib/trycourier/notifications/types/notification_channel_content.rb +52 -0
- data/lib/trycourier/notifications/types/notification_content.rb +49 -0
- data/lib/trycourier/notifications/types/notification_content_hierarchy.rb +52 -0
- data/lib/trycourier/notifications/types/notification_get_content_response.rb +65 -0
- data/lib/trycourier/notifications/types/notification_list_response.rb +62 -0
- data/lib/trycourier/notifications/types/submission_checks_get_response.rb +51 -0
- data/lib/trycourier/notifications/types/submission_checks_replace_response.rb +51 -0
- data/lib/trycourier/profiles/client.rb +325 -0
- data/lib/trycourier/profiles/types/address.rb +81 -0
- data/lib/trycourier/profiles/types/airship_profile.rb +59 -0
- data/lib/trycourier/profiles/types/airship_profile_audience.rb +47 -0
- data/lib/trycourier/profiles/types/delete_list_subscription_response.rb +47 -0
- data/lib/trycourier/profiles/types/device_type.rb +7 -0
- data/lib/trycourier/profiles/types/discord.rb +50 -0
- data/lib/trycourier/profiles/types/expo.rb +50 -0
- data/lib/trycourier/profiles/types/get_list_subscriptions_list.rb +74 -0
- data/lib/trycourier/profiles/types/get_list_subscriptions_response.rb +62 -0
- data/lib/trycourier/profiles/types/intercom.rb +58 -0
- data/lib/trycourier/profiles/types/intercom_recipient.rb +47 -0
- data/lib/trycourier/profiles/types/merge_profile_response.rb +47 -0
- data/lib/trycourier/profiles/types/ms_teams.rb +86 -0
- data/lib/trycourier/profiles/types/ms_teams_base_properties.rb +52 -0
- data/lib/trycourier/profiles/types/multiple_tokens.rb +51 -0
- data/lib/trycourier/profiles/types/profile_get_parameters.rb +47 -0
- data/lib/trycourier/profiles/types/profile_get_response.rb +58 -0
- data/lib/trycourier/profiles/types/replace_profile_response.rb +47 -0
- data/lib/trycourier/profiles/types/send_direct_message.rb +47 -0
- data/lib/trycourier/profiles/types/send_to_channel.rb +47 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_channel_id.rb +57 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb +68 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_conversation_id.rb +58 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_email.rb +57 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_user_id.rb +57 -0
- data/lib/trycourier/profiles/types/send_to_slack_channel.rb +52 -0
- data/lib/trycourier/profiles/types/send_to_slack_email.rb +52 -0
- data/lib/trycourier/profiles/types/send_to_slack_user_id.rb +52 -0
- data/lib/trycourier/profiles/types/slack.rb +62 -0
- data/lib/trycourier/profiles/types/slack_base_properties.rb +47 -0
- data/lib/trycourier/profiles/types/snooze_rule.rb +58 -0
- data/lib/trycourier/profiles/types/snooze_rule_type.rb +9 -0
- data/lib/trycourier/profiles/types/subscribe_to_lists_request.rb +51 -0
- data/lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb +58 -0
- data/lib/trycourier/profiles/types/subscribe_to_lists_response.rb +47 -0
- data/lib/trycourier/profiles/types/token.rb +47 -0
- data/lib/trycourier/profiles/types/user_profile.rb +274 -0
- data/lib/trycourier/send/types/attachment.rb +7 -0
- data/lib/trycourier/send/types/audience_filter.rb +57 -0
- data/lib/trycourier/send/types/audience_recipient.rb +62 -0
- data/lib/trycourier/send/types/base_message.rb +149 -0
- data/lib/trycourier/send/types/base_social_presence.rb +47 -0
- data/lib/trycourier/send/types/brand_settings_email.rb +87 -0
- data/lib/trycourier/send/types/brand_settings_in_app.rb +119 -0
- data/lib/trycourier/send/types/brand_settings_social_presence.rb +107 -0
- data/lib/trycourier/send/types/brand_template.rb +88 -0
- data/lib/trycourier/send/types/brand_template_override.rb +112 -0
- data/lib/trycourier/send/types/channel.rb +113 -0
- data/lib/trycourier/send/types/channel_metadata.rb +53 -0
- data/lib/trycourier/send/types/channel_source.rb +11 -0
- data/lib/trycourier/send/types/content.rb +50 -0
- data/lib/trycourier/send/types/content_message.rb +177 -0
- data/lib/trycourier/send/types/criteria.rb +12 -0
- data/lib/trycourier/send/types/delay.rb +47 -0
- data/lib/trycourier/send/types/elemental_action_node.rb +116 -0
- data/lib/trycourier/send/types/elemental_base_node.rb +62 -0
- data/lib/trycourier/send/types/elemental_channel_node.rb +105 -0
- data/lib/trycourier/send/types/elemental_content.rb +61 -0
- data/lib/trycourier/send/types/elemental_content_sugar.rb +53 -0
- data/lib/trycourier/send/types/elemental_divider_node.rb +68 -0
- data/lib/trycourier/send/types/elemental_group_node.rb +72 -0
- data/lib/trycourier/send/types/elemental_image_node.rb +101 -0
- data/lib/trycourier/send/types/elemental_meta_node.rb +70 -0
- data/lib/trycourier/send/types/elemental_node.rb +170 -0
- data/lib/trycourier/send/types/elemental_quote_node.rb +104 -0
- data/lib/trycourier/send/types/elemental_text_node.rb +136 -0
- data/lib/trycourier/send/types/email_footer.rb +52 -0
- data/lib/trycourier/send/types/email_head.rb +52 -0
- data/lib/trycourier/send/types/email_header.rb +63 -0
- data/lib/trycourier/send/types/expires_in_type.rb +48 -0
- data/lib/trycourier/send/types/expiry.rb +58 -0
- data/lib/trycourier/send/types/i_action_button_style.rb +10 -0
- data/lib/trycourier/send/types/i_alignment.rb +12 -0
- data/lib/trycourier/send/types/i_preferences.rb +7 -0
- data/lib/trycourier/send/types/i_profile_preferences.rb +59 -0
- data/lib/trycourier/send/types/icons.rb +52 -0
- data/lib/trycourier/send/types/in_app_placement.rb +12 -0
- data/lib/trycourier/send/types/invalid_list_pattern_recipient.rb +52 -0
- data/lib/trycourier/send/types/invalid_list_recipient.rb +52 -0
- data/lib/trycourier/send/types/invalid_user_recipient.rb +52 -0
- data/lib/trycourier/send/types/list_filter.rb +57 -0
- data/lib/trycourier/send/types/list_pattern_recipient.rb +53 -0
- data/lib/trycourier/send/types/list_pattern_recipient_type.rb +41 -0
- data/lib/trycourier/send/types/list_recipient.rb +62 -0
- data/lib/trycourier/send/types/list_recipient_type.rb +41 -0
- data/lib/trycourier/send/types/locale.rb +47 -0
- data/lib/trycourier/send/types/locales.rb +7 -0
- data/lib/trycourier/send/types/logo.rb +52 -0
- data/lib/trycourier/send/types/message.rb +50 -0
- data/lib/trycourier/send/types/message_channel_email_override.rb +119 -0
- data/lib/trycourier/send/types/message_channels.rb +7 -0
- data/lib/trycourier/send/types/message_context.rb +49 -0
- data/lib/trycourier/send/types/message_data.rb +7 -0
- data/lib/trycourier/send/types/message_metadata.rb +68 -0
- data/lib/trycourier/send/types/message_providers.rb +7 -0
- data/lib/trycourier/send/types/message_providers_type.rb +72 -0
- data/lib/trycourier/send/types/message_recipient.rb +54 -0
- data/lib/trycourier/send/types/metadata.rb +53 -0
- data/lib/trycourier/send/types/ms_teams_recipient.rb +53 -0
- data/lib/trycourier/send/types/override.rb +10 -0
- data/lib/trycourier/send/types/preference.rb +73 -0
- data/lib/trycourier/send/types/preferences.rb +47 -0
- data/lib/trycourier/send/types/recipient.rb +98 -0
- data/lib/trycourier/send/types/routing.rb +64 -0
- data/lib/trycourier/send/types/routing_channel.rb +61 -0
- data/lib/trycourier/send/types/routing_method.rb +10 -0
- data/lib/trycourier/send/types/routing_strategy_channel.rb +70 -0
- data/lib/trycourier/send/types/routing_strategy_provider.rb +68 -0
- data/lib/trycourier/send/types/rule_type.rb +11 -0
- data/lib/trycourier/send/types/slack_recipient.rb +53 -0
- data/lib/trycourier/send/types/template_message.rb +169 -0
- data/lib/trycourier/send/types/text_align.rb +11 -0
- data/lib/trycourier/send/types/text_style.rb +12 -0
- data/lib/trycourier/send/types/timeout.rb +76 -0
- data/lib/trycourier/send/types/timeouts.rb +52 -0
- data/lib/trycourier/send/types/tracking_override.rb +47 -0
- data/lib/trycourier/send/types/user_recipient.rb +115 -0
- data/lib/trycourier/send/types/user_recipient_type.rb +41 -0
- data/lib/trycourier/send/types/utm.rb +68 -0
- data/lib/trycourier/send/types/widget_background.rb +52 -0
- data/lib/trycourier/templates/client.rb +67 -0
- data/lib/trycourier/templates/types/channel_identifier.rb +7 -0
- data/lib/trycourier/templates/types/list_templates_response.rb +62 -0
- data/lib/trycourier/templates/types/notification_templates.rb +90 -0
- data/lib/trycourier/templates/types/routing_strategy.rb +54 -0
- data/lib/trycourier/templates/types/routing_strategy_method.rb +10 -0
- data/lib/trycourier/templates/types/tag.rb +51 -0
- data/lib/trycourier/templates/types/tag_data.rb +52 -0
- data/lib/trycourier/tenants/client.rb +255 -0
- data/lib/trycourier/tenants/types/default_preferences.rb +51 -0
- data/lib/trycourier/tenants/types/list_users_for_tenant_response.rb +88 -0
- data/lib/trycourier/tenants/types/subscription_topic.rb +53 -0
- data/lib/trycourier/tenants/types/subscription_topic_status.rb +11 -0
- data/lib/trycourier/tenants/types/template_property.rb +7 -0
- data/lib/trycourier/tenants/types/tenant.rb +95 -0
- data/lib/trycourier/tenants/types/tenant_list_response.rb +86 -0
- data/lib/trycourier/translations/client.rb +106 -0
- data/lib/trycourier/types/send_message_response.rb +49 -0
- data/lib/trycourier/users/client.rb +34 -0
- data/lib/trycourier/users/preferences/client.rb +171 -0
- data/lib/trycourier/users/preferences/types/topic_preference.rb +86 -0
- data/lib/trycourier/users/preferences/types/user_preferences_get_response.rb +55 -0
- data/lib/trycourier/users/preferences/types/user_preferences_list_response.rb +64 -0
- data/lib/trycourier/users/preferences/types/user_preferences_update_response.rb +49 -0
- data/lib/trycourier/users/tenants/client.rb +267 -0
- data/lib/trycourier/users/tenants/types/add_user_to_single_tenants_params_profile.rb +76 -0
- data/lib/trycourier/users/tenants/types/list_tenants_for_user_response.rb +90 -0
- data/lib/trycourier/users/tokens/client.rb +264 -0
- data/lib/trycourier/users/tokens/types/delete_user_token_opts.rb +54 -0
- data/lib/trycourier/users/tokens/types/device.rb +83 -0
- data/lib/trycourier/users/tokens/types/expiry_date.rb +50 -0
- data/lib/trycourier/users/tokens/types/get_all_tokens_response.rb +11 -0
- data/lib/trycourier/users/tokens/types/get_user_token_opts.rb +54 -0
- data/lib/trycourier/users/tokens/types/get_user_token_response.rb +116 -0
- data/lib/trycourier/users/tokens/types/get_user_tokens_opts.rb +49 -0
- data/lib/trycourier/users/tokens/types/patch_op.rb +16 -0
- data/lib/trycourier/users/tokens/types/patch_operation.rb +59 -0
- data/lib/trycourier/users/tokens/types/patch_user_token_opts.rb +53 -0
- data/lib/trycourier/users/tokens/types/provider_key.rb +14 -0
- data/lib/trycourier/users/tokens/types/put_user_token_opts.rb +60 -0
- data/lib/trycourier/users/tokens/types/put_user_tokens_opts.rb +58 -0
- data/lib/trycourier/users/tokens/types/token_status.rb +14 -0
- data/lib/trycourier/users/tokens/types/tracking.rb +64 -0
- data/lib/trycourier/users/tokens/types/user_token.rb +102 -0
- data/lib/trycourier.rb +114 -138
- data/lib/types_export.rb +273 -0
- metadata +362 -50
- data/.github/ISSUE_TEMPLATE.md +0 -17
- data/.github/PULL_REQUEST_TEMPLATE.md +0 -27
- data/.github/workflows/gem-push.yml +0 -51
- data/.gitignore +0 -67
- data/.rspec +0 -3
- data/CHANGELOG.md +0 -126
- data/CONTRIBUTING.md +0 -28
- data/Gemfile +0 -8
- data/Gemfile.lock +0 -72
- data/LICENSE +0 -21
- data/README.md +0 -610
- data/Rakefile +0 -7
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/lib/trycourier/audiences.rb +0 -45
- data/lib/trycourier/audit_events.rb +0 -27
- data/lib/trycourier/auth_tokens.rb +0 -23
- data/lib/trycourier/automations.rb +0 -67
- data/lib/trycourier/brands.rb +0 -70
- data/lib/trycourier/bulk.rb +0 -79
- data/lib/trycourier/events.rb +0 -35
- data/lib/trycourier/exceptions.rb +0 -39
- data/lib/trycourier/lists.rb +0 -109
- data/lib/trycourier/messages.rb +0 -57
- data/lib/trycourier/profiles.rb +0 -64
- data/lib/trycourier/session.rb +0 -80
- data/lib/trycourier/tenants.rb +0 -43
- data/lib/trycourier/version.rb +0 -3
- data/trycourier.gemspec +0 -32
@@ -0,0 +1,75 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Bulk
|
7
|
+
class InboundBulkMessageV1
|
8
|
+
attr_reader :brand, :data, :event, :locale, :override, :additional_properties
|
9
|
+
|
10
|
+
# @param brand [String] A unique identifier that represents the brand that should be used
|
11
|
+
# for rendering the notification.
|
12
|
+
# @param data [Hash{String => String}] JSON that includes any data you want to pass to a message template.
|
13
|
+
# The data will populate the corresponding template variables.
|
14
|
+
# @param event [String]
|
15
|
+
# @param locale [Hash{String => String}]
|
16
|
+
# @param override [Object] JSON that is merged into the request sent by Courier to the provider
|
17
|
+
# to override properties or to gain access to features in the provider
|
18
|
+
# API that are not natively supported by Courier.
|
19
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
20
|
+
# @return [Bulk::InboundBulkMessageV1]
|
21
|
+
def initialize(brand: nil, data: nil, event: nil, locale: nil, override: nil, additional_properties: nil)
|
22
|
+
# @type [String] A unique identifier that represents the brand that should be used
|
23
|
+
# for rendering the notification.
|
24
|
+
@brand = brand
|
25
|
+
# @type [Hash{String => String}] JSON that includes any data you want to pass to a message template.
|
26
|
+
# The data will populate the corresponding template variables.
|
27
|
+
@data = data
|
28
|
+
# @type [String]
|
29
|
+
@event = event
|
30
|
+
# @type [Hash{String => String}]
|
31
|
+
@locale = locale
|
32
|
+
# @type [Object] JSON that is merged into the request sent by Courier to the provider
|
33
|
+
# to override properties or to gain access to features in the provider
|
34
|
+
# API that are not natively supported by Courier.
|
35
|
+
@override = override
|
36
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
37
|
+
@additional_properties = additional_properties
|
38
|
+
end
|
39
|
+
|
40
|
+
# Deserialize a JSON object to an instance of InboundBulkMessageV1
|
41
|
+
#
|
42
|
+
# @param json_object [JSON]
|
43
|
+
# @return [Bulk::InboundBulkMessageV1]
|
44
|
+
def self.from_json(json_object:)
|
45
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
46
|
+
JSON.parse(json_object)
|
47
|
+
brand = struct.brand
|
48
|
+
data = struct.data
|
49
|
+
event = struct.event
|
50
|
+
locale = struct.locale
|
51
|
+
override = struct.override
|
52
|
+
new(brand: brand, data: data, event: event, locale: locale, override: override, additional_properties: struct)
|
53
|
+
end
|
54
|
+
|
55
|
+
# Serialize an instance of InboundBulkMessageV1 to a JSON object
|
56
|
+
#
|
57
|
+
# @return [JSON]
|
58
|
+
def to_json(*_args)
|
59
|
+
{ "brand": @brand, "data": @data, "event": @event, "locale": @locale, "override": @override }.to_json
|
60
|
+
end
|
61
|
+
|
62
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
63
|
+
#
|
64
|
+
# @param obj [Object]
|
65
|
+
# @return [Void]
|
66
|
+
def self.validate_raw(obj:)
|
67
|
+
obj.brand&.is_a?(String) != false || raise("Passed value for field obj.brand is not the expected type, validation failed.")
|
68
|
+
obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
|
69
|
+
obj.event&.is_a?(String) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
|
70
|
+
obj.locale&.is_a?(Hash) != false || raise("Passed value for field obj.locale is not the expected type, validation failed.")
|
71
|
+
obj.override&.is_a?(Object) != false || raise("Passed value for field obj.override is not the expected type, validation failed.")
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
require_relative "inbound_bulk_template_message"
|
5
|
+
require_relative "inbound_bulk_content_message"
|
6
|
+
|
7
|
+
module Courier
|
8
|
+
class Bulk
|
9
|
+
class InboundBulkMessageV2
|
10
|
+
# Deserialize a JSON object to an instance of InboundBulkMessageV2
|
11
|
+
#
|
12
|
+
# @param json_object [JSON]
|
13
|
+
# @return [Bulk::InboundBulkMessageV2]
|
14
|
+
def self.from_json(json_object:)
|
15
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
16
|
+
begin
|
17
|
+
Bulk::InboundBulkTemplateMessage.validate_raw(obj: struct)
|
18
|
+
return Bulk::InboundBulkTemplateMessage.from_json(json_object: json_object)
|
19
|
+
rescue StandardError
|
20
|
+
# noop
|
21
|
+
end
|
22
|
+
begin
|
23
|
+
Bulk::InboundBulkContentMessage.validate_raw(obj: struct)
|
24
|
+
return Bulk::InboundBulkContentMessage.from_json(json_object: json_object)
|
25
|
+
rescue StandardError
|
26
|
+
# noop
|
27
|
+
end
|
28
|
+
struct
|
29
|
+
end
|
30
|
+
|
31
|
+
# 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.
|
32
|
+
#
|
33
|
+
# @param obj [Object]
|
34
|
+
# @return [Void]
|
35
|
+
def self.validate_raw(obj:)
|
36
|
+
begin
|
37
|
+
return Bulk::InboundBulkTemplateMessage.validate_raw(obj: obj)
|
38
|
+
rescue StandardError
|
39
|
+
# noop
|
40
|
+
end
|
41
|
+
begin
|
42
|
+
return Bulk::InboundBulkContentMessage.validate_raw(obj: obj)
|
43
|
+
rescue StandardError
|
44
|
+
# noop
|
45
|
+
end
|
46
|
+
raise("Passed value matched no type within the union, validation failed.")
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,157 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../../send/types/message_data"
|
4
|
+
require_relative "../../send/types/message_channels"
|
5
|
+
require_relative "../../send/types/message_context"
|
6
|
+
require_relative "../../send/types/message_metadata"
|
7
|
+
require_relative "../../send/types/message_providers"
|
8
|
+
require_relative "../../send/types/routing"
|
9
|
+
require_relative "../../send/types/timeout"
|
10
|
+
require_relative "../../send/types/delay"
|
11
|
+
require_relative "../../send/types/expiry"
|
12
|
+
require "json"
|
13
|
+
|
14
|
+
module Courier
|
15
|
+
class Bulk
|
16
|
+
class InboundBulkTemplateMessage
|
17
|
+
attr_reader :template, :data, :brand_id, :channels, :context, :metadata, :providers, :routing, :timeout, :delay,
|
18
|
+
:expiry, :additional_properties
|
19
|
+
|
20
|
+
# @param template [String] The id of the notification template to be rendered and sent to the recipient(s).
|
21
|
+
# This field or the content field must be supplied.
|
22
|
+
# @param data [Send::MESSAGE_DATA] An arbitrary object that includes any data you want to pass to the message.
|
23
|
+
# The data will populate the corresponding template or elements variables.
|
24
|
+
# @param brand_id [String]
|
25
|
+
# @param channels [Send::MESSAGE_CHANNELS] "Define run-time configuration for one or more channels. If you don't specify channels, the default configuration for each channel will be used. Valid ChannelId's are: email, sms, push, inbox, direct_message, banner, and webhook."
|
26
|
+
# @param context [Send::MessageContext] Context to load with this recipient. Will override any context set on message.context.
|
27
|
+
# @param metadata [Send::MessageMetadata] Metadata such as utm tracking attached with the notification through this channel.
|
28
|
+
# @param providers [Send::MESSAGE_PROVIDERS] An object whose keys are valid provider identifiers which map to an object.
|
29
|
+
# @param routing [Send::Routing]
|
30
|
+
# @param timeout [Send::Timeout] Time in ms to attempt the channel before failing over to the next available channel.
|
31
|
+
# @param delay [Send::Delay] Defines the time to wait before delivering the message.
|
32
|
+
# @param expiry [Send::Expiry] "Expiry allows you to set an absolute or relative time in which a message expires.
|
33
|
+
# Note: This is only valid for the Courier Inbox channel as of 12-08-2022."
|
34
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
35
|
+
# @return [Bulk::InboundBulkTemplateMessage]
|
36
|
+
def initialize(template:, data: nil, brand_id: nil, channels: nil, context: nil, metadata: nil, providers: nil,
|
37
|
+
routing: nil, timeout: nil, delay: nil, expiry: nil, additional_properties: nil)
|
38
|
+
# @type [String] The id of the notification template to be rendered and sent to the recipient(s).
|
39
|
+
# This field or the content field must be supplied.
|
40
|
+
@template = template
|
41
|
+
# @type [Send::MESSAGE_DATA] An arbitrary object that includes any data you want to pass to the message.
|
42
|
+
# The data will populate the corresponding template or elements variables.
|
43
|
+
@data = data
|
44
|
+
# @type [String]
|
45
|
+
@brand_id = brand_id
|
46
|
+
# @type [Send::MESSAGE_CHANNELS] "Define run-time configuration for one or more channels. If you don't specify channels, the default configuration for each channel will be used. Valid ChannelId's are: email, sms, push, inbox, direct_message, banner, and webhook."
|
47
|
+
@channels = channels
|
48
|
+
# @type [Send::MessageContext] Context to load with this recipient. Will override any context set on message.context.
|
49
|
+
@context = context
|
50
|
+
# @type [Send::MessageMetadata] Metadata such as utm tracking attached with the notification through this channel.
|
51
|
+
@metadata = metadata
|
52
|
+
# @type [Send::MESSAGE_PROVIDERS] An object whose keys are valid provider identifiers which map to an object.
|
53
|
+
@providers = providers
|
54
|
+
# @type [Send::Routing]
|
55
|
+
@routing = routing
|
56
|
+
# @type [Send::Timeout] Time in ms to attempt the channel before failing over to the next available channel.
|
57
|
+
@timeout = timeout
|
58
|
+
# @type [Send::Delay] Defines the time to wait before delivering the message.
|
59
|
+
@delay = delay
|
60
|
+
# @type [Send::Expiry] "Expiry allows you to set an absolute or relative time in which a message expires.
|
61
|
+
# Note: This is only valid for the Courier Inbox channel as of 12-08-2022."
|
62
|
+
@expiry = expiry
|
63
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
64
|
+
@additional_properties = additional_properties
|
65
|
+
end
|
66
|
+
|
67
|
+
# Deserialize a JSON object to an instance of InboundBulkTemplateMessage
|
68
|
+
#
|
69
|
+
# @param json_object [JSON]
|
70
|
+
# @return [Bulk::InboundBulkTemplateMessage]
|
71
|
+
def self.from_json(json_object:)
|
72
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
73
|
+
parsed_json = JSON.parse(json_object)
|
74
|
+
template = struct.template
|
75
|
+
data = struct.data
|
76
|
+
brand_id = struct.brand_id
|
77
|
+
channels = struct.channels
|
78
|
+
if parsed_json["context"].nil?
|
79
|
+
context = nil
|
80
|
+
else
|
81
|
+
context = parsed_json["context"].to_json
|
82
|
+
context = Send::MessageContext.from_json(json_object: context)
|
83
|
+
end
|
84
|
+
if parsed_json["metadata"].nil?
|
85
|
+
metadata = nil
|
86
|
+
else
|
87
|
+
metadata = parsed_json["metadata"].to_json
|
88
|
+
metadata = Send::MessageMetadata.from_json(json_object: metadata)
|
89
|
+
end
|
90
|
+
providers = struct.providers
|
91
|
+
if parsed_json["routing"].nil?
|
92
|
+
routing = nil
|
93
|
+
else
|
94
|
+
routing = parsed_json["routing"].to_json
|
95
|
+
routing = Send::Routing.from_json(json_object: routing)
|
96
|
+
end
|
97
|
+
if parsed_json["timeout"].nil?
|
98
|
+
timeout = nil
|
99
|
+
else
|
100
|
+
timeout = parsed_json["timeout"].to_json
|
101
|
+
timeout = Send::Timeout.from_json(json_object: timeout)
|
102
|
+
end
|
103
|
+
if parsed_json["delay"].nil?
|
104
|
+
delay = nil
|
105
|
+
else
|
106
|
+
delay = parsed_json["delay"].to_json
|
107
|
+
delay = Send::Delay.from_json(json_object: delay)
|
108
|
+
end
|
109
|
+
if parsed_json["expiry"].nil?
|
110
|
+
expiry = nil
|
111
|
+
else
|
112
|
+
expiry = parsed_json["expiry"].to_json
|
113
|
+
expiry = Send::Expiry.from_json(json_object: expiry)
|
114
|
+
end
|
115
|
+
new(template: template, data: data, brand_id: brand_id, channels: channels, context: context,
|
116
|
+
metadata: metadata, providers: providers, routing: routing, timeout: timeout, delay: delay, expiry: expiry, additional_properties: struct)
|
117
|
+
end
|
118
|
+
|
119
|
+
# Serialize an instance of InboundBulkTemplateMessage to a JSON object
|
120
|
+
#
|
121
|
+
# @return [JSON]
|
122
|
+
def to_json(*_args)
|
123
|
+
{
|
124
|
+
"template": @template,
|
125
|
+
"data": @data,
|
126
|
+
"brand_id": @brand_id,
|
127
|
+
"channels": @channels,
|
128
|
+
"context": @context,
|
129
|
+
"metadata": @metadata,
|
130
|
+
"providers": @providers,
|
131
|
+
"routing": @routing,
|
132
|
+
"timeout": @timeout,
|
133
|
+
"delay": @delay,
|
134
|
+
"expiry": @expiry
|
135
|
+
}.to_json
|
136
|
+
end
|
137
|
+
|
138
|
+
# 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.
|
139
|
+
#
|
140
|
+
# @param obj [Object]
|
141
|
+
# @return [Void]
|
142
|
+
def self.validate_raw(obj:)
|
143
|
+
obj.template.is_a?(String) != false || raise("Passed value for field obj.template is not the expected type, validation failed.")
|
144
|
+
obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
|
145
|
+
obj.brand_id&.is_a?(String) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
|
146
|
+
obj.channels&.is_a?(Hash) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
|
147
|
+
obj.context.nil? || Send::MessageContext.validate_raw(obj: obj.context)
|
148
|
+
obj.metadata.nil? || Send::MessageMetadata.validate_raw(obj: obj.metadata)
|
149
|
+
obj.providers&.is_a?(Hash) != false || raise("Passed value for field obj.providers is not the expected type, validation failed.")
|
150
|
+
obj.routing.nil? || Send::Routing.validate_raw(obj: obj.routing)
|
151
|
+
obj.timeout.nil? || Send::Timeout.validate_raw(obj: obj.timeout)
|
152
|
+
obj.delay.nil? || Send::Delay.validate_raw(obj: obj.delay)
|
153
|
+
obj.expiry.nil? || Send::Expiry.validate_raw(obj: obj.expiry)
|
154
|
+
end
|
155
|
+
end
|
156
|
+
end
|
157
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "inbound_bulk_message"
|
4
|
+
require_relative "bulk_job_status"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module Courier
|
8
|
+
class Bulk
|
9
|
+
class JobDetails
|
10
|
+
attr_reader :definition, :enqueued, :failures, :received, :status, :additional_properties
|
11
|
+
|
12
|
+
# @param definition [Bulk::InboundBulkMessage]
|
13
|
+
# @param enqueued [Integer]
|
14
|
+
# @param failures [Integer]
|
15
|
+
# @param received [Integer]
|
16
|
+
# @param status [Bulk::BulkJobStatus]
|
17
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
18
|
+
# @return [Bulk::JobDetails]
|
19
|
+
def initialize(definition:, enqueued:, failures:, received:, status:, additional_properties: nil)
|
20
|
+
# @type [Bulk::InboundBulkMessage]
|
21
|
+
@definition = definition
|
22
|
+
# @type [Integer]
|
23
|
+
@enqueued = enqueued
|
24
|
+
# @type [Integer]
|
25
|
+
@failures = failures
|
26
|
+
# @type [Integer]
|
27
|
+
@received = received
|
28
|
+
# @type [Bulk::BulkJobStatus]
|
29
|
+
@status = status
|
30
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
31
|
+
@additional_properties = additional_properties
|
32
|
+
end
|
33
|
+
|
34
|
+
# Deserialize a JSON object to an instance of JobDetails
|
35
|
+
#
|
36
|
+
# @param json_object [JSON]
|
37
|
+
# @return [Bulk::JobDetails]
|
38
|
+
def self.from_json(json_object:)
|
39
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
40
|
+
parsed_json = JSON.parse(json_object)
|
41
|
+
if parsed_json["definition"].nil?
|
42
|
+
definition = nil
|
43
|
+
else
|
44
|
+
definition = parsed_json["definition"].to_json
|
45
|
+
definition = Bulk::InboundBulkMessage.from_json(json_object: definition)
|
46
|
+
end
|
47
|
+
enqueued = struct.enqueued
|
48
|
+
failures = struct.failures
|
49
|
+
received = struct.received
|
50
|
+
status = struct.status
|
51
|
+
new(definition: definition, enqueued: enqueued, failures: failures, received: received, status: status,
|
52
|
+
additional_properties: struct)
|
53
|
+
end
|
54
|
+
|
55
|
+
# Serialize an instance of JobDetails to a JSON object
|
56
|
+
#
|
57
|
+
# @return [JSON]
|
58
|
+
def to_json(*_args)
|
59
|
+
{
|
60
|
+
"definition": @definition,
|
61
|
+
"enqueued": @enqueued,
|
62
|
+
"failures": @failures,
|
63
|
+
"received": @received,
|
64
|
+
"status": @status
|
65
|
+
}.to_json
|
66
|
+
end
|
67
|
+
|
68
|
+
# 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.
|
69
|
+
#
|
70
|
+
# @param obj [Object]
|
71
|
+
# @return [Void]
|
72
|
+
def self.validate_raw(obj:)
|
73
|
+
Bulk::InboundBulkMessage.validate_raw(obj: obj.definition)
|
74
|
+
obj.enqueued.is_a?(Integer) != false || raise("Passed value for field obj.enqueued is not the expected type, validation failed.")
|
75
|
+
obj.failures.is_a?(Integer) != false || raise("Passed value for field obj.failures is not the expected type, validation failed.")
|
76
|
+
obj.received.is_a?(Integer) != false || raise("Passed value for field obj.received is not the expected type, validation failed.")
|
77
|
+
obj.status.is_a?(Bulk::BulkJobStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Commons
|
7
|
+
class AlreadyExists
|
8
|
+
attr_reader :type, :message, :additional_properties
|
9
|
+
|
10
|
+
# @param type [String]
|
11
|
+
# @param message [String] A message describing the error that occurred.
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [Commons::AlreadyExists]
|
14
|
+
def initialize(type:, message:, additional_properties: nil)
|
15
|
+
# @type [String]
|
16
|
+
@type = type
|
17
|
+
# @type [String] A message describing the error that occurred.
|
18
|
+
@message = message
|
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 AlreadyExists
|
24
|
+
#
|
25
|
+
# @param json_object [JSON]
|
26
|
+
# @return [Commons::AlreadyExists]
|
27
|
+
def self.from_json(json_object:)
|
28
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
29
|
+
JSON.parse(json_object)
|
30
|
+
type = struct.type
|
31
|
+
message = struct.message
|
32
|
+
new(type: type, message: message, additional_properties: struct)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Serialize an instance of AlreadyExists to a JSON object
|
36
|
+
#
|
37
|
+
# @return [JSON]
|
38
|
+
def to_json(*_args)
|
39
|
+
{ "type": @type, "message": @message }.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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
48
|
+
obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Commons
|
7
|
+
class BadRequest
|
8
|
+
attr_reader :type, :message, :additional_properties
|
9
|
+
|
10
|
+
# @param type [String]
|
11
|
+
# @param message [String] A message describing the error that occurred.
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [Commons::BadRequest]
|
14
|
+
def initialize(type:, message:, additional_properties: nil)
|
15
|
+
# @type [String]
|
16
|
+
@type = type
|
17
|
+
# @type [String] A message describing the error that occurred.
|
18
|
+
@message = message
|
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 BadRequest
|
24
|
+
#
|
25
|
+
# @param json_object [JSON]
|
26
|
+
# @return [Commons::BadRequest]
|
27
|
+
def self.from_json(json_object:)
|
28
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
29
|
+
JSON.parse(json_object)
|
30
|
+
type = struct.type
|
31
|
+
message = struct.message
|
32
|
+
new(type: type, message: message, additional_properties: struct)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Serialize an instance of BadRequest to a JSON object
|
36
|
+
#
|
37
|
+
# @return [JSON]
|
38
|
+
def to_json(*_args)
|
39
|
+
{ "type": @type, "message": @message }.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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
48
|
+
obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Commons
|
7
|
+
class BaseError
|
8
|
+
attr_reader :message, :additional_properties
|
9
|
+
|
10
|
+
# @param message [String] A message describing the error that occurred.
|
11
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
12
|
+
# @return [Commons::BaseError]
|
13
|
+
def initialize(message:, additional_properties: nil)
|
14
|
+
# @type [String] A message describing the error that occurred.
|
15
|
+
@message = message
|
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 BaseError
|
21
|
+
#
|
22
|
+
# @param json_object [JSON]
|
23
|
+
# @return [Commons::BaseError]
|
24
|
+
def self.from_json(json_object:)
|
25
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
26
|
+
JSON.parse(json_object)
|
27
|
+
message = struct.message
|
28
|
+
new(message: message, additional_properties: struct)
|
29
|
+
end
|
30
|
+
|
31
|
+
# Serialize an instance of BaseError to a JSON object
|
32
|
+
#
|
33
|
+
# @return [JSON]
|
34
|
+
def to_json(*_args)
|
35
|
+
{ "message": @message }.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.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "channel_classification"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Courier
|
7
|
+
class Commons
|
8
|
+
class ChannelPreference
|
9
|
+
attr_reader :channel, :additional_properties
|
10
|
+
|
11
|
+
# @param channel [Commons::ChannelClassification]
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [Commons::ChannelPreference]
|
14
|
+
def initialize(channel:, additional_properties: nil)
|
15
|
+
# @type [Commons::ChannelClassification]
|
16
|
+
@channel = channel
|
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 ChannelPreference
|
22
|
+
#
|
23
|
+
# @param json_object [JSON]
|
24
|
+
# @return [Commons::ChannelPreference]
|
25
|
+
def self.from_json(json_object:)
|
26
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
27
|
+
JSON.parse(json_object)
|
28
|
+
channel = struct.channel
|
29
|
+
new(channel: channel, additional_properties: struct)
|
30
|
+
end
|
31
|
+
|
32
|
+
# Serialize an instance of ChannelPreference to a JSON object
|
33
|
+
#
|
34
|
+
# @return [JSON]
|
35
|
+
def to_json(*_args)
|
36
|
+
{ "channel": @channel }.to_json
|
37
|
+
end
|
38
|
+
|
39
|
+
# 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.
|
40
|
+
#
|
41
|
+
# @param obj [Object]
|
42
|
+
# @return [Void]
|
43
|
+
def self.validate_raw(obj:)
|
44
|
+
obj.channel.is_a?(Commons::ChannelClassification) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Commons
|
7
|
+
class Conflict
|
8
|
+
attr_reader :type, :message, :additional_properties
|
9
|
+
|
10
|
+
# @param type [String]
|
11
|
+
# @param message [String] A message describing the error that occurred.
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [Commons::Conflict]
|
14
|
+
def initialize(type:, message:, additional_properties: nil)
|
15
|
+
# @type [String]
|
16
|
+
@type = type
|
17
|
+
# @type [String] A message describing the error that occurred.
|
18
|
+
@message = message
|
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 Conflict
|
24
|
+
#
|
25
|
+
# @param json_object [JSON]
|
26
|
+
# @return [Commons::Conflict]
|
27
|
+
def self.from_json(json_object:)
|
28
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
29
|
+
JSON.parse(json_object)
|
30
|
+
type = struct.type
|
31
|
+
message = struct.message
|
32
|
+
new(type: type, message: message, additional_properties: struct)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Serialize an instance of Conflict to a JSON object
|
36
|
+
#
|
37
|
+
# @return [JSON]
|
38
|
+
def to_json(*_args)
|
39
|
+
{ "type": @type, "message": @message }.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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
|
48
|
+
obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|