orb-billing 1.38.0 → 1.39.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.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/changed_subscription_resources.rb +14 -1
  5. data/lib/orb/models/events/backfill_list_params.rb +29 -1
  6. data/lib/orb/models/invoice.rb +14 -1
  7. data/lib/orb/models/invoice_fetch_upcoming_response.rb +14 -1
  8. data/lib/orb/models/invoice_issue_summary_response.rb +14 -1
  9. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +14 -1
  10. data/lib/orb/models/invoice_list_summary_response.rb +14 -1
  11. data/lib/orb/resources/events/backfills.rb +11 -2
  12. data/lib/orb/version.rb +1 -1
  13. data/rbi/orb/models/changed_subscription_resources.rbi +18 -0
  14. data/rbi/orb/models/events/backfill_list_params.rbi +58 -0
  15. data/rbi/orb/models/invoice.rbi +18 -0
  16. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +18 -0
  17. data/rbi/orb/models/invoice_issue_summary_response.rbi +18 -0
  18. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +18 -0
  19. data/rbi/orb/models/invoice_list_summary_response.rbi +18 -0
  20. data/rbi/orb/resources/events/backfills.rbi +12 -1
  21. data/sig/orb/models/changed_subscription_resources.rbs +5 -0
  22. data/sig/orb/models/events/backfill_list_params.rbs +27 -1
  23. data/sig/orb/models/invoice.rbs +5 -0
  24. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +5 -0
  25. data/sig/orb/models/invoice_issue_summary_response.rbs +5 -0
  26. data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +5 -0
  27. data/sig/orb/models/invoice_list_summary_response.rbs +5 -0
  28. data/sig/orb/resources/events/backfills.rbs +2 -0
  29. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '08d38e370980ec182afc292c85c50e3e3d97915a13674b58f16205536ac40509'
4
- data.tar.gz: d6fabb14c95ee9c31d50ea0d2f77e0531ab4aa2719e36ae21d59911a53406962
3
+ metadata.gz: c0a9272658203e27f096597fcf707e6f168ba671f7a9b24da1618ab018a7e19f
4
+ data.tar.gz: d8adf16bf1f52f56468c22783c9d28ec6fec531b4ba25b7b545d942cbc82f5f5
5
5
  SHA512:
