metronome-sdk 0.1.0.pre.alpha.4 → 0.2.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 (68) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +30 -0
  3. data/README.md +1 -1
  4. data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
  5. data/lib/metronome_sdk/internal/transport/base_client.rb +1 -1
  6. data/lib/metronome_sdk/models/commit.rb +81 -8
  7. data/lib/metronome_sdk/models/contract_without_amendments.rb +368 -2
  8. data/lib/metronome_sdk/models/credit.rb +67 -6
  9. data/lib/metronome_sdk/models/v1/alert_create_params.rb +9 -11
  10. data/lib/metronome_sdk/models/v1/contract_create_params.rb +399 -12
  11. data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +9 -1
  12. data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +9 -1
  13. data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +9 -1
  14. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +29 -1
  15. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +2 -0
  16. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +2 -0
  17. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +2 -0
  18. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +417 -18
  19. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +776 -12
  20. data/lib/metronome_sdk/models/v2/contract_list_response.rb +529 -22
  21. data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +529 -22
  22. data/lib/metronome_sdk/resources/v1/alerts.rb +2 -2
  23. data/lib/metronome_sdk/resources/v1/contracts.rb +3 -1
  24. data/lib/metronome_sdk/resources/v1/customers/commits.rb +3 -1
  25. data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -1
  26. data/lib/metronome_sdk/version.rb +1 -1
  27. data/rbi/metronome_sdk/internal/transport/base_client.rbi +1 -1
  28. data/rbi/metronome_sdk/models/commit.rbi +173 -15
  29. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +888 -6
  30. data/rbi/metronome_sdk/models/credit.rbi +141 -12
  31. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +16 -18
  32. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1160 -226
  33. data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +11 -0
  34. data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +11 -0
  35. data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +11 -0
  36. data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +60 -0
  37. data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +10 -0
  38. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +4 -0
  39. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +4 -0
  40. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +1192 -234
  41. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +2155 -87
  42. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +1260 -47
  43. data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +1260 -47
  44. data/rbi/metronome_sdk/resources/v1/alerts.rbi +5 -5
  45. data/rbi/metronome_sdk/resources/v1/contracts.rbi +3 -0
  46. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +3 -0
  47. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
  48. data/rbi/metronome_sdk/resources/v2/contracts.rbi +4 -0
  49. data/sig/metronome_sdk/internal/transport/base_client.rbs +1 -1
  50. data/sig/metronome_sdk/models/commit.rbs +93 -15
  51. data/sig/metronome_sdk/models/contract_without_amendments.rbs +366 -6
  52. data/sig/metronome_sdk/models/credit.rbs +73 -9
  53. data/sig/metronome_sdk/models/v1/alert_create_params.rbs +9 -9
  54. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +376 -3
  55. data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +7 -0
  56. data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +7 -0
  57. data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +7 -0
  58. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +21 -0
  59. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +4 -0
  60. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +376 -3
  61. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +858 -6
  62. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +558 -30
  63. data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +558 -30
  64. data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -1
  65. data/sig/metronome_sdk/resources/v1/contracts.rbs +1 -0
  66. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
  67. data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
  68. metadata +4 -4
@@ -20,8 +20,8 @@ module MetronomeSDK
20
20
  ],
21
21
  customer_id: String,
22
22
  evaluate_on_create: T::Boolean,
23
- group_key_filter:
24
- MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter::OrHash,
23
+ group_values:
24
+ T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash],
25
25
  invoice_types_filter: T::Array[String],
26
26
  plan_id: String,
27
27
  uniqueness_key: String,
@@ -57,9 +57,9 @@ module MetronomeSDK
57
57
  # alert threshold. If false, it will only evaluate on future customers that
58
58
  # trigger the alert threshold. Defaults to true.
59
59
  evaluate_on_create: nil,
60
- # Scopes alert evaluation to a specific presentation group key on individual line
61
- # items. Only present for spend alerts.
62
- group_key_filter: nil,
60
+ # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
61
+ # group key on individual line items.
62
+ group_values: nil,
63
63
  # Only supported for invoice_total_reached alerts. A list of invoice types to
64
64
  # evaluate.
65
65
  invoice_types_filter: nil,
@@ -355,6 +355,7 @@ module MetronomeSDK
355
355
  include_balance: T::Boolean,
356
356
  include_contract_balances: T::Boolean,
357
357
  include_ledgers: T::Boolean,
358
+ limit: Integer,
358
359
  next_page: String,
359
360
  starting_at: Time,
360
361
  request_options: MetronomeSDK::RequestOptions::OrHash
@@ -377,6 +378,8 @@ module MetronomeSDK
377
378
  # Include ledgers in the response. Setting this flag may cause the query to be
378
379
  # slower.
379
380
  include_ledgers: nil,
381
+ # The maximum number of commits to return. Defaults to 25.
382
+ limit: nil,
380
383
  # The next page token from a previous response.
381
384
  next_page: nil,
382
385
  # Include only balances that have any access on or after the provided date
@@ -103,6 +103,7 @@ module MetronomeSDK
103
103
  include_balance: T::Boolean,
