metronome-sdk 2.1.0 → 3.0.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 +65 -0
- data/README.md +10 -1
- data/lib/metronome_sdk/internal/transport/base_client.rb +7 -1
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +18 -12
- data/lib/metronome_sdk/internal/util.rb +7 -2
- data/lib/metronome_sdk/models/commit.rb +69 -1
- data/lib/metronome_sdk/models/contract_v2.rb +45 -2
- data/lib/metronome_sdk/models/credit.rb +69 -1
- data/lib/metronome_sdk/models/rate.rb +1 -11
- data/lib/metronome_sdk/models/subscription.rb +32 -5
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +33 -1
- data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +136 -20
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +1 -11
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +1 -11
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +1 -11
- data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +4 -0
- data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +4 -0
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +4 -0
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_response.rb +4 -0
- data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +4 -0
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +4 -0
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +94 -2
- data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_response.rb +111 -0
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +32 -1
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +15 -1
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +15 -1
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +33 -1
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +71 -3
- data/lib/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rb +8 -1
- data/lib/metronome_sdk/models/v1/payment.rb +40 -1
- data/lib/metronome_sdk/models/v1/setting_upsert_avalara_credentials_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/settings/billing_provider_create_params.rb +1 -0
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +6 -3
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +17 -1
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +17 -1
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +285 -22
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +177 -3
- data/lib/metronome_sdk/resources/v1/alerts.rb +3 -1
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +1 -3
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +1 -1
- data/lib/metronome_sdk/resources/v1/contracts.rb +6 -2
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +3 -1
- data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +8 -4
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +7 -7
- data/lib/metronome_sdk/resources/v1/customers/plans.rb +5 -5
- data/lib/metronome_sdk/resources/v1/customers.rb +12 -10
- data/lib/metronome_sdk/resources/v1/plans.rb +2 -2
- data/lib/metronome_sdk/resources/v1/settings.rb +3 -1
- data/lib/metronome_sdk/resources/v1/usage.rb +7 -7
- data/lib/metronome_sdk/resources/v2/contracts.rb +10 -2
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +3 -0
- data/manifest.yaml +2 -0
- data/rbi/metronome_sdk/internal/transport/base_client.rbi +5 -0
- data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/metronome_sdk/internal/type/base_model.rbi +8 -4
- data/rbi/metronome_sdk/models/commit.rbi +171 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +85 -6
- data/rbi/metronome_sdk/models/credit.rbi +171 -0
- data/rbi/metronome_sdk/models/rate.rbi +3 -18
- data/rbi/metronome_sdk/models/subscription.rbi +55 -9
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +69 -0
- data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +288 -24
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +3 -18
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +0 -15
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +3 -18
- data/rbi/metronome_sdk/models/v1/custom_field_add_key_params.rbi +20 -0
- data/rbi/metronome_sdk/models/v1/custom_field_delete_values_params.rbi +20 -0
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_params.rbi +20 -0
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +20 -0
- data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi +20 -0
- data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +20 -0
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +204 -0
- data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_response.rbi +281 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +67 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +18 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +18 -0
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +71 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +121 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbi +9 -0
- data/rbi/metronome_sdk/models/v1/payment.rbi +79 -0
- data/rbi/metronome_sdk/models/v1/setting_upsert_avalara_credentials_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/settings/billing_provider_create_params.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +11 -3
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +22 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +22 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +616 -27
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +367 -3
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +5 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +0 -5
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +1 -1
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +9 -0
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +5 -0
- data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi +9 -3
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +7 -7
- data/rbi/metronome_sdk/resources/v1/customers/plans.rbi +5 -5
- data/rbi/metronome_sdk/resources/v1/customers.rbi +15 -8
- data/rbi/metronome_sdk/resources/v1/plans.rbi +2 -2
- data/rbi/metronome_sdk/resources/v1/settings.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/usage.rbi +7 -7
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +12 -0
- data/sig/metronome_sdk/internal/transport/base_client.rbs +2 -0
- data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/metronome_sdk/models/commit.rbs +74 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +45 -6
- data/sig/metronome_sdk/models/credit.rbs +74 -0
- data/sig/metronome_sdk/models/rate.rbs +3 -10
- data/sig/metronome_sdk/models/subscription.rbs +22 -3
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +28 -0
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +104 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +3 -10
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +1 -8
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +3 -10
- data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +8 -0
- data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +83 -0
- data/sig/metronome_sdk/models/v1/customer_set_billing_configurations_response.rbs +119 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +26 -1
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +30 -0
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +64 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/payment.rbs +45 -0
- data/sig/metronome_sdk/models/v1/setting_upsert_avalara_credentials_params.rbs +8 -1
- data/sig/metronome_sdk/models/v1/settings/billing_provider_create_params.rbs +3 -1
- data/sig/metronome_sdk/models/v1/usage_search_response.rbs +3 -1
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +14 -0
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +14 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +232 -3
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +131 -3
- data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +0 -1
- data/sig/metronome_sdk/resources/v1/contracts.rbs +2 -0
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/billing_config.rbs +2 -0
- data/sig/metronome_sdk/resources/v1/customers.rbs +2 -1
- data/sig/metronome_sdk/resources/v1/settings.rbs +1 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +4 -0
- metadata +19 -2
|
@@ -1854,6 +1854,11 @@ module MetronomeSDK
|
|
|
1854
1854
|
# @return [Array<String>, nil]
|
|
1855
1855
|
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
1856
1856
|
|
|
1857
|
+
# @!attribute description
|
|
1858
|
+
#
|
|
1859
|
+
# @return [String, nil]
|
|
1860
|
+
optional :description, String
|
|
1861
|
+
|
|
1857
1862
|
# @!attribute hierarchy_configuration
|
|
1858
1863
|
# Optional configuration for commit hierarchy access control
|
|
1859
1864
|
#
|
|
@@ -1913,7 +1918,7 @@ module MetronomeSDK
|
|
|
1913
1918
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
|
|
1914
1919
|
nil?: true
|
|
1915
1920
|
|
|
1916
|
-
# @!method initialize(id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, product_id: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
|
|
1921
|
+
# @!method initialize(id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, product_id: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
|
|
1917
1922
|
# Some parameter documentations has been truncated, see
|
|
1918
1923
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit}
|
|
1919
1924
|
# for more details.
|
|
@@ -1926,6 +1931,8 @@ module MetronomeSDK
|
|
|
1926
1931
|
#
|
|
1927
1932
|
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
|
|
1928
1933
|
#
|
|
1934
|
+
# @param description [String]
|
|
1935
|
+
#
|
|
1929
1936
|
# @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
|
|
1930
1937
|
#
|
|
1931
1938
|
# @param invoice_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::InvoiceSchedule]
|
|
@@ -2187,6 +2194,11 @@ module MetronomeSDK
|
|
|
2187
2194
|
optional :access_schedule,
|
|
2188
2195
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::AccessSchedule }
|
|
2189
2196
|
|
|
2197
|
+
# @!attribute description
|
|
2198
|
+
#
|
|
2199
|
+
# @return [String, nil]
|
|
2200
|
+
optional :description, String
|
|
2201
|
+
|
|
2190
2202
|
# @!attribute hierarchy_configuration
|
|
2191
2203
|
# Optional configuration for credit hierarchy access control
|
|
2192
2204
|
#
|
|
@@ -2222,7 +2234,7 @@ module MetronomeSDK
|
|
|
2222
2234
|
# @return [Float, nil]
|
|
2223
2235
|
optional :rollover_fraction, Float, nil?: true
|
|
2224
2236
|
|
|
2225
|
-
# @!method initialize(id:, access_schedule: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rollover_fraction: nil)
|
|
2237
|
+
# @!method initialize(id:, access_schedule: nil, description: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rollover_fraction: nil)
|
|
2226
2238
|
# Some parameter documentations has been truncated, see
|
|
2227
2239
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit}
|
|
2228
2240
|
# for more details.
|
|
@@ -2231,6 +2243,8 @@ module MetronomeSDK
|
|
|
2231
2243
|
#
|
|
2232
2244
|
# @param access_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::AccessSchedule]
|
|
2233
2245
|
#
|
|
2246
|
+
# @param description [String]
|
|
2247
|
+
#
|
|
2234
2248
|
# @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
|
|
2235
2249
|
#
|
|
2236
2250
|
# @param name [String]
|
|
@@ -3051,10 +3065,21 @@ module MetronomeSDK
|
|
|
3051
3065
|
optional :quantity_updates,
|
|
3052
3066
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate] }
|
|
3053
3067
|
|
|
3054
|
-
# @!
|
|
3068
|
+
# @!attribute seat_updates
|
|
3069
|
+
# Manage subscription seats for subscriptions in SEAT_BASED mode.
|
|
3070
|
+
#
|
|
3071
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates, nil]
|
|
3072
|
+
optional :seat_updates,
|
|
3073
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates }
|
|
3074
|
+
|
|
3075
|
+
# @!method initialize(id:, ending_before: nil, quantity_updates: nil, seat_updates: nil)
|
|
3055
3076
|
# @param id [String]
|
|
3077
|
+
#
|
|
3056
3078
|
# @param ending_before [Time]
|
|
3079
|
+
#
|
|
3057
3080
|
# @param quantity_updates [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate>]
|
|
3081
|
+
#
|
|
3082
|
+
# @param seat_updates [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates] Manage subscription seats for subscriptions in SEAT_BASED mode.
|
|
3058
3083
|
|
|
3059
3084
|
class QuantityUpdate < MetronomeSDK::Internal::Type::BaseModel
|
|
3060
3085
|
# @!attribute starting_at
|
|
@@ -3077,6 +3102,155 @@ module MetronomeSDK
|
|
|
3077
3102
|
# @param quantity [Float]
|
|
3078
3103
|
# @param quantity_delta [Float]
|
|
3079
3104
|
end
|
|
3105
|
+
|
|
3106
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription#seat_updates
|
|
3107
|
+
class SeatUpdates < MetronomeSDK::Internal::Type::BaseModel
|
|
3108
|
+
# @!attribute add_seat_ids
|
|
3109
|
+
# Adds seat IDs to the subscription. If there are unassigned seats, the new seat
|
|
3110
|
+
# IDs will fill these unassigned seats and not increase the total subscription
|
|
3111
|
+
# quantity. Otherwise, if there are more new seat IDs than unassigned seats, the
|
|
3112
|
+
# total subscription quantity will increase.
|
|
3113
|
+
#
|
|
3114
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID>, nil]
|
|
3115
|
+
optional :add_seat_ids,
|
|
3116
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID] }
|
|
3117
|
+
|
|
3118
|
+
# @!attribute add_unassigned_seats
|
|
3119
|
+
# Adds unassigned seats to the subscription. This will increase the total
|
|
3120
|
+
# subscription quantity.
|
|
3121
|
+
#
|
|
3122
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat>, nil]
|
|
3123
|
+
optional :add_unassigned_seats,
|
|
3124
|
+
-> do
|
|
3125
|
+
MetronomeSDK::Internal::Type::ArrayOf[
|
|
3126
|
+
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat
|
|
3127
|
+
]
|
|
3128
|
+
end
|
|
3129
|
+
|
|
3130
|
+
# @!attribute remove_seat_ids
|
|
3131
|
+
# Removes seat IDs from the subscription, if possible. If a seat ID is removed,
|
|
3132
|
+
# the total subscription quantity will decrease. Otherwise, if the seat ID is not
|
|
3133
|
+
# found on the subscription, this is a no-op.
|
|
3134
|
+
#
|
|
3135
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID>, nil]
|
|
3136
|
+
optional :remove_seat_ids,
|
|
3137
|
+
-> do
|
|
3138
|
+
MetronomeSDK::Internal::Type::ArrayOf[
|
|
3139
|
+
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID
|
|
3140
|
+
]
|
|
3141
|
+
end
|
|
3142
|
+
|
|
3143
|
+
# @!attribute remove_unassigned_seats
|
|
3144
|
+
# Removes unassigned seats from the subscription. This will decrease the total
|
|
3145
|
+
# subscription quantity if there are are unassigned seats.
|
|
3146
|
+
#
|
|
3147
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat>, nil]
|
|
3148
|
+
optional :remove_unassigned_seats,
|
|
3149
|
+
-> do
|
|
3150
|
+
MetronomeSDK::Internal::Type::ArrayOf[
|
|
3151
|
+
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat
|
|
3152
|
+
]
|
|
3153
|
+
end
|
|
3154
|
+
|
|
3155
|
+
# @!method initialize(add_seat_ids: nil, add_unassigned_seats: nil, remove_seat_ids: nil, remove_unassigned_seats: nil)
|
|
3156
|
+
# Some parameter documentations has been truncated, see
|
|
3157
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates}
|
|
3158
|
+
# for more details.
|
|
3159
|
+
#
|
|
3160
|
+
# Manage subscription seats for subscriptions in SEAT_BASED mode.
|
|
3161
|
+
#
|
|
3162
|
+
# @param add_seat_ids [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddSeatID>] Adds seat IDs to the subscription. If there are unassigned seats, the new seat
|
|
3163
|
+
#
|
|
3164
|
+
# @param add_unassigned_seats [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat>] Adds unassigned seats to the subscription. This will increase the total subscrip
|
|
3165
|
+
#
|
|
3166
|
+
# @param remove_seat_ids [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveSeatID>] Removes seat IDs from the subscription, if possible. If a seat ID is removed, t
|
|
3167
|
+
#
|
|
3168
|
+
# @param remove_unassigned_seats [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat>] Removes unassigned seats from the subscription. This will decrease the total sub
|
|
3169
|
+
|
|
3170
|
+
class AddSeatID < MetronomeSDK::Internal::Type::BaseModel
|
|
3171
|
+
# @!attribute seat_ids
|
|
3172
|
+
#
|
|
3173
|
+
# @return [Array<String>]
|
|
3174
|
+
required :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
3175
|
+
|
|
3176
|
+
# @!attribute starting_at
|
|
3177
|
+
# Assigned seats will be added/removed starting at this date.
|
|
3178
|
+
#
|
|
3179
|
+
# @return [Time]
|
|
3180
|
+
required :starting_at, Time
|
|
3181
|
+
|
|
3182
|
+
# @!method initialize(seat_ids:, starting_at:)
|
|
3183
|
+
# @param seat_ids [Array<String>]
|
|
3184
|
+
#
|
|
3185
|
+
# @param starting_at [Time] Assigned seats will be added/removed starting at this date.
|
|
3186
|
+
end
|
|
3187
|
+
|
|
3188
|
+
class AddUnassignedSeat < MetronomeSDK::Internal::Type::BaseModel
|
|
3189
|
+
# @!attribute quantity
|
|
3190
|
+
# The number of unassigned seats on the subscription will increase/decrease by
|
|
3191
|
+
# this delta. Must be greater than 0.
|
|
3192
|
+
#
|
|
3193
|
+
# @return [Float]
|
|
3194
|
+
required :quantity, Float
|
|
3195
|
+
|
|
3196
|
+
# @!attribute starting_at
|
|
3197
|
+
# Unassigned seats will be updated starting at this date.
|
|
3198
|
+
#
|
|
3199
|
+
# @return [Time]
|
|
3200
|
+
required :starting_at, Time
|
|
3201
|
+
|
|
3202
|
+
# @!method initialize(quantity:, starting_at:)
|
|
3203
|
+
# Some parameter documentations has been truncated, see
|
|
3204
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::AddUnassignedSeat}
|
|
3205
|
+
# for more details.
|
|
3206
|
+
#
|
|
3207
|
+
# @param quantity [Float] The number of unassigned seats on the subscription will increase/decrease by thi
|
|
3208
|
+
#
|
|
3209
|
+
# @param starting_at [Time] Unassigned seats will be updated starting at this date.
|
|
3210
|
+
end
|
|
3211
|
+
|
|
3212
|
+
class RemoveSeatID < MetronomeSDK::Internal::Type::BaseModel
|
|
3213
|
+
# @!attribute seat_ids
|
|
3214
|
+
#
|
|
3215
|
+
# @return [Array<String>]
|
|
3216
|
+
required :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
3217
|
+
|
|
3218
|
+
# @!attribute starting_at
|
|
3219
|
+
# Assigned seats will be added/removed starting at this date.
|
|
3220
|
+
#
|
|
3221
|
+
# @return [Time]
|
|
3222
|
+
required :starting_at, Time
|
|
3223
|
+
|
|
3224
|
+
# @!method initialize(seat_ids:, starting_at:)
|
|
3225
|
+
# @param seat_ids [Array<String>]
|
|
3226
|
+
#
|
|
3227
|
+
# @param starting_at [Time] Assigned seats will be added/removed starting at this date.
|
|
3228
|
+
end
|
|
3229
|
+
|
|
3230
|
+
class RemoveUnassignedSeat < MetronomeSDK::Internal::Type::BaseModel
|
|
3231
|
+
# @!attribute quantity
|
|
3232
|
+
# The number of unassigned seats on the subscription will increase/decrease by
|
|
3233
|
+
# this delta. Must be greater than 0.
|
|
3234
|
+
#
|
|
3235
|
+
# @return [Float]
|
|
3236
|
+
required :quantity, Float
|
|
3237
|
+
|
|
3238
|
+
# @!attribute starting_at
|
|
3239
|
+
# Unassigned seats will be updated starting at this date.
|
|
3240
|
+
#
|
|
3241
|
+
# @return [Time]
|
|
3242
|
+
required :starting_at, Time
|
|
3243
|
+
|
|
3244
|
+
# @!method initialize(quantity:, starting_at:)
|
|
3245
|
+
# Some parameter documentations has been truncated, see
|
|
3246
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates::RemoveUnassignedSeat}
|
|
3247
|
+
# for more details.
|
|
3248
|
+
#
|
|
3249
|
+
# @param quantity [Float] The number of unassigned seats on the subscription will increase/decrease by thi
|
|
3250
|
+
#
|
|
3251
|
+
# @param starting_at [Time] Unassigned seats will be updated starting at this date.
|
|
3252
|
+
end
|
|
3253
|
+
end
|
|
3080
3254
|
end
|
|
3081
3255
|
end
|
|
3082
3256
|
end
|
|
@@ -53,7 +53,7 @@ module MetronomeSDK
|
|
|
53
53
|
# threshold notification evaluations in real-time as usage events stream in,
|
|
54
54
|
# unlike competitors who rely on periodic polling or batch evaluation cycles
|
|
55
55
|
#
|
|
56
|
-
# @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
|
|
56
|
+
# @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, seat_filter: nil, uniqueness_key: nil, request_options: {})
|
|
57
57
|
#
|
|
58
58
|
# @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the threshold notification
|
|
59
59
|
#
|
|
@@ -79,6 +79,8 @@ module MetronomeSDK
|
|
|
79
79
|
#
|
|
80
80
|
# @param plan_id [String] If provided, will create this threshold notification for this specific plan. To
|
|
81
81
|
#
|
|
82
|
+
# @param seat_filter [MetronomeSDK::Models::V1::AlertCreateParams::SeatFilter] Required for `low_remaining_seat_balance_reached` notifications. The alert is sc
|
|
83
|
+
#
|
|
82
84
|
# @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
|
|
83
85
|
#
|
|
84
86
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -57,7 +57,7 @@ module MetronomeSDK
|
|
|
57
57
|
#
|
|
58
58
|
# Add a new rate
|
|
59
59
|
#
|
|
60
|
-
# @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil,
|
|
60
|
+
# @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, request_options: {})
|
|
61
61
|
#
|
|
62
62
|
# @param entitled [Boolean]
|
|
63
63
|
#
|
|
@@ -89,8 +89,6 @@ module MetronomeSDK
|
|
|
89
89
|
#
|
|
90
90
|
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
|
91
91
|
#
|
|
92
|
-
# @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
|
|
93
|
-
#
|
|
94
92
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
93
|
#
|
|
96
94
|
# @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse]
|
|
@@ -196,7 +196,7 @@ module MetronomeSDK
|
|
|
196
196
|
#
|
|
197
197
|
# @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
|
|
198
198
|
#
|
|
199
|
-
# @param body [Object] Body param
|
|
199
|
+
# @param body [Object] Body param
|
|
200
200
|
#
|
|
201
201
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
202
202
|
#
|
|
@@ -140,7 +140,7 @@ module MetronomeSDK
|
|
|
140
140
|
# `usage_filters` to route the correct usage to each contract.
|
|
141
141
|
# [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).
|
|
142
142
|
#
|
|
143
|
-
# @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: 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, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
|
|
143
|
+
# @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: 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, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, revenue_system_configuration: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
|
|
144
144
|
#
|
|
145
145
|
# @param customer_id [String]
|
|
146
146
|
#
|
|
@@ -186,6 +186,8 @@ module MetronomeSDK
|
|
|
186
186
|
#
|
|
187
187
|
# @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
|
|
188
188
|
#
|
|
189
|
+
# @param revenue_system_configuration [MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration] The revenue system configuration associated with a contract. Provide either an I
|
|
190
|
+
#
|
|
189
191
|
# @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
|
|
190
192
|
#
|
|
191
193
|
# @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge>]
|
|
@@ -318,7 +320,7 @@ module MetronomeSDK
|
|
|
318
320
|
# upstream of the commit, whether that is via contract editing, rate editing, or
|
|
319
321
|
# other actions that cause an invoice to be recalculated.
|
|
320
322
|
#
|
|
321
|
-
# @overload add_manual_balance_entry(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, timestamp: nil, request_options: {})
|
|
323
|
+
# @overload add_manual_balance_entry(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, per_group_amounts: nil, timestamp: nil, request_options: {})
|
|
322
324
|
#
|
|
323
325
|
# @param id [String] ID of the balance (commit or credit) to update.
|
|
324
326
|
#
|
|
@@ -332,6 +334,8 @@ module MetronomeSDK
|
|
|
332
334
|
#
|
|
333
335
|
# @param contract_id [String] ID of the contract to update. Leave blank to update a customer level balance.
|
|
334
336
|
#
|
|
337
|
+
# @param per_group_amounts [Hash{Symbol=>Float}] If using individually configured commits/credits attached to seat managed subscr
|
|
338
|
+
#
|
|
335
339
|
# @param timestamp [Time] RFC 3339 timestamp indicating when the manual adjustment takes place. If not pro
|
|
336
340
|
#
|
|
337
341
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -64,7 +64,7 @@ module MetronomeSDK
|
|
|
64
64
|
# - Error handling: Returns 404 if either the customer or alert_id doesn't exist
|
|
65
65
|
# or isn't accessible to your organization
|
|
66
66
|
#
|
|
67
|
-
# @overload retrieve(alert_id:, customer_id:, group_values: nil, plans_or_contracts: nil, request_options: {})
|
|
67
|
+
# @overload retrieve(alert_id:, customer_id:, group_values: nil, plans_or_contracts: nil, seat_filter: nil, request_options: {})
|
|
68
68
|
#
|
|
69
69
|
# @param alert_id [String] The Metronome ID of the threshold notification
|
|
70
70
|
#
|
|
@@ -74,6 +74,8 @@ module MetronomeSDK
|
|
|
74
74
|
#
|
|
75
75
|
# @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel threshold notifications are enabled during migration, this flag de
|
|
76
76
|
#
|
|
77
|
+
# @param seat_filter [MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::SeatFilter] Only allowed for `low_remaining_seat_balance_reached` notifications. This filter
|
|
78
|
+
#
|
|
77
79
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
78
80
|
#
|
|
79
81
|
# @return [MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse]
|
|
@@ -12,17 +12,21 @@ module MetronomeSDK
|
|
|
12
12
|
# Set the billing configuration for a given customer. This is a Plans (deprecated)
|
|
13
13
|
# endpoint. New clients should implement using Contracts.
|
|
14
14
|
#
|
|
15
|
-
# @overload create(customer_id:, billing_provider_type:, billing_provider_customer_id:, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil, request_options: {})
|
|
15
|
+
# @overload create(customer_id:, billing_provider_type:, billing_provider_customer_id:, aws_customer_account_id: nil, aws_customer_id: nil, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil, request_options: {})
|
|
16
16
|
#
|
|
17
|
-
# @param customer_id [String] Path param
|
|
17
|
+
# @param customer_id [String] Path param
|
|
18
18
|
#
|
|
19
19
|
# @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::BillingProviderType] Path param: The billing provider (e.g. stripe)
|
|
20
20
|
#
|
|
21
21
|
# @param billing_provider_customer_id [String] Body param: The customer ID in the billing provider's system. For Azure, this is
|
|
22
22
|
#
|
|
23
|
-
# @param
|
|
23
|
+
# @param aws_customer_account_id [String] Body param
|
|
24
24
|
#
|
|
25
|
-
# @param
|
|
25
|
+
# @param aws_customer_id [String] Body param
|
|
26
|
+
#
|
|
27
|
+
# @param aws_product_code [String] Body param
|
|
28
|
+
#
|
|
29
|
+
# @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param
|
|
26
30
|
#
|
|
27
31
|
# @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param: The collection method for the customer's invoices.
|
|
28
32
|
#
|
|
@@ -51,9 +51,9 @@ module MetronomeSDK
|
|
|
51
51
|
#
|
|
52
52
|
# @overload retrieve(customer_id:, invoice_id:, skip_zero_qty_line_items: nil, request_options: {})
|
|
53
53
|
#
|
|
54
|
-
# @param customer_id [String] Path param
|
|
54
|
+
# @param customer_id [String] Path param
|
|
55
55
|
#
|
|
56
|
-
# @param invoice_id [String] Path param
|
|
56
|
+
# @param invoice_id [String] Path param
|
|
57
57
|
#
|
|
58
58
|
# @param skip_zero_qty_line_items [Boolean] Query param: If set, all zero quantity line items will be filtered out of the re
|
|
59
59
|
#
|
|
@@ -133,7 +133,7 @@ module MetronomeSDK
|
|
|
133
133
|
#
|
|
134
134
|
# @overload list(customer_id:, 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, request_options: {})
|
|
135
135
|
#
|
|
136
|
-
# @param customer_id [String] Path param
|
|
136
|
+
# @param customer_id [String] Path param
|
|
137
137
|
#
|
|
138
138
|
# @param credit_type_id [String] Query param: Only return invoices for the specified credit type
|
|
139
139
|
#
|
|
@@ -180,19 +180,19 @@ module MetronomeSDK
|
|
|
180
180
|
#
|
|
181
181
|
# @overload add_charge(customer_id:, charge_id:, customer_plan_id:, description:, invoice_start_timestamp:, price:, quantity:, request_options: {})
|
|
182
182
|
#
|
|
183
|
-
# @param customer_id [String] Path param
|
|
183
|
+
# @param customer_id [String] Path param
|
|
184
184
|
#
|
|
185
185
|
# @param charge_id [String] Body param: The Metronome ID of the charge to add to the invoice. Note that the
|
|
186
186
|
#
|
|
187
187
|
# @param customer_plan_id [String] Body param: The Metronome ID of the customer plan to add the charge to.
|
|
188
188
|
#
|
|
189
|
-
# @param description [String] Body param
|
|
189
|
+
# @param description [String] Body param
|
|
190
190
|
#
|
|
191
191
|
# @param invoice_start_timestamp [Time] Body param: The start_timestamp of the invoice to add the charge to.
|
|
192
192
|
#
|
|
193
193
|
# @param price [Float] Body param: The price of the charge. This price will match the currency on the i
|
|
194
194
|
#
|
|
195
|
-
# @param quantity [Float] Body param
|
|
195
|
+
# @param quantity [Float] Body param
|
|
196
196
|
#
|
|
197
197
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
198
198
|
#
|
|
@@ -259,7 +259,7 @@ module MetronomeSDK
|
|
|
259
259
|
#
|
|
260
260
|
# @overload list_breakdowns(customer_id:, ending_before:, starting_on:, credit_type_id: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, status: nil, window_size: nil, request_options: {})
|
|
261
261
|
#
|
|
262
|
-
# @param customer_id [String] Path param
|
|
262
|
+
# @param customer_id [String] Path param
|
|
263
263
|
#
|
|
264
264
|
# @param ending_before [Time] Query param: RFC 3339 timestamp. Breakdowns will only be returned for time windo
|
|
265
265
|
#
|
|
@@ -10,7 +10,7 @@ module MetronomeSDK
|
|
|
10
10
|
#
|
|
11
11
|
# @overload list(customer_id:, limit: nil, next_page: nil, request_options: {})
|
|
12
12
|
#
|
|
13
|
-
# @param customer_id [String] Path param
|
|
13
|
+
# @param customer_id [String] Path param
|
|
14
14
|
#
|
|
15
15
|
# @param limit [Integer] Query param: Max number of results that should be returned
|
|
16
16
|
#
|
|
@@ -47,9 +47,9 @@ module MetronomeSDK
|
|
|
47
47
|
#
|
|
48
48
|
# @overload add(customer_id:, plan_id:, starting_on:, ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {})
|
|
49
49
|
#
|
|
50
|
-
# @param customer_id [String] Path param
|
|
50
|
+
# @param customer_id [String] Path param
|
|
51
51
|
#
|
|
52
|
-
# @param plan_id [String] Body param
|
|
52
|
+
# @param plan_id [String] Body param
|
|
53
53
|
#
|
|
54
54
|
# @param starting_on [Time] Body param: RFC 3339 timestamp for when the plan becomes active for this custome
|
|
55
55
|
#
|
|
@@ -91,7 +91,7 @@ module MetronomeSDK
|
|
|
91
91
|
#
|
|
92
92
|
# @overload end_(customer_id:, customer_plan_id:, ending_before: nil, void_invoices: nil, void_stripe_invoices: nil, request_options: {})
|
|
93
93
|
#
|
|
94
|
-
# @param customer_id [String] Path param
|
|
94
|
+
# @param customer_id [String] Path param
|
|
95
95
|
#
|
|
96
96
|
# @param customer_plan_id [String] Path param: the ID of a customer-plan relationship
|
|
97
97
|
#
|
|
@@ -132,7 +132,7 @@ module MetronomeSDK
|
|
|
132
132
|
#
|
|
133
133
|
# @overload list_price_adjustments(customer_id:, customer_plan_id:, limit: nil, next_page: nil, request_options: {})
|
|
134
134
|
#
|
|
135
|
-
# @param customer_id [String] Path param
|
|
135
|
+
# @param customer_id [String] Path param
|
|
136
136
|
#
|
|
137
137
|
# @param customer_plan_id [String] Path param: the ID of a customer-plan relationship
|
|
138
138
|
#
|
|
@@ -63,7 +63,7 @@ module MetronomeSDK
|
|
|
63
63
|
# For details on different billing configurations for different systems, review
|
|
64
64
|
# the `/setCustomerBillingConfiguration` end-point.
|
|
65
65
|
#
|
|
66
|
-
# @overload create(name:, billing_config: nil, custom_fields: nil, customer_billing_provider_configurations: nil, external_id: nil, ingest_aliases: nil, request_options: {})
|
|
66
|
+
# @overload create(name:, billing_config: nil, custom_fields: nil, customer_billing_provider_configurations: nil, customer_revenue_system_configurations: nil, external_id: nil, ingest_aliases: nil, request_options: {})
|
|
67
67
|
#
|
|
68
68
|
# @param name [String] This will be truncated to 160 characters if the provided name is longer.
|
|
69
69
|
#
|
|
@@ -73,6 +73,8 @@ module MetronomeSDK
|
|
|
73
73
|
#
|
|
74
74
|
# @param customer_billing_provider_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>]
|
|
75
75
|
#
|
|
76
|
+
# @param customer_revenue_system_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerRevenueSystemConfiguration>]
|
|
77
|
+
#
|
|
76
78
|
# @param external_id [String] (deprecated, use ingest_aliases instead) an alias that can be used to refer to t
|
|
77
79
|
#
|
|
78
80
|
# @param ingest_aliases [Array<String>] Aliases that can be used to refer to this customer in usage events
|
|
@@ -207,7 +209,7 @@ module MetronomeSDK
|
|
|
207
209
|
#
|
|
208
210
|
# @overload list_billable_metrics(customer_id:, include_archived: nil, limit: nil, next_page: nil, on_current_plan: nil, request_options: {})
|
|
209
211
|
#
|
|
210
|
-
# @param customer_id [String] Path param
|
|
212
|
+
# @param customer_id [String] Path param
|
|
211
213
|
#
|
|
212
214
|
# @param include_archived [Boolean] Query param: If true, the list of returned metrics will include archived metrics
|
|
213
215
|
#
|
|
@@ -245,7 +247,7 @@ module MetronomeSDK
|
|
|
245
247
|
#
|
|
246
248
|
# @overload list_costs(customer_id:, ending_before:, starting_on:, limit: nil, next_page: nil, request_options: {})
|
|
247
249
|
#
|
|
248
|
-
# @param customer_id [String] Path param
|
|
250
|
+
# @param customer_id [String] Path param
|
|
249
251
|
#
|
|
250
252
|
# @param ending_before [Time] Query param: RFC 3339 timestamp (exclusive)
|
|
251
253
|
#
|
|
@@ -287,7 +289,7 @@ module MetronomeSDK
|
|
|
287
289
|
#
|
|
288
290
|
# @overload preview_events(customer_id:, events:, mode: nil, skip_zero_qty_line_items: nil, request_options: {})
|
|
289
291
|
#
|
|
290
|
-
# @param customer_id [String] Path param
|
|
292
|
+
# @param customer_id [String] Path param
|
|
291
293
|
#
|
|
292
294
|
# @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>] Body param: Array of usage events to include in the preview calculation. Must co
|
|
293
295
|
#
|
|
@@ -386,7 +388,7 @@ module MetronomeSDK
|
|
|
386
388
|
# @param data [Array<MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams::Data>]
|
|
387
389
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
388
390
|
#
|
|
389
|
-
# @return [
|
|
391
|
+
# @return [MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse]
|
|
390
392
|
#
|
|
391
393
|
# @see MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams
|
|
392
394
|
def set_billing_configurations(params)
|
|
@@ -395,7 +397,7 @@ module MetronomeSDK
|
|
|
395
397
|
method: :post,
|
|
396
398
|
path: "v1/setCustomerBillingProviderConfigurations",
|
|
397
399
|
body: parsed,
|
|
398
|
-
model:
|
|
400
|
+
model: MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsResponse,
|
|
399
401
|
options: options
|
|
400
402
|
)
|
|
401
403
|
end
|
|
@@ -416,9 +418,9 @@ module MetronomeSDK
|
|
|
416
418
|
#
|
|
417
419
|
# @overload set_ingest_aliases(customer_id:, ingest_aliases:, request_options: {})
|
|
418
420
|
#
|
|
419
|
-
# @param customer_id [String] Path param
|
|
421
|
+
# @param customer_id [String] Path param
|
|
420
422
|
#
|
|
421
|
-
# @param ingest_aliases [Array<String>] Body param
|
|
423
|
+
# @param ingest_aliases [Array<String>] Body param
|
|
422
424
|
#
|
|
423
425
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
424
426
|
#
|
|
@@ -451,7 +453,7 @@ module MetronomeSDK
|
|
|
451
453
|
#
|
|
452
454
|
# @overload set_name(customer_id:, name:, request_options: {})
|
|
453
455
|
#
|
|
454
|
-
# @param customer_id [String] Path param
|
|
456
|
+
# @param customer_id [String] Path param
|
|
455
457
|
#
|
|
456
458
|
# @param name [String] Body param: The new name for the customer. This will be truncated to 160 charact
|
|
457
459
|
#
|
|
@@ -485,7 +487,7 @@ module MetronomeSDK
|
|
|
485
487
|
#
|
|
486
488
|
# @overload update_config(customer_id:, leave_stripe_invoices_in_draft: nil, salesforce_account_id: nil, request_options: {})
|
|
487
489
|
#
|
|
488
|
-
# @param customer_id [String] Path param
|
|
490
|
+
# @param customer_id [String] Path param
|
|
489
491
|
#
|
|
490
492
|
# @param leave_stripe_invoices_in_draft [Boolean, nil] Body param: Leave in draft or set to auto-advance on invoices sent to Stripe. Fa
|
|
491
493
|
#
|
|
@@ -60,7 +60,7 @@ module MetronomeSDK
|
|
|
60
60
|
#
|
|
61
61
|
# @overload list_charges(plan_id:, limit: nil, next_page: nil, request_options: {})
|
|
62
62
|
#
|
|
63
|
-
# @param plan_id [String] Path param
|
|
63
|
+
# @param plan_id [String] Path param
|
|
64
64
|
#
|
|
65
65
|
# @param limit [Integer] Query param: Max number of results that should be returned
|
|
66
66
|
#
|
|
@@ -96,7 +96,7 @@ module MetronomeSDK
|
|
|
96
96
|
#
|
|
97
97
|
# @overload list_customers(plan_id:, limit: nil, next_page: nil, status: nil, request_options: {})
|
|
98
98
|
#
|
|
99
|
-
# @param plan_id [String] Path param
|
|
99
|
+
# @param plan_id [String] Path param
|
|
100
100
|
#
|
|
101
101
|
# @param limit [Integer] Query param: Max number of results that should be returned
|
|
102
102
|
#
|
|
@@ -16,7 +16,7 @@ module MetronomeSDK
|
|
|
16
16
|
# Avalara credentials to the appropriate billing entity. These credentials are
|
|
17
17
|
# only used for PLG Invoicing today.
|
|
18
18
|
#
|
|
19
|
-
# @overload upsert_avalara_credentials(avalara_environment:, avalara_password:, avalara_username:, delivery_method_ids:, request_options: {})
|
|
19
|
+
# @overload upsert_avalara_credentials(avalara_environment:, avalara_password:, avalara_username:, delivery_method_ids:, commit_transactions: nil, request_options: {})
|
|
20
20
|
#
|
|
21
21
|
# @param avalara_environment [Symbol, MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment] The Avalara environment to use (SANDBOX or PRODUCTION).
|
|
22
22
|
#
|
|
@@ -26,6 +26,8 @@ module MetronomeSDK
|
|
|
26
26
|
#
|
|
27
27
|
# @param delivery_method_ids [Array<String>] The delivery method IDs of the billing provider configurations to update, can be
|
|
28
28
|
#
|
|
29
|
+
# @param commit_transactions [Boolean] Commit transactions if you want Metronome tax calculations used for reporting an
|
|
30
|
+
#
|
|
29
31
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
30
32
|
#
|
|
31
33
|
# @return [MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsResponse]
|
|
@@ -43,9 +43,9 @@ module MetronomeSDK
|
|
|
43
43
|
#
|
|
44
44
|
# @overload list(ending_before:, starting_on:, window_size:, next_page: nil, billable_metrics: nil, customer_ids: nil, request_options: {})
|
|
45
45
|
#
|
|
46
|
-
# @param ending_before [Time] Body param
|
|
46
|
+
# @param ending_before [Time] Body param
|
|
47
47
|
#
|
|
48
|
-
# @param starting_on [Time] Body param
|
|
48
|
+
# @param starting_on [Time] Body param
|
|
49
49
|
#
|
|
50
50
|
# @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
|
|
51
51
|
#
|
|
@@ -220,9 +220,9 @@ module MetronomeSDK
|
|
|
220
220
|
#
|
|
221
221
|
# @overload list_with_groups(billable_metric_id:, customer_id:, window_size:, limit: nil, next_page: nil, current_period: nil, ending_before: nil, group_by: nil, starting_on: nil, request_options: {})
|
|
222
222
|
#
|
|
223
|
-
# @param billable_metric_id [String] Body param
|
|
223
|
+
# @param billable_metric_id [String] Body param
|
|
224
224
|
#
|
|
225
|
-
# @param customer_id [String] Body param
|
|
225
|
+
# @param customer_id [String] Body param
|
|
226
226
|
#
|
|
227
227
|
# @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
|
|
228
228
|
#
|
|
@@ -232,11 +232,11 @@ module MetronomeSDK
|
|
|
232
232
|
#
|
|
233
233
|
# @param current_period [Boolean] Body param: If true, will return the usage for the current billing period. Will
|
|
234
234
|
#
|
|
235
|
-
# @param ending_before [Time] Body param
|
|
235
|
+
# @param ending_before [Time] Body param
|
|
236
236
|
#
|
|
237
|
-
# @param group_by [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy] Body param
|
|
237
|
+
# @param group_by [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy] Body param
|
|
238
238
|
#
|
|
239
|
-
# @param starting_on [Time] Body param
|
|
239
|
+
# @param starting_on [Time] Body param
|
|
240
240
|
#
|
|
241
241
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
242
242
|
#
|