trycourier 3.1.3 → 3.4.0.pre.alpha0
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 +53 -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 -55
- 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
@@ -1,58 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative "../../commons/types/recipient_preferences"
|
4
|
-
require "json"
|
5
|
-
|
6
|
-
module Courier
|
7
|
-
class Lists
|
8
|
-
class ListPutParams
|
9
|
-
attr_reader :name, :preferences, :additional_properties
|
10
|
-
|
11
|
-
# @param name [String]
|
12
|
-
# @param preferences [Commons::RecipientPreferences]
|
13
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
14
|
-
# @return [Lists::ListPutParams]
|
15
|
-
def initialize(name:, preferences: nil, additional_properties: nil)
|
16
|
-
# @type [String]
|
17
|
-
@name = name
|
18
|
-
# @type [Commons::RecipientPreferences]
|
19
|
-
@preferences = preferences
|
20
|
-
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
21
|
-
@additional_properties = additional_properties
|
22
|
-
end
|
23
|
-
|
24
|
-
# Deserialize a JSON object to an instance of ListPutParams
|
25
|
-
#
|
26
|
-
# @param json_object [JSON]
|
27
|
-
# @return [Lists::ListPutParams]
|
28
|
-
def self.from_json(json_object:)
|
29
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
30
|
-
parsed_json = JSON.parse(json_object)
|
31
|
-
name = struct.name
|
32
|
-
if parsed_json["preferences"].nil?
|
33
|
-
preferences = nil
|
34
|
-
else
|
35
|
-
preferences = parsed_json["preferences"].to_json
|
36
|
-
preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
|
37
|
-
end
|
38
|
-
new(name: name, preferences: preferences, additional_properties: struct)
|
39
|
-
end
|
40
|
-
|
41
|
-
# Serialize an instance of ListPutParams to a JSON object
|
42
|
-
#
|
43
|
-
# @return [JSON]
|
44
|
-
def to_json(*_args)
|
45
|
-
{ "name": @name, "preferences": @preferences }.to_json
|
46
|
-
end
|
47
|
-
|
48
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
49
|
-
#
|
50
|
-
# @param obj [Object]
|
51
|
-
# @return [Void]
|
52
|
-
def self.validate_raw(obj:)
|
53
|
-
obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
54
|
-
obj.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
|
55
|
-
end
|
56
|
-
end
|
57
|
-
end
|
58
|
-
end
|
@@ -1,63 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative "../../commons/types/recipient_preferences"
|
4
|
-
require "json"
|
5
|
-
|
6
|
-
module Courier
|
7
|
-
class Lists
|
8
|
-
class ListSubscriptionRecipient
|
9
|
-
attr_reader :recipient_id, :created, :preferences, :additional_properties
|
10
|
-
|
11
|
-
# @param recipient_id [String]
|
12
|
-
# @param created [String]
|
13
|
-
# @param preferences [Commons::RecipientPreferences]
|
14
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
15
|
-
# @return [Lists::ListSubscriptionRecipient]
|
16
|
-
def initialize(recipient_id:, created: nil, preferences: nil, additional_properties: nil)
|
17
|
-
# @type [String]
|
18
|
-
@recipient_id = recipient_id
|
19
|
-
# @type [String]
|
20
|
-
@created = created
|
21
|
-
# @type [Commons::RecipientPreferences]
|
22
|
-
@preferences = preferences
|
23
|
-
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
24
|
-
@additional_properties = additional_properties
|
25
|
-
end
|
26
|
-
|
27
|
-
# Deserialize a JSON object to an instance of ListSubscriptionRecipient
|
28
|
-
#
|
29
|
-
# @param json_object [JSON]
|
30
|
-
# @return [Lists::ListSubscriptionRecipient]
|
31
|
-
def self.from_json(json_object:)
|
32
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
33
|
-
parsed_json = JSON.parse(json_object)
|
34
|
-
recipient_id = struct.recipientId
|
35
|
-
created = struct.created
|
36
|
-
if parsed_json["preferences"].nil?
|
37
|
-
preferences = nil
|
38
|
-
else
|
39
|
-
preferences = parsed_json["preferences"].to_json
|
40
|
-
preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
|
41
|
-
end
|
42
|
-
new(recipient_id: recipient_id, created: created, preferences: preferences, additional_properties: struct)
|
43
|
-
end
|
44
|
-
|
45
|
-
# Serialize an instance of ListSubscriptionRecipient to a JSON object
|
46
|
-
#
|
47
|
-
# @return [JSON]
|
48
|
-
def to_json(*_args)
|
49
|
-
{ "recipientId": @recipient_id, "created": @created, "preferences": @preferences }.to_json
|
50
|
-
end
|
51
|
-
|
52
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
53
|
-
#
|
54
|
-
# @param obj [Object]
|
55
|
-
# @return [Void]
|
56
|
-
def self.validate_raw(obj:)
|
57
|
-
obj.recipient_id.is_a?(String) != false || raise("Passed value for field obj.recipient_id is not the expected type, validation failed.")
|
58
|
-
obj.created&.is_a?(String) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
|
59
|
-
obj.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
|
60
|
-
end
|
61
|
-
end
|
62
|
-
end
|
63
|
-
end
|
@@ -1,58 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative "../../commons/types/recipient_preferences"
|
4
|
-
require "json"
|
5
|
-
|
6
|
-
module Courier
|
7
|
-
class Lists
|
8
|
-
class PutSubscriptionsRecipient
|
9
|
-
attr_reader :recipient_id, :preferences, :additional_properties
|
10
|
-
|
11
|
-
# @param recipient_id [String]
|
12
|
-
# @param preferences [Commons::RecipientPreferences]
|
13
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
14
|
-
# @return [Lists::PutSubscriptionsRecipient]
|
15
|
-
def initialize(recipient_id:, preferences: nil, additional_properties: nil)
|
16
|
-
# @type [String]
|
17
|
-
@recipient_id = recipient_id
|
18
|
-
# @type [Commons::RecipientPreferences]
|
19
|
-
@preferences = preferences
|
20
|
-
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
21
|
-
@additional_properties = additional_properties
|
22
|
-
end
|
23
|
-
|
24
|
-
# Deserialize a JSON object to an instance of PutSubscriptionsRecipient
|
25
|
-
#
|
26
|
-
# @param json_object [JSON]
|
27
|
-
# @return [Lists::PutSubscriptionsRecipient]
|
28
|
-
def self.from_json(json_object:)
|
29
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
30
|
-
parsed_json = JSON.parse(json_object)
|
31
|
-
recipient_id = struct.recipientId
|
32
|
-
if parsed_json["preferences"].nil?
|
33
|
-
preferences = nil
|
34
|
-
else
|
35
|
-
preferences = parsed_json["preferences"].to_json
|
36
|
-
preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
|
37
|
-
end
|
38
|
-
new(recipient_id: recipient_id, preferences: preferences, additional_properties: struct)
|
39
|
-
end
|
40
|
-
|
41
|
-
# Serialize an instance of PutSubscriptionsRecipient to a JSON object
|
42
|
-
#
|
43
|
-
# @return [JSON]
|
44
|
-
def to_json(*_args)
|
45
|
-
{ "recipientId": @recipient_id, "preferences": @preferences }.to_json
|
46
|
-
end
|
47
|
-
|
48
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
49
|
-
#
|
50
|
-
# @param obj [Object]
|
51
|
-
# @return [Void]
|
52
|
-
def self.validate_raw(obj:)
|
53
|
-
obj.recipient_id.is_a?(String) != false || raise("Passed value for field obj.recipient_id is not the expected type, validation failed.")
|
54
|
-
obj.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
|
55
|
-
end
|
56
|
-
end
|
57
|
-
end
|
58
|
-
end
|
@@ -1,300 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative "../../requests"
|
4
|
-
require_relative "types/list_messages_response"
|
5
|
-
require_relative "types/message_details"
|
6
|
-
require_relative "types/message_history_response"
|
7
|
-
require_relative "types/render_output_response"
|
8
|
-
require "async"
|
9
|
-
|
10
|
-
module Courier
|
11
|
-
class MessagesClient
|
12
|
-
attr_reader :request_client
|
13
|
-
|
14
|
-
# @param request_client [RequestClient]
|
15
|
-
# @return [MessagesClient]
|
16
|
-
def initialize(request_client:)
|
17
|
-
# @type [RequestClient]
|
18
|
-
@request_client = request_client
|
19
|
-
end
|
20
|
-
|
21
|
-
# Fetch the statuses of messages you've previously sent.
|
22
|
-
#
|
23
|
-
# @param archived [Boolean] A boolean value that indicates whether archived messages should be included in the response.
|
24
|
-
# @param cursor [String] A unique identifier that allows for fetching the next set of message statuses.
|
25
|
-
# @param event [String] A unique identifier representing the event that was used to send the event.
|
26
|
-
# @param list [String] A unique identifier representing the list the message was sent to.
|
27
|
-
# @param message_id [String] A unique identifier representing the message_id returned from either /send or /send/list.
|
28
|
-
# @param notification [String] A unique identifier representing the notification that was used to send the event.
|
29
|
-
# @param recipient [String] A unique identifier representing the recipient associated with the requested profile.
|
30
|
-
# @param status [String] An indicator of the current status of the message. Multiple status values can be passed in.
|
31
|
-
# @param tags [String] A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.
|
32
|
-
# @param enqueued_after [String] The enqueued datetime of a message to filter out messages received before.
|
33
|
-
# @param trace_id [String] The unique identifier used to trace the requests
|
34
|
-
# @param request_options [RequestOptions]
|
35
|
-
# @return [Messages::ListMessagesResponse]
|
36
|
-
def list(archived: nil, cursor: nil, event: nil, list: nil, message_id: nil, notification: nil, recipient: nil,
|
37
|
-
status: nil, tags: nil, enqueued_after: nil, trace_id: nil, request_options: nil)
|
38
|
-
response = @request_client.conn.get("/messages") do |req|
|
39
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
40
|
-
unless request_options&.authorization_token.nil?
|
41
|
-
req.headers["Authorization"] =
|
42
|
-
request_options.authorization_token
|
43
|
-
end
|
44
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
45
|
-
req.params = {
|
46
|
-
**(request_options&.additional_query_parameters || {}),
|
47
|
-
"archived": archived,
|
48
|
-
"cursor": cursor,
|
49
|
-
"event": event,
|
50
|
-
"list": list,
|
51
|
-
"messageId": message_id,
|
52
|
-
"notification": notification,
|
53
|
-
"recipient": recipient,
|
54
|
-
"status": status,
|
55
|
-
"tags": tags,
|
56
|
-
"enqueued_after": enqueued_after,
|
57
|
-
"traceId": trace_id
|
58
|
-
}.compact
|
59
|
-
end
|
60
|
-
Messages::ListMessagesResponse.from_json(json_object: response.body)
|
61
|
-
end
|
62
|
-
|
63
|
-
# Fetch the status of a message you've previously sent.
|
64
|
-
#
|
65
|
-
# @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
|
66
|
-
# @param request_options [RequestOptions]
|
67
|
-
# @return [Messages::MessageDetails]
|
68
|
-
def get(message_id:, request_options: nil)
|
69
|
-
response = @request_client.conn.get("/messages/#{message_id}") do |req|
|
70
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
71
|
-
unless request_options&.authorization_token.nil?
|
72
|
-
req.headers["Authorization"] =
|
73
|
-
request_options.authorization_token
|
74
|
-
end
|
75
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
76
|
-
end
|
77
|
-
Messages::MessageDetails.from_json(json_object: response.body)
|
78
|
-
end
|
79
|
-
|
80
|
-
# Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
|
81
|
-
#
|
82
|
-
# @param message_id [String] A unique identifier representing the message ID
|
83
|
-
# @param request_options [IdempotencyRequestOptions]
|
84
|
-
# @return [Messages::MessageDetails]
|
85
|
-
def cancel(message_id:, request_options: nil)
|
86
|
-
response = @request_client.conn.post("/messages/#{message_id}/cancel") do |req|
|
87
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
88
|
-
unless request_options&.authorization_token.nil?
|
89
|
-
req.headers["Authorization"] =
|
90
|
-
request_options.authorization_token
|
91
|
-
end
|
92
|
-
req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
|
93
|
-
unless request_options&.idempotency_expiry.nil?
|
94
|
-
req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
|
95
|
-
end
|
96
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
97
|
-
end
|
98
|
-
Messages::MessageDetails.from_json(json_object: response.body)
|
99
|
-
end
|
100
|
-
|
101
|
-
# Fetch the array of events of a message you've previously sent.
|
102
|
-
#
|
103
|
-
# @param message_id [String] A unique identifier representing the message ID
|
104
|
-
# @param type [String] A supported Message History type that will filter the events returned.
|
105
|
-
# @param request_options [RequestOptions]
|
106
|
-
# @return [Messages::MessageHistoryResponse]
|
107
|
-
def get_history(message_id:, type: nil, request_options: nil)
|
108
|
-
response = @request_client.conn.get("/messages/#{message_id}/history") do |req|
|
109
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
110
|
-
unless request_options&.authorization_token.nil?
|
111
|
-
req.headers["Authorization"] =
|
112
|
-
request_options.authorization_token
|
113
|
-
end
|
114
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
115
|
-
req.params = { **(request_options&.additional_query_parameters || {}), "type": type }.compact
|
116
|
-
end
|
117
|
-
Messages::MessageHistoryResponse.from_json(json_object: response.body)
|
118
|
-
end
|
119
|
-
|
120
|
-
# @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
|
121
|
-
# @param request_options [RequestOptions]
|
122
|
-
# @return [Messages::RenderOutputResponse]
|
123
|
-
def get_content(message_id:, request_options: nil)
|
124
|
-
response = @request_client.conn.get("/messages/#{message_id}/output") do |req|
|
125
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
126
|
-
unless request_options&.authorization_token.nil?
|
127
|
-
req.headers["Authorization"] =
|
128
|
-
request_options.authorization_token
|
129
|
-
end
|
130
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
131
|
-
end
|
132
|
-
Messages::RenderOutputResponse.from_json(json_object: response.body)
|
133
|
-
end
|
134
|
-
|
135
|
-
# @param request_id [String] A unique identifier representing the request ID
|
136
|
-
# @param request_options [RequestOptions]
|
137
|
-
# @return [Void]
|
138
|
-
def archive(request_id:, request_options: nil)
|
139
|
-
@request_client.conn.put("/requests/#{request_id}/archive") do |req|
|
140
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
141
|
-
unless request_options&.authorization_token.nil?
|
142
|
-
req.headers["Authorization"] =
|
143
|
-
request_options.authorization_token
|
144
|
-
end
|
145
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
146
|
-
end
|
147
|
-
end
|
148
|
-
end
|
149
|
-
|
150
|
-
class AsyncMessagesClient
|
151
|
-
attr_reader :request_client
|
152
|
-
|
153
|
-
# @param request_client [AsyncRequestClient]
|
154
|
-
# @return [AsyncMessagesClient]
|
155
|
-
def initialize(request_client:)
|
156
|
-
# @type [AsyncRequestClient]
|
157
|
-
@request_client = request_client
|
158
|
-
end
|
159
|
-
|
160
|
-
# Fetch the statuses of messages you've previously sent.
|
161
|
-
#
|
162
|
-
# @param archived [Boolean] A boolean value that indicates whether archived messages should be included in the response.
|
163
|
-
# @param cursor [String] A unique identifier that allows for fetching the next set of message statuses.
|
164
|
-
# @param event [String] A unique identifier representing the event that was used to send the event.
|
165
|
-
# @param list [String] A unique identifier representing the list the message was sent to.
|
166
|
-
# @param message_id [String] A unique identifier representing the message_id returned from either /send or /send/list.
|
167
|
-
# @param notification [String] A unique identifier representing the notification that was used to send the event.
|
168
|
-
# @param recipient [String] A unique identifier representing the recipient associated with the requested profile.
|
169
|
-
# @param status [String] An indicator of the current status of the message. Multiple status values can be passed in.
|
170
|
-
# @param tags [String] A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.
|
171
|
-
# @param enqueued_after [String] The enqueued datetime of a message to filter out messages received before.
|
172
|
-
# @param trace_id [String] The unique identifier used to trace the requests
|
173
|
-
# @param request_options [RequestOptions]
|
174
|
-
# @return [Messages::ListMessagesResponse]
|
175
|
-
def list(archived: nil, cursor: nil, event: nil, list: nil, message_id: nil, notification: nil, recipient: nil,
|
176
|
-
status: nil, tags: nil, enqueued_after: nil, trace_id: nil, request_options: nil)
|
177
|
-
Async do
|
178
|
-
response = @request_client.conn.get("/messages") do |req|
|
179
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
180
|
-
unless request_options&.authorization_token.nil?
|
181
|
-
req.headers["Authorization"] =
|
182
|
-
request_options.authorization_token
|
183
|
-
end
|
184
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
185
|
-
req.params = {
|
186
|
-
**(request_options&.additional_query_parameters || {}),
|
187
|
-
"archived": archived,
|
188
|
-
"cursor": cursor,
|
189
|
-
"event": event,
|
190
|
-
"list": list,
|
191
|
-
"messageId": message_id,
|
192
|
-
"notification": notification,
|
193
|
-
"recipient": recipient,
|
194
|
-
"status": status,
|
195
|
-
"tags": tags,
|
196
|
-
"enqueued_after": enqueued_after,
|
197
|
-
"traceId": trace_id
|
198
|
-
}.compact
|
199
|
-
end
|
200
|
-
Messages::ListMessagesResponse.from_json(json_object: response.body)
|
201
|
-
end
|
202
|
-
end
|
203
|
-
|
204
|
-
# Fetch the status of a message you've previously sent.
|
205
|
-
#
|
206
|
-
# @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
|
207
|
-
# @param request_options [RequestOptions]
|
208
|
-
# @return [Messages::MessageDetails]
|
209
|
-
def get(message_id:, request_options: nil)
|
210
|
-
Async do
|
211
|
-
response = @request_client.conn.get("/messages/#{message_id}") do |req|
|
212
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
213
|
-
unless request_options&.authorization_token.nil?
|
214
|
-
req.headers["Authorization"] =
|
215
|
-
request_options.authorization_token
|
216
|
-
end
|
217
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
218
|
-
end
|
219
|
-
Messages::MessageDetails.from_json(json_object: response.body)
|
220
|
-
end
|
221
|
-
end
|
222
|
-
|
223
|
-
# Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
|
224
|
-
#
|
225
|
-
# @param message_id [String] A unique identifier representing the message ID
|
226
|
-
# @param request_options [IdempotencyRequestOptions]
|
227
|
-
# @return [Messages::MessageDetails]
|
228
|
-
def cancel(message_id:, request_options: nil)
|
229
|
-
Async do
|
230
|
-
response = @request_client.conn.post("/messages/#{message_id}/cancel") do |req|
|
231
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
232
|
-
unless request_options&.authorization_token.nil?
|
233
|
-
req.headers["Authorization"] =
|
234
|
-
request_options.authorization_token
|
235
|
-
end
|
236
|
-
req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
|
237
|
-
unless request_options&.idempotency_expiry.nil?
|
238
|
-
req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
|
239
|
-
end
|
240
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
241
|
-
end
|
242
|
-
Messages::MessageDetails.from_json(json_object: response.body)
|
243
|
-
end
|
244
|
-
end
|
245
|
-
|
246
|
-
# Fetch the array of events of a message you've previously sent.
|
247
|
-
#
|
248
|
-
# @param message_id [String] A unique identifier representing the message ID
|
249
|
-
# @param type [String] A supported Message History type that will filter the events returned.
|
250
|
-
# @param request_options [RequestOptions]
|
251
|
-
# @return [Messages::MessageHistoryResponse]
|
252
|
-
def get_history(message_id:, type: nil, request_options: nil)
|
253
|
-
Async do
|
254
|
-
response = @request_client.conn.get("/messages/#{message_id}/history") do |req|
|
255
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
256
|
-
unless request_options&.authorization_token.nil?
|
257
|
-
req.headers["Authorization"] =
|
258
|
-
request_options.authorization_token
|
259
|
-
end
|
260
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
261
|
-
req.params = { **(request_options&.additional_query_parameters || {}), "type": type }.compact
|
262
|
-
end
|
263
|
-
Messages::MessageHistoryResponse.from_json(json_object: response.body)
|
264
|
-
end
|
265
|
-
end
|
266
|
-
|
267
|
-
# @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
|
268
|
-
# @param request_options [RequestOptions]
|
269
|
-
# @return [Messages::RenderOutputResponse]
|
270
|
-
def get_content(message_id:, request_options: nil)
|
271
|
-
Async do
|
272
|
-
response = @request_client.conn.get("/messages/#{message_id}/output") do |req|
|
273
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
274
|
-
unless request_options&.authorization_token.nil?
|
275
|
-
req.headers["Authorization"] =
|
276
|
-
request_options.authorization_token
|
277
|
-
end
|
278
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
279
|
-
end
|
280
|
-
Messages::RenderOutputResponse.from_json(json_object: response.body)
|
281
|
-
end
|
282
|
-
end
|
283
|
-
|
284
|
-
# @param request_id [String] A unique identifier representing the request ID
|
285
|
-
# @param request_options [RequestOptions]
|
286
|
-
# @return [Void]
|
287
|
-
def archive(request_id:, request_options: nil)
|
288
|
-
Async do
|
289
|
-
@request_client.conn.put("/requests/#{request_id}/archive") do |req|
|
290
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
291
|
-
unless request_options&.authorization_token.nil?
|
292
|
-
req.headers["Authorization"] =
|
293
|
-
request_options.authorization_token
|
294
|
-
end
|
295
|
-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
296
|
-
end
|
297
|
-
end
|
298
|
-
end
|
299
|
-
end
|
300
|
-
end
|
@@ -1,62 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative "../../commons/types/paging"
|
4
|
-
require_relative "message_details"
|
5
|
-
require "json"
|
6
|
-
|
7
|
-
module Courier
|
8
|
-
class Messages
|
9
|
-
class ListMessagesResponse
|
10
|
-
attr_reader :paging, :results, :additional_properties
|
11
|
-
|
12
|
-
# @param paging [Commons::Paging] Paging information for the result set.
|
13
|
-
# @param results [Array<Messages::MessageDetails>] An array of messages with their details.
|
14
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
15
|
-
# @return [Messages::ListMessagesResponse]
|
16
|
-
def initialize(paging:, results:, additional_properties: nil)
|
17
|
-
# @type [Commons::Paging] Paging information for the result set.
|
18
|
-
@paging = paging
|
19
|
-
# @type [Array<Messages::MessageDetails>] An array of messages with their details.
|
20
|
-
@results = results
|
21
|
-
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
22
|
-
@additional_properties = additional_properties
|
23
|
-
end
|
24
|
-
|
25
|
-
# Deserialize a JSON object to an instance of ListMessagesResponse
|
26
|
-
#
|
27
|
-
# @param json_object [JSON]
|
28
|
-
# @return [Messages::ListMessagesResponse]
|
29
|
-
def self.from_json(json_object:)
|
30
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
31
|
-
parsed_json = JSON.parse(json_object)
|
32
|
-
if parsed_json["paging"].nil?
|
33
|
-
paging = nil
|
34
|
-
else
|
35
|
-
paging = parsed_json["paging"].to_json
|
36
|
-
paging = Commons::Paging.from_json(json_object: paging)
|
37
|
-
end
|
38
|
-
results = parsed_json["results"]&.map do |v|
|
39
|
-
v = v.to_json
|
40
|
-
Messages::MessageDetails.from_json(json_object: v)
|
41
|
-
end
|
42
|
-
new(paging: paging, results: results, additional_properties: struct)
|
43
|
-
end
|
44
|
-
|
45
|
-
# Serialize an instance of ListMessagesResponse to a JSON object
|
46
|
-
#
|
47
|
-
# @return [JSON]
|
48
|
-
def to_json(*_args)
|
49
|
-
{ "paging": @paging, "results": @results }.to_json
|
50
|
-
end
|
51
|
-
|
52
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
53
|
-
#
|
54
|
-
# @param obj [Object]
|
55
|
-
# @return [Void]
|
56
|
-
def self.validate_raw(obj:)
|
57
|
-
Commons::Paging.validate_raw(obj: obj.paging)
|
58
|
-
obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
|
59
|
-
end
|
60
|
-
end
|
61
|
-
end
|
62
|
-
end
|
@@ -1,120 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative "message_status"
|
4
|
-
require_relative "reason"
|
5
|
-
require "json"
|
6
|
-
|
7
|
-
module Courier
|
8
|
-
class Messages
|
9
|
-
class MessageDetails
|
10
|
-
attr_reader :id, :status, :enqueued, :sent, :delivered, :opened, :clicked, :recipient, :event, :notification,
|
11
|
-
:error, :reason, :additional_properties
|
12
|
-
|
13
|
-
# @param id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
|
14
|
-
# @param status [Messages::MessageStatus] The current status of the message.
|
15
|
-
# @param enqueued [Integer] A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
|
16
|
-
# @param sent [Integer] A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
|
17
|
-
# @param delivered [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
|
18
|
-
# @param opened [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
|
19
|
-
# @param clicked [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
|
20
|
-
# @param recipient [String] A unique identifier associated with the recipient of the delivered message.
|
21
|
-
# @param event [String] A unique identifier associated with the event of the delivered message.
|
22
|
-
# @param notification [String] A unique identifier associated with the notification of the delivered message.
|
23
|
-
# @param error [String] A message describing the error that occurred.
|
24
|
-
# @param reason [Messages::Reason] The reason for the current status of the message.
|
25
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
26
|
-
# @return [Messages::MessageDetails]
|
27
|
-
def initialize(id:, status:, enqueued:, sent:, delivered:, opened:, clicked:, recipient:, event:, notification:,
|
28
|
-
error: nil, reason: nil, additional_properties: nil)
|
29
|
-
# @type [String] A unique identifier associated with the message you wish to retrieve (results from a send).
|
30
|
-
@id = id
|
31
|
-
# @type [Messages::MessageStatus] The current status of the message.
|
32
|
-
@status = status
|
33
|
-
# @type [Integer] A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
|
34
|
-
@enqueued = enqueued
|
35
|
-
# @type [Integer] A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
|
36
|
-
@sent = sent
|
37
|
-
# @type [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
|
38
|
-
@delivered = delivered
|
39
|
-
# @type [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
|
40
|
-
@opened = opened
|
41
|
-
# @type [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
|
42
|
-
@clicked = clicked
|
43
|
-
# @type [String] A unique identifier associated with the recipient of the delivered message.
|
44
|
-
@recipient = recipient
|
45
|
-
# @type [String] A unique identifier associated with the event of the delivered message.
|
46
|
-
@event = event
|
47
|
-
# @type [String] A unique identifier associated with the notification of the delivered message.
|
48
|
-
@notification = notification
|
49
|
-
# @type [String] A message describing the error that occurred.
|
50
|
-
@error = error
|
51
|
-
# @type [Messages::Reason] The reason for the current status of the message.
|
52
|
-
@reason = reason
|
53
|
-
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
54
|
-
@additional_properties = additional_properties
|
55
|
-
end
|
56
|
-
|
57
|
-
# Deserialize a JSON object to an instance of MessageDetails
|
58
|
-
#
|
59
|
-
# @param json_object [JSON]
|
60
|
-
# @return [Messages::MessageDetails]
|
61
|
-
def self.from_json(json_object:)
|
62
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
63
|
-
JSON.parse(json_object)
|
64
|
-
id = struct.id
|
65
|
-
status = struct.status
|
66
|
-
enqueued = struct.enqueued
|
67
|
-
sent = struct.sent
|
68
|
-
delivered = struct.delivered
|
69
|
-
opened = struct.opened
|
70
|
-
clicked = struct.clicked
|
71
|
-
recipient = struct.recipient
|
72
|
-
event = struct.event
|
73
|
-
notification = struct.notification
|
74
|
-
error = struct.error
|
75
|
-
reason = struct.reason
|
76
|
-
new(id: id, status: status, enqueued: enqueued, sent: sent, delivered: delivered, opened: opened,
|
77
|
-
clicked: clicked, recipient: recipient, event: event, notification: notification, error: error, reason: reason, additional_properties: struct)
|
78
|
-
end
|
79
|
-
|
80
|
-
# Serialize an instance of MessageDetails to a JSON object
|
81
|
-
#
|
82
|
-
# @return [JSON]
|
83
|
-
def to_json(*_args)
|
84
|
-
{
|
85
|
-
"id": @id,
|
86
|
-
"status": @status,
|
87
|
-
"enqueued": @enqueued,
|
88
|
-
"sent": @sent,
|
89
|
-
"delivered": @delivered,
|
90
|
-
"opened": @opened,
|
91
|
-
"clicked": @clicked,
|
92
|
-
"recipient": @recipient,
|
93
|
-
"event": @event,
|
94
|
-
"notification": @notification,
|
95
|
-
"error": @error,
|
96
|
-
"reason": @reason
|
97
|
-
}.to_json
|
98
|
-
end
|
99
|
-
|
100
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
101
|
-
#
|
102
|
-
# @param obj [Object]
|
103
|
-
# @return [Void]
|
104
|
-
def self.validate_raw(obj:)
|
105
|
-
obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
|
106
|
-
obj.status.is_a?(Messages::MessageStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
|
107
|
-
obj.enqueued.is_a?(Integer) != false || raise("Passed value for field obj.enqueued is not the expected type, validation failed.")
|
108
|
-
obj.sent.is_a?(Integer) != false || raise("Passed value for field obj.sent is not the expected type, validation failed.")
|
109
|
-
obj.delivered.is_a?(Integer) != false || raise("Passed value for field obj.delivered is not the expected type, validation failed.")
|
110
|
-
obj.opened.is_a?(Integer) != false || raise("Passed value for field obj.opened is not the expected type, validation failed.")
|
111
|
-
obj.clicked.is_a?(Integer) != false || raise("Passed value for field obj.clicked is not the expected type, validation failed.")
|
112
|
-
obj.recipient.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
|
113
|
-
obj.event.is_a?(String) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
|
114
|
-
obj.notification.is_a?(String) != false || raise("Passed value for field obj.notification is not the expected type, validation failed.")
|
115
|
-
obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
|
116
|
-
obj.reason&.is_a?(Messages::Reason) != false || raise("Passed value for field obj.reason is not the expected type, validation failed.")
|
117
|
-
end
|
118
|
-
end
|
119
|
-
end
|
120
|
-
end
|