104
104
  include_contract_commits: T::Boolean,
105
105
  include_ledgers: T::Boolean,
106
+ limit: Integer,
106
107
  next_page: String,
107
108
  starting_at: Time,
108
109
  request_options: MetronomeSDK::RequestOptions::OrHash
@@ -125,6 +126,8 @@ module MetronomeSDK
125
126
  # Include commit ledgers in the response. Setting this flag may cause the query to
126
127
  # be slower.
127
128
  include_ledgers: nil,
129
+ # The maximum number of commits to return. Defaults to 25.
130
+ limit: nil,
128
131
  # The next page token from a previous response.
129
132
  next_page: nil,
130
133
  # Include only commits that have any access on or after the provided date
@@ -83,6 +83,7 @@ module MetronomeSDK
83
83
  include_balance: T::Boolean,
84
84
  include_contract_credits: T::Boolean,
85
85
  include_ledgers: T::Boolean,
86
+ limit: Integer,
86
87
  next_page: String,
87
88
  starting_at: Time,
88
89
  request_options: MetronomeSDK::RequestOptions::OrHash
@@ -105,6 +106,8 @@ module MetronomeSDK
105
106
  # Include credit ledgers in the response. Setting this flag may cause the query to
106
107
  # be slower.
107
108
  include_ledgers: nil,
109
+ # The maximum number of commits to return. Defaults to 25.
110
+ limit: nil,
108
111
  # The next page token from a previous response.
109
112
  next_page: nil,
110
113
  # Include only credits that have any access on or after the provided date
@@ -263,6 +263,8 @@ module MetronomeSDK
263
263
  # or credit. A customer's usage needs to meet the condition of at least one of the
264
264
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
265
265
  # be used together with `applicable_product_ids` or `applicable_product_tags`.
266
+ # Instead, to target usage by product or product tag, pass those values in the
267
+ # body of `specifiers`.
266
268
  specifiers: nil,
267
269
  request_options: {}
268
270
  )
@@ -305,6 +307,8 @@ module MetronomeSDK
305
307
  # or credit. A customer's usage needs to meet the condition of at least one of the
306
308
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
307
309
  # be used together with `applicable_product_ids` or `applicable_product_tags`.
310
+ # Instead, to target usage by product or product tag, pass those values in the
311
+ # body of `specifiers`.
308
312
  specifiers: nil,
309
313
  request_options: {}
310
314
  )
@@ -99,7 +99,7 @@ module MetronomeSDK
99
99
  retry_count: Integer
100
100
  ) -> Float
101
101
 
102
- private def send_request: (
102
+ def send_request: (
103
103
  MetronomeSDK::Internal::Transport::BaseClient::request_input request,
104
104
  redirect_count: Integer,
105
105
  retry_count: Integer,
@@ -369,6 +369,7 @@ module MetronomeSDK
369
369
  | MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry
370
370
  | MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry
371
371
  | MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry
372
+ | MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry
372
373
  | MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry
373
374
  | MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry
374
375
  | MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry
@@ -428,7 +429,8 @@ module MetronomeSDK
428
429
  invoice_id: String,
429
430
  segment_id: String,
430
431
  timestamp: Time,
431
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
432
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_,
433
+ contract_id: String
432
434
  }
433
435
 
434
436
  class PrepaidCommitAutomatedInvoiceDeductionLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
@@ -442,12 +444,17 @@ module MetronomeSDK
442
444
 
443
445
  attr_accessor type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
444
446
 
447
+ attr_reader contract_id: String?
448
+
449
+ def contract_id=: (String) -> String
450
+
445
451
  def initialize: (
446
452
  amount: Float,
447
453
  invoice_id: String,
448
454
  segment_id: String,
449
455
  timestamp: Time,
450
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
456
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_,
457
+ ?contract_id: String
451
458
  ) -> void
452
459
 
453
460
  def to_hash: -> {
@@ -455,7 +462,8 @@ module MetronomeSDK
455
462
  invoice_id: String,
456
463
  segment_id: String,
457
464
  timestamp: Time,
458
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
465
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::type_,
466
+ contract_id: String
459
467
  }
460
468
 
461
469
  type type_ = :PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION
@@ -564,7 +572,8 @@ module MetronomeSDK
564
572
  invoice_id: String,
565
573
  segment_id: String,
566
574
  timestamp: Time,
567
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_
575
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_,
576
+ contract_id: String
568
577
  }
569
578
 
570
579
  class PrepaidCommitCanceledLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
@@ -578,12 +587,17 @@ module MetronomeSDK
578
587
 
579
588
  attr_accessor type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_
580
589
 
590
+ attr_reader contract_id: String?
591
+
592
+ def contract_id=: (String) -> String
593
+
581
594
  def initialize: (
582
595
  amount: Float,
583
596
  invoice_id: String,
584
597
  segment_id: String,
585
598
  timestamp: Time,
586
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_
599
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_,
600
+ ?contract_id: String
587
601
  ) -> void
588
602
 
