qubrics-management 3.0.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 +7 -0
- data/CHANGELOG.md +100 -0
- data/LICENSE +21 -0
- data/README.md +157 -0
- data/lib/qubrics/management/client.rb +99 -0
- data/lib/qubrics/management/version.rb +7 -0
- data/lib/qubrics/management.rb +12 -0
- data/lib/qubrics_management_generated/api/billing_api.rb +221 -0
- data/lib/qubrics_management_generated/api/connection_api.rb +82 -0
- data/lib/qubrics_management_generated/api/domain_filters_api.rb +161 -0
- data/lib/qubrics_management_generated/api/domains_api.rb +492 -0
- data/lib/qubrics_management_generated/api/emails_api.rb +258 -0
- data/lib/qubrics_management_generated/api/inboxes_api.rb +175 -0
- data/lib/qubrics_management_generated/api/mailbox_filters_api.rb +161 -0
- data/lib/qubrics_management_generated/api/mailboxes_api.rb +996 -0
- data/lib/qubrics_management_generated/api/sending_accounts_api.rb +1009 -0
- data/lib/qubrics_management_generated/api/webhooks_api.rb +666 -0
- data/lib/qubrics_management_generated/api_client.rb +447 -0
- data/lib/qubrics_management_generated/api_error.rb +58 -0
- data/lib/qubrics_management_generated/api_model_base.rb +95 -0
- data/lib/qubrics_management_generated/configuration.rb +400 -0
- data/lib/qubrics_management_generated/models/api_error_detail.rb +219 -0
- data/lib/qubrics_management_generated/models/api_error_error.rb +275 -0
- data/lib/qubrics_management_generated/models/api_error_meta.rb +164 -0
- data/lib/qubrics_management_generated/models/api_error_response.rb +216 -0
- data/lib/qubrics_management_generated/models/balance.rb +293 -0
- data/lib/qubrics_management_generated/models/balance_auto_topup.rb +226 -0
- data/lib/qubrics_management_generated/models/balance_response.rb +223 -0
- data/lib/qubrics_management_generated/models/connection.rb +273 -0
- data/lib/qubrics_management_generated/models/connection_credential.rb +226 -0
- data/lib/qubrics_management_generated/models/connection_mailboxes_inner.rb +190 -0
- data/lib/qubrics_management_generated/models/connection_response.rb +223 -0
- data/lib/qubrics_management_generated/models/connection_team.rb +190 -0
- data/lib/qubrics_management_generated/models/cursor_pagination.rb +173 -0
- data/lib/qubrics_management_generated/models/delivery_log_detail.rb +573 -0
- data/lib/qubrics_management_generated/models/delivery_log_item.rb +543 -0
- data/lib/qubrics_management_generated/models/delivery_log_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/delivery_log_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/delivery_log_recipient.rb +254 -0
- data/lib/qubrics_management_generated/models/domain_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/domain_deleted_response_all_of_data.rb +190 -0
- data/lib/qubrics_management_generated/models/domain_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/domain_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/domain_verify_response.rb +223 -0
- data/lib/qubrics_management_generated/models/email_metrics.rb +218 -0
- data/lib/qubrics_management_generated/models/email_metrics_comparison.rb +294 -0
- data/lib/qubrics_management_generated/models/email_metrics_comparison_change_pct.rb +268 -0
- data/lib/qubrics_management_generated/models/email_metrics_response.rb +223 -0
- data/lib/qubrics_management_generated/models/email_metrics_summary.rb +268 -0
- data/lib/qubrics_management_generated/models/email_metrics_timeseries_inner.rb +294 -0
- data/lib/qubrics_management_generated/models/filter_rule.rb +242 -0
- data/lib/qubrics_management_generated/models/filter_state.rb +218 -0
- data/lib/qubrics_management_generated/models/filter_state_response.rb +223 -0
- data/lib/qubrics_management_generated/models/incoming_log_item.rb +465 -0
- data/lib/qubrics_management_generated/models/incoming_log_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/incoming_log_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mail_webhook_event_payload.rb +296 -0
- data/lib/qubrics_management_generated/models/mailbox.rb +284 -0
- data/lib/qubrics_management_generated/models/mailbox_app_password_result.rb +164 -0
- data/lib/qubrics_management_generated/models/mailbox_app_password_result_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_availability_reason.rb +45 -0
- data/lib/qubrics_management_generated/models/mailbox_availability_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_availability_result.rb +240 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage.rb +409 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage_incoming.rb +422 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_cost_usage_storage.rb +299 -0
- data/lib/qubrics_management_generated/models/mailbox_create_result.rb +190 -0
- data/lib/qubrics_management_generated/models/mailbox_create_result_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_credential.rb +352 -0
- data/lib/qubrics_management_generated/models/mailbox_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_domain.rb +452 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_dns_records.rb +303 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_mail_from_records.rb +191 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_mx_record.rb +190 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_name_value_record.rb +191 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_named_mx_record.rb +217 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_verify_checks.rb +300 -0
- data/lib/qubrics_management_generated/models/mailbox_domain_verify_result.rb +377 -0
- data/lib/qubrics_management_generated/models/mailbox_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/mailbox_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_key_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy.rb +196 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_allowed_from.rb +213 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_allowed_reply_to.rb +213 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients.rb +158 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients_allow.rb +201 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_recipients_deny.rb +201 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_response.rb +223 -0
- data/lib/qubrics_management_generated/models/mailbox_send_policy_snapshot.rb +202 -0
- data/lib/qubrics_management_generated/models/mailbox_send_scope.rb +213 -0
- data/lib/qubrics_management_generated/models/management_create_domain_request.rb +209 -0
- data/lib/qubrics_management_generated/models/management_create_mailbox_key_request.rb +183 -0
- data/lib/qubrics_management_generated/models/management_create_mailbox_request.rb +270 -0
- data/lib/qubrics_management_generated/models/management_create_mailbox_request_send_scope.rb +214 -0
- data/lib/qubrics_management_generated/models/management_test_webhook200_response.rb +223 -0
- data/lib/qubrics_management_generated/models/management_update_domain_request.rb +189 -0
- data/lib/qubrics_management_generated/models/provider_allowed_actions.rb +294 -0
- data/lib/qubrics_management_generated/models/provider_create_body.rb +611 -0
- data/lib/qubrics_management_generated/models/provider_create_body_quotas.rb +174 -0
- data/lib/qubrics_management_generated/models/provider_create_body_quotas_per_day.rb +104 -0
- data/lib/qubrics_management_generated/models/provider_deleted.rb +190 -0
- data/lib/qubrics_management_generated/models/provider_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_item.rb +733 -0
- data/lib/qubrics_management_generated/models/provider_item_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/provider_item_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_limits.rb +190 -0
- data/lib/qubrics_management_generated/models/provider_limits_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_list_item.rb +695 -0
- data/lib/qubrics_management_generated/models/provider_quota_range.rb +208 -0
- data/lib/qubrics_management_generated/models/provider_quotas.rb +186 -0
- data/lib/qubrics_management_generated/models/provider_stats.rb +325 -0
- data/lib/qubrics_management_generated/models/provider_stats_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_status_counts.rb +242 -0
- data/lib/qubrics_management_generated/models/provider_test_result.rb +251 -0
- data/lib/qubrics_management_generated/models/provider_test_result_response.rb +223 -0
- data/lib/qubrics_management_generated/models/provider_type_counts.rb +246 -0
- data/lib/qubrics_management_generated/models/provider_update_body.rb +569 -0
- data/lib/qubrics_management_generated/models/provider_usage.rb +216 -0
- data/lib/qubrics_management_generated/models/provider_usage_item.rb +374 -0
- data/lib/qubrics_management_generated/models/provider_usage_response.rb +223 -0
- data/lib/qubrics_management_generated/models/replace_mailbox_send_policy.rb +165 -0
- data/lib/qubrics_management_generated/models/resource_limit_snapshot.rb +420 -0
- data/lib/qubrics_management_generated/models/response_meta.rb +164 -0
- data/lib/qubrics_management_generated/models/sending_account_limit_request.rb +190 -0
- data/lib/qubrics_management_generated/models/sending_account_limit_request_response.rb +223 -0
- data/lib/qubrics_management_generated/models/set_filter_state_body.rb +226 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit.rb +315 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request.rb +361 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_cancel.rb +190 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_cancel_response.rb +223 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_create.rb +190 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_create_response.rb +223 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_page.rb +176 -0
- data/lib/qubrics_management_generated/models/shared_amazon_ses_limit_request_page_response.rb +223 -0
- data/lib/qubrics_management_generated/models/spend_summary.rb +292 -0
- data/lib/qubrics_management_generated/models/spend_summary_response.rb +223 -0
- data/lib/qubrics_management_generated/models/success_envelope.rb +192 -0
- data/lib/qubrics_management_generated/models/transaction.rb +332 -0
- data/lib/qubrics_management_generated/models/transaction_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/update_mailbox_body.rb +211 -0
- data/lib/qubrics_management_generated/models/update_mailbox_body_send_scope.rb +214 -0
- data/lib/qubrics_management_generated/models/webhook_create_body.rb +269 -0
- data/lib/qubrics_management_generated/models/webhook_deleted_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_attempt.rb +560 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_attempt_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_payload.rb +337 -0
- data/lib/qubrics_management_generated/models/webhook_delivery_payload_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_event_data.rb +406 -0
- data/lib/qubrics_management_generated/models/webhook_event_payload.rb +304 -0
- data/lib/qubrics_management_generated/models/webhook_filters.rb +168 -0
- data/lib/qubrics_management_generated/models/webhook_subscription.rb +368 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_cursor_list_response.rb +251 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_with_secret.rb +395 -0
- data/lib/qubrics_management_generated/models/webhook_subscription_with_secret_response.rb +223 -0
- data/lib/qubrics_management_generated/models/webhook_test_response.rb +165 -0
- data/lib/qubrics_management_generated/models/webhook_update_body.rb +233 -0
- data/lib/qubrics_management_generated/version.rb +15 -0
- data/lib/qubrics_management_generated.rb +195 -0
- metadata +283 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: '0806ba337858838c50c8f82422c3f11e635222567a02ce8414060c296887029b'
|
|
4
|
+
data.tar.gz: c2efd5dadbcf0beade691e38e39a604aee8bfe937d0bc578f6c9062b8a464f14
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 2f2752c562f90b54864a207fbcbfa5ca9c715e1229c76be6e364f432befb56d6b0ff68b3b68d51d2948c5c124094e7a59979768b7f1b7e0b60708ae4ec3605bc
|
|
7
|
+
data.tar.gz: 83978ada809bf20dd480a74812b64d201d0f416adbc952de9fa5116fc44c3bdb7672ce5553725248007f77c6ddeacd35da73623c92fe833231dd15cf9de13a9a
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 3.0.0
|
|
4
|
+
|
|
5
|
+
### Changed
|
|
6
|
+
|
|
7
|
+
* Load the client with `require 'qubrics/management'`.
|
|
8
|
+
* Calendar webhook models and the `calendar.changed` event are excluded. Mail webhook models and events remain available.
|
|
9
|
+
* The Core dependency accepts `qubrics-core 2.0.0` and excludes 3.0.0.
|
|
10
|
+
|
|
11
|
+
## [2.0.1](https://github.com/Sendmux/sendmux-sdk/compare/ruby-management/v2.0.0...ruby-management/v2.0.1) (2026-09-21)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
|
|
16
|
+
* **Regenerated models:** `management_create_mailbox_key` results (`MailboxAppPasswordResultResponse#data`, a `Sendmux::Management::Generated::MailboxAppPasswordResult`) type `credential` as the canonical `MailboxCredential` — the class `management_create_mailbox` already returns in `MailboxCreateResult#credential`, with the same eight attributes (`imap_port`, `key_prefix`, `key_suffix`, `public_id`, `secret`, `server`, `smtp_port`, `username`) — instead of the generator's `MailboxAppPasswordResultCredential` copy. The per-period quotas on `management_create_provider` and `management_update_provider` bodies (`ProviderCreateBodyQuotas#per_second`, `#per_minute`, `#per_hour`, `#per_day`) accept an `Integer` or a `ProviderQuotaRange` (`min`/`max`) instead of the `ProviderCreateBodyQuotasPerDayAnyOf` copy. `WebhookSubscriptionWithSecret` (`management_create_webhook`, `management_rotate_webhook_secret`) is generated from the flat deployed schema: `secret` now sits in alphabetical attribute order (between `name` and `updated_at`, which only changes `to_hash` key order) and the class no longer defines the generator's `openapi_all_of` introspection method; no public class or accessor is added or removed. The wire format is unchanged, and `pending_request`, `MailboxCreateResult#credential` and `ProviderQuotas#per_*` are unchanged ([ab2af52](https://github.com/Sendmux/sendmux-sdk/commit/ab2af52629e73b42862aae2f40c6b60248dccf95), [b002849](https://github.com/Sendmux/sendmux-sdk/commit/b00284908ee07980f25badafaba90f4bd4eb6b25)).
|
|
17
|
+
|
|
18
|
+
### Deprecated
|
|
19
|
+
|
|
20
|
+
* `Sendmux::Management::Generated::MailboxAppPasswordResultCredential` is now a deprecated constant aliasing `MailboxCredential`, and `ProviderCreateBodyQuotasPerDayAnyOf` aliases `ProviderQuotaRange`. Referencing an old constant still works and, with `Warning[:deprecated]` enabled (`ruby -W:deprecated`), warns that it is deprecated; the aliases are removed in the next major, 3.0 ([ab2af52](https://github.com/Sendmux/sendmux-sdk/commit/ab2af52629e73b42862aae2f40c6b60248dccf95)).
|
|
21
|
+
|
|
22
|
+
## Verification behind each claim
|
|
23
|
+
|
|
24
|
+
- Operation → model mapping from `packages/ruby/management/lib/sendmux_management_generated/api/*.rb` at 67ea1c15: `management_create_mailbox_key` → `MailboxAppPasswordResultResponse` (`data: MailboxAppPasswordResult`, `models/mailbox_app_password_result_response.rb:48`); `management_create_mailbox` → `MailboxCreateResultResponse`; `management_create_provider` body `provider_create_body`, `management_update_provider` body `provider_update_body`, both with `quotas: ProviderCreateBodyQuotas` whose four periods are `ProviderCreateBodyQuotasPerDay` (`models/provider_create_body_quotas.rb:49-52`); `management_create_webhook`/`management_rotate_webhook_secret` → `WebhookSubscriptionWithSecretResponse`.
|
|
25
|
+
- ab2af52 diff: `mailbox_app_password_result.rb` `:'MailboxAppPasswordResultCredential'` → `:'MailboxCredential'`; `provider_create_body_quotas_per_day.rb` any-of `ProviderCreateBodyQuotasPerDayAnyOf` → `ProviderQuotaRange`; two copies deleted (574 lines); `sendmux_management_generated.rb` adds the two `deprecate_constant` aliases; a doc comment moves from `mailbox_credential.rb` to `mailbox_create_result.rb`. The 2.0.0 `MailboxAppPasswordResultCredential` had the same eight `attr_accessor`s as `MailboxCredential` (checked at tag ruby-management/v2.0.0).
|
|
26
|
+
- b002849 (the management part of merge 628b161): `webhook_subscription_with_secret.rb` only reorders `secret` and removes `openapi_all_of` (+31/−38).
|
|
27
|
+
- Isolated install of the built gem (`.claude/artifacts/l22/ruby-management/smoke.log`): `credential => MailboxCredential`, `openapi_any_of => [:Integer, :ProviderQuotaRange]`, `build(250) => 250`, `secret` at index 7 of 10 attributes, `openapi_all_of` absent, 2/2 aliases resolve with 2 deprecation warnings.
|
|
28
|
+
- Published `sendmux-management-2.0.0.gem` (sha256 fddae3c5…, the L5 receipt) vs the candidate: 10 member differences, exactly `CHANGELOG.md`, `version.rb`, the five regenerated models, the loader and the two removed copies (`diff-published-2.0.0-vs-candidate-2.0.1.txt`).
|
|
29
|
+
|
|
30
|
+
### Bug Fixes
|
|
31
|
+
|
|
32
|
+
* regenerate SDKs from the deployed flattened response schemas (docs 86b0f45) ([628b161](https://github.com/Sendmux/sendmux-sdk/commit/628b161d2692775ac1f4830c1d64c024ba04ed83))
|
|
33
|
+
* **ruby-management:** regenerate management models from the deployed v1.8.250 schema ([ab2af52](https://github.com/Sendmux/sendmux-sdk/commit/ab2af52629e73b42862aae2f40c6b60248dccf95))
|
|
34
|
+
* **ruby-management:** regenerate the flattened webhook secret response model ([b002849](https://github.com/Sendmux/sendmux-sdk/commit/b00284908ee07980f25badafaba90f4bd4eb6b25))
|
|
35
|
+
|
|
36
|
+
## [2.0.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-management/v1.3.0...ruby-management/v2.0.0) (2026-09-18)
|
|
37
|
+
|
|
38
|
+
### Changed
|
|
39
|
+
|
|
40
|
+
* **Breaking:** `management_list_providers` returns `ProviderListItem` instead of `ProviderItem`; list entries don't expose `variables`, while detail `ProviderItem` requires a variables hash. Update list-specific class checks and fetch detail when you need variables. See [Migrate from 1.x to 2.0](README.md#migrate-from-1x-to-20).
|
|
41
|
+
|
|
42
|
+
### Features
|
|
43
|
+
|
|
44
|
+
* integrate combined provider variables and delivery routing ([81bbf22](https://github.com/Sendmux/sendmux-sdk/commit/81bbf221a357bf5d588eba654184ff34491473df))
|
|
45
|
+
* **sdk:** add provider variables and delivery group routing ([94f52d4](https://github.com/Sendmux/sendmux-sdk/commit/94f52d4e9f6157e197308541cc5987517bac7a4a))
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Bug Fixes
|
|
49
|
+
|
|
50
|
+
* correct generated client contracts ([dd31abe](https://github.com/Sendmux/sendmux-sdk/commit/dd31abed8e264e05f4717388a0d4ada83e47d7e3))
|
|
51
|
+
* **sdk:** adopt final provider contract description and provenance ([a9bdaf5](https://github.com/Sendmux/sendmux-sdk/commit/a9bdaf58f0db684328458e269ba8aff515334d0b))
|
|
52
|
+
* **sdk:** adopt final provider contract description and provenance ([815278e](https://github.com/Sendmux/sendmux-sdk/commit/815278e76587dcba314c51202b8e764250e51ef3))
|
|
53
|
+
|
|
54
|
+
## [1.3.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-management/v1.2.0...ruby-management/v1.3.0) (2026-09-10)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Features
|
|
58
|
+
|
|
59
|
+
* add REST OAuth clients and CLI token lifecycle ([cc4a3aa](https://github.com/Sendmux/sendmux-sdk/commit/cc4a3aa6110378641418a94455ed5b9a986e65ff))
|
|
60
|
+
|
|
61
|
+
## [1.2.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-management/v1.1.1...ruby-management/v1.2.0) (2026-09-08)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Features
|
|
65
|
+
|
|
66
|
+
* add connection checks across SDKs, CLI and MCP ([77f449e](https://github.com/Sendmux/sendmux-sdk/commit/77f449e2c8cba49bc8bc84c49c35baa61120866a))
|
|
67
|
+
* **sdk:** add connection checks across clients, CLI and MCP ([3e02c67](https://github.com/Sendmux/sendmux-sdk/commit/3e02c67dcab45e37dad7abbdd4c4e1bd0b1fbbe6))
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Bug Fixes
|
|
71
|
+
|
|
72
|
+
* anchor generated Ruby email validation ([a87933b](https://github.com/Sendmux/sendmux-sdk/commit/a87933b507c572104b1832818e7db0587ad0352b))
|
|
73
|
+
* reject mailbox email line breaks in generated clients ([7934cbe](https://github.com/Sendmux/sendmux-sdk/commit/7934cbe13f1d966878239e7c1d9e75ba44927937))
|
|
74
|
+
* sync mailbox reliability clients ([fad78fa](https://github.com/Sendmux/sendmux-sdk/commit/fad78faf1d495c31bc0e0c40ef7d605f72727431))
|
|
75
|
+
* sync mailbox reliability clients ([e8e7148](https://github.com/Sendmux/sendmux-sdk/commit/e8e7148e21f8fdba790c89331e8a2e144f86be4b))
|
|
76
|
+
|
|
77
|
+
## [1.1.1](https://github.com/Sendmux/sendmux-sdk/compare/ruby-management/v1.1.0...ruby-management/v1.1.1) (2026-08-07)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### Bug Fixes
|
|
81
|
+
|
|
82
|
+
* **sdk:** regenerate management clients for the Amazon SES identity fields ([#137](https://github.com/Sendmux/sendmux-sdk/issues/137)) ([b0a3d63](https://github.com/Sendmux/sendmux-sdk/commit/b0a3d63f7d836d3d0e290a5b8c4e315a1a017e43))
|
|
83
|
+
|
|
84
|
+
## [1.1.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-management/v1.0.0...ruby-management/v1.1.0) (2026-07-08)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Features
|
|
88
|
+
|
|
89
|
+
* **sdk:** add sending attachment upload surfaces ([#96](https://github.com/Sendmux/sendmux-sdk/issues/96)) ([b8f9d5f](https://github.com/Sendmux/sendmux-sdk/commit/b8f9d5fe3c1ae510db82ce05c55cbcad92b43b44))
|
|
90
|
+
|
|
91
|
+
## 1.0.0 (2026-06-02)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### Features
|
|
95
|
+
|
|
96
|
+
* **ruby:** add generated SDK packages ([f097fdf](https://github.com/Sendmux/sendmux-sdk/commit/f097fdf6afcbc2a048d9fdb1c9a669fff2a7ca4f))
|
|
97
|
+
|
|
98
|
+
## 1.0.0
|
|
99
|
+
|
|
100
|
+
- Initial generated Ruby Management API package.
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Sendmux
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# qubrics-management
|
|
2
|
+
|
|
3
|
+
[](https://rubygems.org/gems/qubrics-management)
|
|
4
|
+
[](https://github.com/qubrics/qubrics-sdk/actions/workflows/ci.yml)
|
|
5
|
+
[](https://github.com/qubrics/qubrics-sdk/blob/main/LICENSE)
|
|
6
|
+
|
|
7
|
+
Ruby SDK package for the Qubrics Management API.
|
|
8
|
+
|
|
9
|
+
## Documentation
|
|
10
|
+
|
|
11
|
+
- Ruby SDK guide: https://qubrics.com/docs/sdks/ruby
|
|
12
|
+
- Management API reference: https://qubrics.com/docs/api
|
|
13
|
+
- Source: https://github.com/qubrics/qubrics-sdk/tree/main/packages/ruby/management
|
|
14
|
+
- Changelog: https://github.com/qubrics/qubrics-sdk/blob/main/packages/ruby/management/CHANGELOG.md
|
|
15
|
+
|
|
16
|
+
## Requirements
|
|
17
|
+
|
|
18
|
+
- Ruby 3.1 or newer.
|
|
19
|
+
- A root Qubrics API key beginning with `smx_root_`.
|
|
20
|
+
|
|
21
|
+
For OAuth, use a REST access token with the scopes and mailbox access required by the operation. See [OAuth for REST APIs](https://qubrics.com/docs/developer-tools/oauth).
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
gem install qubrics-management
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Or add it to your Gemfile:
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
gem "qubrics-management", "~> 3.0"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Provider model migration
|
|
36
|
+
|
|
37
|
+
If you check sending-account result classes, update those checks to use the current
|
|
38
|
+
models. `management_list_providers` returns `ProviderListItem` entries instead of
|
|
39
|
+
`ProviderItem`. List entries don't expose `variables`; detail results remain
|
|
40
|
+
`ProviderItem` and require a variables hash, which is empty when none are set.
|
|
41
|
+
|
|
42
|
+
1. Update list-specific class checks to use the class loaded by the public entry
|
|
43
|
+
point:
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
require "qubrics/management"
|
|
47
|
+
|
|
48
|
+
def provider_list_item?(item)
|
|
49
|
+
# Before: item.is_a?(Qubrics::Management::Generated::ProviderItem)
|
|
50
|
+
item.is_a?(Qubrics::Management::Generated::ProviderListItem)
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
2. If you need an account's variables, fetch its detail using the public client.
|
|
55
|
+
Pass the account's `id` as the `public_id` argument:
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
def provider_variables(client, public_id)
|
|
59
|
+
detail = client.sending_accounts.management_get_provider(public_id).data
|
|
60
|
+
detail.variables
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Don't convert a list entry into `ProviderItem` or substitute an empty variables
|
|
65
|
+
hash for the account's actual variables. Update hand-built detail fixtures to
|
|
66
|
+
include `variables: {}` when no variables are set.
|
|
67
|
+
|
|
68
|
+
3. Run your application's tests with the updated bundle. Verify that list
|
|
69
|
+
handling accepts `ProviderListItem` and only detail handling reads variables.
|
|
70
|
+
|
|
71
|
+
## OAuth access tokens
|
|
72
|
+
|
|
73
|
+
Pass either `api_key:` or `access_token:`. `access_token:` accepts a bare token string or a callable; the callable is evaluated once per authenticated request. Your application owns token storage, expiry checks and refresh coordination.
|
|
74
|
+
|
|
75
|
+
```ruby
|
|
76
|
+
require "qubrics/management"
|
|
77
|
+
|
|
78
|
+
client = Qubrics::Management::Client.new(
|
|
79
|
+
access_token: -> { ENV.fetch("QUBRICS_ACCESS_TOKEN") }
|
|
80
|
+
)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Usage
|
|
84
|
+
|
|
85
|
+
Create a management client with a root key for the API-key example below.
|
|
86
|
+
|
|
87
|
+
```ruby
|
|
88
|
+
require "qubrics/management"
|
|
89
|
+
|
|
90
|
+
client = Qubrics::Management::Client.new(
|
|
91
|
+
api_key: ENV.fetch("QUBRICS_ROOT_KEY")
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
mailboxes = client.mailboxes.management_list_mailboxes(limit: 25)
|
|
95
|
+
domains = client.domains.management_list_domains(limit: 25)
|
|
96
|
+
|
|
97
|
+
puts mailboxes.data.length
|
|
98
|
+
puts domains.data.length
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Client surface
|
|
102
|
+
|
|
103
|
+
`Qubrics::Management::Client` exposes generated API groups:
|
|
104
|
+
|
|
105
|
+
- `client.billing`
|
|
106
|
+
- `client.connection`
|
|
107
|
+
- `client.domain_filters`
|
|
108
|
+
- `client.domains`
|
|
109
|
+
- `client.emails`
|
|
110
|
+
- `client.inboxes`
|
|
111
|
+
- `client.mailbox_filters`
|
|
112
|
+
- `client.mailboxes`
|
|
113
|
+
- `client.sending_accounts`
|
|
114
|
+
- `client.webhooks`
|
|
115
|
+
|
|
116
|
+
Each group exposes generated operation methods using the `management_` prefix, such as `management_list_mailboxes`, `management_create_mailbox`, `management_list_domains`, and `management_create_webhook`.
|
|
117
|
+
|
|
118
|
+
### Idempotency and conditional requests
|
|
119
|
+
|
|
120
|
+
Mutating generated operations accept option hashes. Use the core header helpers for idempotency and ETag preconditions.
|
|
121
|
+
|
|
122
|
+
```ruby
|
|
123
|
+
client.webhooks.management_create_webhook(
|
|
124
|
+
Qubrics::Core::Headers.idempotency_key("create-webhook-001").merge(
|
|
125
|
+
webhook_create_body: Qubrics::Management::Generated::WebhookCreateBody.new(
|
|
126
|
+
url: "https://example.com/webhook",
|
|
127
|
+
event_types: ["sendmux.test"]
|
|
128
|
+
)
|
|
129
|
+
)
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
client.domains.management_update_domain(
|
|
133
|
+
"mdom_123",
|
|
134
|
+
Qubrics::Core::Headers.if_match('W/"etag"')
|
|
135
|
+
)
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Pagination and errors
|
|
139
|
+
|
|
140
|
+
Use `Qubrics::Core.each_cursor` for list operations that return cursor pagination. Generated API errors are mapped to `Qubrics::Core::ApiError`.
|
|
141
|
+
|
|
142
|
+
```ruby
|
|
143
|
+
pager = Qubrics::Core.each_cursor(lambda do |opts|
|
|
144
|
+
client.mailboxes.management_list_mailboxes(opts.merge(limit: 50))
|
|
145
|
+
end)
|
|
146
|
+
|
|
147
|
+
pager.each { |mailbox| puts mailbox.id }
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Support
|
|
151
|
+
|
|
152
|
+
- Documentation: https://qubrics.com/docs
|
|
153
|
+
- Contact: contact@qubrics.com
|
|
154
|
+
|
|
155
|
+
## Licence
|
|
156
|
+
|
|
157
|
+
MIT licence. See https://github.com/qubrics/qubrics-sdk/blob/main/LICENSE.
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Qubrics
|
|
4
|
+
module Management
|
|
5
|
+
DEFAULT_BASE_URL = 'https://app.qubrics.com/api/v1'
|
|
6
|
+
|
|
7
|
+
class ApiClient < Generated::ApiClient
|
|
8
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
|
9
|
+
auth_names = Array(auth_names)
|
|
10
|
+
if !auth_names.empty? && (auth_names - %w[UploadTokenQubrics UploadTokenSendmux]).empty?
|
|
11
|
+
apply_upload_token_auth!(header_params)
|
|
12
|
+
return
|
|
13
|
+
end
|
|
14
|
+
return super unless config.access_token_getter && !auth_names.empty?
|
|
15
|
+
|
|
16
|
+
header_params['Authorization'] = "Bearer #{config.access_token_with_refresh}"
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def call_api(...)
|
|
20
|
+
super
|
|
21
|
+
rescue Generated::ApiError => e
|
|
22
|
+
raise Qubrics::Core::ErrorMapper.map(e)
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
private
|
|
26
|
+
|
|
27
|
+
def apply_upload_token_auth!(header_params)
|
|
28
|
+
upload_headers = %w[X-Qubrics-Upload-Token X-Sendmux-Upload-Token]
|
|
29
|
+
return if upload_headers.any? { |header| header_params[header] || header_params[header.to_sym] }
|
|
30
|
+
|
|
31
|
+
upload_headers.each do |header|
|
|
32
|
+
token = config.api_key_with_prefix(header)
|
|
33
|
+
next if token.nil? || token.empty?
|
|
34
|
+
|
|
35
|
+
header_params[header] = token
|
|
36
|
+
break
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
class Client
|
|
42
|
+
attr_reader :api_client, :configuration
|
|
43
|
+
|
|
44
|
+
def initialize(api_key: nil, access_token: nil, base_url: nil, retry_options: nil)
|
|
45
|
+
qubrics_base_url = ENV.fetch('QUBRICS_BASE_URL', nil)
|
|
46
|
+
qubrics_base_url = nil if qubrics_base_url&.empty?
|
|
47
|
+
@configuration = Qubrics::Core::Auth.configure_bearer(
|
|
48
|
+
Generated::Configuration.new,
|
|
49
|
+
api_key,
|
|
50
|
+
Qubrics::Core::ApiKeySurface::ROOT,
|
|
51
|
+
base_url: base_url || qubrics_base_url || ENV.fetch('SENDMUX_BASE_URL', DEFAULT_BASE_URL),
|
|
52
|
+
access_token: access_token
|
|
53
|
+
)
|
|
54
|
+
Qubrics::Core::Retry.configure(@configuration, retry_options)
|
|
55
|
+
@api_client = ApiClient.new(@configuration)
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
def billing
|
|
59
|
+
@billing ||= Generated::BillingApi.new(@api_client)
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def connection
|
|
63
|
+
@connection ||= Generated::ConnectionApi.new(@api_client)
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
def domain_filters
|
|
67
|
+
@domain_filters ||= Generated::DomainFiltersApi.new(@api_client)
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
def domains
|
|
71
|
+
@domains ||= Generated::DomainsApi.new(@api_client)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
def emails
|
|
75
|
+
@emails ||= Generated::EmailsApi.new(@api_client)
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
def inboxes
|
|
79
|
+
@inboxes ||= Generated::InboxesApi.new(@api_client)
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
def mailbox_filters
|
|
83
|
+
@mailbox_filters ||= Generated::MailboxFiltersApi.new(@api_client)
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
def mailboxes
|
|
87
|
+
@mailboxes ||= Generated::MailboxesApi.new(@api_client)
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
def sending_accounts
|
|
91
|
+
@sending_accounts ||= Generated::SendingAccountsApi.new(@api_client)
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
def webhooks
|
|
95
|
+
@webhooks ||= Generated::WebhooksApi.new(@api_client)
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Qubrics API
|
|
3
|
+
|
|
4
|
+
#Programmatic access to your Qubrics email infrastructure.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.22.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Qubrics::Management::Generated
|
|
16
|
+
class BillingApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get spend summary
|
|
23
|
+
# Returns a spend summary over a configurable lookback period.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [String] :days
|
|
26
|
+
# @return [SpendSummaryResponse]
|
|
27
|
+
def management_get_spend_summary(opts = {})
|
|
28
|
+
data, _status_code, _headers = management_get_spend_summary_with_http_info(opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get spend summary
|
|
33
|
+
# Returns a spend summary over a configurable lookback period.
|
|
34
|
+
# @param [Hash] opts the optional parameters
|
|
35
|
+
# @option opts [String] :days
|
|
36
|
+
# @return [Array<(SpendSummaryResponse, Integer, Hash)>] SpendSummaryResponse data, response status code and response headers
|
|
37
|
+
def management_get_spend_summary_with_http_info(opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: BillingApi.management_get_spend_summary ...'
|
|
40
|
+
end
|
|
41
|
+
allowable_values = ["7", "30", "90", "unknown_default_open_api"]
|
|
42
|
+
if @api_client.config.client_side_validation && opts[:'days'] && !allowable_values.include?(opts[:'days'])
|
|
43
|
+
fail ArgumentError, "invalid value for \"days\", must be one of #{allowable_values}"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/billing/summary'
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
|
|
51
|
+
|
|
52
|
+
# header parameters
|
|
53
|
+
header_params = opts[:header_params] || {}
|
|
54
|
+
# HTTP header 'Accept' (if needed)
|
|
55
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
56
|
+
|
|
57
|
+
# form parameters
|
|
58
|
+
form_params = opts[:form_params] || {}
|
|
59
|
+
|
|
60
|
+
# http body (model)
|
|
61
|
+
post_body = opts[:debug_body]
|
|
62
|
+
|
|
63
|
+
# return_type
|
|
64
|
+
return_type = opts[:debug_return_type] || 'SpendSummaryResponse'
|
|
65
|
+
|
|
66
|
+
# auth_names
|
|
67
|
+
auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
|
|
68
|
+
|
|
69
|
+
new_options = opts.merge(
|
|
70
|
+
:operation => :"BillingApi.management_get_spend_summary",
|
|
71
|
+
:header_params => header_params,
|
|
72
|
+
:query_params => query_params,
|
|
73
|
+
:form_params => form_params,
|
|
74
|
+
:body => post_body,
|
|
75
|
+
:auth_names => auth_names,
|
|
76
|
+
:return_type => return_type
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
80
|
+
if @api_client.config.debugging
|
|
81
|
+
@api_client.config.logger.debug "API called: BillingApi#management_get_spend_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
82
|
+
end
|
|
83
|
+
return data, status_code, headers
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Get current balance
|
|
87
|
+
# Returns the current spendable balance.
|
|
88
|
+
# @param [Hash] opts the optional parameters
|
|
89
|
+
# @return [BalanceResponse]
|
|
90
|
+
def management_list_balance(opts = {})
|
|
91
|
+
data, _status_code, _headers = management_list_balance_with_http_info(opts)
|
|
92
|
+
data
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Get current balance
|
|
96
|
+
# Returns the current spendable balance.
|
|
97
|
+
# @param [Hash] opts the optional parameters
|
|
98
|
+
# @return [Array<(BalanceResponse, Integer, Hash)>] BalanceResponse data, response status code and response headers
|
|
99
|
+
def management_list_balance_with_http_info(opts = {})
|
|
100
|
+
if @api_client.config.debugging
|
|
101
|
+
@api_client.config.logger.debug 'Calling API: BillingApi.management_list_balance ...'
|
|
102
|
+
end
|
|
103
|
+
# resource path
|
|
104
|
+
local_var_path = '/billing/balance'
|
|
105
|
+
|
|
106
|
+
# query parameters
|
|
107
|
+
query_params = opts[:query_params] || {}
|
|
108
|
+
|
|
109
|
+
# header parameters
|
|
110
|
+
header_params = opts[:header_params] || {}
|
|
111
|
+
# HTTP header 'Accept' (if needed)
|
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
113
|
+
|
|
114
|
+
# form parameters
|
|
115
|
+
form_params = opts[:form_params] || {}
|
|
116
|
+
|
|
117
|
+
# http body (model)
|
|
118
|
+
post_body = opts[:debug_body]
|
|
119
|
+
|
|
120
|
+
# return_type
|
|
121
|
+
return_type = opts[:debug_return_type] || 'BalanceResponse'
|
|
122
|
+
|
|
123
|
+
# auth_names
|
|
124
|
+
auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
|
|
125
|
+
|
|
126
|
+
new_options = opts.merge(
|
|
127
|
+
:operation => :"BillingApi.management_list_balance",
|
|
128
|
+
:header_params => header_params,
|
|
129
|
+
:query_params => query_params,
|
|
130
|
+
:form_params => form_params,
|
|
131
|
+
:body => post_body,
|
|
132
|
+
:auth_names => auth_names,
|
|
133
|
+
:return_type => return_type
|
|
134
|
+
)
|
|
135
|
+
|
|
136
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
137
|
+
if @api_client.config.debugging
|
|
138
|
+
@api_client.config.logger.debug "API called: BillingApi#management_list_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
139
|
+
end
|
|
140
|
+
return data, status_code, headers
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
# List transactions
|
|
144
|
+
# Returns paginated credit transaction history with optional type filter. Uses cursor-based pagination ordered by created_at descending — pass `cursor=<next_cursor>` from the previous response to fetch the next page.
|
|
145
|
+
# @param [Hash] opts the optional parameters
|
|
146
|
+
# @option opts [String] :cursor
|
|
147
|
+
# @option opts [Integer] :limit
|
|
148
|
+
# @option opts [String] :type
|
|
149
|
+
# @return [TransactionCursorListResponse]
|
|
150
|
+
def management_list_transactions(opts = {})
|
|
151
|
+
data, _status_code, _headers = management_list_transactions_with_http_info(opts)
|
|
152
|
+
data
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# List transactions
|
|
156
|
+
# Returns paginated credit transaction history with optional type filter. Uses cursor-based pagination ordered by created_at descending — pass `cursor=<next_cursor>` from the previous response to fetch the next page.
|
|
157
|
+
# @param [Hash] opts the optional parameters
|
|
158
|
+
# @option opts [String] :cursor
|
|
159
|
+
# @option opts [Integer] :limit
|
|
160
|
+
# @option opts [String] :type
|
|
161
|
+
# @return [Array<(TransactionCursorListResponse, Integer, Hash)>] TransactionCursorListResponse data, response status code and response headers
|
|
162
|
+
def management_list_transactions_with_http_info(opts = {})
|
|
163
|
+
if @api_client.config.debugging
|
|
164
|
+
@api_client.config.logger.debug 'Calling API: BillingApi.management_list_transactions ...'
|
|
165
|
+
end
|
|
166
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
167
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BillingApi.management_list_transactions, must be smaller than or equal to 100.'
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
171
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BillingApi.management_list_transactions, must be greater than or equal to 1.'
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
allowable_values = ["PURCHASE", "USAGE", "AUTO_TOPUP", "REFUND", "ADJUSTMENT", "unknown_default_open_api"]
|
|
175
|
+
if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
|
|
176
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
177
|
+
end
|
|
178
|
+
# resource path
|
|
179
|
+
local_var_path = '/billing/transactions'
|
|
180
|
+
|
|
181
|
+
# query parameters
|
|
182
|
+
query_params = opts[:query_params] || {}
|
|
183
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
184
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
185
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
186
|
+
|
|
187
|
+
# header parameters
|
|
188
|
+
header_params = opts[:header_params] || {}
|
|
189
|
+
# HTTP header 'Accept' (if needed)
|
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
191
|
+
|
|
192
|
+
# form parameters
|
|
193
|
+
form_params = opts[:form_params] || {}
|
|
194
|
+
|
|
195
|
+
# http body (model)
|
|
196
|
+
post_body = opts[:debug_body]
|
|
197
|
+
|
|
198
|
+
# return_type
|
|
199
|
+
return_type = opts[:debug_return_type] || 'TransactionCursorListResponse'
|
|
200
|
+
|
|
201
|
+
# auth_names
|
|
202
|
+
auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
|
|
203
|
+
|
|
204
|
+
new_options = opts.merge(
|
|
205
|
+
:operation => :"BillingApi.management_list_transactions",
|
|
206
|
+
:header_params => header_params,
|
|
207
|
+
:query_params => query_params,
|
|
208
|
+
:form_params => form_params,
|
|
209
|
+
:body => post_body,
|
|
210
|
+
:auth_names => auth_names,
|
|
211
|
+
:return_type => return_type
|
|
212
|
+
)
|
|
213
|
+
|
|
214
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
215
|
+
if @api_client.config.debugging
|
|
216
|
+
@api_client.config.logger.debug "API called: BillingApi#management_list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
217
|
+
end
|
|
218
|
+
return data, status_code, headers
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
end
|