metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4
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 +40 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
- data/lib/metronome_sdk/internal/type/array_of.rb +6 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +82 -26
- data/lib/metronome_sdk/internal/type/boolean.rb +7 -1
- data/lib/metronome_sdk/internal/type/converter.rb +42 -34
- data/lib/metronome_sdk/internal/type/enum.rb +16 -5
- data/lib/metronome_sdk/internal/type/file_input.rb +6 -1
- data/lib/metronome_sdk/internal/type/hash_of.rb +6 -1
- data/lib/metronome_sdk/internal/type/union.rb +17 -9
- data/lib/metronome_sdk/internal/type/unknown.rb +7 -1
- data/lib/metronome_sdk/internal/util.rb +8 -9
- data/lib/metronome_sdk/models/base_usage_filter.rb +27 -0
- data/lib/metronome_sdk/models/commit.rb +1010 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +1803 -0
- data/lib/metronome_sdk/models/credit.rb +634 -0
- data/lib/metronome_sdk/models/credit_type_data.rb +21 -0
- data/lib/metronome_sdk/models/discount.rb +68 -0
- data/lib/metronome_sdk/models/event_type_filter.rb +33 -0
- data/lib/metronome_sdk/models/id.rb +15 -0
- data/lib/metronome_sdk/models/override.rb +381 -0
- data/lib/metronome_sdk/models/pro_service.rb +73 -0
- data/lib/metronome_sdk/models/property_filter.rb +52 -0
- data/lib/metronome_sdk/models/rate.rb +101 -0
- data/lib/metronome_sdk/models/schedule_duration.rb +50 -0
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +62 -0
- data/lib/metronome_sdk/models/scheduled_charge.rb +76 -0
- data/lib/metronome_sdk/models/tier.rb +21 -0
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +4 -1
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -86
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +6 -85
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +8 -85
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +312 -35
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +550 -102
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +5 -1645
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +253 -10692
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +9 -295
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +254 -10721
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -97
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +148 -0
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +12 -561
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +14 -559
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +6 -97
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +57 -0
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +45 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +6 -42
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +6 -159
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +6 -42
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -44
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +3 -16
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +6 -44
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +9 -61
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +6 -158
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +5 -77
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +11 -153
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +14 -175
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +69 -0
- data/lib/metronome_sdk/models/v1/customer.rb +53 -0
- data/lib/metronome_sdk/models/v1/customer_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +3 -50
- data/lib/metronome_sdk/models/v1/{customer_list_response.rb → customer_detail.rb} +14 -15
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +6 -86
- data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
- data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +3 -126
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +3 -50
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +5 -276
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +3 -279
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +8 -6
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +3 -1047
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +3 -593
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +270 -0
- data/lib/metronome_sdk/models/v1/customers/{invoice_list_response.rb → invoice.rb} +119 -303
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rb +2 -1271
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +3 -21
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +1 -0
- data/lib/metronome_sdk/models/v1/plan_detail.rb +200 -0
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +3 -286
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +3 -20
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +3 -128
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +38 -0
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +38 -0
- data/lib/metronome_sdk/models/v1/usage_search_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +11 -8
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +3 -2
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +885 -103
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +351 -625
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +590 -749
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +590 -751
- data/lib/metronome_sdk/models.rb +36 -4
- data/lib/metronome_sdk/resources/v1/alerts.rb +1 -1
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +2 -2
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +4 -4
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +1 -1
- data/lib/metronome_sdk/resources/v1/contracts.rb +8 -4
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers.rb +40 -2
- data/lib/metronome_sdk/resources/v1/usage.rb +25 -0
- data/lib/metronome_sdk/resources/v2/contracts.rb +11 -9
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +31 -2
- data/rbi/metronome_sdk/errors.rbi +16 -0
- data/rbi/metronome_sdk/internal/type/boolean.rbi +2 -0
- data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
- data/rbi/metronome_sdk/internal/type/union.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/unknown.rbi +2 -0
- data/rbi/metronome_sdk/internal/util.rbi +2 -0
- data/rbi/metronome_sdk/models/base_usage_filter.rbi +46 -0
- data/rbi/metronome_sdk/models/commit.rbi +1962 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +3676 -0
- data/rbi/metronome_sdk/models/credit.rbi +1230 -0
- data/rbi/metronome_sdk/models/credit_type_data.rbi +26 -0
- data/rbi/metronome_sdk/models/discount.rbi +106 -0
- data/rbi/metronome_sdk/models/event_type_filter.rbi +57 -0
- data/rbi/metronome_sdk/models/id.rbi +23 -0
- data/rbi/metronome_sdk/models/override.rbi +675 -0
- data/rbi/metronome_sdk/models/pro_service.rbi +98 -0
- data/rbi/metronome_sdk/models/property_filter.rbi +88 -0
- data/rbi/metronome_sdk/models/rate.rbi +155 -0
- data/rbi/metronome_sdk/models/schedule_duration.rbi +89 -0
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +121 -0
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +119 -0
- data/rbi/metronome_sdk/models/tier.rbi +29 -0
- data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +6 -0
- data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +6 -12
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +4 -43
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +8 -175
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +712 -68
- data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +3 -2595
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1100 -172
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +3 -3366
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +375 -22523
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +12 -632
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +375 -22523
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +3 -2595
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +8 -209
- data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +237 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +76 -1143
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +76 -1137
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +8 -209
- data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +111 -0
- data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +94 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +8 -74
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +8 -344
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +8 -74
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +8 -108
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +4 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +8 -108
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +12 -149
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +8 -344
- data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +8 -166
- data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +10 -231
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +14 -281
- data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +90 -0
- data/rbi/metronome_sdk/models/v1/customer.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +6 -12
- data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +6 -84
- data/rbi/metronome_sdk/models/v1/{customer_list_response.rbi → customer_detail.rbi} +19 -26
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
- data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +6 -255
- data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +6 -86
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +3 -623
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +4 -622
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +12 -8
- data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +3 -2164
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +3 -1224
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +572 -0
- data/rbi/metronome_sdk/models/v1/customers/{invoice_list_response.rbi → invoice.rbi} +182 -589
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +4 -2561
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +6 -2612
- data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +349 -0
- data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +6 -560
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +4 -248
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +79 -0
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +80 -0
- data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +23 -23
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +11 -15
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +1859 -202
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +700 -1447
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +1204 -1472
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +1204 -1472
- data/rbi/metronome_sdk/models.rbi +32 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +2 -6
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +4 -4
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +1 -4
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +10 -4
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +6 -4
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +1 -1
- data/rbi/metronome_sdk/resources/v1/customers.rbi +34 -3
- data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +24 -14
- data/sig/metronome_sdk/errors.rbs +9 -0
- data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
- data/sig/metronome_sdk/models/base_usage_filter.rbs +28 -0
- data/sig/metronome_sdk/models/commit.rbs +1020 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +1582 -0
- data/sig/metronome_sdk/models/credit.rbs +643 -0
- data/sig/metronome_sdk/models/credit_type_data.rbs +15 -0
- data/sig/metronome_sdk/models/discount.rbs +63 -0
- data/sig/metronome_sdk/models/event_type_filter.rbs +26 -0
- data/sig/metronome_sdk/models/id.rbs +13 -0
- data/sig/metronome_sdk/models/override.rbs +399 -0
- data/sig/metronome_sdk/models/pro_service.rbs +61 -0
- data/sig/metronome_sdk/models/property_filter.rbs +41 -0
- data/sig/metronome_sdk/models/rate.rbs +94 -0
- data/sig/metronome_sdk/models/schedule_duration.rbs +56 -0
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +75 -0
- data/sig/metronome_sdk/models/scheduled_charge.rbs +70 -0
- data/sig/metronome_sdk/models/tier.rbs +17 -0
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -73
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +291 -24
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +4 -1291
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +448 -84
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +1 -1642
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +188 -10437
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +15 -271
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +188 -10437
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +4 -1291
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +8 -82
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +121 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +16 -466
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +16 -466
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +8 -82
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +47 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +41 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +10 -34
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +10 -144
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +10 -34
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +12 -40
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +12 -40
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +18 -58
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +10 -144
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +2 -66
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +12 -118
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +16 -140
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +52 -0
- data/sig/metronome_sdk/models/v1/customer.rbs +44 -0
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +4 -48
- data/sig/metronome_sdk/models/v1/{customer_list_response.rbs → customer_detail.rbs} +17 -17
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
- data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +4 -112
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +4 -48
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +4 -243
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +4 -247
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +4 -1057
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +4 -596
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +234 -0
- data/sig/metronome_sdk/models/v1/customers/{invoice_list_response.rbs → invoice.rbs} +147 -305
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +8 -1278
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +4 -1294
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +4 -16
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +2 -1
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +203 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +4 -267
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +4 -16
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +4 -108
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +37 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +37 -0
- data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +4 -8
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +4 -8
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +743 -77
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +274 -665
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +567 -759
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +567 -759
- data/sig/metronome_sdk/models.rbs +32 -0
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts.rbs +3 -1
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers.rbs +9 -1
- data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +3 -2
- metadata +95 -8
@@ -188,7 +188,7 @@ module MetronomeSDK
|
|
188
188
|
# @!attribute rollover_amount
|
189
189
|
# Specify how much to rollover to the rollover credit grant
|
190
190
|
#
|
191
|
-
# @return [MetronomeSDK::Models::V1::
|
191
|
+
# @return [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount]
|
192
192
|
required :rollover_amount,
|
193
193
|
union: -> { MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount }
|
194
194
|
|
@@ -205,7 +205,7 @@ module MetronomeSDK
|
|
205
205
|
#
|
206
206
|
# @param priority [Float] The priority to give the rollover credit grant that gets created when a rollover
|
207
207
|
#
|
208
|
-
# @param rollover_amount [MetronomeSDK::Models::V1::
|
208
|
+
# @param rollover_amount [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount] Specify how much to rollover to the rollover credit grant
|
209
209
|
|
210
210
|
# Specify how much to rollover to the rollover credit grant
|
211
211
|
#
|
@@ -213,84 +213,12 @@ module MetronomeSDK
|
|
213
213
|
module RolloverAmount
|
214
214
|
extend MetronomeSDK::Internal::Type::Union
|
215
215
|
|
216
|
-
variant -> {
|
217
|
-
MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0
|
218
|
-
}
|
216
|
+
variant -> { MetronomeSDK::V1::RolloverAmountMaxPercentage }
|
219
217
|
|
220
|
-
variant -> {
|
221
|
-
MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1
|
222
|
-
}
|
223
|
-
|
224
|
-
class UnionMember0 < MetronomeSDK::Internal::Type::BaseModel
|
225
|
-
# @!attribute type
|
226
|
-
# Rollover up to a percentage of the original credit grant amount.
|
227
|
-
#
|
228
|
-
# @return [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0::Type]
|
229
|
-
required :type,
|
230
|
-
enum: -> {
|
231
|
-
MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0::Type
|
232
|
-
}
|
233
|
-
|
234
|
-
# @!attribute value
|
235
|
-
# The maximum percentage (0-1) of the original credit grant to rollover.
|
236
|
-
#
|
237
|
-
# @return [Float]
|
238
|
-
required :value, Float
|
239
|
-
|
240
|
-
# @!method initialize(type:, value:)
|
241
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0::Type] Rollover up to a percentage of the original credit grant amount.
|
242
|
-
#
|
243
|
-
# @param value [Float] The maximum percentage (0-1) of the original credit grant to rollover.
|
244
|
-
|
245
|
-
# Rollover up to a percentage of the original credit grant amount.
|
246
|
-
#
|
247
|
-
# @see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0#type
|
248
|
-
module Type
|
249
|
-
extend MetronomeSDK::Internal::Type::Enum
|
250
|
-
|
251
|
-
MAX_PERCENTAGE = :MAX_PERCENTAGE
|
252
|
-
|
253
|
-
# @!method self.values
|
254
|
-
# @return [Array<Symbol>]
|
255
|
-
end
|
256
|
-
end
|
257
|
-
|
258
|
-
class UnionMember1 < MetronomeSDK::Internal::Type::BaseModel
|
259
|
-
# @!attribute type
|
260
|
-
# Rollover up to a fixed amount of the original credit grant amount.
|
261
|
-
#
|
262
|
-
# @return [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1::Type]
|
263
|
-
required :type,
|
264
|
-
enum: -> {
|
265
|
-
MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1::Type
|
266
|
-
}
|
267
|
-
|
268
|
-
# @!attribute value
|
269
|
-
# The maximum amount to rollover.
|
270
|
-
#
|
271
|
-
# @return [Float]
|
272
|
-
required :value, Float
|
273
|
-
|
274
|
-
# @!method initialize(type:, value:)
|
275
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1::Type] Rollover up to a fixed amount of the original credit grant amount.
|
276
|
-
#
|
277
|
-
# @param value [Float] The maximum amount to rollover.
|
278
|
-
|
279
|
-
# Rollover up to a fixed amount of the original credit grant amount.
|
280
|
-
#
|
281
|
-
# @see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1#type
|
282
|
-
module Type
|
283
|
-
extend MetronomeSDK::Internal::Type::Enum
|
284
|
-
|
285
|
-
MAX_AMOUNT = :MAX_AMOUNT
|
286
|
-
|
287
|
-
# @!method self.values
|
288
|
-
# @return [Array<Symbol>]
|
289
|
-
end
|
290
|
-
end
|
218
|
+
variant -> { MetronomeSDK::V1::RolloverAmountMaxAmount }
|
291
219
|
|
292
220
|
# @!method self.variants
|
293
|
-
# @return [Array(MetronomeSDK::Models::V1::
|
221
|
+
# @return [Array(MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount)]
|
294
222
|
end
|
295
223
|
end
|
296
224
|
end
|
@@ -7,22 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class CreditGrantCreateResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::Models::
|
11
|
-
required :data, -> { MetronomeSDK::
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
|
+
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::Models::
|
15
|
-
|
16
|
-
# @see MetronomeSDK::Models::V1::CreditGrantCreateResponse#data
|
17
|
-
class Data < MetronomeSDK::Internal::Type::BaseModel
|
18
|
-
# @!attribute id
|
19
|
-
#
|
20
|
-
# @return [String]
|
21
|
-
required :id, String
|
22
|
-
|
23
|
-
# @!method initialize(id:)
|
24
|
-
# @param id [String]
|
25
|
-
end
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
26
15
|
end
|
27
16
|
end
|
28
17
|
end
|
@@ -7,22 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class CreditGrantEditResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::Models::
|
11
|
-
required :data, -> { MetronomeSDK::
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
|
+
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::Models::
|
15
|
-
|
16
|
-
# @see MetronomeSDK::Models::V1::CreditGrantEditResponse#data
|
17
|
-
class Data < MetronomeSDK::Internal::Type::BaseModel
|
18
|
-
# @!attribute id
|
19
|
-
#
|
20
|
-
# @return [String]
|
21
|
-
required :id, String
|
22
|
-
|
23
|
-
# @!method initialize(id:)
|
24
|
-
# @param id [String]
|
25
|
-
end
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
26
15
|
end
|
27
16
|
end
|
28
17
|
end
|
@@ -14,6 +14,12 @@ module MetronomeSDK
|
|
14
14
|
# @return [String, nil]
|
15
15
|
optional :next_page, String
|
16
16
|
|
17
|
+
# @!attribute sort
|
18
|
+
# Ledgers sort order by date, asc or desc. Defaults to asc.
|
19
|
+
#
|
20
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CreditGrantListEntriesParams::Sort, nil]
|
21
|
+
optional :sort, enum: -> { MetronomeSDK::V1::CreditGrantListEntriesParams::Sort }
|
22
|
+
|
17
23
|
# @!attribute credit_type_ids
|
18
24
|
# A list of Metronome credit type IDs to fetch ledger entries for. If absent,
|
19
25
|
# ledger entries for all credit types will be returned.
|
@@ -44,12 +50,14 @@ module MetronomeSDK
|
|
44
50
|
# @return [Time, nil]
|
45
51
|
optional :starting_on, Time
|
46
52
|
|
47
|
-
# @!method initialize(next_page: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
|
53
|
+
# @!method initialize(next_page: nil, sort: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
|
48
54
|
# Some parameter documentations has been truncated, see
|
49
55
|
# {MetronomeSDK::Models::V1::CreditGrantListEntriesParams} for more details.
|
50
56
|
#
|
51
57
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
52
58
|
#
|
59
|
+
# @param sort [Symbol, MetronomeSDK::Models::V1::CreditGrantListEntriesParams::Sort] Ledgers sort order by date, asc or desc. Defaults to asc.
|
60
|
+
#
|
53
61
|
# @param credit_type_ids [Array<String>] A list of Metronome credit type IDs to fetch ledger entries for. If absent, ledg
|
54
62
|
#
|
55
63
|
# @param customer_ids [Array<String>] A list of Metronome customer IDs to fetch ledger entries for. If absent, ledger
|
@@ -59,6 +67,17 @@ module MetronomeSDK
|
|
59
67
|
# @param starting_on [Time] If supplied, only ledger entries effective at or after this time will be returne
|
60
68
|
#
|
61
69
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
70
|
+
|
71
|
+
# Ledgers sort order by date, asc or desc. Defaults to asc.
|
72
|
+
module Sort
|
73
|
+
extend MetronomeSDK::Internal::Type::Enum
|
74
|
+
|
75
|
+
ASC = :asc
|
76
|
+
DESC = :desc
|
77
|
+
|
78
|
+
# @!method self.values
|
79
|
+
# @return [Array<Symbol>]
|
80
|
+
end
|
62
81
|
end
|
63
82
|
end
|
64
83
|
end
|
@@ -39,9 +39,8 @@ module MetronomeSDK
|
|
39
39
|
class Ledger < MetronomeSDK::Internal::Type::BaseModel
|
40
40
|
# @!attribute credit_type
|
41
41
|
#
|
42
|
-
# @return [MetronomeSDK::Models::
|
43
|
-
required :credit_type,
|
44
|
-
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType }
|
42
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
43
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
45
44
|
|
46
45
|
# @!attribute ending_balance
|
47
46
|
# the effective balances at the end of the specified time window
|
@@ -52,15 +51,17 @@ module MetronomeSDK
|
|
52
51
|
|
53
52
|
# @!attribute entries
|
54
53
|
#
|
55
|
-
# @return [Array<MetronomeSDK::Models::V1::
|
54
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
56
55
|
required :entries,
|
57
|
-
-> {
|
56
|
+
-> {
|
57
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry]
|
58
|
+
}
|
58
59
|
|
59
60
|
# @!attribute pending_entries
|
60
61
|
#
|
61
|
-
# @return [Array<MetronomeSDK::Models::V1::
|
62
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
62
63
|
required :pending_entries,
|
63
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
64
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
64
65
|
|
65
66
|
# @!attribute starting_balance
|
66
67
|
#
|
@@ -69,33 +70,16 @@ module MetronomeSDK
|
|
69
70
|
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance }
|
70
71
|
|
71
72
|
# @!method initialize(credit_type:, ending_balance:, entries:, pending_entries:, starting_balance:)
|
72
|
-
# @param credit_type [MetronomeSDK::Models::
|
73
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
73
74
|
#
|
74
75
|
# @param ending_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance] the effective balances at the end of the specified time window
|
75
76
|
#
|
76
|
-
# @param entries [Array<MetronomeSDK::Models::V1::
|
77
|
+
# @param entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
77
78
|
#
|
78
|
-
# @param pending_entries [Array<MetronomeSDK::Models::V1::
|
79
|
+
# @param pending_entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
79
80
|
#
|
80
81
|
# @param starting_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance]
|
81
82
|
|
82
|
-
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#credit_type
|
83
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
84
|
-
# @!attribute id
|
85
|
-
#
|
86
|
-
# @return [String]
|
87
|
-
required :id, String
|
88
|
-
|
89
|
-
# @!attribute name
|
90
|
-
#
|
91
|
-
# @return [String]
|
92
|
-
required :name, String
|
93
|
-
|
94
|
-
# @!method initialize(id:, name:)
|
95
|
-
# @param id [String]
|
96
|
-
# @param name [String]
|
97
|
-
end
|
98
|
-
|
99
83
|
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#ending_balance
|
100
84
|
class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
|
101
85
|
# @!attribute effective_at
|
@@ -134,132 +118,6 @@ module MetronomeSDK
|
|
134
118
|
# @param including_pending [Float] the excluding_pending balance plus any pending invoice deductions and expiration
|
135
119
|
end
|
136
120
|
|
137
|
-
class Entry < MetronomeSDK::Internal::Type::BaseModel
|
138
|
-
# @!attribute amount
|
139
|
-
# an amount representing the change to the customer's credit balance
|
140
|
-
#
|
141
|
-
# @return [Float]
|
142
|
-
required :amount, Float
|
143
|
-
|
144
|
-
# @!attribute created_by
|
145
|
-
#
|
146
|
-
# @return [String]
|
147
|
-
required :created_by, String
|
148
|
-
|
149
|
-
# @!attribute credit_grant_id
|
150
|
-
# the credit grant this entry is related to
|
151
|
-
#
|
152
|
-
# @return [String]
|
153
|
-
required :credit_grant_id, String
|
154
|
-
|
155
|
-
# @!attribute effective_at
|
156
|
-
#
|
157
|
-
# @return [Time]
|
158
|
-
required :effective_at, Time
|
159
|
-
|
160
|
-
# @!attribute reason
|
161
|
-
#
|
162
|
-
# @return [String]
|
163
|
-
required :reason, String
|
164
|
-
|
165
|
-
# @!attribute running_balance
|
166
|
-
# the running balance for this credit type at the time of the ledger entry,
|
167
|
-
# including all preceding charges
|
168
|
-
#
|
169
|
-
# @return [Float]
|
170
|
-
required :running_balance, Float
|
171
|
-
|
172
|
-
# @!attribute invoice_id
|
173
|
-
# if this entry is a deduction, the Metronome ID of the invoice where the credit
|
174
|
-
# deduction was consumed; if this entry is a grant, the Metronome ID of the
|
175
|
-
# invoice where the grant's paid_amount was charged
|
176
|
-
#
|
177
|
-
# @return [String, nil]
|
178
|
-
optional :invoice_id, String, nil?: true
|
179
|
-
|
180
|
-
# @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
|
181
|
-
# Some parameter documentations has been truncated, see
|
182
|
-
# {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry}
|
183
|
-
# for more details.
|
184
|
-
#
|
185
|
-
# @param amount [Float] an amount representing the change to the customer's credit balance
|
186
|
-
#
|
187
|
-
# @param created_by [String]
|
188
|
-
#
|
189
|
-
# @param credit_grant_id [String] the credit grant this entry is related to
|
190
|
-
#
|
191
|
-
# @param effective_at [Time]
|
192
|
-
#
|
193
|
-
# @param reason [String]
|
194
|
-
#
|
195
|
-
# @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
|
196
|
-
#
|
197
|
-
# @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
|
198
|
-
end
|
199
|
-
|
200
|
-
class PendingEntry < MetronomeSDK::Internal::Type::BaseModel
|
201
|
-
# @!attribute amount
|
202
|
-
# an amount representing the change to the customer's credit balance
|
203
|
-
#
|
204
|
-
# @return [Float]
|
205
|
-
required :amount, Float
|
206
|
-
|
207
|
-
# @!attribute created_by
|
208
|
-
#
|
209
|
-
# @return [String]
|
210
|
-
required :created_by, String
|
211
|
-
|
212
|
-
# @!attribute credit_grant_id
|
213
|
-
# the credit grant this entry is related to
|
214
|
-
#
|
215
|
-
# @return [String]
|
216
|
-
required :credit_grant_id, String
|
217
|
-
|
218
|
-
# @!attribute effective_at
|
219
|
-
#
|
220
|
-
# @return [Time]
|
221
|
-
required :effective_at, Time
|
222
|
-
|
223
|
-
# @!attribute reason
|
224
|
-
#
|
225
|
-
# @return [String]
|
226
|
-
required :reason, String
|
227
|
-
|
228
|
-
# @!attribute running_balance
|
229
|
-
# the running balance for this credit type at the time of the ledger entry,
|
230
|
-
# including all preceding charges
|
231
|
-
#
|
232
|
-
# @return [Float]
|
233
|
-
required :running_balance, Float
|
234
|
-
|
235
|
-
# @!attribute invoice_id
|
236
|
-
# if this entry is a deduction, the Metronome ID of the invoice where the credit
|
237
|
-
# deduction was consumed; if this entry is a grant, the Metronome ID of the
|
238
|
-
# invoice where the grant's paid_amount was charged
|
239
|
-
#
|
240
|
-
# @return [String, nil]
|
241
|
-
optional :invoice_id, String, nil?: true
|
242
|
-
|
243
|
-
# @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
|
244
|
-
# Some parameter documentations has been truncated, see
|
245
|
-
# {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry}
|
246
|
-
# for more details.
|
247
|
-
#
|
248
|
-
# @param amount [Float] an amount representing the change to the customer's credit balance
|
249
|
-
#
|
250
|
-
# @param created_by [String]
|
251
|
-
#
|
252
|
-
# @param credit_grant_id [String] the credit grant this entry is related to
|
253
|
-
#
|
254
|
-
# @param effective_at [Time]
|
255
|
-
#
|
256
|
-
# @param reason [String]
|
257
|
-
#
|
258
|
-
# @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
|
259
|
-
#
|
260
|
-
# @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
|
261
|
-
end
|
262
|
-
|
263
121
|
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#starting_balance
|
264
122
|
class StartingBalance < MetronomeSDK::Internal::Type::BaseModel
|
265
123
|
# @!attribute effective_at
|
@@ -32,9 +32,11 @@ module MetronomeSDK
|
|
32
32
|
|
33
33
|
# @!attribute deductions
|
34
34
|
#
|
35
|
-
# @return [Array<MetronomeSDK::Models::V1::
|
35
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
36
36
|
required :deductions,
|
37
|
-
-> {
|
37
|
+
-> {
|
38
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry]
|
39
|
+
}
|
38
40
|
|
39
41
|
# @!attribute effective_at
|
40
42
|
#
|
@@ -65,9 +67,9 @@ module MetronomeSDK
|
|
65
67
|
|
66
68
|
# @!attribute pending_deductions
|
67
69
|
#
|
68
|
-
# @return [Array<MetronomeSDK::Models::V1::
|
70
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
69
71
|
required :pending_deductions,
|
70
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
72
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
71
73
|
|
72
74
|
# @!attribute priority
|
73
75
|
#
|
@@ -119,7 +121,7 @@ module MetronomeSDK
|
|
119
121
|
#
|
120
122
|
# @param customer_id [String] the Metronome ID of the customer
|
121
123
|
#
|
122
|
-
# @param deductions [Array<MetronomeSDK::Models::V1::
|
124
|
+
# @param deductions [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
123
125
|
#
|
124
126
|
# @param effective_at [Time]
|
125
127
|
#
|
@@ -131,7 +133,7 @@ module MetronomeSDK
|
|
131
133
|
#
|
132
134
|
# @param paid_amount [MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount] the amount paid for this credit grant
|
133
135
|
#
|
134
|
-
# @param pending_deductions [Array<MetronomeSDK::Models::V1::
|
136
|
+
# @param pending_deductions [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
135
137
|
#
|
136
138
|
# @param priority [Float]
|
137
139
|
#
|
@@ -183,68 +185,6 @@ module MetronomeSDK
|
|
183
185
|
# @param including_pending [Float] The grant's current balance including all posted and pending deductions. If the
|
184
186
|
end
|
185
187
|
|
186
|
-
class Deduction < MetronomeSDK::Internal::Type::BaseModel
|
187
|
-
# @!attribute amount
|
188
|
-
# an amount representing the change to the customer's credit balance
|
189
|
-
#
|
190
|
-
# @return [Float]
|
191
|
-
required :amount, Float
|
192
|
-
|
193
|
-
# @!attribute created_by
|
194
|
-
#
|
195
|
-
# @return [String]
|
196
|
-
required :created_by, String
|
197
|
-
|
198
|
-
# @!attribute credit_grant_id
|
199
|
-
# the credit grant this entry is related to
|
200
|
-
#
|
201
|
-
# @return [String]
|
202
|
-
required :credit_grant_id, String
|
203
|
-
|
204
|
-
# @!attribute effective_at
|
205
|
-
#
|
206
|
-
# @return [Time]
|
207
|
-
required :effective_at, Time
|
208
|
-
|
209
|
-
# @!attribute reason
|
210
|
-
#
|
211
|
-
# @return [String]
|
212
|
-
required :reason, String
|
213
|
-
|
214
|
-
# @!attribute running_balance
|
215
|
-
# the running balance for this credit type at the time of the ledger entry,
|
216
|
-
# including all preceding charges
|
217
|
-
#
|
218
|
-
# @return [Float]
|
219
|
-
required :running_balance, Float
|
220
|
-
|
221
|
-
# @!attribute invoice_id
|
222
|
-
# if this entry is a deduction, the Metronome ID of the invoice where the credit
|
223
|
-
# deduction was consumed; if this entry is a grant, the Metronome ID of the
|
224
|
-
# invoice where the grant's paid_amount was charged
|
225
|
-
#
|
226
|
-
# @return [String, nil]
|
227
|
-
optional :invoice_id, String, nil?: true
|
228
|
-
|
229
|
-
# @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
|
230
|
-
# Some parameter documentations has been truncated, see
|
231
|
-
# {MetronomeSDK::Models::V1::CreditGrantListResponse::Deduction} for more details.
|
232
|
-
#
|
233
|
-
# @param amount [Float] an amount representing the change to the customer's credit balance
|
234
|
-
#
|
235
|
-
# @param created_by [String]
|
236
|
-
#
|
237
|
-
# @param credit_grant_id [String] the credit grant this entry is related to
|
238
|
-
#
|
239
|
-
# @param effective_at [Time]
|
240
|
-
#
|
241
|
-
# @param reason [String]
|
242
|
-
#
|
243
|
-
# @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
|
244
|
-
#
|
245
|
-
# @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
|
246
|
-
end
|
247
|
-
|
248
188
|
# @see MetronomeSDK::Models::V1::CreditGrantListResponse#grant_amount
|
249
189
|
class GrantAmount < MetronomeSDK::Internal::Type::BaseModel
|
250
190
|
# @!attribute amount
|
@@ -255,34 +195,15 @@ module MetronomeSDK
|
|
255
195
|
# @!attribute credit_type
|
256
196
|
# the credit type for the amount granted
|
257
197
|
#
|
258
|
-
# @return [MetronomeSDK::Models::
|
259
|
-
required :credit_type, -> { MetronomeSDK::
|
198
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
199
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
260
200
|
|
261
201
|
# @!method initialize(amount:, credit_type:)
|
262
202
|
# the amount of credits initially granted
|
263
203
|
#
|
264
204
|
# @param amount [Float]
|
265
205
|
#
|
266
|
-
# @param credit_type [MetronomeSDK::Models::
|
267
|
-
|
268
|
-
# @see MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount#credit_type
|
269
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
270
|
-
# @!attribute id
|
271
|
-
#
|
272
|
-
# @return [String]
|
273
|
-
required :id, String
|
274
|
-
|
275
|
-
# @!attribute name
|
276
|
-
#
|
277
|
-
# @return [String]
|
278
|
-
required :name, String
|
279
|
-
|
280
|
-
# @!method initialize(id:, name:)
|
281
|
-
# the credit type for the amount granted
|
282
|
-
#
|
283
|
-
# @param id [String]
|
284
|
-
# @param name [String]
|
285
|
-
end
|
206
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData] the credit type for the amount granted
|
286
207
|
end
|
287
208
|
|
288
209
|
# @see MetronomeSDK::Models::V1::CreditGrantListResponse#paid_amount
|
@@ -295,97 +216,15 @@ module MetronomeSDK
|
|
295
216
|
# @!attribute credit_type
|
296
217
|
# the credit type for the amount paid
|
297
218
|
#
|
298
|
-
# @return [MetronomeSDK::Models::
|
299
|
-
required :credit_type, -> { MetronomeSDK::
|
219
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
220
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
300
221
|
|
301
222
|
# @!method initialize(amount:, credit_type:)
|
302
223
|
# the amount paid for this credit grant
|
303
224
|
#
|
304
225
|
# @param amount [Float]
|
305
226
|
#
|
306
|
-
# @param credit_type [MetronomeSDK::Models::
|
307
|
-
|
308
|
-
# @see MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount#credit_type
|
309
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
310
|
-
# @!attribute id
|
311
|
-
#
|
312
|
-
# @return [String]
|
313
|
-
required :id, String
|
314
|
-
|
315
|
-
# @!attribute name
|
316
|
-
#
|
317
|
-
# @return [String]
|
318
|
-
required :name, String
|
319
|
-
|
320
|
-
# @!method initialize(id:, name:)
|
321
|
-
# the credit type for the amount paid
|
322
|
-
#
|
323
|
-
# @param id [String]
|
324
|
-
# @param name [String]
|
325
|
-
end
|
326
|
-
end
|
327
|
-
|
328
|
-
class PendingDeduction < MetronomeSDK::Internal::Type::BaseModel
|
329
|
-
# @!attribute amount
|
330
|
-
# an amount representing the change to the customer's credit balance
|
331
|
-
#
|
332
|
-
# @return [Float]
|
333
|
-
required :amount, Float
|
334
|
-
|
335
|
-
# @!attribute created_by
|
336
|
-
#
|
337
|
-
# @return [String]
|
338
|
-
required :created_by, String
|
339
|
-
|
340
|
-
# @!attribute credit_grant_id
|
341
|
-
# the credit grant this entry is related to
|
342
|
-
#
|
343
|
-
# @return [String]
|
344
|
-
required :credit_grant_id, String
|
345
|
-
|
346
|
-
# @!attribute effective_at
|
347
|
-
#
|
348
|
-
# @return [Time]
|
349
|
-
required :effective_at, Time
|
350
|
-
|
351
|
-
# @!attribute reason
|
352
|
-
#
|
353
|
-
# @return [String]
|
354
|
-
required :reason, String
|
355
|
-
|
356
|
-
# @!attribute running_balance
|
357
|
-
# the running balance for this credit type at the time of the ledger entry,
|
358
|
-
# including all preceding charges
|
359
|
-
#
|
360
|
-
# @return [Float]
|
361
|
-
required :running_balance, Float
|
362
|
-
|
363
|
-
# @!attribute invoice_id
|
364
|
-
# if this entry is a deduction, the Metronome ID of the invoice where the credit
|
365
|
-
# deduction was consumed; if this entry is a grant, the Metronome ID of the
|
366
|
-
# invoice where the grant's paid_amount was charged
|
367
|
-
#
|
368
|
-
# @return [String, nil]
|
369
|
-
optional :invoice_id, String, nil?: true
|
370
|
-
|
371
|
-
# @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
|
372
|
-
# Some parameter documentations has been truncated, see
|
373
|
-
# {MetronomeSDK::Models::V1::CreditGrantListResponse::PendingDeduction} for more
|
374
|
-
# details.
|
375
|
-
#
|
376
|
-
# @param amount [Float] an amount representing the change to the customer's credit balance
|
377
|
-
#
|
378
|
-
# @param created_by [String]
|
379
|
-
#
|
380
|
-
# @param credit_grant_id [String] the credit grant this entry is related to
|
381
|
-
#
|
382
|
-
# @param effective_at [Time]
|
383
|
-
#
|
384
|
-
# @param reason [String]
|
385
|
-
#
|
386
|
-
# @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
|
387
|
-
#
|
388
|
-
# @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
|
227
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData] the credit type for the amount paid
|
389
228
|
end
|
390
229
|
|
391
230
|
class Product < MetronomeSDK::Internal::Type::BaseModel
|