mailslurp_client 15.19.22 → 15.20.0
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/LICENSE +1 -1
- data/README.md +1 -1
- data/lib/mailslurp_client/api/alias_controller_api.rb +10 -10
- data/lib/mailslurp_client/api/attachment_controller_api.rb +22 -6
- data/lib/mailslurp_client/api/bounce_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +5 -5
- data/lib/mailslurp_client/api/connector_controller_api.rb +1250 -122
- data/lib/mailslurp_client/api/consent_controller_api.rb +269 -0
- data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/email_controller_api.rb +471 -12
- data/lib/mailslurp_client/api/email_verification_controller_api.rb +9 -1
- data/lib/mailslurp_client/api/expired_controller_api.rb +4 -1
- data/lib/mailslurp_client/api/export_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/form_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/guest_portal_controller_api.rb +569 -0
- data/lib/mailslurp_client/api/imap_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/inbox_controller_api.rb +886 -126
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +13 -11
- data/lib/mailslurp_client/api/inbox_replier_controller_api.rb +82 -1
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/phone_controller_api.rb +675 -1
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/sms_controller_api.rb +494 -44
- data/lib/mailslurp_client/api/sse_controller_api.rb +81 -0
- data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/tools_controller_api.rb +192 -1
- data/lib/mailslurp_client/api/tracking_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/user_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/webhook_controller_api.rb +274 -12
- data/lib/mailslurp_client/api_client.rb +1 -1
- data/lib/mailslurp_client/api_error.rb +1 -1
- data/lib/mailslurp_client/configuration.rb +1 -1
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
- data/lib/mailslurp_client/models/account_bounce_block_dto.rb +16 -2
- data/lib/mailslurp_client/models/alias_dto.rb +1 -1
- data/lib/mailslurp_client/models/alias_projection.rb +20 -20
- data/lib/mailslurp_client/models/{thread_projection.rb → alias_thread_projection.rb} +42 -42
- data/lib/mailslurp_client/models/{attachment_entity.rb → attachment_entity_dto.rb} +26 -14
- data/lib/mailslurp_client/models/attachment_meta_data.rb +1 -1
- data/lib/mailslurp_client/models/attachment_projection.rb +27 -2
- data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
- data/lib/mailslurp_client/models/bounce_projection.rb +12 -12
- data/lib/mailslurp_client/models/bounce_recipient_projection.rb +1 -1
- data/lib/mailslurp_client/models/bounced_email_dto.rb +1 -1
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +1 -1
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +1 -1
- data/lib/mailslurp_client/models/can_send_email_results.rb +1 -1
- data/lib/mailslurp_client/models/check_email_body_feature_support_results.rb +1 -1
- data/lib/mailslurp_client/models/check_email_body_results.rb +1 -1
- data/lib/mailslurp_client/models/check_email_client_support_options.rb +1 -1
- data/lib/mailslurp_client/models/check_email_client_support_results.rb +1 -1
- data/lib/mailslurp_client/models/check_email_features_client_support_options.rb +1 -1
- data/lib/mailslurp_client/models/check_email_features_client_support_results.rb +1 -1
- data/lib/mailslurp_client/models/complaint.rb +1 -1
- data/lib/mailslurp_client/models/condition_option.rb +1 -1
- data/lib/mailslurp_client/models/connector_dto.rb +12 -98
- data/lib/mailslurp_client/models/connector_event_dto.rb +354 -0
- data/lib/mailslurp_client/models/{connector_sync_event_projection.rb → connector_event_projection.rb} +72 -37
- data/lib/mailslurp_client/models/connector_imap_connection_dto.rb +83 -2
- data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause.rb → connector_imap_connection_test_result.rb} +33 -19
- data/lib/mailslurp_client/models/connector_projection.rb +22 -83
- data/lib/mailslurp_client/models/connector_provider_settings_dto.rb +225 -0
- data/lib/mailslurp_client/models/connector_smtp_connection_dto.rb +96 -2
- data/lib/mailslurp_client/models/{connector_sync_request_result_exception.rb → connector_smtp_connection_test_result.rb} +29 -35
- data/lib/mailslurp_client/models/connector_sync_request_result.rb +2 -2
- data/lib/mailslurp_client/models/connector_sync_result.rb +20 -9
- data/lib/mailslurp_client/models/{connector_sync_event_dto.rb → connector_sync_settings_dto.rb} +50 -53
- data/lib/mailslurp_client/models/consent_status_dto.rb +211 -0
- data/lib/mailslurp_client/models/contact_dto.rb +1 -1
- data/lib/mailslurp_client/models/contact_projection.rb +1 -1
- data/lib/mailslurp_client/models/content_match_options.rb +1 -1
- data/lib/mailslurp_client/models/count_dto.rb +1 -1
- data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
- data/lib/mailslurp_client/models/create_connector_imap_connection_options.rb +93 -7
- data/lib/mailslurp_client/models/create_connector_options.rb +2 -69
- data/lib/mailslurp_client/models/create_connector_smtp_connection_options.rb +94 -5
- data/lib/mailslurp_client/models/create_connector_sync_settings_options.rb +265 -0
- data/lib/mailslurp_client/models/create_connector_with_options.rb +239 -0
- data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
- data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/create_emergency_address_options.rb +1 -1
- data/lib/mailslurp_client/models/create_group_options.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_replier_options.rb +2 -6
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +1 -1
- data/lib/mailslurp_client/models/create_portal_options.rb +233 -0
- data/lib/mailslurp_client/models/create_portal_user_options.rb +251 -0
- data/lib/mailslurp_client/models/create_template_options.rb +1 -1
- data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
- data/lib/mailslurp_client/models/create_webhook_options.rb +21 -8
- data/lib/mailslurp_client/models/delivery_status_dto.rb +1 -1
- data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookup_result.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookups_options.rb +1 -1
- data/lib/mailslurp_client/models/domain_dto.rb +1 -1
- data/lib/mailslurp_client/models/domain_group.rb +1 -1
- data/lib/mailslurp_client/models/domain_groups_dto.rb +1 -1
- data/lib/mailslurp_client/models/domain_information.rb +1 -1
- data/lib/mailslurp_client/models/domain_issues_dto.rb +1 -1
- data/lib/mailslurp_client/models/domain_name_record.rb +1 -1
- data/lib/mailslurp_client/models/domain_preview.rb +1 -1
- data/lib/mailslurp_client/models/download_attachment_dto.rb +1 -1
- data/lib/mailslurp_client/models/email.rb +57 -2
- data/lib/mailslurp_client/models/email_analysis.rb +1 -1
- data/lib/mailslurp_client/models/email_available_result.rb +1 -1
- data/lib/mailslurp_client/models/email_content_match_result.rb +1 -1
- data/lib/mailslurp_client/models/email_content_part_result.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_category_name.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_family_name.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_family_statistics.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_names.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_overview.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_platform_name.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_platform_statistics.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_support_flags.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_support_result.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_support_status_percentage.rb +1 -1
- data/lib/mailslurp_client/models/email_feature_version_statistics.rb +1 -1
- data/lib/mailslurp_client/models/email_html_dto.rb +1 -1
- data/lib/mailslurp_client/models/email_links_result.rb +1 -1
- data/lib/mailslurp_client/models/email_preview.rb +102 -6
- data/lib/mailslurp_client/models/email_preview_urls.rb +1 -1
- data/lib/mailslurp_client/models/email_projection.rb +123 -41
- data/lib/mailslurp_client/models/email_recipients.rb +1 -1
- data/lib/mailslurp_client/models/email_recipients_projection.rb +231 -0
- data/lib/mailslurp_client/models/email_screenshot_result.rb +1 -1
- data/lib/mailslurp_client/models/email_text_lines_result.rb +1 -1
- data/lib/mailslurp_client/models/email_thread_dto.rb +348 -0
- data/lib/mailslurp_client/models/email_thread_item.rb +429 -0
- data/lib/mailslurp_client/models/email_thread_items_dto.rb +213 -0
- data/lib/mailslurp_client/models/email_thread_projection.rb +441 -0
- data/lib/mailslurp_client/models/email_validation_request_dto.rb +1 -1
- data/lib/mailslurp_client/models/email_verification_result.rb +1 -1
- data/lib/mailslurp_client/models/emergency_address.rb +6 -1
- data/lib/mailslurp_client/models/emergency_address_dto.rb +1 -1
- data/lib/mailslurp_client/models/empty_response_dto.rb +1 -1
- data/lib/mailslurp_client/models/expiration_defaults.rb +1 -1
- data/lib/mailslurp_client/models/expired_inbox_dto.rb +1 -1
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +16 -16
- data/lib/mailslurp_client/models/export_link.rb +1 -1
- data/lib/mailslurp_client/models/export_options.rb +1 -1
- data/lib/mailslurp_client/models/fake_email_dto.rb +49 -5
- data/lib/mailslurp_client/models/fake_email_preview.rb +16 -2
- data/lib/mailslurp_client/models/fake_email_result.rb +1 -1
- data/lib/mailslurp_client/models/filter_bounced_recipients_options.rb +1 -1
- data/lib/mailslurp_client/models/filter_bounced_recipients_result.rb +1 -1
- data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +1 -1
- data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
- data/lib/mailslurp_client/models/generate_bimi_record_options.rb +1 -1
- data/lib/mailslurp_client/models/generate_bimi_record_results.rb +1 -1
- data/lib/mailslurp_client/models/generate_dmarc_record_options.rb +1 -1
- data/lib/mailslurp_client/models/generate_dmarc_record_results.rb +1 -1
- data/lib/mailslurp_client/models/generate_mta_sts_record_options.rb +1 -1
- data/lib/mailslurp_client/models/generate_mta_sts_record_results.rb +1 -1
- data/lib/mailslurp_client/models/generate_tls_reporting_record_options.rb +1 -1
- data/lib/mailslurp_client/models/generate_tls_reporting_record_results.rb +1 -1
- data/lib/mailslurp_client/models/get_email_screenshot_options.rb +1 -1
- data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
- data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
- data/lib/mailslurp_client/models/group_dto.rb +1 -1
- data/lib/mailslurp_client/models/group_projection.rb +1 -1
- data/lib/mailslurp_client/models/guest_portal_dto.rb +303 -0
- data/lib/mailslurp_client/models/guest_portal_user_create_dto.rb +225 -0
- data/lib/mailslurp_client/models/guest_portal_user_dto.rb +322 -0
- data/lib/mailslurp_client/models/guest_portal_user_projection.rb +309 -0
- data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
- data/lib/mailslurp_client/models/image_issue.rb +1 -1
- data/lib/mailslurp_client/models/imap_access_details.rb +1 -1
- data/lib/mailslurp_client/models/imap_email_projection.rb +1 -1
- data/lib/mailslurp_client/models/imap_flag_operation_options.rb +1 -1
- data/lib/mailslurp_client/models/imap_mailbox_status.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_fetch_item.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_fetch_result.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_get_result.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_list_options.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_list_result.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_mailbox_result.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_search_options.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_search_result.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_status_options.rb +1 -1
- data/lib/mailslurp_client/models/imap_server_status_result.rb +1 -1
- data/lib/mailslurp_client/models/imap_smtp_access_details.rb +17 -2
- data/lib/mailslurp_client/models/imap_smtp_access_servers.rb +1 -1
- data/lib/mailslurp_client/models/imap_update_flags_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_by_email_address_result.rb +1 -1
- data/lib/mailslurp_client/models/inbox_by_name_result.rb +1 -1
- data/lib/mailslurp_client/models/inbox_dto.rb +54 -9
- data/lib/mailslurp_client/models/inbox_exists_dto.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +2 -6
- data/lib/mailslurp_client/models/inbox_forwarder_event_dto.rb +12 -2
- data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +19 -9
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
- data/lib/mailslurp_client/models/inbox_id_item.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ids_result.rb +1 -1
- data/lib/mailslurp_client/models/inbox_preview.rb +54 -9
- data/lib/mailslurp_client/models/inbox_replier_dto.rb +2 -6
- data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +22 -22
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
- data/lib/mailslurp_client/models/inline_object.rb +2 -12
- data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
- data/lib/mailslurp_client/models/json_schema_dto.rb +1 -1
- data/lib/mailslurp_client/models/link_issue.rb +1 -1
- data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +1 -1
- data/lib/mailslurp_client/models/lookup_bimi_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/lookup_bimi_domain_results.rb +1 -1
- data/lib/mailslurp_client/models/lookup_dmarc_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/lookup_dmarc_domain_results.rb +1 -1
- data/lib/mailslurp_client/models/lookup_mta_sts_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/lookup_mta_sts_domain_results.rb +1 -1
- data/lib/mailslurp_client/models/lookup_tls_reporting_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/lookup_tls_reporting_domain_results.rb +1 -1
- data/lib/mailslurp_client/models/match_option.rb +1 -1
- data/lib/mailslurp_client/models/match_options.rb +1 -1
- data/lib/mailslurp_client/models/missed_email_dto.rb +1 -1
- data/lib/mailslurp_client/models/missed_email_projection.rb +12 -12
- data/lib/mailslurp_client/models/name_server_record.rb +1 -1
- data/lib/mailslurp_client/models/new_fake_email_address_result.rb +1 -1
- data/lib/mailslurp_client/models/opt_in_consent_options.rb +229 -0
- data/lib/mailslurp_client/models/opt_in_consent_send_result.rb +211 -0
- data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause_stack_trace.rb → opt_in_identity_projection.rb} +54 -61
- data/lib/mailslurp_client/models/opt_in_sending_consent_dto.rb +239 -0
- data/lib/mailslurp_client/models/optional_connector_dto.rb +220 -0
- data/lib/mailslurp_client/models/optional_connector_imap_connection_dto.rb +220 -0
- data/lib/mailslurp_client/models/optional_connector_smtp_connection_dto.rb +220 -0
- data/lib/mailslurp_client/models/optional_connector_sync_settings_dto.rb +220 -0
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +68 -8
- data/lib/mailslurp_client/models/page_alias.rb +16 -16
- data/lib/mailslurp_client/models/{page_connector_sync_events.rb → page_alias_thread_projection.rb} +21 -21
- data/lib/mailslurp_client/models/page_attachment_entity.rb +16 -16
- data/lib/mailslurp_client/models/page_bounced_email.rb +16 -16
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +16 -16
- data/lib/mailslurp_client/models/page_complaint.rb +16 -16
- data/lib/mailslurp_client/models/page_connector.rb +16 -16
- data/lib/mailslurp_client/models/page_connector_events.rb +309 -0
- data/lib/mailslurp_client/models/page_contact_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_delivery_status.rb +16 -16
- data/lib/mailslurp_client/models/page_email_preview.rb +16 -16
- data/lib/mailslurp_client/models/page_email_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_email_thread_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_email_validation_request.rb +16 -16
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_group_projection.rb +16 -16
- data/lib/mailslurp_client/models/{page_thread_projection.rb → page_guest_portal_users.rb} +21 -21
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +16 -16
- data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +16 -16
- data/lib/mailslurp_client/models/page_inbox_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +16 -16
- data/lib/mailslurp_client/models/page_inbox_replier_events.rb +16 -16
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +16 -16
- data/lib/mailslurp_client/models/page_inbox_tags.rb +309 -0
- data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +16 -16
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_phone_number_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_plus_address_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_scheduled_jobs.rb +16 -16
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_sent_sms_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_sms_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_template_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_webhook_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_webhook_result.rb +16 -16
- data/lib/mailslurp_client/models/pageable_object.rb +20 -20
- data/lib/mailslurp_client/models/phone_number_dto.rb +37 -5
- data/lib/mailslurp_client/models/phone_number_projection.rb +11 -2
- data/lib/mailslurp_client/models/phone_number_validation_dto.rb +254 -0
- data/lib/mailslurp_client/models/phone_plan_availability.rb +213 -0
- data/lib/mailslurp_client/models/phone_plan_availability_item.rb +271 -0
- data/lib/mailslurp_client/models/phone_plan_dto.rb +1 -1
- data/lib/mailslurp_client/models/plus_address_dto.rb +295 -0
- data/lib/mailslurp_client/models/plus_address_projection.rb +295 -0
- data/lib/mailslurp_client/models/provider_settings.rb +347 -0
- data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
- data/lib/mailslurp_client/models/recipient.rb +1 -1
- data/lib/mailslurp_client/models/recipient_projection.rb +234 -0
- data/lib/mailslurp_client/models/reply_for_sms.rb +1 -1
- data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
- data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
- data/lib/mailslurp_client/models/scheduled_job.rb +1 -1
- data/lib/mailslurp_client/models/scheduled_job_dto.rb +1 -1
- data/lib/mailslurp_client/models/search_emails_options.rb +1 -1
- data/lib/mailslurp_client/models/search_inboxes_options.rb +3 -3
- data/lib/mailslurp_client/models/send_email_body_part.rb +1 -1
- data/lib/mailslurp_client/models/send_email_options.rb +13 -2
- data/lib/mailslurp_client/models/send_opt_in_consent_email_options.rb +234 -0
- data/lib/mailslurp_client/models/send_smtp_envelope_options.rb +1 -1
- data/lib/mailslurp_client/models/send_with_queue_result.rb +1 -1
- data/lib/mailslurp_client/models/sender.rb +1 -1
- data/lib/mailslurp_client/models/sender_projection.rb +235 -0
- data/lib/mailslurp_client/models/sent_email_dto.rb +92 -2
- data/lib/mailslurp_client/models/sent_email_projection.rb +110 -41
- data/lib/mailslurp_client/models/sent_sms_dto.rb +1 -11
- data/lib/mailslurp_client/models/sent_sms_projection.rb +305 -0
- data/lib/mailslurp_client/models/server_endpoints.rb +1 -1
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
- data/lib/mailslurp_client/models/set_phone_favourited_options.rb +213 -0
- data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
- data/lib/mailslurp_client/models/sms_dto.rb +25 -2
- data/lib/mailslurp_client/models/sms_match_option.rb +1 -1
- data/lib/mailslurp_client/models/sms_preview.rb +1 -1
- data/lib/mailslurp_client/models/sms_projection.rb +1 -1
- data/lib/mailslurp_client/models/sms_reply_options.rb +1 -1
- data/lib/mailslurp_client/models/sms_send_options.rb +225 -0
- data/lib/mailslurp_client/models/smtp_access_details.rb +1 -1
- data/lib/mailslurp_client/models/sort_object.rb +1 -1
- data/lib/mailslurp_client/models/spelling_issue.rb +1 -1
- data/lib/mailslurp_client/models/template_dto.rb +1 -1
- data/lib/mailslurp_client/models/template_preview.rb +1 -1
- data/lib/mailslurp_client/models/template_projection.rb +1 -1
- data/lib/mailslurp_client/models/template_variable.rb +1 -1
- data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_options.rb +1 -1
- data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_result.rb +1 -1
- data/lib/mailslurp_client/models/test_inbox_ruleset_sending_options.rb +1 -1
- data/lib/mailslurp_client/models/test_inbox_ruleset_sending_result.rb +1 -1
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
- data/lib/mailslurp_client/models/test_phone_number_options.rb +1 -1
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +11 -11
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +11 -11
- data/lib/mailslurp_client/models/unread_count.rb +1 -1
- data/lib/mailslurp_client/models/unseen_error_count_dto.rb +1 -1
- data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
- data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
- data/lib/mailslurp_client/models/update_imap_access_options.rb +1 -1
- data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
- data/lib/mailslurp_client/models/update_inbox_replier_options.rb +1 -1
- data/lib/mailslurp_client/models/update_phone_number_options.rb +215 -0
- data/lib/mailslurp_client/models/update_smtp_access_options.rb +1 -1
- data/lib/mailslurp_client/models/upload_attachment_options.rb +1 -1
- data/lib/mailslurp_client/models/user_info_dto.rb +1 -1
- data/lib/mailslurp_client/models/validate_email_address_list_options.rb +1 -1
- data/lib/mailslurp_client/models/validate_email_address_list_result.rb +1 -1
- data/lib/mailslurp_client/models/validate_phone_number_options.rb +211 -0
- data/lib/mailslurp_client/models/validation_dto.rb +1 -1
- data/lib/mailslurp_client/models/validation_message.rb +1 -1
- data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
- data/lib/mailslurp_client/models/verify_webhook_signature_options.rb +1 -1
- data/lib/mailslurp_client/models/verify_webhook_signature_results.rb +1 -1
- data/lib/mailslurp_client/models/wait_for_conditions.rb +1 -1
- data/lib/mailslurp_client/models/wait_for_single_sms_options.rb +1 -1
- data/lib/mailslurp_client/models/wait_for_sms_conditions.rb +1 -1
- data/lib/mailslurp_client/models/webhook_bounce_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_bounce_recipient_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_delivery_status_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_dto.rb +31 -8
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_email_read_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_endpoint_projection.rb +259 -0
- data/lib/mailslurp_client/models/webhook_header_name_value.rb +1 -1
- data/lib/mailslurp_client/models/webhook_headers.rb +1 -1
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_new_sms_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_projection.rb +60 -7
- data/lib/mailslurp_client/models/webhook_redrive_all_result.rb +1 -1
- data/lib/mailslurp_client/models/webhook_redrive_result.rb +1 -1
- data/lib/mailslurp_client/models/webhook_result_dto.rb +3 -3
- data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
- data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
- data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
- data/lib/mailslurp_client/version.rb +2 -2
- data/lib/mailslurp_client.rb +58 -10
- metadata +59 -11
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
Contact: contact@mailslurp.dev
|
@@ -905,7 +905,7 @@ module MailSlurpClient
|
|
905
905
|
if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
|
906
906
|
fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
|
907
907
|
end
|
908
|
-
allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"]
|
908
|
+
allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR", "ACCOUNT", "GUEST"]
|
909
909
|
if @api_client.config.client_side_validation && opts[:'inbox_function'] && !allowable_values.include?(opts[:'inbox_function'])
|
910
910
|
fail ArgumentError, "invalid value for \"inbox_function\", must be one of #{allowable_values}"
|
911
911
|
end
|
@@ -1009,7 +1009,7 @@ module MailSlurpClient
|
|
1009
1009
|
if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
|
1010
1010
|
fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
|
1011
1011
|
end
|
1012
|
-
allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"]
|
1012
|
+
allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR", "ACCOUNT", "GUEST"]
|
1013
1013
|
if @api_client.config.client_side_validation && opts[:'inbox_function'] && !allowable_values.include?(opts[:'inbox_function'])
|
1014
1014
|
fail ArgumentError, "invalid value for \"inbox_function\", must be one of #{allowable_values}"
|
1015
1015
|
end
|
@@ -1064,6 +1064,78 @@ module MailSlurpClient
|
|
1064
1064
|
return data, status_code, headers
|
1065
1065
|
end
|
1066
1066
|
|
1067
|
+
# Get all sub address plus address aliases for an inbox
|
1068
|
+
# Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias.
|
1069
|
+
# @param [Hash] opts the optional parameters
|
1070
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
1071
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
1072
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1073
|
+
# @option opts [String] :inbox_id Optional inboxId filter
|
1074
|
+
# @return [PagePlusAddressProjection]
|
1075
|
+
def get_all_plus_addresses(opts = {})
|
1076
|
+
data, _status_code, _headers = get_all_plus_addresses_with_http_info(opts)
|
1077
|
+
data
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# Get all sub address plus address aliases for an inbox
|
1081
|
+
# Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias.
|
1082
|
+
# @param [Hash] opts the optional parameters
|
1083
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
1084
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
1085
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1086
|
+
# @option opts [String] :inbox_id Optional inboxId filter
|
1087
|
+
# @return [Array<(PagePlusAddressProjection, Integer, Hash)>] PagePlusAddressProjection data, response status code and response headers
|
1088
|
+
def get_all_plus_addresses_with_http_info(opts = {})
|
1089
|
+
if @api_client.config.debugging
|
1090
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_all_plus_addresses ...'
|
1091
|
+
end
|
1092
|
+
allowable_values = ["ASC", "DESC"]
|
1093
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1094
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1095
|
+
end
|
1096
|
+
# resource path
|
1097
|
+
local_var_path = '/inboxes/plus-addresses'
|
1098
|
+
|
1099
|
+
# query parameters
|
1100
|
+
query_params = opts[:query_params] || {}
|
1101
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1102
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1103
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1104
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
1105
|
+
|
1106
|
+
# header parameters
|
1107
|
+
header_params = opts[:header_params] || {}
|
1108
|
+
# HTTP header 'Accept' (if needed)
|
1109
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1110
|
+
|
1111
|
+
# form parameters
|
1112
|
+
form_params = opts[:form_params] || {}
|
1113
|
+
|
1114
|
+
# http body (model)
|
1115
|
+
post_body = opts[:body]
|
1116
|
+
|
1117
|
+
# return_type
|
1118
|
+
return_type = opts[:return_type] || 'PagePlusAddressProjection'
|
1119
|
+
|
1120
|
+
# auth_names
|
1121
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1122
|
+
|
1123
|
+
new_options = opts.merge(
|
1124
|
+
:header_params => header_params,
|
1125
|
+
:query_params => query_params,
|
1126
|
+
:form_params => form_params,
|
1127
|
+
:body => post_body,
|
1128
|
+
:auth_names => auth_names,
|
1129
|
+
:return_type => return_type
|
1130
|
+
)
|
1131
|
+
|
1132
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1133
|
+
if @api_client.config.debugging
|
1134
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_all_plus_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1135
|
+
end
|
1136
|
+
return data, status_code, headers
|
1137
|
+
end
|
1138
|
+
|
1067
1139
|
# Get all scheduled email sending jobs for account
|
1068
1140
|
# Schedule sending of emails using scheduled jobs. These can be inbox or account level.
|
1069
1141
|
# @param [Hash] opts the optional parameters
|
@@ -1072,6 +1144,7 @@ module MailSlurpClient
|
|
1072
1144
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1073
1145
|
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
1074
1146
|
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
1147
|
+
# @option opts [String] :inbox_id
|
1075
1148
|
# @return [PageScheduledJobs]
|
1076
1149
|
def get_all_scheduled_jobs(opts = {})
|
1077
1150
|
data, _status_code, _headers = get_all_scheduled_jobs_with_http_info(opts)
|
@@ -1086,6 +1159,7 @@ module MailSlurpClient
|
|
1086
1159
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1087
1160
|
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
1088
1161
|
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
1162
|
+
# @option opts [String] :inbox_id
|
1089
1163
|
# @return [Array<(PageScheduledJobs, Integer, Hash)>] PageScheduledJobs data, response status code and response headers
|
1090
1164
|
def get_all_scheduled_jobs_with_http_info(opts = {})
|
1091
1165
|
if @api_client.config.debugging
|
@@ -1105,6 +1179,7 @@ module MailSlurpClient
|
|
1105
1179
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1106
1180
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1107
1181
|
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1182
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
1108
1183
|
|
1109
1184
|
# header parameters
|
1110
1185
|
header_params = opts[:header_params] || {}
|
@@ -1855,6 +1930,7 @@ module MailSlurpClient
|
|
1855
1930
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1856
1931
|
# @option opts [DateTime] :since Optional filter by received after given date time
|
1857
1932
|
# @option opts [DateTime] :before Optional filter by received before given date time
|
1933
|
+
# @option opts [Boolean] :sync_connectors Sync connectors before fetching emails
|
1858
1934
|
# @return [PageEmailPreview]
|
1859
1935
|
def get_inbox_emails_paginated(inbox_id, opts = {})
|
1860
1936
|
data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(inbox_id, opts)
|
@@ -1870,6 +1946,7 @@ module MailSlurpClient
|
|
1870
1946
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1871
1947
|
# @option opts [DateTime] :since Optional filter by received after given date time
|
1872
1948
|
# @option opts [DateTime] :before Optional filter by received before given date time
|
1949
|
+
# @option opts [Boolean] :sync_connectors Sync connectors before fetching emails
|
1873
1950
|
# @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
|
1874
1951
|
def get_inbox_emails_paginated_with_http_info(inbox_id, opts = {})
|
1875
1952
|
if @api_client.config.debugging
|
@@ -1893,6 +1970,7 @@ module MailSlurpClient
|
|
1893
1970
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1894
1971
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1895
1972
|
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1973
|
+
query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
|
1896
1974
|
|
1897
1975
|
# header parameters
|
1898
1976
|
header_params = opts[:header_params] || {}
|
@@ -1983,56 +2061,40 @@ module MailSlurpClient
|
|
1983
2061
|
return data, status_code, headers
|
1984
2062
|
end
|
1985
2063
|
|
1986
|
-
# Get
|
1987
|
-
# Returns
|
1988
|
-
# @param
|
2064
|
+
# Get sub address plus address for an inbox
|
2065
|
+
# Returns a plus address object based on emails that used the inbox address with a +xyz alias.
|
2066
|
+
# @param plus_address_id [String] ID of the plus address you want to fetch
|
2067
|
+
# @param inbox_id [String] ID of the inbox you want to fetch
|
1989
2068
|
# @param [Hash] opts the optional parameters
|
1990
|
-
# @
|
1991
|
-
|
1992
|
-
|
1993
|
-
# @option opts [String] :search_filter Optional sent email search
|
1994
|
-
# @option opts [DateTime] :since Optional filter by sent after given date time
|
1995
|
-
# @option opts [DateTime] :before Optional filter by sent before given date time
|
1996
|
-
# @return [PageSentEmailProjection]
|
1997
|
-
def get_inbox_sent_emails(inbox_id, opts = {})
|
1998
|
-
data, _status_code, _headers = get_inbox_sent_emails_with_http_info(inbox_id, opts)
|
2069
|
+
# @return [PlusAddressDto]
|
2070
|
+
def get_inbox_plus_address(plus_address_id, inbox_id, opts = {})
|
2071
|
+
data, _status_code, _headers = get_inbox_plus_address_with_http_info(plus_address_id, inbox_id, opts)
|
1999
2072
|
data
|
2000
2073
|
end
|
2001
2074
|
|
2002
|
-
# Get
|
2003
|
-
# Returns
|
2004
|
-
# @param
|
2075
|
+
# Get sub address plus address for an inbox
|
2076
|
+
# Returns a plus address object based on emails that used the inbox address with a +xyz alias.
|
2077
|
+
# @param plus_address_id [String] ID of the plus address you want to fetch
|
2078
|
+
# @param inbox_id [String] ID of the inbox you want to fetch
|
2005
2079
|
# @param [Hash] opts the optional parameters
|
2006
|
-
# @
|
2007
|
-
|
2008
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2009
|
-
# @option opts [String] :search_filter Optional sent email search
|
2010
|
-
# @option opts [DateTime] :since Optional filter by sent after given date time
|
2011
|
-
# @option opts [DateTime] :before Optional filter by sent before given date time
|
2012
|
-
# @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
|
2013
|
-
def get_inbox_sent_emails_with_http_info(inbox_id, opts = {})
|
2080
|
+
# @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
|
2081
|
+
def get_inbox_plus_address_with_http_info(plus_address_id, inbox_id, opts = {})
|
2014
2082
|
if @api_client.config.debugging
|
2015
|
-
@api_client.config.logger.debug 'Calling API: InboxControllerApi.
|
2083
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address ...'
|
2084
|
+
end
|
2085
|
+
# verify the required parameter 'plus_address_id' is set
|
2086
|
+
if @api_client.config.client_side_validation && plus_address_id.nil?
|
2087
|
+
fail ArgumentError, "Missing the required parameter 'plus_address_id' when calling InboxControllerApi.get_inbox_plus_address"
|
2016
2088
|
end
|
2017
2089
|
# verify the required parameter 'inbox_id' is set
|
2018
2090
|
if @api_client.config.client_side_validation && inbox_id.nil?
|
2019
|
-
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.
|
2020
|
-
end
|
2021
|
-
allowable_values = ["ASC", "DESC"]
|
2022
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2023
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2091
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_address"
|
2024
2092
|
end
|
2025
2093
|
# resource path
|
2026
|
-
local_var_path = '/inboxes/{inboxId}/
|
2094
|
+
local_var_path = '/inboxes/{inboxId}/plus-addresses/{plusAddressId}'.sub('{' + 'plusAddressId' + '}', CGI.escape(plus_address_id.to_s)).sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
2027
2095
|
|
2028
2096
|
# query parameters
|
2029
2097
|
query_params = opts[:query_params] || {}
|
2030
|
-
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2031
|
-
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2032
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2033
|
-
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
2034
|
-
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2035
|
-
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
2036
2098
|
|
2037
2099
|
# header parameters
|
2038
2100
|
header_params = opts[:header_params] || {}
|
@@ -2046,7 +2108,7 @@ module MailSlurpClient
|
|
2046
2108
|
post_body = opts[:body]
|
2047
2109
|
|
2048
2110
|
# return_type
|
2049
|
-
return_type = opts[:return_type] || '
|
2111
|
+
return_type = opts[:return_type] || 'PlusAddressDto'
|
2050
2112
|
|
2051
2113
|
# auth_names
|
2052
2114
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -2062,33 +2124,42 @@ module MailSlurpClient
|
|
2062
2124
|
|
2063
2125
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2064
2126
|
if @api_client.config.debugging
|
2065
|
-
@api_client.config.logger.debug "API called: InboxControllerApi#
|
2127
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2066
2128
|
end
|
2067
2129
|
return data, status_code, headers
|
2068
2130
|
end
|
2069
2131
|
|
2070
|
-
# Get
|
2071
|
-
#
|
2132
|
+
# Get sub address plus address by ID
|
2133
|
+
# Returns a plus address object based on emails that used the inbox address with a +xyz alias.
|
2134
|
+
# @param plus_address_id [String] ID of the plus address you want to fetch
|
2072
2135
|
# @param [Hash] opts the optional parameters
|
2073
|
-
# @
|
2074
|
-
|
2075
|
-
|
2136
|
+
# @option opts [String] :inbox_id ID of the inbox you want to filter for
|
2137
|
+
# @return [PlusAddressDto]
|
2138
|
+
def get_inbox_plus_address_by_id(plus_address_id, opts = {})
|
2139
|
+
data, _status_code, _headers = get_inbox_plus_address_by_id_with_http_info(plus_address_id, opts)
|
2076
2140
|
data
|
2077
2141
|
end
|
2078
2142
|
|
2079
|
-
# Get
|
2080
|
-
#
|
2143
|
+
# Get sub address plus address by ID
|
2144
|
+
# Returns a plus address object based on emails that used the inbox address with a +xyz alias.
|
2145
|
+
# @param plus_address_id [String] ID of the plus address you want to fetch
|
2081
2146
|
# @param [Hash] opts the optional parameters
|
2082
|
-
# @
|
2083
|
-
|
2147
|
+
# @option opts [String] :inbox_id ID of the inbox you want to filter for
|
2148
|
+
# @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
|
2149
|
+
def get_inbox_plus_address_by_id_with_http_info(plus_address_id, opts = {})
|
2084
2150
|
if @api_client.config.debugging
|
2085
|
-
@api_client.config.logger.debug 'Calling API: InboxControllerApi.
|
2151
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address_by_id ...'
|
2152
|
+
end
|
2153
|
+
# verify the required parameter 'plus_address_id' is set
|
2154
|
+
if @api_client.config.client_side_validation && plus_address_id.nil?
|
2155
|
+
fail ArgumentError, "Missing the required parameter 'plus_address_id' when calling InboxControllerApi.get_inbox_plus_address_by_id"
|
2086
2156
|
end
|
2087
2157
|
# resource path
|
2088
|
-
local_var_path = '/inboxes/
|
2158
|
+
local_var_path = '/inboxes/plus-addresses/{plusAddressId}'.sub('{' + 'plusAddressId' + '}', CGI.escape(plus_address_id.to_s))
|
2089
2159
|
|
2090
2160
|
# query parameters
|
2091
2161
|
query_params = opts[:query_params] || {}
|
2162
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
2092
2163
|
|
2093
2164
|
# header parameters
|
2094
2165
|
header_params = opts[:header_params] || {}
|
@@ -2102,7 +2173,7 @@ module MailSlurpClient
|
|
2102
2173
|
post_body = opts[:body]
|
2103
2174
|
|
2104
2175
|
# return_type
|
2105
|
-
return_type = opts[:return_type] || '
|
2176
|
+
return_type = opts[:return_type] || 'PlusAddressDto'
|
2106
2177
|
|
2107
2178
|
# auth_names
|
2108
2179
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -2118,55 +2189,64 @@ module MailSlurpClient
|
|
2118
2189
|
|
2119
2190
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2120
2191
|
if @api_client.config.debugging
|
2121
|
-
@api_client.config.logger.debug "API called: InboxControllerApi#
|
2192
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2122
2193
|
end
|
2123
2194
|
return data, status_code, headers
|
2124
2195
|
end
|
2125
2196
|
|
2126
|
-
#
|
2127
|
-
#
|
2197
|
+
# Get emails for a given inbox plus address
|
2198
|
+
# Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
|
2199
|
+
# @param plus_address [String] The plus address to fetch emails for. If your inbox address is `123@test.com` and the email was sent to `123+abc@test.com` then the plus address is `abc`
|
2200
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
2128
2201
|
# @param [Hash] opts the optional parameters
|
2129
|
-
# @option opts [Integer] :
|
2202
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
2203
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
2130
2204
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2131
2205
|
# @option opts [DateTime] :since Optional filter by created after given date time
|
2132
|
-
# @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
|
2133
2206
|
# @option opts [DateTime] :before Optional filter by created before given date time
|
2134
|
-
# @return [
|
2135
|
-
def
|
2136
|
-
data, _status_code, _headers =
|
2207
|
+
# @return [PageEmailPreview]
|
2208
|
+
def get_inbox_plus_address_emails(plus_address, inbox_id, opts = {})
|
2209
|
+
data, _status_code, _headers = get_inbox_plus_address_emails_with_http_info(plus_address, inbox_id, opts)
|
2137
2210
|
data
|
2138
2211
|
end
|
2139
2212
|
|
2140
|
-
#
|
2141
|
-
#
|
2213
|
+
# Get emails for a given inbox plus address
|
2214
|
+
# Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
|
2215
|
+
# @param plus_address [String] The plus address to fetch emails for. If your inbox address is `123@test.com` and the email was sent to `123+abc@test.com` then the plus address is `abc`
|
2216
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
2142
2217
|
# @param [Hash] opts the optional parameters
|
2143
|
-
# @option opts [Integer] :
|
2218
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
2219
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
2144
2220
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2145
2221
|
# @option opts [DateTime] :since Optional filter by created after given date time
|
2146
|
-
# @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
|
2147
2222
|
# @option opts [DateTime] :before Optional filter by created before given date time
|
2148
|
-
# @return [Array<(
|
2149
|
-
def
|
2223
|
+
# @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
|
2224
|
+
def get_inbox_plus_address_emails_with_http_info(plus_address, inbox_id, opts = {})
|
2150
2225
|
if @api_client.config.debugging
|
2151
|
-
@api_client.config.logger.debug 'Calling API: InboxControllerApi.
|
2226
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address_emails ...'
|
2152
2227
|
end
|
2153
|
-
|
2154
|
-
|
2228
|
+
# verify the required parameter 'plus_address' is set
|
2229
|
+
if @api_client.config.client_side_validation && plus_address.nil?
|
2230
|
+
fail ArgumentError, "Missing the required parameter 'plus_address' when calling InboxControllerApi.get_inbox_plus_address_emails"
|
2231
|
+
end
|
2232
|
+
# verify the required parameter 'inbox_id' is set
|
2233
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
2234
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_address_emails"
|
2155
2235
|
end
|
2156
|
-
|
2157
2236
|
allowable_values = ["ASC", "DESC"]
|
2158
2237
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2159
2238
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2160
2239
|
end
|
2161
2240
|
# resource path
|
2162
|
-
local_var_path = '/inboxes'
|
2241
|
+
local_var_path = '/inboxes/{inboxId}/plus-addresses/emails'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
2163
2242
|
|
2164
2243
|
# query parameters
|
2165
2244
|
query_params = opts[:query_params] || {}
|
2245
|
+
query_params[:'plusAddress'] = plus_address
|
2246
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2166
2247
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2167
2248
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2168
2249
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2169
|
-
query_params[:'excludeCatchAllInboxes'] = opts[:'exclude_catch_all_inboxes'] if !opts[:'exclude_catch_all_inboxes'].nil?
|
2170
2250
|
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
2171
2251
|
|
2172
2252
|
# header parameters
|
@@ -2181,7 +2261,7 @@ module MailSlurpClient
|
|
2181
2261
|
post_body = opts[:body]
|
2182
2262
|
|
2183
2263
|
# return_type
|
2184
|
-
return_type = opts[:return_type] || '
|
2264
|
+
return_type = opts[:return_type] || 'PageEmailPreview'
|
2185
2265
|
|
2186
2266
|
# auth_names
|
2187
2267
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -2197,47 +2277,64 @@ module MailSlurpClient
|
|
2197
2277
|
|
2198
2278
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2199
2279
|
if @api_client.config.debugging
|
2200
|
-
@api_client.config.logger.debug "API called: InboxControllerApi#
|
2280
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2201
2281
|
end
|
2202
2282
|
return data, status_code, headers
|
2203
2283
|
end
|
2204
2284
|
|
2205
|
-
# Get
|
2206
|
-
#
|
2207
|
-
# @param
|
2208
|
-
# @param
|
2285
|
+
# Get emails for a given inbox plus address
|
2286
|
+
# Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
|
2287
|
+
# @param plus_address_id [String] The plus address ID to fetch emails for.
|
2288
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
2209
2289
|
# @param [Hash] opts the optional parameters
|
2210
|
-
# @
|
2211
|
-
|
2212
|
-
|
2290
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
2291
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
2292
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2293
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
2294
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
2295
|
+
# @return [PageEmailPreview]
|
2296
|
+
def get_inbox_plus_address_emails_for_plus_address_id(plus_address_id, inbox_id, opts = {})
|
2297
|
+
data, _status_code, _headers = get_inbox_plus_address_emails_for_plus_address_id_with_http_info(plus_address_id, inbox_id, opts)
|
2213
2298
|
data
|
2214
2299
|
end
|
2215
2300
|
|
2216
|
-
# Get
|
2217
|
-
#
|
2218
|
-
# @param
|
2219
|
-
# @param
|
2301
|
+
# Get emails for a given inbox plus address
|
2302
|
+
# Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
|
2303
|
+
# @param plus_address_id [String] The plus address ID to fetch emails for.
|
2304
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
2220
2305
|
# @param [Hash] opts the optional parameters
|
2221
|
-
# @
|
2222
|
-
|
2306
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
2307
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
2308
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2309
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
2310
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
2311
|
+
# @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
|
2312
|
+
def get_inbox_plus_address_emails_for_plus_address_id_with_http_info(plus_address_id, inbox_id, opts = {})
|
2223
2313
|
if @api_client.config.debugging
|
2224
|
-
@api_client.config.logger.debug 'Calling API: InboxControllerApi.
|
2314
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address_emails_for_plus_address_id ...'
|
2315
|
+
end
|
2316
|
+
# verify the required parameter 'plus_address_id' is set
|
2317
|
+
if @api_client.config.client_side_validation && plus_address_id.nil?
|
2318
|
+
fail ArgumentError, "Missing the required parameter 'plus_address_id' when calling InboxControllerApi.get_inbox_plus_address_emails_for_plus_address_id"
|
2225
2319
|
end
|
2226
2320
|
# verify the required parameter 'inbox_id' is set
|
2227
2321
|
if @api_client.config.client_side_validation && inbox_id.nil?
|
2228
|
-
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.
|
2322
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_address_emails_for_plus_address_id"
|
2229
2323
|
end
|
2230
|
-
|
2231
|
-
if @api_client.config.client_side_validation &&
|
2232
|
-
fail ArgumentError, "
|
2324
|
+
allowable_values = ["ASC", "DESC"]
|
2325
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2326
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2233
2327
|
end
|
2234
2328
|
# resource path
|
2235
|
-
local_var_path = '/inboxes/
|
2329
|
+
local_var_path = '/inboxes/{inboxId}/plus-addresses/{plusAddressId}/emails'.sub('{' + 'plusAddressId' + '}', CGI.escape(plus_address_id.to_s)).sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
2236
2330
|
|
2237
2331
|
# query parameters
|
2238
2332
|
query_params = opts[:query_params] || {}
|
2239
|
-
query_params[:'
|
2240
|
-
query_params[:'
|
2333
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2334
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2335
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2336
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2337
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
2241
2338
|
|
2242
2339
|
# header parameters
|
2243
2340
|
header_params = opts[:header_params] || {}
|
@@ -2251,7 +2348,7 @@ module MailSlurpClient
|
|
2251
2348
|
post_body = opts[:body]
|
2252
2349
|
|
2253
2350
|
# return_type
|
2254
|
-
return_type = opts[:return_type] || '
|
2351
|
+
return_type = opts[:return_type] || 'PageEmailPreview'
|
2255
2352
|
|
2256
2353
|
# auth_names
|
2257
2354
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -2267,55 +2364,52 @@ module MailSlurpClient
|
|
2267
2364
|
|
2268
2365
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2269
2366
|
if @api_client.config.debugging
|
2270
|
-
@api_client.config.logger.debug "API called: InboxControllerApi#
|
2367
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address_emails_for_plus_address_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2271
2368
|
end
|
2272
2369
|
return data, status_code, headers
|
2273
2370
|
end
|
2274
2371
|
|
2275
|
-
#
|
2276
|
-
#
|
2372
|
+
# Get sub address plus address aliases for an inbox
|
2373
|
+
# Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
|
2374
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
2277
2375
|
# @param [Hash] opts the optional parameters
|
2278
|
-
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
2279
|
-
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
2376
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
2377
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
2280
2378
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2281
|
-
# @
|
2282
|
-
|
2283
|
-
|
2284
|
-
# @return [PageOrganizationInboxProjection]
|
2285
|
-
def get_organization_inboxes(opts = {})
|
2286
|
-
data, _status_code, _headers = get_organization_inboxes_with_http_info(opts)
|
2379
|
+
# @return [PagePlusAddressProjection]
|
2380
|
+
def get_inbox_plus_addresses(inbox_id, opts = {})
|
2381
|
+
data, _status_code, _headers = get_inbox_plus_addresses_with_http_info(inbox_id, opts)
|
2287
2382
|
data
|
2288
2383
|
end
|
2289
2384
|
|
2290
|
-
#
|
2291
|
-
#
|
2385
|
+
# Get sub address plus address aliases for an inbox
|
2386
|
+
# Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
|
2387
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
2292
2388
|
# @param [Hash] opts the optional parameters
|
2293
|
-
# @option opts [Integer] :page Optional page index in list pagination
|
2294
|
-
# @option opts [Integer] :size Optional page size in list pagination
|
2389
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
2390
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
2295
2391
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2296
|
-
# @
|
2297
|
-
|
2298
|
-
# @option opts [DateTime] :before Optional filter by created before given date time
|
2299
|
-
# @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
|
2300
|
-
def get_organization_inboxes_with_http_info(opts = {})
|
2392
|
+
# @return [Array<(PagePlusAddressProjection, Integer, Hash)>] PagePlusAddressProjection data, response status code and response headers
|
2393
|
+
def get_inbox_plus_addresses_with_http_info(inbox_id, opts = {})
|
2301
2394
|
if @api_client.config.debugging
|
2302
|
-
@api_client.config.logger.debug 'Calling API: InboxControllerApi.
|
2395
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_addresses ...'
|
2396
|
+
end
|
2397
|
+
# verify the required parameter 'inbox_id' is set
|
2398
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
2399
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_addresses"
|
2303
2400
|
end
|
2304
2401
|
allowable_values = ["ASC", "DESC"]
|
2305
2402
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2306
2403
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2307
2404
|
end
|
2308
2405
|
# resource path
|
2309
|
-
local_var_path = '/inboxes/
|
2406
|
+
local_var_path = '/inboxes/{inboxId}/plus-addresses'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
2310
2407
|
|
2311
2408
|
# query parameters
|
2312
2409
|
query_params = opts[:query_params] || {}
|
2313
2410
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2314
2411
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2315
2412
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2316
|
-
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
2317
|
-
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2318
|
-
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
2319
2413
|
|
2320
2414
|
# header parameters
|
2321
2415
|
header_params = opts[:header_params] || {}
|
@@ -2329,7 +2423,7 @@ module MailSlurpClient
|
|
2329
2423
|
post_body = opts[:body]
|
2330
2424
|
|
2331
2425
|
# return_type
|
2332
|
-
return_type = opts[:return_type] || '
|
2426
|
+
return_type = opts[:return_type] || 'PagePlusAddressProjection'
|
2333
2427
|
|
2334
2428
|
# auth_names
|
2335
2429
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -2345,7 +2439,673 @@ module MailSlurpClient
|
|
2345
2439
|
|
2346
2440
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2347
2441
|
if @api_client.config.debugging
|
2348
|
-
@api_client.config.logger.debug "API called: InboxControllerApi#
|
2442
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2443
|
+
end
|
2444
|
+
return data, status_code, headers
|
2445
|
+
end
|
2446
|
+
|
2447
|
+
# Get sent email count in inbox
|
2448
|
+
# @param inbox_id [String] Id of inbox that emails were sent from
|
2449
|
+
# @param [Hash] opts the optional parameters
|
2450
|
+
# @return [CountDto]
|
2451
|
+
def get_inbox_sent_count(inbox_id, opts = {})
|
2452
|
+
data, _status_code, _headers = get_inbox_sent_count_with_http_info(inbox_id, opts)
|
2453
|
+
data
|
2454
|
+
end
|
2455
|
+
|
2456
|
+
# Get sent email count in inbox
|
2457
|
+
# @param inbox_id [String] Id of inbox that emails were sent from
|
2458
|
+
# @param [Hash] opts the optional parameters
|
2459
|
+
# @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
|
2460
|
+
def get_inbox_sent_count_with_http_info(inbox_id, opts = {})
|
2461
|
+
if @api_client.config.debugging
|
2462
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_sent_count ...'
|
2463
|
+
end
|
2464
|
+
# verify the required parameter 'inbox_id' is set
|
2465
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
2466
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_sent_count"
|
2467
|
+
end
|
2468
|
+
# resource path
|
2469
|
+
local_var_path = '/inboxes/{inboxId}/sent/count'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
2470
|
+
|
2471
|
+
# query parameters
|
2472
|
+
query_params = opts[:query_params] || {}
|
2473
|
+
|
2474
|
+
# header parameters
|
2475
|
+
header_params = opts[:header_params] || {}
|
2476
|
+
# HTTP header 'Accept' (if needed)
|
2477
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2478
|
+
|
2479
|
+
# form parameters
|
2480
|
+
form_params = opts[:form_params] || {}
|
2481
|
+
|
2482
|
+
# http body (model)
|
2483
|
+
post_body = opts[:body]
|
2484
|
+
|
2485
|
+
# return_type
|
2486
|
+
return_type = opts[:return_type] || 'CountDto'
|
2487
|
+
|
2488
|
+
# auth_names
|
2489
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2490
|
+
|
2491
|
+
new_options = opts.merge(
|
2492
|
+
:header_params => header_params,
|
2493
|
+
:query_params => query_params,
|
2494
|
+
:form_params => form_params,
|
2495
|
+
:body => post_body,
|
2496
|
+
:auth_names => auth_names,
|
2497
|
+
:return_type => return_type
|
2498
|
+
)
|
2499
|
+
|
2500
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2501
|
+
if @api_client.config.debugging
|
2502
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_sent_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2503
|
+
end
|
2504
|
+
return data, status_code, headers
|
2505
|
+
end
|
2506
|
+
|
2507
|
+
# Get Inbox Sent Emails
|
2508
|
+
# Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
|
2509
|
+
# @param inbox_id [String]
|
2510
|
+
# @param [Hash] opts the optional parameters
|
2511
|
+
# @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
|
2512
|
+
# @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
|
2513
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2514
|
+
# @option opts [String] :search_filter Optional sent email search
|
2515
|
+
# @option opts [DateTime] :since Optional filter by sent after given date time
|
2516
|
+
# @option opts [DateTime] :before Optional filter by sent before given date time
|
2517
|
+
# @return [PageSentEmailProjection]
|
2518
|
+
def get_inbox_sent_emails(inbox_id, opts = {})
|
2519
|
+
data, _status_code, _headers = get_inbox_sent_emails_with_http_info(inbox_id, opts)
|
2520
|
+
data
|
2521
|
+
end
|
2522
|
+
|
2523
|
+
# Get Inbox Sent Emails
|
2524
|
+
# Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
|
2525
|
+
# @param inbox_id [String]
|
2526
|
+
# @param [Hash] opts the optional parameters
|
2527
|
+
# @option opts [Integer] :page Optional page index in inbox sent email list pagination
|
2528
|
+
# @option opts [Integer] :size Optional page size in inbox sent email list pagination
|
2529
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2530
|
+
# @option opts [String] :search_filter Optional sent email search
|
2531
|
+
# @option opts [DateTime] :since Optional filter by sent after given date time
|
2532
|
+
# @option opts [DateTime] :before Optional filter by sent before given date time
|
2533
|
+
# @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
|
2534
|
+
def get_inbox_sent_emails_with_http_info(inbox_id, opts = {})
|
2535
|
+
if @api_client.config.debugging
|
2536
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_sent_emails ...'
|
2537
|
+
end
|
2538
|
+
# verify the required parameter 'inbox_id' is set
|
2539
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
2540
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_sent_emails"
|
2541
|
+
end
|
2542
|
+
allowable_values = ["ASC", "DESC"]
|
2543
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2544
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2545
|
+
end
|
2546
|
+
# resource path
|
2547
|
+
local_var_path = '/inboxes/{inboxId}/sent'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
2548
|
+
|
2549
|
+
# query parameters
|
2550
|
+
query_params = opts[:query_params] || {}
|
2551
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2552
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2553
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2554
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
2555
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2556
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
2557
|
+
|
2558
|
+
# header parameters
|
2559
|
+
header_params = opts[:header_params] || {}
|
2560
|
+
# HTTP header 'Accept' (if needed)
|
2561
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2562
|
+
|
2563
|
+
# form parameters
|
2564
|
+
form_params = opts[:form_params] || {}
|
2565
|
+
|
2566
|
+
# http body (model)
|
2567
|
+
post_body = opts[:body]
|
2568
|
+
|
2569
|
+
# return_type
|
2570
|
+
return_type = opts[:return_type] || 'PageSentEmailProjection'
|
2571
|
+
|
2572
|
+
# auth_names
|
2573
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2574
|
+
|
2575
|
+
new_options = opts.merge(
|
2576
|
+
:header_params => header_params,
|
2577
|
+
:query_params => query_params,
|
2578
|
+
:form_params => form_params,
|
2579
|
+
:body => post_body,
|
2580
|
+
:auth_names => auth_names,
|
2581
|
+
:return_type => return_type
|
2582
|
+
)
|
2583
|
+
|
2584
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2585
|
+
if @api_client.config.debugging
|
2586
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_sent_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2587
|
+
end
|
2588
|
+
return data, status_code, headers
|
2589
|
+
end
|
2590
|
+
|
2591
|
+
# Get inbox tags
|
2592
|
+
# Get all inbox tags
|
2593
|
+
# @param [Hash] opts the optional parameters
|
2594
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
2595
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
2596
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2597
|
+
# @option opts [String] :search_filter Optional search filter
|
2598
|
+
# @return [Array<String>]
|
2599
|
+
def get_inbox_tags(opts = {})
|
2600
|
+
data, _status_code, _headers = get_inbox_tags_with_http_info(opts)
|
2601
|
+
data
|
2602
|
+
end
|
2603
|
+
|
2604
|
+
# Get inbox tags
|
2605
|
+
# Get all inbox tags
|
2606
|
+
# @param [Hash] opts the optional parameters
|
2607
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
2608
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
2609
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2610
|
+
# @option opts [String] :search_filter Optional search filter
|
2611
|
+
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
2612
|
+
def get_inbox_tags_with_http_info(opts = {})
|
2613
|
+
if @api_client.config.debugging
|
2614
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags ...'
|
2615
|
+
end
|
2616
|
+
allowable_values = ["ASC", "DESC"]
|
2617
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2618
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2619
|
+
end
|
2620
|
+
# resource path
|
2621
|
+
local_var_path = '/inboxes/tags'
|
2622
|
+
|
2623
|
+
# query parameters
|
2624
|
+
query_params = opts[:query_params] || {}
|
2625
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2626
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2627
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2628
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
2629
|
+
|
2630
|
+
# header parameters
|
2631
|
+
header_params = opts[:header_params] || {}
|
2632
|
+
# HTTP header 'Accept' (if needed)
|
2633
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2634
|
+
|
2635
|
+
# form parameters
|
2636
|
+
form_params = opts[:form_params] || {}
|
2637
|
+
|
2638
|
+
# http body (model)
|
2639
|
+
post_body = opts[:body]
|
2640
|
+
|
2641
|
+
# return_type
|
2642
|
+
return_type = opts[:return_type] || 'Array<String>'
|
2643
|
+
|
2644
|
+
# auth_names
|
2645
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2646
|
+
|
2647
|
+
new_options = opts.merge(
|
2648
|
+
:header_params => header_params,
|
2649
|
+
:query_params => query_params,
|
2650
|
+
:form_params => form_params,
|
2651
|
+
:body => post_body,
|
2652
|
+
:auth_names => auth_names,
|
2653
|
+
:return_type => return_type
|
2654
|
+
)
|
2655
|
+
|
2656
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2657
|
+
if @api_client.config.debugging
|
2658
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2659
|
+
end
|
2660
|
+
return data, status_code, headers
|
2661
|
+
end
|
2662
|
+
|
2663
|
+
# Get inbox tags paginated
|
2664
|
+
# Get all inbox tags paginated
|
2665
|
+
# @param [Hash] opts the optional parameters
|
2666
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
2667
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
2668
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2669
|
+
# @option opts [String] :search_filter Optional search filter
|
2670
|
+
# @return [PageInboxTags]
|
2671
|
+
def get_inbox_tags_paginated(opts = {})
|
2672
|
+
data, _status_code, _headers = get_inbox_tags_paginated_with_http_info(opts)
|
2673
|
+
data
|
2674
|
+
end
|
2675
|
+
|
2676
|
+
# Get inbox tags paginated
|
2677
|
+
# Get all inbox tags paginated
|
2678
|
+
# @param [Hash] opts the optional parameters
|
2679
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
2680
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
2681
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2682
|
+
# @option opts [String] :search_filter Optional search filter
|
2683
|
+
# @return [Array<(PageInboxTags, Integer, Hash)>] PageInboxTags data, response status code and response headers
|
2684
|
+
def get_inbox_tags_paginated_with_http_info(opts = {})
|
2685
|
+
if @api_client.config.debugging
|
2686
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags_paginated ...'
|
2687
|
+
end
|
2688
|
+
allowable_values = ["ASC", "DESC"]
|
2689
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2690
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2691
|
+
end
|
2692
|
+
# resource path
|
2693
|
+
local_var_path = '/inboxes/tags/paginated'
|
2694
|
+
|
2695
|
+
# query parameters
|
2696
|
+
query_params = opts[:query_params] || {}
|
2697
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2698
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2699
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2700
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
2701
|
+
|
2702
|
+
# header parameters
|
2703
|
+
header_params = opts[:header_params] || {}
|
2704
|
+
# HTTP header 'Accept' (if needed)
|
2705
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2706
|
+
|
2707
|
+
# form parameters
|
2708
|
+
form_params = opts[:form_params] || {}
|
2709
|
+
|
2710
|
+
# http body (model)
|
2711
|
+
post_body = opts[:body]
|
2712
|
+
|
2713
|
+
# return_type
|
2714
|
+
return_type = opts[:return_type] || 'PageInboxTags'
|
2715
|
+
|
2716
|
+
# auth_names
|
2717
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2718
|
+
|
2719
|
+
new_options = opts.merge(
|
2720
|
+
:header_params => header_params,
|
2721
|
+
:query_params => query_params,
|
2722
|
+
:form_params => form_params,
|
2723
|
+
:body => post_body,
|
2724
|
+
:auth_names => auth_names,
|
2725
|
+
:return_type => return_type
|
2726
|
+
)
|
2727
|
+
|
2728
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2729
|
+
if @api_client.config.debugging
|
2730
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2731
|
+
end
|
2732
|
+
return data, status_code, headers
|
2733
|
+
end
|
2734
|
+
|
2735
|
+
# List Inboxes and email addresses
|
2736
|
+
# List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.
|
2737
|
+
# @param [Hash] opts the optional parameters
|
2738
|
+
# @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (default to 100)
|
2739
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2740
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
2741
|
+
# @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
|
2742
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
2743
|
+
# @option opts [Array<String>] :include Optional inboxIds to include in result
|
2744
|
+
# @return [Array<InboxDto>]
|
2745
|
+
def get_inboxes(opts = {})
|
2746
|
+
data, _status_code, _headers = get_inboxes_with_http_info(opts)
|
2747
|
+
data
|
2748
|
+
end
|
2749
|
+
|
2750
|
+
# List Inboxes and email addresses
|
2751
|
+
# List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.
|
2752
|
+
# @param [Hash] opts the optional parameters
|
2753
|
+
# @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries.
|
2754
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2755
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
2756
|
+
# @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
|
2757
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
2758
|
+
# @option opts [Array<String>] :include Optional inboxIds to include in result
|
2759
|
+
# @return [Array<(Array<InboxDto>, Integer, Hash)>] Array<InboxDto> data, response status code and response headers
|
2760
|
+
def get_inboxes_with_http_info(opts = {})
|
2761
|
+
if @api_client.config.debugging
|
2762
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...'
|
2763
|
+
end
|
2764
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
2765
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InboxControllerApi.get_inboxes, must be smaller than or equal to 100.'
|
2766
|
+
end
|
2767
|
+
|
2768
|
+
allowable_values = ["ASC", "DESC"]
|
2769
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2770
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2771
|
+
end
|
2772
|
+
# resource path
|
2773
|
+
local_var_path = '/inboxes'
|
2774
|
+
|
2775
|
+
# query parameters
|
2776
|
+
query_params = opts[:query_params] || {}
|
2777
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2778
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2779
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
2780
|
+
query_params[:'excludeCatchAllInboxes'] = opts[:'exclude_catch_all_inboxes'] if !opts[:'exclude_catch_all_inboxes'].nil?
|
2781
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
2782
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
|
2783
|
+
|
2784
|
+
# header parameters
|
2785
|
+
header_params = opts[:header_params] || {}
|
2786
|
+
# HTTP header 'Accept' (if needed)
|
2787
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2788
|
+
|
2789
|
+
# form parameters
|
2790
|
+
form_params = opts[:form_params] || {}
|
2791
|
+
|
2792
|
+
# http body (model)
|
2793
|
+
post_body = opts[:body]
|
2794
|
+
|
2795
|
+
# return_type
|
2796
|
+
return_type = opts[:return_type] || 'Array<InboxDto>'
|
2797
|
+
|
2798
|
+
# auth_names
|
2799
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2800
|
+
|
2801
|
+
new_options = opts.merge(
|
2802
|
+
:header_params => header_params,
|
2803
|
+
:query_params => query_params,
|
2804
|
+
:form_params => form_params,
|
2805
|
+
:body => post_body,
|
2806
|
+
:auth_names => auth_names,
|
2807
|
+
:return_type => return_type
|
2808
|
+
)
|
2809
|
+
|
2810
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2811
|
+
if @api_client.config.debugging
|
2812
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2813
|
+
end
|
2814
|
+
return data, status_code, headers
|
2815
|
+
end
|
2816
|
+
|
2817
|
+
# Get inboxes for a tag
|
2818
|
+
# Get all inboxes for a given inbox tag
|
2819
|
+
# @param tag [String] Tag to filter by
|
2820
|
+
# @param [Hash] opts the optional parameters
|
2821
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
2822
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
2823
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2824
|
+
# @option opts [String] :search_filter Optional search filter
|
2825
|
+
# @return [PageInboxProjection]
|
2826
|
+
def get_inboxes_by_tag(tag, opts = {})
|
2827
|
+
data, _status_code, _headers = get_inboxes_by_tag_with_http_info(tag, opts)
|
2828
|
+
data
|
2829
|
+
end
|
2830
|
+
|
2831
|
+
# Get inboxes for a tag
|
2832
|
+
# Get all inboxes for a given inbox tag
|
2833
|
+
# @param tag [String] Tag to filter by
|
2834
|
+
# @param [Hash] opts the optional parameters
|
2835
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
2836
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
2837
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2838
|
+
# @option opts [String] :search_filter Optional search filter
|
2839
|
+
# @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
|
2840
|
+
def get_inboxes_by_tag_with_http_info(tag, opts = {})
|
2841
|
+
if @api_client.config.debugging
|
2842
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes_by_tag ...'
|
2843
|
+
end
|
2844
|
+
# verify the required parameter 'tag' is set
|
2845
|
+
if @api_client.config.client_side_validation && tag.nil?
|
2846
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling InboxControllerApi.get_inboxes_by_tag"
|
2847
|
+
end
|
2848
|
+
allowable_values = ["ASC", "DESC"]
|
2849
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2850
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2851
|
+
end
|
2852
|
+
# resource path
|
2853
|
+
local_var_path = '/inboxes/tags/inboxes'
|
2854
|
+
|
2855
|
+
# query parameters
|
2856
|
+
query_params = opts[:query_params] || {}
|
2857
|
+
query_params[:'tag'] = tag
|
2858
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2859
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
2860
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2861
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
2862
|
+
|
2863
|
+
# header parameters
|
2864
|
+
header_params = opts[:header_params] || {}
|
2865
|
+
# HTTP header 'Accept' (if needed)
|
2866
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2867
|
+
|
2868
|
+
# form parameters
|
2869
|
+
form_params = opts[:form_params] || {}
|
2870
|
+
|
2871
|
+
# http body (model)
|
2872
|
+
post_body = opts[:body]
|
2873
|
+
|
2874
|
+
# return_type
|
2875
|
+
return_type = opts[:return_type] || 'PageInboxProjection'
|
2876
|
+
|
2877
|
+
# auth_names
|
2878
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2879
|
+
|
2880
|
+
new_options = opts.merge(
|
2881
|
+
:header_params => header_params,
|
2882
|
+
:query_params => query_params,
|
2883
|
+
:form_params => form_params,
|
2884
|
+
:body => post_body,
|
2885
|
+
:auth_names => auth_names,
|
2886
|
+
:return_type => return_type
|
2887
|
+
)
|
2888
|
+
|
2889
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2890
|
+
if @api_client.config.debugging
|
2891
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_inboxes_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2892
|
+
end
|
2893
|
+
return data, status_code, headers
|
2894
|
+
end
|
2895
|
+
|
2896
|
+
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
2897
|
+
# Get the newest email in an inbox or wait for one to arrive
|
2898
|
+
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
2899
|
+
# @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
|
2900
|
+
# @param [Hash] opts the optional parameters
|
2901
|
+
# @return [Email]
|
2902
|
+
def get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {})
|
2903
|
+
data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts)
|
2904
|
+
data
|
2905
|
+
end
|
2906
|
+
|
2907
|
+
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
2908
|
+
# Get the newest email in an inbox or wait for one to arrive
|
2909
|
+
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
2910
|
+
# @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
|
2911
|
+
# @param [Hash] opts the optional parameters
|
2912
|
+
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
2913
|
+
def get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {})
|
2914
|
+
if @api_client.config.debugging
|
2915
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_latest_email_in_inbox ...'
|
2916
|
+
end
|
2917
|
+
# verify the required parameter 'inbox_id' is set
|
2918
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
2919
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_latest_email_in_inbox"
|
2920
|
+
end
|
2921
|
+
# verify the required parameter 'timeout_millis' is set
|
2922
|
+
if @api_client.config.client_side_validation && timeout_millis.nil?
|
2923
|
+
fail ArgumentError, "Missing the required parameter 'timeout_millis' when calling InboxControllerApi.get_latest_email_in_inbox"
|
2924
|
+
end
|
2925
|
+
# resource path
|
2926
|
+
local_var_path = '/inboxes/getLatestEmail'
|
2927
|
+
|
2928
|
+
# query parameters
|
2929
|
+
query_params = opts[:query_params] || {}
|
2930
|
+
query_params[:'inboxId'] = inbox_id
|
2931
|
+
query_params[:'timeoutMillis'] = timeout_millis
|
2932
|
+
|
2933
|
+
# header parameters
|
2934
|
+
header_params = opts[:header_params] || {}
|
2935
|
+
# HTTP header 'Accept' (if needed)
|
2936
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2937
|
+
|
2938
|
+
# form parameters
|
2939
|
+
form_params = opts[:form_params] || {}
|
2940
|
+
|
2941
|
+
# http body (model)
|
2942
|
+
post_body = opts[:body]
|
2943
|
+
|
2944
|
+
# return_type
|
2945
|
+
return_type = opts[:return_type] || 'Email'
|
2946
|
+
|
2947
|
+
# auth_names
|
2948
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2949
|
+
|
2950
|
+
new_options = opts.merge(
|
2951
|
+
:header_params => header_params,
|
2952
|
+
:query_params => query_params,
|
2953
|
+
:form_params => form_params,
|
2954
|
+
:body => post_body,
|
2955
|
+
:auth_names => auth_names,
|
2956
|
+
:return_type => return_type
|
2957
|
+
)
|
2958
|
+
|
2959
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2960
|
+
if @api_client.config.debugging
|
2961
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_latest_email_in_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2962
|
+
end
|
2963
|
+
return data, status_code, headers
|
2964
|
+
end
|
2965
|
+
|
2966
|
+
# List Organization Inboxes Paginated
|
2967
|
+
# List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
|
2968
|
+
# @param [Hash] opts the optional parameters
|
2969
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
2970
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
2971
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
2972
|
+
# @option opts [String] :search_filter Optional search filter
|
2973
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
2974
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
2975
|
+
# @return [PageOrganizationInboxProjection]
|
2976
|
+
def get_organization_inboxes(opts = {})
|
2977
|
+
data, _status_code, _headers = get_organization_inboxes_with_http_info(opts)
|
2978
|
+
data
|
2979
|
+
end
|
2980
|
+
|
2981
|
+
# List Organization Inboxes Paginated
|
2982
|
+
# List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
|
2983
|
+
# @param [Hash] opts the optional parameters
|
2984
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
2985
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
2986
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
2987
|
+
# @option opts [String] :search_filter Optional search filter
|
2988
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
2989
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
2990
|
+
# @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
|
2991
|
+
def get_organization_inboxes_with_http_info(opts = {})
|
2992
|
+
if @api_client.config.debugging
|
2993
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_organization_inboxes ...'
|
2994
|
+
end
|
2995
|
+
allowable_values = ["ASC", "DESC"]
|
2996
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2997
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2998
|
+
end
|
2999
|
+
# resource path
|
3000
|
+
local_var_path = '/inboxes/organization'
|
3001
|
+
|
3002
|
+
# query parameters
|
3003
|
+
query_params = opts[:query_params] || {}
|
3004
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
3005
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
3006
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3007
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
3008
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
3009
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
3010
|
+
|
3011
|
+
# header parameters
|
3012
|
+
header_params = opts[:header_params] || {}
|
3013
|
+
# HTTP header 'Accept' (if needed)
|
3014
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
3015
|
+
|
3016
|
+
# form parameters
|
3017
|
+
form_params = opts[:form_params] || {}
|
3018
|
+
|
3019
|
+
# http body (model)
|
3020
|
+
post_body = opts[:body]
|
3021
|
+
|
3022
|
+
# return_type
|
3023
|
+
return_type = opts[:return_type] || 'PageOrganizationInboxProjection'
|
3024
|
+
|
3025
|
+
# auth_names
|
3026
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
3027
|
+
|
3028
|
+
new_options = opts.merge(
|
3029
|
+
:header_params => header_params,
|
3030
|
+
:query_params => query_params,
|
3031
|
+
:form_params => form_params,
|
3032
|
+
:body => post_body,
|
3033
|
+
:auth_names => auth_names,
|
3034
|
+
:return_type => return_type
|
3035
|
+
)
|
3036
|
+
|
3037
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3038
|
+
if @api_client.config.debugging
|
3039
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_organization_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3040
|
+
end
|
3041
|
+
return data, status_code, headers
|
3042
|
+
end
|
3043
|
+
|
3044
|
+
# List all inboxes with sent emails
|
3045
|
+
# List inboxes that have sent emails
|
3046
|
+
# @param [Hash] opts the optional parameters
|
3047
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
3048
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
3049
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
3050
|
+
# @return [PageInboxProjection]
|
3051
|
+
def get_outboxes(opts = {})
|
3052
|
+
data, _status_code, _headers = get_outboxes_with_http_info(opts)
|
3053
|
+
data
|
3054
|
+
end
|
3055
|
+
|
3056
|
+
# List all inboxes with sent emails
|
3057
|
+
# List inboxes that have sent emails
|
3058
|
+
# @param [Hash] opts the optional parameters
|
3059
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
3060
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
3061
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
3062
|
+
# @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
|
3063
|
+
def get_outboxes_with_http_info(opts = {})
|
3064
|
+
if @api_client.config.debugging
|
3065
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_outboxes ...'
|
3066
|
+
end
|
3067
|
+
allowable_values = ["ASC", "DESC"]
|
3068
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3069
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3070
|
+
end
|
3071
|
+
# resource path
|
3072
|
+
local_var_path = '/inboxes/outboxes'
|
3073
|
+
|
3074
|
+
# query parameters
|
3075
|
+
query_params = opts[:query_params] || {}
|
3076
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
3077
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
3078
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3079
|
+
|
3080
|
+
# header parameters
|
3081
|
+
header_params = opts[:header_params] || {}
|
3082
|
+
# HTTP header 'Accept' (if needed)
|
3083
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
3084
|
+
|
3085
|
+
# form parameters
|
3086
|
+
form_params = opts[:form_params] || {}
|
3087
|
+
|
3088
|
+
# http body (model)
|
3089
|
+
post_body = opts[:body]
|
3090
|
+
|
3091
|
+
# return_type
|
3092
|
+
return_type = opts[:return_type] || 'PageInboxProjection'
|
3093
|
+
|
3094
|
+
# auth_names
|
3095
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
3096
|
+
|
3097
|
+
new_options = opts.merge(
|
3098
|
+
:header_params => header_params,
|
3099
|
+
:query_params => query_params,
|
3100
|
+
:form_params => form_params,
|
3101
|
+
:body => post_body,
|
3102
|
+
:auth_names => auth_names,
|
3103
|
+
:return_type => return_type
|
3104
|
+
)
|
3105
|
+
|
3106
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3107
|
+
if @api_client.config.debugging
|
3108
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_outboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2349
3109
|
end
|
2350
3110
|
return data, status_code, headers
|
2351
3111
|
end
|
@@ -3268,7 +4028,7 @@ module MailSlurpClient
|
|
3268
4028
|
end
|
3269
4029
|
|
3270
4030
|
# Set inbox favourited state
|
3271
|
-
# Set and return new
|
4031
|
+
# Set and return new favorite state for an inbox
|
3272
4032
|
# @param inbox_id [String] ID of inbox to set favourite state
|
3273
4033
|
# @param set_inbox_favourited_options [SetInboxFavouritedOptions]
|
3274
4034
|
# @param [Hash] opts the optional parameters
|
@@ -3279,7 +4039,7 @@ module MailSlurpClient
|
|
3279
4039
|
end
|
3280
4040
|
|
3281
4041
|
# Set inbox favourited state
|
3282
|
-
# Set and return new
|
4042
|
+
# Set and return new favorite state for an inbox
|
3283
4043
|
# @param inbox_id [String] ID of inbox to set favourite state
|
3284
4044
|
# @param set_inbox_favourited_options [SetInboxFavouritedOptions]
|
3285
4045
|
# @param [Hash] opts the optional parameters
|