orb-billing 1.46.0 → 1.47.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 +17 -1
- data/README.md +1 -1
- data/lib/orb/models/invoice_issue_summary_response.rb +2 -1
- data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
- data/lib/orb/models/invoice_list_summary_response.rb +2 -1
- data/lib/orb/models/metric_list_params.rb +21 -1
- data/lib/orb/models/metric_update_params.rb +17 -1
- data/lib/orb/models/plan_update_params.rb +9 -1
- data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
- data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
- data/lib/orb/models/webhook_endpoint.rb +28 -1
- data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
- data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
- data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
- data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
- data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +5 -9
- data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +5 -9
- data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +5 -9
- data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +5 -9
- data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +5 -9
- data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +7 -7
- data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +7 -7
- data/lib/orb/resources/metrics.rb +15 -5
- data/lib/orb/resources/plans/external_plan_id.rb +6 -3
- data/lib/orb/resources/plans.rb +6 -3
- data/lib/orb/resources/webhook_endpoints.rb +6 -2
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
- data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
- data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
- data/rbi/orb/models/metric_list_params.rbi +29 -0
- data/rbi/orb/models/metric_update_params.rbi +16 -0
- data/rbi/orb/models/plan_update_params.rbi +8 -0
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
- data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhook_endpoint.rbi +39 -0
- data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
- data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
- data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
- data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
- data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +9 -9
- data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +9 -9
- data/rbi/orb/resources/metrics.rbi +16 -3
- data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
- data/rbi/orb/resources/plans.rbi +6 -2
- data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
- data/sig/orb/models/metric_list_params.rbs +18 -1
- data/sig/orb/models/metric_update_params.rbs +14 -1
- data/sig/orb/models/plan_update_params.rbs +6 -1
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
- data/sig/orb/models/webhook_endpoint.rbs +16 -0
- data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
- data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
- data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
- data/sig/orb/resources/metrics.rbs +3 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
- data/sig/orb/resources/plans.rbs +1 -0
- data/sig/orb/resources/webhook_endpoints.rbs +2 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d7c98b26b6434d034ca980f43f02584b1899396f1a4e527aafbcf81d7b47616
|
|
4
|
+
data.tar.gz: d92ce8e10c43f62392c762f01ccae79e520badae4a7f66a6fb91f73f3f53010d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d40cf89aa5841db9d6c37dddacd5521aca697e8723a8c6f08fe0514ab201bf06e129831ab244d73687ee674add8265286d6c9cdfb347c77b6491c837ffd342c2
|
|
7
|
+
data.tar.gz: 608dfcf816e143b4845c999ae90f0e84c7c5cf14157246b0cb61e960be81ceaad1b564a09ccd5ad3cc11d0d3d24b1d77e89010b72f3eedec9ac24d615c99dcc9
|
data/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,27 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.47.0](https://github.com/orbcorp/orb-ruby/compare/v1.46.0...v1.47.0) (2026-10-23)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** Add customer credit balance summary endpoints ([86aae77](https://github.com/orbcorp/orb-ruby/commit/86aae7723d2ae70a7e2a2fa25e32d851e7e7063c))
|
|
9
|
+
* **api:** Add endpoint to update credit block metadata ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
|
|
10
|
+
* **api:** api update ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
|
|
11
|
+
* **api:** api update ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
|
|
12
|
+
* **api:** api update ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Chores
|
|
16
|
+
|
|
17
|
+
* correct the standard webhook unwrap changelog entry ([#7](https://github.com/orbcorp/orb-ruby/issues/7)) ([637729f](https://github.com/orbcorp/orb-ruby/commit/637729fc02855e0599b70f4ce6c33a92e9ae1035))
|
|
18
|
+
|
|
3
19
|
## [1.46.0](https://github.com/orbcorp/orb-ruby/compare/v1.45.0...v1.46.0) (2026-10-22)
|
|
4
20
|
|
|
5
21
|
|
|
6
22
|
### Features
|
|
7
23
|
|
|
8
|
-
* **api:**
|
|
24
|
+
* **api:** add `webhooks.standard.unwrap_standard`, which parses standard webhook payloads ([1682d74](https://github.com/orbcorp/orb-ruby/commit/1682d74396deb8eb97d937edf47b041df59e44ed))
|
|
9
25
|
|
|
10
26
|
|
|
11
27
|
### Chores
|
data/README.md
CHANGED
|
@@ -381,7 +381,8 @@ module Orb
|
|
|
381
381
|
# Some parameter documentations has been truncated, see
|
|
382
382
|
# {Orb::Models::InvoiceIssueSummaryResponse} for more details.
|
|
383
383
|
#
|
|
384
|
-
#
|
|
384
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
385
|
+
# Fetch the invoice for those.
|
|
385
386
|
#
|
|
386
387
|
# @param id [String]
|
|
387
388
|
#
|
|
@@ -16,7 +16,8 @@ module Orb
|
|
|
16
16
|
required :created_at, Time
|
|
17
17
|
|
|
18
18
|
# @!attribute invoice
|
|
19
|
-
#
|
|
19
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
20
|
+
# Fetch the invoice for those.
|
|
20
21
|
#
|
|
21
22
|
# @return [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice]
|
|
22
23
|
required :invoice, -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice }
|
|
@@ -50,7 +51,7 @@ module Orb
|
|
|
50
51
|
#
|
|
51
52
|
# @param created_at [Time] The time at which this event was created, to the second.
|
|
52
53
|
#
|
|
53
|
-
# @param invoice [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice]
|
|
54
|
+
# @param invoice [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
|
|
54
55
|
#
|
|
55
56
|
# @param payload_style [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
|
|
56
57
|
#
|
|
@@ -437,7 +438,8 @@ module Orb
|
|
|
437
438
|
# Some parameter documentations has been truncated, see
|
|
438
439
|
# {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice} for more details.
|
|
439
440
|
#
|
|
440
|
-
#
|
|
441
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
442
|
+
# Fetch the invoice for those.
|
|
441
443
|
#
|
|
442
444
|
# @param id [String]
|
|
443
445
|
#
|
|
@@ -381,7 +381,8 @@ module Orb
|
|
|
381
381
|
# Some parameter documentations has been truncated, see
|
|
382
382
|
# {Orb::Models::InvoiceListSummaryResponse} for more details.
|
|
383
383
|
#
|
|
384
|
-
#
|
|
384
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
385
|
+
# Fetch the invoice for those.
|
|
385
386
|
#
|
|
386
387
|
# @param id [String]
|
|
387
388
|
#
|
|
@@ -40,7 +40,13 @@ module Orb
|
|
|
40
40
|
# @return [Integer, nil]
|
|
41
41
|
optional :limit, Integer
|
|
42
42
|
|
|
43
|
-
# @!
|
|
43
|
+
# @!attribute status
|
|
44
|
+
# The metric status to filter to ('active', 'archived', or 'draft').
|
|
45
|
+
#
|
|
46
|
+
# @return [Symbol, Orb::Models::MetricListParams::Status, nil]
|
|
47
|
+
optional :status, enum: -> { Orb::MetricListParams::Status }, nil?: true
|
|
48
|
+
|
|
49
|
+
# @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {})
|
|
44
50
|
# Some parameter documentations has been truncated, see
|
|
45
51
|
# {Orb::Models::MetricListParams} for more details.
|
|
46
52
|
#
|
|
@@ -56,7 +62,21 @@ module Orb
|
|
|
56
62
|
#
|
|
57
63
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
|
58
64
|
#
|
|
65
|
+
# @param status [Symbol, Orb::Models::MetricListParams::Status, nil] The metric status to filter to ('active', 'archived', or 'draft').
|
|
66
|
+
#
|
|
59
67
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
68
|
+
|
|
69
|
+
# The metric status to filter to ('active', 'archived', or 'draft').
|
|
70
|
+
module Status
|
|
71
|
+
extend Orb::Internal::Type::Enum
|
|
72
|
+
|
|
73
|
+
ACTIVE = :active
|
|
74
|
+
ARCHIVED = :archived
|
|
75
|
+
DRAFT = :draft
|
|
76
|
+
|
|
77
|
+
# @!method self.values
|
|
78
|
+
# @return [Array<Symbol>]
|
|
79
|
+
end
|
|
60
80
|
end
|
|
61
81
|
end
|
|
62
82
|
end
|
|
@@ -12,6 +12,12 @@ module Orb
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :metric_id, String
|
|
14
14
|
|
|
15
|
+
# @!attribute description
|
|
16
|
+
# A description of the metric.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :description, String, nil?: true
|
|
20
|
+
|
|
15
21
|
# @!attribute metadata
|
|
16
22
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
17
23
|
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -20,14 +26,24 @@ module Orb
|
|
|
20
26
|
# @return [Hash{Symbol=>String, nil}, nil]
|
|
21
27
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
22
28
|
|
|
23
|
-
# @!
|
|
29
|
+
# @!attribute name
|
|
30
|
+
# The name of the metric.
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :name, String, nil?: true
|
|
34
|
+
|
|
35
|
+
# @!method initialize(metric_id:, description: nil, metadata: nil, name: nil, request_options: {})
|
|
24
36
|
# Some parameter documentations has been truncated, see
|
|
25
37
|
# {Orb::Models::MetricUpdateParams} for more details.
|
|
26
38
|
#
|
|
27
39
|
# @param metric_id [String]
|
|
28
40
|
#
|
|
41
|
+
# @param description [String, nil] A description of the metric.
|
|
42
|
+
#
|
|
29
43
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
30
44
|
#
|
|
45
|
+
# @param name [String, nil] The name of the metric.
|
|
46
|
+
#
|
|
31
47
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
32
48
|
end
|
|
33
49
|
end
|
|
@@ -34,7 +34,13 @@ module Orb
|
|
|
34
34
|
# @return [Hash{Symbol=>String, nil}, nil]
|
|
35
35
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
36
36
|
|
|
37
|
-
# @!
|
|
37
|
+
# @!attribute name
|
|
38
|
+
# The name of the plan.
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :name, String, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!method initialize(plan_id:, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
|
|
38
44
|
# Some parameter documentations has been truncated, see
|
|
39
45
|
# {Orb::Models::PlanUpdateParams} for more details.
|
|
40
46
|
#
|
|
@@ -46,6 +52,8 @@ module Orb
|
|
|
46
52
|
#
|
|
47
53
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
48
54
|
#
|
|
55
|
+
# @param name [String, nil] The name of the plan.
|
|
56
|
+
#
|
|
49
57
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
50
58
|
end
|
|
51
59
|
end
|
|
@@ -35,7 +35,13 @@ module Orb
|
|
|
35
35
|
# @return [Hash{Symbol=>String, nil}, nil]
|
|
36
36
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
37
37
|
|
|
38
|
-
# @!
|
|
38
|
+
# @!attribute name
|
|
39
|
+
# The name of the plan.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :name, String, nil?: true
|
|
43
|
+
|
|
44
|
+
# @!method initialize(other_external_plan_id:, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
|
|
39
45
|
# Some parameter documentations has been truncated, see
|
|
40
46
|
# {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
|
|
41
47
|
#
|
|
@@ -47,6 +53,8 @@ module Orb
|
|
|
47
53
|
#
|
|
48
54
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
49
55
|
#
|
|
56
|
+
# @param name [String, nil] The name of the plan.
|
|
57
|
+
#
|
|
50
58
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
51
59
|
end
|
|
52
60
|
end
|
|
@@ -30,10 +30,8 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::SubscriptionAlertDisabledWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
36
|
-
# serialization.
|
|
33
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
34
|
+
# dates, plan and customer.
|
|
37
35
|
#
|
|
38
36
|
# @return [Orb::Models::SubscriptionAlertDisabledWebhookEvent::Subscription]
|
|
39
37
|
required :subscription, -> { Orb::SubscriptionAlertDisabledWebhookEvent::Subscription }
|
|
@@ -58,7 +56,7 @@ module Orb
|
|
|
58
56
|
#
|
|
59
57
|
# @param properties [Orb::Models::SubscriptionAlertDisabledWebhookEvent::Properties] Sent when the system disables an alert on its own, currently for cardinality-lim
|
|
60
58
|
#
|
|
61
|
-
# @param subscription [Orb::Models::SubscriptionAlertDisabledWebhookEvent::Subscription]
|
|
59
|
+
# @param subscription [Orb::Models::SubscriptionAlertDisabledWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
|
|
62
60
|
#
|
|
63
61
|
# @param type [Symbol, Orb::Models::SubscriptionAlertDisabledWebhookEvent::Type] The event this payload describes.
|
|
64
62
|
|
|
@@ -574,10 +572,8 @@ module Orb
|
|
|
574
572
|
required :status, enum: -> { Orb::SubscriptionAlertDisabledWebhookEvent::Subscription::Status }
|
|
575
573
|
|
|
576
574
|
# @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
|
|
577
|
-
#
|
|
578
|
-
#
|
|
579
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
580
|
-
# serialization.
|
|
575
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
576
|
+
# dates, plan and customer.
|
|
581
577
|
#
|
|
582
578
|
# @param id [String]
|
|
583
579
|
# @param customer [Orb::Models::CustomerMinified]
|
|
@@ -30,10 +30,8 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::SubscriptionGroupedCostExceededWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
36
|
-
# serialization.
|
|
33
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
34
|
+
# dates, plan and customer.
|
|
37
35
|
#
|
|
38
36
|
# @return [Orb::Models::SubscriptionGroupedCostExceededWebhookEvent::Subscription]
|
|
39
37
|
required :subscription, -> { Orb::SubscriptionGroupedCostExceededWebhookEvent::Subscription }
|
|
@@ -58,7 +56,7 @@ module Orb
|
|
|
58
56
|
#
|
|
59
57
|
# @param properties [Orb::Models::SubscriptionGroupedCostExceededWebhookEvent::Properties] Every group that crossed a threshold for one alert, batched into a single messag
|
|
60
58
|
#
|
|
61
|
-
# @param subscription [Orb::Models::SubscriptionGroupedCostExceededWebhookEvent::Subscription]
|
|
59
|
+
# @param subscription [Orb::Models::SubscriptionGroupedCostExceededWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
|
|
62
60
|
#
|
|
63
61
|
# @param type [Symbol, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent::Type] The event this payload describes.
|
|
64
62
|
|
|
@@ -605,10 +603,8 @@ module Orb
|
|
|
605
603
|
required :status, enum: -> { Orb::SubscriptionGroupedCostExceededWebhookEvent::Subscription::Status }
|
|
606
604
|
|
|
607
605
|
# @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
|
|
608
|
-
#
|
|
609
|
-
#
|
|
610
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
611
|
-
# serialization.
|
|
606
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
607
|
+
# dates, plan and customer.
|
|
612
608
|
#
|
|
613
609
|
# @param id [String]
|
|
614
610
|
# @param customer [Orb::Models::CustomerMinified]
|
|
@@ -29,10 +29,8 @@ module Orb
|
|
|
29
29
|
required :properties, -> { Orb::SubscriptionInvoicingThresholdExceededWebhookEvent::Properties }
|
|
30
30
|
|
|
31
31
|
# @!attribute subscription
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
35
|
-
# serialization.
|
|
32
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
33
|
+
# dates, plan and customer.
|
|
36
34
|
#
|
|
37
35
|
# @return [Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent::Subscription]
|
|
38
36
|
required :subscription, -> { Orb::SubscriptionInvoicingThresholdExceededWebhookEvent::Subscription }
|
|
@@ -59,7 +57,7 @@ module Orb
|
|
|
59
57
|
#
|
|
60
58
|
# @param properties [Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent::Properties]
|
|
61
59
|
#
|
|
62
|
-
# @param subscription [Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent::Subscription]
|
|
60
|
+
# @param subscription [Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
|
|
63
61
|
#
|
|
64
62
|
# @param type [Symbol, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent::Type] The event this payload describes.
|
|
65
63
|
|
|
@@ -142,10 +140,8 @@ module Orb
|
|
|
142
140
|
enum: -> { Orb::SubscriptionInvoicingThresholdExceededWebhookEvent::Subscription::Status }
|
|
143
141
|
|
|
144
142
|
# @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
|
|
145
|
-
#
|
|
146
|
-
#
|
|
147
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
148
|
-
# serialization.
|
|
143
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
144
|
+
# dates, plan and customer.
|
|
149
145
|
#
|
|
150
146
|
# @param id [String]
|
|
151
147
|
# @param customer [Orb::Models::CustomerMinified]
|
|
@@ -30,10 +30,8 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::SubscriptionLicenseAllocationResetWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
36
|
-
# serialization.
|
|
33
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
34
|
+
# dates, plan and customer.
|
|
37
35
|
#
|
|
38
36
|
# @return [Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Subscription]
|
|
39
37
|
required :subscription, -> { Orb::SubscriptionLicenseAllocationResetWebhookEvent::Subscription }
|
|
@@ -58,7 +56,7 @@ module Orb
|
|
|
58
56
|
#
|
|
59
57
|
# @param properties [Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Properties] Fires at the start of a billing period when license allocations are replenished.
|
|
60
58
|
#
|
|
61
|
-
# @param subscription [Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Subscription]
|
|
59
|
+
# @param subscription [Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
|
|
62
60
|
#
|
|
63
61
|
# @param type [Symbol, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Type] The event this payload describes.
|
|
64
62
|
|
|
@@ -164,10 +162,8 @@ module Orb
|
|
|
164
162
|
required :status, enum: -> { Orb::SubscriptionLicenseAllocationResetWebhookEvent::Subscription::Status }
|
|
165
163
|
|
|
166
164
|
# @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
170
|
-
# serialization.
|
|
165
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
166
|
+
# dates, plan and customer.
|
|
171
167
|
#
|
|
172
168
|
# @param id [String]
|
|
173
169
|
# @param customer [Orb::Models::CustomerMinified]
|
|
@@ -31,10 +31,8 @@ module Orb
|
|
|
31
31
|
required :properties, -> { Orb::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Properties }
|
|
32
32
|
|
|
33
33
|
# @!attribute subscription
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
37
|
-
# serialization.
|
|
34
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
35
|
+
# dates, plan and customer.
|
|
38
36
|
#
|
|
39
37
|
# @return [Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription]
|
|
40
38
|
required :subscription, -> { Orb::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription }
|
|
@@ -60,7 +58,7 @@ module Orb
|
|
|
60
58
|
#
|
|
61
59
|
# @param properties [Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Properties] Every license that crossed a threshold for one alert, batched into a single mess
|
|
62
60
|
#
|
|
63
|
-
# @param subscription [Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription]
|
|
61
|
+
# @param subscription [Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
|
|
64
62
|
#
|
|
65
63
|
# @param type [Symbol, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Type] The event this payload describes.
|
|
66
64
|
|
|
@@ -603,10 +601,8 @@ module Orb
|
|
|
603
601
|
enum: -> { Orb::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription::Status }
|
|
604
602
|
|
|
605
603
|
# @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
|
|
606
|
-
#
|
|
607
|
-
#
|
|
608
|
-
# This avoids the expensive to_subscription_params() call required for full
|
|
609
|
-
# serialization.
|
|
604
|
+
# The subscription in a license or grouped cost webhook payload: its status,
|
|
605
|
+
# dates, plan and customer.
|
|
610
606
|
#
|
|
611
607
|
# @param id [String]
|
|
612
608
|
# @param customer [Orb::Models::CustomerMinified]
|
|
@@ -29,13 +29,22 @@ module Orb
|
|
|
29
29
|
# @return [Array<String>, nil]
|
|
30
30
|
required :enabled_event_types, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
31
31
|
|
|
32
|
+
# @!attribute payload_style
|
|
33
|
+
# The payload style of the webhook events sent to this endpoint. `standard`
|
|
34
|
+
# payloads include each object's own fields and references to related objects,
|
|
35
|
+
# without invoice line items or subscription price intervals. `expanded` payloads
|
|
36
|
+
# include every object fully expanded.
|
|
37
|
+
#
|
|
38
|
+
# @return [Symbol, Orb::Models::WebhookEndpoint::PayloadStyle]
|
|
39
|
+
required :payload_style, enum: -> { Orb::WebhookEndpoint::PayloadStyle }
|
|
40
|
+
|
|
32
41
|
# @!attribute url
|
|
33
42
|
# The HTTPS URL that Orb sends webhook events to.
|
|
34
43
|
#
|
|
35
44
|
# @return [String]
|
|
36
45
|
required :url, String
|
|
37
46
|
|
|
38
|
-
# @!method initialize(id:, created_at:, enabled:, enabled_event_types:, url:)
|
|
47
|
+
# @!method initialize(id:, created_at:, enabled:, enabled_event_types:, payload_style:, url:)
|
|
39
48
|
# Some parameter documentations has been truncated, see
|
|
40
49
|
# {Orb::Models::WebhookEndpoint} for more details.
|
|
41
50
|
#
|
|
@@ -50,7 +59,25 @@ module Orb
|
|
|
50
59
|
#
|
|
51
60
|
# @param enabled_event_types [Array<String>, nil] The webhook event types sent to this endpoint. If null, all event types are sent
|
|
52
61
|
#
|
|
62
|
+
# @param payload_style [Symbol, Orb::Models::WebhookEndpoint::PayloadStyle] The payload style of the webhook events sent to this endpoint. `standard` payloa
|
|
63
|
+
#
|
|
53
64
|
# @param url [String] The HTTPS URL that Orb sends webhook events to.
|
|
65
|
+
|
|
66
|
+
# The payload style of the webhook events sent to this endpoint. `standard`
|
|
67
|
+
# payloads include each object's own fields and references to related objects,
|
|
68
|
+
# without invoice line items or subscription price intervals. `expanded` payloads
|
|
69
|
+
# include every object fully expanded.
|
|
70
|
+
#
|
|
71
|
+
# @see Orb::Models::WebhookEndpoint#payload_style
|
|
72
|
+
module PayloadStyle
|
|
73
|
+
extend Orb::Internal::Type::Enum
|
|
74
|
+
|
|
75
|
+
EXPANDED = :expanded
|
|
76
|
+
STANDARD = :standard
|
|
77
|
+
|
|
78
|
+
# @!method self.values
|
|
79
|
+
# @return [Array<Symbol>]
|
|
80
|
+
end
|
|
54
81
|
end
|
|
55
82
|
end
|
|
56
83
|
end
|
|
@@ -20,7 +20,14 @@ module Orb
|
|
|
20
20
|
# @return [Array<String>, nil]
|
|
21
21
|
optional :enabled_event_types, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
22
22
|
|
|
23
|
-
# @!
|
|
23
|
+
# @!attribute payload_style
|
|
24
|
+
# The payload style of the webhook events sent to this endpoint. If omitted or
|
|
25
|
+
# null, the account's default style is used.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, Orb::Models::WebhookEndpointCreateParams::PayloadStyle, nil]
|
|
28
|
+
optional :payload_style, enum: -> { Orb::WebhookEndpointCreateParams::PayloadStyle }, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!method initialize(url:, enabled_event_types: nil, payload_style: nil, request_options: {})
|
|
24
31
|
# Some parameter documentations has been truncated, see
|
|
25
32
|
# {Orb::Models::WebhookEndpointCreateParams} for more details.
|
|
26
33
|
#
|
|
@@ -28,7 +35,21 @@ module Orb
|
|
|
28
35
|
#
|
|
29
36
|
# @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. If omitted or null, all event
|
|
30
37
|
#
|
|
38
|
+
# @param payload_style [Symbol, Orb::Models::WebhookEndpointCreateParams::PayloadStyle, nil] The payload style of the webhook events sent to this endpoint. If omitted or nul
|
|
39
|
+
#
|
|
31
40
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
41
|
+
|
|
42
|
+
# The payload style of the webhook events sent to this endpoint. If omitted or
|
|
43
|
+
# null, the account's default style is used.
|
|
44
|
+
module PayloadStyle
|
|
45
|
+
extend Orb::Internal::Type::Enum
|
|
46
|
+
|
|
47
|
+
EXPANDED = :expanded
|
|
48
|
+
STANDARD = :standard
|
|
49
|
+
|
|
50
|
+
# @!method self.values
|
|
51
|
+
# @return [Array<Symbol>]
|
|
52
|
+
end
|
|
32
53
|
end
|
|
33
54
|
end
|
|
34
55
|
end
|
|
@@ -19,13 +19,20 @@ module Orb
|
|
|
19
19
|
# @return [Array<String>, nil]
|
|
20
20
|
optional :enabled_event_types, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
21
21
|
|
|
22
|
+
# @!attribute payload_style
|
|
23
|
+
# The payload style of the webhook events sent to this endpoint. Applies to events
|
|
24
|
+
# created after the change; omit to leave it unchanged.
|
|
25
|
+
#
|
|
26
|
+
# @return [Symbol, Orb::Models::WebhookEndpointUpdateParams::PayloadStyle, nil]
|
|
27
|
+
optional :payload_style, enum: -> { Orb::WebhookEndpointUpdateParams::PayloadStyle }, nil?: true
|
|
28
|
+
|
|
22
29
|
# @!attribute url
|
|
23
30
|
# The HTTPS URL that Orb sends webhook events to.
|
|
24
31
|
#
|
|
25
32
|
# @return [String, nil]
|
|
26
33
|
optional :url, String, nil?: true
|
|
27
34
|
|
|
28
|
-
# @!method initialize(webhook_endpoint_id:, enabled_event_types: nil, url: nil, request_options: {})
|
|
35
|
+
# @!method initialize(webhook_endpoint_id:, enabled_event_types: nil, payload_style: nil, url: nil, request_options: {})
|
|
29
36
|
# Some parameter documentations has been truncated, see
|
|
30
37
|
# {Orb::Models::WebhookEndpointUpdateParams} for more details.
|
|
31
38
|
#
|
|
@@ -33,9 +40,23 @@ module Orb
|
|
|
33
40
|
#
|
|
34
41
|
# @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. Null sends all event types; om
|
|
35
42
|
#
|
|
43
|
+
# @param payload_style [Symbol, Orb::Models::WebhookEndpointUpdateParams::PayloadStyle, nil] The payload style of the webhook events sent to this endpoint. Applies to events
|
|
44
|
+
#
|
|
36
45
|
# @param url [String, nil] The HTTPS URL that Orb sends webhook events to.
|
|
37
46
|
#
|
|
38
47
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
48
|
+
|
|
49
|
+
# The payload style of the webhook events sent to this endpoint. Applies to events
|
|
50
|
+
# created after the change; omit to leave it unchanged.
|
|
51
|
+
module PayloadStyle
|
|
52
|
+
extend Orb::Internal::Type::Enum
|
|
53
|
+
|
|
54
|
+
EXPANDED = :expanded
|
|
55
|
+
STANDARD = :standard
|
|
56
|
+
|
|
57
|
+
# @!method self.values
|
|
58
|
+
# @return [Array<Symbol>]
|
|
59
|
+
end
|
|
39
60
|
end
|
|
40
61
|
end
|
|
41
62
|
end
|
|
@@ -29,6 +29,15 @@ module Orb
|
|
|
29
29
|
# @return [Array<String>, nil]
|
|
30
30
|
required :enabled_event_types, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
31
31
|
|
|
32
|
+
# @!attribute payload_style
|
|
33
|
+
# The payload style of the webhook events sent to this endpoint. `standard`
|
|
34
|
+
# payloads include each object's own fields and references to related objects,
|
|
35
|
+
# without invoice line items or subscription price intervals. `expanded` payloads
|
|
36
|
+
# include every object fully expanded.
|
|
37
|
+
#
|
|
38
|
+
# @return [Symbol, Orb::Models::WebhookEndpointWithSecret::PayloadStyle]
|
|
39
|
+
required :payload_style, enum: -> { Orb::WebhookEndpointWithSecret::PayloadStyle }
|
|
40
|
+
|
|
32
41
|
# @!attribute secret
|
|
33
42
|
# The secret used to sign the webhook events sent to this endpoint. Only returned
|
|
34
43
|
# when the endpoint is created.
|
|
@@ -42,7 +51,7 @@ module Orb
|
|
|
42
51
|
# @return [String]
|
|
43
52
|
required :url, String
|
|
44
53
|
|
|
45
|
-
# @!method initialize(id:, created_at:, enabled:, enabled_event_types:, secret:, url:)
|
|
54
|
+
# @!method initialize(id:, created_at:, enabled:, enabled_event_types:, payload_style:, secret:, url:)
|
|
46
55
|
# Some parameter documentations has been truncated, see
|
|
47
56
|
# {Orb::Models::WebhookEndpointWithSecret} for more details.
|
|
48
57
|
#
|
|
@@ -57,9 +66,27 @@ module Orb
|
|
|
57
66
|
#
|
|
58
67
|
# @param enabled_event_types [Array<String>, nil] The webhook event types sent to this endpoint. If null, all event types are sent
|
|
59
68
|
#
|
|
69
|
+
# @param payload_style [Symbol, Orb::Models::WebhookEndpointWithSecret::PayloadStyle] The payload style of the webhook events sent to this endpoint. `standard` payloa
|
|
70
|
+
#
|
|
60
71
|
# @param secret [String] The secret used to sign the webhook events sent to this endpoint. Only returned
|
|
61
72
|
#
|
|
62
73
|
# @param url [String] The HTTPS URL that Orb sends webhook events to.
|
|
74
|
+
|
|
75
|
+
# The payload style of the webhook events sent to this endpoint. `standard`
|
|
76
|
+
# payloads include each object's own fields and references to related objects,
|
|
77
|
+
# without invoice line items or subscription price intervals. `expanded` payloads
|
|
78
|
+
# include every object fully expanded.
|
|
79
|
+
#
|
|
80
|
+
# @see Orb::Models::WebhookEndpointWithSecret#payload_style
|
|
81
|
+
module PayloadStyle
|
|
82
|
+
extend Orb::Internal::Type::Enum
|
|
83
|
+
|
|
84
|
+
EXPANDED = :expanded
|
|
85
|
+
STANDARD = :standard
|
|
86
|
+
|
|
87
|
+
# @!method self.values
|
|
88
|
+
# @return [Array<Symbol>]
|
|
89
|
+
end
|
|
63
90
|
end
|
|
64
91
|
end
|
|
65
92
|
end
|
|
@@ -23,7 +23,8 @@ module Orb
|
|
|
23
23
|
required :created_at, Time
|
|
24
24
|
|
|
25
25
|
# @!attribute invoice
|
|
26
|
-
#
|
|
26
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
27
|
+
# Fetch the invoice for those.
|
|
27
28
|
#
|
|
28
29
|
# @return [Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice]
|
|
29
30
|
required :invoice, -> { Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice }
|
|
@@ -60,7 +61,7 @@ module Orb
|
|
|
60
61
|
#
|
|
61
62
|
# @param created_at [Time] The time at which this event was created, to the second.
|
|
62
63
|
#
|
|
63
|
-
# @param invoice [Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice]
|
|
64
|
+
# @param invoice [Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
|
|
64
65
|
#
|
|
65
66
|
# @param payload_style [Symbol, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
|
|
66
67
|
#
|
|
@@ -522,7 +523,8 @@ module Orb
|
|
|
522
523
|
# {Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice}
|
|
523
524
|
# for more details.
|
|
524
525
|
#
|
|
525
|
-
#
|
|
526
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
527
|
+
# Fetch the invoice for those.
|
|
526
528
|
#
|
|
527
529
|
# @param id [String]
|
|
528
530
|
#
|