metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +56 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
- 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 +1053 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +2043 -0
- data/lib/metronome_sdk/models/credit.rb +677 -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 +792 -104
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +9 -1
- 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_params.rb +9 -1
- 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_params.rb +9 -1
- 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 +1127 -105
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +577 -643
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +917 -746
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +917 -748
- 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 +11 -5
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +5 -3
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -1
- 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 +2046 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +4260 -0
- data/rbi/metronome_sdk/models/credit.rbi +1314 -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 +1738 -210
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +11 -0
- 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_params.rbi +11 -0
- 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_params.rbi +11 -0
- 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 +2463 -206
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1381 -1550
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2017 -1466
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2017 -1466
- 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 +13 -4
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +9 -4
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
- 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 +1063 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +1828 -0
- data/sig/metronome_sdk/models/credit.rbs +686 -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 +694 -84
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +7 -0
- 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_params.rbs +7 -0
- 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_params.rbs +7 -0
- 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 +989 -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 +510 -655
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +970 -809
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +970 -809
- 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 +4 -1
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
- 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 +97 -10
@@ -5,7 +5,7 @@ module MetronomeSDK
|
|
5
5
|
module V1
|
6
6
|
module Customers
|
7
7
|
# @see MetronomeSDK::Resources::V1::Customers::Invoices#list
|
8
|
-
class
|
8
|
+
class Invoice < MetronomeSDK::Internal::Type::BaseModel
|
9
9
|
# @!attribute id
|
10
10
|
#
|
11
11
|
# @return [String]
|
@@ -13,8 +13,8 @@ module MetronomeSDK
|
|
13
13
|
|
14
14
|
# @!attribute credit_type
|
15
15
|
#
|
16
|
-
# @return [MetronomeSDK::Models::
|
17
|
-
required :credit_type, -> { MetronomeSDK::
|
16
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
17
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
18
18
|
|
19
19
|
# @!attribute customer_id
|
20
20
|
#
|
@@ -23,9 +23,11 @@ module MetronomeSDK
|
|
23
23
|
|
24
24
|
# @!attribute line_items
|
25
25
|
#
|
26
|
-
# @return [Array<MetronomeSDK::Models::V1::Customers::
|
26
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem>]
|
27
27
|
required :line_items,
|
28
|
-
-> {
|
28
|
+
-> {
|
29
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem]
|
30
|
+
}
|
29
31
|
|
30
32
|
# @!attribute status
|
31
33
|
#
|
@@ -50,9 +52,8 @@ module MetronomeSDK
|
|
50
52
|
# @!attribute billable_status
|
51
53
|
# This field's availability is dependent on your client's configuration.
|
52
54
|
#
|
53
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
54
|
-
optional :billable_status,
|
55
|
-
enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::BillableStatus }
|
55
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus, nil]
|
56
|
+
optional :billable_status, enum: -> { MetronomeSDK::V1::Customers::Invoice::BillableStatus }
|
56
57
|
|
57
58
|
# @!attribute contract_custom_fields
|
58
59
|
#
|
@@ -66,9 +67,8 @@ module MetronomeSDK
|
|
66
67
|
|
67
68
|
# @!attribute correction_record
|
68
69
|
#
|
69
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
70
|
-
optional :correction_record,
|
71
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::CorrectionRecord }
|
70
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord, nil]
|
71
|
+
optional :correction_record, -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord }
|
72
72
|
|
73
73
|
# @!attribute created_at
|
74
74
|
# When the invoice was created (UTC). This field is present for correction
|
@@ -95,16 +95,16 @@ module MetronomeSDK
|
|
95
95
|
|
96
96
|
# @!attribute external_invoice
|
97
97
|
#
|
98
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
99
|
-
optional :external_invoice,
|
100
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::ExternalInvoice },
|
101
|
-
nil?: true
|
98
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice, nil]
|
99
|
+
optional :external_invoice, -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice }, nil?: true
|
102
100
|
|
103
101
|
# @!attribute invoice_adjustments
|
104
102
|
#
|
105
|
-
# @return [Array<MetronomeSDK::Models::V1::Customers::
|
103
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::InvoiceAdjustment>, nil]
|
106
104
|
optional :invoice_adjustments,
|
107
|
-
-> {
|
105
|
+
-> {
|
106
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::InvoiceAdjustment]
|
107
|
+
}
|
108
108
|
|
109
109
|
# @!attribute issued_at
|
110
110
|
# When the invoice was issued (UTC)
|
@@ -141,9 +141,8 @@ module MetronomeSDK
|
|
141
141
|
# @!attribute reseller_royalty
|
142
142
|
# Only present for contract invoices with reseller royalties.
|
143
143
|
#
|
144
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
145
|
-
optional :reseller_royalty,
|
146
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::ResellerRoyalty }
|
144
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty, nil]
|
145
|
+
optional :reseller_royalty, -> { MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty }
|
147
146
|
|
148
147
|
# @!attribute salesforce_opportunity_id
|
149
148
|
# This field's availability is dependent on your client's configuration.
|
@@ -164,15 +163,15 @@ module MetronomeSDK
|
|
164
163
|
|
165
164
|
# @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
|
166
165
|
# Some parameter documentations has been truncated, see
|
167
|
-
# {MetronomeSDK::Models::V1::Customers::
|
166
|
+
# {MetronomeSDK::Models::V1::Customers::Invoice} for more details.
|
168
167
|
#
|
169
168
|
# @param id [String]
|
170
169
|
#
|
171
|
-
# @param credit_type [MetronomeSDK::Models::
|
170
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
172
171
|
#
|
173
172
|
# @param customer_id [String]
|
174
173
|
#
|
175
|
-
# @param line_items [Array<MetronomeSDK::Models::V1::Customers::
|
174
|
+
# @param line_items [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem>]
|
176
175
|
#
|
177
176
|
# @param status [String]
|
178
177
|
#
|
@@ -182,13 +181,13 @@ module MetronomeSDK
|
|
182
181
|
#
|
183
182
|
# @param amendment_id [String]
|
184
183
|
#
|
185
|
-
# @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::
|
184
|
+
# @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus] This field's availability is dependent on your client's configuration.
|
186
185
|
#
|
187
186
|
# @param contract_custom_fields [Hash{Symbol=>String}]
|
188
187
|
#
|
189
188
|
# @param contract_id [String]
|
190
189
|
#
|
191
|
-
# @param correction_record [MetronomeSDK::Models::V1::Customers::
|
190
|
+
# @param correction_record [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord]
|
192
191
|
#
|
193
192
|
# @param created_at [Time] When the invoice was created (UTC). This field is present for correction invoice
|
194
193
|
#
|
@@ -198,9 +197,9 @@ module MetronomeSDK
|
|
198
197
|
#
|
199
198
|
# @param end_timestamp [Time] End of the usage period this invoice covers (UTC)
|
200
199
|
#
|
201
|
-
# @param external_invoice [MetronomeSDK::Models::V1::Customers::
|
200
|
+
# @param external_invoice [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice, nil]
|
202
201
|
#
|
203
|
-
# @param invoice_adjustments [Array<MetronomeSDK::Models::V1::Customers::
|
202
|
+
# @param invoice_adjustments [Array<MetronomeSDK::Models::V1::Customers::Invoice::InvoiceAdjustment>]
|
204
203
|
#
|
205
204
|
# @param issued_at [Time] When the invoice was issued (UTC)
|
206
205
|
#
|
@@ -214,7 +213,7 @@ module MetronomeSDK
|
|
214
213
|
#
|
215
214
|
# @param plan_name [String]
|
216
215
|
#
|
217
|
-
# @param reseller_royalty [MetronomeSDK::Models::V1::Customers::
|
216
|
+
# @param reseller_royalty [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty] Only present for contract invoices with reseller royalties.
|
218
217
|
#
|
219
218
|
# @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
|
220
219
|
#
|
@@ -222,29 +221,11 @@ module MetronomeSDK
|
|
222
221
|
#
|
223
222
|
# @param subtotal [Float]
|
224
223
|
|
225
|
-
# @see MetronomeSDK::Models::V1::Customers::InvoiceListResponse#credit_type
|
226
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
227
|
-
# @!attribute id
|
228
|
-
#
|
229
|
-
# @return [String]
|
230
|
-
required :id, String
|
231
|
-
|
232
|
-
# @!attribute name
|
233
|
-
#
|
234
|
-
# @return [String]
|
235
|
-
required :name, String
|
236
|
-
|
237
|
-
# @!method initialize(id:, name:)
|
238
|
-
# @param id [String]
|
239
|
-
# @param name [String]
|
240
|
-
end
|
241
|
-
|
242
224
|
class LineItem < MetronomeSDK::Internal::Type::BaseModel
|
243
225
|
# @!attribute credit_type
|
244
226
|
#
|
245
|
-
# @return [MetronomeSDK::Models::
|
246
|
-
required :credit_type,
|
247
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::CreditType }
|
227
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
228
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
248
229
|
|
249
230
|
# @!attribute name
|
250
231
|
#
|
@@ -261,9 +242,9 @@ module MetronomeSDK
|
|
261
242
|
# present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
|
262
243
|
# types.
|
263
244
|
#
|
264
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
245
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit, nil]
|
265
246
|
optional :applied_commit_or_credit,
|
266
|
-
-> { MetronomeSDK::
|
247
|
+
-> { MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit }
|
267
248
|
|
268
249
|
# @!attribute commit_custom_fields
|
269
250
|
#
|
@@ -344,8 +325,8 @@ module MetronomeSDK
|
|
344
325
|
# parameter is set to true. This will include the list rate for the charge if
|
345
326
|
# applicable. Only present for usage and subscription line items.
|
346
327
|
#
|
347
|
-
# @return [MetronomeSDK::Models::
|
348
|
-
optional :list_price, -> { MetronomeSDK::
|
328
|
+
# @return [MetronomeSDK::Models::Rate, nil]
|
329
|
+
optional :list_price, -> { MetronomeSDK::Rate }
|
349
330
|
|
350
331
|
# @!attribute metadata
|
351
332
|
#
|
@@ -372,9 +353,8 @@ module MetronomeSDK
|
|
372
353
|
# @!attribute postpaid_commit
|
373
354
|
# Only present for line items paying for a postpaid commit true-up.
|
374
355
|
#
|
375
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
376
|
-
optional :postpaid_commit,
|
377
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::PostpaidCommit }
|
356
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::PostpaidCommit, nil]
|
357
|
+
optional :postpaid_commit, -> { MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit }
|
378
358
|
|
379
359
|
# @!attribute presentation_group_values
|
380
360
|
# Includes the presentation group values associated with this line item if
|
@@ -435,9 +415,8 @@ module MetronomeSDK
|
|
435
415
|
|
436
416
|
# @!attribute reseller_type
|
437
417
|
#
|
438
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
439
|
-
optional :reseller_type,
|
440
|
-
enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ResellerType }
|
418
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::ResellerType, nil]
|
419
|
+
optional :reseller_type, enum: -> { MetronomeSDK::V1::Customers::Invoice::LineItem::ResellerType }
|
441
420
|
|
442
421
|
# @!attribute scheduled_charge_custom_fields
|
443
422
|
#
|
@@ -458,9 +437,11 @@ module MetronomeSDK
|
|
458
437
|
|
459
438
|
# @!attribute sub_line_items
|
460
439
|
#
|
461
|
-
# @return [Array<MetronomeSDK::Models::V1::Customers::
|
440
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem>, nil]
|
462
441
|
optional :sub_line_items,
|
463
|
-
-> {
|
442
|
+
-> {
|
443
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem]
|
444
|
+
}
|
464
445
|
|
465
446
|
# @!attribute subscription_custom_fields
|
466
447
|
#
|
@@ -470,8 +451,8 @@ module MetronomeSDK
|
|
470
451
|
# @!attribute tier
|
471
452
|
# Populated if the line item has a tiered price.
|
472
453
|
#
|
473
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
474
|
-
optional :tier, -> { MetronomeSDK::
|
454
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::Tier, nil]
|
455
|
+
optional :tier, -> { MetronomeSDK::V1::Customers::Invoice::LineItem::Tier }
|
475
456
|
|
476
457
|
# @!attribute unit_price
|
477
458
|
# The unit price associated with the line item.
|
@@ -481,16 +462,15 @@ module MetronomeSDK
|
|
481
462
|
|
482
463
|
# @!method initialize(credit_type:, name:, total:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, tier: nil, unit_price: nil)
|
483
464
|
# Some parameter documentations has been truncated, see
|
484
|
-
# {MetronomeSDK::Models::V1::Customers::
|
485
|
-
# details.
|
465
|
+
# {MetronomeSDK::Models::V1::Customers::Invoice::LineItem} for more details.
|
486
466
|
#
|
487
|
-
# @param credit_type [MetronomeSDK::Models::
|
467
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
488
468
|
#
|
489
469
|
# @param name [String]
|
490
470
|
#
|
491
471
|
# @param total [Float]
|
492
472
|
#
|
493
|
-
# @param applied_commit_or_credit [MetronomeSDK::Models::V1::Customers::
|
473
|
+
# @param applied_commit_or_credit [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit] Details about the credit or commit that was applied to this line item. Only pres
|
494
474
|
#
|
495
475
|
# @param commit_custom_fields [Hash{Symbol=>String}]
|
496
476
|
#
|
@@ -518,7 +498,7 @@ module MetronomeSDK
|
|
518
498
|
#
|
519
499
|
# @param is_prorated [Boolean] Indicates whether the line item is prorated for `SUBSCRIPTION` type product.
|
520
500
|
#
|
521
|
-
# @param list_price [MetronomeSDK::Models::
|
501
|
+
# @param list_price [MetronomeSDK::Models::Rate] Only present for contract invoices and when the `include_list_prices` query para
|
522
502
|
#
|
523
503
|
# @param metadata [String]
|
524
504
|
#
|
@@ -528,7 +508,7 @@ module MetronomeSDK
|
|
528
508
|
#
|
529
509
|
# @param netsuite_item_id [String]
|
530
510
|
#
|
531
|
-
# @param postpaid_commit [MetronomeSDK::Models::V1::Customers::
|
511
|
+
# @param postpaid_commit [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::PostpaidCommit] Only present for line items paying for a postpaid commit true-up.
|
532
512
|
#
|
533
513
|
# @param presentation_group_values [Hash{Symbol=>String, nil}] Includes the presentation group values associated with this line item if present
|
534
514
|
#
|
@@ -548,7 +528,7 @@ module MetronomeSDK
|
|
548
528
|
#
|
549
529
|
# @param quantity [Float] The quantity associated with the line item.
|
550
530
|
#
|
551
|
-
# @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::
|
531
|
+
# @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::ResellerType]
|
552
532
|
#
|
553
533
|
# @param scheduled_charge_custom_fields [Hash{Symbol=>String}]
|
554
534
|
#
|
@@ -556,32 +536,15 @@ module MetronomeSDK
|
|
556
536
|
#
|
557
537
|
# @param starting_at [Time] The line item's start date (inclusive).
|
558
538
|
#
|
559
|
-
# @param sub_line_items [Array<MetronomeSDK::Models::V1::Customers::
|
539
|
+
# @param sub_line_items [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem>]
|
560
540
|
#
|
561
541
|
# @param subscription_custom_fields [Hash{Symbol=>String}]
|
562
542
|
#
|
563
|
-
# @param tier [MetronomeSDK::Models::V1::Customers::
|
543
|
+
# @param tier [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::Tier] Populated if the line item has a tiered price.
|
564
544
|
#
|
565
545
|
# @param unit_price [Float] The unit price associated with the line item.
|
566
546
|
|
567
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
568
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
569
|
-
# @!attribute id
|
570
|
-
#
|
571
|
-
# @return [String]
|
572
|
-
required :id, String
|
573
|
-
|
574
|
-
# @!attribute name
|
575
|
-
#
|
576
|
-
# @return [String]
|
577
|
-
required :name, String
|
578
|
-
|
579
|
-
# @!method initialize(id:, name:)
|
580
|
-
# @param id [String]
|
581
|
-
# @param name [String]
|
582
|
-
end
|
583
|
-
|
584
|
-
# @see MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem#applied_commit_or_credit
|
547
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#applied_commit_or_credit
|
585
548
|
class AppliedCommitOrCredit < MetronomeSDK::Internal::Type::BaseModel
|
586
549
|
# @!attribute id
|
587
550
|
#
|
@@ -590,9 +553,11 @@ module MetronomeSDK
|
|
590
553
|
|
591
554
|
# @!attribute type
|
592
555
|
#
|
593
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
556
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type]
|
594
557
|
required :type,
|
595
|
-
enum: -> {
|
558
|
+
enum: -> {
|
559
|
+
MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type
|
560
|
+
}
|
596
561
|
|
597
562
|
# @!method initialize(id:, type:)
|
598
563
|
# Details about the credit or commit that was applied to this line item. Only
|
@@ -600,9 +565,9 @@ module MetronomeSDK
|
|
600
565
|
# types.
|
601
566
|
#
|
602
567
|
# @param id [String]
|
603
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::Customers::
|
568
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type]
|
604
569
|
|
605
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
570
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit#type
|
606
571
|
module Type
|
607
572
|
extend MetronomeSDK::Internal::Type::Enum
|
608
573
|
|
@@ -615,146 +580,7 @@ module MetronomeSDK
|
|
615
580
|
end
|
616
581
|
end
|
617
582
|
|
618
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
619
|
-
class ListPrice < MetronomeSDK::Internal::Type::BaseModel
|
620
|
-
# @!attribute rate_type
|
621
|
-
#
|
622
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::RateType]
|
623
|
-
required :rate_type,
|
624
|
-
enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::RateType }
|
625
|
-
|
626
|
-
# @!attribute credit_type
|
627
|
-
#
|
628
|
-
# @return [MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::CreditType, nil]
|
629
|
-
optional :credit_type,
|
630
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::CreditType }
|
631
|
-
|
632
|
-
# @!attribute custom_rate
|
633
|
-
# Only set for CUSTOM rate_type. This field is interpreted by custom rate
|
634
|
-
# processors.
|
635
|
-
#
|
636
|
-
# @return [Hash{Symbol=>Object}, nil]
|
637
|
-
optional :custom_rate,
|
638
|
-
MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
|
639
|
-
|
640
|
-
# @!attribute is_prorated
|
641
|
-
# Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
|
642
|
-
# set to true.
|
643
|
-
#
|
644
|
-
# @return [Boolean, nil]
|
645
|
-
optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
|
646
|
-
|
647
|
-
# @!attribute price
|
648
|
-
# Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
|
649
|
-
# this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
|
650
|
-
#
|
651
|
-
# @return [Float, nil]
|
652
|
-
optional :price, Float
|
653
|
-
|
654
|
-
# @!attribute pricing_group_values
|
655
|
-
# if pricing groups are used, this will contain the values used to calculate the
|
656
|
-
# price
|
657
|
-
#
|
658
|
-
# @return [Hash{Symbol=>String}, nil]
|
659
|
-
optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
|
660
|
-
|
661
|
-
# @!attribute quantity
|
662
|
-
# Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
663
|
-
#
|
664
|
-
# @return [Float, nil]
|
665
|
-
optional :quantity, Float
|
666
|
-
|
667
|
-
# @!attribute tiers
|
668
|
-
# Only set for TIERED rate_type.
|
669
|
-
#
|
670
|
-
# @return [Array<MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::Tier>, nil]
|
671
|
-
optional :tiers,
|
672
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::Tier] }
|
673
|
-
|
674
|
-
# @!attribute use_list_prices
|
675
|
-
# Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
|
676
|
-
# using list prices rather than the standard rates for this product on the
|
677
|
-
# contract.
|
678
|
-
#
|
679
|
-
# @return [Boolean, nil]
|
680
|
-
optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
|
681
|
-
|
682
|
-
# @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
|
683
|
-
# Some parameter documentations has been truncated, see
|
684
|
-
# {MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice}
|
685
|
-
# for more details.
|
686
|
-
#
|
687
|
-
# Only present for contract invoices and when the `include_list_prices` query
|
688
|
-
# parameter is set to true. This will include the list rate for the charge if
|
689
|
-
# applicable. Only present for usage and subscription line items.
|
690
|
-
#
|
691
|
-
# @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::RateType]
|
692
|
-
#
|
693
|
-
# @param credit_type [MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::CreditType]
|
694
|
-
#
|
695
|
-
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
696
|
-
#
|
697
|
-
# @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
|
698
|
-
#
|
699
|
-
# @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
|
700
|
-
#
|
701
|
-
# @param pricing_group_values [Hash{Symbol=>String}] if pricing groups are used, this will contain the values used to calculate the p
|
702
|
-
#
|
703
|
-
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
704
|
-
#
|
705
|
-
# @param tiers [Array<MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice::Tier>] Only set for TIERED rate_type.
|
706
|
-
#
|
707
|
-
# @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
|
708
|
-
|
709
|
-
# @see MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice#rate_type
|
710
|
-
module RateType
|
711
|
-
extend MetronomeSDK::Internal::Type::Enum
|
712
|
-
|
713
|
-
FLAT = :FLAT
|
714
|
-
PERCENTAGE = :PERCENTAGE
|
715
|
-
SUBSCRIPTION = :SUBSCRIPTION
|
716
|
-
CUSTOM = :CUSTOM
|
717
|
-
TIERED = :TIERED
|
718
|
-
|
719
|
-
# @!method self.values
|
720
|
-
# @return [Array<Symbol>]
|
721
|
-
end
|
722
|
-
|
723
|
-
# @see MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem::ListPrice#credit_type
|
724
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
725
|
-
# @!attribute id
|
726
|
-
#
|
727
|
-
# @return [String]
|
728
|
-
required :id, String
|
729
|
-
|
730
|
-
# @!attribute name
|
731
|
-
#
|
732
|
-
# @return [String]
|
733
|
-
required :name, String
|
734
|
-
|
735
|
-
# @!method initialize(id:, name:)
|
736
|
-
# @param id [String]
|
737
|
-
# @param name [String]
|
738
|
-
end
|
739
|
-
|
740
|
-
class Tier < MetronomeSDK::Internal::Type::BaseModel
|
741
|
-
# @!attribute price
|
742
|
-
#
|
743
|
-
# @return [Float]
|
744
|
-
required :price, Float
|
745
|
-
|
746
|
-
# @!attribute size
|
747
|
-
#
|
748
|
-
# @return [Float, nil]
|
749
|
-
optional :size, Float
|
750
|
-
|
751
|
-
# @!method initialize(price:, size: nil)
|
752
|
-
# @param price [Float]
|
753
|
-
# @param size [Float]
|
754
|
-
end
|
755
|
-
end
|
756
|
-
|
757
|
-
# @see MetronomeSDK::Models::V1::Customers::InvoiceListResponse::LineItem#postpaid_commit
|
583
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#postpaid_commit
|
758
584
|
class PostpaidCommit < MetronomeSDK::Internal::Type::BaseModel
|
759
585
|
# @!attribute id
|
760
586
|
#
|
@@ -767,7 +593,7 @@ module MetronomeSDK
|
|
767
593
|
# @param id [String]
|
768
594
|
end
|
769
595
|
|
770
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
596
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#reseller_type
|
771
597
|
module ResellerType
|
772
598
|
extend MetronomeSDK::Internal::Type::Enum
|
773
599
|
|
@@ -833,20 +659,24 @@ module MetronomeSDK
|
|
833
659
|
# @!attribute tier_period
|
834
660
|
# when the current tier started and ends (for tiered charges only)
|
835
661
|
#
|
836
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
662
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod, nil]
|
837
663
|
optional :tier_period,
|
838
|
-
-> {
|
664
|
+
-> {
|
665
|
+
MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod
|
666
|
+
}
|
839
667
|
|
840
668
|
# @!attribute tiers
|
841
669
|
#
|
842
|
-
# @return [Array<MetronomeSDK::Models::V1::Customers::
|
670
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::Tier>, nil]
|
843
671
|
optional :tiers,
|
844
|
-
-> {
|
672
|
+
-> {
|
673
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::Tier]
|
674
|
+
}
|
845
675
|
|
846
676
|
# @!method initialize(custom_fields:, name:, quantity:, subtotal:, charge_id: nil, credit_grant_id: nil, end_date: nil, price: nil, start_date: nil, tier_period: nil, tiers: nil)
|
847
677
|
# Some parameter documentations has been truncated, see
|
848
|
-
# {MetronomeSDK::Models::V1::Customers::
|
849
|
-
#
|
678
|
+
# {MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem} for more
|
679
|
+
# details.
|
850
680
|
#
|
851
681
|
# @param custom_fields [Hash{Symbol=>String}]
|
852
682
|
#
|
@@ -866,11 +696,11 @@ module MetronomeSDK
|
|
866
696
|
#
|
867
697
|
# @param start_date [Time] The start date for the charge (for seats charges only).
|
868
698
|
#
|
869
|
-
# @param tier_period [MetronomeSDK::Models::V1::Customers::
|
699
|
+
# @param tier_period [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod] when the current tier started and ends (for tiered charges only)
|
870
700
|
#
|
871
|
-
# @param tiers [Array<MetronomeSDK::Models::V1::Customers::
|
701
|
+
# @param tiers [Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::Tier>]
|
872
702
|
|
873
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
703
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem#tier_period
|
874
704
|
class TierPeriod < MetronomeSDK::Internal::Type::BaseModel
|
875
705
|
# @!attribute starting_at
|
876
706
|
#
|
@@ -922,7 +752,7 @@ module MetronomeSDK
|
|
922
752
|
end
|
923
753
|
end
|
924
754
|
|
925
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
755
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#tier
|
926
756
|
class Tier < MetronomeSDK::Internal::Type::BaseModel
|
927
757
|
# @!attribute level
|
928
758
|
#
|
@@ -950,7 +780,7 @@ module MetronomeSDK
|
|
950
780
|
|
951
781
|
# This field's availability is dependent on your client's configuration.
|
952
782
|
#
|
953
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
783
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice#billable_status
|
954
784
|
module BillableStatus
|
955
785
|
extend MetronomeSDK::Internal::Type::Enum
|
956
786
|
|
@@ -961,7 +791,7 @@ module MetronomeSDK
|
|
961
791
|
# @return [Array<Symbol>]
|
962
792
|
end
|
963
793
|
|
964
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
794
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice#correction_record
|
965
795
|
class CorrectionRecord < MetronomeSDK::Internal::Type::BaseModel
|
966
796
|
# @!attribute corrected_invoice_id
|
967
797
|
#
|
@@ -980,29 +810,33 @@ module MetronomeSDK
|
|
980
810
|
|
981
811
|
# @!attribute corrected_external_invoice
|
982
812
|
#
|
983
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
813
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice, nil]
|
984
814
|
optional :corrected_external_invoice,
|
985
|
-
-> { MetronomeSDK::
|
815
|
+
-> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice }
|
986
816
|
|
987
817
|
# @!method initialize(corrected_invoice_id:, memo:, reason:, corrected_external_invoice: nil)
|
988
818
|
# @param corrected_invoice_id [String]
|
989
819
|
# @param memo [String]
|
990
820
|
# @param reason [String]
|
991
|
-
# @param corrected_external_invoice [MetronomeSDK::Models::V1::Customers::
|
821
|
+
# @param corrected_external_invoice [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice]
|
992
822
|
|
993
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
823
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord#corrected_external_invoice
|
994
824
|
class CorrectedExternalInvoice < MetronomeSDK::Internal::Type::BaseModel
|
995
825
|
# @!attribute billing_provider_type
|
996
826
|
#
|
997
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
827
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
|
998
828
|
required :billing_provider_type,
|
999
|
-
enum: -> {
|
829
|
+
enum: -> {
|
830
|
+
MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType
|
831
|
+
}
|
1000
832
|
|
1001
833
|
# @!attribute external_status
|
1002
834
|
#
|
1003
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
835
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus, nil]
|
1004
836
|
optional :external_status,
|
1005
|
-
enum: -> {
|
837
|
+
enum: -> {
|
838
|
+
MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus
|
839
|
+
}
|
1006
840
|
|
1007
841
|
# @!attribute invoice_id
|
1008
842
|
#
|
@@ -1015,12 +849,12 @@ module MetronomeSDK
|
|
1015
849
|
optional :issued_at_timestamp, Time
|
1016
850
|
|
1017
851
|
# @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
|
1018
|
-
# @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::
|
1019
|
-
# @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::
|
852
|
+
# @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
|
853
|
+
# @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus]
|
1020
854
|
# @param invoice_id [String]
|
1021
855
|
# @param issued_at_timestamp [Time]
|
1022
856
|
|
1023
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
857
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#billing_provider_type
|
1024
858
|
module BillingProviderType
|
1025
859
|
extend MetronomeSDK::Internal::Type::Enum
|
1026
860
|
|
@@ -1037,7 +871,7 @@ module MetronomeSDK
|
|
1037
871
|
# @return [Array<Symbol>]
|
1038
872
|
end
|
1039
873
|
|
1040
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
874
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#external_status
|
1041
875
|
module ExternalStatus
|
1042
876
|
extend MetronomeSDK::Internal::Type::Enum
|
1043
877
|
|
@@ -1059,19 +893,19 @@ module MetronomeSDK
|
|
1059
893
|
end
|
1060
894
|
end
|
1061
895
|
|
1062
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
896
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice#external_invoice
|
1063
897
|
class ExternalInvoice < MetronomeSDK::Internal::Type::BaseModel
|
1064
898
|
# @!attribute billing_provider_type
|
1065
899
|
#
|
1066
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
900
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::BillingProviderType]
|
1067
901
|
required :billing_provider_type,
|
1068
|
-
enum: -> { MetronomeSDK::
|
902
|
+
enum: -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::BillingProviderType }
|
1069
903
|
|
1070
904
|
# @!attribute external_status
|
1071
905
|
#
|
1072
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
906
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus, nil]
|
1073
907
|
optional :external_status,
|
1074
|
-
enum: -> { MetronomeSDK::
|
908
|
+
enum: -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::ExternalStatus }
|
1075
909
|
|
1076
910
|
# @!attribute invoice_id
|
1077
911
|
#
|
@@ -1084,12 +918,12 @@ module MetronomeSDK
|
|
1084
918
|
optional :issued_at_timestamp, Time
|
1085
919
|
|
1086
920
|
# @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
|
1087
|
-
# @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::
|
1088
|
-
# @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::
|
921
|
+
# @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::BillingProviderType]
|
922
|
+
# @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus]
|
1089
923
|
# @param invoice_id [String]
|
1090
924
|
# @param issued_at_timestamp [Time]
|
1091
925
|
|
1092
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
926
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#billing_provider_type
|
1093
927
|
module BillingProviderType
|
1094
928
|
extend MetronomeSDK::Internal::Type::Enum
|
1095
929
|
|
@@ -1106,7 +940,7 @@ module MetronomeSDK
|
|
1106
940
|
# @return [Array<Symbol>]
|
1107
941
|
end
|
1108
942
|
|
1109
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
943
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#external_status
|
1110
944
|
module ExternalStatus
|
1111
945
|
extend MetronomeSDK::Internal::Type::Enum
|
1112
946
|
|
@@ -1130,9 +964,8 @@ module MetronomeSDK
|
|
1130
964
|
class InvoiceAdjustment < MetronomeSDK::Internal::Type::BaseModel
|
1131
965
|
# @!attribute credit_type
|
1132
966
|
#
|
1133
|
-
# @return [MetronomeSDK::Models::
|
1134
|
-
required :credit_type,
|
1135
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::InvoiceAdjustment::CreditType }
|
967
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
968
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
1136
969
|
|
1137
970
|
# @!attribute name
|
1138
971
|
#
|
@@ -1155,31 +988,14 @@ module MetronomeSDK
|
|
1155
988
|
optional :credit_grant_id, String
|
1156
989
|
|
1157
990
|
# @!method initialize(credit_type:, name:, total:, credit_grant_custom_fields: nil, credit_grant_id: nil)
|
1158
|
-
# @param credit_type [MetronomeSDK::Models::
|
991
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
1159
992
|
# @param name [String]
|
1160
993
|
# @param total [Float]
|
1161
994
|
# @param credit_grant_custom_fields [Hash{Symbol=>String}]
|
1162
995
|
# @param credit_grant_id [String]
|
1163
|
-
|
1164
|
-
# @see MetronomeSDK::Models::V1::Customers::InvoiceListResponse::InvoiceAdjustment#credit_type
|
1165
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
1166
|
-
# @!attribute id
|
1167
|
-
#
|
1168
|
-
# @return [String]
|
1169
|
-
required :id, String
|
1170
|
-
|
1171
|
-
# @!attribute name
|
1172
|
-
#
|
1173
|
-
# @return [String]
|
1174
|
-
required :name, String
|
1175
|
-
|
1176
|
-
# @!method initialize(id:, name:)
|
1177
|
-
# @param id [String]
|
1178
|
-
# @param name [String]
|
1179
|
-
end
|
1180
996
|
end
|
1181
997
|
|
1182
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
998
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice#reseller_royalty
|
1183
999
|
class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
|
1184
1000
|
# @!attribute fraction
|
1185
1001
|
#
|
@@ -1193,32 +1009,32 @@ module MetronomeSDK
|
|
1193
1009
|
|
1194
1010
|
# @!attribute reseller_type
|
1195
1011
|
#
|
1196
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Customers::
|
1012
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::ResellerType]
|
1197
1013
|
required :reseller_type,
|
1198
|
-
enum: -> {
|
1014
|
+
enum: -> {
|
1015
|
+
MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::ResellerType
|
1016
|
+
}
|
1199
1017
|
|
1200
1018
|
# @!attribute aws_options
|
1201
1019
|
#
|
1202
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
1203
|
-
optional :aws_options,
|
1204
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::ResellerRoyalty::AwsOptions }
|
1020
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::AwsOptions, nil]
|
1021
|
+
optional :aws_options, -> { MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::AwsOptions }
|
1205
1022
|
|
1206
1023
|
# @!attribute gcp_options
|
1207
1024
|
#
|
1208
|
-
# @return [MetronomeSDK::Models::V1::Customers::
|
1209
|
-
optional :gcp_options,
|
1210
|
-
-> { MetronomeSDK::Models::V1::Customers::InvoiceListResponse::ResellerRoyalty::GcpOptions }
|
1025
|
+
# @return [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::GcpOptions, nil]
|
1026
|
+
optional :gcp_options, -> { MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::GcpOptions }
|
1211
1027
|
|
1212
1028
|
# @!method initialize(fraction:, netsuite_reseller_id:, reseller_type:, aws_options: nil, gcp_options: nil)
|
1213
1029
|
# Only present for contract invoices with reseller royalties.
|
1214
1030
|
#
|
1215
1031
|
# @param fraction [String]
|
1216
1032
|
# @param netsuite_reseller_id [String]
|
1217
|
-
# @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::
|
1218
|
-
# @param aws_options [MetronomeSDK::Models::V1::Customers::
|
1219
|
-
# @param gcp_options [MetronomeSDK::Models::V1::Customers::
|
1033
|
+
# @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::ResellerType]
|
1034
|
+
# @param aws_options [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::AwsOptions]
|
1035
|
+
# @param gcp_options [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty::GcpOptions]
|
1220
1036
|
|
1221
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
1037
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty#reseller_type
|
1222
1038
|
module ResellerType
|
1223
1039
|
extend MetronomeSDK::Internal::Type::Enum
|
1224
1040
|
|
@@ -1231,7 +1047,7 @@ module MetronomeSDK
|
|
1231
1047
|
# @return [Array<Symbol>]
|
1232
1048
|
end
|
1233
1049
|
|
1234
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
1050
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty#aws_options
|
1235
1051
|
class AwsOptions < MetronomeSDK::Internal::Type::BaseModel
|
1236
1052
|
# @!attribute aws_account_number
|
1237
1053
|
#
|
@@ -1254,7 +1070,7 @@ module MetronomeSDK
|
|
1254
1070
|
# @param aws_payer_reference_id [String]
|
1255
1071
|
end
|
1256
1072
|
|
1257
|
-
# @see MetronomeSDK::Models::V1::Customers::
|
1073
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty#gcp_options
|
1258
1074
|
class GcpOptions < MetronomeSDK::Internal::Type::BaseModel
|
1259
1075
|
# @!attribute gcp_account_id
|
1260
1076
|
#
|