orb-billing 0.1.3 → 0.3.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/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
data/lib/orb/models/invoice.rb
CHANGED
@@ -166,6 +166,8 @@ module Orb
|
|
166
166
|
required :customer_tax_id, -> { Orb::Models::Invoice::CustomerTaxID }, nil?: true
|
167
167
|
|
168
168
|
# @!attribute discount
|
169
|
+
# @deprecated
|
170
|
+
#
|
169
171
|
# This field is deprecated in favor of `discounts`. If a `discounts` list is
|
170
172
|
# provided, the first discount in the list will be returned. If the list is empty,
|
171
173
|
# `None` will be returned.
|
@@ -364,103 +366,115 @@ module Orb
|
|
364
366
|
# @return [Boolean]
|
365
367
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
366
368
|
|
367
|
-
# @!
|
368
|
-
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
445
|
-
#
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
|
463
|
-
#
|
369
|
+
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
370
|
+
# Some parameter documentations has been truncated, see {Orb::Models::Invoice} for
|
371
|
+
# more details.
|
372
|
+
#
|
373
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
374
|
+
# representing the request for payment for a single subscription. This includes a
|
375
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
376
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
377
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
378
|
+
#
|
379
|
+
# @param id [String]
|
380
|
+
#
|
381
|
+
# @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
|
382
|
+
# ...
|
383
|
+
#
|
384
|
+
# @param auto_collection [Orb::Models::Invoice::AutoCollection]
|
385
|
+
#
|
386
|
+
# @param billing_address [Orb::Models::Invoice::BillingAddress, nil]
|
387
|
+
#
|
388
|
+
# @param created_at [Time] The creation time of the resource in Orb.
|
389
|
+
#
|
390
|
+
# @param credit_notes [Array<Orb::Models::Invoice::CreditNote>] A list of credit notes associated with the invoice
|
391
|
+
#
|
392
|
+
# @param currency [String] An ISO 4217 currency string or `credits`
|
393
|
+
#
|
394
|
+
# @param customer [Orb::Models::Invoice::Customer]
|
395
|
+
#
|
396
|
+
# @param customer_balance_transactions [Array<Orb::Models::Invoice::CustomerBalanceTransaction>]
|
397
|
+
#
|
398
|
+
# @param customer_tax_id [Orb::Models::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
399
|
+
# ...
|
400
|
+
#
|
401
|
+
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
402
|
+
# ...
|
403
|
+
#
|
404
|
+
# @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
405
|
+
#
|
406
|
+
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
407
|
+
# ...
|
408
|
+
#
|
409
|
+
# @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
|
410
|
+
# ...
|
411
|
+
#
|
412
|
+
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
413
|
+
# ...
|
414
|
+
#
|
415
|
+
# @param invoice_date [Time] The scheduled date of the invoice
|
416
|
+
#
|
417
|
+
# @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
|
418
|
+
# ...
|
419
|
+
#
|
420
|
+
# @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
|
421
|
+
#
|
422
|
+
# @param invoice_source [Symbol, Orb::Models::Invoice::InvoiceSource]
|
423
|
+
#
|
424
|
+
# @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
|
425
|
+
# ...
|
426
|
+
#
|
427
|
+
# @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
|
428
|
+
# ...
|
429
|
+
#
|
430
|
+
# @param line_items [Array<Orb::Models::Invoice::LineItem>] The breakdown of prices in this invoice.
|
431
|
+
#
|
432
|
+
# @param maximum [Orb::Models::Invoice::Maximum, nil]
|
433
|
+
#
|
434
|
+
# @param maximum_amount [String, nil]
|
435
|
+
#
|
436
|
+
# @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
437
|
+
# ...
|
438
|
+
#
|
439
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
440
|
+
# ...
|
441
|
+
#
|
442
|
+
# @param minimum [Orb::Models::Invoice::Minimum, nil]
|
443
|
+
#
|
444
|
+
# @param minimum_amount [String, nil]
|
445
|
+
#
|
446
|
+
# @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
|
447
|
+
# ...
|
448
|
+
#
|
449
|
+
# @param payment_attempts [Array<Orb::Models::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
|
450
|
+
#
|
451
|
+
# @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
|
452
|
+
# ...
|
453
|
+
#
|
454
|
+
# @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
|
455
|
+
# ...
|
456
|
+
#
|
457
|
+
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
458
|
+
# ...
|
459
|
+
#
|
460
|
+
# @param shipping_address [Orb::Models::Invoice::ShippingAddress, nil]
|
461
|
+
#
|
462
|
+
# @param status [Symbol, Orb::Models::Invoice::Status]
|
463
|
+
#
|
464
|
+
# @param subscription [Orb::Models::Invoice::Subscription, nil]
|
465
|
+
#
|
466
|
+
# @param subtotal [String] The total before any discounts and minimums are applied.
|
467
|
+
#
|
468
|
+
# @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
|
469
|
+
# ...
|
470
|
+
#
|
471
|
+
# @param total [String] The total after any minimums and discounts have been applied.
|
472
|
+
#
|
473
|
+
# @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
|
474
|
+
# ...
|
475
|
+
#
|
476
|
+
# @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
|
477
|
+
# ...
|
464
478
|
|
465
479
|
# @see Orb::Models::Invoice#auto_collection
|
466
480
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
@@ -495,15 +509,19 @@ module Orb
|
|
495
509
|
# @return [Time, nil]
|
496
510
|
required :previously_attempted_at, Time, nil?: true
|
497
511
|
|
498
|
-
# @!
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
|
506
|
-
#
|
512
|
+
# @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
|
513
|
+
# Some parameter documentations has been truncated, see
|
514
|
+
# {Orb::Models::Invoice::AutoCollection} for more details.
|
515
|
+
#
|
516
|
+
# @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
|
517
|
+
#
|
518
|
+
# @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
|
519
|
+
# ...
|
520
|
+
#
|
521
|
+
# @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
|
522
|
+
#
|
523
|
+
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
524
|
+
# ...
|
507
525
|
end
|
508
526
|
|
509
527
|
# @see Orb::Models::Invoice#billing_address
|
@@ -538,17 +556,13 @@ module Orb
|
|
538
556
|
# @return [String, nil]
|
539
557
|
required :state, String, nil?: true
|
540
558
|
|
541
|
-
# @!
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
# #
|
549
|
-
# def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
|
550
|
-
|
551
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
559
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
560
|
+
# @param city [String, nil]
|
561
|
+
# @param country [String, nil]
|
562
|
+
# @param line1 [String, nil]
|
563
|
+
# @param line2 [String, nil]
|
564
|
+
# @param postal_code [String, nil]
|
565
|
+
# @param state [String, nil]
|
552
566
|
end
|
553
567
|
|
554
568
|
class CreditNote < Orb::Internal::Type::BaseModel
|
@@ -590,18 +604,24 @@ module Orb
|
|
590
604
|
# @return [Time, nil]
|
591
605
|
required :voided_at, Time, nil?: true
|
592
606
|
|
593
|
-
# @!
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
|
604
|
-
#
|
607
|
+
# @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
|
608
|
+
# Some parameter documentations has been truncated, see
|
609
|
+
# {Orb::Models::Invoice::CreditNote} for more details.
|
610
|
+
#
|
611
|
+
# @param id [String]
|
612
|
+
#
|
613
|
+
# @param credit_note_number [String]
|
614
|
+
#
|
615
|
+
# @param memo [String, nil] An optional memo supplied on the credit note.
|
616
|
+
#
|
617
|
+
# @param reason [String]
|
618
|
+
#
|
619
|
+
# @param total [String]
|
620
|
+
#
|
621
|
+
# @param type [String]
|
622
|
+
#
|
623
|
+
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
624
|
+
# ...
|
605
625
|
end
|
606
626
|
|
607
627
|
# @see Orb::Models::Invoice#customer
|
@@ -616,13 +636,9 @@ module Orb
|
|
616
636
|
# @return [String, nil]
|
617
637
|
required :external_customer_id, String, nil?: true
|
618
638
|
|
619
|
-
# @!
|
620
|
-
#
|
621
|
-
#
|
622
|
-
# #
|
623
|
-
# def initialize(id:, external_customer_id:, **) = super
|
624
|
-
|
625
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
639
|
+
# @!method initialize(id:, external_customer_id:)
|
640
|
+
# @param id [String]
|
641
|
+
# @param external_customer_id [String, nil]
|
626
642
|
end
|
627
643
|
|
628
644
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
@@ -684,35 +700,31 @@ module Orb
|
|
684
700
|
# @return [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type]
|
685
701
|
required :type, enum: -> { Orb::Models::Invoice::CustomerBalanceTransaction::Type }
|
686
702
|
|
687
|
-
# @!
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
692
|
-
#
|
693
|
-
#
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
#
|
708
|
-
#
|
709
|
-
#
|
710
|
-
#
|
711
|
-
#
|
712
|
-
# super
|
713
|
-
# end
|
714
|
-
|
715
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
703
|
+
# @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
|
704
|
+
# Some parameter documentations has been truncated, see
|
705
|
+
# {Orb::Models::Invoice::CustomerBalanceTransaction} for more details.
|
706
|
+
#
|
707
|
+
# @param id [String] A unique id for this transaction.
|
708
|
+
#
|
709
|
+
# @param action [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action]
|
710
|
+
#
|
711
|
+
# @param amount [String] The value of the amount changed in the transaction.
|
712
|
+
#
|
713
|
+
# @param created_at [Time] The creation time of this transaction.
|
714
|
+
#
|
715
|
+
# @param credit_note [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
716
|
+
#
|
717
|
+
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
718
|
+
#
|
719
|
+
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
720
|
+
# ...
|
721
|
+
#
|
722
|
+
# @param invoice [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
723
|
+
#
|
724
|
+
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
725
|
+
# ...
|
726
|
+
#
|
727
|
+
# @param type [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type]
|
716
728
|
|
717
729
|
# @see Orb::Models::Invoice::CustomerBalanceTransaction#action
|
718
730
|
module Action
|
@@ -728,11 +740,8 @@ module Orb
|
|
728
740
|
OVERPAYMENT_REFUND = :overpayment_refund
|
729
741
|
EXTERNAL_PAYMENT = :external_payment
|
730
742
|
|
731
|
-
|
732
|
-
|
733
|
-
# @!parse
|
734
|
-
# # @return [Array<Symbol>]
|
735
|
-
# def self.values; end
|
743
|
+
# @!method self.values
|
744
|
+
# @return [Array<Symbol>]
|
736
745
|
end
|
737
746
|
|
738
747
|
# @see Orb::Models::Invoice::CustomerBalanceTransaction#credit_note
|
@@ -743,12 +752,8 @@ module Orb
|
|
743
752
|
# @return [String]
|
744
753
|
required :id, String
|
745
754
|
|
746
|
-
# @!
|
747
|
-
#
|
748
|
-
# #
|
749
|
-
# def initialize(id:, **) = super
|
750
|
-
|
751
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
755
|
+
# @!method initialize(id:)
|
756
|
+
# @param id [String] The id of the Credit note
|
752
757
|
end
|
753
758
|
|
754
759
|
# @see Orb::Models::Invoice::CustomerBalanceTransaction#invoice
|
@@ -759,12 +764,8 @@ module Orb
|
|
759
764
|
# @return [String]
|
760
765
|
required :id, String
|
761
766
|
|
762
|
-
# @!
|
763
|
-
#
|
764
|
-
# #
|
765
|
-
# def initialize(id:, **) = super
|
766
|
-
|
767
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
767
|
+
# @!method initialize(id:)
|
768
|
+
# @param id [String] The Invoice id
|
768
769
|
end
|
769
770
|
|
770
771
|
# @see Orb::Models::Invoice::CustomerBalanceTransaction#type
|
@@ -774,11 +775,8 @@ module Orb
|
|
774
775
|
INCREMENT = :increment
|
775
776
|
DECREMENT = :decrement
|
776
777
|
|
777
|
-
|
778
|
-
|
779
|
-
# @!parse
|
780
|
-
# # @return [Array<Symbol>]
|
781
|
-
# def self.values; end
|
778
|
+
# @!method self.values
|
779
|
+
# @return [Array<Symbol>]
|
782
780
|
end
|
783
781
|
end
|
784
782
|
|
@@ -799,120 +797,116 @@ module Orb
|
|
799
797
|
# @return [String]
|
800
798
|
required :value, String
|
801
799
|
|
802
|
-
# @!
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
821
|
-
#
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
#
|
836
|
-
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
#
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
871
|
-
#
|
872
|
-
#
|
873
|
-
#
|
874
|
-
#
|
875
|
-
#
|
876
|
-
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
#
|
880
|
-
#
|
881
|
-
#
|
882
|
-
#
|
883
|
-
#
|
884
|
-
#
|
885
|
-
#
|
886
|
-
#
|
887
|
-
#
|
888
|
-
#
|
889
|
-
#
|
890
|
-
#
|
891
|
-
#
|
892
|
-
#
|
893
|
-
#
|
894
|
-
#
|
895
|
-
#
|
896
|
-
#
|
897
|
-
#
|
898
|
-
#
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
# #
|
913
|
-
# def initialize(country:, type:, value:, **) = super
|
914
|
-
|
915
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
800
|
+
# @!method initialize(country:, type:, value:)
|
801
|
+
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
802
|
+
# added to the headers of invoices.
|
803
|
+
#
|
804
|
+
# ### Supported Tax ID Countries and Types
|
805
|
+
#
|
806
|
+
# | Country | Type | Description |
|
807
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
808
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
809
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
810
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
811
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
812
|
+
# | Austria | `eu_vat` | European VAT Number |
|
813
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
814
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
815
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
816
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
817
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
818
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
819
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
820
|
+
# | Canada | `ca_bn` | Canadian BN |
|
821
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
822
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
823
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
824
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
825
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
826
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
827
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
828
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
829
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
830
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
831
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
832
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
833
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
834
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
835
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
836
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
837
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
838
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
839
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
840
|
+
# | Finland | `eu_vat` | European VAT Number |
|
841
|
+
# | France | `eu_vat` | European VAT Number |
|
842
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
843
|
+
# | Germany | `eu_vat` | European VAT Number |
|
844
|
+
# | Greece | `eu_vat` | European VAT Number |
|
845
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
846
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
847
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
848
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
849
|
+
# | India | `in_gst` | Indian GST Number |
|
850
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
851
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
852
|
+
# | Israel | `il_vat` | Israel VAT |
|
853
|
+
# | Italy | `eu_vat` | European VAT Number |
|
854
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
855
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
856
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
857
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
858
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
859
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
860
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
861
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
862
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
863
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
864
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
865
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
866
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
867
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
868
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
869
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
870
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
871
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
872
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
873
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
874
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
875
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
876
|
+
# | Poland | `eu_vat` | European VAT Number |
|
877
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
878
|
+
# | Romania | `eu_vat` | European VAT Number |
|
879
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
880
|
+
# | Russia | `ru_inn` | Russian INN |
|
881
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
882
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
883
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
884
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
885
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
886
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
887
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
888
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
889
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
890
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
891
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
892
|
+
# | Spain | `eu_vat` | European VAT Number |
|
893
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
894
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
895
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
896
|
+
# | Thailand | `th_vat` | Thai VAT |
|
897
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
898
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
899
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
900
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
901
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
902
|
+
# | United States | `us_ein` | United States EIN |
|
903
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
904
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
905
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
906
|
+
#
|
907
|
+
# @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
|
908
|
+
# @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
|
909
|
+
# @param value [String]
|
916
910
|
|
917
911
|
# @see Orb::Models::Invoice::CustomerTaxID#country
|
918
912
|
module Country
|
@@ -997,11 +991,8 @@ module Orb
|
|
997
991
|
VN = :VN
|
998
992
|
ZA = :ZA
|
999
993
|
|
1000
|
-
|
1001
|
-
|
1002
|
-
# @!parse
|
1003
|
-
# # @return [Array<Symbol>]
|
1004
|
-
# def self.values; end
|
994
|
+
# @!method self.values
|
995
|
+
# @return [Array<Symbol>]
|
1005
996
|
end
|
1006
997
|
|
1007
998
|
# @see Orb::Models::Invoice::CustomerTaxID#type
|
@@ -1080,11 +1071,8 @@ module Orb
|
|
1080
1071
|
VN_TIN = :vn_tin
|
1081
1072
|
ZA_VAT = :za_vat
|
1082
1073
|
|
1083
|
-
|
1084
|
-
|
1085
|
-
# @!parse
|
1086
|
-
# # @return [Array<Symbol>]
|
1087
|
-
# def self.values; end
|
1074
|
+
# @!method self.values
|
1075
|
+
# @return [Array<Symbol>]
|
1088
1076
|
end
|
1089
1077
|
end
|
1090
1078
|
|
@@ -1096,11 +1084,8 @@ module Orb
|
|
1096
1084
|
PARTIAL = :partial
|
1097
1085
|
ONE_OFF = :one_off
|
1098
1086
|
|
1099
|
-
|
1100
|
-
|
1101
|
-
# @!parse
|
1102
|
-
# # @return [Array<Symbol>]
|
1103
|
-
# def self.values; end
|
1087
|
+
# @!method self.values
|
1088
|
+
# @return [Array<Symbol>]
|
1104
1089
|
end
|
1105
1090
|
|
1106
1091
|
class LineItem < Orb::Internal::Type::BaseModel
|
@@ -1165,24 +1150,32 @@ module Orb
|
|
1165
1150
|
required :grouping, String, nil?: true
|
1166
1151
|
|
1167
1152
|
# @!attribute maximum
|
1153
|
+
# @deprecated
|
1154
|
+
#
|
1168
1155
|
# This field is deprecated in favor of `adjustments`.
|
1169
1156
|
#
|
1170
1157
|
# @return [Orb::Models::Invoice::LineItem::Maximum, nil]
|
1171
1158
|
required :maximum, -> { Orb::Models::Invoice::LineItem::Maximum }, nil?: true
|
1172
1159
|
|
1173
1160
|
# @!attribute maximum_amount
|
1161
|
+
# @deprecated
|
1162
|
+
#
|
1174
1163
|
# This field is deprecated in favor of `adjustments`.
|
1175
1164
|
#
|
1176
1165
|
# @return [String, nil]
|
1177
1166
|
required :maximum_amount, String, nil?: true
|
1178
1167
|
|
1179
1168
|
# @!attribute minimum
|
1169
|
+
# @deprecated
|
1170
|
+
#
|
1180
1171
|
# This field is deprecated in favor of `adjustments`.
|
1181
1172
|
#
|
1182
1173
|
# @return [Orb::Models::Invoice::LineItem::Minimum, nil]
|
1183
1174
|
required :minimum, -> { Orb::Models::Invoice::LineItem::Minimum }, nil?: true
|
1184
1175
|
|
1185
1176
|
# @!attribute minimum_amount
|
1177
|
+
# @deprecated
|
1178
|
+
#
|
1186
1179
|
# This field is deprecated in favor of `adjustments`.
|
1187
1180
|
#
|
1188
1181
|
# @return [String, nil]
|
@@ -1254,59 +1247,61 @@ module Orb
|
|
1254
1247
|
# @return [Array<String>, nil]
|
1255
1248
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1256
1249
|
|
1257
|
-
# @!
|
1258
|
-
#
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
#
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
#
|
1267
|
-
#
|
1268
|
-
#
|
1269
|
-
#
|
1270
|
-
#
|
1271
|
-
#
|
1272
|
-
#
|
1273
|
-
#
|
1274
|
-
#
|
1275
|
-
#
|
1276
|
-
#
|
1277
|
-
#
|
1278
|
-
#
|
1279
|
-
#
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
#
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
#
|
1298
|
-
#
|
1299
|
-
#
|
1300
|
-
#
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
#
|
1304
|
-
#
|
1305
|
-
#
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
|
1309
|
-
#
|
1250
|
+
# @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:)
|
1251
|
+
# Some parameter documentations has been truncated, see
|
1252
|
+
# {Orb::Models::Invoice::LineItem} for more details.
|
1253
|
+
#
|
1254
|
+
# @param id [String] A unique ID for this line item.
|
1255
|
+
#
|
1256
|
+
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1257
|
+
# ...
|
1258
|
+
#
|
1259
|
+
# @param adjustments [Array<Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
|
1260
|
+
# ...
|
1261
|
+
#
|
1262
|
+
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1263
|
+
# ...
|
1264
|
+
#
|
1265
|
+
# @param credits_applied [String] The number of prepaid credits applied.
|
1266
|
+
#
|
1267
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
1268
|
+
#
|
1269
|
+
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1270
|
+
#
|
1271
|
+
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
1272
|
+
#
|
1273
|
+
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1274
|
+
# ...
|
1275
|
+
#
|
1276
|
+
# @param maximum [Orb::Models::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1277
|
+
#
|
1278
|
+
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1279
|
+
#
|
1280
|
+
# @param minimum [Orb::Models::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
1281
|
+
#
|
1282
|
+
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1283
|
+
#
|
1284
|
+
# @param name [String] The name of the price associated with this line item.
|
1285
|
+
#
|
1286
|
+
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1287
|
+
#
|
1288
|
+
# @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, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1289
|
+
# ...
|
1290
|
+
#
|
1291
|
+
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1292
|
+
#
|
1293
|
+
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1294
|
+
#
|
1295
|
+
# @param sub_line_items [Array<Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem>] For complex pricing structures, the line item can be broken down further in `sub
|
1296
|
+
# ...
|
1297
|
+
#
|
1298
|
+
# @param subtotal [String] The line amount before before any adjustments.
|
1299
|
+
#
|
1300
|
+
# @param tax_amounts [Array<Orb::Models::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1301
|
+
# ...
|
1302
|
+
#
|
1303
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1304
|
+
# ...
|
1310
1305
|
|
1311
1306
|
module Adjustment
|
1312
1307
|
extend Orb::Internal::Type::Union
|
@@ -1369,29 +1364,26 @@ module Orb
|
|
1369
1364
|
# @return [Float]
|
1370
1365
|
required :usage_discount, Float
|
1371
1366
|
|
1372
|
-
# @!
|
1373
|
-
#
|
1374
|
-
#
|
1375
|
-
#
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
#
|
1379
|
-
#
|
1380
|
-
#
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
#
|
1385
|
-
#
|
1386
|
-
#
|
1387
|
-
#
|
1388
|
-
#
|
1389
|
-
#
|
1390
|
-
#
|
1391
|
-
#
|
1392
|
-
# end
|
1393
|
-
|
1394
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1367
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
1368
|
+
# Some parameter documentations has been truncated, see
|
1369
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment}
|
1370
|
+
# for more details.
|
1371
|
+
#
|
1372
|
+
# @param id [String]
|
1373
|
+
#
|
1374
|
+
# @param amount [String] The value applied by an adjustment.
|
1375
|
+
#
|
1376
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1377
|
+
#
|
1378
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1379
|
+
# ...
|
1380
|
+
#
|
1381
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1382
|
+
#
|
1383
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
1384
|
+
# ...
|
1385
|
+
#
|
1386
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
1395
1387
|
end
|
1396
1388
|
|
1397
1389
|
class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1437,29 +1429,26 @@ module Orb
|
|
1437
1429
|
# @return [String, nil]
|
1438
1430
|
required :reason, String, nil?: true
|
1439
1431
|
|
1440
|
-
# @!
|
1441
|
-
#
|
1442
|
-
#
|
1443
|
-
#
|
1444
|
-
#
|
1445
|
-
#
|
1446
|
-
#
|
1447
|
-
#
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
#
|
1453
|
-
#
|
1454
|
-
#
|
1455
|
-
#
|
1456
|
-
#
|
1457
|
-
#
|
1458
|
-
#
|
1459
|
-
#
|
1460
|
-
# end
|
1461
|
-
|
1462
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1432
|
+
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
1433
|
+
# Some parameter documentations has been truncated, see
|
1434
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment}
|
1435
|
+
# for more details.
|
1436
|
+
#
|
1437
|
+
# @param id [String]
|
1438
|
+
#
|
1439
|
+
# @param amount [String] The value applied by an adjustment.
|
1440
|
+
#
|
1441
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
1442
|
+
# ...
|
1443
|
+
#
|
1444
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1445
|
+
#
|
1446
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1447
|
+
# ...
|
1448
|
+
#
|
1449
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1450
|
+
#
|
1451
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
1463
1452
|
end
|
1464
1453
|
|
1465
1454
|
class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1505,29 +1494,26 @@ module Orb
|
|
1505
1494
|
# @return [String, nil]
|
1506
1495
|
required :reason, String, nil?: true
|
1507
1496
|
|
1508
|
-
# @!
|
1509
|
-
#
|
1510
|
-
#
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
#
|
1514
|
-
#
|
1515
|
-
#
|
1516
|
-
#
|
1517
|
-
#
|
1518
|
-
#
|
1519
|
-
#
|
1520
|
-
#
|
1521
|
-
#
|
1522
|
-
#
|
1523
|
-
#
|
1524
|
-
#
|
1525
|
-
#
|
1526
|
-
#
|
1527
|
-
#
|
1528
|
-
# end
|
1529
|
-
|
1530
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1497
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
1498
|
+
# Some parameter documentations has been truncated, see
|
1499
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment}
|
1500
|
+
# for more details.
|
1501
|
+
#
|
1502
|
+
# @param id [String]
|
1503
|
+
#
|
1504
|
+
# @param amount [String] The value applied by an adjustment.
|
1505
|
+
#
|
1506
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1507
|
+
#
|
1508
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1509
|
+
# ...
|
1510
|
+
#
|
1511
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
1512
|
+
# ...
|
1513
|
+
#
|
1514
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1515
|
+
#
|
1516
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
1531
1517
|
end
|
1532
1518
|
|
1533
1519
|
class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1579,31 +1565,28 @@ module Orb
|
|
1579
1565
|
# @return [String, nil]
|
1580
1566
|
required :reason, String, nil?: true
|
1581
1567
|
|
1582
|
-
# @!
|
1583
|
-
#
|
1584
|
-
#
|
1585
|
-
#
|
1586
|
-
#
|
1587
|
-
#
|
1588
|
-
#
|
1589
|
-
#
|
1590
|
-
#
|
1591
|
-
#
|
1592
|
-
#
|
1593
|
-
#
|
1594
|
-
#
|
1595
|
-
#
|
1596
|
-
#
|
1597
|
-
#
|
1598
|
-
#
|
1599
|
-
#
|
1600
|
-
#
|
1601
|
-
#
|
1602
|
-
#
|
1603
|
-
#
|
1604
|
-
# end
|
1605
|
-
|
1606
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1568
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
1569
|
+
# Some parameter documentations has been truncated, see
|
1570
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment} for more
|
1571
|
+
# details.
|
1572
|
+
#
|
1573
|
+
# @param id [String]
|
1574
|
+
#
|
1575
|
+
# @param amount [String] The value applied by an adjustment.
|
1576
|
+
#
|
1577
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1578
|
+
#
|
1579
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1580
|
+
# ...
|
1581
|
+
#
|
1582
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
1583
|
+
#
|
1584
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
1585
|
+
# ...
|
1586
|
+
#
|
1587
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1588
|
+
#
|
1589
|
+
# @param adjustment_type [Symbol, :minimum]
|
1607
1590
|
end
|
1608
1591
|
|
1609
1592
|
class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1649,34 +1632,30 @@ module Orb
|
|
1649
1632
|
# @return [String, nil]
|
1650
1633
|
required :reason, String, nil?: true
|
1651
1634
|
|
1652
|
-
# @!
|
1653
|
-
#
|
1654
|
-
#
|
1655
|
-
#
|
1656
|
-
#
|
1657
|
-
#
|
1658
|
-
#
|
1659
|
-
#
|
1660
|
-
#
|
1661
|
-
#
|
1662
|
-
#
|
1663
|
-
#
|
1664
|
-
#
|
1665
|
-
#
|
1666
|
-
#
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
# end
|
1673
|
-
|
1674
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1635
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
1636
|
+
# Some parameter documentations has been truncated, see
|
1637
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment} for more
|
1638
|
+
# details.
|
1639
|
+
#
|
1640
|
+
# @param id [String]
|
1641
|
+
#
|
1642
|
+
# @param amount [String] The value applied by an adjustment.
|
1643
|
+
#
|
1644
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1645
|
+
#
|
1646
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1647
|
+
# ...
|
1648
|
+
#
|
1649
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
1650
|
+
# ...
|
1651
|
+
#
|
1652
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1653
|
+
#
|
1654
|
+
# @param adjustment_type [Symbol, :maximum]
|
1675
1655
|
end
|
1676
1656
|
|
1677
|
-
# @!
|
1678
|
-
#
|
1679
|
-
# def self.variants; end
|
1657
|
+
# @!method self.variants
|
1658
|
+
# @return [Array(Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment)]
|
1680
1659
|
end
|
1681
1660
|
|
1682
1661
|
# @deprecated
|
@@ -1696,15 +1675,16 @@ module Orb
|
|
1696
1675
|
# @return [String]
|
1697
1676
|
required :maximum_amount, String
|
1698
1677
|
|
1699
|
-
# @!
|
1700
|
-
#
|
1701
|
-
#
|
1702
|
-
#
|
1703
|
-
#
|
1704
|
-
#
|
1705
|
-
#
|
1706
|
-
|
1707
|
-
#
|
1678
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
1679
|
+
# Some parameter documentations has been truncated, see
|
1680
|
+
# {Orb::Models::Invoice::LineItem::Maximum} for more details.
|
1681
|
+
#
|
1682
|
+
# This field is deprecated in favor of `adjustments`.
|
1683
|
+
#
|
1684
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
1685
|
+
# ...
|
1686
|
+
#
|
1687
|
+
# @param maximum_amount [String] Maximum amount applied
|
1708
1688
|
end
|
1709
1689
|
|
1710
1690
|
# @deprecated
|
@@ -1724,15 +1704,16 @@ module Orb
|
|
1724
1704
|
# @return [String]
|
1725
1705
|
required :minimum_amount, String
|
1726
1706
|
|
1727
|
-
# @!
|
1728
|
-
#
|
1729
|
-
#
|
1730
|
-
#
|
1731
|
-
#
|
1732
|
-
#
|
1733
|
-
#
|
1734
|
-
|
1735
|
-
#
|
1707
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
1708
|
+
# Some parameter documentations has been truncated, see
|
1709
|
+
# {Orb::Models::Invoice::LineItem::Minimum} for more details.
|
1710
|
+
#
|
1711
|
+
# This field is deprecated in favor of `adjustments`.
|
1712
|
+
#
|
1713
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
1714
|
+
# ...
|
1715
|
+
#
|
1716
|
+
# @param minimum_amount [String] Minimum amount applied
|
1736
1717
|
end
|
1737
1718
|
|
1738
1719
|
module SubLineItem
|
@@ -1781,17 +1762,18 @@ module Orb
|
|
1781
1762
|
# @return [Symbol, :matrix]
|
1782
1763
|
required :type, const: :matrix
|
1783
1764
|
|
1784
|
-
# @!
|
1785
|
-
#
|
1786
|
-
#
|
1787
|
-
#
|
1788
|
-
#
|
1789
|
-
#
|
1790
|
-
#
|
1791
|
-
#
|
1792
|
-
#
|
1793
|
-
|
1794
|
-
#
|
1765
|
+
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
1766
|
+
# @param amount [String] The total amount for this sub line item.
|
1767
|
+
#
|
1768
|
+
# @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil]
|
1769
|
+
#
|
1770
|
+
# @param matrix_config [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig]
|
1771
|
+
#
|
1772
|
+
# @param name [String]
|
1773
|
+
#
|
1774
|
+
# @param quantity [Float]
|
1775
|
+
#
|
1776
|
+
# @param type [Symbol, :matrix]
|
1795
1777
|
|
1796
1778
|
# @see Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem#grouping
|
1797
1779
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -1806,13 +1788,10 @@ module Orb
|
|
1806
1788
|
# @return [String, nil]
|
1807
1789
|
required :value, String, nil?: true
|
1808
1790
|
|
1809
|
-
# @!
|
1810
|
-
#
|
1811
|
-
#
|
1812
|
-
#
|
1813
|
-
# def initialize(key:, value:, **) = super
|
1814
|
-
|
1815
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1791
|
+
# @!method initialize(key:, value:)
|
1792
|
+
# @param key [String]
|
1793
|
+
#
|
1794
|
+
# @param value [String, nil] No value indicates the default group
|
1816
1795
|
end
|
1817
1796
|
|
1818
1797
|
# @see Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem#matrix_config
|
@@ -1823,12 +1802,8 @@ module Orb
|
|
1823
1802
|
# @return [Array<String, nil>]
|
1824
1803
|
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
1825
1804
|
|
1826
|
-
# @!
|
1827
|
-
#
|
1828
|
-
# #
|
1829
|
-
# def initialize(dimension_values:, **) = super
|
1830
|
-
|
1831
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1805
|
+
# @!method initialize(dimension_values:)
|
1806
|
+
# @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
|
1832
1807
|
end
|
1833
1808
|
end
|
1834
1809
|
|
@@ -1866,17 +1841,18 @@ module Orb
|
|
1866
1841
|
# @return [Symbol, :tier]
|
1867
1842
|
required :type, const: :tier
|
1868
1843
|
|
1869
|
-
# @!
|
1870
|
-
#
|
1871
|
-
#
|
1872
|
-
#
|
1873
|
-
#
|
1874
|
-
#
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
#
|
1878
|
-
|
1879
|
-
#
|
1844
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
1845
|
+
# @param amount [String] The total amount for this sub line item.
|
1846
|
+
#
|
1847
|
+
# @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::Grouping, nil]
|
1848
|
+
#
|
1849
|
+
# @param name [String]
|
1850
|
+
#
|
1851
|
+
# @param quantity [Float]
|
1852
|
+
#
|
1853
|
+
# @param tier_config [Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::TierConfig]
|
1854
|
+
#
|
1855
|
+
# @param type [Symbol, :tier]
|
1880
1856
|
|
1881
1857
|
# @see Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem#grouping
|
1882
1858
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -1891,13 +1867,10 @@ module Orb
|
|
1891
1867
|
# @return [String, nil]
|
1892
1868
|
required :value, String, nil?: true
|
1893
1869
|
|
1894
|
-
# @!
|
1895
|
-
#
|
1896
|
-
#
|
1897
|
-
#
|
1898
|
-
# def initialize(key:, value:, **) = super
|
1899
|
-
|
1900
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1870
|
+
# @!method initialize(key:, value:)
|
1871
|
+
# @param key [String]
|
1872
|
+
#
|
1873
|
+
# @param value [String, nil] No value indicates the default group
|
1901
1874
|
end
|
1902
1875
|
|
1903
1876
|
# @see Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem#tier_config
|
@@ -1917,14 +1890,10 @@ module Orb
|
|
1917
1890
|
# @return [String]
|
1918
1891
|
required :unit_amount, String
|
1919
1892
|
|
1920
|
-
# @!
|
1921
|
-
#
|
1922
|
-
#
|
1923
|
-
#
|
1924
|
-
# #
|
1925
|
-
# def initialize(first_unit:, last_unit:, unit_amount:, **) = super
|
1926
|
-
|
1927
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1893
|
+
# @!method initialize(first_unit:, last_unit:, unit_amount:)
|
1894
|
+
# @param first_unit [Float]
|
1895
|
+
# @param last_unit [Float, nil]
|
1896
|
+
# @param unit_amount [String]
|
1928
1897
|
end
|
1929
1898
|
end
|
1930
1899
|
|
@@ -1957,16 +1926,16 @@ module Orb
|
|
1957
1926
|
# @return [Symbol, :"'null'"]
|
1958
1927
|
required :type, const: :"'null'"
|
1959
1928
|
|
1960
|
-
# @!
|
1961
|
-
#
|
1962
|
-
#
|
1963
|
-
#
|
1964
|
-
#
|
1965
|
-
#
|
1966
|
-
#
|
1967
|
-
#
|
1968
|
-
|
1969
|
-
#
|
1929
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
1930
|
+
# @param amount [String] The total amount for this sub line item.
|
1931
|
+
#
|
1932
|
+
# @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil]
|
1933
|
+
#
|
1934
|
+
# @param name [String]
|
1935
|
+
#
|
1936
|
+
# @param quantity [Float]
|
1937
|
+
#
|
1938
|
+
# @param type [Symbol, :"'null'"]
|
1970
1939
|
|
1971
1940
|
# @see Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem#grouping
|
1972
1941
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -1981,19 +1950,15 @@ module Orb
|
|
1981
1950
|
# @return [String, nil]
|
1982
1951
|
required :value, String, nil?: true
|
1983
1952
|
|
1984
|
-
# @!
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
#
|
1988
|
-
# def initialize(key:, value:, **) = super
|
1989
|
-
|
1990
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1953
|
+
# @!method initialize(key:, value:)
|
1954
|
+
# @param key [String]
|
1955
|
+
#
|
1956
|
+
# @param value [String, nil] No value indicates the default group
|
1991
1957
|
end
|
1992
1958
|
end
|
1993
1959
|
|
1994
|
-
# @!
|
1995
|
-
#
|
1996
|
-
# def self.variants; end
|
1960
|
+
# @!method self.variants
|
1961
|
+
# @return [Array(Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem)]
|
1997
1962
|
end
|
1998
1963
|
|
1999
1964
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -2015,14 +1980,12 @@ module Orb
|
|
2015
1980
|
# @return [String, nil]
|
2016
1981
|
required :tax_rate_percentage, String, nil?: true
|
2017
1982
|
|
2018
|
-
# @!
|
2019
|
-
#
|
2020
|
-
#
|
2021
|
-
#
|
2022
|
-
#
|
2023
|
-
#
|
2024
|
-
|
2025
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1983
|
+
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
1984
|
+
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
1985
|
+
#
|
1986
|
+
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
1987
|
+
#
|
1988
|
+
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
2026
1989
|
end
|
2027
1990
|
end
|
2028
1991
|
|
@@ -2041,13 +2004,14 @@ module Orb
|
|
2041
2004
|
# @return [String]
|
2042
2005
|
required :maximum_amount, String
|
2043
2006
|
|
2044
|
-
# @!
|
2045
|
-
#
|
2046
|
-
#
|
2047
|
-
#
|
2048
|
-
#
|
2049
|
-
|
2050
|
-
#
|
2007
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
2008
|
+
# Some parameter documentations has been truncated, see
|
2009
|
+
# {Orb::Models::Invoice::Maximum} for more details.
|
2010
|
+
#
|
2011
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2012
|
+
# ...
|
2013
|
+
#
|
2014
|
+
# @param maximum_amount [String] Maximum amount applied
|
2051
2015
|
end
|
2052
2016
|
|
2053
2017
|
# @see Orb::Models::Invoice#minimum
|
@@ -2065,13 +2029,14 @@ module Orb
|
|
2065
2029
|
# @return [String]
|
2066
2030
|
required :minimum_amount, String
|
2067
2031
|
|
2068
|
-
# @!
|
2069
|
-
#
|
2070
|
-
#
|
2071
|
-
#
|
2072
|
-
#
|
2073
|
-
|
2074
|
-
#
|
2032
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
2033
|
+
# Some parameter documentations has been truncated, see
|
2034
|
+
# {Orb::Models::Invoice::Minimum} for more details.
|
2035
|
+
#
|
2036
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2037
|
+
# ...
|
2038
|
+
#
|
2039
|
+
# @param minimum_amount [String] Minimum amount applied
|
2075
2040
|
end
|
2076
2041
|
|
2077
2042
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
@@ -2111,17 +2076,18 @@ module Orb
|
|
2111
2076
|
# @return [Boolean]
|
2112
2077
|
required :succeeded, Orb::Internal::Type::Boolean
|
2113
2078
|
|
2114
|
-
# @!
|
2115
|
-
#
|
2116
|
-
#
|
2117
|
-
#
|
2118
|
-
#
|
2119
|
-
#
|
2120
|
-
#
|
2121
|
-
#
|
2122
|
-
#
|
2123
|
-
|
2124
|
-
#
|
2079
|
+
# @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:)
|
2080
|
+
# @param id [String] The ID of the payment attempt.
|
2081
|
+
#
|
2082
|
+
# @param amount [String] The amount of the payment attempt.
|
2083
|
+
#
|
2084
|
+
# @param created_at [Time] The time at which the payment attempt was created.
|
2085
|
+
#
|
2086
|
+
# @param payment_provider [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
|
2087
|
+
#
|
2088
|
+
# @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
|
2089
|
+
#
|
2090
|
+
# @param succeeded [Boolean] Whether the payment attempt succeeded.
|
2125
2091
|
|
2126
2092
|
# The payment provider that attempted to collect the payment.
|
2127
2093
|
#
|
@@ -2131,11 +2097,8 @@ module Orb
|
|
2131
2097
|
|
2132
2098
|
STRIPE = :stripe
|
2133
2099
|
|
2134
|
-
|
2135
|
-
|
2136
|
-
# @!parse
|
2137
|
-
# # @return [Array<Symbol>]
|
2138
|
-
# def self.values; end
|
2100
|
+
# @!method self.values
|
2101
|
+
# @return [Array<Symbol>]
|
2139
2102
|
end
|
2140
2103
|
end
|
2141
2104
|
|
@@ -2171,17 +2134,13 @@ module Orb
|
|
2171
2134
|
# @return [String, nil]
|
2172
2135
|
required :state, String, nil?: true
|
2173
2136
|
|
2174
|
-
# @!
|
2175
|
-
#
|
2176
|
-
#
|
2177
|
-
#
|
2178
|
-
#
|
2179
|
-
#
|
2180
|
-
#
|
2181
|
-
# #
|
2182
|
-
# def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
|
2183
|
-
|
2184
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2137
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
2138
|
+
# @param city [String, nil]
|
2139
|
+
# @param country [String, nil]
|
2140
|
+
# @param line1 [String, nil]
|
2141
|
+
# @param line2 [String, nil]
|
2142
|
+
# @param postal_code [String, nil]
|
2143
|
+
# @param state [String, nil]
|
2185
2144
|
end
|
2186
2145
|
|
2187
2146
|
# @see Orb::Models::Invoice#status
|
@@ -2194,11 +2153,8 @@ module Orb
|
|
2194
2153
|
VOID = :void
|
2195
2154
|
DRAFT = :draft
|
2196
2155
|
|
2197
|
-
|
2198
|
-
|
2199
|
-
# @!parse
|
2200
|
-
# # @return [Array<Symbol>]
|
2201
|
-
# def self.values; end
|
2156
|
+
# @!method self.values
|
2157
|
+
# @return [Array<Symbol>]
|
2202
2158
|
end
|
2203
2159
|
|
2204
2160
|
# @see Orb::Models::Invoice#subscription
|
@@ -2208,12 +2164,8 @@ module Orb
|
|
2208
2164
|
# @return [String]
|
2209
2165
|
required :id, String
|
2210
2166
|
|
2211
|
-
# @!
|
2212
|
-
#
|
2213
|
-
# #
|
2214
|
-
# def initialize(id:, **) = super
|
2215
|
-
|
2216
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2167
|
+
# @!method initialize(id:)
|
2168
|
+
# @param id [String]
|
2217
2169
|
end
|
2218
2170
|
end
|
2219
2171
|
end
|