orb-billing 0.1.0.pre.alpha.33
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 +7 -0
- data/README.md +169 -0
- data/lib/orb/client.rb +129 -0
- data/lib/orb/errors.rb +317 -0
- data/lib/orb/models/alert.rb +225 -0
- data/lib/orb/models/alert_create_for_customer_params.rb +77 -0
- data/lib/orb/models/alert_create_for_external_customer_params.rb +77 -0
- data/lib/orb/models/alert_create_for_subscription_params.rb +74 -0
- data/lib/orb/models/alert_disable_params.rb +26 -0
- data/lib/orb/models/alert_enable_params.rb +26 -0
- data/lib/orb/models/alert_list_params.rb +97 -0
- data/lib/orb/models/alert_retrieve_params.rb +19 -0
- data/lib/orb/models/alert_update_params.rb +46 -0
- data/lib/orb/models/amount_discount.rb +53 -0
- data/lib/orb/models/billable_metric.rb +76 -0
- data/lib/orb/models/billing_cycle_relative_date.rb +18 -0
- data/lib/orb/models/coupon.rb +86 -0
- data/lib/orb/models/coupon_archive_params.rb +19 -0
- data/lib/orb/models/coupon_create_params.rb +102 -0
- data/lib/orb/models/coupon_fetch_params.rb +19 -0
- data/lib/orb/models/coupon_list_params.rb +53 -0
- data/lib/orb/models/coupons/subscription_list_params.rb +40 -0
- data/lib/orb/models/credit_note.rb +522 -0
- data/lib/orb/models/credit_note_create_params.rb +77 -0
- data/lib/orb/models/credit_note_fetch_params.rb +19 -0
- data/lib/orb/models/credit_note_list_params.rb +73 -0
- data/lib/orb/models/customer.rb +872 -0
- data/lib/orb/models/customer_create_params.rb +843 -0
- data/lib/orb/models/customer_delete_params.rb +19 -0
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +19 -0
- data/lib/orb/models/customer_fetch_params.rb +19 -0
- data/lib/orb/models/customer_list_params.rb +73 -0
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +19 -0
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +19 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +848 -0
- data/lib/orb/models/customer_update_params.rb +838 -0
- data/lib/orb/models/customers/balance_transaction_create_params.rb +53 -0
- data/lib/orb/models/customers/balance_transaction_create_response.rb +167 -0
- data/lib/orb/models/customers/balance_transaction_list_params.rb +75 -0
- data/lib/orb/models/customers/balance_transaction_list_response.rb +167 -0
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +69 -0
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +106 -0
- data/lib/orb/models/customers/cost_list_params.rb +69 -0
- data/lib/orb/models/customers/cost_list_response.rb +106 -0
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +59 -0
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +72 -0
- data/lib/orb/models/customers/credit_list_params.rb +59 -0
- data/lib/orb/models/customers/credit_list_response.rb +72 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +215 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +1311 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +214 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +1310 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +141 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +1310 -0
- data/lib/orb/models/customers/credits/ledger_list_params.rb +141 -0
- data/lib/orb/models/customers/credits/ledger_list_response.rb +1306 -0
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +159 -0
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +154 -0
- data/lib/orb/models/customers/credits/top_up_create_params.rb +158 -0
- data/lib/orb/models/customers/credits/top_up_create_response.rb +153 -0
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +29 -0
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +29 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +42 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +154 -0
- data/lib/orb/models/customers/credits/top_up_list_params.rb +42 -0
- data/lib/orb/models/customers/credits/top_up_list_response.rb +153 -0
- data/lib/orb/models/dimensional_price_group.rb +64 -0
- data/lib/orb/models/dimensional_price_group_create_params.rb +63 -0
- data/lib/orb/models/dimensional_price_group_list_params.rb +38 -0
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +19 -0
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +21 -0
- data/lib/orb/models/dimensional_price_groups.rb +25 -0
- data/lib/orb/models/discount.rb +23 -0
- data/lib/orb/models/evaluate_price_group.rb +48 -0
- data/lib/orb/models/event_deprecate_params.rb +19 -0
- data/lib/orb/models/event_deprecate_response.rb +21 -0
- data/lib/orb/models/event_ingest_params.rb +100 -0
- data/lib/orb/models/event_ingest_response.rb +77 -0
- data/lib/orb/models/event_search_params.rb +45 -0
- data/lib/orb/models/event_search_response.rb +87 -0
- data/lib/orb/models/event_update_params.rb +58 -0
- data/lib/orb/models/event_update_response.rb +21 -0
- data/lib/orb/models/events/backfill_close_params.rb +21 -0
- data/lib/orb/models/events/backfill_close_response.rb +131 -0
- data/lib/orb/models/events/backfill_create_params.rb +97 -0
- data/lib/orb/models/events/backfill_create_response.rb +131 -0
- data/lib/orb/models/events/backfill_fetch_params.rb +21 -0
- data/lib/orb/models/events/backfill_fetch_response.rb +131 -0
- data/lib/orb/models/events/backfill_list_params.rb +40 -0
- data/lib/orb/models/events/backfill_list_response.rb +131 -0
- data/lib/orb/models/events/backfill_revert_params.rb +21 -0
- data/lib/orb/models/events/backfill_revert_response.rb +131 -0
- data/lib/orb/models/events/event_volumes.rb +54 -0
- data/lib/orb/models/events/volume_list_params.rb +64 -0
- data/lib/orb/models/invoice.rb +2218 -0
- data/lib/orb/models/invoice_create_params.rb +200 -0
- data/lib/orb/models/invoice_fetch_params.rb +19 -0
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +25 -0
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +2226 -0
- data/lib/orb/models/invoice_issue_params.rb +34 -0
- data/lib/orb/models/invoice_level_discount.rb +21 -0
- data/lib/orb/models/invoice_line_item_create_params.rb +62 -0
- data/lib/orb/models/invoice_line_item_create_response.rb +929 -0
- data/lib/orb/models/invoice_list_params.rb +197 -0
- data/lib/orb/models/invoice_mark_paid_params.rb +40 -0
- data/lib/orb/models/invoice_pay_params.rb +19 -0
- data/lib/orb/models/invoice_update_params.rb +28 -0
- data/lib/orb/models/invoice_void_params.rb +19 -0
- data/lib/orb/models/item.rb +82 -0
- data/lib/orb/models/item_create_params.rb +26 -0
- data/lib/orb/models/item_fetch_params.rb +19 -0
- data/lib/orb/models/item_list_params.rb +38 -0
- data/lib/orb/models/item_update_params.rb +73 -0
- data/lib/orb/models/metric_create_params.rb +56 -0
- data/lib/orb/models/metric_fetch_params.rb +19 -0
- data/lib/orb/models/metric_list_params.rb +73 -0
- data/lib/orb/models/metric_update_params.rb +28 -0
- data/lib/orb/models/pagination_metadata.rb +25 -0
- data/lib/orb/models/percentage_discount.rb +54 -0
- data/lib/orb/models/plan.rb +894 -0
- data/lib/orb/models/plan_create_params.rb +6702 -0
- data/lib/orb/models/plan_fetch_params.rb +19 -0
- data/lib/orb/models/plan_list_params.rb +100 -0
- data/lib/orb/models/plan_update_params.rb +37 -0
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +21 -0
- data/lib/orb/models/plans/external_plan_id_update_params.rb +39 -0
- data/lib/orb/models/price.rb +12229 -0
- data/lib/orb/models/price_create_params.rb +808 -0
- data/lib/orb/models/price_evaluate_params.rb +80 -0
- data/lib/orb/models/price_evaluate_response.rb +20 -0
- data/lib/orb/models/price_fetch_params.rb +19 -0
- data/lib/orb/models/price_list_params.rb +38 -0
- data/lib/orb/models/price_update_params.rb +28 -0
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +21 -0
- data/lib/orb/models/prices/external_price_id_update_params.rb +30 -0
- data/lib/orb/models/subscription.rb +1233 -0
- data/lib/orb/models/subscription_cancel_params.rb +58 -0
- data/lib/orb/models/subscription_cancel_response.rb +1217 -0
- data/lib/orb/models/subscription_create_params.rb +15065 -0
- data/lib/orb/models/subscription_create_response.rb +1217 -0
- data/lib/orb/models/subscription_fetch_costs_params.rb +67 -0
- data/lib/orb/models/subscription_fetch_costs_response.rb +104 -0
- data/lib/orb/models/subscription_fetch_params.rb +19 -0
- data/lib/orb/models/subscription_fetch_schedule_params.rb +73 -0
- data/lib/orb/models/subscription_fetch_schedule_response.rb +68 -0
- data/lib/orb/models/subscription_fetch_usage_params.rb +135 -0
- data/lib/orb/models/subscription_list_params.rb +108 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +8358 -0
- data/lib/orb/models/subscription_price_intervals_response.rb +1224 -0
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +15088 -0
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +1224 -0
- data/lib/orb/models/subscription_trigger_phase_params.rb +36 -0
- data/lib/orb/models/subscription_trigger_phase_response.rb +1224 -0
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +19 -0
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +1224 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +26 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +1228 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +19 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +1224 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +90 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +1224 -0
- data/lib/orb/models/subscription_update_params.rb +74 -0
- data/lib/orb/models/subscription_update_trial_params.rb +59 -0
- data/lib/orb/models/subscription_update_trial_response.rb +1222 -0
- data/lib/orb/models/subscription_usage.rb +258 -0
- data/lib/orb/models/subscriptions.rb +25 -0
- data/lib/orb/models/top_level_ping_params.rb +19 -0
- data/lib/orb/models/top_level_ping_response.rb +20 -0
- data/lib/orb/models/trial_discount.rb +69 -0
- data/lib/orb/models/usage_discount.rb +54 -0
- data/lib/orb/page.rb +114 -0
- data/lib/orb/request_options.rb +75 -0
- data/lib/orb/resources/alerts.rb +239 -0
- data/lib/orb/resources/coupons/subscriptions.rb +43 -0
- data/lib/orb/resources/coupons.rb +115 -0
- data/lib/orb/resources/credit_notes.rb +87 -0
- data/lib/orb/resources/customers/balance_transactions.rb +96 -0
- data/lib/orb/resources/customers/costs.rb +298 -0
- data/lib/orb/resources/customers/credits/ledger.rb +527 -0
- data/lib/orb/resources/customers/credits/top_ups.rb +192 -0
- data/lib/orb/resources/customers/credits.rb +88 -0
- data/lib/orb/resources/customers.rb +321 -0
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +38 -0
- data/lib/orb/resources/dimensional_price_groups.rb +93 -0
- data/lib/orb/resources/events/backfills.rb +174 -0
- data/lib/orb/resources/events/volume.rb +52 -0
- data/lib/orb/resources/events.rb +415 -0
- data/lib/orb/resources/invoice_line_items.rb +41 -0
- data/lib/orb/resources/invoices.rb +266 -0
- data/lib/orb/resources/items.rb +95 -0
- data/lib/orb/resources/metrics.rb +114 -0
- data/lib/orb/resources/plans/external_plan_id.rb +76 -0
- data/lib/orb/resources/plans.rb +133 -0
- data/lib/orb/resources/prices/external_price_id.rb +61 -0
- data/lib/orb/resources/prices.rb +197 -0
- data/lib/orb/resources/subscriptions.rb +1278 -0
- data/lib/orb/resources/top_level.rb +37 -0
- data/lib/orb/transport/base_client.rb +459 -0
- data/lib/orb/transport/pooled_net_requester.rb +182 -0
- data/lib/orb/type/array_of.rb +112 -0
- data/lib/orb/type/base_model.rb +367 -0
- data/lib/orb/type/base_page.rb +61 -0
- data/lib/orb/type/boolean_model.rb +52 -0
- data/lib/orb/type/converter.rb +217 -0
- data/lib/orb/type/enum.rb +101 -0
- data/lib/orb/type/hash_of.rb +132 -0
- data/lib/orb/type/request_parameters.rb +38 -0
- data/lib/orb/type/union.rb +225 -0
- data/lib/orb/type/unknown.rb +56 -0
- data/lib/orb/type.rb +23 -0
- data/lib/orb/util.rb +722 -0
- data/lib/orb/version.rb +5 -0
- data/lib/orb.rb +247 -0
- data/manifest.yaml +15 -0
- data/rbi/lib/orb/client.rbi +90 -0
- data/rbi/lib/orb/errors.rbi +246 -0
- data/rbi/lib/orb/models/alert.rbi +239 -0
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +86 -0
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +88 -0
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +83 -0
- data/rbi/lib/orb/models/alert_disable_params.rbi +28 -0
- data/rbi/lib/orb/models/alert_enable_params.rbi +28 -0
- data/rbi/lib/orb/models/alert_list_params.rbi +95 -0
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +20 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +51 -0
- data/rbi/lib/orb/models/amount_discount.rbi +62 -0
- data/rbi/lib/orb/models/billable_metric.rbi +83 -0
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +19 -0
- data/rbi/lib/orb/models/coupon.rbi +90 -0
- data/rbi/lib/orb/models/coupon_archive_params.rbi +20 -0
- data/rbi/lib/orb/models/coupon_create_params.rbi +120 -0
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/coupon_list_params.rbi +59 -0
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +41 -0
- data/rbi/lib/orb/models/credit_note.rbi +546 -0
- data/rbi/lib/orb/models/credit_note_create_params.rbi +84 -0
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/credit_note_list_params.rbi +74 -0
- data/rbi/lib/orb/models/customer.rbi +941 -0
- data/rbi/lib/orb/models/customer_create_params.rbi +923 -0
- data/rbi/lib/orb/models/customer_delete_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_list_params.rbi +74 -0
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +945 -0
- data/rbi/lib/orb/models/customer_update_params.rbi +919 -0
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +199 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +76 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +191 -0
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +86 -0
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +214 -0
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +84 -0
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +212 -0
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +87 -0
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +86 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +270 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +1670 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +238 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +1626 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +181 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +1654 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +144 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +1588 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +196 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +198 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +176 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +175 -0
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +31 -0
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +28 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +49 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +188 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +49 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +168 -0
- data/rbi/lib/orb/models/dimensional_price_group.rbi +75 -0
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +66 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +39 -0
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +20 -0
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +22 -0
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +35 -0
- data/rbi/lib/orb/models/discount.rbi +18 -0
- data/rbi/lib/orb/models/evaluate_price_group.rbi +45 -0
- data/rbi/lib/orb/models/event_deprecate_params.rbi +20 -0
- data/rbi/lib/orb/models/event_deprecate_response.rbi +19 -0
- data/rbi/lib/orb/models/event_ingest_params.rbi +120 -0
- data/rbi/lib/orb/models/event_ingest_response.rbi +79 -0
- data/rbi/lib/orb/models/event_search_params.rbi +53 -0
- data/rbi/lib/orb/models/event_search_response.rbi +100 -0
- data/rbi/lib/orb/models/event_update_params.rbi +71 -0
- data/rbi/lib/orb/models/event_update_response.rbi +19 -0
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +97 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +128 -0
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +41 -0
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +128 -0
- data/rbi/lib/orb/models/events/event_volumes.rbi +47 -0
- data/rbi/lib/orb/models/events/volume_list_params.rbi +69 -0
- data/rbi/lib/orb/models/invoice.rbi +2466 -0
- data/rbi/lib/orb/models/invoice_create_params.rbi +230 -0
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +24 -0
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +2646 -0
- data/rbi/lib/orb/models/invoice_issue_params.rbi +32 -0
- data/rbi/lib/orb/models/invoice_level_discount.rbi +16 -0
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +67 -0
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +1164 -0
- data/rbi/lib/orb/models/invoice_list_params.rbi +187 -0
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +48 -0
- data/rbi/lib/orb/models/invoice_pay_params.rbi +20 -0
- data/rbi/lib/orb/models/invoice_update_params.rbi +36 -0
- data/rbi/lib/orb/models/invoice_void_params.rbi +20 -0
- data/rbi/lib/orb/models/item.rbi +101 -0
- data/rbi/lib/orb/models/item_create_params.rbi +25 -0
- data/rbi/lib/orb/models/item_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/item_list_params.rbi +39 -0
- data/rbi/lib/orb/models/item_update_params.rbi +113 -0
- data/rbi/lib/orb/models/metric_create_params.rbi +62 -0
- data/rbi/lib/orb/models/metric_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/metric_list_params.rbi +74 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +36 -0
- data/rbi/lib/orb/models/pagination_metadata.rbi +21 -0
- data/rbi/lib/orb/models/percentage_discount.rbi +63 -0
- data/rbi/lib/orb/models/plan.rbi +1071 -0
- data/rbi/lib/orb/models/plan_create_params.rbi +10069 -0
- data/rbi/lib/orb/models/plan_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/plan_list_params.rbi +100 -0
- data/rbi/lib/orb/models/plan_update_params.rbi +46 -0
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +48 -0
- data/rbi/lib/orb/models/price.rbi +15341 -0
- data/rbi/lib/orb/models/price_create_params.rbi +885 -0
- data/rbi/lib/orb/models/price_evaluate_params.rbi +81 -0
- data/rbi/lib/orb/models/price_evaluate_response.rbi +21 -0
- data/rbi/lib/orb/models/price_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/price_list_params.rbi +39 -0
- data/rbi/lib/orb/models/price_update_params.rbi +36 -0
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +38 -0
- data/rbi/lib/orb/models/subscription.rbi +1381 -0
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +75 -0
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +1374 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +23422 -0
- data/rbi/lib/orb/models/subscription_create_response.rbi +1374 -0
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +82 -0
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +210 -0
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +74 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +81 -0
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +137 -0
- data/rbi/lib/orb/models/subscription_list_params.rbi +108 -0
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +12991 -0
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +1387 -0
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +23589 -0
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +1390 -0
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +45 -0
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +1381 -0
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +1400 -0
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +25 -0
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1451 -0
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1410 -0
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +104 -0
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1400 -0
- data/rbi/lib/orb/models/subscription_update_params.rbi +77 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +63 -0
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +1378 -0
- data/rbi/lib/orb/models/subscription_usage.rbi +323 -0
- data/rbi/lib/orb/models/subscriptions.rbi +33 -0
- data/rbi/lib/orb/models/top_level_ping_params.rbi +20 -0
- data/rbi/lib/orb/models/top_level_ping_response.rbi +18 -0
- data/rbi/lib/orb/models/trial_discount.rbi +73 -0
- data/rbi/lib/orb/models/usage_discount.rbi +62 -0
- data/rbi/lib/orb/page.rbi +35 -0
- data/rbi/lib/orb/request_options.rbi +48 -0
- data/rbi/lib/orb/resources/alerts.rbi +216 -0
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +38 -0
- data/rbi/lib/orb/resources/coupons.rbi +96 -0
- data/rbi/lib/orb/resources/credit_notes.rbi +74 -0
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +92 -0
- data/rbi/lib/orb/resources/customers/costs.rbi +304 -0
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +645 -0
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +180 -0
- data/rbi/lib/orb/resources/customers/credits.rbi +88 -0
- data/rbi/lib/orb/resources/customers.rbi +714 -0
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +25 -0
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +78 -0
- data/rbi/lib/orb/resources/events/backfills.rbi +161 -0
- data/rbi/lib/orb/resources/events/volume.rbi +57 -0
- data/rbi/lib/orb/resources/events.rbi +408 -0
- data/rbi/lib/orb/resources/invoice_line_items.rbi +44 -0
- data/rbi/lib/orb/resources/invoices.rbi +262 -0
- data/rbi/lib/orb/resources/items.rbi +65 -0
- data/rbi/lib/orb/resources/metrics.rbi +102 -0
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +67 -0
- data/rbi/lib/orb/resources/plans.rbi +170 -0
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +110 -0
- data/rbi/lib/orb/resources/prices.rbi +371 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +1469 -0
- data/rbi/lib/orb/resources/top_level.rbi +25 -0
- data/rbi/lib/orb/transport/base_client.rbi +205 -0
- data/rbi/lib/orb/transport/pooled_net_requester.rbi +64 -0
- data/rbi/lib/orb/type/array_of.rbi +82 -0
- data/rbi/lib/orb/type/base_model.rbi +197 -0
- data/rbi/lib/orb/type/base_page.rbi +38 -0
- data/rbi/lib/orb/type/boolean_model.rbi +41 -0
- data/rbi/lib/orb/type/converter.rbi +95 -0
- data/rbi/lib/orb/type/enum.rbi +58 -0
- data/rbi/lib/orb/type/hash_of.rbi +86 -0
- data/rbi/lib/orb/type/request_parameters.rbi +20 -0
- data/rbi/lib/orb/type/union.rbi +66 -0
- data/rbi/lib/orb/type/unknown.rbi +37 -0
- data/rbi/lib/orb/type.rbi +23 -0
- data/rbi/lib/orb/util.rbi +278 -0
- data/rbi/lib/orb/version.rbi +5 -0
- data/sig/orb/client.rbs +53 -0
- data/sig/orb/errors.rbs +201 -0
- data/sig/orb/models/alert.rbs +142 -0
- data/sig/orb/models/alert_create_for_customer_params.rbs +56 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +56 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +52 -0
- data/sig/orb/models/alert_disable_params.rbs +20 -0
- data/sig/orb/models/alert_enable_params.rbs +20 -0
- data/sig/orb/models/alert_list_params.rbs +57 -0
- data/sig/orb/models/alert_retrieve_params.rbs +14 -0
- data/sig/orb/models/alert_update_params.rbs +31 -0
- data/sig/orb/models/amount_discount.rbs +40 -0
- data/sig/orb/models/billable_metric.rbs +50 -0
- data/sig/orb/models/billing_cycle_relative_date.rbs +14 -0
- data/sig/orb/models/coupon.rbs +51 -0
- data/sig/orb/models/coupon_archive_params.rbs +14 -0
- data/sig/orb/models/coupon_create_params.rbs +77 -0
- data/sig/orb/models/coupon_fetch_params.rbs +14 -0
- data/sig/orb/models/coupon_list_params.rbs +37 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +27 -0
- data/sig/orb/models/credit_note.rbs +345 -0
- data/sig/orb/models/credit_note_create_params.rbs +57 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +14 -0
- data/sig/orb/models/credit_note_list_params.rbs +45 -0
- data/sig/orb/models/customer.rbs +628 -0
- data/sig/orb/models/customer_create_params.rbs +624 -0
- data/sig/orb/models/customer_delete_params.rbs +14 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customer_fetch_params.rbs +14 -0
- data/sig/orb/models/customer_list_params.rbs +45 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +15 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +15 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +620 -0
- data/sig/orb/models/customer_update_params.rbs +620 -0
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +44 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +114 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +47 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +114 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +48 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +82 -0
- data/sig/orb/models/customers/cost_list_params.rbs +48 -0
- data/sig/orb/models/customers/cost_list_response.rbs +80 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +41 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +55 -0
- data/sig/orb/models/customers/credit_list_params.rbs +41 -0
- data/sig/orb/models/customers/credit_list_response.rbs +55 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +120 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +120 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +99 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +99 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +814 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +95 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +95 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +24 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +24 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +29 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +29 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +90 -0
- data/sig/orb/models/dimensional_price_group.rbs +38 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +39 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +25 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +15 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +17 -0
- data/sig/orb/models/dimensional_price_groups.rbs +22 -0
- data/sig/orb/models/discount.rbs +15 -0
- data/sig/orb/models/evaluate_price_group.rbs +34 -0
- data/sig/orb/models/event_deprecate_params.rbs +14 -0
- data/sig/orb/models/event_deprecate_response.rbs +13 -0
- data/sig/orb/models/event_ingest_params.rbs +68 -0
- data/sig/orb/models/event_ingest_response.rbs +53 -0
- data/sig/orb/models/event_search_params.rbs +31 -0
- data/sig/orb/models/event_search_response.rbs +55 -0
- data/sig/orb/models/event_update_params.rbs +39 -0
- data/sig/orb/models/event_update_response.rbs +13 -0
- data/sig/orb/models/events/backfill_close_params.rbs +16 -0
- data/sig/orb/models/events/backfill_close_response.rbs +73 -0
- data/sig/orb/models/events/backfill_create_params.rbs +51 -0
- data/sig/orb/models/events/backfill_create_response.rbs +73 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +16 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +73 -0
- data/sig/orb/models/events/backfill_list_params.rbs +27 -0
- data/sig/orb/models/events/backfill_list_response.rbs +73 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +16 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +73 -0
- data/sig/orb/models/events/event_volumes.rbs +39 -0
- data/sig/orb/models/events/volume_list_params.rbs +41 -0
- data/sig/orb/models/invoice.rbs +1430 -0
- data/sig/orb/models/invoice_create_params.rbs +120 -0
- data/sig/orb/models/invoice_fetch_params.rbs +14 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +20 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +1430 -0
- data/sig/orb/models/invoice_issue_params.rbs +21 -0
- data/sig/orb/models/invoice_level_discount.rbs +14 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +43 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +546 -0
- data/sig/orb/models/invoice_list_params.rbs +122 -0
- data/sig/orb/models/invoice_mark_paid_params.rbs +27 -0
- data/sig/orb/models/invoice_pay_params.rbs +14 -0
- data/sig/orb/models/invoice_update_params.rbs +20 -0
- data/sig/orb/models/invoice_void_params.rbs +14 -0
- data/sig/orb/models/item.rbs +72 -0
- data/sig/orb/models/item_create_params.rbs +19 -0
- data/sig/orb/models/item_fetch_params.rbs +14 -0
- data/sig/orb/models/item_list_params.rbs +25 -0
- data/sig/orb/models/item_update_params.rbs +69 -0
- data/sig/orb/models/metric_create_params.rbs +39 -0
- data/sig/orb/models/metric_fetch_params.rbs +14 -0
- data/sig/orb/models/metric_list_params.rbs +45 -0
- data/sig/orb/models/metric_update_params.rbs +20 -0
- data/sig/orb/models/pagination_metadata.rbs +15 -0
- data/sig/orb/models/percentage_discount.rbs +40 -0
- data/sig/orb/models/plan.rbs +529 -0
- data/sig/orb/models/plan_create_params.rbs +3991 -0
- data/sig/orb/models/plan_fetch_params.rbs +14 -0
- data/sig/orb/models/plan_list_params.rbs +65 -0
- data/sig/orb/models/plan_update_params.rbs +24 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +16 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +26 -0
- data/sig/orb/models/price.rbs +8108 -0
- data/sig/orb/models/price_create_params.rbs +520 -0
- data/sig/orb/models/price_evaluate_params.rbs +45 -0
- data/sig/orb/models/price_evaluate_response.rbs +14 -0
- data/sig/orb/models/price_fetch_params.rbs +14 -0
- data/sig/orb/models/price_list_params.rbs +25 -0
- data/sig/orb/models/price_update_params.rbs +20 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +16 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +22 -0
- data/sig/orb/models/subscription.rbs +687 -0
- data/sig/orb/models/subscription_cancel_params.rbs +44 -0
- data/sig/orb/models/subscription_cancel_response.rbs +687 -0
- data/sig/orb/models/subscription_create_params.rbs +9141 -0
- data/sig/orb/models/subscription_create_response.rbs +687 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +46 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +78 -0
- data/sig/orb/models/subscription_fetch_params.rbs +14 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +45 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +48 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +80 -0
- data/sig/orb/models/subscription_list_params.rbs +69 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +5117 -0
- data/sig/orb/models/subscription_price_intervals_response.rbs +687 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +9133 -0
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +687 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +24 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +15 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +20 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +15 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +687 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +55 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +687 -0
- data/sig/orb/models/subscription_update_params.rbs +39 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +39 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +687 -0
- data/sig/orb/models/subscription_usage.rbs +196 -0
- data/sig/orb/models/subscriptions.rbs +22 -0
- data/sig/orb/models/top_level_ping_params.rbs +14 -0
- data/sig/orb/models/top_level_ping_response.rbs +13 -0
- data/sig/orb/models/trial_discount.rbs +44 -0
- data/sig/orb/models/usage_discount.rbs +40 -0
- data/sig/orb/page.rbs +22 -0
- data/sig/orb/request_options.rbs +32 -0
- data/sig/orb/resources/alerts.rbs +67 -0
- data/sig/orb/resources/coupons/subscriptions.rbs +16 -0
- data/sig/orb/resources/coupons.rbs +35 -0
- data/sig/orb/resources/credit_notes.rbs +29 -0
- data/sig/orb/resources/customers/balance_transactions.rbs +28 -0
- data/sig/orb/resources/customers/costs.rbs +27 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +75 -0
- data/sig/orb/resources/customers/credits/top_ups.rbs +63 -0
- data/sig/orb/resources/customers/credits.rbs +31 -0
- data/sig/orb/resources/customers.rbs +114 -0
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +14 -0
- data/sig/orb/resources/dimensional_price_groups.rbs +29 -0
- data/sig/orb/resources/events/backfills.rbs +41 -0
- data/sig/orb/resources/events/volume.rbs +17 -0
- data/sig/orb/resources/events.rbs +40 -0
- data/sig/orb/resources/invoice_line_items.rbs +17 -0
- data/sig/orb/resources/invoices.rbs +84 -0
- data/sig/orb/resources/items.rbs +30 -0
- data/sig/orb/resources/metrics.rbs +37 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +21 -0
- data/sig/orb/resources/plans.rbs +44 -0
- data/sig/orb/resources/prices/external_price_id.rbs +20 -0
- data/sig/orb/resources/prices.rbs +83 -0
- data/sig/orb/resources/subscriptions.rbs +194 -0
- data/sig/orb/resources/top_level.rbs +11 -0
- data/sig/orb/transport/base_client.rbs +110 -0
- data/sig/orb/transport/pooled_net_requester.rbs +39 -0
- data/sig/orb/type/array_of.rbs +36 -0
- data/sig/orb/type/base_model.rbs +77 -0
- data/sig/orb/type/base_page.rbs +22 -0
- data/sig/orb/type/boolean_model.rbs +18 -0
- data/sig/orb/type/converter.rbs +36 -0
- data/sig/orb/type/enum.rbs +22 -0
- data/sig/orb/type/hash_of.rbs +36 -0
- data/sig/orb/type/request_parameters.rbs +13 -0
- data/sig/orb/type/union.rbs +37 -0
- data/sig/orb/type/unknown.rbs +15 -0
- data/sig/orb/type.rbs +22 -0
- data/sig/orb/util.rbs +132 -0
- data/sig/orb/version.rbs +3 -0
- metadata +692 -0
@@ -0,0 +1,69 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
# @see Orb::Resources::Customers::Costs#list
|
7
|
+
class CostListParams < Orb::BaseModel
|
8
|
+
# @!parse
|
9
|
+
# extend Orb::Type::RequestParameters::Converter
|
10
|
+
include Orb::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute currency
|
13
|
+
# The currency or custom pricing unit to use.
|
14
|
+
#
|
15
|
+
# @return [String, nil]
|
16
|
+
optional :currency, String, nil?: true
|
17
|
+
|
18
|
+
# @!attribute timeframe_end
|
19
|
+
# Costs returned are exclusive of `timeframe_end`.
|
20
|
+
#
|
21
|
+
# @return [Time, nil]
|
22
|
+
optional :timeframe_end, Time, nil?: true
|
23
|
+
|
24
|
+
# @!attribute timeframe_start
|
25
|
+
# Costs returned are inclusive of `timeframe_start`.
|
26
|
+
#
|
27
|
+
# @return [Time, nil]
|
28
|
+
optional :timeframe_start, Time, nil?: true
|
29
|
+
|
30
|
+
# @!attribute view_mode
|
31
|
+
# Controls whether Orb returns cumulative costs since the start of the billing
|
32
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
33
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
34
|
+
# behavior.
|
35
|
+
#
|
36
|
+
# @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
|
37
|
+
optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true
|
38
|
+
|
39
|
+
# @!parse
|
40
|
+
# # @param currency [String, nil]
|
41
|
+
# # @param timeframe_end [Time, nil]
|
42
|
+
# # @param timeframe_start [Time, nil]
|
43
|
+
# # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
|
44
|
+
# # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
45
|
+
# #
|
46
|
+
# def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super
|
47
|
+
|
48
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
49
|
+
|
50
|
+
# Controls whether Orb returns cumulative costs since the start of the billing
|
51
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
52
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
53
|
+
# behavior.
|
54
|
+
module ViewMode
|
55
|
+
extend Orb::Enum
|
56
|
+
|
57
|
+
PERIODIC = :periodic
|
58
|
+
CUMULATIVE = :cumulative
|
59
|
+
|
60
|
+
finalize!
|
61
|
+
|
62
|
+
# @!parse
|
63
|
+
# # @return [Array<Symbol>]
|
64
|
+
# def self.values; end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
@@ -0,0 +1,106 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
# @see Orb::Resources::Customers::Costs#list
|
7
|
+
class CostListResponse < Orb::BaseModel
|
8
|
+
# @!attribute data
|
9
|
+
#
|
10
|
+
# @return [Array<Orb::Models::Customers::CostListResponse::Data>]
|
11
|
+
required :data, -> { Orb::ArrayOf[Orb::Models::Customers::CostListResponse::Data] }
|
12
|
+
|
13
|
+
# @!parse
|
14
|
+
# # @param data [Array<Orb::Models::Customers::CostListResponse::Data>]
|
15
|
+
# #
|
16
|
+
# def initialize(data:, **) = super
|
17
|
+
|
18
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
19
|
+
|
20
|
+
class Data < Orb::BaseModel
|
21
|
+
# @!attribute per_price_costs
|
22
|
+
#
|
23
|
+
# @return [Array<Orb::Models::Customers::CostListResponse::Data::PerPriceCost>]
|
24
|
+
required :per_price_costs,
|
25
|
+
-> { Orb::ArrayOf[Orb::Models::Customers::CostListResponse::Data::PerPriceCost] }
|
26
|
+
|
27
|
+
# @!attribute subtotal
|
28
|
+
# Total costs for the timeframe, excluding any minimums and discounts.
|
29
|
+
#
|
30
|
+
# @return [String]
|
31
|
+
required :subtotal, String
|
32
|
+
|
33
|
+
# @!attribute timeframe_end
|
34
|
+
#
|
35
|
+
# @return [Time]
|
36
|
+
required :timeframe_end, Time
|
37
|
+
|
38
|
+
# @!attribute timeframe_start
|
39
|
+
#
|
40
|
+
# @return [Time]
|
41
|
+
required :timeframe_start, Time
|
42
|
+
|
43
|
+
# @!attribute total
|
44
|
+
# Total costs for the timeframe, including any minimums and discounts.
|
45
|
+
#
|
46
|
+
# @return [String]
|
47
|
+
required :total, String
|
48
|
+
|
49
|
+
# @!parse
|
50
|
+
# # @param per_price_costs [Array<Orb::Models::Customers::CostListResponse::Data::PerPriceCost>]
|
51
|
+
# # @param subtotal [String]
|
52
|
+
# # @param timeframe_end [Time]
|
53
|
+
# # @param timeframe_start [Time]
|
54
|
+
# # @param total [String]
|
55
|
+
# #
|
56
|
+
# def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super
|
57
|
+
|
58
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
59
|
+
|
60
|
+
class PerPriceCost < Orb::BaseModel
|
61
|
+
# @!attribute price
|
62
|
+
# The price object
|
63
|
+
#
|
64
|
+
# @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
|
65
|
+
required :price, union: -> { Orb::Models::Price }
|
66
|
+
|
67
|
+
# @!attribute price_id
|
68
|
+
# The price the cost is associated with
|
69
|
+
#
|
70
|
+
# @return [String]
|
71
|
+
required :price_id, String
|
72
|
+
|
73
|
+
# @!attribute subtotal
|
74
|
+
# Price's contributions for the timeframe, excluding any minimums and discounts.
|
75
|
+
#
|
76
|
+
# @return [String]
|
77
|
+
required :subtotal, String
|
78
|
+
|
79
|
+
# @!attribute total
|
80
|
+
# Price's contributions for the timeframe, including minimums and discounts.
|
81
|
+
#
|
82
|
+
# @return [String]
|
83
|
+
required :total, String
|
84
|
+
|
85
|
+
# @!attribute quantity
|
86
|
+
# The price's quantity for the timeframe
|
87
|
+
#
|
88
|
+
# @return [Float, nil]
|
89
|
+
optional :quantity, Float, nil?: true
|
90
|
+
|
91
|
+
# @!parse
|
92
|
+
# # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
|
93
|
+
# # @param price_id [String]
|
94
|
+
# # @param subtotal [String]
|
95
|
+
# # @param total [String]
|
96
|
+
# # @param quantity [Float, nil]
|
97
|
+
# #
|
98
|
+
# def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super
|
99
|
+
|
100
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
# @see Orb::Resources::Customers::Credits#list_by_external_id
|
7
|
+
class CreditListByExternalIDParams < Orb::BaseModel
|
8
|
+
# @!parse
|
9
|
+
# extend Orb::Type::RequestParameters::Converter
|
10
|
+
include Orb::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute currency
|
13
|
+
# The ledger currency or custom pricing unit to use.
|
14
|
+
#
|
15
|
+
# @return [String, nil]
|
16
|
+
optional :currency, String, nil?: true
|
17
|
+
|
18
|
+
# @!attribute cursor
|
19
|
+
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
20
|
+
# from the initial request.
|
21
|
+
#
|
22
|
+
# @return [String, nil]
|
23
|
+
optional :cursor, String, nil?: true
|
24
|
+
|
25
|
+
# @!attribute [r] include_all_blocks
|
26
|
+
# If set to True, all expired and depleted blocks, as well as active block will be
|
27
|
+
# returned.
|
28
|
+
#
|
29
|
+
# @return [Boolean, nil]
|
30
|
+
optional :include_all_blocks, Orb::BooleanModel
|
31
|
+
|
32
|
+
# @!parse
|
33
|
+
# # @return [Boolean]
|
34
|
+
# attr_writer :include_all_blocks
|
35
|
+
|
36
|
+
# @!attribute [r] limit
|
37
|
+
# The number of items to fetch. Defaults to 20.
|
38
|
+
#
|
39
|
+
# @return [Integer, nil]
|
40
|
+
optional :limit, Integer
|
41
|
+
|
42
|
+
# @!parse
|
43
|
+
# # @return [Integer]
|
44
|
+
# attr_writer :limit
|
45
|
+
|
46
|
+
# @!parse
|
47
|
+
# # @param currency [String, nil]
|
48
|
+
# # @param cursor [String, nil]
|
49
|
+
# # @param include_all_blocks [Boolean]
|
50
|
+
# # @param limit [Integer]
|
51
|
+
# # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
52
|
+
# #
|
53
|
+
# def initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}, **) = super
|
54
|
+
|
55
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
# @see Orb::Resources::Customers::Credits#list_by_external_id
|
7
|
+
class CreditListByExternalIDResponse < Orb::BaseModel
|
8
|
+
# @!attribute id
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute balance
|
14
|
+
#
|
15
|
+
# @return [Float]
|
16
|
+
required :balance, Float
|
17
|
+
|
18
|
+
# @!attribute effective_date
|
19
|
+
#
|
20
|
+
# @return [Time, nil]
|
21
|
+
required :effective_date, Time, nil?: true
|
22
|
+
|
23
|
+
# @!attribute expiry_date
|
24
|
+
#
|
25
|
+
# @return [Time, nil]
|
26
|
+
required :expiry_date, Time, nil?: true
|
27
|
+
|
28
|
+
# @!attribute maximum_initial_balance
|
29
|
+
#
|
30
|
+
# @return [Float, nil]
|
31
|
+
required :maximum_initial_balance, Float, nil?: true
|
32
|
+
|
33
|
+
# @!attribute per_unit_cost_basis
|
34
|
+
#
|
35
|
+
# @return [String, nil]
|
36
|
+
required :per_unit_cost_basis, String, nil?: true
|
37
|
+
|
38
|
+
# @!attribute status
|
39
|
+
#
|
40
|
+
# @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
|
41
|
+
required :status, enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::Status }
|
42
|
+
|
43
|
+
# @!parse
|
44
|
+
# # @param id [String]
|
45
|
+
# # @param balance [Float]
|
46
|
+
# # @param effective_date [Time, nil]
|
47
|
+
# # @param expiry_date [Time, nil]
|
48
|
+
# # @param maximum_initial_balance [Float, nil]
|
49
|
+
# # @param per_unit_cost_basis [String, nil]
|
50
|
+
# # @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
|
51
|
+
# #
|
52
|
+
# def initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:, **) = super
|
53
|
+
|
54
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
55
|
+
|
56
|
+
# @see Orb::Models::Customers::CreditListByExternalIDResponse#status
|
57
|
+
module Status
|
58
|
+
extend Orb::Enum
|
59
|
+
|
60
|
+
ACTIVE = :active
|
61
|
+
PENDING_PAYMENT = :pending_payment
|
62
|
+
|
63
|
+
finalize!
|
64
|
+
|
65
|
+
# @!parse
|
66
|
+
# # @return [Array<Symbol>]
|
67
|
+
# def self.values; end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
# @see Orb::Resources::Customers::Credits#list
|
7
|
+
class CreditListParams < Orb::BaseModel
|
8
|
+
# @!parse
|
9
|
+
# extend Orb::Type::RequestParameters::Converter
|
10
|
+
include Orb::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute currency
|
13
|
+
# The ledger currency or custom pricing unit to use.
|
14
|
+
#
|
15
|
+
# @return [String, nil]
|
16
|
+
optional :currency, String, nil?: true
|
17
|
+
|
18
|
+
# @!attribute cursor
|
19
|
+
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
20
|
+
# from the initial request.
|
21
|
+
#
|
22
|
+
# @return [String, nil]
|
23
|
+
optional :cursor, String, nil?: true
|
24
|
+
|
25
|
+
# @!attribute [r] include_all_blocks
|
26
|
+
# If set to True, all expired and depleted blocks, as well as active block will be
|
27
|
+
# returned.
|
28
|
+
#
|
29
|
+
# @return [Boolean, nil]
|
30
|
+
optional :include_all_blocks, Orb::BooleanModel
|
31
|
+
|
32
|
+
# @!parse
|
33
|
+
# # @return [Boolean]
|
34
|
+
# attr_writer :include_all_blocks
|
35
|
+
|
36
|
+
# @!attribute [r] limit
|
37
|
+
# The number of items to fetch. Defaults to 20.
|
38
|
+
#
|
39
|
+
# @return [Integer, nil]
|
40
|
+
optional :limit, Integer
|
41
|
+
|
42
|
+
# @!parse
|
43
|
+
# # @return [Integer]
|
44
|
+
# attr_writer :limit
|
45
|
+
|
46
|
+
# @!parse
|
47
|
+
# # @param currency [String, nil]
|
48
|
+
# # @param cursor [String, nil]
|
49
|
+
# # @param include_all_blocks [Boolean]
|
50
|
+
# # @param limit [Integer]
|
51
|
+
# # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
52
|
+
# #
|
53
|
+
# def initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}, **) = super
|
54
|
+
|
55
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
# @see Orb::Resources::Customers::Credits#list
|
7
|
+
class CreditListResponse < Orb::BaseModel
|
8
|
+
# @!attribute id
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute balance
|
14
|
+
#
|
15
|
+
# @return [Float]
|
16
|
+
required :balance, Float
|
17
|
+
|
18
|
+
# @!attribute effective_date
|
19
|
+
#
|
20
|
+
# @return [Time, nil]
|
21
|
+
required :effective_date, Time, nil?: true
|
22
|
+
|
23
|
+
# @!attribute expiry_date
|
24
|
+
#
|
25
|
+
# @return [Time, nil]
|
26
|
+
required :expiry_date, Time, nil?: true
|
27
|
+
|
28
|
+
# @!attribute maximum_initial_balance
|
29
|
+
#
|
30
|
+
# @return [Float, nil]
|
31
|
+
required :maximum_initial_balance, Float, nil?: true
|
32
|
+
|
33
|
+
# @!attribute per_unit_cost_basis
|
34
|
+
#
|
35
|
+
# @return [String, nil]
|
36
|
+
required :per_unit_cost_basis, String, nil?: true
|
37
|
+
|
38
|
+
# @!attribute status
|
39
|
+
#
|
40
|
+
# @return [Symbol, Orb::Models::Customers::CreditListResponse::Status]
|
41
|
+
required :status, enum: -> { Orb::Models::Customers::CreditListResponse::Status }
|
42
|
+
|
43
|
+
# @!parse
|
44
|
+
# # @param id [String]
|
45
|
+
# # @param balance [Float]
|
46
|
+
# # @param effective_date [Time, nil]
|
47
|
+
# # @param expiry_date [Time, nil]
|
48
|
+
# # @param maximum_initial_balance [Float, nil]
|
49
|
+
# # @param per_unit_cost_basis [String, nil]
|
50
|
+
# # @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status]
|
51
|
+
# #
|
52
|
+
# def initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:, **) = super
|
53
|
+
|
54
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
55
|
+
|
56
|
+
# @see Orb::Models::Customers::CreditListResponse#status
|
57
|
+
module Status
|
58
|
+
extend Orb::Enum
|
59
|
+
|
60
|
+
ACTIVE = :active
|
61
|
+
PENDING_PAYMENT = :pending_payment
|
62
|
+
|
63
|
+
finalize!
|
64
|
+
|
65
|
+
# @!parse
|
66
|
+
# # @return [Array<Symbol>]
|
67
|
+
# def self.values; end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -0,0 +1,215 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
module Customers
|
6
|
+
module Credits
|
7
|
+
# @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id
|
8
|
+
class LedgerCreateEntryByExternalIDParams < Orb::BaseModel
|
9
|
+
# @!parse
|
10
|
+
# extend Orb::Type::RequestParameters::Converter
|
11
|
+
include Orb::RequestParameters
|
12
|
+
|
13
|
+
# @!attribute amount
|
14
|
+
# The number of credits to effect. Note that this is required for increment,
|
15
|
+
# decrement or void operations.
|
16
|
+
#
|
17
|
+
# @return [Float]
|
18
|
+
required :amount, Float
|
19
|
+
|
20
|
+
# @!attribute entry_type
|
21
|
+
#
|
22
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
23
|
+
required :entry_type,
|
24
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType }
|
25
|
+
|
26
|
+
# @!attribute currency
|
27
|
+
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
28
|
+
# real-world currency, it must match the customer's invoicing currency.
|
29
|
+
#
|
30
|
+
# @return [String, nil]
|
31
|
+
optional :currency, String, nil?: true
|
32
|
+
|
33
|
+
# @!attribute description
|
34
|
+
# Optional metadata that can be specified when adding ledger results via the API.
|
35
|
+
# For example, this can be used to note an increment refers to trial credits, or
|
36
|
+
# for noting corrections as a result of an incident, etc.
|
37
|
+
#
|
38
|
+
# @return [String, nil]
|
39
|
+
optional :description, String, nil?: true
|
40
|
+
|
41
|
+
# @!attribute effective_date
|
42
|
+
# An ISO 8601 format date that denotes when this credit balance should become
|
43
|
+
# available for use.
|
44
|
+
#
|
45
|
+
# @return [Time, nil]
|
46
|
+
optional :effective_date, Time, nil?: true
|
47
|
+
|
48
|
+
# @!attribute expiry_date
|
49
|
+
# An ISO 8601 format date that identifies the origination credit block to expire
|
50
|
+
#
|
51
|
+
# @return [Time, nil]
|
52
|
+
required :expiry_date, Time, nil?: true
|
53
|
+
|
54
|
+
# @!attribute invoice_settings
|
55
|
+
# Passing `invoice_settings` automatically generates an invoice for the newly
|
56
|
+
# added credits. If `invoice_settings` is passed, you must specify
|
57
|
+
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
58
|
+
# basis.
|
59
|
+
#
|
60
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
|
61
|
+
optional :invoice_settings,
|
62
|
+
-> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings },
|
63
|
+
nil?: true
|
64
|
+
|
65
|
+
# @!attribute metadata
|
66
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
67
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
68
|
+
# by setting `metadata` to `null`.
|
69
|
+
#
|
70
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
71
|
+
optional :metadata, Orb::HashOf[String, nil?: true], nil?: true
|
72
|
+
|
73
|
+
# @!attribute per_unit_cost_basis
|
74
|
+
# Can only be specified when entry_type=increment. How much, in the customer's
|
75
|
+
# currency, a customer paid for a single credit in this block
|
76
|
+
#
|
77
|
+
# @return [String, nil]
|
78
|
+
optional :per_unit_cost_basis, String, nil?: true
|
79
|
+
|
80
|
+
# @!attribute target_expiry_date
|
81
|
+
# A future date (specified in YYYY-MM-DD format) used for expiration change,
|
82
|
+
# denoting when credits transferred (as part of a partial block expiration) should
|
83
|
+
# expire.
|
84
|
+
#
|
85
|
+
# @return [Date]
|
86
|
+
required :target_expiry_date, Date
|
87
|
+
|
88
|
+
# @!attribute block_id
|
89
|
+
# The ID of the block to reverse a decrement from.
|
90
|
+
#
|
91
|
+
# @return [String]
|
92
|
+
required :block_id, String
|
93
|
+
|
94
|
+
# @!attribute void_reason
|
95
|
+
# Can only be specified when `entry_type=void`. The reason for the void.
|
96
|
+
#
|
97
|
+
# @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
|
98
|
+
optional :void_reason,
|
99
|
+
enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason },
|
100
|
+
nil?: true
|
101
|
+
|
102
|
+
# @!parse
|
103
|
+
# # @param amount [Float]
|
104
|
+
# # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
|
105
|
+
# # @param expiry_date [Time, nil]
|
106
|
+
# # @param target_expiry_date [Date]
|
107
|
+
# # @param block_id [String]
|
108
|
+
# # @param currency [String, nil]
|
109
|
+
# # @param description [String, nil]
|
110
|
+
# # @param effective_date [Time, nil]
|
111
|
+
# # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
|
112
|
+
# # @param metadata [Hash{Symbol=>String, nil}, nil]
|
113
|
+
# # @param per_unit_cost_basis [String, nil]
|
114
|
+
# # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
|
115
|
+
# # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
116
|
+
# #
|
117
|
+
# def initialize(
|
118
|
+
# amount:,
|
119
|
+
# entry_type:,
|
120
|
+
# expiry_date:,
|
121
|
+
# target_expiry_date:,
|
122
|
+
# block_id:,
|
123
|
+
# currency: nil,
|
124
|
+
# description: nil,
|
125
|
+
# effective_date: nil,
|
126
|
+
# invoice_settings: nil,
|
127
|
+
# metadata: nil,
|
128
|
+
# per_unit_cost_basis: nil,
|
129
|
+
# void_reason: nil,
|
130
|
+
# request_options: {},
|
131
|
+
# **
|
132
|
+
# )
|
133
|
+
# super
|
134
|
+
# end
|
135
|
+
|
136
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
137
|
+
|
138
|
+
module EntryType
|
139
|
+
extend Orb::Enum
|
140
|
+
|
141
|
+
AMENDMENT = :amendment
|
142
|
+
|
143
|
+
finalize!
|
144
|
+
|
145
|
+
# @!parse
|
146
|
+
# # @return [Array<Symbol>]
|
147
|
+
# def self.values; end
|
148
|
+
end
|
149
|
+
|
150
|
+
class InvoiceSettings < Orb::BaseModel
|
151
|
+
# @!attribute auto_collection
|
152
|
+
# Whether the credits purchase invoice should auto collect with the customer's
|
153
|
+
# saved payment method.
|
154
|
+
#
|
155
|
+
# @return [Boolean]
|
156
|
+
required :auto_collection, Orb::BooleanModel
|
157
|
+
|
158
|
+
# @!attribute net_terms
|
159
|
+
# The net terms determines the difference between the invoice date and the issue
|
160
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
161
|
+
# to 0.
|
162
|
+
#
|
163
|
+
# @return [Integer]
|
164
|
+
required :net_terms, Integer
|
165
|
+
|
166
|
+
# @!attribute memo
|
167
|
+
# An optional memo to display on the invoice.
|
168
|
+
#
|
169
|
+
# @return [String, nil]
|
170
|
+
optional :memo, String, nil?: true
|
171
|
+
|
172
|
+
# @!attribute [r] require_successful_payment
|
173
|
+
# If true, the new credit block will require that the corresponding invoice is
|
174
|
+
# paid before it can be drawn down from.
|
175
|
+
#
|
176
|
+
# @return [Boolean, nil]
|
177
|
+
optional :require_successful_payment, Orb::BooleanModel
|
178
|
+
|
179
|
+
# @!parse
|
180
|
+
# # @return [Boolean]
|
181
|
+
# attr_writer :require_successful_payment
|
182
|
+
|
183
|
+
# @!parse
|
184
|
+
# # Passing `invoice_settings` automatically generates an invoice for the newly
|
185
|
+
# # added credits. If `invoice_settings` is passed, you must specify
|
186
|
+
# # per_unit_cost_basis, as the calculation of the invoice total is done on that
|
187
|
+
# # basis.
|
188
|
+
# #
|
189
|
+
# # @param auto_collection [Boolean]
|
190
|
+
# # @param net_terms [Integer]
|
191
|
+
# # @param memo [String, nil]
|
192
|
+
# # @param require_successful_payment [Boolean]
|
193
|
+
# #
|
194
|
+
# def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
|
195
|
+
|
196
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
197
|
+
end
|
198
|
+
|
199
|
+
# Can only be specified when `entry_type=void`. The reason for the void.
|
200
|
+
module VoidReason
|
201
|
+
extend Orb::Enum
|
202
|
+
|
203
|
+
REFUND = :refund
|
204
|
+
|
205
|
+
finalize!
|
206
|
+
|
207
|
+
# @!parse
|
208
|
+
# # @return [Array<Symbol>]
|
209
|
+
# def self.values; end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
214
|
+
end
|
215
|
+
end
|