trycourier 1.10.0 → 3.0.0.pre.beta1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/environment.rb +7 -0
- data/lib/gemconfig.rb +14 -0
- data/lib/requests.rb +121 -0
- data/lib/trycourier/audiences/client.rb +235 -0
- data/lib/trycourier/audiences/types/audience.rb +86 -0
- data/lib/trycourier/audiences/types/audience_list_response.rb +62 -0
- data/lib/trycourier/audiences/types/audience_member.rb +74 -0
- data/lib/trycourier/audiences/types/audience_member_get_response.rb +53 -0
- data/lib/trycourier/audiences/types/audience_member_list_response.rb +62 -0
- data/lib/trycourier/audiences/types/audience_update_response.rb +53 -0
- data/lib/trycourier/audiences/types/base_filter_config.rb +53 -0
- data/lib/trycourier/audiences/types/comparison_operator.rb +21 -0
- data/lib/trycourier/audiences/types/filter.rb +50 -0
- data/lib/trycourier/audiences/types/filter_config.rb +50 -0
- data/lib/trycourier/audiences/types/logical_operator.rb +10 -0
- data/lib/trycourier/audiences/types/nested_filter_config.rb +63 -0
- data/lib/trycourier/audiences/types/operator.rb +48 -0
- data/lib/trycourier/audiences/types/single_filter_config.rb +64 -0
- data/lib/trycourier/audit_events/client.rb +104 -0
- data/lib/trycourier/audit_events/types/actor.rb +52 -0
- data/lib/trycourier/audit_events/types/audit_event.rb +92 -0
- data/lib/trycourier/audit_events/types/get_audit_event_params.rb +47 -0
- data/lib/trycourier/audit_events/types/list_audit_events_params.rb +47 -0
- data/lib/trycourier/audit_events/types/list_audit_events_response.rb +62 -0
- data/lib/trycourier/audit_events/types/target.rb +52 -0
- data/lib/trycourier/auth_tokens/client.rb +85 -0
- data/lib/trycourier/auth_tokens/types/issue_token_response.rb +47 -0
- data/lib/trycourier/automations/client.rb +151 -0
- data/lib/trycourier/automations/types/automation.rb +56 -0
- data/lib/trycourier/automations/types/automation_ad_hoc_invoke_params.rb +88 -0
- data/lib/trycourier/automations/types/automation_cancel_step.rb +62 -0
- data/lib/trycourier/automations/types/automation_delay_step.rb +62 -0
- data/lib/trycourier/automations/types/automation_invoke_params.rb +69 -0
- data/lib/trycourier/automations/types/automation_invoke_response.rb +47 -0
- data/lib/trycourier/automations/types/automation_invoke_step.rb +62 -0
- data/lib/trycourier/automations/types/automation_invoke_template_params.rb +82 -0
- data/lib/trycourier/automations/types/automation_run_context.rb +69 -0
- data/lib/trycourier/automations/types/automation_send_list_step.rb +93 -0
- data/lib/trycourier/automations/types/automation_send_step.rb +99 -0
- data/lib/trycourier/automations/types/automation_step.rb +52 -0
- data/lib/trycourier/automations/types/automation_step_action.rb +14 -0
- data/lib/trycourier/automations/types/automation_step_option.rb +110 -0
- data/lib/trycourier/automations/types/automation_update_profile_step.rb +64 -0
- data/lib/trycourier/automations/types/automation_v_2_send_step.rb +68 -0
- data/lib/trycourier/automations/types/merge_algorithm.rb +12 -0
- data/lib/trycourier/automations/types/profile.rb +7 -0
- data/lib/trycourier/brands/client.rb +281 -0
- data/lib/trycourier/brands/types/brand.rb +105 -0
- data/lib/trycourier/brands/types/brand_colors.rb +57 -0
- data/lib/trycourier/brands/types/brand_get_all_response.rb +62 -0
- data/lib/trycourier/brands/types/brand_parameters.rb +74 -0
- data/lib/trycourier/brands/types/brand_settings.rb +69 -0
- data/lib/trycourier/brands/types/brand_snippet.rb +57 -0
- data/lib/trycourier/brands/types/brand_snippets.rb +51 -0
- data/lib/trycourier/brands/types/brands_response.rb +62 -0
- data/lib/trycourier/bulk/client.rb +249 -0
- data/lib/trycourier/bulk/types/bulk_create_job_response.rb +47 -0
- data/lib/trycourier/bulk/types/bulk_get_job_params.rb +47 -0
- data/lib/trycourier/bulk/types/bulk_get_job_response.rb +53 -0
- data/lib/trycourier/bulk/types/bulk_get_job_users_params.rb +52 -0
- data/lib/trycourier/bulk/types/bulk_get_job_users_response.rb +62 -0
- data/lib/trycourier/bulk/types/bulk_ingest_error.rb +52 -0
- data/lib/trycourier/bulk/types/bulk_ingest_users_params.rb +51 -0
- data/lib/trycourier/bulk/types/bulk_ingest_users_response.rb +56 -0
- data/lib/trycourier/bulk/types/bulk_job_status.rb +12 -0
- data/lib/trycourier/bulk/types/bulk_job_user_status.rb +11 -0
- data/lib/trycourier/bulk/types/bulk_message_user_response.rb +100 -0
- data/lib/trycourier/bulk/types/inbound_bulk_content_message.rb +165 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message.rb +95 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message_user.rb +80 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message_v_1.rb +75 -0
- data/lib/trycourier/bulk/types/inbound_bulk_message_v_2.rb +50 -0
- data/lib/trycourier/bulk/types/inbound_bulk_template_message.rb +157 -0
- data/lib/trycourier/bulk/types/job_details.rb +81 -0
- data/lib/trycourier/commons/types/already_exists.rb +52 -0
- data/lib/trycourier/commons/types/bad_request.rb +52 -0
- data/lib/trycourier/commons/types/base_error.rb +47 -0
- data/lib/trycourier/commons/types/channel_classification.rb +14 -0
- data/lib/trycourier/commons/types/channel_preference.rb +48 -0
- data/lib/trycourier/commons/types/conflict.rb +52 -0
- data/lib/trycourier/commons/types/email.rb +52 -0
- data/lib/trycourier/commons/types/message_not_found.rb +52 -0
- data/lib/trycourier/commons/types/not_found.rb +52 -0
- data/lib/trycourier/commons/types/notification_preference_details.rb +66 -0
- data/lib/trycourier/commons/types/notification_preferences.rb +7 -0
- data/lib/trycourier/commons/types/paging.rb +52 -0
- data/lib/trycourier/commons/types/payment_required.rb +52 -0
- data/lib/trycourier/commons/types/preference_status.rb +11 -0
- data/lib/trycourier/commons/types/recipient_preferences.rb +53 -0
- data/lib/trycourier/commons/types/rule.rb +52 -0
- data/lib/trycourier/commons/types/user_tenant_association.rb +62 -0
- data/lib/trycourier/lists/client.rb +454 -0
- data/lib/trycourier/lists/types/list.rb +62 -0
- data/lib/trycourier/lists/types/list_get_all_response.rb +62 -0
- data/lib/trycourier/lists/types/list_get_subscriptions_response.rb +62 -0
- data/lib/trycourier/lists/types/list_put_params.rb +58 -0
- data/lib/trycourier/lists/types/list_subscription_recipient.rb +63 -0
- data/lib/trycourier/lists/types/put_subscriptions_recipient.rb +58 -0
- data/lib/trycourier/messages/client.rb +300 -0
- data/lib/trycourier/messages/types/list_messages_response.rb +62 -0
- data/lib/trycourier/messages/types/message_details.rb +120 -0
- data/lib/trycourier/messages/types/message_history_response.rb +51 -0
- data/lib/trycourier/messages/types/message_status.rb +17 -0
- data/lib/trycourier/messages/types/reason.rb +14 -0
- data/lib/trycourier/messages/types/render_output.rb +63 -0
- data/lib/trycourier/messages/types/render_output_response.rb +51 -0
- data/lib/trycourier/messages/types/rendered_message_block.rb +52 -0
- data/lib/trycourier/messages/types/rendered_message_content.rb +77 -0
- data/lib/trycourier/notifications/client.rb +379 -0
- data/lib/trycourier/notifications/types/base_check.rb +58 -0
- data/lib/trycourier/notifications/types/block_type.rb +17 -0
- data/lib/trycourier/notifications/types/check.rb +63 -0
- data/lib/trycourier/notifications/types/check_status.rb +11 -0
- data/lib/trycourier/notifications/types/message_routing.rb +57 -0
- data/lib/trycourier/notifications/types/message_routing_channel.rb +49 -0
- data/lib/trycourier/notifications/types/message_routing_method.rb +10 -0
- data/lib/trycourier/notifications/types/notification.rb +63 -0
- data/lib/trycourier/notifications/types/notification_block.rb +94 -0
- data/lib/trycourier/notifications/types/notification_channel.rb +73 -0
- data/lib/trycourier/notifications/types/notification_channel_content.rb +52 -0
- data/lib/trycourier/notifications/types/notification_content.rb +49 -0
- data/lib/trycourier/notifications/types/notification_content_hierarchy.rb +52 -0
- data/lib/trycourier/notifications/types/notification_get_content_response.rb +65 -0
- data/lib/trycourier/notifications/types/notification_list_response.rb +62 -0
- data/lib/trycourier/notifications/types/submission_checks_get_response.rb +51 -0
- data/lib/trycourier/notifications/types/submission_checks_replace_response.rb +51 -0
- data/lib/trycourier/profiles/client.rb +325 -0
- data/lib/trycourier/profiles/types/address.rb +81 -0
- data/lib/trycourier/profiles/types/airship_profile.rb +59 -0
- data/lib/trycourier/profiles/types/airship_profile_audience.rb +47 -0
- data/lib/trycourier/profiles/types/delete_list_subscription_response.rb +47 -0
- data/lib/trycourier/profiles/types/device_type.rb +7 -0
- data/lib/trycourier/profiles/types/discord.rb +50 -0
- data/lib/trycourier/profiles/types/expo.rb +50 -0
- data/lib/trycourier/profiles/types/get_list_subscriptions_list.rb +74 -0
- data/lib/trycourier/profiles/types/get_list_subscriptions_response.rb +62 -0
- data/lib/trycourier/profiles/types/intercom.rb +58 -0
- data/lib/trycourier/profiles/types/intercom_recipient.rb +47 -0
- data/lib/trycourier/profiles/types/merge_profile_response.rb +47 -0
- data/lib/trycourier/profiles/types/ms_teams.rb +86 -0
- data/lib/trycourier/profiles/types/ms_teams_base_properties.rb +52 -0
- data/lib/trycourier/profiles/types/multiple_tokens.rb +51 -0
- data/lib/trycourier/profiles/types/profile_get_parameters.rb +47 -0
- data/lib/trycourier/profiles/types/profile_get_response.rb +58 -0
- data/lib/trycourier/profiles/types/replace_profile_response.rb +47 -0
- data/lib/trycourier/profiles/types/send_direct_message.rb +47 -0
- data/lib/trycourier/profiles/types/send_to_channel.rb +47 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_channel_id.rb +57 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb +68 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_conversation_id.rb +58 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_email.rb +57 -0
- data/lib/trycourier/profiles/types/send_to_ms_teams_user_id.rb +57 -0
- data/lib/trycourier/profiles/types/send_to_slack_channel.rb +52 -0
- data/lib/trycourier/profiles/types/send_to_slack_email.rb +52 -0
- data/lib/trycourier/profiles/types/send_to_slack_user_id.rb +52 -0
- data/lib/trycourier/profiles/types/slack.rb +62 -0
- data/lib/trycourier/profiles/types/slack_base_properties.rb +47 -0
- data/lib/trycourier/profiles/types/snooze_rule.rb +58 -0
- data/lib/trycourier/profiles/types/snooze_rule_type.rb +9 -0
- data/lib/trycourier/profiles/types/subscribe_to_lists_request.rb +51 -0
- data/lib/trycourier/profiles/types/subscribe_to_lists_request_list_object.rb +58 -0
- data/lib/trycourier/profiles/types/subscribe_to_lists_response.rb +47 -0
- data/lib/trycourier/profiles/types/token.rb +47 -0
- data/lib/trycourier/profiles/types/user_profile.rb +274 -0
- data/lib/trycourier/send/types/attachment.rb +7 -0
- data/lib/trycourier/send/types/audience_filter.rb +57 -0
- data/lib/trycourier/send/types/audience_recipient.rb +62 -0
- data/lib/trycourier/send/types/base_message.rb +149 -0
- data/lib/trycourier/send/types/base_social_presence.rb +47 -0
- data/lib/trycourier/send/types/brand_settings_email.rb +87 -0
- data/lib/trycourier/send/types/brand_settings_in_app.rb +119 -0
- data/lib/trycourier/send/types/brand_settings_social_presence.rb +107 -0
- data/lib/trycourier/send/types/brand_template.rb +88 -0
- data/lib/trycourier/send/types/brand_template_override.rb +112 -0
- data/lib/trycourier/send/types/channel.rb +113 -0
- data/lib/trycourier/send/types/channel_metadata.rb +53 -0
- data/lib/trycourier/send/types/channel_source.rb +11 -0
- data/lib/trycourier/send/types/content.rb +50 -0
- data/lib/trycourier/send/types/content_message.rb +177 -0
- data/lib/trycourier/send/types/criteria.rb +12 -0
- data/lib/trycourier/send/types/delay.rb +47 -0
- data/lib/trycourier/send/types/elemental_action_node.rb +116 -0
- data/lib/trycourier/send/types/elemental_base_node.rb +62 -0
- data/lib/trycourier/send/types/elemental_channel_node.rb +105 -0
- data/lib/trycourier/send/types/elemental_content.rb +61 -0
- data/lib/trycourier/send/types/elemental_content_sugar.rb +53 -0
- data/lib/trycourier/send/types/elemental_divider_node.rb +68 -0
- data/lib/trycourier/send/types/elemental_group_node.rb +72 -0
- data/lib/trycourier/send/types/elemental_image_node.rb +101 -0
- data/lib/trycourier/send/types/elemental_meta_node.rb +70 -0
- data/lib/trycourier/send/types/elemental_node.rb +170 -0
- data/lib/trycourier/send/types/elemental_quote_node.rb +104 -0
- data/lib/trycourier/send/types/elemental_text_node.rb +136 -0
- data/lib/trycourier/send/types/email_footer.rb +52 -0
- data/lib/trycourier/send/types/email_head.rb +52 -0
- data/lib/trycourier/send/types/email_header.rb +63 -0
- data/lib/trycourier/send/types/expires_in_type.rb +48 -0
- data/lib/trycourier/send/types/expiry.rb +58 -0
- data/lib/trycourier/send/types/i_action_button_style.rb +10 -0
- data/lib/trycourier/send/types/i_alignment.rb +12 -0
- data/lib/trycourier/send/types/i_preferences.rb +7 -0
- data/lib/trycourier/send/types/i_profile_preferences.rb +59 -0
- data/lib/trycourier/send/types/icons.rb +52 -0
- data/lib/trycourier/send/types/in_app_placement.rb +12 -0
- data/lib/trycourier/send/types/invalid_list_pattern_recipient.rb +52 -0
- data/lib/trycourier/send/types/invalid_list_recipient.rb +52 -0
- data/lib/trycourier/send/types/invalid_user_recipient.rb +52 -0
- data/lib/trycourier/send/types/list_filter.rb +57 -0
- data/lib/trycourier/send/types/list_pattern_recipient.rb +53 -0
- data/lib/trycourier/send/types/list_pattern_recipient_type.rb +41 -0
- data/lib/trycourier/send/types/list_recipient.rb +62 -0
- data/lib/trycourier/send/types/list_recipient_type.rb +41 -0
- data/lib/trycourier/send/types/locale.rb +47 -0
- data/lib/trycourier/send/types/locales.rb +7 -0
- data/lib/trycourier/send/types/logo.rb +52 -0
- data/lib/trycourier/send/types/message.rb +50 -0
- data/lib/trycourier/send/types/message_channel_email_override.rb +119 -0
- data/lib/trycourier/send/types/message_channels.rb +7 -0
- data/lib/trycourier/send/types/message_context.rb +49 -0
- data/lib/trycourier/send/types/message_data.rb +7 -0
- data/lib/trycourier/send/types/message_metadata.rb +68 -0
- data/lib/trycourier/send/types/message_providers.rb +7 -0
- data/lib/trycourier/send/types/message_providers_type.rb +72 -0
- data/lib/trycourier/send/types/message_recipient.rb +54 -0
- data/lib/trycourier/send/types/metadata.rb +53 -0
- data/lib/trycourier/send/types/ms_teams_recipient.rb +53 -0
- data/lib/trycourier/send/types/override.rb +10 -0
- data/lib/trycourier/send/types/preference.rb +73 -0
- data/lib/trycourier/send/types/preferences.rb +47 -0
- data/lib/trycourier/send/types/recipient.rb +98 -0
- data/lib/trycourier/send/types/routing.rb +64 -0
- data/lib/trycourier/send/types/routing_channel.rb +61 -0
- data/lib/trycourier/send/types/routing_method.rb +10 -0
- data/lib/trycourier/send/types/routing_strategy_channel.rb +70 -0
- data/lib/trycourier/send/types/routing_strategy_provider.rb +68 -0
- data/lib/trycourier/send/types/rule_type.rb +11 -0
- data/lib/trycourier/send/types/slack_recipient.rb +53 -0
- data/lib/trycourier/send/types/template_message.rb +169 -0
- data/lib/trycourier/send/types/text_align.rb +11 -0
- data/lib/trycourier/send/types/text_style.rb +12 -0
- data/lib/trycourier/send/types/timeout.rb +76 -0
- data/lib/trycourier/send/types/timeouts.rb +52 -0
- data/lib/trycourier/send/types/tracking_override.rb +47 -0
- data/lib/trycourier/send/types/user_recipient.rb +115 -0
- data/lib/trycourier/send/types/user_recipient_type.rb +41 -0
- data/lib/trycourier/send/types/utm.rb +68 -0
- data/lib/trycourier/send/types/widget_background.rb +52 -0
- data/lib/trycourier/templates/client.rb +67 -0
- data/lib/trycourier/templates/types/channel_identifier.rb +7 -0
- data/lib/trycourier/templates/types/list_templates_response.rb +62 -0
- data/lib/trycourier/templates/types/notification_templates.rb +90 -0
- data/lib/trycourier/templates/types/routing_strategy.rb +54 -0
- data/lib/trycourier/templates/types/routing_strategy_method.rb +10 -0
- data/lib/trycourier/templates/types/tag.rb +51 -0
- data/lib/trycourier/templates/types/tag_data.rb +52 -0
- data/lib/trycourier/tenants/client.rb +255 -0
- data/lib/trycourier/tenants/types/default_preferences.rb +51 -0
- data/lib/trycourier/tenants/types/list_users_for_tenant_response.rb +88 -0
- data/lib/trycourier/tenants/types/subscription_topic.rb +53 -0
- data/lib/trycourier/tenants/types/subscription_topic_status.rb +11 -0
- data/lib/trycourier/tenants/types/template_property.rb +7 -0
- data/lib/trycourier/tenants/types/tenant.rb +95 -0
- data/lib/trycourier/tenants/types/tenant_list_response.rb +86 -0
- data/lib/trycourier/translations/client.rb +106 -0
- data/lib/trycourier/types/send_message_response.rb +49 -0
- data/lib/trycourier/users/client.rb +34 -0
- data/lib/trycourier/users/preferences/client.rb +171 -0
- data/lib/trycourier/users/preferences/types/topic_preference.rb +86 -0
- data/lib/trycourier/users/preferences/types/user_preferences_get_response.rb +55 -0
- data/lib/trycourier/users/preferences/types/user_preferences_list_response.rb +64 -0
- data/lib/trycourier/users/preferences/types/user_preferences_update_response.rb +49 -0
- data/lib/trycourier/users/tenants/client.rb +267 -0
- data/lib/trycourier/users/tenants/types/add_user_to_single_tenants_params_profile.rb +76 -0
- data/lib/trycourier/users/tenants/types/list_tenants_for_user_response.rb +90 -0
- data/lib/trycourier/users/tokens/client.rb +264 -0
- data/lib/trycourier/users/tokens/types/delete_user_token_opts.rb +54 -0
- data/lib/trycourier/users/tokens/types/device.rb +83 -0
- data/lib/trycourier/users/tokens/types/expiry_date.rb +50 -0
- data/lib/trycourier/users/tokens/types/get_all_tokens_response.rb +11 -0
- data/lib/trycourier/users/tokens/types/get_user_token_opts.rb +54 -0
- data/lib/trycourier/users/tokens/types/get_user_token_response.rb +116 -0
- data/lib/trycourier/users/tokens/types/get_user_tokens_opts.rb +49 -0
- data/lib/trycourier/users/tokens/types/patch_op.rb +16 -0
- data/lib/trycourier/users/tokens/types/patch_operation.rb +59 -0
- data/lib/trycourier/users/tokens/types/patch_user_token_opts.rb +53 -0
- data/lib/trycourier/users/tokens/types/provider_key.rb +14 -0
- data/lib/trycourier/users/tokens/types/put_user_token_opts.rb +60 -0
- data/lib/trycourier/users/tokens/types/put_user_tokens_opts.rb +58 -0
- data/lib/trycourier/users/tokens/types/token_status.rb +14 -0
- data/lib/trycourier/users/tokens/types/tracking.rb +64 -0
- data/lib/trycourier/users/tokens/types/user_token.rb +102 -0
- data/lib/trycourier.rb +114 -138
- data/lib/types_export.rb +273 -0
- metadata +362 -50
- data/.github/ISSUE_TEMPLATE.md +0 -17
- data/.github/PULL_REQUEST_TEMPLATE.md +0 -27
- data/.github/workflows/gem-push.yml +0 -51
- data/.gitignore +0 -67
- data/.rspec +0 -3
- data/CHANGELOG.md +0 -126
- data/CONTRIBUTING.md +0 -28
- data/Gemfile +0 -8
- data/Gemfile.lock +0 -72
- data/LICENSE +0 -21
- data/README.md +0 -610
- data/Rakefile +0 -7
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/lib/trycourier/accounts.rb +0 -43
- data/lib/trycourier/audiences.rb +0 -45
- data/lib/trycourier/audit_events.rb +0 -27
- data/lib/trycourier/auth_tokens.rb +0 -23
- data/lib/trycourier/automations.rb +0 -67
- data/lib/trycourier/brands.rb +0 -70
- data/lib/trycourier/bulk.rb +0 -79
- data/lib/trycourier/events.rb +0 -35
- data/lib/trycourier/exceptions.rb +0 -39
- data/lib/trycourier/lists.rb +0 -109
- data/lib/trycourier/messages.rb +0 -57
- data/lib/trycourier/profiles.rb +0 -64
- data/lib/trycourier/session.rb +0 -80
- data/lib/trycourier/version.rb +0 -3
- data/trycourier.gemspec +0 -32
@@ -0,0 +1,62 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "audience_member"
|
4
|
+
require_relative "../../commons/types/paging"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module Courier
|
8
|
+
class Audiences
|
9
|
+
class AudienceMemberListResponse
|
10
|
+
attr_reader :items, :paging, :additional_properties
|
11
|
+
|
12
|
+
# @param items [Array<Audiences::AudienceMember>]
|
13
|
+
# @param paging [Commons::Paging]
|
14
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
15
|
+
# @return [Audiences::AudienceMemberListResponse]
|
16
|
+
def initialize(items:, paging:, additional_properties: nil)
|
17
|
+
# @type [Array<Audiences::AudienceMember>]
|
18
|
+
@items = items
|
19
|
+
# @type [Commons::Paging]
|
20
|
+
@paging = paging
|
21
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
22
|
+
@additional_properties = additional_properties
|
23
|
+
end
|
24
|
+
|
25
|
+
# Deserialize a JSON object to an instance of AudienceMemberListResponse
|
26
|
+
#
|
27
|
+
# @param json_object [JSON]
|
28
|
+
# @return [Audiences::AudienceMemberListResponse]
|
29
|
+
def self.from_json(json_object:)
|
30
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
31
|
+
parsed_json = JSON.parse(json_object)
|
32
|
+
items = parsed_json["items"]&.map do |v|
|
33
|
+
v = v.to_json
|
34
|
+
Audiences::AudienceMember.from_json(json_object: v)
|
35
|
+
end
|
36
|
+
if parsed_json["paging"].nil?
|
37
|
+
paging = nil
|
38
|
+
else
|
39
|
+
paging = parsed_json["paging"].to_json
|
40
|
+
paging = Commons::Paging.from_json(json_object: paging)
|
41
|
+
end
|
42
|
+
new(items: items, paging: paging, additional_properties: struct)
|
43
|
+
end
|
44
|
+
|
45
|
+
# Serialize an instance of AudienceMemberListResponse to a JSON object
|
46
|
+
#
|
47
|
+
# @return [JSON]
|
48
|
+
def to_json(*_args)
|
49
|
+
{ "items": @items, "paging": @paging }.to_json
|
50
|
+
end
|
51
|
+
|
52
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
53
|
+
#
|
54
|
+
# @param obj [Object]
|
55
|
+
# @return [Void]
|
56
|
+
def self.validate_raw(obj:)
|
57
|
+
obj.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
|
58
|
+
Commons::Paging.validate_raw(obj: obj.paging)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "audience"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Courier
|
7
|
+
class Audiences
|
8
|
+
class AudienceUpdateResponse
|
9
|
+
attr_reader :audience, :additional_properties
|
10
|
+
|
11
|
+
# @param audience [Audiences::Audience]
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [Audiences::AudienceUpdateResponse]
|
14
|
+
def initialize(audience:, additional_properties: nil)
|
15
|
+
# @type [Audiences::Audience]
|
16
|
+
@audience = audience
|
17
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
18
|
+
@additional_properties = additional_properties
|
19
|
+
end
|
20
|
+
|
21
|
+
# Deserialize a JSON object to an instance of AudienceUpdateResponse
|
22
|
+
#
|
23
|
+
# @param json_object [JSON]
|
24
|
+
# @return [Audiences::AudienceUpdateResponse]
|
25
|
+
def self.from_json(json_object:)
|
26
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
27
|
+
parsed_json = JSON.parse(json_object)
|
28
|
+
if parsed_json["audience"].nil?
|
29
|
+
audience = nil
|
30
|
+
else
|
31
|
+
audience = parsed_json["audience"].to_json
|
32
|
+
audience = Audiences::Audience.from_json(json_object: audience)
|
33
|
+
end
|
34
|
+
new(audience: audience, additional_properties: struct)
|
35
|
+
end
|
36
|
+
|
37
|
+
# Serialize an instance of AudienceUpdateResponse to a JSON object
|
38
|
+
#
|
39
|
+
# @return [JSON]
|
40
|
+
def to_json(*_args)
|
41
|
+
{ "audience": @audience }.to_json
|
42
|
+
end
|
43
|
+
|
44
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
45
|
+
#
|
46
|
+
# @param obj [Object]
|
47
|
+
# @return [Void]
|
48
|
+
def self.validate_raw(obj:)
|
49
|
+
Audiences::Audience.validate_raw(obj: obj.audience)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "operator"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Courier
|
7
|
+
class Audiences
|
8
|
+
class BaseFilterConfig
|
9
|
+
attr_reader :operator, :additional_properties
|
10
|
+
|
11
|
+
# @param operator [Audiences::Operator] The operator to use for filtering
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [Audiences::BaseFilterConfig]
|
14
|
+
def initialize(operator:, additional_properties: nil)
|
15
|
+
# @type [Audiences::Operator] The operator to use for filtering
|
16
|
+
@operator = operator
|
17
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
18
|
+
@additional_properties = additional_properties
|
19
|
+
end
|
20
|
+
|
21
|
+
# Deserialize a JSON object to an instance of BaseFilterConfig
|
22
|
+
#
|
23
|
+
# @param json_object [JSON]
|
24
|
+
# @return [Audiences::BaseFilterConfig]
|
25
|
+
def self.from_json(json_object:)
|
26
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
27
|
+
parsed_json = JSON.parse(json_object)
|
28
|
+
if parsed_json["operator"].nil?
|
29
|
+
operator = nil
|
30
|
+
else
|
31
|
+
operator = parsed_json["operator"].to_json
|
32
|
+
operator = Audiences::Operator.from_json(json_object: operator)
|
33
|
+
end
|
34
|
+
new(operator: operator, additional_properties: struct)
|
35
|
+
end
|
36
|
+
|
37
|
+
# Serialize an instance of BaseFilterConfig to a JSON object
|
38
|
+
#
|
39
|
+
# @return [JSON]
|
40
|
+
def to_json(*_args)
|
41
|
+
{ "operator": @operator }.to_json
|
42
|
+
end
|
43
|
+
|
44
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
45
|
+
#
|
46
|
+
# @param obj [Object]
|
47
|
+
# @return [Void]
|
48
|
+
def self.validate_raw(obj:)
|
49
|
+
Audiences::Operator.validate_raw(obj: obj.operator)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Courier
|
4
|
+
class Audiences
|
5
|
+
class ComparisonOperator
|
6
|
+
ENDS_WITH = "ENDS_WITH"
|
7
|
+
EQ = "EQ"
|
8
|
+
EXISTS = "EXISTS"
|
9
|
+
GT = "GT"
|
10
|
+
GTE = "GTE"
|
11
|
+
INCLUDES = "INCLUDES"
|
12
|
+
IS_AFTER = "IS_AFTER"
|
13
|
+
IS_BEFORE = "IS_BEFORE"
|
14
|
+
LT = "LT"
|
15
|
+
LTE = "LTE"
|
16
|
+
NEQ = "NEQ"
|
17
|
+
OMIT = "OMIT"
|
18
|
+
STARTS_WITH = "STARTS_WITH"
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
require_relative "single_filter_config"
|
5
|
+
require_relative "nested_filter_config"
|
6
|
+
|
7
|
+
module Courier
|
8
|
+
class Audiences
|
9
|
+
class Filter
|
10
|
+
# Deserialize a JSON object to an instance of Filter
|
11
|
+
#
|
12
|
+
# @param json_object [JSON]
|
13
|
+
# @return [Audiences::Filter]
|
14
|
+
def self.from_json(json_object:)
|
15
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
16
|
+
begin
|
17
|
+
Audiences::SingleFilterConfig.validate_raw(obj: struct)
|
18
|
+
return Audiences::SingleFilterConfig.from_json(json_object: json_object)
|
19
|
+
rescue StandardError
|
20
|
+
# noop
|
21
|
+
end
|
22
|
+
begin
|
23
|
+
Audiences::NestedFilterConfig.validate_raw(obj: struct)
|
24
|
+
return Audiences::NestedFilterConfig.from_json(json_object: json_object)
|
25
|
+
rescue StandardError
|
26
|
+
# noop
|
27
|
+
end
|
28
|
+
struct
|
29
|
+
end
|
30
|
+
|
31
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
32
|
+
#
|
33
|
+
# @param obj [Object]
|
34
|
+
# @return [Void]
|
35
|
+
def self.validate_raw(obj:)
|
36
|
+
begin
|
37
|
+
return Audiences::SingleFilterConfig.validate_raw(obj: obj)
|
38
|
+
rescue StandardError
|
39
|
+
# noop
|
40
|
+
end
|
41
|
+
begin
|
42
|
+
return Audiences::NestedFilterConfig.validate_raw(obj: obj)
|
43
|
+
rescue StandardError
|
44
|
+
# noop
|
45
|
+
end
|
46
|
+
raise("Passed value matched no type within the union, validation failed.")
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
require_relative "single_filter_config"
|
5
|
+
require_relative "nested_filter_config"
|
6
|
+
|
7
|
+
module Courier
|
8
|
+
class Audiences
|
9
|
+
class FilterConfig
|
10
|
+
# Deserialize a JSON object to an instance of FilterConfig
|
11
|
+
#
|
12
|
+
# @param json_object [JSON]
|
13
|
+
# @return [Audiences::FilterConfig]
|
14
|
+
def self.from_json(json_object:)
|
15
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
16
|
+
begin
|
17
|
+
Audiences::SingleFilterConfig.validate_raw(obj: struct)
|
18
|
+
return Audiences::SingleFilterConfig.from_json(json_object: json_object)
|
19
|
+
rescue StandardError
|
20
|
+
# noop
|
21
|
+
end
|
22
|
+
begin
|
23
|
+
Audiences::NestedFilterConfig.validate_raw(obj: struct)
|
24
|
+
return Audiences::NestedFilterConfig.from_json(json_object: json_object)
|
25
|
+
rescue StandardError
|
26
|
+
# noop
|
27
|
+
end
|
28
|
+
struct
|
29
|
+
end
|
30
|
+
|
31
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
32
|
+
#
|
33
|
+
# @param obj [Object]
|
34
|
+
# @return [Void]
|
35
|
+
def self.validate_raw(obj:)
|
36
|
+
begin
|
37
|
+
return Audiences::SingleFilterConfig.validate_raw(obj: obj)
|
38
|
+
rescue StandardError
|
39
|
+
# noop
|
40
|
+
end
|
41
|
+
begin
|
42
|
+
return Audiences::NestedFilterConfig.validate_raw(obj: obj)
|
43
|
+
rescue StandardError
|
44
|
+
# noop
|
45
|
+
end
|
46
|
+
raise("Passed value matched no type within the union, validation failed.")
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "filter_config"
|
4
|
+
require_relative "operator"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module Courier
|
8
|
+
class Audiences
|
9
|
+
# The operator to use for filtering
|
10
|
+
class NestedFilterConfig
|
11
|
+
attr_reader :rules, :operator, :additional_properties
|
12
|
+
|
13
|
+
# @param rules [Array<Audiences::FilterConfig>]
|
14
|
+
# @param operator [Audiences::Operator] The operator to use for filtering
|
15
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
16
|
+
# @return [Audiences::NestedFilterConfig]
|
17
|
+
def initialize(rules:, operator:, additional_properties: nil)
|
18
|
+
# @type [Array<Audiences::FilterConfig>]
|
19
|
+
@rules = rules
|
20
|
+
# @type [Audiences::Operator] The operator to use for filtering
|
21
|
+
@operator = operator
|
22
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
23
|
+
@additional_properties = additional_properties
|
24
|
+
end
|
25
|
+
|
26
|
+
# Deserialize a JSON object to an instance of NestedFilterConfig
|
27
|
+
#
|
28
|
+
# @param json_object [JSON]
|
29
|
+
# @return [Audiences::NestedFilterConfig]
|
30
|
+
def self.from_json(json_object:)
|
31
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
32
|
+
parsed_json = JSON.parse(json_object)
|
33
|
+
rules = parsed_json["rules"]&.map do |v|
|
34
|
+
v = v.to_json
|
35
|
+
Audiences::FilterConfig.from_json(json_object: v)
|
36
|
+
end
|
37
|
+
if parsed_json["operator"].nil?
|
38
|
+
operator = nil
|
39
|
+
else
|
40
|
+
operator = parsed_json["operator"].to_json
|
41
|
+
operator = Audiences::Operator.from_json(json_object: operator)
|
42
|
+
end
|
43
|
+
new(rules: rules, operator: operator, additional_properties: struct)
|
44
|
+
end
|
45
|
+
|
46
|
+
# Serialize an instance of NestedFilterConfig to a JSON object
|
47
|
+
#
|
48
|
+
# @return [JSON]
|
49
|
+
def to_json(*_args)
|
50
|
+
{ "rules": @rules, "operator": @operator }.to_json
|
51
|
+
end
|
52
|
+
|
53
|
+
# 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.
|
54
|
+
#
|
55
|
+
# @param obj [Object]
|
56
|
+
# @return [Void]
|
57
|
+
def self.validate_raw(obj:)
|
58
|
+
obj.rules.is_a?(Array) != false || raise("Passed value for field obj.rules is not the expected type, validation failed.")
|
59
|
+
Audiences::Operator.validate_raw(obj: obj.operator)
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class Audiences
|
7
|
+
class Operator
|
8
|
+
# Deserialize a JSON object to an instance of Operator
|
9
|
+
#
|
10
|
+
# @param json_object [JSON]
|
11
|
+
# @return [Audiences::Operator]
|
12
|
+
def self.from_json(json_object:)
|
13
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
14
|
+
begin
|
15
|
+
struct.is_a?(Audiences::ComparisonOperator) != false || raise("Passed value for field struct is not the expected type, validation failed.")
|
16
|
+
return json_object
|
17
|
+
rescue StandardError
|
18
|
+
# noop
|
19
|
+
end
|
20
|
+
begin
|
21
|
+
struct.is_a?(Audiences::LogicalOperator) != false || raise("Passed value for field struct is not the expected type, validation failed.")
|
22
|
+
return json_object
|
23
|
+
rescue StandardError
|
24
|
+
# noop
|
25
|
+
end
|
26
|
+
struct
|
27
|
+
end
|
28
|
+
|
29
|
+
# 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.
|
30
|
+
#
|
31
|
+
# @param obj [Object]
|
32
|
+
# @return [Void]
|
33
|
+
def self.validate_raw(obj:)
|
34
|
+
begin
|
35
|
+
return obj.is_a?(Audiences::ComparisonOperator) != false || raise("Passed value for field obj is not the expected type, validation failed.")
|
36
|
+
rescue StandardError
|
37
|
+
# noop
|
38
|
+
end
|
39
|
+
begin
|
40
|
+
return obj.is_a?(Audiences::LogicalOperator) != false || raise("Passed value for field obj is not the expected type, validation failed.")
|
41
|
+
rescue StandardError
|
42
|
+
# noop
|
43
|
+
end
|
44
|
+
raise("Passed value matched no type within the union, validation failed.")
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "operator"
|
4
|
+
require "json"
|
5
|
+
|
6
|
+
module Courier
|
7
|
+
class Audiences
|
8
|
+
# A single filter to use for filtering
|
9
|
+
class SingleFilterConfig
|
10
|
+
attr_reader :value, :path, :operator, :additional_properties
|
11
|
+
|
12
|
+
# @param value [String] The value to use for filtering
|
13
|
+
# @param path [String] The attribe name from profile whose value will be operated against the filter value
|
14
|
+
# @param operator [Audiences::Operator] The operator to use for filtering
|
15
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
16
|
+
# @return [Audiences::SingleFilterConfig]
|
17
|
+
def initialize(value:, path:, operator:, additional_properties: nil)
|
18
|
+
# @type [String] The value to use for filtering
|
19
|
+
@value = value
|
20
|
+
# @type [String] The attribe name from profile whose value will be operated against the filter value
|
21
|
+
@path = path
|
22
|
+
# @type [Audiences::Operator] The operator to use for filtering
|
23
|
+
@operator = operator
|
24
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
25
|
+
@additional_properties = additional_properties
|
26
|
+
end
|
27
|
+
|
28
|
+
# Deserialize a JSON object to an instance of SingleFilterConfig
|
29
|
+
#
|
30
|
+
# @param json_object [JSON]
|
31
|
+
# @return [Audiences::SingleFilterConfig]
|
32
|
+
def self.from_json(json_object:)
|
33
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
34
|
+
parsed_json = JSON.parse(json_object)
|
35
|
+
value = struct.value
|
36
|
+
path = struct.path
|
37
|
+
if parsed_json["operator"].nil?
|
38
|
+
operator = nil
|
39
|
+
else
|
40
|
+
operator = parsed_json["operator"].to_json
|
41
|
+
operator = Audiences::Operator.from_json(json_object: operator)
|
42
|
+
end
|
43
|
+
new(value: value, path: path, operator: operator, additional_properties: struct)
|
44
|
+
end
|
45
|
+
|
46
|
+
# Serialize an instance of SingleFilterConfig to a JSON object
|
47
|
+
#
|
48
|
+
# @return [JSON]
|
49
|
+
def to_json(*_args)
|
50
|
+
{ "value": @value, "path": @path, "operator": @operator }.to_json
|
51
|
+
end
|
52
|
+
|
53
|
+
# 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.
|
54
|
+
#
|
55
|
+
# @param obj [Object]
|
56
|
+
# @return [Void]
|
57
|
+
def self.validate_raw(obj:)
|
58
|
+
obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
|
59
|
+
obj.path.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
|
60
|
+
Audiences::Operator.validate_raw(obj: obj.operator)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,104 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../../requests"
|
4
|
+
require_relative "types/list_audit_events_response"
|
5
|
+
require_relative "types/audit_event"
|
6
|
+
require "async"
|
7
|
+
|
8
|
+
module Courier
|
9
|
+
class AuditEventsClient
|
10
|
+
attr_reader :request_client
|
11
|
+
|
12
|
+
# @param request_client [RequestClient]
|
13
|
+
# @return [AuditEventsClient]
|
14
|
+
def initialize(request_client:)
|
15
|
+
# @type [RequestClient]
|
16
|
+
@request_client = request_client
|
17
|
+
end
|
18
|
+
|
19
|
+
# Fetch the list of audit events
|
20
|
+
#
|
21
|
+
# @param cursor [String] A unique identifier that allows for fetching the next set of audit events.
|
22
|
+
# @param request_options [RequestOptions]
|
23
|
+
# @return [AuditEvents::ListAuditEventsResponse]
|
24
|
+
def list(cursor: nil, request_options: nil)
|
25
|
+
response = @request_client.conn.get("/audit-events") do |req|
|
26
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
27
|
+
unless request_options&.authorization_token.nil?
|
28
|
+
req.headers["Authorization"] =
|
29
|
+
request_options.authorization_token
|
30
|
+
end
|
31
|
+
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
32
|
+
req.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
|
33
|
+
end
|
34
|
+
AuditEvents::ListAuditEventsResponse.from_json(json_object: response.body)
|
35
|
+
end
|
36
|
+
|
37
|
+
# Fetch a specific audit event by ID.
|
38
|
+
#
|
39
|
+
# @param audit_event_id [String] A unique identifier associated with the audit event you wish to retrieve
|
40
|
+
# @param request_options [RequestOptions]
|
41
|
+
# @return [AuditEvents::AuditEvent]
|
42
|
+
def get(audit_event_id:, request_options: nil)
|
43
|
+
response = @request_client.conn.get("/audit-events/#{audit_event_id}") do |req|
|
44
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
45
|
+
unless request_options&.authorization_token.nil?
|
46
|
+
req.headers["Authorization"] =
|
47
|
+
request_options.authorization_token
|
48
|
+
end
|
49
|
+
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
50
|
+
end
|
51
|
+
AuditEvents::AuditEvent.from_json(json_object: response.body)
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
class AsyncAuditEventsClient
|
56
|
+
attr_reader :request_client
|
57
|
+
|
58
|
+
# @param request_client [AsyncRequestClient]
|
59
|
+
# @return [AsyncAuditEventsClient]
|
60
|
+
def initialize(request_client:)
|
61
|
+
# @type [AsyncRequestClient]
|
62
|
+
@request_client = request_client
|
63
|
+
end
|
64
|
+
|
65
|
+
# Fetch the list of audit events
|
66
|
+
#
|
67
|
+
# @param cursor [String] A unique identifier that allows for fetching the next set of audit events.
|
68
|
+
# @param request_options [RequestOptions]
|
69
|
+
# @return [AuditEvents::ListAuditEventsResponse]
|
70
|
+
def list(cursor: nil, request_options: nil)
|
71
|
+
Async do
|
72
|
+
response = @request_client.conn.get("/audit-events") do |req|
|
73
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
74
|
+
unless request_options&.authorization_token.nil?
|
75
|
+
req.headers["Authorization"] =
|
76
|
+
request_options.authorization_token
|
77
|
+
end
|
78
|
+
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
79
|
+
req.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
|
80
|
+
end
|
81
|
+
AuditEvents::ListAuditEventsResponse.from_json(json_object: response.body)
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
# Fetch a specific audit event by ID.
|
86
|
+
#
|
87
|
+
# @param audit_event_id [String] A unique identifier associated with the audit event you wish to retrieve
|
88
|
+
# @param request_options [RequestOptions]
|
89
|
+
# @return [AuditEvents::AuditEvent]
|
90
|
+
def get(audit_event_id:, request_options: nil)
|
91
|
+
Async do
|
92
|
+
response = @request_client.conn.get("/audit-events/#{audit_event_id}") do |req|
|
93
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
94
|
+
unless request_options&.authorization_token.nil?
|
95
|
+
req.headers["Authorization"] =
|
96
|
+
request_options.authorization_token
|
97
|
+
end
|
98
|
+
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
|
99
|
+
end
|
100
|
+
AuditEvents::AuditEvent.from_json(json_object: response.body)
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "json"
|
4
|
+
|
5
|
+
module Courier
|
6
|
+
class AuditEvents
|
7
|
+
class Actor
|
8
|
+
attr_reader :id, :email, :additional_properties
|
9
|
+
|
10
|
+
# @param id [String]
|
11
|
+
# @param email [String]
|
12
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
13
|
+
# @return [AuditEvents::Actor]
|
14
|
+
def initialize(id: nil, email: nil, additional_properties: nil)
|
15
|
+
# @type [String]
|
16
|
+
@id = id
|
17
|
+
# @type [String]
|
18
|
+
@email = email
|
19
|
+
# @type [OpenStruct] Additional properties unmapped to the current class definition
|
20
|
+
@additional_properties = additional_properties
|
21
|
+
end
|
22
|
+
|
23
|
+
# Deserialize a JSON object to an instance of Actor
|
24
|
+
#
|
25
|
+
# @param json_object [JSON]
|
26
|
+
# @return [AuditEvents::Actor]
|
27
|
+
def self.from_json(json_object:)
|
28
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
29
|
+
JSON.parse(json_object)
|
30
|
+
id = struct.id
|
31
|
+
email = struct.email
|
32
|
+
new(id: id, email: email, additional_properties: struct)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Serialize an instance of Actor to a JSON object
|
36
|
+
#
|
37
|
+
# @return [JSON]
|
38
|
+
def to_json(*_args)
|
39
|
+
{ "id": @id, "email": @email }.to_json
|
40
|
+
end
|
41
|
+
|
42
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
|
43
|
+
#
|
44
|
+
# @param obj [Object]
|
45
|
+
# @return [Void]
|
46
|
+
def self.validate_raw(obj:)
|
47
|
+
obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
|
48
|
+
obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|