ark-email 0.18.0 → 0.19.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/CHANGELOG.md +22 -0
- data/README.md +9 -9
- data/lib/ark_email/client.rb +8 -16
- data/lib/ark_email/internal/util.rb +1 -1
- data/lib/ark_email/models/email_counts.rb +58 -0
- data/lib/ark_email/models/email_rates.rb +26 -0
- data/lib/ark_email/models/email_retrieve_deliveries_response.rb +2 -2
- data/lib/ark_email/models/{webhook_delete_params.rb → limit_retrieve_params.rb} +2 -2
- data/lib/ark_email/models/{tracking_retrieve_response.rb → limit_retrieve_response.rb} +10 -5
- data/lib/ark_email/models/limits_data.rb +234 -0
- data/lib/ark_email/models/org_usage_summary.rb +93 -0
- data/lib/ark_email/models/platform/webhook_create_params.rb +57 -0
- data/lib/ark_email/models/platform/webhook_create_response.rb +105 -0
- data/lib/ark_email/models/platform/webhook_delete_params.rb +16 -0
- data/lib/ark_email/models/platform/webhook_delete_response.rb +41 -0
- data/lib/ark_email/models/platform/webhook_list_deliveries_params.rb +97 -0
- data/lib/ark_email/models/platform/webhook_list_deliveries_response.rb +112 -0
- data/lib/ark_email/models/platform/webhook_list_params.rb +16 -0
- data/lib/ark_email/models/platform/webhook_list_response.rb +77 -0
- data/lib/ark_email/models/platform/webhook_replay_delivery_params.rb +16 -0
- data/lib/ark_email/models/platform/webhook_replay_delivery_response.rb +84 -0
- data/lib/ark_email/models/platform/webhook_retrieve_delivery_params.rb +16 -0
- data/lib/ark_email/models/platform/webhook_retrieve_delivery_response.rb +182 -0
- data/lib/ark_email/models/platform/webhook_retrieve_params.rb +16 -0
- data/lib/ark_email/models/platform/webhook_retrieve_response.rb +105 -0
- data/lib/ark_email/models/platform/webhook_test_params.rb +41 -0
- data/lib/ark_email/models/platform/webhook_test_response.rb +66 -0
- data/lib/ark_email/models/platform/webhook_update_params.rb +65 -0
- data/lib/ark_email/models/platform/webhook_update_response.rb +105 -0
- data/lib/ark_email/models/tenant.rb +2 -2
- data/lib/ark_email/models/tenant_usage_item.rb +73 -0
- data/lib/ark_email/models/tenants/credential_create_params.rb +53 -0
- data/lib/ark_email/models/tenants/credential_create_response.rb +131 -0
- data/lib/ark_email/models/tenants/credential_delete_params.rb +22 -0
- data/lib/ark_email/models/tenants/credential_delete_response.rb +41 -0
- data/lib/ark_email/models/tenants/credential_list_params.rb +51 -0
- data/lib/ark_email/models/tenants/credential_list_response.rb +90 -0
- data/lib/ark_email/models/tenants/credential_retrieve_params.rb +31 -0
- data/lib/ark_email/models/tenants/credential_retrieve_response.rb +133 -0
- data/lib/ark_email/models/tenants/credential_update_params.rb +43 -0
- data/lib/ark_email/models/tenants/credential_update_response.rb +133 -0
- data/lib/ark_email/models/tenants/dns_record.rb +113 -0
- data/lib/ark_email/models/tenants/domain_create_params.rb +24 -0
- data/lib/ark_email/models/tenants/domain_create_response.rb +221 -0
- data/lib/ark_email/models/tenants/domain_delete_params.rb +22 -0
- data/lib/ark_email/models/tenants/domain_delete_response.rb +41 -0
- data/lib/ark_email/models/tenants/domain_list_params.rb +16 -0
- data/lib/ark_email/models/tenants/domain_list_response.rb +89 -0
- data/lib/ark_email/models/tenants/domain_retrieve_params.rb +22 -0
- data/lib/ark_email/models/tenants/domain_retrieve_response.rb +221 -0
- data/lib/ark_email/models/tenants/domain_verify_params.rb +22 -0
- data/lib/ark_email/models/tenants/domain_verify_response.rb +221 -0
- data/lib/ark_email/models/tenants/suppression_create_params.rb +32 -0
- data/lib/ark_email/models/tenants/suppression_create_response.rb +64 -0
- data/lib/ark_email/models/tenants/suppression_delete_params.rb +22 -0
- data/lib/ark_email/models/tenants/suppression_delete_response.rb +41 -0
- data/lib/ark_email/models/tenants/suppression_list_params.rb +28 -0
- data/lib/ark_email/models/tenants/suppression_list_response.rb +40 -0
- data/lib/ark_email/models/tenants/suppression_retrieve_params.rb +22 -0
- data/lib/ark_email/models/tenants/suppression_retrieve_response.rb +66 -0
- data/lib/ark_email/models/tenants/tenant_usage.rb +62 -0
- data/lib/ark_email/models/tenants/tenant_usage_timeseries.rb +130 -0
- data/lib/ark_email/models/tenants/track_domain.rb +186 -0
- data/lib/ark_email/models/tenants/tracking_create_params.rb +56 -0
- data/lib/ark_email/models/tenants/tracking_create_response.rb +30 -0
- data/lib/ark_email/models/tenants/tracking_delete_params.rb +22 -0
- data/lib/ark_email/models/tenants/tracking_delete_response.rb +41 -0
- data/lib/ark_email/models/tenants/tracking_list_params.rb +16 -0
- data/lib/ark_email/models/tenants/tracking_list_response.rb +43 -0
- data/lib/ark_email/models/tenants/tracking_retrieve_params.rb +22 -0
- data/lib/ark_email/models/tenants/tracking_retrieve_response.rb +30 -0
- data/lib/ark_email/models/tenants/tracking_update_params.rb +55 -0
- data/lib/ark_email/models/tenants/tracking_update_response.rb +30 -0
- data/lib/ark_email/models/tenants/tracking_verify_params.rb +22 -0
- data/lib/ark_email/models/tenants/tracking_verify_response.rb +135 -0
- data/lib/ark_email/models/tenants/usage_retrieve_params.rb +43 -0
- data/lib/ark_email/models/tenants/usage_retrieve_response.rb +35 -0
- data/lib/ark_email/models/tenants/usage_retrieve_timeseries_params.rb +53 -0
- data/lib/ark_email/models/tenants/usage_retrieve_timeseries_response.rb +35 -0
- data/lib/ark_email/models/tenants/webhook_create_params.rb +88 -0
- data/lib/ark_email/models/tenants/webhook_create_response.rb +113 -0
- data/lib/ark_email/models/tenants/webhook_delete_params.rb +22 -0
- data/lib/ark_email/models/tenants/webhook_delete_response.rb +41 -0
- data/lib/ark_email/models/tenants/webhook_list_deliveries_params.rb +88 -0
- data/lib/ark_email/models/tenants/webhook_list_deliveries_response.rb +156 -0
- data/lib/ark_email/models/tenants/webhook_list_params.rb +16 -0
- data/lib/ark_email/models/tenants/webhook_list_response.rb +81 -0
- data/lib/ark_email/models/tenants/webhook_replay_delivery_params.rb +28 -0
- data/lib/ark_email/models/tenants/webhook_replay_delivery_response.rb +84 -0
- data/lib/ark_email/models/tenants/webhook_retrieve_delivery_params.rb +28 -0
- data/lib/ark_email/models/tenants/webhook_retrieve_delivery_response.rb +200 -0
- data/lib/ark_email/models/tenants/webhook_retrieve_params.rb +22 -0
- data/lib/ark_email/models/tenants/webhook_retrieve_response.rb +113 -0
- data/lib/ark_email/models/tenants/webhook_test_params.rb +48 -0
- data/lib/ark_email/models/tenants/webhook_test_response.rb +82 -0
- data/lib/ark_email/models/tenants/webhook_update_params.rb +52 -0
- data/lib/ark_email/models/tenants/webhook_update_response.rb +113 -0
- data/lib/ark_email/models/usage_export_params.rb +86 -0
- data/lib/ark_email/models/usage_export_response.rb +123 -0
- data/lib/ark_email/models/usage_list_tenants_params.rb +111 -0
- data/lib/ark_email/models/usage_period.rb +26 -0
- data/lib/ark_email/models/usage_retrieve_params.rb +27 -1
- data/lib/ark_email/models.rb +15 -47
- data/lib/ark_email/resources/emails.rb +18 -18
- data/lib/ark_email/resources/limits.rb +48 -0
- data/lib/ark_email/resources/platform/webhooks.rb +289 -0
- data/lib/ark_email/resources/platform.rb +18 -0
- data/lib/ark_email/resources/tenants/credentials.rb +194 -0
- data/lib/ark_email/resources/tenants/domains.rb +159 -0
- data/lib/ark_email/resources/tenants/suppressions.rb +126 -0
- data/lib/ark_email/resources/tenants/tracking.rb +203 -0
- data/lib/ark_email/resources/tenants/usage.rb +107 -0
- data/lib/ark_email/resources/tenants/webhooks.rb +363 -0
- data/lib/ark_email/resources/tenants.rb +24 -0
- data/lib/ark_email/resources/usage.rb +142 -17
- data/lib/ark_email/version.rb +1 -1
- data/lib/ark_email.rb +104 -57
- data/rbi/ark_email/client.rbi +6 -12
- data/rbi/ark_email/internal/util.rbi +1 -1
- data/rbi/ark_email/models/email_counts.rbi +78 -0
- data/rbi/ark_email/models/email_rates.rbi +38 -0
- data/rbi/ark_email/models/email_retrieve_deliveries_response.rbi +2 -2
- data/rbi/ark_email/models/{webhook_delete_params.rbi → limit_retrieve_params.rbi} +2 -2
- data/rbi/ark_email/models/{tracking_update_response.rbi → limit_retrieve_response.rbi} +14 -7
- data/rbi/ark_email/models/limits_data.rbi +374 -0
- data/rbi/ark_email/models/org_usage_summary.rbi +165 -0
- data/rbi/ark_email/models/platform/webhook_create_params.rbi +145 -0
- data/rbi/ark_email/models/platform/webhook_create_response.rbi +215 -0
- data/rbi/ark_email/models/platform/webhook_delete_params.rbi +32 -0
- data/rbi/ark_email/models/platform/webhook_delete_response.rbi +81 -0
- data/rbi/ark_email/models/platform/webhook_list_deliveries_params.rbi +206 -0
- data/rbi/ark_email/models/platform/webhook_list_deliveries_response.rbi +186 -0
- data/rbi/ark_email/models/platform/webhook_list_params.rbi +32 -0
- data/rbi/ark_email/models/platform/webhook_list_response.rbi +124 -0
- data/rbi/ark_email/models/platform/webhook_replay_delivery_params.rbi +32 -0
- data/rbi/ark_email/models/platform/webhook_replay_delivery_response.rbi +141 -0
- data/rbi/ark_email/models/platform/webhook_retrieve_delivery_params.rbi +32 -0
- data/rbi/ark_email/models/platform/webhook_retrieve_delivery_response.rbi +315 -0
- data/rbi/ark_email/models/platform/webhook_retrieve_params.rbi +32 -0
- data/rbi/ark_email/models/platform/webhook_retrieve_response.rbi +217 -0
- data/rbi/ark_email/models/platform/webhook_test_params.rbi +110 -0
- data/rbi/ark_email/models/platform/webhook_test_response.rbi +117 -0
- data/rbi/ark_email/models/platform/webhook_update_params.rbi +162 -0
- data/rbi/ark_email/models/platform/webhook_update_response.rbi +215 -0
- data/rbi/ark_email/models/tenant_usage_item.rbi +107 -0
- data/rbi/ark_email/models/tenants/credential_create_params.rbi +101 -0
- data/rbi/ark_email/models/tenants/credential_create_response.rbi +220 -0
- data/rbi/ark_email/models/tenants/credential_delete_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/credential_delete_response.rbi +83 -0
- data/rbi/ark_email/models/tenants/credential_list_params.rbi +113 -0
- data/rbi/ark_email/models/tenants/credential_list_response.rbi +142 -0
- data/rbi/ark_email/models/tenants/credential_retrieve_params.rbi +57 -0
- data/rbi/ark_email/models/tenants/credential_retrieve_response.rbi +227 -0
- data/rbi/ark_email/models/tenants/credential_update_params.rbi +70 -0
- data/rbi/ark_email/models/tenants/credential_update_response.rbi +227 -0
- data/rbi/ark_email/models/tenants/dns_record.rbi +161 -0
- data/rbi/ark_email/models/tenants/domain_create_params.rbi +45 -0
- data/rbi/ark_email/models/tenants/domain_create_response.rbi +388 -0
- data/rbi/ark_email/models/tenants/domain_delete_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/domain_delete_response.rbi +79 -0
- data/rbi/ark_email/models/tenants/domain_list_params.rbi +32 -0
- data/rbi/ark_email/models/tenants/domain_list_response.rbi +176 -0
- data/rbi/ark_email/models/tenants/domain_retrieve_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/domain_retrieve_response.rbi +390 -0
- data/rbi/ark_email/models/tenants/domain_verify_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/domain_verify_response.rbi +388 -0
- data/rbi/ark_email/models/tenants/suppression_create_params.rbi +56 -0
- data/rbi/ark_email/models/tenants/suppression_create_response.rbi +115 -0
- data/rbi/ark_email/models/tenants/suppression_delete_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/suppression_delete_response.rbi +83 -0
- data/rbi/ark_email/models/tenants/suppression_list_params.rbi +54 -0
- data/rbi/ark_email/models/tenants/suppression_list_response.rbi +58 -0
- data/rbi/ark_email/models/tenants/suppression_retrieve_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/suppression_retrieve_response.rbi +122 -0
- data/rbi/ark_email/models/tenants/tenant_usage.rbi +91 -0
- data/rbi/ark_email/models/tenants/tenant_usage_timeseries.rbi +218 -0
- data/rbi/ark_email/models/tenants/track_domain.rbi +255 -0
- data/rbi/ark_email/models/tenants/tracking_create_params.rbi +80 -0
- data/rbi/ark_email/models/tenants/tracking_create_response.rbi +54 -0
- data/rbi/ark_email/models/tenants/tracking_delete_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/tracking_delete_response.rbi +81 -0
- data/rbi/ark_email/models/tenants/tracking_list_params.rbi +32 -0
- data/rbi/ark_email/models/tenants/tracking_list_response.rbi +87 -0
- data/rbi/ark_email/models/tenants/tracking_retrieve_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/tracking_retrieve_response.rbi +54 -0
- data/rbi/ark_email/models/tenants/tracking_update_params.rbi +78 -0
- data/rbi/ark_email/models/tenants/tracking_update_response.rbi +54 -0
- data/rbi/ark_email/models/tenants/tracking_verify_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/tracking_verify_response.rbi +260 -0
- data/rbi/ark_email/models/tenants/usage_retrieve_params.rbi +78 -0
- data/rbi/ark_email/models/tenants/usage_retrieve_response.rbi +61 -0
- data/rbi/ark_email/models/tenants/usage_retrieve_timeseries_params.rbi +131 -0
- data/rbi/ark_email/models/tenants/usage_retrieve_timeseries_response.rbi +63 -0
- data/rbi/ark_email/models/tenants/webhook_create_params.rbi +175 -0
- data/rbi/ark_email/models/tenants/webhook_create_response.rbi +222 -0
- data/rbi/ark_email/models/tenants/webhook_delete_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/webhook_delete_response.rbi +80 -0
- data/rbi/ark_email/models/tenants/webhook_list_deliveries_params.rbi +190 -0
- data/rbi/ark_email/models/tenants/webhook_list_deliveries_response.rbi +265 -0
- data/rbi/ark_email/models/tenants/webhook_list_params.rbi +32 -0
- data/rbi/ark_email/models/tenants/webhook_list_response.rbi +160 -0
- data/rbi/ark_email/models/tenants/webhook_replay_delivery_params.rbi +48 -0
- data/rbi/ark_email/models/tenants/webhook_replay_delivery_response.rbi +141 -0
- data/rbi/ark_email/models/tenants/webhook_retrieve_delivery_params.rbi +48 -0
- data/rbi/ark_email/models/tenants/webhook_retrieve_delivery_response.rbi +380 -0
- data/rbi/ark_email/models/tenants/webhook_retrieve_params.rbi +40 -0
- data/rbi/ark_email/models/tenants/webhook_retrieve_response.rbi +225 -0
- data/rbi/ark_email/models/tenants/webhook_test_params.rbi +116 -0
- data/rbi/ark_email/models/tenants/webhook_test_response.rbi +133 -0
- data/rbi/ark_email/models/tenants/webhook_update_params.rbi +76 -0
- data/rbi/ark_email/models/tenants/webhook_update_response.rbi +222 -0
- data/rbi/ark_email/models/usage_export_params.rbi +148 -0
- data/rbi/ark_email/models/usage_export_response.rbi +177 -0
- data/rbi/ark_email/models/usage_list_tenants_params.rbi +228 -0
- data/rbi/ark_email/models/usage_period.rbi +34 -0
- data/rbi/ark_email/models/usage_retrieve_params.rbi +49 -5
- data/rbi/ark_email/models.rbi +15 -48
- data/rbi/ark_email/resources/emails.rbi +12 -12
- data/rbi/ark_email/resources/limits.rbi +37 -0
- data/rbi/ark_email/resources/platform/webhooks.rbi +246 -0
- data/rbi/ark_email/resources/platform.rbi +15 -0
- data/rbi/ark_email/resources/tenants/credentials.rbi +154 -0
- data/rbi/ark_email/resources/tenants/domains.rbi +114 -0
- data/rbi/ark_email/resources/tenants/suppressions.rbi +93 -0
- data/rbi/ark_email/resources/tenants/tracking.rbi +153 -0
- data/rbi/ark_email/resources/tenants/usage.rbi +100 -0
- data/rbi/ark_email/resources/tenants/webhooks.rbi +295 -0
- data/rbi/ark_email/resources/tenants.rbi +18 -0
- data/rbi/ark_email/resources/usage.rbi +149 -16
- data/sig/ark_email/client.rbs +4 -8
- data/sig/ark_email/models/email_counts.rbs +45 -0
- data/sig/ark_email/models/email_rates.rbs +15 -0
- data/sig/ark_email/models/{webhook_delete_params.rbs → limit_retrieve_params.rbs} +2 -2
- data/sig/ark_email/models/{tracking_update_response.rbs → limit_retrieve_response.rbs} +6 -6
- data/sig/ark_email/models/limits_data.rbs +185 -0
- data/sig/ark_email/models/org_usage_summary.rbs +85 -0
- data/sig/ark_email/models/platform/webhook_create_params.rbs +67 -0
- data/sig/ark_email/models/platform/webhook_create_response.rbs +104 -0
- data/sig/ark_email/models/platform/webhook_delete_params.rbs +17 -0
- data/sig/ark_email/models/platform/webhook_delete_response.rbs +42 -0
- data/sig/ark_email/models/platform/webhook_list_deliveries_params.rbs +106 -0
- data/sig/ark_email/models/{webhook_list_deliveries_response.rbs → platform/webhook_list_deliveries_response.rbs} +13 -48
- data/sig/ark_email/models/platform/webhook_list_params.rbs +17 -0
- data/sig/ark_email/models/platform/webhook_list_response.rbs +74 -0
- data/sig/ark_email/models/platform/webhook_replay_delivery_params.rbs +17 -0
- data/sig/ark_email/models/platform/webhook_replay_delivery_response.rbs +74 -0
- data/sig/ark_email/models/platform/webhook_retrieve_delivery_params.rbs +17 -0
- data/sig/ark_email/models/platform/webhook_retrieve_delivery_response.rbs +146 -0
- data/sig/ark_email/models/platform/webhook_retrieve_params.rbs +17 -0
- data/sig/ark_email/models/platform/webhook_retrieve_response.rbs +104 -0
- data/sig/ark_email/models/platform/webhook_test_params.rbs +51 -0
- data/sig/ark_email/models/platform/webhook_test_response.rbs +64 -0
- data/sig/ark_email/models/platform/webhook_update_params.rbs +78 -0
- data/sig/ark_email/models/platform/webhook_update_response.rbs +104 -0
- data/sig/ark_email/models/tenant_usage_item.rbs +57 -0
- data/sig/ark_email/models/tenants/credential_create_params.rbs +44 -0
- data/sig/ark_email/models/tenants/credential_create_response.rbs +102 -0
- data/sig/ark_email/models/tenants/credential_delete_params.rbs +25 -0
- data/sig/ark_email/models/tenants/credential_delete_response.rbs +42 -0
- data/sig/ark_email/models/tenants/credential_list_params.rbs +57 -0
- data/sig/ark_email/models/tenants/credential_list_response.rbs +63 -0
- data/sig/ark_email/models/tenants/credential_retrieve_params.rbs +32 -0
- data/sig/ark_email/models/tenants/credential_retrieve_response.rbs +104 -0
- data/sig/ark_email/models/tenants/credential_update_params.rbs +38 -0
- data/sig/ark_email/models/tenants/credential_update_response.rbs +104 -0
- data/sig/ark_email/models/tenants/dns_record.rbs +66 -0
- data/sig/ark_email/models/tenants/domain_create_params.rbs +25 -0
- data/sig/ark_email/models/tenants/domain_create_response.rbs +127 -0
- data/sig/ark_email/models/tenants/domain_delete_params.rbs +25 -0
- data/sig/ark_email/models/tenants/domain_delete_response.rbs +42 -0
- data/sig/ark_email/models/tenants/domain_list_params.rbs +17 -0
- data/sig/ark_email/models/tenants/domain_list_response.rbs +90 -0
- data/sig/ark_email/models/tenants/domain_retrieve_params.rbs +25 -0
- data/sig/ark_email/models/tenants/domain_retrieve_response.rbs +127 -0
- data/sig/ark_email/models/tenants/domain_verify_params.rbs +25 -0
- data/sig/ark_email/models/tenants/domain_verify_response.rbs +127 -0
- data/sig/ark_email/models/tenants/suppression_create_params.rbs +30 -0
- data/sig/ark_email/models/tenants/suppression_create_response.rbs +61 -0
- data/sig/ark_email/models/tenants/suppression_delete_params.rbs +25 -0
- data/sig/ark_email/models/tenants/suppression_delete_response.rbs +42 -0
- data/sig/ark_email/models/tenants/suppression_list_params.rbs +34 -0
- data/sig/ark_email/models/tenants/suppression_list_response.rbs +34 -0
- data/sig/ark_email/models/tenants/suppression_retrieve_params.rbs +25 -0
- data/sig/ark_email/models/tenants/suppression_retrieve_response.rbs +64 -0
- data/sig/ark_email/models/tenants/tenant_usage.rbs +49 -0
- data/sig/ark_email/models/tenants/tenant_usage_timeseries.rbs +104 -0
- data/sig/ark_email/models/tenants/track_domain.rbs +124 -0
- data/sig/ark_email/models/tenants/tracking_create_params.rbs +48 -0
- data/sig/ark_email/models/tenants/tracking_create_response.rbs +32 -0
- data/sig/ark_email/models/tenants/tracking_delete_params.rbs +25 -0
- data/sig/ark_email/models/tenants/tracking_delete_response.rbs +42 -0
- data/sig/ark_email/models/tenants/tracking_list_params.rbs +17 -0
- data/sig/ark_email/models/tenants/tracking_list_response.rbs +46 -0
- data/sig/ark_email/models/tenants/tracking_retrieve_params.rbs +25 -0
- data/sig/ark_email/models/tenants/tracking_retrieve_response.rbs +32 -0
- data/sig/ark_email/models/tenants/tracking_update_params.rbs +48 -0
- data/sig/ark_email/models/tenants/tracking_update_response.rbs +32 -0
- data/sig/ark_email/models/tenants/tracking_verify_params.rbs +25 -0
- data/sig/ark_email/models/tenants/tracking_verify_response.rbs +115 -0
- data/sig/ark_email/models/tenants/usage_retrieve_params.rbs +34 -0
- data/sig/ark_email/models/tenants/usage_retrieve_response.rbs +32 -0
- data/sig/ark_email/models/tenants/usage_retrieve_timeseries_params.rbs +59 -0
- data/sig/ark_email/models/tenants/usage_retrieve_timeseries_response.rbs +32 -0
- data/sig/ark_email/models/tenants/webhook_create_params.rbs +73 -0
- data/sig/ark_email/models/tenants/webhook_create_response.rbs +109 -0
- data/sig/ark_email/models/tenants/webhook_delete_params.rbs +25 -0
- data/sig/ark_email/models/tenants/webhook_delete_response.rbs +42 -0
- data/sig/ark_email/models/tenants/webhook_list_deliveries_params.rbs +97 -0
- data/sig/ark_email/models/tenants/webhook_list_deliveries_response.rbs +129 -0
- data/sig/ark_email/models/tenants/webhook_list_params.rbs +17 -0
- data/sig/ark_email/models/tenants/webhook_list_response.rbs +86 -0
- data/sig/ark_email/models/tenants/webhook_replay_delivery_params.rbs +30 -0
- data/sig/ark_email/models/tenants/webhook_replay_delivery_response.rbs +74 -0
- data/sig/ark_email/models/tenants/webhook_retrieve_delivery_params.rbs +30 -0
- data/sig/ark_email/models/tenants/webhook_retrieve_delivery_response.rbs +160 -0
- data/sig/ark_email/models/tenants/webhook_retrieve_params.rbs +25 -0
- data/sig/ark_email/models/tenants/webhook_retrieve_response.rbs +109 -0
- data/sig/ark_email/models/tenants/webhook_test_params.rbs +58 -0
- data/sig/ark_email/models/tenants/webhook_test_response.rbs +74 -0
- data/sig/ark_email/models/tenants/webhook_update_params.rbs +53 -0
- data/sig/ark_email/models/tenants/webhook_update_response.rbs +109 -0
- data/sig/ark_email/models/usage_export_params.rbs +83 -0
- data/sig/ark_email/models/usage_export_response.rbs +92 -0
- data/sig/ark_email/models/usage_list_tenants_params.rbs +115 -0
- data/sig/ark_email/models/usage_period.rbs +15 -0
- data/sig/ark_email/models/usage_retrieve_params.rbs +20 -3
- data/sig/ark_email/models.rbs +15 -47
- data/sig/ark_email/resources/emails.rbs +3 -3
- data/sig/ark_email/resources/limits.rbs +11 -0
- data/sig/ark_email/resources/platform/webhooks.rbs +67 -0
- data/sig/ark_email/resources/platform.rbs +9 -0
- data/sig/ark_email/resources/tenants/credentials.rbs +45 -0
- data/sig/ark_email/resources/tenants/domains.rbs +38 -0
- data/sig/ark_email/resources/tenants/suppressions.rbs +35 -0
- data/sig/ark_email/resources/tenants/tracking.rbs +52 -0
- data/sig/ark_email/resources/tenants/usage.rbs +24 -0
- data/sig/ark_email/resources/tenants/webhooks.rbs +80 -0
- data/sig/ark_email/resources/tenants.rbs +12 -0
- data/sig/ark_email/resources/usage.rbs +23 -1
- metadata +314 -173
- data/lib/ark_email/models/dns_record.rb +0 -111
- data/lib/ark_email/models/domain_create_params.rb +0 -22
- data/lib/ark_email/models/domain_create_response.rb +0 -202
- data/lib/ark_email/models/domain_delete_params.rb +0 -14
- data/lib/ark_email/models/domain_delete_response.rb +0 -39
- data/lib/ark_email/models/domain_list_params.rb +0 -14
- data/lib/ark_email/models/domain_list_response.rb +0 -71
- data/lib/ark_email/models/domain_retrieve_params.rb +0 -14
- data/lib/ark_email/models/domain_retrieve_response.rb +0 -202
- data/lib/ark_email/models/domain_verify_params.rb +0 -14
- data/lib/ark_email/models/domain_verify_response.rb +0 -202
- data/lib/ark_email/models/suppression_bulk_create_params.rb +0 -39
- data/lib/ark_email/models/suppression_bulk_create_response.rb +0 -64
- data/lib/ark_email/models/suppression_create_params.rb +0 -30
- data/lib/ark_email/models/suppression_create_response.rb +0 -62
- data/lib/ark_email/models/suppression_delete_params.rb +0 -14
- data/lib/ark_email/models/suppression_delete_response.rb +0 -39
- data/lib/ark_email/models/suppression_list_params.rb +0 -26
- data/lib/ark_email/models/suppression_list_response.rb +0 -38
- data/lib/ark_email/models/suppression_retrieve_params.rb +0 -14
- data/lib/ark_email/models/suppression_retrieve_response.rb +0 -64
- data/lib/ark_email/models/track_domain.rb +0 -176
- data/lib/ark_email/models/tracking_create_params.rb +0 -54
- data/lib/ark_email/models/tracking_create_response.rb +0 -28
- data/lib/ark_email/models/tracking_delete_params.rb +0 -14
- data/lib/ark_email/models/tracking_delete_response.rb +0 -39
- data/lib/ark_email/models/tracking_list_params.rb +0 -14
- data/lib/ark_email/models/tracking_list_response.rb +0 -41
- data/lib/ark_email/models/tracking_retrieve_params.rb +0 -14
- data/lib/ark_email/models/tracking_update_params.rb +0 -46
- data/lib/ark_email/models/tracking_update_response.rb +0 -28
- data/lib/ark_email/models/tracking_verify_params.rb +0 -14
- data/lib/ark_email/models/tracking_verify_response.rb +0 -133
- data/lib/ark_email/models/usage_retrieve_response.rb +0 -270
- data/lib/ark_email/models/webhook_create_params.rb +0 -84
- data/lib/ark_email/models/webhook_create_response.rb +0 -111
- data/lib/ark_email/models/webhook_delete_response.rb +0 -39
- data/lib/ark_email/models/webhook_list_deliveries_params.rb +0 -79
- data/lib/ark_email/models/webhook_list_deliveries_response.rb +0 -154
- data/lib/ark_email/models/webhook_list_params.rb +0 -14
- data/lib/ark_email/models/webhook_list_response.rb +0 -79
- data/lib/ark_email/models/webhook_replay_delivery_params.rb +0 -20
- data/lib/ark_email/models/webhook_replay_delivery_response.rb +0 -82
- data/lib/ark_email/models/webhook_retrieve_delivery_params.rb +0 -20
- data/lib/ark_email/models/webhook_retrieve_delivery_response.rb +0 -198
- data/lib/ark_email/models/webhook_retrieve_params.rb +0 -14
- data/lib/ark_email/models/webhook_retrieve_response.rb +0 -111
- data/lib/ark_email/models/webhook_test_params.rb +0 -39
- data/lib/ark_email/models/webhook_test_response.rb +0 -80
- data/lib/ark_email/models/webhook_update_params.rb +0 -44
- data/lib/ark_email/models/webhook_update_response.rb +0 -111
- data/lib/ark_email/resources/domains.rb +0 -127
- data/lib/ark_email/resources/suppressions.rb +0 -124
- data/lib/ark_email/resources/tracking.rb +0 -167
- data/lib/ark_email/resources/webhooks.rb +0 -302
- data/rbi/ark_email/models/dns_record.rbi +0 -146
- data/rbi/ark_email/models/domain_create_params.rbi +0 -40
- data/rbi/ark_email/models/domain_create_response.rbi +0 -354
- data/rbi/ark_email/models/domain_delete_params.rbi +0 -27
- data/rbi/ark_email/models/domain_delete_response.rbi +0 -75
- data/rbi/ark_email/models/domain_list_params.rbi +0 -27
- data/rbi/ark_email/models/domain_list_response.rbi +0 -138
- data/rbi/ark_email/models/domain_retrieve_params.rbi +0 -27
- data/rbi/ark_email/models/domain_retrieve_response.rbi +0 -358
- data/rbi/ark_email/models/domain_verify_params.rbi +0 -27
- data/rbi/ark_email/models/domain_verify_response.rbi +0 -354
- data/rbi/ark_email/models/suppression_bulk_create_params.rbi +0 -80
- data/rbi/ark_email/models/suppression_bulk_create_response.rbi +0 -115
- data/rbi/ark_email/models/suppression_create_params.rbi +0 -51
- data/rbi/ark_email/models/suppression_create_response.rbi +0 -109
- data/rbi/ark_email/models/suppression_delete_params.rbi +0 -27
- data/rbi/ark_email/models/suppression_delete_response.rbi +0 -77
- data/rbi/ark_email/models/suppression_list_params.rbi +0 -49
- data/rbi/ark_email/models/suppression_list_response.rbi +0 -56
- data/rbi/ark_email/models/suppression_retrieve_params.rbi +0 -30
- data/rbi/ark_email/models/suppression_retrieve_response.rbi +0 -115
- data/rbi/ark_email/models/track_domain.rbi +0 -230
- data/rbi/ark_email/models/tracking_create_params.rbi +0 -75
- data/rbi/ark_email/models/tracking_create_response.rbi +0 -52
- data/rbi/ark_email/models/tracking_delete_params.rbi +0 -27
- data/rbi/ark_email/models/tracking_delete_response.rbi +0 -77
- data/rbi/ark_email/models/tracking_list_params.rbi +0 -27
- data/rbi/ark_email/models/tracking_list_response.rbi +0 -81
- data/rbi/ark_email/models/tracking_retrieve_params.rbi +0 -27
- data/rbi/ark_email/models/tracking_retrieve_response.rbi +0 -52
- data/rbi/ark_email/models/tracking_update_params.rbi +0 -67
- data/rbi/ark_email/models/tracking_verify_params.rbi +0 -27
- data/rbi/ark_email/models/tracking_verify_response.rbi +0 -254
- data/rbi/ark_email/models/usage_retrieve_response.rbi +0 -511
- data/rbi/ark_email/models/webhook_create_params.rbi +0 -158
- data/rbi/ark_email/models/webhook_create_response.rbi +0 -217
- data/rbi/ark_email/models/webhook_delete_response.rbi +0 -75
- data/rbi/ark_email/models/webhook_list_deliveries_params.rbi +0 -172
- data/rbi/ark_email/models/webhook_list_deliveries_response.rbi +0 -257
- data/rbi/ark_email/models/webhook_list_params.rbi +0 -27
- data/rbi/ark_email/models/webhook_list_response.rbi +0 -152
- data/rbi/ark_email/models/webhook_replay_delivery_params.rbi +0 -38
- data/rbi/ark_email/models/webhook_replay_delivery_response.rbi +0 -132
- data/rbi/ark_email/models/webhook_retrieve_delivery_params.rbi +0 -38
- data/rbi/ark_email/models/webhook_retrieve_delivery_response.rbi +0 -371
- data/rbi/ark_email/models/webhook_retrieve_params.rbi +0 -27
- data/rbi/ark_email/models/webhook_retrieve_response.rbi +0 -219
- data/rbi/ark_email/models/webhook_test_params.rbi +0 -95
- data/rbi/ark_email/models/webhook_test_response.rbi +0 -129
- data/rbi/ark_email/models/webhook_update_params.rbi +0 -65
- data/rbi/ark_email/models/webhook_update_response.rbi +0 -217
- data/rbi/ark_email/resources/domains.rbi +0 -84
- data/rbi/ark_email/resources/suppressions.rbi +0 -84
- data/rbi/ark_email/resources/tracking.rbi +0 -130
- data/rbi/ark_email/resources/webhooks.rbi +0 -244
- data/sig/ark_email/models/dns_record.rbs +0 -64
- data/sig/ark_email/models/domain_create_params.rbs +0 -23
- data/sig/ark_email/models/domain_create_response.rbs +0 -111
- data/sig/ark_email/models/domain_delete_params.rbs +0 -15
- data/sig/ark_email/models/domain_delete_response.rbs +0 -40
- data/sig/ark_email/models/domain_list_params.rbs +0 -15
- data/sig/ark_email/models/domain_list_response.rbs +0 -59
- data/sig/ark_email/models/domain_retrieve_params.rbs +0 -15
- data/sig/ark_email/models/domain_retrieve_response.rbs +0 -111
- data/sig/ark_email/models/domain_verify_params.rbs +0 -15
- data/sig/ark_email/models/domain_verify_response.rbs +0 -111
- data/sig/ark_email/models/suppression_bulk_create_params.rbs +0 -38
- data/sig/ark_email/models/suppression_bulk_create_response.rbs +0 -62
- data/sig/ark_email/models/suppression_create_params.rbs +0 -28
- data/sig/ark_email/models/suppression_create_response.rbs +0 -59
- data/sig/ark_email/models/suppression_delete_params.rbs +0 -15
- data/sig/ark_email/models/suppression_delete_response.rbs +0 -40
- data/sig/ark_email/models/suppression_list_params.rbs +0 -32
- data/sig/ark_email/models/suppression_list_response.rbs +0 -32
- data/sig/ark_email/models/suppression_retrieve_params.rbs +0 -15
- data/sig/ark_email/models/suppression_retrieve_response.rbs +0 -62
- data/sig/ark_email/models/track_domain.rbs +0 -122
- data/sig/ark_email/models/tracking_create_params.rbs +0 -46
- data/sig/ark_email/models/tracking_create_response.rbs +0 -26
- data/sig/ark_email/models/tracking_delete_params.rbs +0 -15
- data/sig/ark_email/models/tracking_delete_response.rbs +0 -40
- data/sig/ark_email/models/tracking_list_params.rbs +0 -15
- data/sig/ark_email/models/tracking_list_response.rbs +0 -40
- data/sig/ark_email/models/tracking_retrieve_params.rbs +0 -15
- data/sig/ark_email/models/tracking_retrieve_response.rbs +0 -26
- data/sig/ark_email/models/tracking_update_params.rbs +0 -41
- data/sig/ark_email/models/tracking_verify_params.rbs +0 -15
- data/sig/ark_email/models/tracking_verify_response.rbs +0 -109
- data/sig/ark_email/models/usage_retrieve_response.rbs +0 -212
- data/sig/ark_email/models/webhook_create_params.rbs +0 -71
- data/sig/ark_email/models/webhook_create_response.rbs +0 -107
- data/sig/ark_email/models/webhook_delete_response.rbs +0 -40
- data/sig/ark_email/models/webhook_list_deliveries_params.rbs +0 -90
- data/sig/ark_email/models/webhook_list_params.rbs +0 -15
- data/sig/ark_email/models/webhook_list_response.rbs +0 -84
- data/sig/ark_email/models/webhook_replay_delivery_params.rbs +0 -23
- data/sig/ark_email/models/webhook_replay_delivery_response.rbs +0 -72
- data/sig/ark_email/models/webhook_retrieve_delivery_params.rbs +0 -23
- data/sig/ark_email/models/webhook_retrieve_delivery_response.rbs +0 -158
- data/sig/ark_email/models/webhook_retrieve_params.rbs +0 -15
- data/sig/ark_email/models/webhook_retrieve_response.rbs +0 -107
- data/sig/ark_email/models/webhook_test_params.rbs +0 -49
- data/sig/ark_email/models/webhook_test_response.rbs +0 -72
- data/sig/ark_email/models/webhook_update_params.rbs +0 -46
- data/sig/ark_email/models/webhook_update_response.rbs +0 -107
- data/sig/ark_email/resources/domains.rbs +0 -31
- data/sig/ark_email/resources/suppressions.rbs +0 -34
- data/sig/ark_email/resources/tracking.rbs +0 -44
- data/sig/ark_email/resources/webhooks.rbs +0 -69
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6255c7791ef262ad25da9374d066c4eeea50052acc0e83258f13a7091a2a2420
|
|
4
|
+
data.tar.gz: 2358b745c8956be0861bbaec0870dd6961aee04c94857b75ac1be0a0c2e88d65
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5e2b2d595d3891d689a095f6e57c580796ba0033514c1679d8c6d8f145bd76db7bff8b6c7ced06700b8d3e1aae0cb0dac4aab9316c4d6130ba3c78b5494a9582
|
|
7
|
+
data.tar.gz: 12d2ec03093ce4603a223474bd4ed4939c7cda16dd4546660ff431867c35336836aa282eea11f02a79e138a9b9017bf37984b62fb2ebaa186a576d31418aa6a9
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.19.0 (2026-02-07)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.18.0...v0.19.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.18.0...v0.19.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add Credentials endpoint ([e1b4536](https://github.com/ArkHQ-io/ark-ruby/commit/e1b45361e3a4e4cfd9de4648def64e2622baea81))
|
|
10
|
+
* **api:** add Platform webhooks ([56ac161](https://github.com/ArkHQ-io/ark-ruby/commit/56ac1617e16253ec182b5705621159edddb8791c))
|
|
11
|
+
* **api:** endpoint updates ([f492b2e](https://github.com/ArkHQ-io/ark-ruby/commit/f492b2e39082aed03ef6d104a1e3d9695e3d66b6))
|
|
12
|
+
* **api:** standardization improvements ([b187d9b](https://github.com/ArkHQ-io/ark-ruby/commit/b187d9b397de264ac9dbf6d7b882b28e6850ddf6))
|
|
13
|
+
* **api:** tenant usage ([b3aca3d](https://github.com/ArkHQ-io/ark-ruby/commit/b3aca3dfd1957992552c18d94bba4cd6e1db31f3))
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* **client:** loosen json header parsing ([209ac67](https://github.com/ArkHQ-io/ark-ruby/commit/209ac6701b972d01b0d83ec8319bb6a36812909d))
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Chores
|
|
22
|
+
|
|
23
|
+
* **docs:** remove www prefix ([80b201f](https://github.com/ArkHQ-io/ark-ruby/commit/80b201fff6de57f5d2496f488e137ac1535304ef))
|
|
24
|
+
|
|
3
25
|
## 0.18.0 (2026-02-03)
|
|
4
26
|
|
|
5
27
|
Full Changelog: [v0.17.0...v0.18.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.17.0...v0.18.0)
|
data/README.md
CHANGED
|
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
26
26
|
<!-- x-release-please-start-version -->
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
gem "ark-email", "~> 0.
|
|
29
|
+
gem "ark-email", "~> 0.19.0"
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<!-- x-release-please-end -->
|
|
@@ -46,7 +46,7 @@ response = ark.emails.send_(
|
|
|
46
46
|
subject: "Hello World",
|
|
47
47
|
to: ["user@example.com"],
|
|
48
48
|
html: "<h1>Welcome!</h1>",
|
|
49
|
-
metadata: {user_id: "
|
|
49
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
50
50
|
tag: "welcome"
|
|
51
51
|
)
|
|
52
52
|
|
|
@@ -92,7 +92,7 @@ begin
|
|
|
92
92
|
subject: "Hello World",
|
|
93
93
|
to: ["user@example.com"],
|
|
94
94
|
html: "<h1>Welcome!</h1>",
|
|
95
|
-
metadata: {user_id: "
|
|
95
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
96
96
|
tag: "welcome"
|
|
97
97
|
)
|
|
98
98
|
rescue ArkEmail::Errors::APIConnectionError => e
|
|
@@ -142,7 +142,7 @@ ark.emails.send_(
|
|
|
142
142
|
subject: "Hello World",
|
|
143
143
|
to: ["user@example.com"],
|
|
144
144
|
html: "<h1>Welcome!</h1>",
|
|
145
|
-
metadata: {user_id: "
|
|
145
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
146
146
|
tag: "welcome",
|
|
147
147
|
request_options: {max_retries: 5}
|
|
148
148
|
)
|
|
@@ -164,7 +164,7 @@ ark.emails.send_(
|
|
|
164
164
|
subject: "Hello World",
|
|
165
165
|
to: ["user@example.com"],
|
|
166
166
|
html: "<h1>Welcome!</h1>",
|
|
167
|
-
metadata: {user_id: "
|
|
167
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
168
168
|
tag: "welcome",
|
|
169
169
|
request_options: {timeout: 5}
|
|
170
170
|
)
|
|
@@ -203,7 +203,7 @@ response =
|
|
|
203
203
|
subject: "Hello World",
|
|
204
204
|
to: ["user@example.com"],
|
|
205
205
|
html: "<h1>Welcome!</h1>",
|
|
206
|
-
metadata: {user_id: "
|
|
206
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
207
207
|
tag: "welcome",
|
|
208
208
|
request_options: {
|
|
209
209
|
extra_query: {my_query_parameter: value},
|
|
@@ -255,7 +255,7 @@ ark.emails.send_(
|
|
|
255
255
|
subject: "Hello World",
|
|
256
256
|
to: ["user@example.com"],
|
|
257
257
|
html: "<h1>Welcome!</h1>",
|
|
258
|
-
metadata: {user_id: "
|
|
258
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
259
259
|
tag: "welcome"
|
|
260
260
|
)
|
|
261
261
|
```
|
|
@@ -269,7 +269,7 @@ ark.emails.send_(
|
|
|
269
269
|
subject: "Hello World",
|
|
270
270
|
to: ["user@example.com"],
|
|
271
271
|
html: "<h1>Welcome!</h1>",
|
|
272
|
-
metadata: {user_id: "
|
|
272
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
273
273
|
tag: "welcome"
|
|
274
274
|
)
|
|
275
275
|
|
|
@@ -279,7 +279,7 @@ params = ArkEmail::EmailSendParams.new(
|
|
|
279
279
|
subject: "Hello World",
|
|
280
280
|
to: ["user@example.com"],
|
|
281
281
|
html: "<h1>Welcome!</h1>",
|
|
282
|
-
metadata: {user_id: "
|
|
282
|
+
metadata: {user_id: "usr_123456", campaign: "onboarding"},
|
|
283
283
|
tag: "welcome"
|
|
284
284
|
)
|
|
285
285
|
ark.emails.send_(**params)
|
data/lib/ark_email/client.rb
CHANGED
|
@@ -27,27 +27,21 @@ module ArkEmail
|
|
|
27
27
|
# @return [ArkEmail::Resources::Emails]
|
|
28
28
|
attr_reader :emails
|
|
29
29
|
|
|
30
|
-
# @return [ArkEmail::Resources::Domains]
|
|
31
|
-
attr_reader :domains
|
|
32
|
-
|
|
33
|
-
# @return [ArkEmail::Resources::Suppressions]
|
|
34
|
-
attr_reader :suppressions
|
|
35
|
-
|
|
36
|
-
# @return [ArkEmail::Resources::Webhooks]
|
|
37
|
-
attr_reader :webhooks
|
|
38
|
-
|
|
39
|
-
# @return [ArkEmail::Resources::Tracking]
|
|
40
|
-
attr_reader :tracking
|
|
41
|
-
|
|
42
30
|
# @return [ArkEmail::Resources::Logs]
|
|
43
31
|
attr_reader :logs
|
|
44
32
|
|
|
45
33
|
# @return [ArkEmail::Resources::Usage]
|
|
46
34
|
attr_reader :usage
|
|
47
35
|
|
|
36
|
+
# @return [ArkEmail::Resources::Limits]
|
|
37
|
+
attr_reader :limits
|
|
38
|
+
|
|
48
39
|
# @return [ArkEmail::Resources::Tenants]
|
|
49
40
|
attr_reader :tenants
|
|
50
41
|
|
|
42
|
+
# @return [ArkEmail::Resources::Platform]
|
|
43
|
+
attr_reader :platform
|
|
44
|
+
|
|
51
45
|
# @api private
|
|
52
46
|
#
|
|
53
47
|
# @return [Hash{String=>String}]
|
|
@@ -102,13 +96,11 @@ module ArkEmail
|
|
|
102
96
|
)
|
|
103
97
|
|
|
104
98
|
@emails = ArkEmail::Resources::Emails.new(client: self)
|
|
105
|
-
@domains = ArkEmail::Resources::Domains.new(client: self)
|
|
106
|
-
@suppressions = ArkEmail::Resources::Suppressions.new(client: self)
|
|
107
|
-
@webhooks = ArkEmail::Resources::Webhooks.new(client: self)
|
|
108
|
-
@tracking = ArkEmail::Resources::Tracking.new(client: self)
|
|
109
99
|
@logs = ArkEmail::Resources::Logs.new(client: self)
|
|
110
100
|
@usage = ArkEmail::Resources::Usage.new(client: self)
|
|
101
|
+
@limits = ArkEmail::Resources::Limits.new(client: self)
|
|
111
102
|
@tenants = ArkEmail::Resources::Tenants.new(client: self)
|
|
103
|
+
@platform = ArkEmail::Resources::Platform.new(client: self)
|
|
112
104
|
end
|
|
113
105
|
end
|
|
114
106
|
end
|
|
@@ -485,7 +485,7 @@ module ArkEmail
|
|
|
485
485
|
end
|
|
486
486
|
|
|
487
487
|
# @type [Regexp]
|
|
488
|
-
JSON_CONTENT = %r{^application/(?:
|
|
488
|
+
JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
|
|
489
489
|
# @type [Regexp]
|
|
490
490
|
JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
|
|
491
491
|
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ArkEmail
|
|
4
|
+
module Models
|
|
5
|
+
class EmailCounts < ArkEmail::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute bounced
|
|
7
|
+
# Emails that bounced
|
|
8
|
+
#
|
|
9
|
+
# @return [Integer]
|
|
10
|
+
required :bounced, Integer
|
|
11
|
+
|
|
12
|
+
# @!attribute delivered
|
|
13
|
+
# Emails successfully delivered
|
|
14
|
+
#
|
|
15
|
+
# @return [Integer]
|
|
16
|
+
required :delivered, Integer
|
|
17
|
+
|
|
18
|
+
# @!attribute hard_failed
|
|
19
|
+
# Emails that hard-failed (permanent failures)
|
|
20
|
+
#
|
|
21
|
+
# @return [Integer]
|
|
22
|
+
required :hard_failed, Integer
|
|
23
|
+
|
|
24
|
+
# @!attribute held
|
|
25
|
+
# Emails currently held for review
|
|
26
|
+
#
|
|
27
|
+
# @return [Integer]
|
|
28
|
+
required :held, Integer
|
|
29
|
+
|
|
30
|
+
# @!attribute sent
|
|
31
|
+
# Total emails sent
|
|
32
|
+
#
|
|
33
|
+
# @return [Integer]
|
|
34
|
+
required :sent, Integer
|
|
35
|
+
|
|
36
|
+
# @!attribute soft_failed
|
|
37
|
+
# Emails that soft-failed (temporary failures, may be retried)
|
|
38
|
+
#
|
|
39
|
+
# @return [Integer]
|
|
40
|
+
required :soft_failed, Integer
|
|
41
|
+
|
|
42
|
+
# @!method initialize(bounced:, delivered:, hard_failed:, held:, sent:, soft_failed:)
|
|
43
|
+
# Email delivery counts
|
|
44
|
+
#
|
|
45
|
+
# @param bounced [Integer] Emails that bounced
|
|
46
|
+
#
|
|
47
|
+
# @param delivered [Integer] Emails successfully delivered
|
|
48
|
+
#
|
|
49
|
+
# @param hard_failed [Integer] Emails that hard-failed (permanent failures)
|
|
50
|
+
#
|
|
51
|
+
# @param held [Integer] Emails currently held for review
|
|
52
|
+
#
|
|
53
|
+
# @param sent [Integer] Total emails sent
|
|
54
|
+
#
|
|
55
|
+
# @param soft_failed [Integer] Emails that soft-failed (temporary failures, may be retried)
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ArkEmail
|
|
4
|
+
module Models
|
|
5
|
+
class EmailRates < ArkEmail::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute bounce_rate
|
|
7
|
+
# Percentage of sent emails that bounced (0-1)
|
|
8
|
+
#
|
|
9
|
+
# @return [Float]
|
|
10
|
+
required :bounce_rate, Float
|
|
11
|
+
|
|
12
|
+
# @!attribute delivery_rate
|
|
13
|
+
# Percentage of sent emails that were delivered (0-1)
|
|
14
|
+
#
|
|
15
|
+
# @return [Float]
|
|
16
|
+
required :delivery_rate, Float
|
|
17
|
+
|
|
18
|
+
# @!method initialize(bounce_rate:, delivery_rate:)
|
|
19
|
+
# Email delivery rates (as decimals, e.g., 0.95 = 95%)
|
|
20
|
+
#
|
|
21
|
+
# @param bounce_rate [Float] Percentage of sent emails that bounced (0-1)
|
|
22
|
+
#
|
|
23
|
+
# @param delivery_rate [Float] Percentage of sent emails that were delivered (0-1)
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -33,7 +33,7 @@ module ArkEmail
|
|
|
33
33
|
required :id, String
|
|
34
34
|
|
|
35
35
|
# @!attribute can_retry_manually
|
|
36
|
-
# Whether the message can be manually retried via `POST /emails/{
|
|
36
|
+
# Whether the message can be manually retried via `POST /emails/{emailId}/retry`.
|
|
37
37
|
# `true` when the raw message content is still available (not expired). Messages
|
|
38
38
|
# older than the retention period cannot be retried.
|
|
39
39
|
#
|
|
@@ -77,7 +77,7 @@ module ArkEmail
|
|
|
77
77
|
#
|
|
78
78
|
# @param id [String] Message identifier (token)
|
|
79
79
|
#
|
|
80
|
-
# @param can_retry_manually [Boolean] Whether the message can be manually retried via `POST /emails/{
|
|
80
|
+
# @param can_retry_manually [Boolean] Whether the message can be manually retried via `POST /emails/{emailId}/retry`.
|
|
81
81
|
#
|
|
82
82
|
# @param deliveries [Array<ArkEmail::Models::EmailRetrieveDeliveriesResponse::Data::Delivery>] Chronological list of delivery attempts for this message.
|
|
83
83
|
#
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module ArkEmail
|
|
4
4
|
module Models
|
|
5
|
-
# @see ArkEmail::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see ArkEmail::Resources::Limits#retrieve
|
|
6
|
+
class LimitRetrieveParams < ArkEmail::Internal::Type::BaseModel
|
|
7
7
|
extend ArkEmail::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include ArkEmail::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -2,12 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
module ArkEmail
|
|
4
4
|
module Models
|
|
5
|
-
# @see ArkEmail::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see ArkEmail::Resources::Limits#retrieve
|
|
6
|
+
class LimitRetrieveResponse < ArkEmail::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
+
# Current usage and limit information
|
|
8
9
|
#
|
|
9
|
-
# @return [ArkEmail::Models::
|
|
10
|
-
required :data, -> { ArkEmail::
|
|
10
|
+
# @return [ArkEmail::Models::LimitsData]
|
|
11
|
+
required :data, -> { ArkEmail::LimitsData }
|
|
11
12
|
|
|
12
13
|
# @!attribute meta
|
|
13
14
|
#
|
|
@@ -20,8 +21,12 @@ module ArkEmail
|
|
|
20
21
|
required :success, const: true
|
|
21
22
|
|
|
22
23
|
# @!method initialize(data:, meta:, success: true)
|
|
23
|
-
#
|
|
24
|
+
# Account rate limits and send limits response
|
|
25
|
+
#
|
|
26
|
+
# @param data [ArkEmail::Models::LimitsData] Current usage and limit information
|
|
27
|
+
#
|
|
24
28
|
# @param meta [ArkEmail::Models::APIMeta]
|
|
29
|
+
#
|
|
25
30
|
# @param success [Boolean, true]
|
|
26
31
|
end
|
|
27
32
|
end
|
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ArkEmail
|
|
4
|
+
module Models
|
|
5
|
+
class LimitsData < ArkEmail::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute billing
|
|
7
|
+
# Billing and credit information
|
|
8
|
+
#
|
|
9
|
+
# @return [ArkEmail::Models::LimitsData::Billing, nil]
|
|
10
|
+
required :billing, -> { ArkEmail::LimitsData::Billing }, nil?: true
|
|
11
|
+
|
|
12
|
+
# @!attribute rate_limit
|
|
13
|
+
# API rate limit status
|
|
14
|
+
#
|
|
15
|
+
# @return [ArkEmail::Models::LimitsData::RateLimit]
|
|
16
|
+
required :rate_limit, -> { ArkEmail::LimitsData::RateLimit }, api_name: :rateLimit
|
|
17
|
+
|
|
18
|
+
# @!attribute send_limit
|
|
19
|
+
# Email send limit status (hourly cap)
|
|
20
|
+
#
|
|
21
|
+
# @return [ArkEmail::Models::LimitsData::SendLimit, nil]
|
|
22
|
+
required :send_limit, -> { ArkEmail::LimitsData::SendLimit }, api_name: :sendLimit, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!method initialize(billing:, rate_limit:, send_limit:)
|
|
25
|
+
# Current usage and limit information
|
|
26
|
+
#
|
|
27
|
+
# @param billing [ArkEmail::Models::LimitsData::Billing, nil] Billing and credit information
|
|
28
|
+
#
|
|
29
|
+
# @param rate_limit [ArkEmail::Models::LimitsData::RateLimit] API rate limit status
|
|
30
|
+
#
|
|
31
|
+
# @param send_limit [ArkEmail::Models::LimitsData::SendLimit, nil] Email send limit status (hourly cap)
|
|
32
|
+
|
|
33
|
+
# @see ArkEmail::Models::LimitsData#billing
|
|
34
|
+
class Billing < ArkEmail::Internal::Type::BaseModel
|
|
35
|
+
# @!attribute auto_recharge
|
|
36
|
+
# Auto-recharge configuration
|
|
37
|
+
#
|
|
38
|
+
# @return [ArkEmail::Models::LimitsData::Billing::AutoRecharge]
|
|
39
|
+
required :auto_recharge, -> { ArkEmail::LimitsData::Billing::AutoRecharge }, api_name: :autoRecharge
|
|
40
|
+
|
|
41
|
+
# @!attribute credit_balance
|
|
42
|
+
# Current credit balance as formatted string (e.g., "25.50")
|
|
43
|
+
#
|
|
44
|
+
# @return [String]
|
|
45
|
+
required :credit_balance, String, api_name: :creditBalance
|
|
46
|
+
|
|
47
|
+
# @!attribute credit_balance_cents
|
|
48
|
+
# Current credit balance in cents for precise calculations
|
|
49
|
+
#
|
|
50
|
+
# @return [Integer]
|
|
51
|
+
required :credit_balance_cents, Integer, api_name: :creditBalanceCents
|
|
52
|
+
|
|
53
|
+
# @!attribute has_payment_method
|
|
54
|
+
# Whether a payment method is configured
|
|
55
|
+
#
|
|
56
|
+
# @return [Boolean]
|
|
57
|
+
required :has_payment_method, ArkEmail::Internal::Type::Boolean, api_name: :hasPaymentMethod
|
|
58
|
+
|
|
59
|
+
# @!method initialize(auto_recharge:, credit_balance:, credit_balance_cents:, has_payment_method:)
|
|
60
|
+
# Billing and credit information
|
|
61
|
+
#
|
|
62
|
+
# @param auto_recharge [ArkEmail::Models::LimitsData::Billing::AutoRecharge] Auto-recharge configuration
|
|
63
|
+
#
|
|
64
|
+
# @param credit_balance [String] Current credit balance as formatted string (e.g., "25.50")
|
|
65
|
+
#
|
|
66
|
+
# @param credit_balance_cents [Integer] Current credit balance in cents for precise calculations
|
|
67
|
+
#
|
|
68
|
+
# @param has_payment_method [Boolean] Whether a payment method is configured
|
|
69
|
+
|
|
70
|
+
# @see ArkEmail::Models::LimitsData::Billing#auto_recharge
|
|
71
|
+
class AutoRecharge < ArkEmail::Internal::Type::BaseModel
|
|
72
|
+
# @!attribute amount
|
|
73
|
+
# Amount to recharge when triggered
|
|
74
|
+
#
|
|
75
|
+
# @return [String]
|
|
76
|
+
required :amount, String
|
|
77
|
+
|
|
78
|
+
# @!attribute enabled
|
|
79
|
+
# Whether auto-recharge is enabled
|
|
80
|
+
#
|
|
81
|
+
# @return [Boolean]
|
|
82
|
+
required :enabled, ArkEmail::Internal::Type::Boolean
|
|
83
|
+
|
|
84
|
+
# @!attribute threshold
|
|
85
|
+
# Balance threshold that triggers recharge
|
|
86
|
+
#
|
|
87
|
+
# @return [String]
|
|
88
|
+
required :threshold, String
|
|
89
|
+
|
|
90
|
+
# @!method initialize(amount:, enabled:, threshold:)
|
|
91
|
+
# Auto-recharge configuration
|
|
92
|
+
#
|
|
93
|
+
# @param amount [String] Amount to recharge when triggered
|
|
94
|
+
#
|
|
95
|
+
# @param enabled [Boolean] Whether auto-recharge is enabled
|
|
96
|
+
#
|
|
97
|
+
# @param threshold [String] Balance threshold that triggers recharge
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# @see ArkEmail::Models::LimitsData#rate_limit
|
|
102
|
+
class RateLimit < ArkEmail::Internal::Type::BaseModel
|
|
103
|
+
# @!attribute limit
|
|
104
|
+
# Maximum requests allowed per period
|
|
105
|
+
#
|
|
106
|
+
# @return [Integer]
|
|
107
|
+
required :limit, Integer
|
|
108
|
+
|
|
109
|
+
# @!attribute period
|
|
110
|
+
# Time period for the limit
|
|
111
|
+
#
|
|
112
|
+
# @return [Symbol, ArkEmail::Models::LimitsData::RateLimit::Period]
|
|
113
|
+
required :period, enum: -> { ArkEmail::LimitsData::RateLimit::Period }
|
|
114
|
+
|
|
115
|
+
# @!attribute remaining
|
|
116
|
+
# Requests remaining in current window
|
|
117
|
+
#
|
|
118
|
+
# @return [Integer]
|
|
119
|
+
required :remaining, Integer
|
|
120
|
+
|
|
121
|
+
# @!attribute reset
|
|
122
|
+
# Unix timestamp when the limit resets
|
|
123
|
+
#
|
|
124
|
+
# @return [Integer]
|
|
125
|
+
required :reset, Integer
|
|
126
|
+
|
|
127
|
+
# @!method initialize(limit:, period:, remaining:, reset:)
|
|
128
|
+
# API rate limit status
|
|
129
|
+
#
|
|
130
|
+
# @param limit [Integer] Maximum requests allowed per period
|
|
131
|
+
#
|
|
132
|
+
# @param period [Symbol, ArkEmail::Models::LimitsData::RateLimit::Period] Time period for the limit
|
|
133
|
+
#
|
|
134
|
+
# @param remaining [Integer] Requests remaining in current window
|
|
135
|
+
#
|
|
136
|
+
# @param reset [Integer] Unix timestamp when the limit resets
|
|
137
|
+
|
|
138
|
+
# Time period for the limit
|
|
139
|
+
#
|
|
140
|
+
# @see ArkEmail::Models::LimitsData::RateLimit#period
|
|
141
|
+
module Period
|
|
142
|
+
extend ArkEmail::Internal::Type::Enum
|
|
143
|
+
|
|
144
|
+
SECOND = :second
|
|
145
|
+
|
|
146
|
+
# @!method self.values
|
|
147
|
+
# @return [Array<Symbol>]
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# @see ArkEmail::Models::LimitsData#send_limit
|
|
152
|
+
class SendLimit < ArkEmail::Internal::Type::BaseModel
|
|
153
|
+
# @!attribute approaching
|
|
154
|
+
# Whether approaching the limit (>90%)
|
|
155
|
+
#
|
|
156
|
+
# @return [Boolean]
|
|
157
|
+
required :approaching, ArkEmail::Internal::Type::Boolean
|
|
158
|
+
|
|
159
|
+
# @!attribute exceeded
|
|
160
|
+
# Whether the limit has been exceeded
|
|
161
|
+
#
|
|
162
|
+
# @return [Boolean]
|
|
163
|
+
required :exceeded, ArkEmail::Internal::Type::Boolean
|
|
164
|
+
|
|
165
|
+
# @!attribute limit
|
|
166
|
+
# Maximum emails allowed per hour (null = unlimited)
|
|
167
|
+
#
|
|
168
|
+
# @return [Integer, nil]
|
|
169
|
+
required :limit, Integer, nil?: true
|
|
170
|
+
|
|
171
|
+
# @!attribute period
|
|
172
|
+
# Time period for the limit
|
|
173
|
+
#
|
|
174
|
+
# @return [Symbol, ArkEmail::Models::LimitsData::SendLimit::Period]
|
|
175
|
+
required :period, enum: -> { ArkEmail::LimitsData::SendLimit::Period }
|
|
176
|
+
|
|
177
|
+
# @!attribute remaining
|
|
178
|
+
# Emails remaining in current period (null if unlimited)
|
|
179
|
+
#
|
|
180
|
+
# @return [Integer, nil]
|
|
181
|
+
required :remaining, Integer, nil?: true
|
|
182
|
+
|
|
183
|
+
# @!attribute resets_at
|
|
184
|
+
# ISO timestamp when the limit window resets (top of next hour)
|
|
185
|
+
#
|
|
186
|
+
# @return [Time]
|
|
187
|
+
required :resets_at, Time, api_name: :resetsAt
|
|
188
|
+
|
|
189
|
+
# @!attribute usage_percent
|
|
190
|
+
# Usage as a percentage (null if unlimited)
|
|
191
|
+
#
|
|
192
|
+
# @return [Float, nil]
|
|
193
|
+
required :usage_percent, Float, api_name: :usagePercent, nil?: true
|
|
194
|
+
|
|
195
|
+
# @!attribute used
|
|
196
|
+
# Emails sent in current period
|
|
197
|
+
#
|
|
198
|
+
# @return [Integer]
|
|
199
|
+
required :used, Integer
|
|
200
|
+
|
|
201
|
+
# @!method initialize(approaching:, exceeded:, limit:, period:, remaining:, resets_at:, usage_percent:, used:)
|
|
202
|
+
# Email send limit status (hourly cap)
|
|
203
|
+
#
|
|
204
|
+
# @param approaching [Boolean] Whether approaching the limit (>90%)
|
|
205
|
+
#
|
|
206
|
+
# @param exceeded [Boolean] Whether the limit has been exceeded
|
|
207
|
+
#
|
|
208
|
+
# @param limit [Integer, nil] Maximum emails allowed per hour (null = unlimited)
|
|
209
|
+
#
|
|
210
|
+
# @param period [Symbol, ArkEmail::Models::LimitsData::SendLimit::Period] Time period for the limit
|
|
211
|
+
#
|
|
212
|
+
# @param remaining [Integer, nil] Emails remaining in current period (null if unlimited)
|
|
213
|
+
#
|
|
214
|
+
# @param resets_at [Time] ISO timestamp when the limit window resets (top of next hour)
|
|
215
|
+
#
|
|
216
|
+
# @param usage_percent [Float, nil] Usage as a percentage (null if unlimited)
|
|
217
|
+
#
|
|
218
|
+
# @param used [Integer] Emails sent in current period
|
|
219
|
+
|
|
220
|
+
# Time period for the limit
|
|
221
|
+
#
|
|
222
|
+
# @see ArkEmail::Models::LimitsData::SendLimit#period
|
|
223
|
+
module Period
|
|
224
|
+
extend ArkEmail::Internal::Type::Enum
|
|
225
|
+
|
|
226
|
+
HOUR = :hour
|
|
227
|
+
|
|
228
|
+
# @!method self.values
|
|
229
|
+
# @return [Array<Symbol>]
|
|
230
|
+
end
|
|
231
|
+
end
|
|
232
|
+
end
|
|
233
|
+
end
|
|
234
|
+
end
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ArkEmail
|
|
4
|
+
module Models
|
|
5
|
+
# @see ArkEmail::Resources::Usage#retrieve
|
|
6
|
+
class OrgUsageSummary < ArkEmail::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [ArkEmail::Models::OrgUsageSummary::Data]
|
|
10
|
+
required :data, -> { ArkEmail::OrgUsageSummary::Data }
|
|
11
|
+
|
|
12
|
+
# @!attribute meta
|
|
13
|
+
#
|
|
14
|
+
# @return [ArkEmail::Models::APIMeta]
|
|
15
|
+
required :meta, -> { ArkEmail::APIMeta }
|
|
16
|
+
|
|
17
|
+
# @!attribute success
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, true]
|
|
20
|
+
required :success, const: true
|
|
21
|
+
|
|
22
|
+
# @!method initialize(data:, meta:, success: true)
|
|
23
|
+
# Org-wide usage summary response
|
|
24
|
+
#
|
|
25
|
+
# @param data [ArkEmail::Models::OrgUsageSummary::Data]
|
|
26
|
+
# @param meta [ArkEmail::Models::APIMeta]
|
|
27
|
+
# @param success [Boolean, true]
|
|
28
|
+
|
|
29
|
+
# @see ArkEmail::Models::OrgUsageSummary#data
|
|
30
|
+
class Data < ArkEmail::Internal::Type::BaseModel
|
|
31
|
+
# @!attribute emails
|
|
32
|
+
# Email delivery counts
|
|
33
|
+
#
|
|
34
|
+
# @return [ArkEmail::Models::EmailCounts]
|
|
35
|
+
required :emails, -> { ArkEmail::EmailCounts }
|
|
36
|
+
|
|
37
|
+
# @!attribute period
|
|
38
|
+
# Time period for usage data
|
|
39
|
+
#
|
|
40
|
+
# @return [ArkEmail::Models::UsagePeriod]
|
|
41
|
+
required :period, -> { ArkEmail::UsagePeriod }
|
|
42
|
+
|
|
43
|
+
# @!attribute rates
|
|
44
|
+
# Email delivery rates (as decimals, e.g., 0.95 = 95%)
|
|
45
|
+
#
|
|
46
|
+
# @return [ArkEmail::Models::EmailRates]
|
|
47
|
+
required :rates, -> { ArkEmail::EmailRates }
|
|
48
|
+
|
|
49
|
+
# @!attribute tenants
|
|
50
|
+
#
|
|
51
|
+
# @return [ArkEmail::Models::OrgUsageSummary::Data::Tenants]
|
|
52
|
+
required :tenants, -> { ArkEmail::OrgUsageSummary::Data::Tenants }
|
|
53
|
+
|
|
54
|
+
# @!method initialize(emails:, period:, rates:, tenants:)
|
|
55
|
+
# @param emails [ArkEmail::Models::EmailCounts] Email delivery counts
|
|
56
|
+
#
|
|
57
|
+
# @param period [ArkEmail::Models::UsagePeriod] Time period for usage data
|
|
58
|
+
#
|
|
59
|
+
# @param rates [ArkEmail::Models::EmailRates] Email delivery rates (as decimals, e.g., 0.95 = 95%)
|
|
60
|
+
#
|
|
61
|
+
# @param tenants [ArkEmail::Models::OrgUsageSummary::Data::Tenants]
|
|
62
|
+
|
|
63
|
+
# @see ArkEmail::Models::OrgUsageSummary::Data#tenants
|
|
64
|
+
class Tenants < ArkEmail::Internal::Type::BaseModel
|
|
65
|
+
# @!attribute active
|
|
66
|
+
# Number of active tenants
|
|
67
|
+
#
|
|
68
|
+
# @return [Integer]
|
|
69
|
+
required :active, Integer
|
|
70
|
+
|
|
71
|
+
# @!attribute total
|
|
72
|
+
# Total number of tenants
|
|
73
|
+
#
|
|
74
|
+
# @return [Integer]
|
|
75
|
+
required :total, Integer
|
|
76
|
+
|
|
77
|
+
# @!attribute with_activity
|
|
78
|
+
# Number of tenants with sending activity
|
|
79
|
+
#
|
|
80
|
+
# @return [Integer]
|
|
81
|
+
required :with_activity, Integer, api_name: :withActivity
|
|
82
|
+
|
|
83
|
+
# @!method initialize(active:, total:, with_activity:)
|
|
84
|
+
# @param active [Integer] Number of active tenants
|
|
85
|
+
#
|
|
86
|
+
# @param total [Integer] Total number of tenants
|
|
87
|
+
#
|
|
88
|
+
# @param with_activity [Integer] Number of tenants with sending activity
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|