metronome-sdk 0.1.0.pre.alpha.4 → 0.1.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 +16 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
- data/lib/metronome_sdk/models/commit.rb +46 -3
- data/lib/metronome_sdk/models/contract_without_amendments.rb +242 -2
- data/lib/metronome_sdk/models/credit.rb +46 -3
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +242 -2
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +9 -1
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +242 -2
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +214 -6
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +343 -13
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +343 -13
- data/lib/metronome_sdk/resources/v1/contracts.rb +3 -1
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +3 -1
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -1
- data/lib/metronome_sdk/version.rb +1 -1
- data/rbi/metronome_sdk/models/commit.rbi +84 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +584 -0
- data/rbi/metronome_sdk/models/credit.rbi +87 -3
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +747 -147
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +11 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +747 -147
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +584 -6
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +867 -48
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +867 -48
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
- data/sig/metronome_sdk/models/commit.rbs +43 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +246 -0
- data/sig/metronome_sdk/models/credit.rbs +43 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +246 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +246 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +246 -0
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +353 -0
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +353 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
- metadata +4 -4
@@ -112,6 +112,13 @@ module MetronomeSDK
|
|
112
112
|
# @return [Time, nil]
|
113
113
|
optional :ending_before, Time
|
114
114
|
|
115
|
+
# @!attribute has_more
|
116
|
+
# Indicates whether there are more items than the limit for this endpoint. Use the
|
117
|
+
# respective list endpoints to get the full lists.
|
118
|
+
#
|
119
|
+
# @return [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::HasMore, nil]
|
120
|
+
optional :has_more, -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::HasMore }
|
121
|
+
|
115
122
|
# @!attribute hierarchy_configuration
|
116
123
|
# Either a **parent** configuration with a list of children or a **child**
|
117
124
|
# configuration with a single parent.
|
@@ -234,7 +241,7 @@ module MetronomeSDK
|
|
234
241
|
# @return [String, nil]
|
235
242
|
optional :uniqueness_key, String
|
236
243
|
|
237
|
-
# @!method initialize(id:, commits:, created_at:, created_by:, customer_id:, overrides:, scheduled_charges:, starting_at:, transitions:, usage_filter:, usage_statement_schedule:, archived_at: nil, credits: nil, custom_fields: nil, customer_billing_provider_configuration: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, uniqueness_key: nil)
|
244
|
+
# @!method initialize(id:, commits:, created_at:, created_by:, customer_id:, overrides:, scheduled_charges:, starting_at:, transitions:, usage_filter:, usage_statement_schedule:, archived_at: nil, credits: nil, custom_fields: nil, customer_billing_provider_configuration: nil, discounts: nil, ending_before: nil, has_more: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, uniqueness_key: nil)
|
238
245
|
# Some parameter documentations has been truncated, see
|
239
246
|
# {MetronomeSDK::Models::V2::ContractRetrieveResponse::Data} for more details.
|
240
247
|
#
|
@@ -272,6 +279,8 @@ module MetronomeSDK
|
|
272
279
|
#
|
273
280
|
# @param ending_before [Time]
|
274
281
|
#
|
282
|
+
# @param has_more [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::HasMore] Indicates whether there are more items than the limit for this endpoint. Use the
|
283
|
+
#
|
275
284
|
# @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::HierarchyConfiguration::ChildHierarchyConfiguration] Either a **parent** configuration with a list of children or a **child** configu
|
276
285
|
#
|
277
286
|
# @param multiplier_override_prioritization [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
|
@@ -403,7 +412,7 @@ module MetronomeSDK
|
|
403
412
|
# A list of ordered events that impact the balance of a commit. For example, an
|
404
413
|
# invoice deduction or a rollover.
|
405
414
|
#
|
406
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
|
415
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
|
407
416
|
optional :ledger,
|
408
417
|
-> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger] }
|
409
418
|
|
@@ -492,7 +501,7 @@ module MetronomeSDK
|
|
492
501
|
#
|
493
502
|
# @param invoice_schedule [MetronomeSDK::Models::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
|
494
503
|
#
|
495
|
-
# @param ledger [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
|
504
|
+
# @param ledger [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
|
496
505
|
#
|
497
506
|
# @param name [String]
|
498
507
|
#
|
@@ -674,6 +683,8 @@ module MetronomeSDK
|
|
674
683
|
|
675
684
|
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry }
|
676
685
|
|
686
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry }
|
687
|
+
|
677
688
|
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry }
|
678
689
|
|
679
690
|
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry }
|
@@ -946,6 +957,45 @@ module MetronomeSDK
|
|
946
957
|
end
|
947
958
|
end
|
948
959
|
|
960
|
+
class PrepaidCommitSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
961
|
+
# @!attribute amount
|
962
|
+
#
|
963
|
+
# @return [Float]
|
964
|
+
required :amount, Float
|
965
|
+
|
966
|
+
# @!attribute segment_id
|
967
|
+
#
|
968
|
+
# @return [String]
|
969
|
+
required :segment_id, String
|
970
|
+
|
971
|
+
# @!attribute timestamp
|
972
|
+
#
|
973
|
+
# @return [Time]
|
974
|
+
required :timestamp, Time
|
975
|
+
|
976
|
+
# @!attribute type
|
977
|
+
#
|
978
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type]
|
979
|
+
required :type,
|
980
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type }
|
981
|
+
|
982
|
+
# @!method initialize(amount:, segment_id:, timestamp:, type:)
|
983
|
+
# @param amount [Float]
|
984
|
+
# @param segment_id [String]
|
985
|
+
# @param timestamp [Time]
|
986
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type]
|
987
|
+
|
988
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry#type
|
989
|
+
module Type
|
990
|
+
extend MetronomeSDK::Internal::Type::Enum
|
991
|
+
|
992
|
+
PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT = :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT
|
993
|
+
|
994
|
+
# @!method self.values
|
995
|
+
# @return [Array<Symbol>]
|
996
|
+
end
|
997
|
+
end
|
998
|
+
|
949
999
|
class PostpaidCommitInitialBalanceLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
950
1000
|
# @!attribute amount
|
951
1001
|
#
|
@@ -1220,7 +1270,7 @@ module MetronomeSDK
|
|
1220
1270
|
end
|
1221
1271
|
|
1222
1272
|
# @!method self.variants
|
1223
|
-
# @return [Array(MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
|
1273
|
+
# @return [Array(MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
|
1224
1274
|
end
|
1225
1275
|
|
1226
1276
|
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Commit#rate_type
|
@@ -1765,7 +1815,7 @@ module MetronomeSDK
|
|
1765
1815
|
# A list of ordered events that impact the balance of a credit. For example, an
|
1766
1816
|
# invoice deduction or an expiration.
|
1767
1817
|
#
|
1768
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry>, nil]
|
1818
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>, nil]
|
1769
1819
|
optional :ledger,
|
1770
1820
|
-> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger] }
|
1771
1821
|
|
@@ -1831,7 +1881,7 @@ module MetronomeSDK
|
|
1831
1881
|
#
|
1832
1882
|
# @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::HierarchyConfiguration] Optional configuration for credit hierarchy access control
|
1833
1883
|
#
|
1834
|
-
# @param ledger [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
|
1884
|
+
# @param ledger [Array<MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
|
1835
1885
|
#
|
1836
1886
|
# @param name [String]
|
1837
1887
|
#
|
@@ -1993,6 +2043,8 @@ module MetronomeSDK
|
|
1993
2043
|
|
1994
2044
|
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry }
|
1995
2045
|
|
2046
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry }
|
2047
|
+
|
1996
2048
|
class CreditSegmentStartLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
1997
2049
|
# @!attribute amount
|
1998
2050
|
#
|
@@ -2245,8 +2297,47 @@ module MetronomeSDK
|
|
2245
2297
|
end
|
2246
2298
|
end
|
2247
2299
|
|
2300
|
+
class CreditSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
2301
|
+
# @!attribute amount
|
2302
|
+
#
|
2303
|
+
# @return [Float]
|
2304
|
+
required :amount, Float
|
2305
|
+
|
2306
|
+
# @!attribute segment_id
|
2307
|
+
#
|
2308
|
+
# @return [String]
|
2309
|
+
required :segment_id, String
|
2310
|
+
|
2311
|
+
# @!attribute timestamp
|
2312
|
+
#
|
2313
|
+
# @return [Time]
|
2314
|
+
required :timestamp, Time
|
2315
|
+
|
2316
|
+
# @!attribute type
|
2317
|
+
#
|
2318
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type]
|
2319
|
+
required :type,
|
2320
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type }
|
2321
|
+
|
2322
|
+
# @!method initialize(amount:, segment_id:, timestamp:, type:)
|
2323
|
+
# @param amount [Float]
|
2324
|
+
# @param segment_id [String]
|
2325
|
+
# @param timestamp [Time]
|
2326
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type]
|
2327
|
+
|
2328
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry#type
|
2329
|
+
module Type
|
2330
|
+
extend MetronomeSDK::Internal::Type::Enum
|
2331
|
+
|
2332
|
+
CREDIT_SEAT_BASED_ADJUSTMENT = :CREDIT_SEAT_BASED_ADJUSTMENT
|
2333
|
+
|
2334
|
+
# @!method self.values
|
2335
|
+
# @return [Array<Symbol>]
|
2336
|
+
end
|
2337
|
+
end
|
2338
|
+
|
2248
2339
|
# @!method self.variants
|
2249
|
-
# @return [Array(MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry)]
|
2340
|
+
# @return [Array(MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry)]
|
2250
2341
|
end
|
2251
2342
|
|
2252
2343
|
class Specifier < MetronomeSDK::Internal::Type::BaseModel
|
@@ -2339,6 +2430,37 @@ module MetronomeSDK
|
|
2339
2430
|
end
|
2340
2431
|
end
|
2341
2432
|
|
2433
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data#has_more
|
2434
|
+
class HasMore < MetronomeSDK::Internal::Type::BaseModel
|
2435
|
+
# @!attribute commits
|
2436
|
+
# Whether there are more commits on this contract than the limit for this
|
2437
|
+
# endpoint. Use the /contracts/customerCommits/list endpoint to get the full list
|
2438
|
+
# of commits.
|
2439
|
+
#
|
2440
|
+
# @return [Boolean]
|
2441
|
+
required :commits, MetronomeSDK::Internal::Type::Boolean
|
2442
|
+
|
2443
|
+
# @!attribute credits
|
2444
|
+
# Whether there are more credits on this contract than the limit for this
|
2445
|
+
# endpoint. Use the /contracts/customerCredits/list endpoint to get the full list
|
2446
|
+
# of credits.
|
2447
|
+
#
|
2448
|
+
# @return [Boolean]
|
2449
|
+
required :credits, MetronomeSDK::Internal::Type::Boolean
|
2450
|
+
|
2451
|
+
# @!method initialize(commits:, credits:)
|
2452
|
+
# Some parameter documentations has been truncated, see
|
2453
|
+
# {MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::HasMore} for more
|
2454
|
+
# details.
|
2455
|
+
#
|
2456
|
+
# Indicates whether there are more items than the limit for this endpoint. Use the
|
2457
|
+
# respective list endpoints to get the full lists.
|
2458
|
+
#
|
2459
|
+
# @param commits [Boolean] Whether there are more commits on this contract than the limit for this endpoint
|
2460
|
+
#
|
2461
|
+
# @param credits [Boolean] Whether there are more credits on this contract than the limit for this endpoint
|
2462
|
+
end
|
2463
|
+
|
2342
2464
|
# Either a **parent** configuration with a list of children or a **child**
|
2343
2465
|
# configuration with a single parent.
|
2344
2466
|
#
|
@@ -2827,6 +2949,13 @@ module MetronomeSDK
|
|
2827
2949
|
# @return [Time, nil]
|
2828
2950
|
optional :ending_before, Time
|
2829
2951
|
|
2952
|
+
# @!attribute hierarchy_configuration
|
2953
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
2954
|
+
#
|
2955
|
+
# @return [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration, nil]
|
2956
|
+
optional :hierarchy_configuration,
|
2957
|
+
-> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration }
|
2958
|
+
|
2830
2959
|
# @!attribute invoice_amount
|
2831
2960
|
# The amount the customer should be billed for the commit. Not required.
|
2832
2961
|
#
|
@@ -2849,7 +2978,6 @@ module MetronomeSDK
|
|
2849
2978
|
# @!attribute proration
|
2850
2979
|
# Determines whether the first and last commit will be prorated. If not provided,
|
2851
2980
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
2852
|
-
# subscription_config:
|
2853
2981
|
#
|
2854
2982
|
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::Proration, nil]
|
2855
2983
|
optional :proration,
|
@@ -2883,7 +3011,7 @@ module MetronomeSDK
|
|
2883
3011
|
optional :specifiers,
|
2884
3012
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::Specifier] }
|
2885
3013
|
|
2886
|
-
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
3014
|
+
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
2887
3015
|
# Some parameter documentations has been truncated, see
|
2888
3016
|
# {MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit} for
|
2889
3017
|
# more details.
|
@@ -2912,6 +3040,8 @@ module MetronomeSDK
|
|
2912
3040
|
#
|
2913
3041
|
# @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
|
2914
3042
|
#
|
3043
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
|
3044
|
+
#
|
2915
3045
|
# @param invoice_amount [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
|
2916
3046
|
#
|
2917
3047
|
# @param name [String] Displayed on invoices. Will be passed through to the individual commits
|
@@ -3022,6 +3152,103 @@ module MetronomeSDK
|
|
3022
3152
|
# @param id [String]
|
3023
3153
|
end
|
3024
3154
|
|
3155
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit#hierarchy_configuration
|
3156
|
+
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
3157
|
+
# @!attribute child_access
|
3158
|
+
#
|
3159
|
+
# @return [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
3160
|
+
required :child_access,
|
3161
|
+
union: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess }
|
3162
|
+
|
3163
|
+
# @!method initialize(child_access:)
|
3164
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
3165
|
+
#
|
3166
|
+
# @param child_access [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
3167
|
+
|
3168
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration#child_access
|
3169
|
+
module ChildAccess
|
3170
|
+
extend MetronomeSDK::Internal::Type::Union
|
3171
|
+
|
3172
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll }
|
3173
|
+
|
3174
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone }
|
3175
|
+
|
3176
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs }
|
3177
|
+
|
3178
|
+
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
3179
|
+
# @!attribute type
|
3180
|
+
#
|
3181
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
3182
|
+
required :type,
|
3183
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type }
|
3184
|
+
|
3185
|
+
# @!method initialize(type:)
|
3186
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
3187
|
+
|
3188
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
3189
|
+
module Type
|
3190
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3191
|
+
|
3192
|
+
ALL = :ALL
|
3193
|
+
|
3194
|
+
# @!method self.values
|
3195
|
+
# @return [Array<Symbol>]
|
3196
|
+
end
|
3197
|
+
end
|
3198
|
+
|
3199
|
+
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
3200
|
+
# @!attribute type
|
3201
|
+
#
|
3202
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
3203
|
+
required :type,
|
3204
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type }
|
3205
|
+
|
3206
|
+
# @!method initialize(type:)
|
3207
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
3208
|
+
|
3209
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
3210
|
+
module Type
|
3211
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3212
|
+
|
3213
|
+
NONE = :NONE
|
3214
|
+
|
3215
|
+
# @!method self.values
|
3216
|
+
# @return [Array<Symbol>]
|
3217
|
+
end
|
3218
|
+
end
|
3219
|
+
|
3220
|
+
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
3221
|
+
# @!attribute contract_ids
|
3222
|
+
#
|
3223
|
+
# @return [Array<String>]
|
3224
|
+
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
3225
|
+
|
3226
|
+
# @!attribute type
|
3227
|
+
#
|
3228
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
3229
|
+
required :type,
|
3230
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type }
|
3231
|
+
|
3232
|
+
# @!method initialize(contract_ids:, type:)
|
3233
|
+
# @param contract_ids [Array<String>]
|
3234
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
3235
|
+
|
3236
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
3237
|
+
module Type
|
3238
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3239
|
+
|
3240
|
+
CONTRACT_IDS = :CONTRACT_IDS
|
3241
|
+
|
3242
|
+
# @!method self.values
|
3243
|
+
# @return [Array<Symbol>]
|
3244
|
+
end
|
3245
|
+
end
|
3246
|
+
|
3247
|
+
# @!method self.variants
|
3248
|
+
# @return [Array(MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
3249
|
+
end
|
3250
|
+
end
|
3251
|
+
|
3025
3252
|
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit#invoice_amount
|
3026
3253
|
class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
|
3027
3254
|
# @!attribute credit_type_id
|
@@ -3049,7 +3276,6 @@ module MetronomeSDK
|
|
3049
3276
|
|
3050
3277
|
# Determines whether the first and last commit will be prorated. If not provided,
|
3051
3278
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
3052
|
-
# subscription_config:
|
3053
3279
|
#
|
3054
3280
|
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCommit#proration
|
3055
3281
|
module Proration
|
@@ -3197,6 +3423,13 @@ module MetronomeSDK
|
|
3197
3423
|
# @return [Time, nil]
|
3198
3424
|
optional :ending_before, Time
|
3199
3425
|
|
3426
|
+
# @!attribute hierarchy_configuration
|
3427
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
3428
|
+
#
|
3429
|
+
# @return [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration, nil]
|
3430
|
+
optional :hierarchy_configuration,
|
3431
|
+
-> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration }
|
3432
|
+
|
3200
3433
|
# @!attribute name
|
3201
3434
|
# Displayed on invoices. Will be passed through to the individual commits
|
3202
3435
|
#
|
@@ -3212,7 +3445,6 @@ module MetronomeSDK
|
|
3212
3445
|
# @!attribute proration
|
3213
3446
|
# Determines whether the first and last commit will be prorated. If not provided,
|
3214
3447
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
3215
|
-
# subscription_config:
|
3216
3448
|
#
|
3217
3449
|
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::Proration, nil]
|
3218
3450
|
optional :proration,
|
@@ -3246,7 +3478,7 @@ module MetronomeSDK
|
|
3246
3478
|
optional :specifiers,
|
3247
3479
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::Specifier] }
|
3248
3480
|
|
3249
|
-
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
3481
|
+
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
3250
3482
|
# Some parameter documentations has been truncated, see
|
3251
3483
|
# {MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit} for
|
3252
3484
|
# more details.
|
@@ -3275,6 +3507,8 @@ module MetronomeSDK
|
|
3275
3507
|
#
|
3276
3508
|
# @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
|
3277
3509
|
#
|
3510
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
|
3511
|
+
#
|
3278
3512
|
# @param name [String] Displayed on invoices. Will be passed through to the individual commits
|
3279
3513
|
#
|
3280
3514
|
# @param netsuite_sales_order_id [String] Will be passed down to the individual commits
|
@@ -3383,9 +3617,105 @@ module MetronomeSDK
|
|
3383
3617
|
# @param id [String]
|
3384
3618
|
end
|
3385
3619
|
|
3620
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit#hierarchy_configuration
|
3621
|
+
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
3622
|
+
# @!attribute child_access
|
3623
|
+
#
|
3624
|
+
# @return [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
3625
|
+
required :child_access,
|
3626
|
+
union: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess }
|
3627
|
+
|
3628
|
+
# @!method initialize(child_access:)
|
3629
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
3630
|
+
#
|
3631
|
+
# @param child_access [MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
3632
|
+
|
3633
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration#child_access
|
3634
|
+
module ChildAccess
|
3635
|
+
extend MetronomeSDK::Internal::Type::Union
|
3636
|
+
|
3637
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll }
|
3638
|
+
|
3639
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone }
|
3640
|
+
|
3641
|
+
variant -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs }
|
3642
|
+
|
3643
|
+
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
3644
|
+
# @!attribute type
|
3645
|
+
#
|
3646
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
3647
|
+
required :type,
|
3648
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type }
|
3649
|
+
|
3650
|
+
# @!method initialize(type:)
|
3651
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
3652
|
+
|
3653
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
3654
|
+
module Type
|
3655
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3656
|
+
|
3657
|
+
ALL = :ALL
|
3658
|
+
|
3659
|
+
# @!method self.values
|
3660
|
+
# @return [Array<Symbol>]
|
3661
|
+
end
|
3662
|
+
end
|
3663
|
+
|
3664
|
+
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
3665
|
+
# @!attribute type
|
3666
|
+
#
|
3667
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
3668
|
+
required :type,
|
3669
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type }
|
3670
|
+
|
3671
|
+
# @!method initialize(type:)
|
3672
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
3673
|
+
|
3674
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
3675
|
+
module Type
|
3676
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3677
|
+
|
3678
|
+
NONE = :NONE
|
3679
|
+
|
3680
|
+
# @!method self.values
|
3681
|
+
# @return [Array<Symbol>]
|
3682
|
+
end
|
3683
|
+
end
|
3684
|
+
|
3685
|
+
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
3686
|
+
# @!attribute contract_ids
|
3687
|
+
#
|
3688
|
+
# @return [Array<String>]
|
3689
|
+
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
3690
|
+
|
3691
|
+
# @!attribute type
|
3692
|
+
#
|
3693
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
3694
|
+
required :type,
|
3695
|
+
enum: -> { MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type }
|
3696
|
+
|
3697
|
+
# @!method initialize(contract_ids:, type:)
|
3698
|
+
# @param contract_ids [Array<String>]
|
3699
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
3700
|
+
|
3701
|
+
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
3702
|
+
module Type
|
3703
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3704
|
+
|
3705
|
+
CONTRACT_IDS = :CONTRACT_IDS
|
3706
|
+
|
3707
|
+
# @!method self.values
|
3708
|
+
# @return [Array<Symbol>]
|
3709
|
+
end
|
3710
|
+
end
|
3711
|
+
|
3712
|
+
# @!method self.variants
|
3713
|
+
# @return [Array(MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
3714
|
+
end
|
3715
|
+
end
|
3716
|
+
|
3386
3717
|
# Determines whether the first and last commit will be prorated. If not provided,
|
3387
3718
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
3388
|
-
# subscription_config:
|
3389
3719
|
#
|
3390
3720
|
# @see MetronomeSDK::Models::V2::ContractRetrieveResponse::Data::RecurringCredit#proration
|
3391
3721
|
module Proration
|
@@ -314,7 +314,7 @@ module MetronomeSDK
|
|
314
314
|
#
|
315
315
|
# List balances (commits and credits).
|
316
316
|
#
|
317
|
-
# @overload list_balances(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
|
317
|
+
# @overload list_balances(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
|
318
318
|
#
|
319
319
|
# @param customer_id [String]
|
320
320
|
#
|
@@ -332,6 +332,8 @@ module MetronomeSDK
|
|
332
332
|
#
|
333
333
|
# @param include_ledgers [Boolean] Include ledgers in the response. Setting this flag may cause the query to be slo
|
334
334
|
#
|
335
|
+
# @param limit [Integer] The maximum number of commits to return. Defaults to 25.
|
336
|
+
#
|
335
337
|
# @param next_page [String] The next page token from a previous response.
|
336
338
|
#
|
337
339
|
# @param starting_at [Time] Include only balances that have any access on or after the provided date
|
@@ -69,7 +69,7 @@ module MetronomeSDK
|
|
69
69
|
#
|
70
70
|
# List commits.
|
71
71
|
#
|
72
|
-
# @overload list(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
|
72
|
+
# @overload list(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
|
73
73
|
#
|
74
74
|
# @param customer_id [String]
|
75
75
|
#
|
@@ -87,6 +87,8 @@ module MetronomeSDK
|
|
87
87
|
#
|
88
88
|
# @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
|
89
89
|
#
|
90
|
+
# @param limit [Integer] The maximum number of commits to return. Defaults to 25.
|
91
|
+
#
|
90
92
|
# @param next_page [String] The next page token from a previous response.
|
91
93
|
#
|
92
94
|
# @param starting_at [Time] Include only commits that have any access on or after the provided date
|
@@ -63,7 +63,7 @@ module MetronomeSDK
|
|
63
63
|
#
|
64
64
|
# List credits.
|
65
65
|
#
|
66
|
-
# @overload list(customer_id:, covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
|
66
|
+
# @overload list(customer_id:, covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
|
67
67
|
#
|
68
68
|
# @param customer_id [String]
|
69
69
|
#
|
@@ -81,6 +81,8 @@ module MetronomeSDK
|
|
81
81
|
#
|
82
82
|
# @param include_ledgers [Boolean] Include credit ledgers in the response. Setting this flag may cause the query to
|
83
83
|
#
|
84
|
+
# @param limit [Integer] The maximum number of commits to return. Defaults to 25.
|
85
|
+
#
|
84
86
|
# @param next_page [String] The next page token from a previous response.
|
85
87
|
#
|
86
88
|
# @param starting_at [Time] Include only credits that have any access on or after the provided date
|