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
@@ -105,6 +105,16 @@ module MetronomeSDK
105
105
  MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter
106
106
  }
107
107
 
108
+ # @!attribute group_values
109
+ # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
110
+ # group key on individual line items.
111
+ #
112
+ # @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>, nil]
113
+ optional :group_values,
114
+ -> {
115
+ MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue]
116
+ }
117
+
108
118
  # @!attribute invoice_types_filter
109
119
  # Only supported for invoice_total_reached alerts. A list of invoice types to
110
120
  # evaluate.
@@ -120,7 +130,7 @@ module MetronomeSDK
120
130
  # @return [String, nil]
121
131
  optional :uniqueness_key, String
122
132
 
123
- # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, invoice_types_filter: nil, uniqueness_key: nil)
133
+ # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, group_values: nil, invoice_types_filter: nil, uniqueness_key: nil)
124
134
  # Some parameter documentations has been truncated, see
125
135
  # {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
126
136
  #
@@ -144,6 +154,8 @@ module MetronomeSDK
144
154
  #
145
155
  # @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
146
156
  #
157
+ # @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
158
+ #
147
159
  # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
148
160
  #
149
161
  # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
@@ -245,6 +257,22 @@ module MetronomeSDK
245
257
  # @param key [String]
246
258
  # @param value [String]
247
259
  end
260
+
261
+ class GroupValue < MetronomeSDK::Internal::Type::BaseModel
262
+ # @!attribute key
263
+ #
264
+ # @return [String]
265
+ required :key, String
266
+
267
+ # @!attribute value
268
+ #
269
+ # @return [String]
270
+ required :value, String
271
+
272
+ # @!method initialize(key:, value:)
273
+ # @param key [String]
274
+ # @param value [String]
275
+ end
248
276
  end
249
277
 
250
278
  # The status of the customer alert. If the alert is archived, null will be
@@ -148,6 +148,8 @@ module MetronomeSDK
148
148
  USAGE_LINE_9 = :UsageLine_9
149
149
  PRIMARY_GREEN = :Primary_green
150
150
  PRIMARY_RED = :Primary_red
151
+ PROGRESS_BAR = :Progress_bar
152
+ PROGRESS_BAR_BACKGROUND = :Progress_bar_background
151
153
 
152
154
  # @!method self.values
153
155
  # @return [Array<Symbol>]
@@ -62,6 +62,8 @@ module MetronomeSDK
62
62
  # or credit. A customer's usage needs to meet the condition of at least one of the
63
63
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
64
64
  # be used together with `applicable_product_ids` or `applicable_product_tags`.
65
+ # Instead, to target usage by product or product tag, pass those values in the
66
+ # body of `specifiers`.
65
67
  #
66
68
  # @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::Specifier>, nil]
67
69
  optional :specifiers,
@@ -49,6 +49,8 @@ module MetronomeSDK
49
49
  # or credit. A customer's usage needs to meet the condition of at least one of the
50
50
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
51
51
  # be used together with `applicable_product_ids` or `applicable_product_tags`.
52
+ # Instead, to target usage by product or product tag, pass those values in the
53
+ # body of `specifiers`.
52
54
  #
53
55
  # @return [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::Specifier>, nil]
54
56
  optional :specifiers,