6
- metadata.gz: 18505cebc20678a82ead5270592e366c99faba099075532ea2f126cde3587e288c237fc1eac3ef617cff148f2f06e4973da7eb110490b175e9ef9b1ae99fed82
7
- data.tar.gz: 84c365786b41b80d4609739230596d4728757c2ebbd38c32b40e7d94c37d5fed954d4e96fad227f1445e9210a725619431ad319601dca64b72f2c75afb6c1869
6
+ metadata.gz: ed994b60bbfe92f2faebb1eb6f479187f0c903e04357740976a63ff383b0329cee0e0ef990aeba26f7ed8fa56067d967ea92f1347c2f84448785ce89c9e61770
7
+ data.tar.gz: 9e5940453306f3ff24b0027885138b31d095fdfa42865fabccf8ba5585f510832decf24770165b5b3890c212a6f85eec78e554e46be15b9873aacb2a9fa7fe6e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.39.0](https://github.com/orbcorp/orb-ruby/compare/v1.38.0...v1.39.0) (2026-10-01)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** add `customer_id` and `status` filters to list backfills endpoint ([3d497bc](https://github.com/orbcorp/orb-ruby/commit/3d497bc1dde6257959f0bd502057e91b4229356e))
9
+ * **api:** add `payment_received_at` field to invoice responses ([959a88d](https://github.com/orbcorp/orb-ruby/commit/959a88d58c0fb54a2d9c28a8c9c91f5a1a42c5a8))
10
+
11
+
12
+ ### Bug Fixes
13
+
14
+ * **api:** correct webhook doc page titles and remove inapplicable auth section ([959a88d](https://github.com/orbcorp/orb-ruby/commit/959a88d58c0fb54a2d9c28a8c9c91f5a1a42c5a8))
15
+
3
16
  ## [1.38.0](https://github.com/orbcorp/orb-ruby/compare/v1.37.0...v1.38.0) (2026-09-25)
4
17
 
5
18
 
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "orb-billing", "~> 1.38.0"
18
+ gem "orb-billing", "~> 1.39.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -399,6 +399,17 @@ module Orb
399
399
  # @return [Time, nil]
400
400
  required :payment_failed_at, Time, nil?: true
401
401
 
402
+ # @!attribute payment_received_at
403
+ # When payment for this invoice was received. For an invoice manually marked as
404
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
405
+ # through a payment provider, this is the settlement time reported by that
406
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
407
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
408
+ # when the invoice reached the `paid` status in Orb.
409
+ #
410
+ # @return [Time, nil]
411
+ required :payment_received_at, Time, nil?: true
412
+
402
413
  # @!attribute payment_started_at
403
414
  # If payment was attempted on this invoice, this will be the start time of the
404
415
  # most recent attempt. This field is especially useful for delayed-notification
@@ -463,7 +474,7 @@ module Orb
463
474
  # @return [Boolean]
464
475
  required :will_auto_issue, Orb::Internal::Type::Boolean
465
476
 
466
- # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, is_payable_now:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
477
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, is_payable_now:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
467
478
  # Some parameter documentations has been truncated, see
468
479
  # {Orb::Models::ChangedSubscriptionResources::CreatedInvoice} for more details.
469
480
  #
@@ -533,6 +544,8 @@ module Orb
533
544
  #
534
545
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
535
546
  #
547
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
548
+ #
536
549
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
537
550
  #
538
551
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
@@ -15,21 +15,49 @@ module Orb
15
15
  # @return [String, nil]
16
16
  optional :cursor, String, nil?: true
17
17
 
18
+ # @!attribute customer_id
19
+ #
20
+ # @return [String, nil]
21
+ optional :customer_id, String, nil?: true
22
+
18
23
  # @!attribute limit
19
24
  # The number of items to fetch. Defaults to 20.
20
25
  #
21
26
  # @return [Integer, nil]
22
27
  optional :limit, Integer
23
28
 
24
- # @!method initialize(cursor: nil, limit: nil, request_options: {})
29
+ # @!attribute status
30
+ # The status of the backfill.
31
+ #
32
+ # @return [Symbol, Orb::Models::Events::BackfillListParams::Status, nil]
33
+ optional :status, enum: -> { Orb::Events::BackfillListParams::Status }, nil?: true
34
+
35
+ # @!method initialize(cursor: nil, customer_id: nil, limit: nil, status: nil, request_options: {})
25
36
  # Some parameter documentations has been truncated, see
26
37
  # {Orb::Models::Events::BackfillListParams} for more details.
27
38
  #
28
39
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
29
40
  #
41
+ # @param customer_id [String, nil]
42
+ #
30
43
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
31
44
  #
45
+ # @param status [Symbol, Orb::Models::Events::BackfillListParams::Status, nil] The status of the backfill.
46
+ #
32
47
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
48
+
49
+ # The status of the backfill.
50
+ module Status
51
+ extend Orb::Internal::Type::Enum
52
+
53
+ PENDING = :pending
54
+ REFLECTED = :reflected
55
+ PENDING_REVERT = :pending_revert
56
+ REVERTED = :reverted
57
+
58
+ # @!method self.values
59
+ # @return [Array<Symbol>]
60
+ end
33
61
  end
34
62
  end
35
63
  end
@@ -355,6 +355,17 @@ module Orb
355
355
  # @return [Time, nil]
356
356
  required :payment_failed_at, Time, nil?: true
357
357
 
358
+ # @!attribute payment_received_at
359
+ # When payment for this invoice was received. For an invoice manually marked as
360
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
361
+ # through a payment provider, this is the settlement time reported by that
362
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
363
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
364
+ # when the invoice reached the `paid` status in Orb.
365
+ #
366
+ # @return [Time, nil]
367
+ required :payment_received_at, Time, nil?: true
368
+
358
369
  # @!attribute payment_started_at
359
370
  # If payment was attempted on this invoice, this will be the start time of the
360
371
  # most recent attempt. This field is especially useful for delayed-notification
@@ -419,7 +430,7 @@ module Orb
419
430
  # @return [Boolean]
420
431
  required :will_auto_issue, Orb::Internal::Type::Boolean
421
432
 
422
- # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
433
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
423
434
  # Some parameter documentations has been truncated, see {Orb::Models::Invoice} for
424
435
  # more details.
425
436
  #
@@ -493,6 +504,8 @@ module Orb
493
504
  #
494
505
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
495
506
  #
507
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
508
+ #
496
509
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
497
510
  #
498
511
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
@@ -353,6 +353,17 @@ module Orb
353
353
  # @return [Time, nil]
354
354
  required :payment_failed_at, Time, nil?: true
355
355
 
356
+ # @!attribute payment_received_at
357
+ # When payment for this invoice was received. For an invoice manually marked as
358
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
359
+ # through a payment provider, this is the settlement time reported by that
360
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
361
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
362
+ # when the invoice reached the `paid` status in Orb.
363
+ #
364
+ # @return [Time, nil]
365
+ required :payment_received_at, Time, nil?: true
366
+
356
367
  # @!attribute payment_started_at
357
368
  # If payment was attempted on this invoice, this will be the start time of the
358
369
  # most recent attempt. This field is especially useful for delayed-notification
@@ -423,7 +434,7 @@ module Orb
423
434
  # @return [Boolean]
424
435
  required :will_auto_issue, Orb::Internal::Type::Boolean
425
436
 
426
- # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:)
437
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:)
427
438
  # Some parameter documentations has been truncated, see
428
439
  # {Orb::Models::InvoiceFetchUpcomingResponse} for more details.
429
440
  #
@@ -489,6 +500,8 @@ module Orb
489
500
  #
490
501
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
491
502
  #
503
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
504
+ #
492
505
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
493
506
  #
494
507
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
@@ -308,6 +308,17 @@ module Orb
308
308
  # @return [Time, nil]
309
309
  required :payment_failed_at, Time, nil?: true
310
310
 
311
+ # @!attribute payment_received_at
312
+ # When payment for this invoice was received. For an invoice manually marked as
313
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
314
+ # through a payment provider, this is the settlement time reported by that
315
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
316
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
317
+ # when the invoice reached the `paid` status in Orb.
318
+ #
319
+ # @return [Time, nil]
320
+ required :payment_received_at, Time, nil?: true
321
+
311
322
  # @!attribute payment_started_at
312
323
  # If payment was attempted on this invoice, this will be the start time of the
313
324
  # most recent attempt. This field is especially useful for delayed-notification
@@ -366,7 +377,7 @@ module Orb
366
377
  # @return [Boolean]
367
378
  required :will_auto_issue, Orb::Internal::Type::Boolean
368
379
 
369
- # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
380
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
370
381
  # Some parameter documentations has been truncated, see
371
382
  # {Orb::Models::InvoiceIssueSummaryResponse} for more details.
372
383
  #
@@ -420,6 +431,8 @@ module Orb
420
431
  #
421
432
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
422
433
  #
434
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
435
+ #
423
436
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
424
437
  #
425
438
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
@@ -352,6 +352,17 @@ module Orb
352
352
  # @return [Time, nil]
353
353
  required :payment_failed_at, Time, nil?: true
354
354
 
355
+ # @!attribute payment_received_at
356
+ # When payment for this invoice was received. For an invoice manually marked as
357
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
358
+ # through a payment provider, this is the settlement time reported by that
359
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
360
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
361
+ # when the invoice reached the `paid` status in Orb.
362
+ #
363
+ # @return [Time, nil]
364
+ required :payment_received_at, Time, nil?: true
365
+
355
366
  # @!attribute payment_started_at
356
367
  # If payment was attempted on this invoice, this will be the start time of the
357
368
  # most recent attempt. This field is especially useful for delayed-notification
@@ -410,7 +421,7 @@ module Orb
410
421
  # @return [Boolean]
411
422
  required :will_auto_issue, Orb::Internal::Type::Boolean
412
423
 
413
- # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
424
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
414
425
  # Some parameter documentations has been truncated, see
415
426
  # {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice} for more details.
416
427
  #
@@ -464,6 +475,8 @@ module Orb
464
475
  #
465
476
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
466
477
  #
478
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
479
+ #
467
480
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
468
481
  #
469
482
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
@@ -308,6 +308,17 @@ module Orb
308
308
  # @return [Time, nil]
309
309
  required :payment_failed_at, Time, nil?: true
310
310
 
311
+ # @!attribute payment_received_at
312
+ # When payment for this invoice was received. For an invoice manually marked as
313
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
314
+ # through a payment provider, this is the settlement time reported by that
315
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
316
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
317
+ # when the invoice reached the `paid` status in Orb.
318
+ #
319
+ # @return [Time, nil]
320
+ required :payment_received_at, Time, nil?: true
321
+
311
322
  # @!attribute payment_started_at
312
323
  # If payment was attempted on this invoice, this will be the start time of the
313
324
  # most recent attempt. This field is especially useful for delayed-notification
@@ -366,7 +377,7 @@ module Orb
366
377
  # @return [Boolean]
367
378
  required :will_auto_issue, Orb::Internal::Type::Boolean
368
379
 
369
- # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
380
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
370
381
  # Some parameter documentations has been truncated, see
371
382
  # {Orb::Models::InvoiceListSummaryResponse} for more details.
372
383
  #
@@ -420,6 +431,8 @@ module Orb
420
431
  #
421
432
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
422
433
  #
434
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
435
+ #
423
436
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
424
437
  #
425
438
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
@@ -46,7 +46,10 @@ module Orb
46
46
  # enables filtering using
47
47
  # [computed properties](/extensibility/advanced-metrics#computed-properties). The
48
48
  # expressiveness of computed properties allows you to deprecate existing events
49
- # based on both a period of time and specific property values.
49
+ # based on both a period of time and specific property values. When
50
+ # `deprecation_filter` is provided, the timeframe may extend to `now` rather than
51
+ # the event reporting grace boundary. Matching events that arrive later with
52
+ # timestamps inside the timeframe will also be deprecated.
50
53
  #
51
54
  # You may not have multiple backfills in a pending or pending_revert state with
52
55
  # overlapping timeframes.
@@ -93,12 +96,18 @@ module Orb
93
96
  # [`pagination_metadata`](/api-reference/pagination), which lets the caller
94
97
  # retrieve the next page of results if they exist.
95
98
  #
96
- # @overload list(cursor: nil, limit: nil, request_options: {})
99
+ # Use `customer_id` and `status` to filter the results.
100
+ #
101
+ # @overload list(cursor: nil, customer_id: nil, limit: nil, status: nil, request_options: {})
97
102
  #
98
103
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
99
104
  #
105
+ # @param customer_id [String, nil]
106
+ #
100
107
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
101
108
  #
109
+ # @param status [Symbol, Orb::Models::Events::BackfillListParams::Status, nil] The status of the backfill.
110
+ #
102
111
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
103
112
  #
104
113
  # @return [Orb::Internal::Page<Orb::Models::Events::BackfillListResponse>]
data/lib/orb/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Orb
4
- VERSION = "1.38.0"
4
+ VERSION = "1.39.0"
5
5
  end
@@ -416,6 +416,15 @@ module Orb
416
416
  sig { returns(T.nilable(Time)) }
417
417
  attr_accessor :payment_failed_at
418
418
 
419
+ # When payment for this invoice was received. For an invoice manually marked as
420
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
421
+ # through a payment provider, this is the settlement time reported by that
422
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
423
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
424
+ # when the invoice reached the `paid` status in Orb.
425
+ sig { returns(T.nilable(Time)) }
426
+ attr_accessor :payment_received_at
427
+
419
428
  # If payment was attempted on this invoice, this will be the start time of the
420
429
  # most recent attempt. This field is especially useful for delayed-notification
421
430
  # payment mechanisms (like bank transfers), where payment can take 3 days or more.
@@ -531,6 +540,7 @@ module Orb
531
540
  Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt::OrHash
532
541
  ],
533
542
  payment_failed_at: T.nilable(Time),
543
+ payment_received_at: T.nilable(Time),
534
544
  payment_started_at: T.nilable(Time),
535
545
  scheduled_issue_at: T.nilable(Time),
536
546
  shipping_address: T.nilable(Orb::Address::OrHash),
@@ -768,6 +778,13 @@ module Orb
768
778
  # If payment was attempted on this invoice but failed, this will be the time of
769
779
  # the most recent attempt.
770
780
  payment_failed_at:,
781
+ # When payment for this invoice was received. For an invoice manually marked as
782
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
783
+ # through a payment provider, this is the settlement time reported by that
784
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
785
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
786
+ # when the invoice reached the `paid` status in Orb.
787
+ payment_received_at:,
771
788
  # If payment was attempted on this invoice, this will be the start time of the
772
789
  # most recent attempt. This field is especially useful for delayed-notification
773
790
  # payment mechanisms (like bank transfers), where payment can take 3 days or more.
@@ -845,6 +862,7 @@ module Orb
845
862
  Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt
846
863
  ],
847
864
  payment_failed_at: T.nilable(Time),
865
+ payment_received_at: T.nilable(Time),
848
866
  payment_started_at: T.nilable(Time),
849
867
  scheduled_issue_at: T.nilable(Time),
850
868
  shipping_address: T.nilable(Orb::Address),
@@ -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
@@ -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),
@@ -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?,
@@ -2,7 +2,12 @@ module Orb
2
2
  module Models
3
3
  module Events
4
4
  type backfill_list_params =
5
- { cursor: String?, limit: Integer }
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
@@ -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?,
@@ -62,6 +62,7 @@ module Orb
62
62
  paid_at: Time?,
63
63
  payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt],
