trycourier 3.1.4 → 3.4.0.pre.alpha1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ignore +2 -0
- data/CHANGELOG.md +105 -0
- data/README.md +257 -0
- data/SECURITY.md +23 -0
- data/lib/trycourier/client.rb +134 -0
- data/lib/trycourier/errors.rb +228 -0
- data/lib/trycourier/file_part.rb +58 -0
- data/lib/trycourier/internal/transport/base_client.rb +567 -0
- data/lib/trycourier/internal/transport/pooled_net_requester.rb +198 -0
- data/lib/trycourier/internal/type/array_of.rb +168 -0
- data/lib/trycourier/internal/type/base_model.rb +531 -0
- data/lib/trycourier/internal/type/base_page.rb +55 -0
- data/lib/trycourier/internal/type/boolean.rb +77 -0
- data/lib/trycourier/internal/type/converter.rb +327 -0
- data/lib/trycourier/internal/type/enum.rb +156 -0
- data/lib/trycourier/internal/type/file_input.rb +111 -0
- data/lib/trycourier/internal/type/hash_of.rb +188 -0
- data/lib/trycourier/internal/type/request_parameters.rb +42 -0
- data/lib/trycourier/internal/type/union.rb +250 -0
- data/lib/trycourier/internal/type/unknown.rb +81 -0
- data/lib/trycourier/internal/util.rb +915 -0
- data/lib/trycourier/internal.rb +20 -0
- data/lib/trycourier/models/alignment.rb +17 -0
- data/lib/trycourier/models/audience.rb +54 -0
- data/lib/trycourier/models/audience_delete_params.rb +14 -0
- data/lib/trycourier/models/audience_list_members_params.rb +22 -0
- data/lib/trycourier/models/audience_list_members_response.rb +57 -0
- data/lib/trycourier/models/audience_list_params.rb +22 -0
- data/lib/trycourier/models/audience_list_response.rb +22 -0
- data/lib/trycourier/models/audience_retrieve_params.rb +14 -0
- data/lib/trycourier/models/audience_update_params.rb +38 -0
- data/lib/trycourier/models/audience_update_response.rb +16 -0
- data/lib/trycourier/models/audit_event.rb +62 -0
- data/lib/trycourier/models/audit_event_list_params.rb +22 -0
- data/lib/trycourier/models/audit_event_list_response.rb +22 -0
- data/lib/trycourier/models/audit_event_retrieve_params.rb +14 -0
- data/lib/trycourier/models/auth_issue_token_params.rb +26 -0
- data/lib/trycourier/models/auth_issue_token_response.rb +16 -0
- data/lib/trycourier/models/automation_invoke_response.rb +15 -0
- data/lib/trycourier/models/automations/invoke_invoke_ad_hoc_params.rb +426 -0
- data/lib/trycourier/models/automations/invoke_invoke_by_template_params.rb +46 -0
- data/lib/trycourier/models/base_check.rb +49 -0
- data/lib/trycourier/models/base_template_tenant_association.rb +48 -0
- data/lib/trycourier/models/brand.rb +57 -0
- data/lib/trycourier/models/brand_colors.rb +21 -0
- data/lib/trycourier/models/brand_create_params.rb +38 -0
- data/lib/trycourier/models/brand_delete_params.rb +14 -0
- data/lib/trycourier/models/brand_list_params.rb +22 -0
- data/lib/trycourier/models/brand_list_response.rb +22 -0
- data/lib/trycourier/models/brand_retrieve_params.rb +14 -0
- data/lib/trycourier/models/brand_settings.rb +27 -0
- data/lib/trycourier/models/brand_settings_email.rb +62 -0
- data/lib/trycourier/models/brand_settings_in_app.rb +67 -0
- data/lib/trycourier/models/brand_snippet.rb +21 -0
- data/lib/trycourier/models/brand_snippets.rb +15 -0
- data/lib/trycourier/models/brand_template.rb +51 -0
- data/lib/trycourier/models/brand_update_params.rb +36 -0
- data/lib/trycourier/models/bulk_add_users_params.rb +20 -0
- data/lib/trycourier/models/bulk_create_job_params.rb +20 -0
- data/lib/trycourier/models/bulk_create_job_response.rb +16 -0
- data/lib/trycourier/models/bulk_list_users_params.rb +26 -0
- data/lib/trycourier/models/bulk_list_users_response.rb +50 -0
- data/lib/trycourier/models/bulk_retrieve_job_params.rb +14 -0
- data/lib/trycourier/models/bulk_retrieve_job_response.rb +64 -0
- data/lib/trycourier/models/bulk_run_job_params.rb +14 -0
- data/lib/trycourier/models/channel_classification.rb +19 -0
- data/lib/trycourier/models/channel_preference.rb +15 -0
- data/lib/trycourier/models/check.rb +15 -0
- data/lib/trycourier/models/default_preferences.rb +28 -0
- data/lib/trycourier/models/elemental_action_node_with_type.rb +24 -0
- data/lib/trycourier/models/elemental_base_node.rb +33 -0
- data/lib/trycourier/models/elemental_channel_node.rb +40 -0
- data/lib/trycourier/models/elemental_channel_node_with_type.rb +35 -0
- data/lib/trycourier/models/elemental_content.rb +30 -0
- data/lib/trycourier/models/elemental_content_sugar.rb +26 -0
- data/lib/trycourier/models/elemental_divider_node_with_type.rb +24 -0
- data/lib/trycourier/models/elemental_image_node_with_type.rb +24 -0
- data/lib/trycourier/models/elemental_meta_node_with_type.rb +24 -0
- data/lib/trycourier/models/elemental_node.rb +44 -0
- data/lib/trycourier/models/elemental_quote_node_with_type.rb +24 -0
- data/lib/trycourier/models/elemental_text_node_with_type.rb +24 -0
- data/lib/trycourier/models/email_footer.rb +21 -0
- data/lib/trycourier/models/email_head.rb +21 -0
- data/lib/trycourier/models/email_header.rb +27 -0
- data/lib/trycourier/models/filter.rb +62 -0
- data/lib/trycourier/models/filter_config.rb +62 -0
- data/lib/trycourier/models/icons.rb +21 -0
- data/lib/trycourier/models/inbound_bulk_message.rb +125 -0
- data/lib/trycourier/models/inbound_bulk_message_user.rb +39 -0
- data/lib/trycourier/models/inbound_track_event_params.rb +66 -0
- data/lib/trycourier/models/inbound_track_event_response.rb +21 -0
- data/lib/trycourier/models/list_delete_params.rb +14 -0
- data/lib/trycourier/models/list_list_params.rb +36 -0
- data/lib/trycourier/models/list_list_response.rb +22 -0
- data/lib/trycourier/models/list_restore_params.rb +14 -0
- data/lib/trycourier/models/list_retrieve_params.rb +14 -0
- data/lib/trycourier/models/list_update_params.rb +26 -0
- data/lib/trycourier/models/lists/subscription_add_params.rb +22 -0
- data/lib/trycourier/models/lists/subscription_list_params.rb +24 -0
- data/lib/trycourier/models/lists/subscription_list_response.rb +47 -0
- data/lib/trycourier/models/lists/subscription_subscribe_params.rb +22 -0
- data/lib/trycourier/models/lists/subscription_subscribe_user_params.rb +28 -0
- data/lib/trycourier/models/lists/subscription_unsubscribe_user_params.rb +22 -0
- data/lib/trycourier/models/logo.rb +21 -0
- data/lib/trycourier/models/message_cancel_params.rb +14 -0
- data/lib/trycourier/models/message_content_params.rb +14 -0
- data/lib/trycourier/models/message_content_response.rb +119 -0
- data/lib/trycourier/models/message_context.rb +16 -0
- data/lib/trycourier/models/message_details.rb +159 -0
- data/lib/trycourier/models/message_history_params.rb +22 -0
- data/lib/trycourier/models/message_history_response.rb +17 -0
- data/lib/trycourier/models/message_list_params.rb +138 -0
- data/lib/trycourier/models/message_list_response.rb +25 -0
- data/lib/trycourier/models/message_retrieve_params.rb +14 -0
- data/lib/trycourier/models/message_retrieve_response.rb +18 -0
- data/lib/trycourier/models/message_routing.rb +32 -0
- data/lib/trycourier/models/message_routing_channel.rb +16 -0
- data/lib/trycourier/models/notification_get_content.rb +225 -0
- data/lib/trycourier/models/notification_list_params.rb +29 -0
- data/lib/trycourier/models/notification_list_response.rb +103 -0
- data/lib/trycourier/models/notification_preference_details.rb +29 -0
- data/lib/trycourier/models/notification_retrieve_content_params.rb +14 -0
- data/lib/trycourier/models/notifications/check_delete_params.rb +22 -0
- data/lib/trycourier/models/notifications/check_list_params.rb +22 -0
- data/lib/trycourier/models/notifications/check_list_response.rb +18 -0
- data/lib/trycourier/models/notifications/check_update_params.rb +28 -0
- data/lib/trycourier/models/notifications/check_update_response.rb +18 -0
- data/lib/trycourier/models/notifications/draft_retrieve_content_params.rb +16 -0
- data/lib/trycourier/models/paging.rb +21 -0
- data/lib/trycourier/models/preference.rb +47 -0
- data/lib/trycourier/models/preference_status.rb +16 -0
- data/lib/trycourier/models/profile_create_params.rb +20 -0
- data/lib/trycourier/models/profile_create_response.rb +26 -0
- data/lib/trycourier/models/profile_delete_params.rb +14 -0
- data/lib/trycourier/models/profile_replace_params.rb +20 -0
- data/lib/trycourier/models/profile_replace_response.rb +26 -0
- data/lib/trycourier/models/profile_retrieve_params.rb +14 -0
- data/lib/trycourier/models/profile_retrieve_response.rb +22 -0
- data/lib/trycourier/models/profile_update_params.rb +49 -0
- data/lib/trycourier/models/profiles/list_delete_params.rb +16 -0
- data/lib/trycourier/models/profiles/list_delete_response.rb +28 -0
- data/lib/trycourier/models/profiles/list_retrieve_params.rb +24 -0
- data/lib/trycourier/models/profiles/list_retrieve_response.rb +73 -0
- data/lib/trycourier/models/profiles/list_subscribe_params.rb +39 -0
- data/lib/trycourier/models/profiles/list_subscribe_response.rb +28 -0
- data/lib/trycourier/models/put_subscriptions_recipient.rb +21 -0
- data/lib/trycourier/models/recipient.rb +105 -0
- data/lib/trycourier/models/recipient_preferences.rb +25 -0
- data/lib/trycourier/models/request_archive_params.rb +14 -0
- data/lib/trycourier/models/rule.rb +21 -0
- data/lib/trycourier/models/send_message_params.rb +507 -0
- data/lib/trycourier/models/send_message_response.rb +23 -0
- data/lib/trycourier/models/subscription_list.rb +33 -0
- data/lib/trycourier/models/subscription_topic_new.rb +50 -0
- data/lib/trycourier/models/tenant.rb +72 -0
- data/lib/trycourier/models/tenant_association.rb +53 -0
- data/lib/trycourier/models/tenant_delete_params.rb +14 -0
- data/lib/trycourier/models/tenant_list_params.rb +41 -0
- data/lib/trycourier/models/tenant_list_response.rb +74 -0
- data/lib/trycourier/models/tenant_list_users_params.rb +33 -0
- data/lib/trycourier/models/tenant_list_users_response.rb +73 -0
- data/lib/trycourier/models/tenant_retrieve_params.rb +14 -0
- data/lib/trycourier/models/tenant_update_params.rb +70 -0
- data/lib/trycourier/models/tenants/default_preferences/item_delete_params.rb +24 -0
- data/lib/trycourier/models/tenants/default_preferences/item_update_params.rb +24 -0
- data/lib/trycourier/models/tenants/template_list_params.rb +32 -0
- data/lib/trycourier/models/tenants/template_list_response.rb +100 -0
- data/lib/trycourier/models/tenants/template_retrieve_params.rb +22 -0
- data/lib/trycourier/models/text_style.rb +17 -0
- data/lib/trycourier/models/topic_preference.rb +53 -0
- data/lib/trycourier/models/translation_retrieve_params.rb +20 -0
- data/lib/trycourier/models/translation_retrieve_response.rb +7 -0
- data/lib/trycourier/models/translation_update_params.rb +26 -0
- data/lib/trycourier/models/user_recipient.rb +105 -0
- data/lib/trycourier/models/user_token.rb +179 -0
- data/lib/trycourier/models/users/preference_retrieve_params.rb +24 -0
- data/lib/trycourier/models/users/preference_retrieve_response.rb +27 -0
- data/lib/trycourier/models/users/preference_retrieve_topic_params.rb +31 -0
- data/lib/trycourier/models/users/preference_retrieve_topic_response.rb +18 -0
- data/lib/trycourier/models/users/preference_update_or_create_topic_params.rb +65 -0
- data/lib/trycourier/models/users/preference_update_or_create_topic_response.rb +18 -0
- data/lib/trycourier/models/users/tenant_add_multiple_params.rb +22 -0
- data/lib/trycourier/models/users/tenant_add_single_params.rb +28 -0
- data/lib/trycourier/models/users/tenant_list_params.rb +35 -0
- data/lib/trycourier/models/users/tenant_list_response.rb +75 -0
- data/lib/trycourier/models/users/tenant_remove_all_params.rb +16 -0
- data/lib/trycourier/models/users/tenant_remove_single_params.rb +22 -0
- data/lib/trycourier/models/users/token_add_multiple_params.rb +16 -0
- data/lib/trycourier/models/users/token_add_single_params.rb +22 -0
- data/lib/trycourier/models/users/token_delete_params.rb +22 -0
- data/lib/trycourier/models/users/token_list_params.rb +16 -0
- data/lib/trycourier/models/users/token_list_response.rb +10 -0
- data/lib/trycourier/models/users/token_retrieve_params.rb +22 -0
- data/lib/trycourier/models/users/token_retrieve_response.rb +38 -0
- data/lib/trycourier/models/users/token_update_params.rb +55 -0
- data/lib/trycourier/models/utm.rb +39 -0
- data/lib/trycourier/models/widget_background.rb +21 -0
- data/lib/trycourier/models.rb +267 -0
- data/lib/trycourier/request_options.rb +77 -0
- data/lib/trycourier/resources/audiences.rb +128 -0
- data/lib/trycourier/resources/audit_events.rb +56 -0
- data/lib/trycourier/resources/auth.rb +36 -0
- data/lib/trycourier/resources/automations/invoke.rb +81 -0
- data/lib/trycourier/resources/automations.rb +18 -0
- data/lib/trycourier/resources/brands.rb +128 -0
- data/lib/trycourier/resources/bulk.rb +126 -0
- data/lib/trycourier/resources/inbound.rb +47 -0
- data/lib/trycourier/resources/lists/subscriptions.rb +151 -0
- data/lib/trycourier/resources/lists.rb +131 -0
- data/lib/trycourier/resources/messages.rb +159 -0
- data/lib/trycourier/resources/notifications/checks.rb +90 -0
- data/lib/trycourier/resources/notifications/draft.rb +33 -0
- data/lib/trycourier/resources/notifications.rb +61 -0
- data/lib/trycourier/resources/profiles/lists.rb +94 -0
- data/lib/trycourier/resources/profiles.rb +150 -0
- data/lib/trycourier/resources/requests.rb +34 -0
- data/lib/trycourier/resources/send.rb +39 -0
- data/lib/trycourier/resources/tenants/default_preferences/items.rb +83 -0
- data/lib/trycourier/resources/tenants/default_preferences.rb +20 -0
- data/lib/trycourier/resources/tenants/templates.rb +69 -0
- data/lib/trycourier/resources/tenants.rb +157 -0
- data/lib/trycourier/resources/translations.rb +77 -0
- data/lib/trycourier/resources/users/preferences.rb +114 -0
- data/lib/trycourier/resources/users/tenants.rb +151 -0
- data/lib/trycourier/resources/users/tokens.rb +183 -0
- data/lib/trycourier/resources/users.rb +26 -0
- data/lib/trycourier/version.rb +5 -0
- data/lib/trycourier.rb +250 -122
- data/manifest.yaml +15 -0
- data/rbi/trycourier/client.rbi +94 -0
- data/rbi/trycourier/errors.rbi +205 -0
- data/rbi/trycourier/file_part.rbi +37 -0
- data/rbi/trycourier/internal/transport/base_client.rbi +295 -0
- data/rbi/trycourier/internal/transport/pooled_net_requester.rbi +80 -0
- data/rbi/trycourier/internal/type/array_of.rbi +104 -0
- data/rbi/trycourier/internal/type/base_model.rbi +304 -0
- data/rbi/trycourier/internal/type/base_page.rbi +42 -0
- data/rbi/trycourier/internal/type/boolean.rbi +58 -0
- data/rbi/trycourier/internal/type/converter.rbi +216 -0
- data/rbi/trycourier/internal/type/enum.rbi +82 -0
- data/rbi/trycourier/internal/type/file_input.rbi +59 -0
- data/rbi/trycourier/internal/type/hash_of.rbi +104 -0
- data/rbi/trycourier/internal/type/request_parameters.rbi +29 -0
- data/rbi/trycourier/internal/type/union.rbi +128 -0
- data/rbi/trycourier/internal/type/unknown.rbi +58 -0
- data/rbi/trycourier/internal/util.rbi +487 -0
- data/rbi/trycourier/internal.rbi +18 -0
- data/rbi/trycourier/models/alignment.rbi +21 -0
- data/rbi/trycourier/models/audience.rbi +76 -0
- data/rbi/trycourier/models/audience_delete_params.rbi +27 -0
- data/rbi/trycourier/models/audience_list_members_params.rbi +46 -0
- data/rbi/trycourier/models/audience_list_members_response.rbi +107 -0
- data/rbi/trycourier/models/audience_list_params.rbi +43 -0
- data/rbi/trycourier/models/audience_list_response.rbi +41 -0
- data/rbi/trycourier/models/audience_retrieve_params.rbi +30 -0
- data/rbi/trycourier/models/audience_update_params.rbi +62 -0
- data/rbi/trycourier/models/audience_update_response.rbi +31 -0
- data/rbi/trycourier/models/audit_event.rbi +84 -0
- data/rbi/trycourier/models/audit_event_list_params.rbi +43 -0
- data/rbi/trycourier/models/audit_event_list_response.rbi +44 -0
- data/rbi/trycourier/models/audit_event_retrieve_params.rbi +30 -0
- data/rbi/trycourier/models/auth_issue_token_params.rbi +43 -0
- data/rbi/trycourier/models/auth_issue_token_response.rbi +26 -0
- data/rbi/trycourier/models/automation_invoke_response.rbi +26 -0
- data/rbi/trycourier/models/automations/invoke_invoke_ad_hoc_params.rbi +963 -0
- data/rbi/trycourier/models/automations/invoke_invoke_by_template_params.rbi +70 -0
- data/rbi/trycourier/models/base_check.rbi +79 -0
- data/rbi/trycourier/models/base_template_tenant_association.rbi +72 -0
- data/rbi/trycourier/models/brand.rbi +85 -0
- data/rbi/trycourier/models/brand_colors.rbi +35 -0
- data/rbi/trycourier/models/brand_create_params.rbi +69 -0
- data/rbi/trycourier/models/brand_delete_params.rbi +27 -0
- data/rbi/trycourier/models/brand_list_params.rbi +43 -0
- data/rbi/trycourier/models/brand_list_response.rbi +41 -0
- data/rbi/trycourier/models/brand_retrieve_params.rbi +27 -0
- data/rbi/trycourier/models/brand_settings.rbi +56 -0
- data/rbi/trycourier/models/brand_settings_email.rbi +117 -0
- data/rbi/trycourier/models/brand_settings_in_app.rbi +116 -0
- data/rbi/trycourier/models/brand_snippet.rbi +26 -0
- data/rbi/trycourier/models/brand_snippets.rbi +31 -0
- data/rbi/trycourier/models/brand_template.rbi +71 -0
- data/rbi/trycourier/models/brand_update_params.rbi +65 -0
- data/rbi/trycourier/models/bulk_add_users_params.rbi +38 -0
- data/rbi/trycourier/models/bulk_create_job_params.rbi +53 -0
- data/rbi/trycourier/models/bulk_create_job_response.rbi +26 -0
- data/rbi/trycourier/models/bulk_list_users_params.rbi +45 -0
- data/rbi/trycourier/models/bulk_list_users_response.rbi +126 -0
- data/rbi/trycourier/models/bulk_retrieve_job_params.rbi +30 -0
- data/rbi/trycourier/models/bulk_retrieve_job_response.rbi +146 -0
- data/rbi/trycourier/models/bulk_run_job_params.rbi +27 -0
- data/rbi/trycourier/models/channel_classification.rbi +29 -0
- data/rbi/trycourier/models/channel_preference.rbi +31 -0
- data/rbi/trycourier/models/check.rbi +21 -0
- data/rbi/trycourier/models/default_preferences.rbi +57 -0
- data/rbi/trycourier/models/elemental_action_node_with_type.rbi +71 -0
- data/rbi/trycourier/models/elemental_base_node.rbi +48 -0
- data/rbi/trycourier/models/elemental_channel_node.rbi +56 -0
- data/rbi/trycourier/models/elemental_channel_node_with_type.rbi +81 -0
- data/rbi/trycourier/models/elemental_content.rbi +85 -0
- data/rbi/trycourier/models/elemental_content_sugar.rbi +37 -0
- data/rbi/trycourier/models/elemental_divider_node_with_type.rbi +71 -0
- data/rbi/trycourier/models/elemental_image_node_with_type.rbi +69 -0
- data/rbi/trycourier/models/elemental_meta_node_with_type.rbi +67 -0
- data/rbi/trycourier/models/elemental_node.rbi +36 -0
- data/rbi/trycourier/models/elemental_quote_node_with_type.rbi +69 -0
- data/rbi/trycourier/models/elemental_text_node_with_type.rbi +67 -0
- data/rbi/trycourier/models/email_footer.rbi +35 -0
- data/rbi/trycourier/models/email_head.rbi +34 -0
- data/rbi/trycourier/models/email_header.rbi +46 -0
- data/rbi/trycourier/models/filter.rbi +89 -0
- data/rbi/trycourier/models/filter_config.rbi +94 -0
- data/rbi/trycourier/models/icons.rbi +32 -0
- data/rbi/trycourier/models/inbound_bulk_message.rbi +189 -0
- data/rbi/trycourier/models/inbound_bulk_message_user.rbi +78 -0
- data/rbi/trycourier/models/inbound_track_event_params.rbi +99 -0
- data/rbi/trycourier/models/inbound_track_event_response.rbi +32 -0
- data/rbi/trycourier/models/list_delete_params.rbi +27 -0
- data/rbi/trycourier/models/list_list_params.rbi +57 -0
- data/rbi/trycourier/models/list_list_response.rbi +44 -0
- data/rbi/trycourier/models/list_restore_params.rbi +27 -0
- data/rbi/trycourier/models/list_retrieve_params.rbi +27 -0
- data/rbi/trycourier/models/list_update_params.rbi +50 -0
- data/rbi/trycourier/models/lists/subscription_add_params.rbi +43 -0
- data/rbi/trycourier/models/lists/subscription_list_params.rbi +48 -0
- data/rbi/trycourier/models/lists/subscription_list_response.rbi +104 -0
- data/rbi/trycourier/models/lists/subscription_subscribe_params.rbi +43 -0
- data/rbi/trycourier/models/lists/subscription_subscribe_user_params.rbi +55 -0
- data/rbi/trycourier/models/lists/subscription_unsubscribe_user_params.rbi +40 -0
- data/rbi/trycourier/models/logo.rbi +30 -0
- data/rbi/trycourier/models/message_cancel_params.rbi +27 -0
- data/rbi/trycourier/models/message_content_params.rbi +27 -0
- data/rbi/trycourier/models/message_content_response.rbi +226 -0
- data/rbi/trycourier/models/message_context.rbi +27 -0
- data/rbi/trycourier/models/message_details.rbi +231 -0
- data/rbi/trycourier/models/message_history_params.rbi +43 -0
- data/rbi/trycourier/models/message_history_response.rbi +32 -0
- data/rbi/trycourier/models/message_list_params.rbi +174 -0
- data/rbi/trycourier/models/message_list_response.rbi +51 -0
- data/rbi/trycourier/models/message_retrieve_params.rbi +30 -0
- data/rbi/trycourier/models/message_retrieve_response.rbi +34 -0
- data/rbi/trycourier/models/message_routing.rbi +58 -0
- data/rbi/trycourier/models/message_routing_channel.rbi +17 -0
- data/rbi/trycourier/models/notification_get_content.rbi +503 -0
- data/rbi/trycourier/models/notification_list_params.rbi +52 -0
- data/rbi/trycourier/models/notification_list_response.rbi +217 -0
- data/rbi/trycourier/models/notification_preference_details.rbi +48 -0
- data/rbi/trycourier/models/notification_retrieve_content_params.rbi +30 -0
- data/rbi/trycourier/models/notifications/check_delete_params.rbi +40 -0
- data/rbi/trycourier/models/notifications/check_list_params.rbi +40 -0
- data/rbi/trycourier/models/notifications/check_list_response.rbi +32 -0
- data/rbi/trycourier/models/notifications/check_update_params.rbi +48 -0
- data/rbi/trycourier/models/notifications/check_update_response.rbi +32 -0
- data/rbi/trycourier/models/notifications/draft_retrieve_content_params.rbi +34 -0
- data/rbi/trycourier/models/paging.rbi +30 -0
- data/rbi/trycourier/models/preference.rbi +72 -0
- data/rbi/trycourier/models/preference_status.rbi +23 -0
- data/rbi/trycourier/models/profile_create_params.rbi +38 -0
- data/rbi/trycourier/models/profile_create_response.rbi +65 -0
- data/rbi/trycourier/models/profile_delete_params.rbi +27 -0
- data/rbi/trycourier/models/profile_replace_params.rbi +38 -0
- data/rbi/trycourier/models/profile_replace_response.rbi +67 -0
- data/rbi/trycourier/models/profile_retrieve_params.rbi +30 -0
- data/rbi/trycourier/models/profile_retrieve_response.rbi +48 -0
- data/rbi/trycourier/models/profile_update_params.rbi +84 -0
- data/rbi/trycourier/models/profiles/list_delete_params.rbi +34 -0
- data/rbi/trycourier/models/profiles/list_delete_response.rbi +73 -0
- data/rbi/trycourier/models/profiles/list_retrieve_params.rbi +48 -0
- data/rbi/trycourier/models/profiles/list_retrieve_response.rbi +135 -0
- data/rbi/trycourier/models/profiles/list_subscribe_params.rbi +89 -0
- data/rbi/trycourier/models/profiles/list_subscribe_response.rbi +73 -0
- data/rbi/trycourier/models/put_subscriptions_recipient.rbi +48 -0
- data/rbi/trycourier/models/recipient.rbi +153 -0
- data/rbi/trycourier/models/recipient_preferences.rbi +58 -0
- data/rbi/trycourier/models/request_archive_params.rbi +27 -0
- data/rbi/trycourier/models/rule.rbi +28 -0
- data/rbi/trycourier/models/send_message_params.rbi +1107 -0
- data/rbi/trycourier/models/send_message_response.rbi +36 -0
- data/rbi/trycourier/models/subscription_list.rbi +48 -0
- data/rbi/trycourier/models/subscription_topic_new.rbi +95 -0
- data/rbi/trycourier/models/tenant.rbi +95 -0
- data/rbi/trycourier/models/tenant_association.rbi +79 -0
- data/rbi/trycourier/models/tenant_delete_params.rbi +27 -0
- data/rbi/trycourier/models/tenant_list_params.rbi +59 -0
- data/rbi/trycourier/models/tenant_list_response.rbi +111 -0
- data/rbi/trycourier/models/tenant_list_users_params.rbi +54 -0
- data/rbi/trycourier/models/tenant_list_users_response.rbi +112 -0
- data/rbi/trycourier/models/tenant_retrieve_params.rbi +27 -0
- data/rbi/trycourier/models/tenant_update_params.rbi +93 -0
- data/rbi/trycourier/models/tenants/default_preferences/item_delete_params.rbi +42 -0
- data/rbi/trycourier/models/tenants/default_preferences/item_update_params.rbi +42 -0
- data/rbi/trycourier/models/tenants/template_list_params.rbi +56 -0
- data/rbi/trycourier/models/tenants/template_list_response.rbi +214 -0
- data/rbi/trycourier/models/tenants/template_retrieve_params.rbi +40 -0
- data/rbi/trycourier/models/text_style.rbi +21 -0
- data/rbi/trycourier/models/topic_preference.rbi +75 -0
- data/rbi/trycourier/models/translation_retrieve_params.rbi +38 -0
- data/rbi/trycourier/models/translation_retrieve_response.rbi +7 -0
- data/rbi/trycourier/models/translation_update_params.rbi +46 -0
- data/rbi/trycourier/models/user_recipient.rbi +154 -0
- data/rbi/trycourier/models/user_token.rbi +267 -0
- data/rbi/trycourier/models/users/preference_retrieve_params.rbi +48 -0
- data/rbi/trycourier/models/users/preference_retrieve_response.rbi +53 -0
- data/rbi/trycourier/models/users/preference_retrieve_topic_params.rbi +54 -0
- data/rbi/trycourier/models/users/preference_retrieve_topic_response.rbi +35 -0
- data/rbi/trycourier/models/users/preference_update_or_create_topic_params.rbi +129 -0
- data/rbi/trycourier/models/users/preference_update_or_create_topic_response.rbi +28 -0
- data/rbi/trycourier/models/users/tenant_add_multiple_params.rbi +43 -0
- data/rbi/trycourier/models/users/tenant_add_single_params.rbi +48 -0
- data/rbi/trycourier/models/users/tenant_list_params.rbi +56 -0
- data/rbi/trycourier/models/users/tenant_list_response.rbi +116 -0
- data/rbi/trycourier/models/users/tenant_remove_all_params.rbi +34 -0
- data/rbi/trycourier/models/users/tenant_remove_single_params.rbi +40 -0
- data/rbi/trycourier/models/users/token_add_multiple_params.rbi +34 -0
- data/rbi/trycourier/models/users/token_add_single_params.rbi +40 -0
- data/rbi/trycourier/models/users/token_delete_params.rbi +40 -0
- data/rbi/trycourier/models/users/token_list_params.rbi +34 -0
- data/rbi/trycourier/models/users/token_list_response.rbi +13 -0
- data/rbi/trycourier/models/users/token_retrieve_params.rbi +40 -0
- data/rbi/trycourier/models/users/token_retrieve_response.rbi +104 -0
- data/rbi/trycourier/models/users/token_update_params.rbi +94 -0
- data/rbi/trycourier/models/utm.rbi +57 -0
- data/rbi/trycourier/models/widget_background.rbi +35 -0
- data/rbi/trycourier/models.rbi +234 -0
- data/rbi/trycourier/request_options.rbi +59 -0
- data/rbi/trycourier/resources/audiences.rbi +94 -0
- data/rbi/trycourier/resources/audit_events.rbi +40 -0
- data/rbi/trycourier/resources/auth.rbi +23 -0
- data/rbi/trycourier/resources/automations/invoke.rbi +66 -0
- data/rbi/trycourier/resources/automations.rbi +15 -0
- data/rbi/trycourier/resources/brands.rbi +94 -0
- data/rbi/trycourier/resources/bulk.rbi +88 -0
- data/rbi/trycourier/resources/inbound.rbi +38 -0
- data/rbi/trycourier/resources/lists/subscriptions.rbi +104 -0
- data/rbi/trycourier/resources/lists.rbi +95 -0
- data/rbi/trycourier/resources/messages.rbi +139 -0
- data/rbi/trycourier/resources/notifications/checks.rbi +53 -0
- data/rbi/trycourier/resources/notifications/draft.rbi +23 -0
- data/rbi/trycourier/resources/notifications.rbi +42 -0
- data/rbi/trycourier/resources/profiles/lists.rbi +63 -0
- data/rbi/trycourier/resources/profiles.rbi +97 -0
- data/rbi/trycourier/resources/requests.rbi +26 -0
- data/rbi/trycourier/resources/send.rbi +27 -0
- data/rbi/trycourier/resources/tenants/default_preferences/items.rbi +66 -0
- data/rbi/trycourier/resources/tenants/default_preferences.rbi +19 -0
- data/rbi/trycourier/resources/tenants/templates.rbi +51 -0
- data/rbi/trycourier/resources/tenants.rbi +120 -0
- data/rbi/trycourier/resources/translations.rbi +51 -0
- data/rbi/trycourier/resources/users/preferences.rbi +80 -0
- data/rbi/trycourier/resources/users/tenants.rbi +106 -0
- data/rbi/trycourier/resources/users/tokens.rbi +133 -0
- data/rbi/trycourier/resources/users.rbi +21 -0
- data/rbi/trycourier/version.rbi +5 -0
- data/sig/trycourier/client.rbs +56 -0
- data/sig/trycourier/errors.rbs +117 -0
- data/sig/trycourier/file_part.rbs +21 -0
- data/sig/trycourier/internal/transport/base_client.rbs +131 -0
- data/sig/trycourier/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/trycourier/internal/type/array_of.rbs +48 -0
- data/sig/trycourier/internal/type/base_model.rbs +102 -0
- data/sig/trycourier/internal/type/base_page.rbs +24 -0
- data/sig/trycourier/internal/type/boolean.rbs +26 -0
- data/sig/trycourier/internal/type/converter.rbs +79 -0
- data/sig/trycourier/internal/type/enum.rbs +32 -0
- data/sig/trycourier/internal/type/file_input.rbs +25 -0
- data/sig/trycourier/internal/type/hash_of.rbs +48 -0
- data/sig/trycourier/internal/type/request_parameters.rbs +19 -0
- data/sig/trycourier/internal/type/union.rbs +52 -0
- data/sig/trycourier/internal/type/unknown.rbs +26 -0
- data/sig/trycourier/internal/util.rbs +185 -0
- data/sig/trycourier/internal.rbs +9 -0
- data/sig/trycourier/models/alignment.rbs +16 -0
- data/sig/trycourier/models/audience.rbs +45 -0
- data/sig/trycourier/models/audience_delete_params.rbs +15 -0
- data/sig/trycourier/models/audience_list_members_params.rbs +23 -0
- data/sig/trycourier/models/audience_list_members_response.rbs +62 -0
- data/sig/trycourier/models/audience_list_params.rbs +23 -0
- data/sig/trycourier/models/audience_list_response.rbs +22 -0
- data/sig/trycourier/models/audience_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/audience_update_params.rbs +32 -0
- data/sig/trycourier/models/audience_update_response.rbs +13 -0
- data/sig/trycourier/models/audit_event.rbs +57 -0
- data/sig/trycourier/models/audit_event_list_params.rbs +23 -0
- data/sig/trycourier/models/audit_event_list_response.rbs +22 -0
- data/sig/trycourier/models/audit_event_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/auth_issue_token_params.rbs +28 -0
- data/sig/trycourier/models/auth_issue_token_response.rbs +13 -0
- data/sig/trycourier/models/automation_invoke_response.rbs +13 -0
- data/sig/trycourier/models/automations/invoke_invoke_ad_hoc_params.rbs +435 -0
- data/sig/trycourier/models/automations/invoke_invoke_by_template_params.rbs +48 -0
- data/sig/trycourier/models/base_check.rbs +52 -0
- data/sig/trycourier/models/base_template_tenant_association.rbs +40 -0
- data/sig/trycourier/models/brand.rbs +55 -0
- data/sig/trycourier/models/brand_colors.rbs +15 -0
- data/sig/trycourier/models/brand_create_params.rbs +41 -0
- data/sig/trycourier/models/brand_delete_params.rbs +15 -0
- data/sig/trycourier/models/brand_list_params.rbs +23 -0
- data/sig/trycourier/models/brand_list_response.rbs +22 -0
- data/sig/trycourier/models/brand_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/brand_settings.rbs +30 -0
- data/sig/trycourier/models/brand_settings_email.rbs +68 -0
- data/sig/trycourier/models/brand_settings_in_app.rbs +63 -0
- data/sig/trycourier/models/brand_snippet.rbs +15 -0
- data/sig/trycourier/models/brand_snippets.rbs +13 -0
- data/sig/trycourier/models/brand_template.rbs +50 -0
- data/sig/trycourier/models/brand_update_params.rbs +36 -0
- data/sig/trycourier/models/bulk_add_users_params.rbs +24 -0
- data/sig/trycourier/models/bulk_create_job_params.rbs +24 -0
- data/sig/trycourier/models/bulk_create_job_response.rbs +13 -0
- data/sig/trycourier/models/bulk_list_users_params.rbs +23 -0
- data/sig/trycourier/models/bulk_list_users_response.rbs +65 -0
- data/sig/trycourier/models/bulk_retrieve_job_params.rbs +15 -0
- data/sig/trycourier/models/bulk_retrieve_job_response.rbs +66 -0
- data/sig/trycourier/models/bulk_run_job_params.rbs +15 -0
- data/sig/trycourier/models/channel_classification.rbs +19 -0
- data/sig/trycourier/models/channel_preference.rbs +16 -0
- data/sig/trycourier/models/check.rbs +15 -0
- data/sig/trycourier/models/default_preferences.rbs +28 -0
- data/sig/trycourier/models/elemental_action_node_with_type.rbs +32 -0
- data/sig/trycourier/models/elemental_base_node.rbs +30 -0
- data/sig/trycourier/models/elemental_channel_node.rbs +19 -0
- data/sig/trycourier/models/elemental_channel_node_with_type.rbs +32 -0
- data/sig/trycourier/models/elemental_content.rbs +30 -0
- data/sig/trycourier/models/elemental_content_sugar.rbs +15 -0
- data/sig/trycourier/models/elemental_divider_node_with_type.rbs +32 -0
- data/sig/trycourier/models/elemental_image_node_with_type.rbs +32 -0
- data/sig/trycourier/models/elemental_meta_node_with_type.rbs +32 -0
- data/sig/trycourier/models/elemental_node.rbs +18 -0
- data/sig/trycourier/models/elemental_quote_node_with_type.rbs +32 -0
- data/sig/trycourier/models/elemental_text_node_with_type.rbs +32 -0
- data/sig/trycourier/models/email_footer.rbs +15 -0
- data/sig/trycourier/models/email_head.rbs +15 -0
- data/sig/trycourier/models/email_header.rbs +26 -0
- data/sig/trycourier/models/filter.rbs +69 -0
- data/sig/trycourier/models/filter_config.rbs +69 -0
- data/sig/trycourier/models/icons.rbs +15 -0
- data/sig/trycourier/models/inbound_bulk_message.rbs +106 -0
- data/sig/trycourier/models/inbound_bulk_message_user.rbs +44 -0
- data/sig/trycourier/models/inbound_track_event_params.rbs +56 -0
- data/sig/trycourier/models/inbound_track_event_response.rbs +13 -0
- data/sig/trycourier/models/list_delete_params.rbs +15 -0
- data/sig/trycourier/models/list_list_params.rbs +28 -0
- data/sig/trycourier/models/list_list_response.rbs +25 -0
- data/sig/trycourier/models/list_restore_params.rbs +15 -0
- data/sig/trycourier/models/list_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/list_update_params.rbs +28 -0
- data/sig/trycourier/models/lists/subscription_add_params.rbs +26 -0
- data/sig/trycourier/models/lists/subscription_list_params.rbs +25 -0
- data/sig/trycourier/models/lists/subscription_list_response.rbs +54 -0
- data/sig/trycourier/models/lists/subscription_subscribe_params.rbs +26 -0
- data/sig/trycourier/models/lists/subscription_subscribe_user_params.rbs +30 -0
- data/sig/trycourier/models/lists/subscription_unsubscribe_user_params.rbs +25 -0
- data/sig/trycourier/models/logo.rbs +15 -0
- data/sig/trycourier/models/message_cancel_params.rbs +15 -0
- data/sig/trycourier/models/message_content_params.rbs +15 -0
- data/sig/trycourier/models/message_content_response.rbs +99 -0
- data/sig/trycourier/models/message_context.rbs +13 -0
- data/sig/trycourier/models/message_details.rbs +141 -0
- data/sig/trycourier/models/message_history_params.rbs +23 -0
- data/sig/trycourier/models/message_history_response.rbs +13 -0
- data/sig/trycourier/models/message_list_params.rbs +97 -0
- data/sig/trycourier/models/message_list_response.rbs +25 -0
- data/sig/trycourier/models/message_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/message_retrieve_response.rbs +18 -0
- data/sig/trycourier/models/message_routing.rbs +36 -0
- data/sig/trycourier/models/message_routing_channel.rbs +11 -0
- data/sig/trycourier/models/notification_get_content.rbs +211 -0
- data/sig/trycourier/models/notification_list_params.rbs +28 -0
- data/sig/trycourier/models/notification_list_response.rbs +106 -0
- data/sig/trycourier/models/notification_preference_details.rbs +30 -0
- data/sig/trycourier/models/notification_retrieve_content_params.rbs +15 -0
- data/sig/trycourier/models/notifications/check_delete_params.rbs +25 -0
- data/sig/trycourier/models/notifications/check_list_params.rbs +25 -0
- data/sig/trycourier/models/notifications/check_list_response.rbs +15 -0
- data/sig/trycourier/models/notifications/check_update_params.rbs +30 -0
- data/sig/trycourier/models/notifications/check_update_response.rbs +15 -0
- data/sig/trycourier/models/notifications/draft_retrieve_content_params.rbs +17 -0
- data/sig/trycourier/models/paging.rbs +15 -0
- data/sig/trycourier/models/preference.rbs +47 -0
- data/sig/trycourier/models/preference_status.rbs +15 -0
- data/sig/trycourier/models/profile_create_params.rbs +24 -0
- data/sig/trycourier/models/profile_create_response.rbs +28 -0
- data/sig/trycourier/models/profile_delete_params.rbs +15 -0
- data/sig/trycourier/models/profile_replace_params.rbs +24 -0
- data/sig/trycourier/models/profile_replace_response.rbs +28 -0
- data/sig/trycourier/models/profile_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/profile_retrieve_response.rbs +25 -0
- data/sig/trycourier/models/profile_update_params.rbs +38 -0
- data/sig/trycourier/models/profiles/list_delete_params.rbs +17 -0
- data/sig/trycourier/models/profiles/list_delete_response.rbs +30 -0
- data/sig/trycourier/models/profiles/list_retrieve_params.rbs +25 -0
- data/sig/trycourier/models/profiles/list_retrieve_response.rbs +64 -0
- data/sig/trycourier/models/profiles/list_subscribe_params.rbs +45 -0
- data/sig/trycourier/models/profiles/list_subscribe_response.rbs +30 -0
- data/sig/trycourier/models/put_subscriptions_recipient.rbs +22 -0
- data/sig/trycourier/models/recipient.rbs +87 -0
- data/sig/trycourier/models/recipient_preferences.rbs +25 -0
- data/sig/trycourier/models/request_archive_params.rbs +15 -0
- data/sig/trycourier/models/rule.rbs +15 -0
- data/sig/trycourier/models/send_message_params.rbs +418 -0
- data/sig/trycourier/models/send_message_response.rbs +13 -0
- data/sig/trycourier/models/subscription_list.rbs +30 -0
- data/sig/trycourier/models/subscription_topic_new.rbs +42 -0
- data/sig/trycourier/models/tenant.rbs +50 -0
- data/sig/trycourier/models/tenant_association.rbs +45 -0
- data/sig/trycourier/models/tenant_delete_params.rbs +15 -0
- data/sig/trycourier/models/tenant_list_params.rbs +32 -0
- data/sig/trycourier/models/tenant_list_response.rbs +55 -0
- data/sig/trycourier/models/tenant_list_users_params.rbs +28 -0
- data/sig/trycourier/models/tenant_list_users_response.rbs +55 -0
- data/sig/trycourier/models/tenant_retrieve_params.rbs +15 -0
- data/sig/trycourier/models/tenant_update_params.rbs +51 -0
- data/sig/trycourier/models/tenants/default_preferences/item_delete_params.rbs +27 -0
- data/sig/trycourier/models/tenants/default_preferences/item_update_params.rbs +29 -0
- data/sig/trycourier/models/tenants/template_list_params.rbs +30 -0
- data/sig/trycourier/models/tenants/template_list_response.rbs +88 -0
- data/sig/trycourier/models/tenants/template_retrieve_params.rbs +25 -0
- data/sig/trycourier/models/text_style.rbs +16 -0
- data/sig/trycourier/models/topic_preference.rbs +45 -0
- data/sig/trycourier/models/translation_retrieve_params.rbs +23 -0
- data/sig/trycourier/models/translation_retrieve_response.rbs +5 -0
- data/sig/trycourier/models/translation_update_params.rbs +28 -0
- data/sig/trycourier/models/user_recipient.rbs +87 -0
- data/sig/trycourier/models/user_token.rbs +137 -0
- data/sig/trycourier/models/users/preference_retrieve_params.rbs +25 -0
- data/sig/trycourier/models/users/preference_retrieve_response.rbs +27 -0
- data/sig/trycourier/models/users/preference_retrieve_topic_params.rbs +30 -0
- data/sig/trycourier/models/users/preference_retrieve_topic_response.rbs +16 -0
- data/sig/trycourier/models/users/preference_update_or_create_topic_params.rbs +65 -0
- data/sig/trycourier/models/users/preference_update_or_create_topic_response.rbs +15 -0
- data/sig/trycourier/models/users/tenant_add_multiple_params.rbs +26 -0
- data/sig/trycourier/models/users/tenant_add_single_params.rbs +30 -0
- data/sig/trycourier/models/users/tenant_list_params.rbs +30 -0
- data/sig/trycourier/models/users/tenant_list_response.rbs +57 -0
- data/sig/trycourier/models/users/tenant_remove_all_params.rbs +17 -0
- data/sig/trycourier/models/users/tenant_remove_single_params.rbs +25 -0
- data/sig/trycourier/models/users/token_add_multiple_params.rbs +17 -0
- data/sig/trycourier/models/users/token_add_single_params.rbs +27 -0
- data/sig/trycourier/models/users/token_delete_params.rbs +25 -0
- data/sig/trycourier/models/users/token_list_params.rbs +17 -0
- data/sig/trycourier/models/users/token_list_response.rbs +9 -0
- data/sig/trycourier/models/users/token_retrieve_params.rbs +25 -0
- data/sig/trycourier/models/users/token_retrieve_response.rbs +46 -0
- data/sig/trycourier/models/users/token_update_params.rbs +47 -0
- data/sig/trycourier/models/utm.rbs +40 -0
- data/sig/trycourier/models/widget_background.rbs +15 -0
- data/sig/trycourier/models.rbs +227 -0
- data/sig/trycourier/request_options.rbs +36 -0
- data/sig/trycourier/resources/audiences.rbs +36 -0
- data/sig/trycourier/resources/audit_events.rbs +17 -0
- data/sig/trycourier/resources/auth.rbs +13 -0
- data/sig/trycourier/resources/automations/invoke.rbs +29 -0
- data/sig/trycourier/resources/automations.rbs +9 -0
- data/sig/trycourier/resources/brands.rbs +38 -0
- data/sig/trycourier/resources/bulk.rbs +34 -0
- data/sig/trycourier/resources/inbound.rbs +16 -0
- data/sig/trycourier/resources/lists/subscriptions.rbs +40 -0
- data/sig/trycourier/resources/lists.rbs +37 -0
- data/sig/trycourier/resources/messages.rbs +46 -0
- data/sig/trycourier/resources/notifications/checks.rbs +28 -0
- data/sig/trycourier/resources/notifications/draft.rbs +14 -0
- data/sig/trycourier/resources/notifications.rbs +22 -0
- data/sig/trycourier/resources/profiles/lists.rbs +26 -0
- data/sig/trycourier/resources/profiles.rbs +37 -0
- data/sig/trycourier/resources/requests.rbs +12 -0
- data/sig/trycourier/resources/send.rbs +12 -0
- data/sig/trycourier/resources/tenants/default_preferences/items.rbs +26 -0
- data/sig/trycourier/resources/tenants/default_preferences.rbs +11 -0
- data/sig/trycourier/resources/tenants/templates.rbs +22 -0
- data/sig/trycourier/resources/tenants.rbs +46 -0
- data/sig/trycourier/resources/translations.rbs +20 -0
- data/sig/trycourier/resources/users/preferences.rbs +30 -0
- data/sig/trycourier/resources/users/tenants.rbs +40 -0
- data/sig/trycourier/resources/users/tokens.rbs +50 -0
- data/sig/trycourier/resources/users.rbs +13 -0
- data/sig/trycourier/version.rbs +3 -0
- metadata +692 -376
- data/lib/environment.rb +0 -7
- data/lib/gemconfig.rb +0 -14
- data/lib/requests.rb +0 -121
- data/lib/trycourier/audiences/client.rb +0 -235
- data/lib/trycourier/audiences/types/audience.rb +0 -86
- data/lib/trycourier/audiences/types/audience_list_response.rb +0 -62
- data/lib/trycourier/audiences/types/audience_member.rb +0 -74
- data/lib/trycourier/audiences/types/audience_member_get_response.rb +0 -53
- data/lib/trycourier/audiences/types/audience_member_list_response.rb +0 -62
- data/lib/trycourier/audiences/types/audience_update_response.rb +0 -53
- data/lib/trycourier/audiences/types/base_filter_config.rb +0 -53
- data/lib/trycourier/audiences/types/comparison_operator.rb +0 -21
- data/lib/trycourier/audiences/types/filter.rb +0 -50
- data/lib/trycourier/audiences/types/filter_config.rb +0 -50
- data/lib/trycourier/audiences/types/logical_operator.rb +0 -10
- data/lib/trycourier/audiences/types/nested_filter_config.rb +0 -63
- data/lib/trycourier/audiences/types/operator.rb +0 -48
- data/lib/trycourier/audiences/types/single_filter_config.rb +0 -64
- data/lib/trycourier/audit_events/client.rb +0 -104
- data/lib/trycourier/audit_events/types/actor.rb +0 -52
- data/lib/trycourier/audit_events/types/audit_event.rb +0 -92
- data/lib/trycourier/audit_events/types/get_audit_event_params.rb +0 -47
- data/lib/trycourier/audit_events/types/list_audit_events_params.rb +0 -47
- data/lib/trycourier/audit_events/types/list_audit_events_response.rb +0 -62
- data/lib/trycourier/audit_events/types/target.rb +0 -52
- data/lib/trycourier/auth_tokens/client.rb +0 -85
- data/lib/trycourier/auth_tokens/types/issue_token_response.rb +0 -47
- data/lib/trycourier/automations/client.rb +0 -151
- data/lib/trycourier/automations/types/automation.rb +0 -56
- data/lib/trycourier/automations/types/automation_ad_hoc_invoke_params.rb +0 -88
- data/lib/trycourier/automations/types/automation_cancel_step.rb +0 -62
- data/lib/trycourier/automations/types/automation_delay_step.rb +0 -62
- data/lib/trycourier/automations/types/automation_invoke_params.rb +0 -69
- data/lib/trycourier/automations/types/automation_invoke_response.rb +0 -47
- data/lib/trycourier/automations/types/automation_invoke_step.rb +0 -62
- data/lib/trycourier/automations/types/automation_invoke_template_params.rb +0 -82
- data/lib/trycourier/automations/types/automation_run_context.rb +0 -69
- data/lib/trycourier/automations/types/automation_send_list_step.rb +0 -93
- data/lib/trycourier/automations/types/automation_send_step.rb +0 -99
- data/lib/trycourier/automations/types/automation_step.rb +0 -52
- data/lib/trycourier/automations/types/automation_step_action.rb +0 -14
- data/lib/trycourier/automations/types/automation_step_option.rb +0 -110
- data/lib/trycourier/automations/types/automation_update_profile_step.rb +0 -64
- data/lib/trycourier/automations/types/automation_v_2_send_step.rb +0 -68
- data/lib/trycourier/automations/types/merge_algorithm.rb +0 -12
- data/lib/trycourier/automations/types/profile.rb +0 -7
- data/lib/trycourier/brands/client.rb +0 -281
- data/lib/trycourier/brands/types/brand.rb +0 -105
- data/lib/trycourier/brands/types/brand_colors.rb +0 -57
- data/lib/trycourier/brands/types/brand_get_all_response.rb +0 -62
- data/lib/trycourier/brands/types/brand_parameters.rb +0 -74
- data/lib/trycourier/brands/types/brand_settings.rb +0 -69
- data/lib/trycourier/brands/types/brand_snippet.rb +0 -57
- data/lib/trycourier/brands/types/brand_snippets.rb +0 -51
- data/lib/trycourier/brands/types/brands_response.rb +0 -62
- data/lib/trycourier/bulk/client.rb +0 -249
- data/lib/trycourier/bulk/types/bulk_create_job_response.rb +0 -47
- data/lib/trycourier/bulk/types/bulk_get_job_params.rb +0 -47
- data/lib/trycourier/bulk/types/bulk_get_job_response.rb +0 -53
- data/lib/trycourier/bulk/types/bulk_get_job_users_params.rb +0 -52
- data/lib/trycourier/bulk/types/bulk_get_job_users_response.rb +0 -62
- data/lib/trycourier/bulk/types/bulk_ingest_error.rb +0 -52
- data/lib/trycourier/bulk/types/bulk_ingest_users_params.rb +0 -51
- data/lib/trycourier/bulk/types/bulk_ingest_users_response.rb +0 -56
- data/lib/trycourier/bulk/types/bulk_job_status.rb +0 -12
- data/lib/trycourier/bulk/types/bulk_job_user_status.rb +0 -11
- data/lib/trycourier/bulk/types/bulk_message_user_response.rb +0 -100
- data/lib/trycourier/bulk/types/inbound_bulk_content_message.rb +0 -165
- data/lib/trycourier/bulk/types/inbound_bulk_message.rb +0 -95
- data/lib/trycourier/bulk/types/inbound_bulk_message_user.rb +0 -80
- data/lib/trycourier/bulk/types/inbound_bulk_message_v_1.rb +0 -75
- data/lib/trycourier/bulk/types/inbound_bulk_message_v_2.rb +0 -50
- data/lib/trycourier/bulk/types/inbound_bulk_template_message.rb +0 -157
- data/lib/trycourier/bulk/types/job_details.rb +0 -81
- data/lib/trycourier/commons/types/already_exists.rb +0 -52
- data/lib/trycourier/commons/types/bad_request.rb +0 -52
- data/lib/trycourier/commons/types/base_error.rb +0 -47
- data/lib/trycourier/commons/types/channel_classification.rb +0 -14
- data/lib/trycourier/commons/types/channel_preference.rb +0 -48
- data/lib/trycourier/commons/types/conflict.rb +0 -52
- data/lib/trycourier/commons/types/email.rb +0 -52
- data/lib/trycourier/commons/types/message_not_found.rb +0 -52
- data/lib/trycourier/commons/types/not_found.rb +0 -52
- data/lib/trycourier/commons/types/notification_preference_details.rb +0 -66
- data/lib/trycourier/commons/types/notification_preferences.rb +0 -7
- data/lib/trycourier/commons/types/paging.rb +0 -52
- data/lib/trycourier/commons/types/payment_required.rb +0 -52
- data/lib/trycourier/commons/types/preference_status.rb +0 -11
- data/lib/trycourier/commons/types/recipient_preferences.rb +0 -53
- data/lib/trycourier/commons/types/rule.rb +0 -52
- data/lib/trycourier/commons/types/user_tenant_association.rb +0 -62
- data/lib/trycourier/lists/client.rb +0 -454
- data/lib/trycourier/lists/types/list.rb +0 -62
- data/lib/trycourier/lists/types/list_get_all_response.rb +0 -62
- data/lib/trycourier/lists/types/list_get_subscriptions_response.rb +0 -62
- data/lib/trycourier/lists/types/list_put_params.rb +0 -58
- data/lib/trycourier/lists/types/list_subscription_recipient.rb +0 -63
- data/lib/trycourier/lists/types/put_subscriptions_recipient.rb +0 -58
- data/lib/trycourier/messages/client.rb +0 -300
- data/lib/trycourier/messages/types/list_messages_response.rb +0 -62
- data/lib/trycourier/messages/types/message_details.rb +0 -120
- data/lib/trycourier/messages/types/message_history_response.rb +0 -51
- data/lib/trycourier/messages/types/message_status.rb +0 -17
- data/lib/trycourier/messages/types/reason.rb +0 -14
- data/lib/trycourier/messages/types/render_output.rb +0 -63
- data/lib/trycourier/messages/types/render_output_response.rb +0 -51
- data/lib/trycourier/messages/types/rendered_message_block.rb +0 -52
- data/lib/trycourier/messages/types/rendered_message_content.rb +0 -77
- data/lib/trycourier/notifications/client.rb +0 -379
- data/lib/trycourier/notifications/types/base_check.rb +0 -58
- data/lib/trycourier/notifications/types/block_type.rb +0 -17
- data/lib/trycourier/notifications/types/check.rb +0 -63
- data/lib/trycourier/notifications/types/check_status.rb +0 -11
- data/lib/trycourier/notifications/types/message_routing.rb +0 -57
- data/lib/trycourier/notifications/types/message_routing_channel.rb +0 -49
- data/lib/trycourier/notifications/types/message_routing_method.rb +0 -10
- data/lib/trycourier/notifications/types/notification.rb +0 -63
- data/lib/trycourier/notifications/types/notification_block.rb +0 -94
- data/lib/trycourier/notifications/types/notification_channel.rb +0 -73
- data/lib/trycourier/notifications/types/notification_channel_content.rb +0 -52
- data/lib/trycourier/notifications/types/notification_content.rb +0 -49
- data/lib/trycourier/notifications/types/notification_content_hierarchy.rb +0 -52
- data/lib/trycourier/notifications/types/notification_get_content_response.rb +0 -65
- data/lib/trycourier/notifications/types/notification_list_response.rb +0 -62
- data/lib/trycourier/notifications/types/submission_checks_get_response.rb +0 -51
- data/lib/trycourier/notifications/types/submission_checks_replace_response.rb +0 -51
- data/lib/trycourier/profiles/client.rb +0 -325
- data/lib/trycourier/profiles/types/address.rb +0 -81
- data/lib/trycourier/profiles/types/airship_profile.rb +0 -59
- data/lib/trycourier/profiles/types/airship_profile_audience.rb +0 -47
- data/lib/trycourier/profiles/types/delete_list_subscription_response.rb +0 -47
- data/lib/trycourier/profiles/types/device_type.rb +0 -7
- data/lib/trycourier/profiles/types/discord.rb +0 -50
- data/lib/trycourier/profiles/types/expo.rb +0 -50
- data/lib/trycourier/profiles/types/get_list_subscriptions_list.rb +0 -74
- data/lib/trycourier/profiles/types/get_list_subscriptions_response.rb +0 -62
- data/lib/trycourier/profiles/types/intercom.rb +0 -58
- data/lib/trycourier/profiles/types/intercom_recipient.rb +0 -47
- data/lib/trycourier/profiles/types/merge_profile_response.rb +0 -47
- data/lib/trycourier/profiles/types/ms_teams.rb +0 -86
- data/lib/trycourier/profiles/types/ms_teams_base_properties.rb +0 -52
- data/lib/trycourier/profiles/types/multiple_tokens.rb +0 -51
- data/lib/trycourier/profiles/types/profile_get_parameters.rb +0 -47
- data/lib/trycourier/profiles/types/profile_get_response.rb +0 -58
- data/lib/trycourier/profiles/types/replace_profile_response.rb +0 -47
- data/lib/trycourier/profiles/types/send_direct_message.rb +0 -47
- data/lib/trycourier/profiles/types/send_to_channel.rb +0 -47
- data/lib/trycourier/profiles/types/send_to_ms_teams_channel_id.rb +0 -57
- data/lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb +0 -68
- data/lib/trycourier/profiles/types/send_to_ms_teams_conversation_id.rb +0 -58
- data/lib/trycourier/profiles/types/send_to_ms_teams_email.rb +0 -57
- data/lib/trycourier/profiles/types/send_to_ms_teams_user_id.rb +0 -57
- data/lib/trycourier/profiles/types/send_to_slack_channel.rb +0 -52
- data/lib/trycourier/profiles/types/send_to_slack_email.rb +0 -52
- data/lib/trycourier/profiles/types/send_to_slack_user_id.rb +0 -52
- data/lib/trycourier/profiles/types/slack.rb +0 -62
- data/lib/trycourier/profiles/types/slack_base_properties.rb +0 -47
- data/lib/trycourier/profiles/types/snooze_rule.rb +0 -58
- data/lib/trycourier/profiles/types/snooze_rule_type.rb +0 -9
- data/lib/trycourier/profiles/types/subscribe_to_lists_request.rb +0 -51
- data/lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb +0 -58
- data/lib/trycourier/profiles/types/subscribe_to_lists_response.rb +0 -47
- data/lib/trycourier/profiles/types/token.rb +0 -47
- data/lib/trycourier/profiles/types/user_profile.rb +0 -274
- data/lib/trycourier/send/types/attachment.rb +0 -7
- data/lib/trycourier/send/types/audience_filter.rb +0 -57
- data/lib/trycourier/send/types/audience_recipient.rb +0 -62
- data/lib/trycourier/send/types/base_message.rb +0 -149
- data/lib/trycourier/send/types/base_social_presence.rb +0 -47
- data/lib/trycourier/send/types/brand_settings_email.rb +0 -87
- data/lib/trycourier/send/types/brand_settings_in_app.rb +0 -119
- data/lib/trycourier/send/types/brand_settings_social_presence.rb +0 -107
- data/lib/trycourier/send/types/brand_template.rb +0 -88
- data/lib/trycourier/send/types/brand_template_override.rb +0 -112
- data/lib/trycourier/send/types/channel.rb +0 -113
- data/lib/trycourier/send/types/channel_metadata.rb +0 -53
- data/lib/trycourier/send/types/channel_source.rb +0 -11
- data/lib/trycourier/send/types/content.rb +0 -50
- data/lib/trycourier/send/types/content_message.rb +0 -177
- data/lib/trycourier/send/types/criteria.rb +0 -12
- data/lib/trycourier/send/types/delay.rb +0 -47
- data/lib/trycourier/send/types/elemental_action_node.rb +0 -116
- data/lib/trycourier/send/types/elemental_base_node.rb +0 -62
- data/lib/trycourier/send/types/elemental_channel_node.rb +0 -105
- data/lib/trycourier/send/types/elemental_content.rb +0 -61
- data/lib/trycourier/send/types/elemental_content_sugar.rb +0 -53
- data/lib/trycourier/send/types/elemental_divider_node.rb +0 -68
- data/lib/trycourier/send/types/elemental_group_node.rb +0 -72
- data/lib/trycourier/send/types/elemental_image_node.rb +0 -101
- data/lib/trycourier/send/types/elemental_meta_node.rb +0 -70
- data/lib/trycourier/send/types/elemental_node.rb +0 -170
- data/lib/trycourier/send/types/elemental_quote_node.rb +0 -104
- data/lib/trycourier/send/types/elemental_text_node.rb +0 -136
- data/lib/trycourier/send/types/email_footer.rb +0 -52
- data/lib/trycourier/send/types/email_head.rb +0 -52
- data/lib/trycourier/send/types/email_header.rb +0 -63
- data/lib/trycourier/send/types/expires_in_type.rb +0 -48
- data/lib/trycourier/send/types/expiry.rb +0 -58
- data/lib/trycourier/send/types/i_action_button_style.rb +0 -10
- data/lib/trycourier/send/types/i_alignment.rb +0 -12
- data/lib/trycourier/send/types/i_preferences.rb +0 -7
- data/lib/trycourier/send/types/i_profile_preferences.rb +0 -59
- data/lib/trycourier/send/types/icons.rb +0 -52
- data/lib/trycourier/send/types/in_app_placement.rb +0 -12
- data/lib/trycourier/send/types/invalid_list_pattern_recipient.rb +0 -52
- data/lib/trycourier/send/types/invalid_list_recipient.rb +0 -52
- data/lib/trycourier/send/types/invalid_user_recipient.rb +0 -52
- data/lib/trycourier/send/types/list_filter.rb +0 -57
- data/lib/trycourier/send/types/list_pattern_recipient.rb +0 -53
- data/lib/trycourier/send/types/list_pattern_recipient_type.rb +0 -41
- data/lib/trycourier/send/types/list_recipient.rb +0 -62
- data/lib/trycourier/send/types/list_recipient_type.rb +0 -41
- data/lib/trycourier/send/types/locale.rb +0 -47
- data/lib/trycourier/send/types/locales.rb +0 -7
- data/lib/trycourier/send/types/logo.rb +0 -52
- data/lib/trycourier/send/types/message.rb +0 -50
- data/lib/trycourier/send/types/message_channel_email_override.rb +0 -119
- data/lib/trycourier/send/types/message_channels.rb +0 -7
- data/lib/trycourier/send/types/message_context.rb +0 -49
- data/lib/trycourier/send/types/message_data.rb +0 -7
- data/lib/trycourier/send/types/message_metadata.rb +0 -68
- data/lib/trycourier/send/types/message_providers.rb +0 -7
- data/lib/trycourier/send/types/message_providers_type.rb +0 -72
- data/lib/trycourier/send/types/message_recipient.rb +0 -52
- data/lib/trycourier/send/types/metadata.rb +0 -53
- data/lib/trycourier/send/types/ms_teams_recipient.rb +0 -53
- data/lib/trycourier/send/types/override.rb +0 -10
- data/lib/trycourier/send/types/preference.rb +0 -73
- data/lib/trycourier/send/types/preferences.rb +0 -47
- data/lib/trycourier/send/types/recipient.rb +0 -98
- data/lib/trycourier/send/types/routing.rb +0 -64
- data/lib/trycourier/send/types/routing_channel.rb +0 -61
- data/lib/trycourier/send/types/routing_method.rb +0 -10
- data/lib/trycourier/send/types/routing_strategy_channel.rb +0 -70
- data/lib/trycourier/send/types/routing_strategy_provider.rb +0 -68
- data/lib/trycourier/send/types/rule_type.rb +0 -11
- data/lib/trycourier/send/types/slack_recipient.rb +0 -53
- data/lib/trycourier/send/types/template_message.rb +0 -169
- data/lib/trycourier/send/types/text_align.rb +0 -11
- data/lib/trycourier/send/types/text_style.rb +0 -12
- data/lib/trycourier/send/types/timeout.rb +0 -76
- data/lib/trycourier/send/types/timeouts.rb +0 -52
- data/lib/trycourier/send/types/tracking_override.rb +0 -47
- data/lib/trycourier/send/types/user_recipient.rb +0 -115
- data/lib/trycourier/send/types/user_recipient_type.rb +0 -41
- data/lib/trycourier/send/types/utm.rb +0 -68
- data/lib/trycourier/send/types/widget_background.rb +0 -52
- data/lib/trycourier/templates/client.rb +0 -67
- data/lib/trycourier/templates/types/channel_identifier.rb +0 -7
- data/lib/trycourier/templates/types/list_templates_response.rb +0 -62
- data/lib/trycourier/templates/types/notification_templates.rb +0 -90
- data/lib/trycourier/templates/types/routing_strategy.rb +0 -54
- data/lib/trycourier/templates/types/routing_strategy_method.rb +0 -10
- data/lib/trycourier/templates/types/tag.rb +0 -51
- data/lib/trycourier/templates/types/tag_data.rb +0 -52
- data/lib/trycourier/tenants/client.rb +0 -255
- data/lib/trycourier/tenants/types/default_preferences.rb +0 -51
- data/lib/trycourier/tenants/types/list_users_for_tenant_response.rb +0 -88
- data/lib/trycourier/tenants/types/subscription_topic.rb +0 -53
- data/lib/trycourier/tenants/types/subscription_topic_status.rb +0 -11
- data/lib/trycourier/tenants/types/template_property.rb +0 -7
- data/lib/trycourier/tenants/types/tenant.rb +0 -95
- data/lib/trycourier/tenants/types/tenant_list_response.rb +0 -86
- data/lib/trycourier/translations/client.rb +0 -106
- data/lib/trycourier/types/send_message_response.rb +0 -49
- data/lib/trycourier/users/client.rb +0 -34
- data/lib/trycourier/users/preferences/client.rb +0 -171
- data/lib/trycourier/users/preferences/types/topic_preference.rb +0 -86
- data/lib/trycourier/users/preferences/types/user_preferences_get_response.rb +0 -55
- data/lib/trycourier/users/preferences/types/user_preferences_list_response.rb +0 -64
- data/lib/trycourier/users/preferences/types/user_preferences_update_response.rb +0 -49
- data/lib/trycourier/users/tenants/client.rb +0 -267
- data/lib/trycourier/users/tenants/types/add_user_to_single_tenants_params_profile.rb +0 -76
- data/lib/trycourier/users/tenants/types/list_tenants_for_user_response.rb +0 -90
- data/lib/trycourier/users/tokens/client.rb +0 -264
- data/lib/trycourier/users/tokens/types/delete_user_token_opts.rb +0 -54
- data/lib/trycourier/users/tokens/types/device.rb +0 -83
- data/lib/trycourier/users/tokens/types/expiry_date.rb +0 -50
- data/lib/trycourier/users/tokens/types/get_all_tokens_response.rb +0 -11
- data/lib/trycourier/users/tokens/types/get_user_token_opts.rb +0 -54
- data/lib/trycourier/users/tokens/types/get_user_token_response.rb +0 -116
- data/lib/trycourier/users/tokens/types/get_user_tokens_opts.rb +0 -49
- data/lib/trycourier/users/tokens/types/patch_op.rb +0 -16
- data/lib/trycourier/users/tokens/types/patch_operation.rb +0 -59
- data/lib/trycourier/users/tokens/types/patch_user_token_opts.rb +0 -53
- data/lib/trycourier/users/tokens/types/provider_key.rb +0 -14
- data/lib/trycourier/users/tokens/types/put_user_token_opts.rb +0 -60
- data/lib/trycourier/users/tokens/types/put_user_tokens_opts.rb +0 -58
- data/lib/trycourier/users/tokens/types/token_status.rb +0 -14
- data/lib/trycourier/users/tokens/types/tracking.rb +0 -64
- data/lib/trycourier/users/tokens/types/user_token.rb +0 -102
- data/lib/types_export.rb +0 -273
@@ -0,0 +1,1107 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Trycourier
|
4
|
+
module Models
|
5
|
+
class SendMessageParams < Trycourier::Internal::Type::BaseModel
|
6
|
+
extend Trycourier::Internal::Type::RequestParameters::Converter
|
7
|
+
include Trycourier::Internal::Type::RequestParameters
|
8
|
+
|
9
|
+
OrHash =
|
10
|
+
T.type_alias do
|
11
|
+
T.any(Trycourier::SendMessageParams, Trycourier::Internal::AnyHash)
|
12
|
+
end
|
13
|
+
|
14
|
+
# The message property has the following primary top-level properties. They define
|
15
|
+
# the destination and content of the message.
|
16
|
+
sig { returns(Trycourier::SendMessageParams::Message) }
|
17
|
+
attr_reader :message
|
18
|
+
|
19
|
+
sig do
|
20
|
+
params(message: Trycourier::SendMessageParams::Message::OrHash).void
|
21
|
+
end
|
22
|
+
attr_writer :message
|
23
|
+
|
24
|
+
sig do
|
25
|
+
params(
|
26
|
+
message: Trycourier::SendMessageParams::Message::OrHash,
|
27
|
+
request_options: Trycourier::RequestOptions::OrHash
|
28
|
+
).returns(T.attached_class)
|
29
|
+
end
|
30
|
+
def self.new(
|
31
|
+
# The message property has the following primary top-level properties. They define
|
32
|
+
# the destination and content of the message.
|
33
|
+
message:,
|
34
|
+
request_options: {}
|
35
|
+
)
|
36
|
+
end
|
37
|
+
|
38
|
+
sig do
|
39
|
+
override.returns(
|
40
|
+
{
|
41
|
+
message: Trycourier::SendMessageParams::Message,
|
42
|
+
request_options: Trycourier::RequestOptions
|
43
|
+
}
|
44
|
+
)
|
45
|
+
end
|
46
|
+
def to_hash
|
47
|
+
end
|
48
|
+
|
49
|
+
class Message < Trycourier::Internal::Type::BaseModel
|
50
|
+
OrHash =
|
51
|
+
T.type_alias do
|
52
|
+
T.any(
|
53
|
+
Trycourier::SendMessageParams::Message,
|
54
|
+
Trycourier::Internal::AnyHash
|
55
|
+
)
|
56
|
+
end
|
57
|
+
|
58
|
+
sig { returns(T.nilable(String)) }
|
59
|
+
attr_accessor :brand_id
|
60
|
+
|
61
|
+
# Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
|
62
|
+
# inbox, direct_message, banner, webhook.
|
63
|
+
sig do
|
64
|
+
returns(
|
65
|
+
T.nilable(
|
66
|
+
T::Hash[Symbol, Trycourier::SendMessageParams::Message::Channel]
|
67
|
+
)
|
68
|
+
)
|
69
|
+
end
|
70
|
+
attr_accessor :channels
|
71
|
+
|
72
|
+
# Describes content that will work for email, inbox, push, chat, or any channel
|
73
|
+
# id.
|
74
|
+
sig do
|
75
|
+
returns(
|
76
|
+
T.nilable(
|
77
|
+
T.any(
|
78
|
+
Trycourier::ElementalContentSugar,
|
79
|
+
Trycourier::ElementalContent
|
80
|
+
)
|
81
|
+
)
|
82
|
+
)
|
83
|
+
end
|
84
|
+
attr_reader :content
|
85
|
+
|
86
|
+
sig do
|
87
|
+
params(
|
88
|
+
content:
|
89
|
+
T.any(
|
90
|
+
Trycourier::ElementalContentSugar::OrHash,
|
91
|
+
Trycourier::ElementalContent::OrHash
|
92
|
+
)
|
93
|
+
).void
|
94
|
+
end
|
95
|
+
attr_writer :content
|
96
|
+
|
97
|
+
sig { returns(T.nilable(Trycourier::MessageContext)) }
|
98
|
+
attr_reader :context
|
99
|
+
|
100
|
+
sig do
|
101
|
+
params(context: T.nilable(Trycourier::MessageContext::OrHash)).void
|
102
|
+
end
|
103
|
+
attr_writer :context
|
104
|
+
|
105
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
106
|
+
attr_accessor :data
|
107
|
+
|
108
|
+
sig do
|
109
|
+
returns(T.nilable(Trycourier::SendMessageParams::Message::Delay))
|
110
|
+
end
|
111
|
+
attr_reader :delay
|
112
|
+
|
113
|
+
sig do
|
114
|
+
params(
|
115
|
+
delay:
|
116
|
+
T.nilable(Trycourier::SendMessageParams::Message::Delay::OrHash)
|
117
|
+
).void
|
118
|
+
end
|
119
|
+
attr_writer :delay
|
120
|
+
|
121
|
+
sig do
|
122
|
+
returns(T.nilable(Trycourier::SendMessageParams::Message::Expiry))
|
123
|
+
end
|
124
|
+
attr_reader :expiry
|
125
|
+
|
126
|
+
sig do
|
127
|
+
params(
|
128
|
+
expiry:
|
129
|
+
T.nilable(Trycourier::SendMessageParams::Message::Expiry::OrHash)
|
130
|
+
).void
|
131
|
+
end
|
132
|
+
attr_writer :expiry
|
133
|
+
|
134
|
+
sig do
|
135
|
+
returns(T.nilable(Trycourier::SendMessageParams::Message::Metadata))
|
136
|
+
end
|
137
|
+
attr_reader :metadata
|
138
|
+
|
139
|
+
sig do
|
140
|
+
params(
|
141
|
+
metadata:
|
142
|
+
T.nilable(
|
143
|
+
Trycourier::SendMessageParams::Message::Metadata::OrHash
|
144
|
+
)
|
145
|
+
).void
|
146
|
+
end
|
147
|
+
attr_writer :metadata
|
148
|
+
|
149
|
+
sig do
|
150
|
+
returns(
|
151
|
+
T.nilable(Trycourier::SendMessageParams::Message::Preferences)
|
152
|
+
)
|
153
|
+
end
|
154
|
+
attr_reader :preferences
|
155
|
+
|
156
|
+
sig do
|
157
|
+
params(
|
158
|
+
preferences:
|
159
|
+
T.nilable(
|
160
|
+
Trycourier::SendMessageParams::Message::Preferences::OrHash
|
161
|
+
)
|
162
|
+
).void
|
163
|
+
end
|
164
|
+
attr_writer :preferences
|
165
|
+
|
166
|
+
sig do
|
167
|
+
returns(
|
168
|
+
T.nilable(
|
169
|
+
T::Hash[Symbol, Trycourier::SendMessageParams::Message::Provider]
|
170
|
+
)
|
171
|
+
)
|
172
|
+
end
|
173
|
+
attr_accessor :providers
|
174
|
+
|
175
|
+
# Customize which channels/providers Courier may deliver the message through.
|
176
|
+
sig do
|
177
|
+
returns(T.nilable(Trycourier::SendMessageParams::Message::Routing))
|
178
|
+
end
|
179
|
+
attr_reader :routing
|
180
|
+
|
181
|
+
sig do
|
182
|
+
params(
|
183
|
+
routing:
|
184
|
+
T.nilable(Trycourier::SendMessageParams::Message::Routing::OrHash)
|
185
|
+
).void
|
186
|
+
end
|
187
|
+
attr_writer :routing
|
188
|
+
|
189
|
+
sig { returns(T.nilable(String)) }
|
190
|
+
attr_accessor :template
|
191
|
+
|
192
|
+
sig do
|
193
|
+
returns(T.nilable(Trycourier::SendMessageParams::Message::Timeout))
|
194
|
+
end
|
195
|
+
attr_reader :timeout
|
196
|
+
|
197
|
+
sig do
|
198
|
+
params(
|
199
|
+
timeout:
|
200
|
+
T.nilable(Trycourier::SendMessageParams::Message::Timeout::OrHash)
|
201
|
+
).void
|
202
|
+
end
|
203
|
+
attr_writer :timeout
|
204
|
+
|
205
|
+
# The recipient or a list of recipients of the message
|
206
|
+
sig do
|
207
|
+
returns(
|
208
|
+
T.nilable(
|
209
|
+
T.any(Trycourier::UserRecipient, T::Array[Trycourier::Recipient])
|
210
|
+
)
|
211
|
+
)
|
212
|
+
end
|
213
|
+
attr_accessor :to
|
214
|
+
|
215
|
+
# The message property has the following primary top-level properties. They define
|
216
|
+
# the destination and content of the message.
|
217
|
+
sig do
|
218
|
+
params(
|
219
|
+
brand_id: T.nilable(String),
|
220
|
+
channels:
|
221
|
+
T.nilable(
|
222
|
+
T::Hash[
|
223
|
+
Symbol,
|
224
|
+
Trycourier::SendMessageParams::Message::Channel::OrHash
|
225
|
+
]
|
226
|
+
),
|
227
|
+
content:
|
228
|
+
T.any(
|
229
|
+
Trycourier::ElementalContentSugar::OrHash,
|
230
|
+
Trycourier::ElementalContent::OrHash
|
231
|
+
),
|
232
|
+
context: T.nilable(Trycourier::MessageContext::OrHash),
|
233
|
+
data: T.nilable(T::Hash[Symbol, T.anything]),
|
234
|
+
delay:
|
235
|
+
T.nilable(Trycourier::SendMessageParams::Message::Delay::OrHash),
|
236
|
+
expiry:
|
237
|
+
T.nilable(Trycourier::SendMessageParams::Message::Expiry::OrHash),
|
238
|
+
metadata:
|
239
|
+
T.nilable(
|
240
|
+
Trycourier::SendMessageParams::Message::Metadata::OrHash
|
241
|
+
),
|
242
|
+
preferences:
|
243
|
+
T.nilable(
|
244
|
+
Trycourier::SendMessageParams::Message::Preferences::OrHash
|
245
|
+
),
|
246
|
+
providers:
|
247
|
+
T.nilable(
|
248
|
+
T::Hash[
|
249
|
+
Symbol,
|
250
|
+
Trycourier::SendMessageParams::Message::Provider::OrHash
|
251
|
+
]
|
252
|
+
),
|
253
|
+
routing:
|
254
|
+
T.nilable(
|
255
|
+
Trycourier::SendMessageParams::Message::Routing::OrHash
|
256
|
+
),
|
257
|
+
template: T.nilable(String),
|
258
|
+
timeout:
|
259
|
+
T.nilable(
|
260
|
+
Trycourier::SendMessageParams::Message::Timeout::OrHash
|
261
|
+
),
|
262
|
+
to:
|
263
|
+
T.nilable(
|
264
|
+
T.any(
|
265
|
+
Trycourier::UserRecipient::OrHash,
|
266
|
+
T::Array[Trycourier::Recipient::OrHash]
|
267
|
+
)
|
268
|
+
)
|
269
|
+
).returns(T.attached_class)
|
270
|
+
end
|
271
|
+
def self.new(
|
272
|
+
brand_id: nil,
|
273
|
+
# Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
|
274
|
+
# inbox, direct_message, banner, webhook.
|
275
|
+
channels: nil,
|
276
|
+
# Describes content that will work for email, inbox, push, chat, or any channel
|
277
|
+
# id.
|
278
|
+
content: nil,
|
279
|
+
context: nil,
|
280
|
+
data: nil,
|
281
|
+
delay: nil,
|
282
|
+
expiry: nil,
|
283
|
+
metadata: nil,
|
284
|
+
preferences: nil,
|
285
|
+
providers: nil,
|
286
|
+
# Customize which channels/providers Courier may deliver the message through.
|
287
|
+
routing: nil,
|
288
|
+
template: nil,
|
289
|
+
timeout: nil,
|
290
|
+
# The recipient or a list of recipients of the message
|
291
|
+
to: nil
|
292
|
+
)
|
293
|
+
end
|
294
|
+
|
295
|
+
sig do
|
296
|
+
override.returns(
|
297
|
+
{
|
298
|
+
brand_id: T.nilable(String),
|
299
|
+
channels:
|
300
|
+
T.nilable(
|
301
|
+
T::Hash[
|
302
|
+
Symbol,
|
303
|
+
Trycourier::SendMessageParams::Message::Channel
|
304
|
+
]
|
305
|
+
),
|
306
|
+
content:
|
307
|
+
T.any(
|
308
|
+
Trycourier::ElementalContentSugar,
|
309
|
+
Trycourier::ElementalContent
|
310
|
+
),
|
311
|
+
context: T.nilable(Trycourier::MessageContext),
|
312
|
+
data: T.nilable(T::Hash[Symbol, T.anything]),
|
313
|
+
delay: T.nilable(Trycourier::SendMessageParams::Message::Delay),
|
314
|
+
expiry: T.nilable(Trycourier::SendMessageParams::Message::Expiry),
|
315
|
+
metadata:
|
316
|
+
T.nilable(Trycourier::SendMessageParams::Message::Metadata),
|
317
|
+
preferences:
|
318
|
+
T.nilable(Trycourier::SendMessageParams::Message::Preferences),
|
319
|
+
providers:
|
320
|
+
T.nilable(
|
321
|
+
T::Hash[
|
322
|
+
Symbol,
|
323
|
+
Trycourier::SendMessageParams::Message::Provider
|
324
|
+
]
|
325
|
+
),
|
326
|
+
routing:
|
327
|
+
T.nilable(Trycourier::SendMessageParams::Message::Routing),
|
328
|
+
template: T.nilable(String),
|
329
|
+
timeout:
|
330
|
+
T.nilable(Trycourier::SendMessageParams::Message::Timeout),
|
331
|
+
to:
|
332
|
+
T.nilable(
|
333
|
+
T.any(
|
334
|
+
Trycourier::UserRecipient,
|
335
|
+
T::Array[Trycourier::Recipient]
|
336
|
+
)
|
337
|
+
)
|
338
|
+
}
|
339
|
+
)
|
340
|
+
end
|
341
|
+
def to_hash
|
342
|
+
end
|
343
|
+
|
344
|
+
class Channel < Trycourier::Internal::Type::BaseModel
|
345
|
+
OrHash =
|
346
|
+
T.type_alias do
|
347
|
+
T.any(
|
348
|
+
Trycourier::SendMessageParams::Message::Channel,
|
349
|
+
Trycourier::Internal::AnyHash
|
350
|
+
)
|
351
|
+
end
|
352
|
+
|
353
|
+
# Brand id used for rendering.
|
354
|
+
sig { returns(T.nilable(String)) }
|
355
|
+
attr_accessor :brand_id
|
356
|
+
|
357
|
+
# JS conditional with access to data/profile.
|
358
|
+
sig { returns(T.nilable(String)) }
|
359
|
+
attr_accessor :if_
|
360
|
+
|
361
|
+
sig do
|
362
|
+
returns(
|
363
|
+
T.nilable(
|
364
|
+
Trycourier::SendMessageParams::Message::Channel::Metadata
|
365
|
+
)
|
366
|
+
)
|
367
|
+
end
|
368
|
+
attr_reader :metadata
|
369
|
+
|
370
|
+
sig do
|
371
|
+
params(
|
372
|
+
metadata:
|
373
|
+
T.nilable(
|
374
|
+
Trycourier::SendMessageParams::Message::Channel::Metadata::OrHash
|
375
|
+
)
|
376
|
+
).void
|
377
|
+
end
|
378
|
+
attr_writer :metadata
|
379
|
+
|
380
|
+
# Channel specific overrides.
|
381
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
382
|
+
attr_accessor :override
|
383
|
+
|
384
|
+
# Providers enabled for this channel.
|
385
|
+
sig { returns(T.nilable(T::Array[String])) }
|
386
|
+
attr_accessor :providers
|
387
|
+
|
388
|
+
# Defaults to `single`.
|
389
|
+
sig do
|
390
|
+
returns(
|
391
|
+
T.nilable(
|
392
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod::OrSymbol
|
393
|
+
)
|
394
|
+
)
|
395
|
+
end
|
396
|
+
attr_accessor :routing_method
|
397
|
+
|
398
|
+
sig do
|
399
|
+
returns(
|
400
|
+
T.nilable(
|
401
|
+
Trycourier::SendMessageParams::Message::Channel::Timeouts
|
402
|
+
)
|
403
|
+
)
|
404
|
+
end
|
405
|
+
attr_reader :timeouts
|
406
|
+
|
407
|
+
sig do
|
408
|
+
params(
|
409
|
+
timeouts:
|
410
|
+
T.nilable(
|
411
|
+
Trycourier::SendMessageParams::Message::Channel::Timeouts::OrHash
|
412
|
+
)
|
413
|
+
).void
|
414
|
+
end
|
415
|
+
attr_writer :timeouts
|
416
|
+
|
417
|
+
sig do
|
418
|
+
params(
|
419
|
+
brand_id: T.nilable(String),
|
420
|
+
if_: T.nilable(String),
|
421
|
+
metadata:
|
422
|
+
T.nilable(
|
423
|
+
Trycourier::SendMessageParams::Message::Channel::Metadata::OrHash
|
424
|
+
),
|
425
|
+
override: T.nilable(T::Hash[Symbol, T.anything]),
|
426
|
+
providers: T.nilable(T::Array[String]),
|
427
|
+
routing_method:
|
428
|
+
T.nilable(
|
429
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod::OrSymbol
|
430
|
+
),
|
431
|
+
timeouts:
|
432
|
+
T.nilable(
|
433
|
+
Trycourier::SendMessageParams::Message::Channel::Timeouts::OrHash
|
434
|
+
)
|
435
|
+
).returns(T.attached_class)
|
436
|
+
end
|
437
|
+
def self.new(
|
438
|
+
# Brand id used for rendering.
|
439
|
+
brand_id: nil,
|
440
|
+
# JS conditional with access to data/profile.
|
441
|
+
if_: nil,
|
442
|
+
metadata: nil,
|
443
|
+
# Channel specific overrides.
|
444
|
+
override: nil,
|
445
|
+
# Providers enabled for this channel.
|
446
|
+
providers: nil,
|
447
|
+
# Defaults to `single`.
|
448
|
+
routing_method: nil,
|
449
|
+
timeouts: nil
|
450
|
+
)
|
451
|
+
end
|
452
|
+
|
453
|
+
sig do
|
454
|
+
override.returns(
|
455
|
+
{
|
456
|
+
brand_id: T.nilable(String),
|
457
|
+
if_: T.nilable(String),
|
458
|
+
metadata:
|
459
|
+
T.nilable(
|
460
|
+
Trycourier::SendMessageParams::Message::Channel::Metadata
|
461
|
+
),
|
462
|
+
override: T.nilable(T::Hash[Symbol, T.anything]),
|
463
|
+
providers: T.nilable(T::Array[String]),
|
464
|
+
routing_method:
|
465
|
+
T.nilable(
|
466
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod::OrSymbol
|
467
|
+
),
|
468
|
+
timeouts:
|
469
|
+
T.nilable(
|
470
|
+
Trycourier::SendMessageParams::Message::Channel::Timeouts
|
471
|
+
)
|
472
|
+
}
|
473
|
+
)
|
474
|
+
end
|
475
|
+
def to_hash
|
476
|
+
end
|
477
|
+
|
478
|
+
class Metadata < Trycourier::Internal::Type::BaseModel
|
479
|
+
OrHash =
|
480
|
+
T.type_alias do
|
481
|
+
T.any(
|
482
|
+
Trycourier::SendMessageParams::Message::Channel::Metadata,
|
483
|
+
Trycourier::Internal::AnyHash
|
484
|
+
)
|
485
|
+
end
|
486
|
+
|
487
|
+
sig { returns(T.nilable(Trycourier::Utm)) }
|
488
|
+
attr_reader :utm
|
489
|
+
|
490
|
+
sig { params(utm: T.nilable(Trycourier::Utm::OrHash)).void }
|
491
|
+
attr_writer :utm
|
492
|
+
|
493
|
+
sig do
|
494
|
+
params(utm: T.nilable(Trycourier::Utm::OrHash)).returns(
|
495
|
+
T.attached_class
|
496
|
+
)
|
497
|
+
end
|
498
|
+
def self.new(utm: nil)
|
499
|
+
end
|
500
|
+
|
501
|
+
sig { override.returns({ utm: T.nilable(Trycourier::Utm) }) }
|
502
|
+
def to_hash
|
503
|
+
end
|
504
|
+
end
|
505
|
+
|
506
|
+
# Defaults to `single`.
|
507
|
+
module RoutingMethod
|
508
|
+
extend Trycourier::Internal::Type::Enum
|
509
|
+
|
510
|
+
TaggedSymbol =
|
511
|
+
T.type_alias do
|
512
|
+
T.all(
|
513
|
+
Symbol,
|
514
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod
|
515
|
+
)
|
516
|
+
end
|
517
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
518
|
+
|
519
|
+
ALL =
|
520
|
+
T.let(
|
521
|
+
:all,
|
522
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod::TaggedSymbol
|
523
|
+
)
|
524
|
+
SINGLE =
|
525
|
+
T.let(
|
526
|
+
:single,
|
527
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod::TaggedSymbol
|
528
|
+
)
|
529
|
+
|
530
|
+
sig do
|
531
|
+
override.returns(
|
532
|
+
T::Array[
|
533
|
+
Trycourier::SendMessageParams::Message::Channel::RoutingMethod::TaggedSymbol
|
534
|
+
]
|
535
|
+
)
|
536
|
+
end
|
537
|
+
def self.values
|
538
|
+
end
|
539
|
+
end
|
540
|
+
|
541
|
+
class Timeouts < Trycourier::Internal::Type::BaseModel
|
542
|
+
OrHash =
|
543
|
+
T.type_alias do
|
544
|
+
T.any(
|
545
|
+
Trycourier::SendMessageParams::Message::Channel::Timeouts,
|
546
|
+
Trycourier::Internal::AnyHash
|
547
|
+
)
|
548
|
+
end
|
549
|
+
|
550
|
+
sig { returns(T.nilable(Integer)) }
|
551
|
+
attr_accessor :channel
|
552
|
+
|
553
|
+
sig { returns(T.nilable(Integer)) }
|
554
|
+
attr_accessor :provider
|
555
|
+
|
556
|
+
sig do
|
557
|
+
params(
|
558
|
+
channel: T.nilable(Integer),
|
559
|
+
provider: T.nilable(Integer)
|
560
|
+
).returns(T.attached_class)
|
561
|
+
end
|
562
|
+
def self.new(channel: nil, provider: nil)
|
563
|
+
end
|
564
|
+
|
565
|
+
sig do
|
566
|
+
override.returns(
|
567
|
+
{ channel: T.nilable(Integer), provider: T.nilable(Integer) }
|
568
|
+
)
|
569
|
+
end
|
570
|
+
def to_hash
|
571
|
+
end
|
572
|
+
end
|
573
|
+
end
|
574
|
+
|
575
|
+
# Describes content that will work for email, inbox, push, chat, or any channel
|
576
|
+
# id.
|
577
|
+
module Content
|
578
|
+
extend Trycourier::Internal::Type::Union
|
579
|
+
|
580
|
+
Variants =
|
581
|
+
T.type_alias do
|
582
|
+
T.any(
|
583
|
+
Trycourier::ElementalContentSugar,
|
584
|
+
Trycourier::ElementalContent
|
585
|
+
)
|
586
|
+
end
|
587
|
+
|
588
|
+
sig do
|
589
|
+
override.returns(
|
590
|
+
T::Array[
|
591
|
+
Trycourier::SendMessageParams::Message::Content::Variants
|
592
|
+
]
|
593
|
+
)
|
594
|
+
end
|
595
|
+
def self.variants
|
596
|
+
end
|
597
|
+
end
|
598
|
+
|
599
|
+
class Delay < Trycourier::Internal::Type::BaseModel
|
600
|
+
OrHash =
|
601
|
+
T.type_alias do
|
602
|
+
T.any(
|
603
|
+
Trycourier::SendMessageParams::Message::Delay,
|
604
|
+
Trycourier::Internal::AnyHash
|
605
|
+
)
|
606
|
+
end
|
607
|
+
|
608
|
+
# The duration of the delay in milliseconds.
|
609
|
+
sig { returns(T.nilable(Integer)) }
|
610
|
+
attr_accessor :duration
|
611
|
+
|
612
|
+
# ISO 8601 timestamp or opening_hours-like format.
|
613
|
+
sig { returns(T.nilable(String)) }
|
614
|
+
attr_accessor :until_
|
615
|
+
|
616
|
+
sig do
|
617
|
+
params(
|
618
|
+
duration: T.nilable(Integer),
|
619
|
+
until_: T.nilable(String)
|
620
|
+
).returns(T.attached_class)
|
621
|
+
end
|
622
|
+
def self.new(
|
623
|
+
# The duration of the delay in milliseconds.
|
624
|
+
duration: nil,
|
625
|
+
# ISO 8601 timestamp or opening_hours-like format.
|
626
|
+
until_: nil
|
627
|
+
)
|
628
|
+
end
|
629
|
+
|
630
|
+
sig do
|
631
|
+
override.returns(
|
632
|
+
{ duration: T.nilable(Integer), until_: T.nilable(String) }
|
633
|
+
)
|
634
|
+
end
|
635
|
+
def to_hash
|
636
|
+
end
|
637
|
+
end
|
638
|
+
|
639
|
+
class Expiry < Trycourier::Internal::Type::BaseModel
|
640
|
+
OrHash =
|
641
|
+
T.type_alias do
|
642
|
+
T.any(
|
643
|
+
Trycourier::SendMessageParams::Message::Expiry,
|
644
|
+
Trycourier::Internal::AnyHash
|
645
|
+
)
|
646
|
+
end
|
647
|
+
|
648
|
+
# Duration in ms or ISO8601 duration (e.g. P1DT4H).
|
649
|
+
sig do
|
650
|
+
returns(
|
651
|
+
Trycourier::SendMessageParams::Message::Expiry::ExpiresIn::Variants
|
652
|
+
)
|
653
|
+
end
|
654
|
+
attr_accessor :expires_in
|
655
|
+
|
656
|
+
# Epoch or ISO8601 timestamp with timezone.
|
657
|
+
sig { returns(T.nilable(String)) }
|
658
|
+
attr_accessor :expires_at
|
659
|
+
|
660
|
+
sig do
|
661
|
+
params(
|
662
|
+
expires_in:
|
663
|
+
Trycourier::SendMessageParams::Message::Expiry::ExpiresIn::Variants,
|
664
|
+
expires_at: T.nilable(String)
|
665
|
+
).returns(T.attached_class)
|
666
|
+
end
|
667
|
+
def self.new(
|
668
|
+
# Duration in ms or ISO8601 duration (e.g. P1DT4H).
|
669
|
+
expires_in:,
|
670
|
+
# Epoch or ISO8601 timestamp with timezone.
|
671
|
+
expires_at: nil
|
672
|
+
)
|
673
|
+
end
|
674
|
+
|
675
|
+
sig do
|
676
|
+
override.returns(
|
677
|
+
{
|
678
|
+
expires_in:
|
679
|
+
Trycourier::SendMessageParams::Message::Expiry::ExpiresIn::Variants,
|
680
|
+
expires_at: T.nilable(String)
|
681
|
+
}
|
682
|
+
)
|
683
|
+
end
|
684
|
+
def to_hash
|
685
|
+
end
|
686
|
+
|
687
|
+
# Duration in ms or ISO8601 duration (e.g. P1DT4H).
|
688
|
+
module ExpiresIn
|
689
|
+
extend Trycourier::Internal::Type::Union
|
690
|
+
|
691
|
+
Variants = T.type_alias { T.any(String, Integer) }
|
692
|
+
|
693
|
+
sig do
|
694
|
+
override.returns(
|
695
|
+
T::Array[
|
696
|
+
Trycourier::SendMessageParams::Message::Expiry::ExpiresIn::Variants
|
697
|
+
]
|
698
|
+
)
|
699
|
+
end
|
700
|
+
def self.variants
|
701
|
+
end
|
702
|
+
end
|
703
|
+
end
|
704
|
+
|
705
|
+
class Metadata < Trycourier::Internal::Type::BaseModel
|
706
|
+
OrHash =
|
707
|
+
T.type_alias do
|
708
|
+
T.any(
|
709
|
+
Trycourier::SendMessageParams::Message::Metadata,
|
710
|
+
Trycourier::Internal::AnyHash
|
711
|
+
)
|
712
|
+
end
|
713
|
+
|
714
|
+
sig { returns(T.nilable(String)) }
|
715
|
+
attr_accessor :event
|
716
|
+
|
717
|
+
sig { returns(T.nilable(T::Array[String])) }
|
718
|
+
attr_accessor :tags
|
719
|
+
|
720
|
+
sig { returns(T.nilable(String)) }
|
721
|
+
attr_accessor :trace_id
|
722
|
+
|
723
|
+
sig { returns(T.nilable(Trycourier::Utm)) }
|
724
|
+
attr_reader :utm
|
725
|
+
|
726
|
+
sig { params(utm: T.nilable(Trycourier::Utm::OrHash)).void }
|
727
|
+
attr_writer :utm
|
728
|
+
|
729
|
+
sig do
|
730
|
+
params(
|
731
|
+
event: T.nilable(String),
|
732
|
+
tags: T.nilable(T::Array[String]),
|
733
|
+
trace_id: T.nilable(String),
|
734
|
+
utm: T.nilable(Trycourier::Utm::OrHash)
|
735
|
+
).returns(T.attached_class)
|
736
|
+
end
|
737
|
+
def self.new(event: nil, tags: nil, trace_id: nil, utm: nil)
|
738
|
+
end
|
739
|
+
|
740
|
+
sig do
|
741
|
+
override.returns(
|
742
|
+
{
|
743
|
+
event: T.nilable(String),
|
744
|
+
tags: T.nilable(T::Array[String]),
|
745
|
+
trace_id: T.nilable(String),
|
746
|
+
utm: T.nilable(Trycourier::Utm)
|
747
|
+
}
|
748
|
+
)
|
749
|
+
end
|
750
|
+
def to_hash
|
751
|
+
end
|
752
|
+
end
|
753
|
+
|
754
|
+
class Preferences < Trycourier::Internal::Type::BaseModel
|
755
|
+
OrHash =
|
756
|
+
T.type_alias do
|
757
|
+
T.any(
|
758
|
+
Trycourier::SendMessageParams::Message::Preferences,
|
759
|
+
Trycourier::Internal::AnyHash
|
760
|
+
)
|
761
|
+
end
|
762
|
+
|
763
|
+
# The subscription topic to apply to the message.
|
764
|
+
sig { returns(String) }
|
765
|
+
attr_accessor :subscription_topic_id
|
766
|
+
|
767
|
+
sig do
|
768
|
+
params(subscription_topic_id: String).returns(T.attached_class)
|
769
|
+
end
|
770
|
+
def self.new(
|
771
|
+
# The subscription topic to apply to the message.
|
772
|
+
subscription_topic_id:
|
773
|
+
)
|
774
|
+
end
|
775
|
+
|
776
|
+
sig { override.returns({ subscription_topic_id: String }) }
|
777
|
+
def to_hash
|
778
|
+
end
|
779
|
+
end
|
780
|
+
|
781
|
+
class Provider < Trycourier::Internal::Type::BaseModel
|
782
|
+
OrHash =
|
783
|
+
T.type_alias do
|
784
|
+
T.any(
|
785
|
+
Trycourier::SendMessageParams::Message::Provider,
|
786
|
+
Trycourier::Internal::AnyHash
|
787
|
+
)
|
788
|
+
end
|
789
|
+
|
790
|
+
# JS conditional with access to data/profile.
|
791
|
+
sig { returns(T.nilable(String)) }
|
792
|
+
attr_accessor :if_
|
793
|
+
|
794
|
+
sig do
|
795
|
+
returns(
|
796
|
+
T.nilable(
|
797
|
+
Trycourier::SendMessageParams::Message::Provider::Metadata
|
798
|
+
)
|
799
|
+
)
|
800
|
+
end
|
801
|
+
attr_reader :metadata
|
802
|
+
|
803
|
+
sig do
|
804
|
+
params(
|
805
|
+
metadata:
|
806
|
+
T.nilable(
|
807
|
+
Trycourier::SendMessageParams::Message::Provider::Metadata::OrHash
|
808
|
+
)
|
809
|
+
).void
|
810
|
+
end
|
811
|
+
attr_writer :metadata
|
812
|
+
|
813
|
+
# Provider-specific overrides.
|
814
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
815
|
+
attr_accessor :override
|
816
|
+
|
817
|
+
sig { returns(T.nilable(Integer)) }
|
818
|
+
attr_accessor :timeouts
|
819
|
+
|
820
|
+
sig do
|
821
|
+
params(
|
822
|
+
if_: T.nilable(String),
|
823
|
+
metadata:
|
824
|
+
T.nilable(
|
825
|
+
Trycourier::SendMessageParams::Message::Provider::Metadata::OrHash
|
826
|
+
),
|
827
|
+
override: T.nilable(T::Hash[Symbol, T.anything]),
|
828
|
+
timeouts: T.nilable(Integer)
|
829
|
+
).returns(T.attached_class)
|
830
|
+
end
|
831
|
+
def self.new(
|
832
|
+
# JS conditional with access to data/profile.
|
833
|
+
if_: nil,
|
834
|
+
metadata: nil,
|
835
|
+
# Provider-specific overrides.
|
836
|
+
override: nil,
|
837
|
+
timeouts: nil
|
838
|
+
)
|
839
|
+
end
|
840
|
+
|
841
|
+
sig do
|
842
|
+
override.returns(
|
843
|
+
{
|
844
|
+
if_: T.nilable(String),
|
845
|
+
metadata:
|
846
|
+
T.nilable(
|
847
|
+
Trycourier::SendMessageParams::Message::Provider::Metadata
|
848
|
+
),
|
849
|
+
override: T.nilable(T::Hash[Symbol, T.anything]),
|
850
|
+
timeouts: T.nilable(Integer)
|
851
|
+
}
|
852
|
+
)
|
853
|
+
end
|
854
|
+
def to_hash
|
855
|
+
end
|
856
|
+
|
857
|
+
class Metadata < Trycourier::Internal::Type::BaseModel
|
858
|
+
OrHash =
|
859
|
+
T.type_alias do
|
860
|
+
T.any(
|
861
|
+
Trycourier::SendMessageParams::Message::Provider::Metadata,
|
862
|
+
Trycourier::Internal::AnyHash
|
863
|
+
)
|
864
|
+
end
|
865
|
+
|
866
|
+
sig { returns(T.nilable(Trycourier::Utm)) }
|
867
|
+
attr_reader :utm
|
868
|
+
|
869
|
+
sig { params(utm: T.nilable(Trycourier::Utm::OrHash)).void }
|
870
|
+
attr_writer :utm
|
871
|
+
|
872
|
+
sig do
|
873
|
+
params(utm: T.nilable(Trycourier::Utm::OrHash)).returns(
|
874
|
+
T.attached_class
|
875
|
+
)
|
876
|
+
end
|
877
|
+
def self.new(utm: nil)
|
878
|
+
end
|
879
|
+
|
880
|
+
sig { override.returns({ utm: T.nilable(Trycourier::Utm) }) }
|
881
|
+
def to_hash
|
882
|
+
end
|
883
|
+
end
|
884
|
+
end
|
885
|
+
|
886
|
+
class Routing < Trycourier::Internal::Type::BaseModel
|
887
|
+
OrHash =
|
888
|
+
T.type_alias do
|
889
|
+
T.any(
|
890
|
+
Trycourier::SendMessageParams::Message::Routing,
|
891
|
+
Trycourier::Internal::AnyHash
|
892
|
+
)
|
893
|
+
end
|
894
|
+
|
895
|
+
# A list of channels or providers (or nested routing rules).
|
896
|
+
sig { returns(T::Array[T.any(String, Trycourier::MessageRouting)]) }
|
897
|
+
attr_accessor :channels
|
898
|
+
|
899
|
+
sig do
|
900
|
+
returns(
|
901
|
+
Trycourier::SendMessageParams::Message::Routing::Method::OrSymbol
|
902
|
+
)
|
903
|
+
end
|
904
|
+
attr_accessor :method_
|
905
|
+
|
906
|
+
# Customize which channels/providers Courier may deliver the message through.
|
907
|
+
sig do
|
908
|
+
params(
|
909
|
+
channels: T::Array[T.any(String, Trycourier::MessageRouting)],
|
910
|
+
method_:
|
911
|
+
Trycourier::SendMessageParams::Message::Routing::Method::OrSymbol
|
912
|
+
).returns(T.attached_class)
|
913
|
+
end
|
914
|
+
def self.new(
|
915
|
+
# A list of channels or providers (or nested routing rules).
|
916
|
+
channels:,
|
917
|
+
method_:
|
918
|
+
)
|
919
|
+
end
|
920
|
+
|
921
|
+
sig do
|
922
|
+
override.returns(
|
923
|
+
{
|
924
|
+
channels: T::Array[T.any(String, Trycourier::MessageRouting)],
|
925
|
+
method_:
|
926
|
+
Trycourier::SendMessageParams::Message::Routing::Method::OrSymbol
|
927
|
+
}
|
928
|
+
)
|
929
|
+
end
|
930
|
+
def to_hash
|
931
|
+
end
|
932
|
+
|
933
|
+
module Method
|
934
|
+
extend Trycourier::Internal::Type::Enum
|
935
|
+
|
936
|
+
TaggedSymbol =
|
937
|
+
T.type_alias do
|
938
|
+
T.all(
|
939
|
+
Symbol,
|
940
|
+
Trycourier::SendMessageParams::Message::Routing::Method
|
941
|
+
)
|
942
|
+
end
|
943
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
944
|
+
|
945
|
+
ALL =
|
946
|
+
T.let(
|
947
|
+
:all,
|
948
|
+
Trycourier::SendMessageParams::Message::Routing::Method::TaggedSymbol
|
949
|
+
)
|
950
|
+
SINGLE =
|
951
|
+
T.let(
|
952
|
+
:single,
|
953
|
+
Trycourier::SendMessageParams::Message::Routing::Method::TaggedSymbol
|
954
|
+
)
|
955
|
+
|
956
|
+
sig do
|
957
|
+
override.returns(
|
958
|
+
T::Array[
|
959
|
+
Trycourier::SendMessageParams::Message::Routing::Method::TaggedSymbol
|
960
|
+
]
|
961
|
+
)
|
962
|
+
end
|
963
|
+
def self.values
|
964
|
+
end
|
965
|
+
end
|
966
|
+
end
|
967
|
+
|
968
|
+
class Timeout < Trycourier::Internal::Type::BaseModel
|
969
|
+
OrHash =
|
970
|
+
T.type_alias do
|
971
|
+
T.any(
|
972
|
+
Trycourier::SendMessageParams::Message::Timeout,
|
973
|
+
Trycourier::Internal::AnyHash
|
974
|
+
)
|
975
|
+
end
|
976
|
+
|
977
|
+
sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
|
978
|
+
attr_accessor :channel
|
979
|
+
|
980
|
+
sig do
|
981
|
+
returns(
|
982
|
+
T.nilable(
|
983
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::OrSymbol
|
984
|
+
)
|
985
|
+
)
|
986
|
+
end
|
987
|
+
attr_accessor :criteria
|
988
|
+
|
989
|
+
sig { returns(T.nilable(Integer)) }
|
990
|
+
attr_accessor :escalation
|
991
|
+
|
992
|
+
sig { returns(T.nilable(Integer)) }
|
993
|
+
attr_accessor :message
|
994
|
+
|
995
|
+
sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
|
996
|
+
attr_accessor :provider
|
997
|
+
|
998
|
+
sig do
|
999
|
+
params(
|
1000
|
+
channel: T.nilable(T::Hash[Symbol, Integer]),
|
1001
|
+
criteria:
|
1002
|
+
T.nilable(
|
1003
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::OrSymbol
|
1004
|
+
),
|
1005
|
+
escalation: T.nilable(Integer),
|
1006
|
+
message: T.nilable(Integer),
|
1007
|
+
provider: T.nilable(T::Hash[Symbol, Integer])
|
1008
|
+
).returns(T.attached_class)
|
1009
|
+
end
|
1010
|
+
def self.new(
|
1011
|
+
channel: nil,
|
1012
|
+
criteria: nil,
|
1013
|
+
escalation: nil,
|
1014
|
+
message: nil,
|
1015
|
+
provider: nil
|
1016
|
+
)
|
1017
|
+
end
|
1018
|
+
|
1019
|
+
sig do
|
1020
|
+
override.returns(
|
1021
|
+
{
|
1022
|
+
channel: T.nilable(T::Hash[Symbol, Integer]),
|
1023
|
+
criteria:
|
1024
|
+
T.nilable(
|
1025
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::OrSymbol
|
1026
|
+
),
|
1027
|
+
escalation: T.nilable(Integer),
|
1028
|
+
message: T.nilable(Integer),
|
1029
|
+
provider: T.nilable(T::Hash[Symbol, Integer])
|
1030
|
+
}
|
1031
|
+
)
|
1032
|
+
end
|
1033
|
+
def to_hash
|
1034
|
+
end
|
1035
|
+
|
1036
|
+
module Criteria
|
1037
|
+
extend Trycourier::Internal::Type::Enum
|
1038
|
+
|
1039
|
+
TaggedSymbol =
|
1040
|
+
T.type_alias do
|
1041
|
+
T.all(
|
1042
|
+
Symbol,
|
1043
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria
|
1044
|
+
)
|
1045
|
+
end
|
1046
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1047
|
+
|
1048
|
+
NO_ESCALATION =
|
1049
|
+
T.let(
|
1050
|
+
:"no-escalation",
|
1051
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::TaggedSymbol
|
1052
|
+
)
|
1053
|
+
DELIVERED =
|
1054
|
+
T.let(
|
1055
|
+
:delivered,
|
1056
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::TaggedSymbol
|
1057
|
+
)
|
1058
|
+
VIEWED =
|
1059
|
+
T.let(
|
1060
|
+
:viewed,
|
1061
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::TaggedSymbol
|
1062
|
+
)
|
1063
|
+
ENGAGED =
|
1064
|
+
T.let(
|
1065
|
+
:engaged,
|
1066
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::TaggedSymbol
|
1067
|
+
)
|
1068
|
+
|
1069
|
+
sig do
|
1070
|
+
override.returns(
|
1071
|
+
T::Array[
|
1072
|
+
Trycourier::SendMessageParams::Message::Timeout::Criteria::TaggedSymbol
|
1073
|
+
]
|
1074
|
+
)
|
1075
|
+
end
|
1076
|
+
def self.values
|
1077
|
+
end
|
1078
|
+
end
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# The recipient or a list of recipients of the message
|
1082
|
+
module To
|
1083
|
+
extend Trycourier::Internal::Type::Union
|
1084
|
+
|
1085
|
+
Variants =
|
1086
|
+
T.type_alias do
|
1087
|
+
T.any(Trycourier::UserRecipient, T::Array[Trycourier::Recipient])
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
sig do
|
1091
|
+
override.returns(
|
1092
|
+
T::Array[Trycourier::SendMessageParams::Message::To::Variants]
|
1093
|
+
)
|
1094
|
+
end
|
1095
|
+
def self.variants
|
1096
|
+
end
|
1097
|
+
|
1098
|
+
RecipientArray =
|
1099
|
+
T.let(
|
1100
|
+
Trycourier::Internal::Type::ArrayOf[Trycourier::Recipient],
|
1101
|
+
Trycourier::Internal::Type::Converter
|
1102
|
+
)
|
1103
|
+
end
|
1104
|
+
end
|
1105
|
+
end
|
1106
|
+
end
|
1107
|
+
end
|