589
603
  def to_hash: -> {
@@ -591,7 +605,8 @@ module MetronomeSDK
591
605
  invoice_id: String,
592
606
  segment_id: String,
593
607
  timestamp: Time,
594
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_
608
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::type_,
609
+ contract_id: String
595
610
  }
596
611
 
597
612
  type type_ = :PREPAID_COMMIT_CANCELED
@@ -611,7 +626,8 @@ module MetronomeSDK
611
626
  invoice_id: String,
612
627
  segment_id: String,
613
628
  timestamp: Time,
614
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_
629
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_,
630
+ contract_id: String
615
631
  }
616
632
 
617
633
  class PrepaidCommitCreditedLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
@@ -625,12 +641,17 @@ module MetronomeSDK
625
641
 
626
642
  attr_accessor type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_
627
643
 
644
+ attr_reader contract_id: String?
645
+
646
+ def contract_id=: (String) -> String
647
+
628
648
  def initialize: (
629
649
  amount: Float,
630
650
  invoice_id: String,
631
651
  segment_id: String,
632
652
  timestamp: Time,
633
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_
653
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_,
654
+ ?contract_id: String
634
655
  ) -> void
635
656
 
636
657
  def to_hash: -> {
@@ -638,7 +659,8 @@ module MetronomeSDK
638
659
  invoice_id: String,
639
660
  segment_id: String,
640
661
  timestamp: Time,
641
- type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_
662
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::type_,
663
+ contract_id: String
642
664
  }
643
665
 
644
666
  type type_ = :PREPAID_COMMIT_CREDITED
@@ -652,6 +674,48 @@ module MetronomeSDK
652
674
  end
653
675
  end
654
676
 
677
+ type prepaid_commit_seat_based_adjustment_ledger_entry =
678
+ {
679
+ amount: Float,
680
+ segment_id: String,
681
+ timestamp: Time,
682
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::type_
683
+ }
684
+
685
+ class PrepaidCommitSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
686
+ attr_accessor amount: Float
687
+
688
+ attr_accessor segment_id: String
689
+
690
+ attr_accessor timestamp: Time
691
+
692
+ attr_accessor type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::type_
693
+
694
+ def initialize: (
695
+ amount: Float,
696
+ segment_id: String,
697
+ timestamp: Time,
698
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::type_
699
+ ) -> void
700
+
701
+ def to_hash: -> {
702
+ amount: Float,
703
+ segment_id: String,
704
+ timestamp: Time,
705
+ type: MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::type_
706
+ }
707
+
708
+ type type_ = :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT
709
+
710
+ module Type
711
+ extend MetronomeSDK::Internal::Type::Enum
712
+
713
+ PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT: :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT
714
+
715
+ def self?.values: -> ::Array[MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::type_]
716
+ end
717
+ end
718
+
655
719
  type postpaid_commit_initial_balance_ledger_entry =
656
720
  {
657
721
  amount: Float,
@@ -695,7 +759,8 @@ module MetronomeSDK
695
759
  invoice_id: String,
696
760
  segment_id: String,
697
761
  timestamp: Time,
698
- type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
762
+ type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_,
763
+ contract_id: String
699
764
  }
700
765
 
701
766
  class PostpaidCommitAutomatedInvoiceDeductionLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
@@ -709,12 +774,17 @@ module MetronomeSDK
709
774
 
710
775
  attr_accessor type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
711
776
 
777
+ attr_reader contract_id: String?
778
+
779
+ def contract_id=: (String) -> String
780
+
712
781
  def initialize: (
713
782
  amount: Float,
714
783
  invoice_id: String,
715
784
  segment_id: String,
716
785
  timestamp: Time,
717
- type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
786
+ type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_,
787
+ ?contract_id: String
718
788
  ) -> void
719
789
 
720
790
  def to_hash: -> {
@@ -722,7 +792,8 @@ module MetronomeSDK
722
792
  invoice_id: String,
723
793
  segment_id: String,
724
794
  timestamp: Time,
725
- type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_
795
+ type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::type_,
796
+ contract_id: String
726
797
  }
727
798
 
728
799
  type type_ = :POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION
@@ -788,7 +859,8 @@ module MetronomeSDK
788
859
  amount: Float,
789
860
  invoice_id: String,
790
861
  timestamp: Time,
791
- type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_
862
+ type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_,
863
+ contract_id: String
792
864
  }
793
865
 
794
866
  class PostpaidCommitTrueupLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
@@ -800,18 +872,24 @@ module MetronomeSDK
800
872
 
801
873
  attr_accessor type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_
802
874
 
875
+ attr_reader contract_id: String?
876
+
877
+ def contract_id=: (String) -> String
878
+
803
879
  def initialize: (
804
880
  amount: Float,
805
881
  invoice_id: String,
806
882
  timestamp: Time,
807
- type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_
883
+ type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_,
884
+ ?contract_id: String
808
885
  ) -> void
809
886
 
810
887
  def to_hash: -> {
811
888
  amount: Float,
812
889
  invoice_id: String,
813
890
  timestamp: Time,
814
- type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_
891
+ type: MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::type_,
892
+ contract_id: String
815
893
  }
816
894
 
817
895
  type type_ = :POSTPAID_COMMIT_TRUEUP