64
64
  payment_failed_at: Time?,
65
+ payment_received_at: Time?,
65
66
  payment_started_at: Time?,
66
67
  scheduled_issue_at: Time?,
67
68
  shipping_address: Orb::Address?,
@@ -122,6 +123,8 @@ module Orb
122
123
 
123
124
  attr_accessor payment_failed_at: Time?
124
125
 
126
+ attr_accessor payment_received_at: Time?
127
+
125
128
  attr_accessor payment_started_at: Time?
126
129
 
127
130
  attr_accessor scheduled_issue_at: Time?
@@ -165,6 +168,7 @@ module Orb
165
168
  paid_at: Time?,
166
169
  payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt],
167
170
  payment_failed_at: Time?,
171
+ payment_received_at: Time?,
168
172
  payment_started_at: Time?,
169
173
  scheduled_issue_at: Time?,
170
174
  shipping_address: Orb::Address?,
@@ -201,6 +205,7 @@ module Orb
201
205
  paid_at: Time?,
202
206
  payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt],
203
207
  payment_failed_at: Time?,
208
+ payment_received_at: Time?,
204
209
  payment_started_at: Time?,
205
210
  scheduled_issue_at: Time?,
206
211
  shipping_address: Orb::Address?,
@@ -26,6 +26,7 @@ module Orb
26
26
  paid_at: Time?,
27
27
  payment_attempts: ::Array[Orb::Models::InvoiceListSummaryResponse::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::InvoiceListSummaryResponse::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::InvoiceListSummaryResponse::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?,
@@ -15,7 +15,9 @@ module Orb
15
15
 
16
16
  def list: (
17
17
  ?cursor: String?,
18
+ ?customer_id: String?,
18
19
  ?limit: Integer,
20
+ ?status: Orb::Models::Events::BackfillListParams::status?,
19
21
  ?request_options: Orb::request_opts
20
22
  ) -> Orb::Internal::Page[Orb::Models::Events::BackfillListResponse]
21
23
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: orb-billing
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.38.0
4
+ version: 1.39.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb
@@ -1653,7 +1653,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
1653
1653
  - !ruby/object:Gem::Version
1654
1654
  version: '0'
1655
1655
  requirements: []
1656
- rubygems_version: 4.0.21
1656
+ rubygems_version: 4.0.22
1657
1657
  specification_version: 4
1658
1658
  summary: Ruby library to access the Orb API
1659
1659
  test_files: []