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.
- 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/accounts.rb +0 -43
- 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/version.rb +0 -3
- data/trycourier.gemspec +0 -32
@@ -0,0 +1,149 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "message_data"
|
4
|
+
require_relative "message_channels"
|
5
|
+
require_relative "message_context"
|
6
|
+
require_relative "message_metadata"
|
7
|
+
require_relative "message_providers"
|
8
|
+
require_relative "routing"
|
9
|
+
require_relative "timeout"
|
10
|
+
require_relative "delay"
|
11
|
+
require_relative "expiry"
|
12
|
+
require "json"
|
13
|
+
|
14
|
+
module Courier
|
15
|
+
class Send
|
16
|
+
class BaseMessage
|
17
|
+
attr_reader :data, :brand_id, :channels, :context, :metadata, :providers, :routing, :timeout, :delay, :expiry,
|
18
|
+
:additional_properties
|
19
|
+
|
20
|
+
# @param data [Send::MESSAGE_DATA] An arbitrary object that includes any data you want to pass to the message.
|
21
|
+
# The data will populate the corresponding template or elements variables.
|
22
|
+
# @param brand_id [String]
|
23
|
+
# @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."
|
24
|
+
# @param context [Send::MessageContext] Context to load with this recipient. Will override any context set on message.context.
|
25
|
+
# @param metadata [Send::MessageMetadata] Metadata such as utm tracking attached with the notification through this channel.
|
26
|
+
# @param providers [Send::MESSAGE_PROVIDERS] An object whose keys are valid provider identifiers which map to an object.
|
27
|
+
# @param routing [Send::Routing]
|
28
|
+
# @param timeout [Send::Timeout] Time in ms to attempt the channel before failing over to the next available channel.
|
29
|
+
# @param delay [Send::Delay] Defines the time to wait before delivering the message.
|
30
|
+
# @param expiry [Send::Expiry] "Expiry allows you to set an absolute or relative time in which a message expires.
|
31
|
+
# Note: This is only valid for the Courier Inbox channel as of 12-08-2022."
|
32
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
33
|
+
# @return [Send::BaseMessage]
|
34
|
+
def initialize(data: nil, brand_id: nil, channels: nil, context: nil, metadata: nil, providers: nil,
|
35
|
+
routing: nil, timeout: nil, delay: nil, expiry: nil, additional_properties: nil)
|
36
|
+
# @type [Send::MESSAGE_DATA] An arbitrary object that includes any data you want to pass to the message.
|
37
|
+
# The data will populate the corresponding template or elements variables.
|
38
|
+
@data = data
|
39
|
+
# @type [String]
|
40
|
+
@brand_id = brand_id
|
41
|
+
# @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."
|
42
|
+
@channels = channels
|
43
|
+
# @type [Send::MessageContext] Context to load with this recipient. Will override any context set on message.context.
|
44
|
+
@context = context
|
45
|
+
# @type [Send::MessageMetadata] Metadata such as utm tracking attached with the notification through this channel.
|
46
|
+
@metadata = metadata
|
47
|
+
# @type [Send::MESSAGE_PROVIDERS] An object whose keys are valid provider identifiers which map to an object.
|
48
|
+
@providers = providers
|
49
|
+
# @type [Send::Routing]
|
50
|
+
@routing = routing
|
51
|
+
# @type [Send::Timeout] Time in ms to attempt the channel before failing over to the next available channel.
|
52
|
+
@timeout = timeout
|
53
|
+
# @type [Send::Delay] Defines the time to wait before delivering the message.
|
54
|
+
@delay = delay
|
55
|
+
# @type [Send::Expiry] "Expiry allows you to set an absolute or relative time in which a message expires.
|
56
|
+
# Note: This is only valid for the Courier Inbox channel as of 12-08-2022."
|
57
|
+
@expiry = expiry
|
58
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
59
|
+
@additional_properties = additional_properties
|
60
|
+
end
|
61
|
+
|
62
|
+
# Deserialize a JSON object to an instance of BaseMessage
|
63
|
+
#
|
64
|
+
# @param json_object [JSON]
|
65
|
+
# @return [Send::BaseMessage]
|
66
|
+
def self.from_json(json_object:)
|
67
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
68
|
+
parsed_json = JSON.parse(json_object)
|
69
|
+
data = struct.data
|
70
|
+
brand_id = struct.brand_id
|
71
|
+
channels = struct.channels
|
72
|
+
if parsed_json["context"].nil?
|
73
|
+
context = nil
|
74
|
+
else
|
75
|
+
context = parsed_json["context"].to_json
|
76
|
+
context = Send::MessageContext.from_json(json_object: context)
|
77
|
+
end
|
78
|
+
if parsed_json["metadata"].nil?
|
79
|
+
metadata = nil
|
80
|
+
else
|
81
|
+
metadata = parsed_json["metadata"].to_json
|
82
|
+
metadata = Send::MessageMetadata.from_json(json_object: metadata)
|
83
|
+
end
|
84
|
+
providers = struct.providers
|
85
|
+
if parsed_json["routing"].nil?
|
86
|
+
routing = nil
|
87
|
+
else
|
88
|
+
routing = parsed_json["routing"].to_json
|
89
|
+
routing = Send::Routing.from_json(json_object: routing)
|
90
|
+
end
|
91
|
+
if parsed_json["timeout"].nil?
|
92
|
+
timeout = nil
|
93
|
+
else
|
94
|
+
timeout = parsed_json["timeout"].to_json
|
95
|
+
timeout = Send::Timeout.from_json(json_object: timeout)
|
96
|
+
end
|
97
|
+
if parsed_json["delay"].nil?
|
98
|
+
delay = nil
|
99
|
+
else
|
100
|
+
delay = parsed_json["delay"].to_json
|
101
|
+
delay = Send::Delay.from_json(json_object: delay)
|
102
|
+
end
|
103
|
+
if parsed_json["expiry"].nil?
|
104
|
+
expiry = nil
|
105
|
+
else
|
106
|
+
expiry = parsed_json["expiry"].to_json
|
107
|
+
expiry = Send::Expiry.from_json(json_object: expiry)
|
108
|
+
end
|
109
|
+
new(data: data, brand_id: brand_id, channels: channels, context: context, metadata: metadata,
|
110
|
+
providers: providers, routing: routing, timeout: timeout, delay: delay, expiry: expiry, additional_properties: struct)
|
111
|
+
end
|
112
|
+
|
113
|
+
# Serialize an instance of BaseMessage to a JSON object
|
114
|
+
#
|
115
|
+
# @return [JSON]
|
116
|
+
def to_json(*_args)
|
117
|
+
{
|
118
|
+
"data": @data,
|
119
|
+
"brand_id": @brand_id,
|
120
|
+
"channels": @channels,
|
121
|
+
"context": @context,
|
122
|
+
"metadata": @metadata,
|
123
|
+
"providers": @providers,
|
124
|
+
"routing": @routing,
|
125
|
+
"timeout": @timeout,
|
126
|
+
"delay": @delay,
|
127
|
+
"expiry": @expiry
|
128
|
+
}.to_json
|
129
|
+
end
|
130
|
+
|
131
|
+
# 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.
|
132
|
+
#
|
133
|
+
# @param obj [Object]
|
134
|
+
# @return [Void]
|
135
|
+
def self.validate_raw(obj:)
|
136
|
+
obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
|
137
|
+
obj.brand_id&.is_a?(String) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
|
138
|
+
obj.channels&.is_a?(Hash) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
|
139
|
+
obj.context.nil? || Send::MessageContext.validate_raw(obj: obj.context)
|
140
|
+
obj.metadata.nil? || Send::MessageMetadata.validate_raw(obj: obj.metadata)
|
141
|
+
obj.providers&.is_a?(Hash) != false || raise("Passed value for field obj.providers is not the expected type, validation failed.")
|
142
|
+
obj.routing.nil? || Send::Routing.validate_raw(obj: obj.routing)
|
143
|
+
obj.timeout.nil? || Send::Timeout.validate_raw(obj: obj.timeout)
|
144
|
+
obj.delay.nil? || Send::Delay.validate_raw(obj: obj.delay)
|
145
|
+
obj.expiry.nil? || Send::Expiry.validate_raw(obj: obj.expiry)
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
149
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Send
|
7
|
+
class BaseSocialPresence
|
8
|
+
attr_reader :url, :additional_properties
|
9
|
+
|
10
|
+
# @param url [String]
|
11
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
12
|
+
# @return [Send::BaseSocialPresence]
|
13
|
+
def initialize(url:, additional_properties: nil)
|
14
|
+
# @type [String]
|
15
|
+
@url = url
|
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 BaseSocialPresence
|
21
|
+
#
|
22
|
+
# @param json_object [JSON]
|
23
|
+
# @return [Send::BaseSocialPresence]
|
24
|
+
def self.from_json(json_object:)
|
25
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
26
|
+
JSON.parse(json_object)
|
27
|
+
url = struct.url
|
28
|
+
new(url: url, additional_properties: struct)
|
29
|
+
end
|
30
|
+
|
31
|
+
# Serialize an instance of BaseSocialPresence to a JSON object
|
32
|
+
#
|
33
|
+
# @return [JSON]
|
34
|
+
def to_json(*_args)
|
35
|
+
{ "url": @url }.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.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,87 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "brand_template_override"
|
4
|
+
require_relative "email_head"
|
5
|
+
require_relative "email_footer"
|
6
|
+
require_relative "email_header"
|
7
|
+
require "json"
|
8
|
+
|
9
|
+
module Courier
|
10
|
+
class Send
|
11
|
+
class BrandSettingsEmail
|
12
|
+
attr_reader :template_override, :head, :footer, :header, :additional_properties
|
13
|
+
|
14
|
+
# @param template_override [Send::BrandTemplateOverride]
|
15
|
+
# @param head [Send::EmailHead]
|
16
|
+
# @param footer [Send::EmailFooter]
|
17
|
+
# @param header [Send::EmailHeader]
|
18
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
19
|
+
# @return [Send::BrandSettingsEmail]
|
20
|
+
def initialize(template_override: nil, head: nil, footer: nil, header: nil, additional_properties: nil)
|
21
|
+
# @type [Send::BrandTemplateOverride]
|
22
|
+
@template_override = template_override
|
23
|
+
# @type [Send::EmailHead]
|
24
|
+
@head = head
|
25
|
+
# @type [Send::EmailFooter]
|
26
|
+
@footer = footer
|
27
|
+
# @type [Send::EmailHeader]
|
28
|
+
@header = header
|
29
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
30
|
+
@additional_properties = additional_properties
|
31
|
+
end
|
32
|
+
|
33
|
+
# Deserialize a JSON object to an instance of BrandSettingsEmail
|
34
|
+
#
|
35
|
+
# @param json_object [JSON]
|
36
|
+
# @return [Send::BrandSettingsEmail]
|
37
|
+
def self.from_json(json_object:)
|
38
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
39
|
+
parsed_json = JSON.parse(json_object)
|
40
|
+
if parsed_json["templateOverride"].nil?
|
41
|
+
template_override = nil
|
42
|
+
else
|
43
|
+
template_override = parsed_json["templateOverride"].to_json
|
44
|
+
template_override = Send::BrandTemplateOverride.from_json(json_object: template_override)
|
45
|
+
end
|
46
|
+
if parsed_json["head"].nil?
|
47
|
+
head = nil
|
48
|
+
else
|
49
|
+
head = parsed_json["head"].to_json
|
50
|
+
head = Send::EmailHead.from_json(json_object: head)
|
51
|
+
end
|
52
|
+
if parsed_json["footer"].nil?
|
53
|
+
footer = nil
|
54
|
+
else
|
55
|
+
footer = parsed_json["footer"].to_json
|
56
|
+
footer = Send::EmailFooter.from_json(json_object: footer)
|
57
|
+
end
|
58
|
+
if parsed_json["header"].nil?
|
59
|
+
header = nil
|
60
|
+
else
|
61
|
+
header = parsed_json["header"].to_json
|
62
|
+
header = Send::EmailHeader.from_json(json_object: header)
|
63
|
+
end
|
64
|
+
new(template_override: template_override, head: head, footer: footer, header: header,
|
65
|
+
additional_properties: struct)
|
66
|
+
end
|
67
|
+
|
68
|
+
# Serialize an instance of BrandSettingsEmail to a JSON object
|
69
|
+
#
|
70
|
+
# @return [JSON]
|
71
|
+
def to_json(*_args)
|
72
|
+
{ "templateOverride": @template_override, "head": @head, "footer": @footer, "header": @header }.to_json
|
73
|
+
end
|
74
|
+
|
75
|
+
# 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.
|
76
|
+
#
|
77
|
+
# @param obj [Object]
|
78
|
+
# @return [Void]
|
79
|
+
def self.validate_raw(obj:)
|
80
|
+
obj.template_override.nil? || Send::BrandTemplateOverride.validate_raw(obj: obj.template_override)
|
81
|
+
obj.head.nil? || Send::EmailHead.validate_raw(obj: obj.head)
|
82
|
+
obj.footer.nil? || Send::EmailFooter.validate_raw(obj: obj.footer)
|
83
|
+
obj.header.nil? || Send::EmailHeader.validate_raw(obj: obj.header)
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
@@ -0,0 +1,119 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "in_app_placement"
|
4
|
+
require_relative "widget_background"
|
5
|
+
require_relative "../../brands/types/brand_colors"
|
6
|
+
require_relative "icons"
|
7
|
+
require_relative "preferences"
|
8
|
+
require "json"
|
9
|
+
|
10
|
+
module Courier
|
11
|
+
class Send
|
12
|
+
class BrandSettingsInApp
|
13
|
+
attr_reader :border_radius, :disable_message_icon, :font_family, :placement, :widget_background, :colors, :icons,
|
14
|
+
:preferences, :additional_properties
|
15
|
+
|
16
|
+
# @param border_radius [String]
|
17
|
+
# @param disable_message_icon [Boolean]
|
18
|
+
# @param font_family [String]
|
19
|
+
# @param placement [Send::InAppPlacement]
|
20
|
+
# @param widget_background [Send::WidgetBackground]
|
21
|
+
# @param colors [Brands::BrandColors]
|
22
|
+
# @param icons [Send::Icons]
|
23
|
+
# @param preferences [Send::Preferences]
|
24
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
25
|
+
# @return [Send::BrandSettingsInApp]
|
26
|
+
def initialize(widget_background:, colors:, icons:, preferences:, border_radius: nil, disable_message_icon: nil,
|
27
|
+
font_family: nil, placement: nil, additional_properties: nil)
|
28
|
+
# @type [String]
|
29
|
+
@border_radius = border_radius
|
30
|
+
# @type [Boolean]
|
31
|
+
@disable_message_icon = disable_message_icon
|
32
|
+
# @type [String]
|
33
|
+
@font_family = font_family
|
34
|
+
# @type [Send::InAppPlacement]
|
35
|
+
@placement = placement
|
36
|
+
# @type [Send::WidgetBackground]
|
37
|
+
@widget_background = widget_background
|
38
|
+
# @type [Brands::BrandColors]
|
39
|
+
@colors = colors
|
40
|
+
# @type [Send::Icons]
|
41
|
+
@icons = icons
|
42
|
+
# @type [Send::Preferences]
|
43
|
+
@preferences = preferences
|
44
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
45
|
+
@additional_properties = additional_properties
|
46
|
+
end
|
47
|
+
|
48
|
+
# Deserialize a JSON object to an instance of BrandSettingsInApp
|
49
|
+
#
|
50
|
+
# @param json_object [JSON]
|
51
|
+
# @return [Send::BrandSettingsInApp]
|
52
|
+
def self.from_json(json_object:)
|
53
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
54
|
+
parsed_json = JSON.parse(json_object)
|
55
|
+
border_radius = struct.borderRadius
|
56
|
+
disable_message_icon = struct.disableMessageIcon
|
57
|
+
font_family = struct.fontFamily
|
58
|
+
placement = struct.placement
|
59
|
+
if parsed_json["widgetBackground"].nil?
|
60
|
+
widget_background = nil
|
61
|
+
else
|
62
|
+
widget_background = parsed_json["widgetBackground"].to_json
|
63
|
+
widget_background = Send::WidgetBackground.from_json(json_object: widget_background)
|
64
|
+
end
|
65
|
+
if parsed_json["colors"].nil?
|
66
|
+
colors = nil
|
67
|
+
else
|
68
|
+
colors = parsed_json["colors"].to_json
|
69
|
+
colors = Brands::BrandColors.from_json(json_object: colors)
|
70
|
+
end
|
71
|
+
if parsed_json["icons"].nil?
|
72
|
+
icons = nil
|
73
|
+
else
|
74
|
+
icons = parsed_json["icons"].to_json
|
75
|
+
icons = Send::Icons.from_json(json_object: icons)
|
76
|
+
end
|
77
|
+
if parsed_json["preferences"].nil?
|
78
|
+
preferences = nil
|
79
|
+
else
|
80
|
+
preferences = parsed_json["preferences"].to_json
|
81
|
+
preferences = Send::Preferences.from_json(json_object: preferences)
|
82
|
+
end
|
83
|
+
new(border_radius: border_radius, disable_message_icon: disable_message_icon, font_family: font_family,
|
84
|
+
placement: placement, widget_background: widget_background, colors: colors, icons: icons, preferences: preferences, additional_properties: struct)
|
85
|
+
end
|
86
|
+
|
87
|
+
# Serialize an instance of BrandSettingsInApp to a JSON object
|
88
|
+
#
|
89
|
+
# @return [JSON]
|
90
|
+
def to_json(*_args)
|
91
|
+
{
|
92
|
+
"borderRadius": @border_radius,
|
93
|
+
"disableMessageIcon": @disable_message_icon,
|
94
|
+
"fontFamily": @font_family,
|
95
|
+
"placement": @placement,
|
96
|
+
"widgetBackground": @widget_background,
|
97
|
+
"colors": @colors,
|
98
|
+
"icons": @icons,
|
99
|
+
"preferences": @preferences
|
100
|
+
}.to_json
|
101
|
+
end
|
102
|
+
|
103
|
+
# 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.
|
104
|
+
#
|
105
|
+
# @param obj [Object]
|
106
|
+
# @return [Void]
|
107
|
+
def self.validate_raw(obj:)
|
108
|
+
obj.border_radius&.is_a?(String) != false || raise("Passed value for field obj.border_radius is not the expected type, validation failed.")
|
109
|
+
obj.disable_message_icon&.is_a?(Boolean) != false || raise("Passed value for field obj.disable_message_icon is not the expected type, validation failed.")
|
110
|
+
obj.font_family&.is_a?(String) != false || raise("Passed value for field obj.font_family is not the expected type, validation failed.")
|
111
|
+
obj.placement&.is_a?(Send::InAppPlacement) != false || raise("Passed value for field obj.placement is not the expected type, validation failed.")
|
112
|
+
Send::WidgetBackground.validate_raw(obj: obj.widget_background)
|
113
|
+
Brands::BrandColors.validate_raw(obj: obj.colors)
|
114
|
+
Send::Icons.validate_raw(obj: obj.icons)
|
115
|
+
Send::Preferences.validate_raw(obj: obj.preferences)
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
@@ -0,0 +1,107 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "base_social_presence"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Courier
|
7
|
+
class Send
|
8
|
+
class BrandSettingsSocialPresence
|
9
|
+
attr_reader :inherit_default, :facebook, :instagram, :linkedin, :medium, :twitter, :additional_properties
|
10
|
+
|
11
|
+
# @param inherit_default [Boolean]
|
12
|
+
# @param facebook [Send::BaseSocialPresence]
|
13
|
+
# @param instagram [Send::BaseSocialPresence]
|
14
|
+
# @param linkedin [Send::BaseSocialPresence]
|
15
|
+
# @param medium [Send::BaseSocialPresence]
|
16
|
+
# @param twitter [Send::BaseSocialPresence]
|
17
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
18
|
+
# @return [Send::BrandSettingsSocialPresence]
|
19
|
+
def initialize(inherit_default: nil, facebook: nil, instagram: nil, linkedin: nil, medium: nil, twitter: nil,
|
20
|
+
additional_properties: nil)
|
21
|
+
# @type [Boolean]
|
22
|
+
@inherit_default = inherit_default
|
23
|
+
# @type [Send::BaseSocialPresence]
|
24
|
+
@facebook = facebook
|
25
|
+
# @type [Send::BaseSocialPresence]
|
26
|
+
@instagram = instagram
|
27
|
+
# @type [Send::BaseSocialPresence]
|
28
|
+
@linkedin = linkedin
|
29
|
+
# @type [Send::BaseSocialPresence]
|
30
|
+
@medium = medium
|
31
|
+
# @type [Send::BaseSocialPresence]
|
32
|
+
@twitter = twitter
|
33
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
34
|
+
@additional_properties = additional_properties
|
35
|
+
end
|
36
|
+
|
37
|
+
# Deserialize a JSON object to an instance of BrandSettingsSocialPresence
|
38
|
+
#
|
39
|
+
# @param json_object [JSON]
|
40
|
+
# @return [Send::BrandSettingsSocialPresence]
|
41
|
+
def self.from_json(json_object:)
|
42
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
43
|
+
parsed_json = JSON.parse(json_object)
|
44
|
+
inherit_default = struct.inheritDefault
|
45
|
+
if parsed_json["facebook"].nil?
|
46
|
+
facebook = nil
|
47
|
+
else
|
48
|
+
facebook = parsed_json["facebook"].to_json
|
49
|
+
facebook = Send::BaseSocialPresence.from_json(json_object: facebook)
|
50
|
+
end
|
51
|
+
if parsed_json["instagram"].nil?
|
52
|
+
instagram = nil
|
53
|
+
else
|
54
|
+
instagram = parsed_json["instagram"].to_json
|
55
|
+
instagram = Send::BaseSocialPresence.from_json(json_object: instagram)
|
56
|
+
end
|
57
|
+
if parsed_json["linkedin"].nil?
|
58
|
+
linkedin = nil
|
59
|
+
else
|
60
|
+
linkedin = parsed_json["linkedin"].to_json
|
61
|
+
linkedin = Send::BaseSocialPresence.from_json(json_object: linkedin)
|
62
|
+
end
|
63
|
+
if parsed_json["medium"].nil?
|
64
|
+
medium = nil
|
65
|
+
else
|
66
|
+
medium = parsed_json["medium"].to_json
|
67
|
+
medium = Send::BaseSocialPresence.from_json(json_object: medium)
|
68
|
+
end
|
69
|
+
if parsed_json["twitter"].nil?
|
70
|
+
twitter = nil
|
71
|
+
else
|
72
|
+
twitter = parsed_json["twitter"].to_json
|
73
|
+
twitter = Send::BaseSocialPresence.from_json(json_object: twitter)
|
74
|
+
end
|
75
|
+
new(inherit_default: inherit_default, facebook: facebook, instagram: instagram, linkedin: linkedin,
|
76
|
+
medium: medium, twitter: twitter, additional_properties: struct)
|
77
|
+
end
|
78
|
+
|
79
|
+
# Serialize an instance of BrandSettingsSocialPresence to a JSON object
|
80
|
+
#
|
81
|
+
# @return [JSON]
|
82
|
+
def to_json(*_args)
|
83
|
+
{
|
84
|
+
"inheritDefault": @inherit_default,
|
85
|
+
"facebook": @facebook,
|
86
|
+
"instagram": @instagram,
|
87
|
+
"linkedin": @linkedin,
|
88
|
+
"medium": @medium,
|
89
|
+
"twitter": @twitter
|
90
|
+
}.to_json
|
91
|
+
end
|
92
|
+
|
93
|
+
# 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.
|
94
|
+
#
|
95
|
+
# @param obj [Object]
|
96
|
+
# @return [Void]
|
97
|
+
def self.validate_raw(obj:)
|
98
|
+
obj.inherit_default&.is_a?(Boolean) != false || raise("Passed value for field obj.inherit_default is not the expected type, validation failed.")
|
99
|
+
obj.facebook.nil? || Send::BaseSocialPresence.validate_raw(obj: obj.facebook)
|
100
|
+
obj.instagram.nil? || Send::BaseSocialPresence.validate_raw(obj: obj.instagram)
|
101
|
+
obj.linkedin.nil? || Send::BaseSocialPresence.validate_raw(obj: obj.linkedin)
|
102
|
+
obj.medium.nil? || Send::BaseSocialPresence.validate_raw(obj: obj.medium)
|
103
|
+
obj.twitter.nil? || Send::BaseSocialPresence.validate_raw(obj: obj.twitter)
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
@@ -0,0 +1,88 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Send
|
7
|
+
class BrandTemplate
|
8
|
+
attr_reader :background_color, :blocks_background_color, :enabled, :footer, :head, :header, :width,
|
9
|
+
:additional_properties
|
10
|
+
|
11
|
+
# @param background_color [String]
|
12
|
+
# @param blocks_background_color [String]
|
13
|
+
# @param enabled [Boolean]
|
14
|
+
# @param footer [String]
|
15
|
+
# @param head [String]
|
16
|
+
# @param header [String]
|
17
|
+
# @param width [String]
|
18
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
19
|
+
# @return [Send::BrandTemplate]
|
20
|
+
def initialize(enabled:, background_color: nil, blocks_background_color: nil, footer: nil, head: nil,
|
21
|
+
header: nil, width: nil, additional_properties: nil)
|
22
|
+
# @type [String]
|
23
|
+
@background_color = background_color
|
24
|
+
# @type [String]
|
25
|
+
@blocks_background_color = blocks_background_color
|
26
|
+
# @type [Boolean]
|
27
|
+
@enabled = enabled
|
28
|
+
# @type [String]
|
29
|
+
@footer = footer
|
30
|
+
# @type [String]
|
31
|
+
@head = head
|
32
|
+
# @type [String]
|
33
|
+
@header = header
|
34
|
+
# @type [String]
|
35
|
+
@width = width
|
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 BrandTemplate
|
41
|
+
#
|
42
|
+
# @param json_object [JSON]
|
43
|
+
# @return [Send::BrandTemplate]
|
44
|
+
def self.from_json(json_object:)
|
45
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
46
|
+
JSON.parse(json_object)
|
47
|
+
background_color = struct.backgroundColor
|
48
|
+
blocks_background_color = struct.blocksBackgroundColor
|
49
|
+
enabled = struct.enabled
|
50
|
+
footer = struct.footer
|
51
|
+
head = struct.head
|
52
|
+
header = struct.header
|
53
|
+
width = struct.width
|
54
|
+
new(background_color: background_color, blocks_background_color: blocks_background_color, enabled: enabled,
|
55
|
+
footer: footer, head: head, header: header, width: width, additional_properties: struct)
|
56
|
+
end
|
57
|
+
|
58
|
+
# Serialize an instance of BrandTemplate to a JSON object
|
59
|
+
#
|
60
|
+
# @return [JSON]
|
61
|
+
def to_json(*_args)
|
62
|
+
{
|
63
|
+
"backgroundColor": @background_color,
|
64
|
+
"blocksBackgroundColor": @blocks_background_color,
|
65
|
+
"enabled": @enabled,
|
66
|
+
"footer": @footer,
|
67
|
+
"head": @head,
|
68
|
+
"header": @header,
|
69
|
+
"width": @width
|
70
|
+
}.to_json
|
71
|
+
end
|
72
|
+
|
73
|
+
# 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.
|
74
|
+
#
|
75
|
+
# @param obj [Object]
|
76
|
+
# @return [Void]
|
77
|
+
def self.validate_raw(obj:)
|
78
|
+
obj.background_color&.is_a?(String) != false || raise("Passed value for field obj.background_color is not the expected type, validation failed.")
|
79
|
+
obj.blocks_background_color&.is_a?(String) != false || raise("Passed value for field obj.blocks_background_color is not the expected type, validation failed.")
|
80
|
+
obj.enabled.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
|
81
|
+
obj.footer&.is_a?(String) != false || raise("Passed value for field obj.footer is not the expected type, validation failed.")
|
82
|
+
obj.head&.is_a?(String) != false || raise("Passed value for field obj.head is not the expected type, validation failed.")
|
83
|
+
obj.header&.is_a?(String) != false || raise("Passed value for field obj.header is not the expected type, validation failed.")
|
84
|
+
obj.width&.is_a?(String) != false || raise("Passed value for field obj.width is not the expected type, validation failed.")
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|