orb-billing 1.38.0 → 1.40.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 +20 -0
- data/README.md +1 -1
- data/lib/orb/models/changed_subscription_resources.rb +14 -1
- data/lib/orb/models/dimensional_price_group.rb +10 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +9 -1
- data/lib/orb/models/events/backfill_list_params.rb +29 -1
- data/lib/orb/models/invoice.rb +14 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +14 -1
- data/lib/orb/models/invoice_issue_summary_response.rb +14 -1
- data/lib/orb/models/invoice_issued_summary_webhook_event.rb +14 -1
- data/lib/orb/models/invoice_list_summary_response.rb +14 -1
- data/lib/orb/resources/dimensional_price_groups.rb +6 -1
- data/lib/orb/resources/events/backfills.rb +11 -2
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/models/changed_subscription_resources.rbi +18 -0
- data/rbi/orb/models/dimensional_price_group.rbi +13 -3
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +8 -0
- data/rbi/orb/models/events/backfill_list_params.rbi +58 -0
- data/rbi/orb/models/invoice.rbi +18 -0
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +18 -0
- data/rbi/orb/models/invoice_issue_summary_response.rbi +18 -0
- data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +18 -0
- data/rbi/orb/models/invoice_list_summary_response.rbi +18 -0
- data/rbi/orb/resources/dimensional_price_groups.rbi +6 -0
- data/rbi/orb/resources/events/backfills.rbi +12 -1
- data/sig/orb/models/changed_subscription_resources.rbs +5 -0
- data/sig/orb/models/dimensional_price_group.rbs +8 -3
- data/sig/orb/models/dimensional_price_group_list_params.rbs +5 -1
- data/sig/orb/models/events/backfill_list_params.rbs +27 -1
- data/sig/orb/models/invoice.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +5 -0
- data/sig/orb/models/invoice_issue_summary_response.rbs +5 -0
- data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +5 -0
- data/sig/orb/models/invoice_list_summary_response.rbs +5 -0
- data/sig/orb/resources/dimensional_price_groups.rbs +1 -0
- data/sig/orb/resources/events/backfills.rbs +2 -0
- metadata +2 -2
|
@@ -17,6 +17,9 @@ module Orb
|
|
|
17
17
|
sig { returns(T.nilable(String)) }
|
|
18
18
|
attr_accessor :cursor
|
|
19
19
|
|
|
20
|
+
sig { returns(T.nilable(String)) }
|
|
21
|
+
attr_accessor :customer_id
|
|
22
|
+
|
|
20
23
|
# The number of items to fetch. Defaults to 20.
|
|
21
24
|
sig { returns(T.nilable(Integer)) }
|
|
22
25
|
attr_reader :limit
|
|
@@ -24,10 +27,19 @@ module Orb
|
|
|
24
27
|
sig { params(limit: Integer).void }
|
|
25
28
|
attr_writer :limit
|
|
26
29
|
|
|
30
|
+
# The status of the backfill.
|
|
31
|
+
sig do
|
|
32
|
+
returns(T.nilable(Orb::Events::BackfillListParams::Status::OrSymbol))
|
|
33
|
+
end
|
|
34
|
+
attr_accessor :status
|
|
35
|
+
|
|
27
36
|
sig do
|
|
28
37
|
params(
|
|
29
38
|
cursor: T.nilable(String),
|
|
39
|
+
customer_id: T.nilable(String),
|
|
30
40
|
limit: Integer,
|
|
41
|
+
status:
|
|
42
|
+
T.nilable(Orb::Events::BackfillListParams::Status::OrSymbol),
|
|
31
43
|
request_options: Orb::RequestOptions::OrHash
|
|
32
44
|
).returns(T.attached_class)
|
|
33
45
|
end
|
|
@@ -35,8 +47,11 @@ module Orb
|
|
|
35
47
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
36
48
|
# from the initial request.
|
|
37
49
|
cursor: nil,
|
|
50
|
+
customer_id: nil,
|
|
38
51
|
# The number of items to fetch. Defaults to 20.
|
|
39
52
|
limit: nil,
|
|
53
|
+
# The status of the backfill.
|
|
54
|
+
status: nil,
|
|
40
55
|
request_options: {}
|
|
41
56
|
)
|
|
42
57
|
end
|
|
@@ -45,13 +60,56 @@ module Orb
|
|
|
45
60
|
override.returns(
|
|
46
61
|
{
|
|
47
62
|
cursor: T.nilable(String),
|
|
63
|
+
customer_id: T.nilable(String),
|
|
48
64
|
limit: Integer,
|
|
65
|
+
status:
|
|
66
|
+
T.nilable(Orb::Events::BackfillListParams::Status::OrSymbol),
|
|
49
67
|
request_options: Orb::RequestOptions
|
|
50
68
|
}
|
|
51
69
|
)
|
|
52
70
|
end
|
|
53
71
|
def to_hash
|
|
54
72
|
end
|
|
73
|
+
|
|
74
|
+
# The status of the backfill.
|
|
75
|
+
module Status
|
|
76
|
+
extend Orb::Internal::Type::Enum
|
|
77
|
+
|
|
78
|
+
TaggedSymbol =
|
|
79
|
+
T.type_alias do
|
|
80
|
+
T.all(Symbol, Orb::Events::BackfillListParams::Status)
|
|
81
|
+
end
|
|
82
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
83
|
+
|
|
84
|
+
PENDING =
|
|
85
|
+
T.let(
|
|
86
|
+
:pending,
|
|
87
|
+
Orb::Events::BackfillListParams::Status::TaggedSymbol
|
|
88
|
+
)
|
|
89
|
+
REFLECTED =
|
|
90
|
+
T.let(
|
|
91
|
+
:reflected,
|
|
92
|
+
Orb::Events::BackfillListParams::Status::TaggedSymbol
|
|
93
|
+
)
|
|
94
|
+
PENDING_REVERT =
|
|
95
|
+
T.let(
|
|
96
|
+
:pending_revert,
|
|
97
|
+
Orb::Events::BackfillListParams::Status::TaggedSymbol
|
|
98
|
+
)
|
|
99
|
+
REVERTED =
|
|
100
|
+
T.let(
|
|
101
|
+
:reverted,
|
|
102
|
+
Orb::Events::BackfillListParams::Status::TaggedSymbol
|
|
103
|
+
)
|
|
104
|
+
|
|
105
|
+
sig do
|
|
106
|
+
override.returns(
|
|
107
|
+
T::Array[Orb::Events::BackfillListParams::Status::TaggedSymbol]
|
|
108
|
+
)
|
|
109
|
+
end
|
|
110
|
+
def self.values
|
|
111
|
+
end
|
|
112
|
+
end
|
|
55
113
|
end
|
|
56
114
|
end
|
|
57
115
|
end
|
data/rbi/orb/models/invoice.rbi
CHANGED
|
@@ -310,6 +310,15 @@ module Orb
|
|
|
310
310
|
sig { returns(T.nilable(Time)) }
|
|
311
311
|
attr_accessor :payment_failed_at
|
|
312
312
|
|
|
313
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
314
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
315
|
+
# through a payment provider, this is the settlement time reported by that
|
|
316
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
317
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
318
|
+
# when the invoice reached the `paid` status in Orb.
|
|
319
|
+
sig { returns(T.nilable(Time)) }
|
|
320
|
+
attr_accessor :payment_received_at
|
|
321
|
+
|
|
313
322
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
314
323
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
315
324
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -410,6 +419,7 @@ module Orb
|
|
|
410
419
|
paid_at: T.nilable(Time),
|
|
411
420
|
payment_attempts: T::Array[Orb::Invoice::PaymentAttempt::OrHash],
|
|
412
421
|
payment_failed_at: T.nilable(Time),
|
|
422
|
+
payment_received_at: T.nilable(Time),
|
|
413
423
|
payment_started_at: T.nilable(Time),
|
|
414
424
|
scheduled_issue_at: T.nilable(Time),
|
|
415
425
|
shipping_address: T.nilable(Orb::Address::OrHash),
|
|
@@ -644,6 +654,13 @@ module Orb
|
|
|
644
654
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
645
655
|
# the most recent attempt.
|
|
646
656
|
payment_failed_at:,
|
|
657
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
658
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
659
|
+
# through a payment provider, this is the settlement time reported by that
|
|
660
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
661
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
662
|
+
# when the invoice reached the `paid` status in Orb.
|
|
663
|
+
payment_received_at:,
|
|
647
664
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
648
665
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
649
666
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -707,6 +724,7 @@ module Orb
|
|
|
707
724
|
paid_at: T.nilable(Time),
|
|
708
725
|
payment_attempts: T::Array[Orb::Invoice::PaymentAttempt],
|
|
709
726
|
payment_failed_at: T.nilable(Time),
|
|
727
|
+
payment_received_at: T.nilable(Time),
|
|
710
728
|
payment_started_at: T.nilable(Time),
|
|
711
729
|
scheduled_issue_at: T.nilable(Time),
|
|
712
730
|
shipping_address: T.nilable(Orb::Address),
|
|
@@ -335,6 +335,15 @@ module Orb
|
|
|
335
335
|
sig { returns(T.nilable(Time)) }
|
|
336
336
|
attr_accessor :payment_failed_at
|
|
337
337
|
|
|
338
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
339
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
340
|
+
# through a payment provider, this is the settlement time reported by that
|
|
341
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
342
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
343
|
+
# when the invoice reached the `paid` status in Orb.
|
|
344
|
+
sig { returns(T.nilable(Time)) }
|
|
345
|
+
attr_accessor :payment_received_at
|
|
346
|
+
|
|
338
347
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
339
348
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
340
349
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -448,6 +457,7 @@ module Orb
|
|
|
448
457
|
Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::OrHash
|
|
449
458
|
],
|
|
450
459
|
payment_failed_at: T.nilable(Time),
|
|
460
|
+
payment_received_at: T.nilable(Time),
|
|
451
461
|
payment_started_at: T.nilable(Time),
|
|
452
462
|
scheduled_issue_at: T.nilable(Time),
|
|
453
463
|
shipping_address: T.nilable(Orb::Address::OrHash),
|
|
@@ -681,6 +691,13 @@ module Orb
|
|
|
681
691
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
682
692
|
# the most recent attempt.
|
|
683
693
|
payment_failed_at:,
|
|
694
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
695
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
696
|
+
# through a payment provider, this is the settlement time reported by that
|
|
697
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
698
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
699
|
+
# when the invoice reached the `paid` status in Orb.
|
|
700
|
+
payment_received_at:,
|
|
684
701
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
685
702
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
686
703
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -754,6 +771,7 @@ module Orb
|
|
|
754
771
|
Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt
|
|
755
772
|
],
|
|
756
773
|
payment_failed_at: T.nilable(Time),
|
|
774
|
+
payment_received_at: T.nilable(Time),
|
|
757
775
|
payment_started_at: T.nilable(Time),
|
|
758
776
|
scheduled_issue_at: T.nilable(Time),
|
|
759
777
|
shipping_address: T.nilable(Orb::Address),
|
|
@@ -299,6 +299,15 @@ module Orb
|
|
|
299
299
|
sig { returns(T.nilable(Time)) }
|
|
300
300
|
attr_accessor :payment_failed_at
|
|
301
301
|
|
|
302
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
303
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
304
|
+
# through a payment provider, this is the settlement time reported by that
|
|
305
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
306
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
307
|
+
# when the invoice reached the `paid` status in Orb.
|
|
308
|
+
sig { returns(T.nilable(Time)) }
|
|
309
|
+
attr_accessor :payment_received_at
|
|
310
|
+
|
|
302
311
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
303
312
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
304
313
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -387,6 +396,7 @@ module Orb
|
|
|
387
396
|
Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt::OrHash
|
|
388
397
|
],
|
|
389
398
|
payment_failed_at: T.nilable(Time),
|
|
399
|
+
payment_received_at: T.nilable(Time),
|
|
390
400
|
payment_started_at: T.nilable(Time),
|
|
391
401
|
scheduled_issue_at: T.nilable(Time),
|
|
392
402
|
shipping_address: T.nilable(Orb::Address::OrHash),
|
|
@@ -604,6 +614,13 @@ module Orb
|
|
|
604
614
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
605
615
|
# the most recent attempt.
|
|
606
616
|
payment_failed_at:,
|
|
617
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
618
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
619
|
+
# through a payment provider, this is the settlement time reported by that
|
|
620
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
621
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
622
|
+
# when the invoice reached the `paid` status in Orb.
|
|
623
|
+
payment_received_at:,
|
|
607
624
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
608
625
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
609
626
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -665,6 +682,7 @@ module Orb
|
|
|
665
682
|
Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt
|
|
666
683
|
],
|
|
667
684
|
payment_failed_at: T.nilable(Time),
|
|
685
|
+
payment_received_at: T.nilable(Time),
|
|
668
686
|
payment_started_at: T.nilable(Time),
|
|
669
687
|
scheduled_issue_at: T.nilable(Time),
|
|
670
688
|
shipping_address: T.nilable(Orb::Address),
|
|
@@ -384,6 +384,15 @@ module Orb
|
|
|
384
384
|
sig { returns(T.nilable(Time)) }
|
|
385
385
|
attr_accessor :payment_failed_at
|
|
386
386
|
|
|
387
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
388
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
389
|
+
# through a payment provider, this is the settlement time reported by that
|
|
390
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
391
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
392
|
+
# when the invoice reached the `paid` status in Orb.
|
|
393
|
+
sig { returns(T.nilable(Time)) }
|
|
394
|
+
attr_accessor :payment_received_at
|
|
395
|
+
|
|
387
396
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
388
397
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
389
398
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -476,6 +485,7 @@ module Orb
|
|
|
476
485
|
Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::OrHash
|
|
477
486
|
],
|
|
478
487
|
payment_failed_at: T.nilable(Time),
|
|
488
|
+
payment_received_at: T.nilable(Time),
|
|
479
489
|
payment_started_at: T.nilable(Time),
|
|
480
490
|
scheduled_issue_at: T.nilable(Time),
|
|
481
491
|
shipping_address: T.nilable(Orb::Address::OrHash),
|
|
@@ -694,6 +704,13 @@ module Orb
|
|
|
694
704
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
695
705
|
# the most recent attempt.
|
|
696
706
|
payment_failed_at:,
|
|
707
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
708
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
709
|
+
# through a payment provider, this is the settlement time reported by that
|
|
710
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
711
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
712
|
+
# when the invoice reached the `paid` status in Orb.
|
|
713
|
+
payment_received_at:,
|
|
697
714
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
698
715
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
699
716
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -757,6 +774,7 @@ module Orb
|
|
|
757
774
|
Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt
|
|
758
775
|
],
|
|
759
776
|
payment_failed_at: T.nilable(Time),
|
|
777
|
+
payment_received_at: T.nilable(Time),
|
|
760
778
|
payment_started_at: T.nilable(Time),
|
|
761
779
|
scheduled_issue_at: T.nilable(Time),
|
|
762
780
|
shipping_address: T.nilable(Orb::Address),
|
|
@@ -296,6 +296,15 @@ module Orb
|
|
|
296
296
|
sig { returns(T.nilable(Time)) }
|
|
297
297
|
attr_accessor :payment_failed_at
|
|
298
298
|
|
|
299
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
300
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
301
|
+
# through a payment provider, this is the settlement time reported by that
|
|
302
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
303
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
304
|
+
# when the invoice reached the `paid` status in Orb.
|
|
305
|
+
sig { returns(T.nilable(Time)) }
|
|
306
|
+
attr_accessor :payment_received_at
|
|
307
|
+
|
|
299
308
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
300
309
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
301
310
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -384,6 +393,7 @@ module Orb
|
|
|
384
393
|
Orb::Models::InvoiceListSummaryResponse::PaymentAttempt::OrHash
|
|
385
394
|
],
|
|
386
395
|
payment_failed_at: T.nilable(Time),
|
|
396
|
+
payment_received_at: T.nilable(Time),
|
|
387
397
|
payment_started_at: T.nilable(Time),
|
|
388
398
|
scheduled_issue_at: T.nilable(Time),
|
|
389
399
|
shipping_address: T.nilable(Orb::Address::OrHash),
|
|
@@ -601,6 +611,13 @@ module Orb
|
|
|
601
611
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
602
612
|
# the most recent attempt.
|
|
603
613
|
payment_failed_at:,
|
|
614
|
+
# When payment for this invoice was received. For an invoice manually marked as
|
|
615
|
+
# paid, this is the `payment_received_date` that was supplied. For an invoice paid
|
|
616
|
+
# through a payment provider, this is the settlement time reported by that
|
|
617
|
+
# provider. It is `null` for an invoice that became `paid` without a payment, such
|
|
618
|
+
# as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
|
|
619
|
+
# when the invoice reached the `paid` status in Orb.
|
|
620
|
+
payment_received_at:,
|
|
604
621
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
605
622
|
# most recent attempt. This field is especially useful for delayed-notification
|
|
606
623
|
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
@@ -660,6 +677,7 @@ module Orb
|
|
|
660
677
|
payment_attempts:
|
|
661
678
|
T::Array[Orb::Models::InvoiceListSummaryResponse::PaymentAttempt],
|
|
662
679
|
payment_failed_at: T.nilable(Time),
|
|
680
|
+
payment_received_at: T.nilable(Time),
|
|
663
681
|
payment_started_at: T.nilable(Time),
|
|
664
682
|
scheduled_issue_at: T.nilable(Time),
|
|
665
683
|
shipping_address: T.nilable(Orb::Address),
|
|
@@ -86,16 +86,22 @@ module Orb
|
|
|
86
86
|
# dimensions, and the prices in the group specify which partition their usage is
|
|
87
87
|
# derived from.
|
|
88
88
|
#
|
|
89
|
+
# Filter with `billable_metric_id`. Each group includes `price_count`:
|
|
90
|
+
# non-archived prices in the group. Subscription overrides are not counted.
|
|
91
|
+
#
|
|
89
92
|
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
90
93
|
# the next page of results if they exist.
|
|
91
94
|
sig do
|
|
92
95
|
params(
|
|
96
|
+
billable_metric_id: T.nilable(String),
|
|
93
97
|
cursor: T.nilable(String),
|
|
94
98
|
limit: Integer,
|
|
95
99
|
request_options: Orb::RequestOptions::OrHash
|
|
96
100
|
).returns(Orb::Internal::Page[Orb::DimensionalPriceGroup])
|
|
97
101
|
end
|
|
98
102
|
def list(
|
|
103
|
+
# Filter to groups that use this billable metric.
|
|
104
|
+
billable_metric_id: nil,
|
|
99
105
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
100
106
|
# from the initial request.
|
|
101
107
|
cursor: nil,
|
|
@@ -43,7 +43,10 @@ module Orb
|
|
|
43
43
|
# enables filtering using
|
|
44
44
|
# [computed properties](/extensibility/advanced-metrics#computed-properties). The
|
|
45
45
|
# expressiveness of computed properties allows you to deprecate existing events
|
|
46
|
-
# based on both a period of time and specific property values.
|
|
46
|
+
# based on both a period of time and specific property values. When
|
|
47
|
+
# `deprecation_filter` is provided, the timeframe may extend to `now` rather than
|
|
48
|
+
# the event reporting grace boundary. Matching events that arrive later with
|
|
49
|
+
# timestamps inside the timeframe will also be deprecated.
|
|
47
50
|
#
|
|
48
51
|
# You may not have multiple backfills in a pending or pending_revert state with
|
|
49
52
|
# overlapping timeframes.
|
|
@@ -95,10 +98,15 @@ module Orb
|
|
|
95
98
|
# backfill. The response also includes
|
|
96
99
|
# [`pagination_metadata`](/api-reference/pagination), which lets the caller
|
|
97
100
|
# retrieve the next page of results if they exist.
|
|
101
|
+
#
|
|
102
|
+
# Use `customer_id` and `status` to filter the results.
|
|
98
103
|
sig do
|
|
99
104
|
params(
|
|
100
105
|
cursor: T.nilable(String),
|
|
106
|
+
customer_id: T.nilable(String),
|
|
101
107
|
limit: Integer,
|
|
108
|
+
status:
|
|
109
|
+
T.nilable(Orb::Events::BackfillListParams::Status::OrSymbol),
|
|
102
110
|
request_options: Orb::RequestOptions::OrHash
|
|
103
111
|
).returns(
|
|
104
112
|
Orb::Internal::Page[Orb::Models::Events::BackfillListResponse]
|
|
@@ -108,8 +116,11 @@ module Orb
|
|
|
108
116
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
109
117
|
# from the initial request.
|
|
110
118
|
cursor: nil,
|
|
119
|
+
customer_id: nil,
|
|
111
120
|
# The number of items to fetch. Defaults to 20.
|
|
112
121
|
limit: nil,
|
|
122
|
+
# The status of the backfill.
|
|
123
|
+
status: nil,
|
|
113
124
|
request_options: {}
|
|
114
125
|
)
|
|
115
126
|
end
|
|
@@ -66,6 +66,7 @@ module Orb
|
|
|
66
66
|
paid_at: Time?,
|
|
67
67
|
payment_attempts: ::Array[Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt],
|
|
68
68
|
payment_failed_at: Time?,
|
|
69
|
+
payment_received_at: Time?,
|
|
69
70
|
payment_started_at: Time?,
|
|
70
71
|
scheduled_issue_at: Time?,
|
|
71
72
|
shipping_address: Orb::Address?,
|
|
@@ -145,6 +146,8 @@ module Orb
|
|
|
145
146
|
|
|
146
147
|
attr_accessor payment_failed_at: Time?
|
|
147
148
|
|
|
149
|
+
attr_accessor payment_received_at: Time?
|
|
150
|
+
|
|
148
151
|
attr_accessor payment_started_at: Time?
|
|
149
152
|
|
|
150
153
|
attr_accessor scheduled_issue_at: Time?
|
|
@@ -199,6 +202,7 @@ module Orb
|
|
|
199
202
|
paid_at: Time?,
|
|
200
203
|
payment_attempts: ::Array[Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt],
|
|
201
204
|
payment_failed_at: Time?,
|
|
205
|
+
payment_received_at: Time?,
|
|
202
206
|
payment_started_at: Time?,
|
|
203
207
|
scheduled_issue_at: Time?,
|
|
204
208
|
shipping_address: Orb::Address?,
|
|
@@ -245,6 +249,7 @@ module Orb
|
|
|
245
249
|
paid_at: Time?,
|
|
246
250
|
payment_attempts: ::Array[Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt],
|
|
247
251
|
payment_failed_at: Time?,
|
|
252
|
+
payment_received_at: Time?,
|
|
248
253
|
payment_started_at: Time?,
|
|
249
254
|
scheduled_issue_at: Time?,
|
|
250
255
|
shipping_address: Orb::Address?,
|
|
@@ -7,7 +7,8 @@ module Orb
|
|
|
7
7
|
dimensions: ::Array[String],
|
|
8
8
|
external_dimensional_price_group_id: String?,
|
|
9
9
|
metadata: ::Hash[Symbol, String],
|
|
10
|
-
name: String
|
|
10
|
+
name: String,
|
|
11
|
+
price_count: Integer
|
|
11
12
|
}
|
|
12
13
|
|
|
13
14
|
class DimensionalPriceGroup < Orb::Internal::Type::BaseModel
|
|
@@ -23,13 +24,16 @@ module Orb
|
|
|
23
24
|
|
|
24
25
|
attr_accessor name: String
|
|
25
26
|
|
|
27
|
+
attr_accessor price_count: Integer
|
|
28
|
+
|
|
26
29
|
def initialize: (
|
|
27
30
|
id: String,
|
|
28
31
|
billable_metric_id: String,
|
|
29
32
|
dimensions: ::Array[String],
|
|
30
33
|
external_dimensional_price_group_id: String?,
|
|
31
34
|
metadata: ::Hash[Symbol, String],
|
|
32
|
-
name: String
|
|
35
|
+
name: String,
|
|
36
|
+
price_count: Integer
|
|
33
37
|
) -> void
|
|
34
38
|
|
|
35
39
|
def to_hash: -> {
|
|
@@ -38,7 +42,8 @@ module Orb
|
|
|
38
42
|
dimensions: ::Array[String],
|
|
39
43
|
external_dimensional_price_group_id: String?,
|
|
40
44
|
metadata: ::Hash[Symbol, String],
|
|
41
|
-
name: String
|
|
45
|
+
name: String,
|
|
46
|
+
price_count: Integer
|
|
42
47
|
}
|
|
43
48
|
end
|
|
44
49
|
end
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
module Orb
|
|
2
2
|
module Models
|
|
3
3
|
type dimensional_price_group_list_params =
|
|
4
|
-
{ cursor: String?, limit: Integer }
|
|
4
|
+
{ billable_metric_id: String?, cursor: String?, limit: Integer }
|
|
5
5
|
& Orb::Internal::Type::request_parameters
|
|
6
6
|
|
|
7
7
|
class DimensionalPriceGroupListParams < Orb::Internal::Type::BaseModel
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
attr_accessor billable_metric_id: String?
|
|
12
|
+
|
|
11
13
|
attr_accessor cursor: String?
|
|
12
14
|
|
|
13
15
|
attr_reader limit: Integer?
|
|
@@ -15,12 +17,14 @@ module Orb
|
|
|
15
17
|
def limit=: (Integer) -> Integer
|
|
16
18
|
|
|
17
19
|
def initialize: (
|
|
20
|
+
?billable_metric_id: String?,
|
|
18
21
|
?cursor: String?,
|
|
19
22
|
?limit: Integer,
|
|
20
23
|
?request_options: Orb::request_opts
|
|
21
24
|
) -> void
|
|
22
25
|
|
|
23
26
|
def to_hash: -> {
|
|
27
|
+
billable_metric_id: String?,
|
|
24
28
|
cursor: String?,
|
|
25
29
|
limit: Integer,
|
|
26
30
|
request_options: Orb::RequestOptions
|
|
@@ -2,7 +2,12 @@ module Orb
|
|
|
2
2
|
module Models
|
|
3
3
|
module Events
|
|
4
4
|
type backfill_list_params =
|
|
5
|
-
{
|
|
5
|
+
{
|
|
6
|
+
cursor: String?,
|
|
7
|
+
customer_id: String?,
|
|
8
|
+
limit: Integer,
|
|
9
|
+
status: Orb::Models::Events::BackfillListParams::status?
|
|
10
|
+
}
|
|
6
11
|
& Orb::Internal::Type::request_parameters
|
|
7
12
|
|
|
8
13
|
class BackfillListParams < Orb::Internal::Type::BaseModel
|
|
@@ -11,21 +16,42 @@ module Orb
|
|
|
11
16
|
|
|
12
17
|
attr_accessor cursor: String?
|
|
13
18
|
|
|
19
|
+
attr_accessor customer_id: String?
|
|
20
|
+
|
|
14
21
|
attr_reader limit: Integer?
|
|
15
22
|
|
|
16
23
|
def limit=: (Integer) -> Integer
|
|
17
24
|
|
|
25
|
+
attr_accessor status: Orb::Models::Events::BackfillListParams::status?
|
|
26
|
+
|
|
18
27
|
def initialize: (
|
|
19
28
|
?cursor: String?,
|
|
29
|
+
?customer_id: String?,
|
|
20
30
|
?limit: Integer,
|
|
31
|
+
?status: Orb::Models::Events::BackfillListParams::status?,
|
|
21
32
|
?request_options: Orb::request_opts
|
|
22
33
|
) -> void
|
|
23
34
|
|
|
24
35
|
def to_hash: -> {
|
|
25
36
|
cursor: String?,
|
|
37
|
+
customer_id: String?,
|
|
26
38
|
limit: Integer,
|
|
39
|
+
status: Orb::Models::Events::BackfillListParams::status?,
|
|
27
40
|
request_options: Orb::RequestOptions
|
|
28
41
|
}
|
|
42
|
+
|
|
43
|
+
type status = :pending | :reflected | :pending_revert | :reverted
|
|
44
|
+
|
|
45
|
+
module Status
|
|
46
|
+
extend Orb::Internal::Type::Enum
|
|
47
|
+
|
|
48
|
+
PENDING: :pending
|
|
49
|
+
REFLECTED: :reflected
|
|
50
|
+
PENDING_REVERT: :pending_revert
|
|
51
|
+
REVERTED: :reverted
|
|
52
|
+
|
|
53
|
+
def self?.values: -> ::Array[Orb::Models::Events::BackfillListParams::status]
|
|
54
|
+
end
|
|
29
55
|
end
|
|
30
56
|
end
|
|
31
57
|
end
|
data/sig/orb/models/invoice.rbs
CHANGED
|
@@ -34,6 +34,7 @@ module Orb
|
|
|
34
34
|
paid_at: Time?,
|
|
35
35
|
payment_attempts: ::Array[Orb::Invoice::PaymentAttempt],
|
|
36
36
|
payment_failed_at: Time?,
|
|
37
|
+
payment_received_at: Time?,
|
|
37
38
|
payment_started_at: Time?,
|
|
38
39
|
scheduled_issue_at: Time?,
|
|
39
40
|
shipping_address: Orb::Address?,
|
|
@@ -111,6 +112,8 @@ module Orb
|
|
|
111
112
|
|
|
112
113
|
attr_accessor payment_failed_at: Time?
|
|
113
114
|
|
|
115
|
+
attr_accessor payment_received_at: Time?
|
|
116
|
+
|
|
114
117
|
attr_accessor payment_started_at: Time?
|
|
115
118
|
|
|
116
119
|
attr_accessor scheduled_issue_at: Time?
|
|
@@ -164,6 +167,7 @@ module Orb
|
|
|
164
167
|
paid_at: Time?,
|
|
165
168
|
payment_attempts: ::Array[Orb::Invoice::PaymentAttempt],
|
|
166
169
|
payment_failed_at: Time?,
|
|
170
|
+
payment_received_at: Time?,
|
|
167
171
|
payment_started_at: Time?,
|
|
168
172
|
scheduled_issue_at: Time?,
|
|
169
173
|
shipping_address: Orb::Address?,
|
|
@@ -209,6 +213,7 @@ module Orb
|
|
|
209
213
|
paid_at: Time?,
|
|
210
214
|
payment_attempts: ::Array[Orb::Invoice::PaymentAttempt],
|
|
211
215
|
payment_failed_at: Time?,
|
|
216
|
+
payment_received_at: Time?,
|
|
212
217
|
payment_started_at: Time?,
|
|
213
218
|
scheduled_issue_at: Time?,
|
|
214
219
|
shipping_address: Orb::Address?,
|
|
@@ -33,6 +33,7 @@ module Orb
|
|
|
33
33
|
paid_at: Time?,
|
|
34
34
|
payment_attempts: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt],
|
|
35
35
|
payment_failed_at: Time?,
|
|
36
|
+
payment_received_at: Time?,
|
|
36
37
|
payment_started_at: Time?,
|
|
37
38
|
scheduled_issue_at: Time?,
|
|
38
39
|
shipping_address: Orb::Address?,
|
|
@@ -109,6 +110,8 @@ module Orb
|
|
|
109
110
|
|
|
110
111
|
attr_accessor payment_failed_at: Time?
|
|
111
112
|
|
|
113
|
+
attr_accessor payment_received_at: Time?
|
|
114
|
+
|
|
112
115
|
attr_accessor payment_started_at: Time?
|
|
113
116
|
|
|
114
117
|
attr_accessor scheduled_issue_at: Time?
|
|
@@ -163,6 +166,7 @@ module Orb
|
|
|
163
166
|
paid_at: Time?,
|
|
164
167
|
payment_attempts: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt],
|
|
165
168
|
payment_failed_at: Time?,
|
|
169
|
+
payment_received_at: Time?,
|
|
166
170
|
payment_started_at: Time?,
|
|
167
171
|
scheduled_issue_at: Time?,
|
|
168
172
|
shipping_address: Orb::Address?,
|
|
@@ -208,6 +212,7 @@ module Orb
|
|
|
208
212
|
paid_at: Time?,
|
|
209
213
|
payment_attempts: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt],
|
|
210
214
|
payment_failed_at: Time?,
|
|
215
|
+
payment_received_at: Time?,
|
|
211
216
|
payment_started_at: Time?,
|
|
212
217
|
scheduled_issue_at: Time?,
|
|
213
218
|
shipping_address: Orb::Address?,
|
|
@@ -26,6 +26,7 @@ module Orb
|
|
|
26
26
|
paid_at: Time?,
|
|
27
27
|
payment_attempts: ::Array[Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt],
|
|
28
28
|
payment_failed_at: Time?,
|
|
29
|
+
payment_received_at: Time?,
|
|
29
30
|
payment_started_at: Time?,
|
|
30
31
|
scheduled_issue_at: Time?,
|
|
31
32
|
shipping_address: Orb::Address?,
|
|
@@ -86,6 +87,8 @@ module Orb
|
|
|
86
87
|
|
|
87
88
|
attr_accessor payment_failed_at: Time?
|
|
88
89
|
|
|
90
|
+
attr_accessor payment_received_at: Time?
|
|
91
|
+
|
|
89
92
|
attr_accessor payment_started_at: Time?
|
|
90
93
|
|
|
91
94
|
attr_accessor scheduled_issue_at: Time?
|
|
@@ -129,6 +132,7 @@ module Orb
|
|
|
129
132
|
paid_at: Time?,
|
|
130
133
|
payment_attempts: ::Array[Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt],
|
|
131
134
|
payment_failed_at: Time?,
|
|
135
|
+
payment_received_at: Time?,
|
|
132
136
|
payment_started_at: Time?,
|
|
133
137
|
scheduled_issue_at: Time?,
|
|
134
138
|
shipping_address: Orb::Address?,
|
|
@@ -165,6 +169,7 @@ module Orb
|
|
|
165
169
|
paid_at: Time?,
|
|
166
170
|
payment_attempts: ::Array[Orb::Models::InvoiceIssueSummaryResponse::PaymentAttempt],
|
|
167
171
|
payment_failed_at: Time?,
|
|
172
|
+
payment_received_at: Time?,
|
|
168
173
|
payment_started_at: Time?,
|
|
169
174
|
scheduled_issue_at: Time?,
|
|
170
175
|
shipping_address: Orb::Address?,
|