metronome-sdk 3.5.0 → 3.7.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 +53 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/client.rb +15 -1
- data/lib/metronome_sdk/internal/transport/base_client.rb +2 -0
- data/lib/metronome_sdk/internal/type/enum.rb +0 -25
- data/lib/metronome_sdk/models/commit.rb +27 -1
- data/lib/metronome_sdk/models/contract.rb +140 -1
- data/lib/metronome_sdk/models/contract_v2.rb +530 -6
- data/lib/metronome_sdk/models/contract_without_amendments.rb +142 -1
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +105 -2
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +103 -2
- data/lib/metronome_sdk/models/spend_threshold_configuration.rb +33 -1
- data/lib/metronome_sdk/models/spend_threshold_configuration_v2.rb +33 -1
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +1 -0
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +29 -177
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +147 -180
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +1134 -3
- data/lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb +119 -0
- data/lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb +315 -0
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +31 -1
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +31 -1
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +1 -0
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +8 -1
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +29 -1
- data/lib/metronome_sdk/models/v1/package_create_params.rb +115 -18
- data/lib/metronome_sdk/models/v1/package_list_response.rb +110 -1
- data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +114 -1
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +303 -5
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3862 -3
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +507 -6
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +6 -2
- data/lib/metronome_sdk/resources/v1/contracts.rb +72 -3
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +5 -1
- data/lib/metronome_sdk/resources/v1/packages.rb +6 -7
- data/lib/metronome_sdk/resources/v1.rb +0 -4
- data/lib/metronome_sdk/resources/v2/contracts.rb +5 -1
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +2 -8
- data/rbi/metronome_sdk/models/commit.rbi +48 -0
- data/rbi/metronome_sdk/models/contract.rbi +354 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +1172 -4
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +368 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +289 -6
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +283 -6
- data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi +78 -3
- data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi +78 -3
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +54 -396
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +370 -398
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +2448 -4
- data/rbi/metronome_sdk/models/v1/contract_list_seat_balances_params.rbi +179 -0
- data/rbi/metronome_sdk/models/v1/contract_list_seat_balances_response.rbi +714 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +9 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +75 -0
- data/rbi/metronome_sdk/models/v1/package_create_params.rbi +310 -56
- data/rbi/metronome_sdk/models/v1/package_list_response.rbi +307 -0
- data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +307 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +734 -11
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +8612 -4
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1355 -219
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +18 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +88 -3
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +7 -0
- data/rbi/metronome_sdk/resources/v1/packages.rbi +8 -7
- data/rbi/metronome_sdk/resources/v1.rbi +0 -3
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +10 -0
- data/sig/metronome_sdk/models/commit.rbs +19 -0
- data/sig/metronome_sdk/models/contract.rbs +151 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +494 -6
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +151 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +116 -6
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +116 -6
- data/sig/metronome_sdk/models/spend_threshold_configuration.rbs +31 -3
- data/sig/metronome_sdk/models/spend_threshold_configuration_v2.rbs +31 -3
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +3 -1
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +19 -137
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +134 -137
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +1045 -4
- data/sig/metronome_sdk/models/v1/contract_list_seat_balances_params.rbs +96 -0
- data/sig/metronome_sdk/models/v1/contract_list_seat_balances_response.rbs +299 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +3 -1
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +29 -1
- data/sig/metronome_sdk/models/v1/package_create_params.rbs +115 -20
- data/sig/metronome_sdk/models/v1/package_list_response.rbs +115 -0
- data/sig/metronome_sdk/models/v1/package_retrieve_response.rbs +115 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +283 -9
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +3792 -4
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +461 -15
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +2 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +16 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +2 -0
- data/sig/metronome_sdk/resources/v1/packages.rbs +1 -1
- data/sig/metronome_sdk/resources/v1.rbs +0 -2
- data/sig/metronome_sdk/resources/v2/contracts.rbs +2 -0
- metadata +8 -26
- data/lib/metronome_sdk/models/v1/payment.rb +0 -196
- data/lib/metronome_sdk/models/v1/payment_attempt_params.rb +0 -28
- data/lib/metronome_sdk/models/v1/payment_attempt_response.rb +0 -18
- data/lib/metronome_sdk/models/v1/payment_cancel_params.rb +0 -28
- data/lib/metronome_sdk/models/v1/payment_cancel_response.rb +0 -18
- data/lib/metronome_sdk/models/v1/payment_list_params.rb +0 -53
- data/lib/metronome_sdk/models/v1/payment_status.rb +0 -19
- data/lib/metronome_sdk/resources/v1/payments.rb +0 -102
- data/rbi/metronome_sdk/models/v1/payment.rbi +0 -403
- data/rbi/metronome_sdk/models/v1/payment_attempt_params.rbi +0 -48
- data/rbi/metronome_sdk/models/v1/payment_attempt_response.rbi +0 -35
- data/rbi/metronome_sdk/models/v1/payment_cancel_params.rbi +0 -48
- data/rbi/metronome_sdk/models/v1/payment_cancel_response.rbi +0 -35
- data/rbi/metronome_sdk/models/v1/payment_list_params.rbi +0 -91
- data/rbi/metronome_sdk/models/v1/payment_status.rbi +0 -33
- data/rbi/metronome_sdk/resources/v1/payments.rbi +0 -72
- data/sig/metronome_sdk/models/v1/payment.rbs +0 -243
- data/sig/metronome_sdk/models/v1/payment_attempt_params.rbs +0 -30
- data/sig/metronome_sdk/models/v1/payment_attempt_response.rbs +0 -15
- data/sig/metronome_sdk/models/v1/payment_cancel_params.rbs +0 -30
- data/sig/metronome_sdk/models/v1/payment_cancel_response.rbs +0 -15
- data/sig/metronome_sdk/models/v1/payment_list_params.rbs +0 -56
- data/sig/metronome_sdk/models/v1/payment_status.rbs +0 -19
- data/sig/metronome_sdk/resources/v1/payments.rbs +0 -30
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see MetronomeSDK::Resources::V1::Contracts#list_seat_balances
|
|
7
|
+
class ContractListSeatBalancesParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute contract_id
|
|
12
|
+
# The contract ID to retrieve seat balances for
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :contract_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute customer_id
|
|
18
|
+
# The customer ID to retrieve seat balances for
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :customer_id, String
|
|
22
|
+
|
|
23
|
+
# @!attribute covering_date
|
|
24
|
+
# Include only commits or credits with access that cover this specific date
|
|
25
|
+
# (cannot be used with starting_at or ending_before).
|
|
26
|
+
#
|
|
27
|
+
# @return [Time, nil]
|
|
28
|
+
optional :covering_date, Time
|
|
29
|
+
|
|
30
|
+
# @!attribute cursor
|
|
31
|
+
# Page token from a previous response to retrieve the next page
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :cursor, String
|
|
35
|
+
|
|
36
|
+
# @!attribute effective_before
|
|
37
|
+
# Include only commits or credits with access effective on or before this date
|
|
38
|
+
# (cannot be used with covering_date).
|
|
39
|
+
#
|
|
40
|
+
# @return [Time, nil]
|
|
41
|
+
optional :effective_before, Time
|
|
42
|
+
|
|
43
|
+
# @!attribute include_credits_and_commits
|
|
44
|
+
# Include credits and commits in the response
|
|
45
|
+
#
|
|
46
|
+
# @return [Boolean, nil]
|
|
47
|
+
optional :include_credits_and_commits, MetronomeSDK::Internal::Type::Boolean
|
|
48
|
+
|
|
49
|
+
# @!attribute include_ledgers
|
|
50
|
+
# Include ledger entries for each commit and commit. `include_credits_and_commits`
|
|
51
|
+
# must be set to `true` for `include_ledgers=true` to apply.
|
|
52
|
+
#
|
|
53
|
+
# @return [Boolean, nil]
|
|
54
|
+
optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
|
|
55
|
+
|
|
56
|
+
# @!attribute limit
|
|
57
|
+
# Maximum number of seats to return. Range: 1-100. Default: 25. When
|
|
58
|
+
# `include_credits_and_commits = true`, if the total commits/credits across all
|
|
59
|
+
# seats exceeds 100, a limit of 100 applies to the total credits and commits.
|
|
60
|
+
# Seats are included greedily to maximize the number of seats returned. Example:
|
|
61
|
+
# if seat 1 has 98 commits and seat 2 has 10 commits, both seats will be returned
|
|
62
|
+
# (total: 108 commits). Each returned seat includes all of its associated credits
|
|
63
|
+
# and commits.
|
|
64
|
+
#
|
|
65
|
+
# @return [Integer, nil]
|
|
66
|
+
optional :limit, Integer
|
|
67
|
+
|
|
68
|
+
# @!attribute seat_ids
|
|
69
|
+
# Optional filter to only include specific seats.
|
|
70
|
+
#
|
|
71
|
+
# @return [Array<String>, nil]
|
|
72
|
+
optional :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
73
|
+
|
|
74
|
+
# @!attribute starting_at
|
|
75
|
+
# Include only commits or credits with access effective on or after this date
|
|
76
|
+
# (cannot be used with covering_date).
|
|
77
|
+
#
|
|
78
|
+
# @return [Time, nil]
|
|
79
|
+
optional :starting_at, Time
|
|
80
|
+
|
|
81
|
+
# @!attribute subscription_ids
|
|
82
|
+
# Optional filter to only include seats from specific subscriptions. If
|
|
83
|
+
# subscriptions ids are not mapped to SEAT_BASED subscriptions, error will be
|
|
84
|
+
# returned.
|
|
85
|
+
#
|
|
86
|
+
# @return [Array<String>, nil]
|
|
87
|
+
optional :subscription_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
88
|
+
|
|
89
|
+
# @!method initialize(contract_id:, customer_id:, covering_date: nil, cursor: nil, effective_before: nil, include_credits_and_commits: nil, include_ledgers: nil, limit: nil, seat_ids: nil, starting_at: nil, subscription_ids: nil, request_options: {})
|
|
90
|
+
# Some parameter documentations has been truncated, see
|
|
91
|
+
# {MetronomeSDK::Models::V1::ContractListSeatBalancesParams} for more details.
|
|
92
|
+
#
|
|
93
|
+
# @param contract_id [String] The contract ID to retrieve seat balances for
|
|
94
|
+
#
|
|
95
|
+
# @param customer_id [String] The customer ID to retrieve seat balances for
|
|
96
|
+
#
|
|
97
|
+
# @param covering_date [Time] Include only commits or credits with access that cover this specific date (canno
|
|
98
|
+
#
|
|
99
|
+
# @param cursor [String] Page token from a previous response to retrieve the next page
|
|
100
|
+
#
|
|
101
|
+
# @param effective_before [Time] Include only commits or credits with access effective on or before this date (ca
|
|
102
|
+
#
|
|
103
|
+
# @param include_credits_and_commits [Boolean] Include credits and commits in the response
|
|
104
|
+
#
|
|
105
|
+
# @param include_ledgers [Boolean] Include ledger entries for each commit and commit. `include_credits_and_commits`
|
|
106
|
+
#
|
|
107
|
+
# @param limit [Integer] Maximum number of seats to return. Range: 1-100. Default: 25.
|
|
108
|
+
#
|
|
109
|
+
# @param seat_ids [Array<String>] Optional filter to only include specific seats.
|
|
110
|
+
#
|
|
111
|
+
# @param starting_at [Time] Include only commits or credits with access effective on or after this date (can
|
|
112
|
+
#
|
|
113
|
+
# @param subscription_ids [Array<String>] Optional filter to only include seats from specific subscriptions. If subscripti
|
|
114
|
+
#
|
|
115
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
# @see MetronomeSDK::Resources::V1::Contracts#list_seat_balances
|
|
7
|
+
class ContractListSeatBalancesResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data>]
|
|
11
|
+
required :data,
|
|
12
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data] }
|
|
13
|
+
|
|
14
|
+
# @!attribute pagination
|
|
15
|
+
#
|
|
16
|
+
# @return [MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Pagination]
|
|
17
|
+
required :pagination, -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Pagination }
|
|
18
|
+
|
|
19
|
+
# @!method initialize(data:, pagination:)
|
|
20
|
+
# @param data [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data>]
|
|
21
|
+
# @param pagination [MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Pagination]
|
|
22
|
+
|
|
23
|
+
class Data < MetronomeSDK::Internal::Type::BaseModel
|
|
24
|
+
# @!attribute balances
|
|
25
|
+
#
|
|
26
|
+
# @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance>]
|
|
27
|
+
required :balances,
|
|
28
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance] }
|
|
29
|
+
|
|
30
|
+
# @!attribute seat_id
|
|
31
|
+
# The unique identifier for the seat
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :seat_id, String
|
|
35
|
+
|
|
36
|
+
# @!attribute commits
|
|
37
|
+
# Array of commits applicable to this seat with their balances
|
|
38
|
+
#
|
|
39
|
+
# @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit>, nil]
|
|
40
|
+
optional :commits,
|
|
41
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit] },
|
|
42
|
+
nil?: true
|
|
43
|
+
|
|
44
|
+
# @!attribute credits
|
|
45
|
+
# Array of credits applicable to this seat with their balances
|
|
46
|
+
#
|
|
47
|
+
# @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit>, nil]
|
|
48
|
+
optional :credits,
|
|
49
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit] }
|
|
50
|
+
|
|
51
|
+
# @!method initialize(balances:, seat_id:, commits: nil, credits: nil)
|
|
52
|
+
# @param balances [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance>]
|
|
53
|
+
#
|
|
54
|
+
# @param seat_id [String] The unique identifier for the seat
|
|
55
|
+
#
|
|
56
|
+
# @param commits [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit>, nil] Array of commits applicable to this seat with their balances
|
|
57
|
+
#
|
|
58
|
+
# @param credits [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit>] Array of credits applicable to this seat with their balances
|
|
59
|
+
|
|
60
|
+
class Balance < MetronomeSDK::Internal::Type::BaseModel
|
|
61
|
+
# @!attribute balance
|
|
62
|
+
# The total balance across all commits and credits for this seat, of this credit
|
|
63
|
+
# type.
|
|
64
|
+
#
|
|
65
|
+
# @return [Float]
|
|
66
|
+
required :balance, Float
|
|
67
|
+
|
|
68
|
+
# @!attribute credit_type_id
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
required :credit_type_id, String
|
|
72
|
+
|
|
73
|
+
# @!attribute starting_balance
|
|
74
|
+
# The total initial balances of all commits and credits for this seat, of this
|
|
75
|
+
# credit type.
|
|
76
|
+
#
|
|
77
|
+
# @return [Float]
|
|
78
|
+
required :starting_balance, Float
|
|
79
|
+
|
|
80
|
+
# @!method initialize(balance:, credit_type_id:, starting_balance:)
|
|
81
|
+
# Some parameter documentations has been truncated, see
|
|
82
|
+
# {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance} for
|
|
83
|
+
# more details.
|
|
84
|
+
#
|
|
85
|
+
# @param balance [Float] The total balance across all commits and credits for this seat, of this credit t
|
|
86
|
+
#
|
|
87
|
+
# @param credit_type_id [String]
|
|
88
|
+
#
|
|
89
|
+
# @param starting_balance [Float] The total initial balances of all commits and credits for this seat, of this cre
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
|
93
|
+
# @!attribute id
|
|
94
|
+
# The commit or credit ID
|
|
95
|
+
#
|
|
96
|
+
# @return [String]
|
|
97
|
+
required :id, String
|
|
98
|
+
|
|
99
|
+
# @!attribute balance
|
|
100
|
+
# The current balance for this commit for this specific seat
|
|
101
|
+
#
|
|
102
|
+
# @return [Float]
|
|
103
|
+
required :balance, Float
|
|
104
|
+
|
|
105
|
+
# @!attribute start_date
|
|
106
|
+
# The datetime when the commit becomes active
|
|
107
|
+
#
|
|
108
|
+
# @return [Time]
|
|
109
|
+
required :start_date, Time
|
|
110
|
+
|
|
111
|
+
# @!attribute end_date
|
|
112
|
+
# The datetime when the commit expires
|
|
113
|
+
#
|
|
114
|
+
# @return [Time, nil]
|
|
115
|
+
optional :end_date, Time, nil?: true
|
|
116
|
+
|
|
117
|
+
# @!attribute ledger_entries
|
|
118
|
+
# Transaction history for this commit for this seat (only included if
|
|
119
|
+
# include_ledgers=true)
|
|
120
|
+
#
|
|
121
|
+
# @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry>, nil]
|
|
122
|
+
optional :ledger_entries,
|
|
123
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry] }
|
|
124
|
+
|
|
125
|
+
# @!method initialize(id:, balance:, start_date:, end_date: nil, ledger_entries: nil)
|
|
126
|
+
# Some parameter documentations has been truncated, see
|
|
127
|
+
# {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit} for
|
|
128
|
+
# more details.
|
|
129
|
+
#
|
|
130
|
+
# @param id [String] The commit or credit ID
|
|
131
|
+
#
|
|
132
|
+
# @param balance [Float] The current balance for this commit for this specific seat
|
|
133
|
+
#
|
|
134
|
+
# @param start_date [Time] The datetime when the commit becomes active
|
|
135
|
+
#
|
|
136
|
+
# @param end_date [Time, nil] The datetime when the commit expires
|
|
137
|
+
#
|
|
138
|
+
# @param ledger_entries [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry>] Transaction history for this commit for this seat (only included if include_ledg
|
|
139
|
+
|
|
140
|
+
class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
|
141
|
+
# @!attribute amount
|
|
142
|
+
# Amount of the ledger entry
|
|
143
|
+
#
|
|
144
|
+
# @return [Float]
|
|
145
|
+
required :amount, Float
|
|
146
|
+
|
|
147
|
+
# @!attribute timestamp
|
|
148
|
+
# The datetime when the ledger is created
|
|
149
|
+
#
|
|
150
|
+
# @return [Time]
|
|
151
|
+
required :timestamp, Time
|
|
152
|
+
|
|
153
|
+
# @!attribute type
|
|
154
|
+
# Commit ledger type
|
|
155
|
+
#
|
|
156
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry::Type]
|
|
157
|
+
required :type,
|
|
158
|
+
enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry::Type }
|
|
159
|
+
|
|
160
|
+
# @!method initialize(amount:, timestamp:, type:)
|
|
161
|
+
# @param amount [Float] Amount of the ledger entry
|
|
162
|
+
#
|
|
163
|
+
# @param timestamp [Time] The datetime when the ledger is created
|
|
164
|
+
#
|
|
165
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry::Type] Commit ledger type
|
|
166
|
+
|
|
167
|
+
# Commit ledger type
|
|
168
|
+
#
|
|
169
|
+
# @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry#type
|
|
170
|
+
module Type
|
|
171
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
172
|
+
|
|
173
|
+
PREPAID_COMMIT_SEGMENT_START = :PREPAID_COMMIT_SEGMENT_START
|
|
174
|
+
PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION = :PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION
|
|
175
|
+
PREPAID_COMMIT_ROLLOVER = :PREPAID_COMMIT_ROLLOVER
|
|
176
|
+
PREPAID_COMMIT_EXPIRATION = :PREPAID_COMMIT_EXPIRATION
|
|
177
|
+
PREPAID_COMMIT_CANCELED = :PREPAID_COMMIT_CANCELED
|
|
178
|
+
PREPAID_COMMIT_CREDITED = :PREPAID_COMMIT_CREDITED
|
|
179
|
+
PREPAID_COMMIT_MANUAL = :PREPAID_COMMIT_MANUAL
|
|
180
|
+
PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT = :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT
|
|
181
|
+
|
|
182
|
+
# @!method self.values
|
|
183
|
+
# @return [Array<Symbol>]
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
class Credit < MetronomeSDK::Internal::Type::BaseModel
|
|
189
|
+
# @!attribute id
|
|
190
|
+
# The credit ID
|
|
191
|
+
#
|
|
192
|
+
# @return [String]
|
|
193
|
+
required :id, String
|
|
194
|
+
|
|
195
|
+
# @!attribute balance
|
|
196
|
+
# The current balance for this credit for this specific seat
|
|
197
|
+
#
|
|
198
|
+
# @return [Float]
|
|
199
|
+
required :balance, Float
|
|
200
|
+
|
|
201
|
+
# @!attribute start_date
|
|
202
|
+
# The datetime when the credit becomes active
|
|
203
|
+
#
|
|
204
|
+
# @return [Time]
|
|
205
|
+
required :start_date, Time
|
|
206
|
+
|
|
207
|
+
# @!attribute end_date
|
|
208
|
+
# The datetime when the credit expires
|
|
209
|
+
#
|
|
210
|
+
# @return [Time, nil]
|
|
211
|
+
optional :end_date, Time, nil?: true
|
|
212
|
+
|
|
213
|
+
# @!attribute ledger_entries
|
|
214
|
+
# Transaction history for this credit for this seat (only included if
|
|
215
|
+
# include_ledgers=true)
|
|
216
|
+
#
|
|
217
|
+
# @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry>, nil]
|
|
218
|
+
optional :ledger_entries,
|
|
219
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry] }
|
|
220
|
+
|
|
221
|
+
# @!method initialize(id:, balance:, start_date:, end_date: nil, ledger_entries: nil)
|
|
222
|
+
# Some parameter documentations has been truncated, see
|
|
223
|
+
# {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit} for
|
|
224
|
+
# more details.
|
|
225
|
+
#
|
|
226
|
+
# @param id [String] The credit ID
|
|
227
|
+
#
|
|
228
|
+
# @param balance [Float] The current balance for this credit for this specific seat
|
|
229
|
+
#
|
|
230
|
+
# @param start_date [Time] The datetime when the credit becomes active
|
|
231
|
+
#
|
|
232
|
+
# @param end_date [Time, nil] The datetime when the credit expires
|
|
233
|
+
#
|
|
234
|
+
# @param ledger_entries [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry>] Transaction history for this credit for this seat (only included if include_ledg
|
|
235
|
+
|
|
236
|
+
class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
|
237
|
+
# @!attribute amount
|
|
238
|
+
# Amount of the ledger entry
|
|
239
|
+
#
|
|
240
|
+
# @return [Float]
|
|
241
|
+
required :amount, Float
|
|
242
|
+
|
|
243
|
+
# @!attribute timestamp
|
|
244
|
+
# The datetime when the ledger is created
|
|
245
|
+
#
|
|
246
|
+
# @return [Time]
|
|
247
|
+
required :timestamp, Time
|
|
248
|
+
|
|
249
|
+
# @!attribute type
|
|
250
|
+
# Credit ledger type
|
|
251
|
+
#
|
|
252
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry::Type]
|
|
253
|
+
required :type,
|
|
254
|
+
enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry::Type }
|
|
255
|
+
|
|
256
|
+
# @!method initialize(amount:, timestamp:, type:)
|
|
257
|
+
# @param amount [Float] Amount of the ledger entry
|
|
258
|
+
#
|
|
259
|
+
# @param timestamp [Time] The datetime when the ledger is created
|
|
260
|
+
#
|
|
261
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry::Type] Credit ledger type
|
|
262
|
+
|
|
263
|
+
# Credit ledger type
|
|
264
|
+
#
|
|
265
|
+
# @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry#type
|
|
266
|
+
module Type
|
|
267
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
268
|
+
|
|
269
|
+
CREDIT_SEGMENT_START = :CREDIT_SEGMENT_START
|
|
270
|
+
CREDIT_AUTOMATED_INVOICE_DEDUCTION = :CREDIT_AUTOMATED_INVOICE_DEDUCTION
|
|
271
|
+
CREDIT_EXPIRATION = :CREDIT_EXPIRATION
|
|
272
|
+
CREDIT_CANCELED = :CREDIT_CANCELED
|
|
273
|
+
CREDIT_CREDITED = :CREDIT_CREDITED
|
|
274
|
+
CREDIT_MANUAL = :CREDIT_MANUAL
|
|
275
|
+
CREDIT_SEAT_BASED_ADJUSTMENT = :CREDIT_SEAT_BASED_ADJUSTMENT
|
|
276
|
+
CREDIT_ROLLOVER = :CREDIT_ROLLOVER
|
|
277
|
+
|
|
278
|
+
# @!method self.values
|
|
279
|
+
# @return [Array<Symbol>]
|
|
280
|
+
end
|
|
281
|
+
end
|
|
282
|
+
end
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse#pagination
|
|
286
|
+
class Pagination < MetronomeSDK::Internal::Type::BaseModel
|
|
287
|
+
# @!attribute seats_available_for_next_page
|
|
288
|
+
# Number of seats available to fetch in the next page
|
|
289
|
+
#
|
|
290
|
+
# @return [Float]
|
|
291
|
+
required :seats_available_for_next_page, Float
|
|
292
|
+
|
|
293
|
+
# @!attribute seats_included
|
|
294
|
+
# Number of seats included in this response
|
|
295
|
+
#
|
|
296
|
+
# @return [Float]
|
|
297
|
+
required :seats_included, Float
|
|
298
|
+
|
|
299
|
+
# @!attribute next_page
|
|
300
|
+
# Token to retrieve the next page of results. Null if no more pages available
|
|
301
|
+
#
|
|
302
|
+
# @return [String, nil]
|
|
303
|
+
optional :next_page, String, nil?: true
|
|
304
|
+
|
|
305
|
+
# @!method initialize(seats_available_for_next_page:, seats_included:, next_page: nil)
|
|
306
|
+
# @param seats_available_for_next_page [Float] Number of seats available to fetch in the next page
|
|
307
|
+
#
|
|
308
|
+
# @param seats_included [Float] Number of seats included in this response
|
|
309
|
+
#
|
|
310
|
+
# @param next_page [String, nil] Token to retrieve the next page of results. Null if no more pages available
|
|
311
|
+
end
|
|
312
|
+
end
|
|
313
|
+
end
|
|
314
|
+
end
|
|
315
|
+
end
|
|
@@ -108,12 +108,24 @@ module MetronomeSDK
|
|
|
108
108
|
# @return [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil]
|
|
109
109
|
optional :quantity_rounding, -> { MetronomeSDK::V1::Contracts::QuantityRounding }, nil?: true
|
|
110
110
|
|
|
111
|
+
# @!attribute sql_breakdown_granularity
|
|
112
|
+
# Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
|
|
113
|
+
# If set to 'service_period' (default), the usage will be evaluated once for all
|
|
114
|
+
# events the invoice service period and the usage will be applied at the last
|
|
115
|
+
# instant of the invoice. If set to 'hour', it will be broken down and evaluated
|
|
116
|
+
# for each hour. For most use cases, 'hour' is recommended. The setting has no
|
|
117
|
+
# effect for Streaming Billable Metrics.
|
|
118
|
+
#
|
|
119
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity, nil]
|
|
120
|
+
optional :sql_breakdown_granularity,
|
|
121
|
+
enum: -> { MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity }
|
|
122
|
+
|
|
111
123
|
# @!attribute tags
|
|
112
124
|
#
|
|
113
125
|
# @return [Array<String>, nil]
|
|
114
126
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
115
127
|
|
|
116
|
-
# @!method initialize(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, custom_fields: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, tags: nil, request_options: {})
|
|
128
|
+
# @!method initialize(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, custom_fields: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, sql_breakdown_granularity: nil, tags: nil, request_options: {})
|
|
117
129
|
# Some parameter documentations has been truncated, see
|
|
118
130
|
# {MetronomeSDK::Models::V1::Contracts::ProductCreateParams} for more details.
|
|
119
131
|
#
|
|
@@ -145,6 +157,8 @@ module MetronomeSDK
|
|
|
145
157
|
#
|
|
146
158
|
# @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
|
|
147
159
|
#
|
|
160
|
+
# @param sql_breakdown_granularity [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity] Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
|
|
161
|
+
#
|
|
148
162
|
# @param tags [Array<String>]
|
|
149
163
|
#
|
|
150
164
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -162,6 +176,22 @@ module MetronomeSDK
|
|
|
162
176
|
# @!method self.values
|
|
163
177
|
# @return [Array<Symbol>]
|
|
164
178
|
end
|
|
179
|
+
|
|
180
|
+
# Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
|
|
181
|
+
# If set to 'service_period' (default), the usage will be evaluated once for all
|
|
182
|
+
# events the invoice service period and the usage will be applied at the last
|
|
183
|
+
# instant of the invoice. If set to 'hour', it will be broken down and evaluated
|
|
184
|
+
# for each hour. For most use cases, 'hour' is recommended. The setting has no
|
|
185
|
+
# effect for Streaming Billable Metrics.
|
|
186
|
+
module SqlBreakdownGranularity
|
|
187
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
188
|
+
|
|
189
|
+
HOUR = :HOUR
|
|
190
|
+
SERVICE_PERIOD = :SERVICE_PERIOD
|
|
191
|
+
|
|
192
|
+
# @!method self.values
|
|
193
|
+
# @return [Array<Symbol>]
|
|
194
|
+
end
|
|
165
195
|
end
|
|
166
196
|
end
|
|
167
197
|
end
|
|
@@ -116,13 +116,25 @@ module MetronomeSDK
|
|
|
116
116
|
# @return [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil]
|
|
117
117
|
optional :quantity_rounding, -> { MetronomeSDK::V1::Contracts::QuantityRounding }, nil?: true
|
|
118
118
|
|
|
119
|
+
# @!attribute sql_breakdown_granularity
|
|
120
|
+
# Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
|
|
121
|
+
# If set to 'service_period' (default), the usage will be evaluated once for all
|
|
122
|
+
# events the invoice service period and the usage will be applied at the last
|
|
123
|
+
# instant of the invoice. If set to 'hour', it will be broken down and evaluated
|
|
124
|
+
# for each hour. For most use cases, 'hour' is recommended. The setting has no
|
|
125
|
+
# effect for Streaming Billable Metrics.
|
|
126
|
+
#
|
|
127
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity, nil]
|
|
128
|
+
optional :sql_breakdown_granularity,
|
|
129
|
+
enum: -> { MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity }
|
|
130
|
+
|
|
119
131
|
# @!attribute tags
|
|
120
132
|
# If not provided, defaults to product's current tags
|
|
121
133
|
#
|
|
122
134
|
# @return [Array<String>, nil]
|
|
123
135
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
124
136
|
|
|
125
|
-
# @!method initialize(product_id:, starting_at:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, tags: nil, request_options: {})
|
|
137
|
+
# @!method initialize(product_id:, starting_at:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, sql_breakdown_granularity: nil, tags: nil, request_options: {})
|
|
126
138
|
# Some parameter documentations has been truncated, see
|
|
127
139
|
# {MetronomeSDK::Models::V1::Contracts::ProductUpdateParams} for more details.
|
|
128
140
|
#
|
|
@@ -154,9 +166,27 @@ module MetronomeSDK
|
|
|
154
166
|
#
|
|
155
167
|
# @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
|
|
156
168
|
#
|
|
169
|
+
# @param sql_breakdown_granularity [Symbol, MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity] Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
|
|
170
|
+
#
|
|
157
171
|
# @param tags [Array<String>] If not provided, defaults to product's current tags
|
|
158
172
|
#
|
|
159
173
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
174
|
+
|
|
175
|
+
# Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
|
|
176
|
+
# If set to 'service_period' (default), the usage will be evaluated once for all
|
|
177
|
+
# events the invoice service period and the usage will be applied at the last
|
|
178
|
+
# instant of the invoice. If set to 'hour', it will be broken down and evaluated
|
|
179
|
+
# for each hour. For most use cases, 'hour' is recommended. The setting has no
|
|
180
|
+
# effect for Streaming Billable Metrics.
|
|
181
|
+
module SqlBreakdownGranularity
|
|
182
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
183
|
+
|
|
184
|
+
HOUR = :HOUR
|
|
185
|
+
SERVICE_PERIOD = :SERVICE_PERIOD
|
|
186
|
+
|
|
187
|
+
# @!method self.values
|
|
188
|
+
# @return [Array<Symbol>]
|
|
189
|
+
end
|
|
160
190
|
end
|
|
161
191
|
end
|
|
162
192
|
end
|
|
@@ -152,6 +152,11 @@ module MetronomeSDK
|
|
|
152
152
|
# @return [String, nil]
|
|
153
153
|
optional :plan_name, String
|
|
154
154
|
|
|
155
|
+
# @!attribute regenerated_from_invoice_id
|
|
156
|
+
#
|
|
157
|
+
# @return [String, nil]
|
|
158
|
+
optional :regenerated_from_invoice_id, String
|
|
159
|
+
|
|
155
160
|
# @!attribute reseller_royalty
|
|
156
161
|
# Only present for contract invoices with reseller royalties.
|
|
157
162
|
#
|
|
@@ -184,7 +189,7 @@ module MetronomeSDK
|
|
|
184
189
|
# @return [Float, nil]
|
|
185
190
|
optional :subtotal, Float
|
|
186
191
|
|
|
187
|
-
# @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, constituent_invoices: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, payer: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, revenue_system_invoices: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
|
|
192
|
+
# @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, constituent_invoices: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, payer: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, regenerated_from_invoice_id: nil, reseller_royalty: nil, revenue_system_invoices: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
|
|
188
193
|
# Some parameter documentations has been truncated, see
|
|
189
194
|
# {MetronomeSDK::Models::V1::Customers::Invoice} for more details.
|
|
190
195
|
#
|
|
@@ -240,6 +245,8 @@ module MetronomeSDK
|
|
|
240
245
|
#
|
|
241
246
|
# @param plan_name [String]
|
|
242
247
|
#
|
|
248
|
+
# @param regenerated_from_invoice_id [String]
|
|
249
|
+
#
|
|
243
250
|
# @param reseller_royalty [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty] Only present for contract invoices with reseller royalties.
|
|
244
251
|
#
|
|
245
252
|
# @param revenue_system_invoices [Array<MetronomeSDK::Models::V1::Customers::Invoice::RevenueSystemInvoice>, nil]
|
|
@@ -14,6 +14,12 @@ module MetronomeSDK
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :customer_id, String
|
|
16
16
|
|
|
17
|
+
# @!attribute contract_id
|
|
18
|
+
# Only return invoices for the specified contract
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :contract_id, String
|
|
22
|
+
|
|
17
23
|
# @!attribute credit_type_id
|
|
18
24
|
# Only return invoices for the specified credit type
|
|
19
25
|
#
|
|
@@ -65,12 +71,20 @@ module MetronomeSDK
|
|
|
65
71
|
# @return [String, nil]
|
|
66
72
|
optional :status, String
|
|
67
73
|
|
|
68
|
-
# @!
|
|
74
|
+
# @!attribute type
|
|
75
|
+
# Filter invoices by type. Defaults to returning all invoice types.
|
|
76
|
+
#
|
|
77
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type, nil]
|
|
78
|
+
optional :type, enum: -> { MetronomeSDK::V1::Customers::InvoiceListParams::Type }
|
|
79
|
+
|
|
80
|
+
# @!method initialize(customer_id:, contract_id: nil, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, type: nil, request_options: {})
|
|
69
81
|
# Some parameter documentations has been truncated, see
|
|
70
82
|
# {MetronomeSDK::Models::V1::Customers::InvoiceListParams} for more details.
|
|
71
83
|
#
|
|
72
84
|
# @param customer_id [String]
|
|
73
85
|
#
|
|
86
|
+
# @param contract_id [String] Only return invoices for the specified contract
|
|
87
|
+
#
|
|
74
88
|
# @param credit_type_id [String] Only return invoices for the specified credit type
|
|
75
89
|
#
|
|
76
90
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive). Invoices will only be returned for billing perio
|
|
@@ -87,6 +101,8 @@ module MetronomeSDK
|
|
|
87
101
|
#
|
|
88
102
|
# @param status [String] Invoice status, e.g. DRAFT, FINALIZED, or VOID
|
|
89
103
|
#
|
|
104
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type] Filter invoices by type. Defaults to returning all invoice types.
|
|
105
|
+
#
|
|
90
106
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
91
107
|
|
|
92
108
|
# Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to
|
|
@@ -100,6 +116,18 @@ module MetronomeSDK
|
|
|
100
116
|
# @!method self.values
|
|
101
117
|
# @return [Array<Symbol>]
|
|
102
118
|
end
|
|
119
|
+
|
|
120
|
+
# Filter invoices by type. Defaults to returning all invoice types.
|
|
121
|
+
module Type
|
|
122
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
123
|
+
|
|
124
|
+
USAGE = :USAGE
|
|
125
|
+
USAGE_CONSOLIDATED = :USAGE_CONSOLIDATED
|
|
126
|
+
SCHEDULED = :SCHEDULED
|
|
127
|
+
|
|
128
|
+
# @!method self.values
|
|
129
|
+
# @return [Array<Symbol>]
|
|
130
|
+
end
|
|
103
131
|
end
|
|
104
132
|
end
|
|
105
133
|
end
|