orb-billing 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +47 -0
- data/README.md +7 -7
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +13 -14
- data/lib/orb/internal/type/request_parameters.rb +6 -12
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +21 -5
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +8 -10
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +43 -55
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
- data/lib/orb/models/customer_update_params.rb +43 -53
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -114
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -121
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +165 -224
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +83 -111
- data/lib/orb/models/plan_create_params.rb +753 -861
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1699 -1804
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +94 -136
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +52 -91
- data/lib/orb/models/subscription_change_apply_response.rb +50 -88
- data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
- data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
- data/lib/orb/models/subscription_create_params.rb +1927 -1928
- data/lib/orb/models/subscription_create_response.rb +52 -91
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1141 -1079
- data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +52 -91
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +18 -37
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/{lib/orb → orb}/client.rbi +5 -4
- data/rbi/{lib/orb → orb}/errors.rbi +58 -27
- data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
- data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +98 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +29 -0
- data/rbi/orb/internal/type/union.rbi +110 -0
- data/rbi/orb/internal/type/unknown.rbi +50 -0
- data/rbi/orb/internal/util.rbi +424 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
- data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +117 -0
- data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
- data/rbi/orb/models/customer_delete_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
- data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
- data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
- data/rbi/orb/models/discount.rbi +23 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +22 -0
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +24 -0
- data/rbi/orb/models/item.rbi +143 -0
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +141 -0
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +31 -0
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
- data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
- data/rbi/orb/models/plan_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +19414 -0
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +24 -0
- data/rbi/orb/models/price_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
- data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
- data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
- data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
- data/rbi/orb/models/subscription_usage.rbi +446 -0
- data/rbi/orb/models/subscriptions.rbi +38 -0
- data/rbi/orb/models/top_level_ping_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +231 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
- data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
- data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
- data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
- data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +7 -14
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +36 -57
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +36 -57
- data/sig/orb/models/customer_update_params.rbs +36 -57
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +126 -188
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +41 -103
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +41 -75
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +55 -83
- data/sig/orb/models/plan_create_params.rbs +568 -746
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1250 -1790
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +72 -110
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +44 -84
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
- data/sig/orb/models/subscription_create_params.rbs +1223 -1619
- data/sig/orb/models/subscription_create_response.rbs +44 -84
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +738 -970
- data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +44 -84
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/models.rbs +215 -0
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +226 -223
- data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
- data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
- data/rbi/lib/orb/internal/type/union.rbi +0 -75
- data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
- data/rbi/lib/orb/internal/util.rbi +0 -299
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
- data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
- data/rbi/lib/orb/models/discount.rbi +0 -17
- data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
- data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
- data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
- data/rbi/lib/orb/models/item.rbi +0 -95
- data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/item_update_params.rbi +0 -101
- data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
- data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/price.rbi +0 -14861
- data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
- data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
- data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
- data/rbi/lib/orb/models/subscriptions.rbi +0 -31
- data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -3,6 +3,8 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class Invoice < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
sig { returns(String) }
|
7
9
|
attr_accessor :id
|
8
10
|
|
@@ -11,18 +13,19 @@ module Orb
|
|
11
13
|
sig { returns(String) }
|
12
14
|
attr_accessor :amount_due
|
13
15
|
|
14
|
-
sig { returns(Orb::
|
16
|
+
sig { returns(Orb::Invoice::AutoCollection) }
|
15
17
|
attr_reader :auto_collection
|
16
18
|
|
17
|
-
sig { params(auto_collection:
|
19
|
+
sig { params(auto_collection: Orb::Invoice::AutoCollection::OrHash).void }
|
18
20
|
attr_writer :auto_collection
|
19
21
|
|
20
|
-
sig { returns(T.nilable(Orb::
|
22
|
+
sig { returns(T.nilable(Orb::Invoice::BillingAddress)) }
|
21
23
|
attr_reader :billing_address
|
22
24
|
|
23
25
|
sig do
|
24
|
-
params(
|
25
|
-
.
|
26
|
+
params(
|
27
|
+
billing_address: T.nilable(Orb::Invoice::BillingAddress::OrHash)
|
28
|
+
).void
|
26
29
|
end
|
27
30
|
attr_writer :billing_address
|
28
31
|
|
@@ -31,20 +34,20 @@ module Orb
|
|
31
34
|
attr_accessor :created_at
|
32
35
|
|
33
36
|
# A list of credit notes associated with the invoice
|
34
|
-
sig { returns(T::Array[Orb::
|
37
|
+
sig { returns(T::Array[Orb::Invoice::CreditNote]) }
|
35
38
|
attr_accessor :credit_notes
|
36
39
|
|
37
40
|
# An ISO 4217 currency string or `credits`
|
38
41
|
sig { returns(String) }
|
39
42
|
attr_accessor :currency
|
40
43
|
|
41
|
-
sig { returns(Orb::
|
44
|
+
sig { returns(Orb::Invoice::Customer) }
|
42
45
|
attr_reader :customer
|
43
46
|
|
44
|
-
sig { params(customer:
|
47
|
+
sig { params(customer: Orb::Invoice::Customer::OrHash).void }
|
45
48
|
attr_writer :customer
|
46
49
|
|
47
|
-
sig { returns(T::Array[Orb::
|
50
|
+
sig { returns(T::Array[Orb::Invoice::CustomerBalanceTransaction]) }
|
48
51
|
attr_accessor :customer_balance_transactions
|
49
52
|
|
50
53
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
@@ -152,11 +155,13 @@ module Orb
|
|
152
155
|
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
153
156
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
154
157
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
155
|
-
sig { returns(T.nilable(Orb::
|
158
|
+
sig { returns(T.nilable(Orb::Invoice::CustomerTaxID)) }
|
156
159
|
attr_reader :customer_tax_id
|
157
160
|
|
158
161
|
sig do
|
159
|
-
params(
|
162
|
+
params(
|
163
|
+
customer_tax_id: T.nilable(Orb::Invoice::CustomerTaxID::OrHash)
|
164
|
+
).void
|
160
165
|
end
|
161
166
|
attr_writer :customer_tax_id
|
162
167
|
|
@@ -168,7 +173,13 @@ module Orb
|
|
168
173
|
|
169
174
|
sig do
|
170
175
|
returns(
|
171
|
-
T::Array[
|
176
|
+
T::Array[
|
177
|
+
T.any(
|
178
|
+
Orb::PercentageDiscount,
|
179
|
+
Orb::AmountDiscount,
|
180
|
+
Orb::TrialDiscount
|
181
|
+
)
|
182
|
+
]
|
172
183
|
)
|
173
184
|
end
|
174
185
|
attr_accessor :discounts
|
@@ -203,7 +214,7 @@ module Orb
|
|
203
214
|
sig { returns(T.nilable(String)) }
|
204
215
|
attr_accessor :invoice_pdf
|
205
216
|
|
206
|
-
sig { returns(Orb::
|
217
|
+
sig { returns(Orb::Invoice::InvoiceSource::TaggedSymbol) }
|
207
218
|
attr_accessor :invoice_source
|
208
219
|
|
209
220
|
# If the invoice failed to issue, this will be the last time it failed to issue
|
@@ -217,13 +228,13 @@ module Orb
|
|
217
228
|
attr_accessor :issued_at
|
218
229
|
|
219
230
|
# The breakdown of prices in this invoice.
|
220
|
-
sig { returns(T::Array[Orb::
|
231
|
+
sig { returns(T::Array[Orb::Invoice::LineItem]) }
|
221
232
|
attr_accessor :line_items
|
222
233
|
|
223
|
-
sig { returns(T.nilable(Orb::
|
234
|
+
sig { returns(T.nilable(Orb::Invoice::Maximum)) }
|
224
235
|
attr_reader :maximum
|
225
236
|
|
226
|
-
sig { params(maximum: T.nilable(
|
237
|
+
sig { params(maximum: T.nilable(Orb::Invoice::Maximum::OrHash)).void }
|
227
238
|
attr_writer :maximum
|
228
239
|
|
229
240
|
sig { returns(T.nilable(String)) }
|
@@ -240,10 +251,10 @@ module Orb
|
|
240
251
|
sig { returns(T::Hash[Symbol, String]) }
|
241
252
|
attr_accessor :metadata
|
242
253
|
|
243
|
-
sig { returns(T.nilable(Orb::
|
254
|
+
sig { returns(T.nilable(Orb::Invoice::Minimum)) }
|
244
255
|
attr_reader :minimum
|
245
256
|
|
246
|
-
sig { params(minimum: T.nilable(
|
257
|
+
sig { params(minimum: T.nilable(Orb::Invoice::Minimum::OrHash)).void }
|
247
258
|
attr_writer :minimum
|
248
259
|
|
249
260
|
sig { returns(T.nilable(String)) }
|
@@ -255,7 +266,7 @@ module Orb
|
|
255
266
|
attr_accessor :paid_at
|
256
267
|
|
257
268
|
# A list of payment attempts associated with the invoice
|
258
|
-
sig { returns(T::Array[Orb::
|
269
|
+
sig { returns(T::Array[Orb::Invoice::PaymentAttempt]) }
|
259
270
|
attr_accessor :payment_attempts
|
260
271
|
|
261
272
|
# If payment was attempted on this invoice but failed, this will be the time of
|
@@ -274,22 +285,25 @@ module Orb
|
|
274
285
|
sig { returns(T.nilable(Time)) }
|
275
286
|
attr_accessor :scheduled_issue_at
|
276
287
|
|
277
|
-
sig { returns(T.nilable(Orb::
|
288
|
+
sig { returns(T.nilable(Orb::Invoice::ShippingAddress)) }
|
278
289
|
attr_reader :shipping_address
|
279
290
|
|
280
291
|
sig do
|
281
|
-
params(
|
282
|
-
.
|
292
|
+
params(
|
293
|
+
shipping_address: T.nilable(Orb::Invoice::ShippingAddress::OrHash)
|
294
|
+
).void
|
283
295
|
end
|
284
296
|
attr_writer :shipping_address
|
285
297
|
|
286
|
-
sig { returns(Orb::
|
298
|
+
sig { returns(Orb::Invoice::Status::TaggedSymbol) }
|
287
299
|
attr_accessor :status
|
288
300
|
|
289
|
-
sig { returns(T.nilable(Orb::
|
301
|
+
sig { returns(T.nilable(Orb::Invoice::Subscription)) }
|
290
302
|
attr_reader :subscription
|
291
303
|
|
292
|
-
sig
|
304
|
+
sig do
|
305
|
+
params(subscription: T.nilable(Orb::Invoice::Subscription::OrHash)).void
|
306
|
+
end
|
293
307
|
attr_writer :subscription
|
294
308
|
|
295
309
|
# The total before any discounts and minimums are applied.
|
@@ -325,54 +339,54 @@ module Orb
|
|
325
339
|
params(
|
326
340
|
id: String,
|
327
341
|
amount_due: String,
|
328
|
-
auto_collection:
|
329
|
-
billing_address: T.nilable(
|
342
|
+
auto_collection: Orb::Invoice::AutoCollection::OrHash,
|
343
|
+
billing_address: T.nilable(Orb::Invoice::BillingAddress::OrHash),
|
330
344
|
created_at: Time,
|
331
|
-
credit_notes: T::Array[
|
345
|
+
credit_notes: T::Array[Orb::Invoice::CreditNote::OrHash],
|
332
346
|
currency: String,
|
333
|
-
customer:
|
334
|
-
customer_balance_transactions:
|
335
|
-
|
347
|
+
customer: Orb::Invoice::Customer::OrHash,
|
348
|
+
customer_balance_transactions:
|
349
|
+
T::Array[Orb::Invoice::CustomerBalanceTransaction::OrHash],
|
350
|
+
customer_tax_id: T.nilable(Orb::Invoice::CustomerTaxID::OrHash),
|
336
351
|
discount: T.anything,
|
337
|
-
discounts:
|
338
|
-
T
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
352
|
+
discounts:
|
353
|
+
T::Array[
|
354
|
+
T.any(
|
355
|
+
Orb::PercentageDiscount::OrHash,
|
356
|
+
Orb::AmountDiscount::OrHash,
|
357
|
+
Orb::TrialDiscount::OrHash
|
358
|
+
)
|
359
|
+
],
|
345
360
|
due_date: T.nilable(Time),
|
346
361
|
eligible_to_issue_at: T.nilable(Time),
|
347
362
|
hosted_invoice_url: T.nilable(String),
|
348
363
|
invoice_date: Time,
|
349
364
|
invoice_number: String,
|
350
365
|
invoice_pdf: T.nilable(String),
|
351
|
-
invoice_source: Orb::
|
366
|
+
invoice_source: Orb::Invoice::InvoiceSource::OrSymbol,
|
352
367
|
issue_failed_at: T.nilable(Time),
|
353
368
|
issued_at: T.nilable(Time),
|
354
|
-
line_items: T::Array[
|
355
|
-
maximum: T.nilable(
|
369
|
+
line_items: T::Array[Orb::Invoice::LineItem::OrHash],
|
370
|
+
maximum: T.nilable(Orb::Invoice::Maximum::OrHash),
|
356
371
|
maximum_amount: T.nilable(String),
|
357
372
|
memo: T.nilable(String),
|
358
373
|
metadata: T::Hash[Symbol, String],
|
359
|
-
minimum: T.nilable(
|
374
|
+
minimum: T.nilable(Orb::Invoice::Minimum::OrHash),
|
360
375
|
minimum_amount: T.nilable(String),
|
361
376
|
paid_at: T.nilable(Time),
|
362
|
-
payment_attempts: T::Array[
|
377
|
+
payment_attempts: T::Array[Orb::Invoice::PaymentAttempt::OrHash],
|
363
378
|
payment_failed_at: T.nilable(Time),
|
364
379
|
payment_started_at: T.nilable(Time),
|
365
380
|
scheduled_issue_at: T.nilable(Time),
|
366
|
-
shipping_address: T.nilable(
|
367
|
-
status: Orb::
|
368
|
-
subscription: T.nilable(
|
381
|
+
shipping_address: T.nilable(Orb::Invoice::ShippingAddress::OrHash),
|
382
|
+
status: Orb::Invoice::Status::OrSymbol,
|
383
|
+
subscription: T.nilable(Orb::Invoice::Subscription::OrHash),
|
369
384
|
subtotal: String,
|
370
385
|
sync_failed_at: T.nilable(Time),
|
371
386
|
total: String,
|
372
387
|
voided_at: T.nilable(Time),
|
373
388
|
will_auto_issue: T::Boolean
|
374
|
-
)
|
375
|
-
.returns(T.attached_class)
|
389
|
+
).returns(T.attached_class)
|
376
390
|
end
|
377
391
|
def self.new(
|
378
392
|
id:,
|
@@ -570,58 +584,70 @@ module Orb
|
|
570
584
|
# This is true if the invoice will be automatically issued in the future, and
|
571
585
|
# false otherwise.
|
572
586
|
will_auto_issue:
|
573
|
-
)
|
587
|
+
)
|
588
|
+
end
|
589
|
+
|
574
590
|
sig do
|
575
|
-
override
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
591
|
+
override.returns(
|
592
|
+
{
|
593
|
+
id: String,
|
594
|
+
amount_due: String,
|
595
|
+
auto_collection: Orb::Invoice::AutoCollection,
|
596
|
+
billing_address: T.nilable(Orb::Invoice::BillingAddress),
|
597
|
+
created_at: Time,
|
598
|
+
credit_notes: T::Array[Orb::Invoice::CreditNote],
|
599
|
+
currency: String,
|
600
|
+
customer: Orb::Invoice::Customer,
|
601
|
+
customer_balance_transactions:
|
602
|
+
T::Array[Orb::Invoice::CustomerBalanceTransaction],
|
603
|
+
customer_tax_id: T.nilable(Orb::Invoice::CustomerTaxID),
|
604
|
+
discount: T.anything,
|
605
|
+
discounts:
|
606
|
+
T::Array[
|
607
|
+
T.any(
|
608
|
+
Orb::PercentageDiscount,
|
609
|
+
Orb::AmountDiscount,
|
610
|
+
Orb::TrialDiscount
|
611
|
+
)
|
612
|
+
],
|
613
|
+
due_date: T.nilable(Time),
|
614
|
+
eligible_to_issue_at: T.nilable(Time),
|
615
|
+
hosted_invoice_url: T.nilable(String),
|
616
|
+
invoice_date: Time,
|
617
|
+
invoice_number: String,
|
618
|
+
invoice_pdf: T.nilable(String),
|
619
|
+
invoice_source: Orb::Invoice::InvoiceSource::TaggedSymbol,
|
620
|
+
issue_failed_at: T.nilable(Time),
|
621
|
+
issued_at: T.nilable(Time),
|
622
|
+
line_items: T::Array[Orb::Invoice::LineItem],
|
623
|
+
maximum: T.nilable(Orb::Invoice::Maximum),
|
624
|
+
maximum_amount: T.nilable(String),
|
625
|
+
memo: T.nilable(String),
|
626
|
+
metadata: T::Hash[Symbol, String],
|
627
|
+
minimum: T.nilable(Orb::Invoice::Minimum),
|
628
|
+
minimum_amount: T.nilable(String),
|
629
|
+
paid_at: T.nilable(Time),
|
630
|
+
payment_attempts: T::Array[Orb::Invoice::PaymentAttempt],
|
631
|
+
payment_failed_at: T.nilable(Time),
|
632
|
+
payment_started_at: T.nilable(Time),
|
633
|
+
scheduled_issue_at: T.nilable(Time),
|
634
|
+
shipping_address: T.nilable(Orb::Invoice::ShippingAddress),
|
635
|
+
status: Orb::Invoice::Status::TaggedSymbol,
|
636
|
+
subscription: T.nilable(Orb::Invoice::Subscription),
|
637
|
+
subtotal: String,
|
638
|
+
sync_failed_at: T.nilable(Time),
|
639
|
+
total: String,
|
640
|
+
voided_at: T.nilable(Time),
|
641
|
+
will_auto_issue: T::Boolean
|
642
|
+
}
|
643
|
+
)
|
644
|
+
end
|
645
|
+
def to_hash
|
621
646
|
end
|
622
|
-
def to_hash; end
|
623
647
|
|
624
648
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
649
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
650
|
+
|
625
651
|
# True only if auto-collection is enabled for this invoice.
|
626
652
|
sig { returns(T.nilable(T::Boolean)) }
|
627
653
|
attr_accessor :enabled
|
@@ -651,8 +677,7 @@ module Orb
|
|
651
677
|
next_attempt_at: T.nilable(Time),
|
652
678
|
num_attempts: T.nilable(Integer),
|
653
679
|
previously_attempted_at: T.nilable(Time)
|
654
|
-
)
|
655
|
-
.returns(T.attached_class)
|
680
|
+
).returns(T.attached_class)
|
656
681
|
end
|
657
682
|
def self.new(
|
658
683
|
# True only if auto-collection is enabled for this invoice.
|
@@ -670,22 +695,26 @@ module Orb
|
|
670
695
|
# if dunning has been exhausted (`previously_attempted_at` is non-null, but
|
671
696
|
# `next_attempt_time` is null).
|
672
697
|
previously_attempted_at:
|
673
|
-
)
|
698
|
+
)
|
699
|
+
end
|
700
|
+
|
674
701
|
sig do
|
675
|
-
override
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
702
|
+
override.returns(
|
703
|
+
{
|
704
|
+
enabled: T.nilable(T::Boolean),
|
705
|
+
next_attempt_at: T.nilable(Time),
|
706
|
+
num_attempts: T.nilable(Integer),
|
707
|
+
previously_attempted_at: T.nilable(Time)
|
708
|
+
}
|
709
|
+
)
|
710
|
+
end
|
711
|
+
def to_hash
|
684
712
|
end
|
685
|
-
def to_hash; end
|
686
713
|
end
|
687
714
|
|
688
715
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
716
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
717
|
+
|
689
718
|
sig { returns(T.nilable(String)) }
|
690
719
|
attr_accessor :city
|
691
720
|
|
@@ -712,28 +741,30 @@ module Orb
|
|
712
741
|
line2: T.nilable(String),
|
713
742
|
postal_code: T.nilable(String),
|
714
743
|
state: T.nilable(String)
|
715
|
-
)
|
716
|
-
|
744
|
+
).returns(T.attached_class)
|
745
|
+
end
|
746
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
717
747
|
end
|
718
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
719
748
|
|
720
749
|
sig do
|
721
|
-
override
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
750
|
+
override.returns(
|
751
|
+
{
|
752
|
+
city: T.nilable(String),
|
753
|
+
country: T.nilable(String),
|
754
|
+
line1: T.nilable(String),
|
755
|
+
line2: T.nilable(String),
|
756
|
+
postal_code: T.nilable(String),
|
757
|
+
state: T.nilable(String)
|
758
|
+
}
|
759
|
+
)
|
760
|
+
end
|
761
|
+
def to_hash
|
732
762
|
end
|
733
|
-
def to_hash; end
|
734
763
|
end
|
735
764
|
|
736
765
|
class CreditNote < Orb::Internal::Type::BaseModel
|
766
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
767
|
+
|
737
768
|
sig { returns(String) }
|
738
769
|
attr_accessor :id
|
739
770
|
|
@@ -767,8 +798,7 @@ module Orb
|
|
767
798
|
total: String,
|
768
799
|
type: String,
|
769
800
|
voided_at: T.nilable(Time)
|
770
|
-
)
|
771
|
-
.returns(T.attached_class)
|
801
|
+
).returns(T.attached_class)
|
772
802
|
end
|
773
803
|
def self.new(
|
774
804
|
id:,
|
@@ -781,44 +811,64 @@ module Orb
|
|
781
811
|
# If the credit note has a status of `void`, this gives a timestamp when the
|
782
812
|
# credit note was voided.
|
783
813
|
voided_at:
|
784
|
-
)
|
814
|
+
)
|
815
|
+
end
|
816
|
+
|
785
817
|
sig do
|
786
|
-
override
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
818
|
+
override.returns(
|
819
|
+
{
|
820
|
+
id: String,
|
821
|
+
credit_note_number: String,
|
822
|
+
memo: T.nilable(String),
|
823
|
+
reason: String,
|
824
|
+
total: String,
|
825
|
+
type: String,
|
826
|
+
voided_at: T.nilable(Time)
|
827
|
+
}
|
828
|
+
)
|
829
|
+
end
|
830
|
+
def to_hash
|
798
831
|
end
|
799
|
-
def to_hash; end
|
800
832
|
end
|
801
833
|
|
802
834
|
class Customer < Orb::Internal::Type::BaseModel
|
835
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
836
|
+
|
803
837
|
sig { returns(String) }
|
804
838
|
attr_accessor :id
|
805
839
|
|
806
840
|
sig { returns(T.nilable(String)) }
|
807
841
|
attr_accessor :external_customer_id
|
808
842
|
|
809
|
-
sig
|
810
|
-
|
843
|
+
sig do
|
844
|
+
params(id: String, external_customer_id: T.nilable(String)).returns(
|
845
|
+
T.attached_class
|
846
|
+
)
|
847
|
+
end
|
848
|
+
def self.new(id:, external_customer_id:)
|
849
|
+
end
|
811
850
|
|
812
|
-
sig
|
813
|
-
|
851
|
+
sig do
|
852
|
+
override.returns(
|
853
|
+
{ id: String, external_customer_id: T.nilable(String) }
|
854
|
+
)
|
855
|
+
end
|
856
|
+
def to_hash
|
857
|
+
end
|
814
858
|
end
|
815
859
|
|
816
860
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
861
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
862
|
+
|
817
863
|
# A unique id for this transaction.
|
818
864
|
sig { returns(String) }
|
819
865
|
attr_accessor :id
|
820
866
|
|
821
|
-
sig
|
867
|
+
sig do
|
868
|
+
returns(
|
869
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
870
|
+
)
|
871
|
+
end
|
822
872
|
attr_accessor :action
|
823
873
|
|
824
874
|
# The value of the amount changed in the transaction.
|
@@ -829,14 +879,20 @@ module Orb
|
|
829
879
|
sig { returns(Time) }
|
830
880
|
attr_accessor :created_at
|
831
881
|
|
832
|
-
sig
|
882
|
+
sig do
|
883
|
+
returns(
|
884
|
+
T.nilable(Orb::Invoice::CustomerBalanceTransaction::CreditNote)
|
885
|
+
)
|
886
|
+
end
|
833
887
|
attr_reader :credit_note
|
834
888
|
|
835
889
|
sig do
|
836
890
|
params(
|
837
|
-
credit_note:
|
838
|
-
|
839
|
-
|
891
|
+
credit_note:
|
892
|
+
T.nilable(
|
893
|
+
Orb::Invoice::CustomerBalanceTransaction::CreditNote::OrHash
|
894
|
+
)
|
895
|
+
).void
|
840
896
|
end
|
841
897
|
attr_writer :credit_note
|
842
898
|
|
@@ -849,14 +905,18 @@ module Orb
|
|
849
905
|
sig { returns(String) }
|
850
906
|
attr_accessor :ending_balance
|
851
907
|
|
852
|
-
sig
|
908
|
+
sig do
|
909
|
+
returns(T.nilable(Orb::Invoice::CustomerBalanceTransaction::Invoice))
|
910
|
+
end
|
853
911
|
attr_reader :invoice
|
854
912
|
|
855
913
|
sig do
|
856
914
|
params(
|
857
|
-
invoice:
|
858
|
-
|
859
|
-
|
915
|
+
invoice:
|
916
|
+
T.nilable(
|
917
|
+
Orb::Invoice::CustomerBalanceTransaction::Invoice::OrHash
|
918
|
+
)
|
919
|
+
).void
|
860
920
|
end
|
861
921
|
attr_writer :invoice
|
862
922
|
|
@@ -865,23 +925,30 @@ module Orb
|
|
865
925
|
sig { returns(String) }
|
866
926
|
attr_accessor :starting_balance
|
867
927
|
|
868
|
-
sig
|
928
|
+
sig do
|
929
|
+
returns(Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol)
|
930
|
+
end
|
869
931
|
attr_accessor :type
|
870
932
|
|
871
933
|
sig do
|
872
934
|
params(
|
873
935
|
id: String,
|
874
|
-
action: Orb::
|
936
|
+
action: Orb::Invoice::CustomerBalanceTransaction::Action::OrSymbol,
|
875
937
|
amount: String,
|
876
938
|
created_at: Time,
|
877
|
-
credit_note:
|
939
|
+
credit_note:
|
940
|
+
T.nilable(
|
941
|
+
Orb::Invoice::CustomerBalanceTransaction::CreditNote::OrHash
|
942
|
+
),
|
878
943
|
description: T.nilable(String),
|
879
944
|
ending_balance: String,
|
880
|
-
invoice:
|
945
|
+
invoice:
|
946
|
+
T.nilable(
|
947
|
+
Orb::Invoice::CustomerBalanceTransaction::Invoice::OrHash
|
948
|
+
),
|
881
949
|
starting_balance: String,
|
882
|
-
type: Orb::
|
883
|
-
)
|
884
|
-
.returns(T.attached_class)
|
950
|
+
type: Orb::Invoice::CustomerBalanceTransaction::Type::OrSymbol
|
951
|
+
).returns(T.attached_class)
|
885
952
|
end
|
886
953
|
def self.new(
|
887
954
|
# A unique id for this transaction.
|
@@ -902,56 +969,100 @@ module Orb
|
|
902
969
|
# customer's currency.
|
903
970
|
starting_balance:,
|
904
971
|
type:
|
905
|
-
)
|
972
|
+
)
|
973
|
+
end
|
974
|
+
|
906
975
|
sig do
|
907
|
-
override
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
|
914
|
-
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
976
|
+
override.returns(
|
977
|
+
{
|
978
|
+
id: String,
|
979
|
+
action:
|
980
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol,
|
981
|
+
amount: String,
|
982
|
+
created_at: Time,
|
983
|
+
credit_note:
|
984
|
+
T.nilable(Orb::Invoice::CustomerBalanceTransaction::CreditNote),
|
985
|
+
description: T.nilable(String),
|
986
|
+
ending_balance: String,
|
987
|
+
invoice:
|
988
|
+
T.nilable(Orb::Invoice::CustomerBalanceTransaction::Invoice),
|
989
|
+
starting_balance: String,
|
990
|
+
type: Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
991
|
+
}
|
992
|
+
)
|
993
|
+
end
|
994
|
+
def to_hash
|
922
995
|
end
|
923
|
-
def to_hash; end
|
924
996
|
|
925
997
|
module Action
|
926
998
|
extend Orb::Internal::Type::Enum
|
927
999
|
|
928
|
-
TaggedSymbol =
|
1000
|
+
TaggedSymbol =
|
1001
|
+
T.type_alias do
|
1002
|
+
T.all(Symbol, Orb::Invoice::CustomerBalanceTransaction::Action)
|
1003
|
+
end
|
929
1004
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
930
1005
|
|
931
1006
|
APPLIED_TO_INVOICE =
|
932
|
-
T.let(
|
1007
|
+
T.let(
|
1008
|
+
:applied_to_invoice,
|
1009
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1010
|
+
)
|
933
1011
|
MANUAL_ADJUSTMENT =
|
934
|
-
T.let(
|
1012
|
+
T.let(
|
1013
|
+
:manual_adjustment,
|
1014
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1015
|
+
)
|
935
1016
|
PRORATED_REFUND =
|
936
|
-
T.let(
|
1017
|
+
T.let(
|
1018
|
+
:prorated_refund,
|
1019
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1020
|
+
)
|
937
1021
|
REVERT_PRORATED_REFUND =
|
938
|
-
T.let(
|
1022
|
+
T.let(
|
1023
|
+
:revert_prorated_refund,
|
1024
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1025
|
+
)
|
939
1026
|
RETURN_FROM_VOIDING =
|
940
|
-
T.let(
|
1027
|
+
T.let(
|
1028
|
+
:return_from_voiding,
|
1029
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1030
|
+
)
|
941
1031
|
CREDIT_NOTE_APPLIED =
|
942
|
-
T.let(
|
1032
|
+
T.let(
|
1033
|
+
:credit_note_applied,
|
1034
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1035
|
+
)
|
943
1036
|
CREDIT_NOTE_VOIDED =
|
944
|
-
T.let(
|
1037
|
+
T.let(
|
1038
|
+
:credit_note_voided,
|
1039
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1040
|
+
)
|
945
1041
|
OVERPAYMENT_REFUND =
|
946
|
-
T.let(
|
1042
|
+
T.let(
|
1043
|
+
:overpayment_refund,
|
1044
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1045
|
+
)
|
947
1046
|
EXTERNAL_PAYMENT =
|
948
|
-
T.let(
|
1047
|
+
T.let(
|
1048
|
+
:external_payment,
|
1049
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1050
|
+
)
|
949
1051
|
|
950
|
-
sig
|
951
|
-
|
1052
|
+
sig do
|
1053
|
+
override.returns(
|
1054
|
+
T::Array[
|
1055
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1056
|
+
]
|
1057
|
+
)
|
1058
|
+
end
|
1059
|
+
def self.values
|
1060
|
+
end
|
952
1061
|
end
|
953
1062
|
|
954
1063
|
class CreditNote < Orb::Internal::Type::BaseModel
|
1064
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1065
|
+
|
955
1066
|
# The id of the Credit note
|
956
1067
|
sig { returns(String) }
|
957
1068
|
attr_accessor :id
|
@@ -960,12 +1071,17 @@ module Orb
|
|
960
1071
|
def self.new(
|
961
1072
|
# The id of the Credit note
|
962
1073
|
id:
|
963
|
-
)
|
964
|
-
|
965
|
-
|
1074
|
+
)
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
sig { override.returns({ id: String }) }
|
1078
|
+
def to_hash
|
1079
|
+
end
|
966
1080
|
end
|
967
1081
|
|
968
1082
|
class Invoice < Orb::Internal::Type::BaseModel
|
1083
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1084
|
+
|
969
1085
|
# The Invoice id
|
970
1086
|
sig { returns(String) }
|
971
1087
|
attr_accessor :id
|
@@ -974,30 +1090,53 @@ module Orb
|
|
974
1090
|
def self.new(
|
975
1091
|
# The Invoice id
|
976
1092
|
id:
|
977
|
-
)
|
978
|
-
|
979
|
-
|
1093
|
+
)
|
1094
|
+
end
|
1095
|
+
|
1096
|
+
sig { override.returns({ id: String }) }
|
1097
|
+
def to_hash
|
1098
|
+
end
|
980
1099
|
end
|
981
1100
|
|
982
1101
|
module Type
|
983
1102
|
extend Orb::Internal::Type::Enum
|
984
1103
|
|
985
|
-
TaggedSymbol =
|
1104
|
+
TaggedSymbol =
|
1105
|
+
T.type_alias do
|
1106
|
+
T.all(Symbol, Orb::Invoice::CustomerBalanceTransaction::Type)
|
1107
|
+
end
|
986
1108
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
987
1109
|
|
988
|
-
INCREMENT =
|
989
|
-
|
1110
|
+
INCREMENT =
|
1111
|
+
T.let(
|
1112
|
+
:increment,
|
1113
|
+
Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1114
|
+
)
|
1115
|
+
DECREMENT =
|
1116
|
+
T.let(
|
1117
|
+
:decrement,
|
1118
|
+
Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1119
|
+
)
|
990
1120
|
|
991
|
-
sig
|
992
|
-
|
1121
|
+
sig do
|
1122
|
+
override.returns(
|
1123
|
+
T::Array[
|
1124
|
+
Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1125
|
+
]
|
1126
|
+
)
|
1127
|
+
end
|
1128
|
+
def self.values
|
1129
|
+
end
|
993
1130
|
end
|
994
1131
|
end
|
995
1132
|
|
996
1133
|
class CustomerTaxID < Orb::Internal::Type::BaseModel
|
997
|
-
|
1134
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1135
|
+
|
1136
|
+
sig { returns(Orb::Invoice::CustomerTaxID::Country::TaggedSymbol) }
|
998
1137
|
attr_accessor :country
|
999
1138
|
|
1000
|
-
sig { returns(Orb::
|
1139
|
+
sig { returns(Orb::Invoice::CustomerTaxID::Type::TaggedSymbol) }
|
1001
1140
|
attr_accessor :type
|
1002
1141
|
|
1003
1142
|
sig { returns(String) }
|
@@ -1110,213 +1249,299 @@ module Orb
|
|
1110
1249
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
1111
1250
|
sig do
|
1112
1251
|
params(
|
1113
|
-
country: Orb::
|
1114
|
-
type: Orb::
|
1252
|
+
country: Orb::Invoice::CustomerTaxID::Country::OrSymbol,
|
1253
|
+
type: Orb::Invoice::CustomerTaxID::Type::OrSymbol,
|
1115
1254
|
value: String
|
1116
|
-
)
|
1117
|
-
|
1255
|
+
).returns(T.attached_class)
|
1256
|
+
end
|
1257
|
+
def self.new(country:, type:, value:)
|
1118
1258
|
end
|
1119
|
-
def self.new(country:, type:, value:); end
|
1120
1259
|
|
1121
1260
|
sig do
|
1122
|
-
override
|
1123
|
-
|
1124
|
-
|
1125
|
-
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1261
|
+
override.returns(
|
1262
|
+
{
|
1263
|
+
country: Orb::Invoice::CustomerTaxID::Country::TaggedSymbol,
|
1264
|
+
type: Orb::Invoice::CustomerTaxID::Type::TaggedSymbol,
|
1265
|
+
value: String
|
1266
|
+
}
|
1267
|
+
)
|
1268
|
+
end
|
1269
|
+
def to_hash
|
1130
1270
|
end
|
1131
|
-
def to_hash; end
|
1132
1271
|
|
1133
1272
|
module Country
|
1134
1273
|
extend Orb::Internal::Type::Enum
|
1135
1274
|
|
1136
|
-
TaggedSymbol =
|
1275
|
+
TaggedSymbol =
|
1276
|
+
T.type_alias { T.all(Symbol, Orb::Invoice::CustomerTaxID::Country) }
|
1137
1277
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1138
1278
|
|
1139
|
-
AD = T.let(:AD, Orb::
|
1140
|
-
AE = T.let(:AE, Orb::
|
1141
|
-
AR = T.let(:AR, Orb::
|
1142
|
-
AT = T.let(:AT, Orb::
|
1143
|
-
AU = T.let(:AU, Orb::
|
1144
|
-
BE = T.let(:BE, Orb::
|
1145
|
-
BG = T.let(:BG, Orb::
|
1146
|
-
BH = T.let(:BH, Orb::
|
1147
|
-
BO = T.let(:BO, Orb::
|
1148
|
-
BR = T.let(:BR, Orb::
|
1149
|
-
CA = T.let(:CA, Orb::
|
1150
|
-
CH = T.let(:CH, Orb::
|
1151
|
-
CL = T.let(:CL, Orb::
|
1152
|
-
CN = T.let(:CN, Orb::
|
1153
|
-
CO = T.let(:CO, Orb::
|
1154
|
-
CR = T.let(:CR, Orb::
|
1155
|
-
CY = T.let(:CY, Orb::
|
1156
|
-
CZ = T.let(:CZ, Orb::
|
1157
|
-
DE = T.let(:DE, Orb::
|
1158
|
-
DK = T.let(:DK, Orb::
|
1159
|
-
EE = T.let(:EE, Orb::
|
1160
|
-
DO = T.let(:DO, Orb::
|
1161
|
-
EC = T.let(:EC, Orb::
|
1162
|
-
EG = T.let(:EG, Orb::
|
1163
|
-
ES = T.let(:ES, Orb::
|
1164
|
-
EU = T.let(:EU, Orb::
|
1165
|
-
FI = T.let(:FI, Orb::
|
1166
|
-
FR = T.let(:FR, Orb::
|
1167
|
-
GB = T.let(:GB, Orb::
|
1168
|
-
GE = T.let(:GE, Orb::
|
1169
|
-
GR = T.let(:GR, Orb::
|
1170
|
-
HK = T.let(:HK, Orb::
|
1171
|
-
HR = T.let(:HR, Orb::
|
1172
|
-
HU = T.let(:HU, Orb::
|
1173
|
-
ID = T.let(:ID, Orb::
|
1174
|
-
IE = T.let(:IE, Orb::
|
1175
|
-
IL = T.let(:IL, Orb::
|
1176
|
-
IN = T.let(:IN, Orb::
|
1177
|
-
IS = T.let(:IS, Orb::
|
1178
|
-
IT = T.let(:IT, Orb::
|
1179
|
-
JP = T.let(:JP, Orb::
|
1180
|
-
KE = T.let(:KE, Orb::
|
1181
|
-
KR = T.let(:KR, Orb::
|
1182
|
-
KZ = T.let(:KZ, Orb::
|
1183
|
-
LI = T.let(:LI, Orb::
|
1184
|
-
LT = T.let(:LT, Orb::
|
1185
|
-
LU = T.let(:LU, Orb::
|
1186
|
-
LV = T.let(:LV, Orb::
|
1187
|
-
MT = T.let(:MT, Orb::
|
1188
|
-
MX = T.let(:MX, Orb::
|
1189
|
-
MY = T.let(:MY, Orb::
|
1190
|
-
NG = T.let(:NG, Orb::
|
1191
|
-
NL = T.let(:NL, Orb::
|
1192
|
-
NO = T.let(:NO, Orb::
|
1193
|
-
NZ = T.let(:NZ, Orb::
|
1194
|
-
OM = T.let(:OM, Orb::
|
1195
|
-
PE = T.let(:PE, Orb::
|
1196
|
-
PH = T.let(:PH, Orb::
|
1197
|
-
PL = T.let(:PL, Orb::
|
1198
|
-
PT = T.let(:PT, Orb::
|
1199
|
-
RO = T.let(:RO, Orb::
|
1200
|
-
RS = T.let(:RS, Orb::
|
1201
|
-
RU = T.let(:RU, Orb::
|
1202
|
-
SA = T.let(:SA, Orb::
|
1203
|
-
SE = T.let(:SE, Orb::
|
1204
|
-
SG = T.let(:SG, Orb::
|
1205
|
-
SI = T.let(:SI, Orb::
|
1206
|
-
SK = T.let(:SK, Orb::
|
1207
|
-
SV = T.let(:SV, Orb::
|
1208
|
-
TH = T.let(:TH, Orb::
|
1209
|
-
TR = T.let(:TR, Orb::
|
1210
|
-
TW = T.let(:TW, Orb::
|
1211
|
-
UA = T.let(:UA, Orb::
|
1212
|
-
US = T.let(:US, Orb::
|
1213
|
-
UY = T.let(:UY, Orb::
|
1214
|
-
VE = T.let(:VE, Orb::
|
1215
|
-
VN = T.let(:VN, Orb::
|
1216
|
-
ZA = T.let(:ZA, Orb::
|
1217
|
-
|
1218
|
-
sig
|
1219
|
-
|
1279
|
+
AD = T.let(:AD, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1280
|
+
AE = T.let(:AE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1281
|
+
AR = T.let(:AR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1282
|
+
AT = T.let(:AT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1283
|
+
AU = T.let(:AU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1284
|
+
BE = T.let(:BE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1285
|
+
BG = T.let(:BG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1286
|
+
BH = T.let(:BH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1287
|
+
BO = T.let(:BO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1288
|
+
BR = T.let(:BR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1289
|
+
CA = T.let(:CA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1290
|
+
CH = T.let(:CH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1291
|
+
CL = T.let(:CL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1292
|
+
CN = T.let(:CN, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1293
|
+
CO = T.let(:CO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1294
|
+
CR = T.let(:CR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1295
|
+
CY = T.let(:CY, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1296
|
+
CZ = T.let(:CZ, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1297
|
+
DE = T.let(:DE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1298
|
+
DK = T.let(:DK, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1299
|
+
EE = T.let(:EE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1300
|
+
DO = T.let(:DO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1301
|
+
EC = T.let(:EC, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1302
|
+
EG = T.let(:EG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1303
|
+
ES = T.let(:ES, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1304
|
+
EU = T.let(:EU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1305
|
+
FI = T.let(:FI, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1306
|
+
FR = T.let(:FR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1307
|
+
GB = T.let(:GB, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1308
|
+
GE = T.let(:GE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1309
|
+
GR = T.let(:GR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1310
|
+
HK = T.let(:HK, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1311
|
+
HR = T.let(:HR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1312
|
+
HU = T.let(:HU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1313
|
+
ID = T.let(:ID, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1314
|
+
IE = T.let(:IE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1315
|
+
IL = T.let(:IL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1316
|
+
IN = T.let(:IN, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1317
|
+
IS = T.let(:IS, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1318
|
+
IT = T.let(:IT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1319
|
+
JP = T.let(:JP, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1320
|
+
KE = T.let(:KE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1321
|
+
KR = T.let(:KR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1322
|
+
KZ = T.let(:KZ, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1323
|
+
LI = T.let(:LI, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1324
|
+
LT = T.let(:LT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1325
|
+
LU = T.let(:LU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1326
|
+
LV = T.let(:LV, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1327
|
+
MT = T.let(:MT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1328
|
+
MX = T.let(:MX, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1329
|
+
MY = T.let(:MY, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1330
|
+
NG = T.let(:NG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1331
|
+
NL = T.let(:NL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1332
|
+
NO = T.let(:NO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1333
|
+
NZ = T.let(:NZ, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1334
|
+
OM = T.let(:OM, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1335
|
+
PE = T.let(:PE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1336
|
+
PH = T.let(:PH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1337
|
+
PL = T.let(:PL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1338
|
+
PT = T.let(:PT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1339
|
+
RO = T.let(:RO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1340
|
+
RS = T.let(:RS, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1341
|
+
RU = T.let(:RU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1342
|
+
SA = T.let(:SA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1343
|
+
SE = T.let(:SE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1344
|
+
SG = T.let(:SG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1345
|
+
SI = T.let(:SI, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1346
|
+
SK = T.let(:SK, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1347
|
+
SV = T.let(:SV, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1348
|
+
TH = T.let(:TH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1349
|
+
TR = T.let(:TR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1350
|
+
TW = T.let(:TW, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1351
|
+
UA = T.let(:UA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1352
|
+
US = T.let(:US, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1353
|
+
UY = T.let(:UY, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1354
|
+
VE = T.let(:VE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1355
|
+
VN = T.let(:VN, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1356
|
+
ZA = T.let(:ZA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1357
|
+
|
1358
|
+
sig do
|
1359
|
+
override.returns(
|
1360
|
+
T::Array[Orb::Invoice::CustomerTaxID::Country::TaggedSymbol]
|
1361
|
+
)
|
1362
|
+
end
|
1363
|
+
def self.values
|
1364
|
+
end
|
1220
1365
|
end
|
1221
1366
|
|
1222
1367
|
module Type
|
1223
1368
|
extend Orb::Internal::Type::Enum
|
1224
1369
|
|
1225
|
-
TaggedSymbol =
|
1370
|
+
TaggedSymbol =
|
1371
|
+
T.type_alias { T.all(Symbol, Orb::Invoice::CustomerTaxID::Type) }
|
1226
1372
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1227
1373
|
|
1228
|
-
AD_NRT =
|
1229
|
-
|
1230
|
-
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1244
|
-
|
1245
|
-
|
1246
|
-
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1256
|
-
|
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
|
-
|
1374
|
+
AD_NRT =
|
1375
|
+
T.let(:ad_nrt, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1376
|
+
AE_TRN =
|
1377
|
+
T.let(:ae_trn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1378
|
+
AR_CUIT =
|
1379
|
+
T.let(:ar_cuit, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1380
|
+
EU_VAT =
|
1381
|
+
T.let(:eu_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1382
|
+
AU_ABN =
|
1383
|
+
T.let(:au_abn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1384
|
+
AU_ARN =
|
1385
|
+
T.let(:au_arn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1386
|
+
BG_UIC =
|
1387
|
+
T.let(:bg_uic, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1388
|
+
BH_VAT =
|
1389
|
+
T.let(:bh_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1390
|
+
BO_TIN =
|
1391
|
+
T.let(:bo_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1392
|
+
BR_CNPJ =
|
1393
|
+
T.let(:br_cnpj, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1394
|
+
BR_CPF =
|
1395
|
+
T.let(:br_cpf, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1396
|
+
CA_BN = T.let(:ca_bn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1397
|
+
CA_GST_HST =
|
1398
|
+
T.let(:ca_gst_hst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1399
|
+
CA_PST_BC =
|
1400
|
+
T.let(:ca_pst_bc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1401
|
+
CA_PST_MB =
|
1402
|
+
T.let(:ca_pst_mb, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1403
|
+
CA_PST_SK =
|
1404
|
+
T.let(:ca_pst_sk, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1405
|
+
CA_QST =
|
1406
|
+
T.let(:ca_qst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1407
|
+
CH_VAT =
|
1408
|
+
T.let(:ch_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1409
|
+
CL_TIN =
|
1410
|
+
T.let(:cl_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1411
|
+
CN_TIN =
|
1412
|
+
T.let(:cn_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1413
|
+
CO_NIT =
|
1414
|
+
T.let(:co_nit, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1415
|
+
CR_TIN =
|
1416
|
+
T.let(:cr_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1417
|
+
DO_RCN =
|
1418
|
+
T.let(:do_rcn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1419
|
+
EC_RUC =
|
1420
|
+
T.let(:ec_ruc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1421
|
+
EG_TIN =
|
1422
|
+
T.let(:eg_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1423
|
+
ES_CIF =
|
1424
|
+
T.let(:es_cif, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1425
|
+
EU_OSS_VAT =
|
1426
|
+
T.let(:eu_oss_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1427
|
+
GB_VAT =
|
1428
|
+
T.let(:gb_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1429
|
+
GE_VAT =
|
1430
|
+
T.let(:ge_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1431
|
+
HK_BR = T.let(:hk_br, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1432
|
+
HU_TIN =
|
1433
|
+
T.let(:hu_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1434
|
+
ID_NPWP =
|
1435
|
+
T.let(:id_npwp, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1436
|
+
IL_VAT =
|
1437
|
+
T.let(:il_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1438
|
+
IN_GST =
|
1439
|
+
T.let(:in_gst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1440
|
+
IS_VAT =
|
1441
|
+
T.let(:is_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1442
|
+
JP_CN = T.let(:jp_cn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1443
|
+
JP_RN = T.let(:jp_rn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1444
|
+
JP_TRN =
|
1445
|
+
T.let(:jp_trn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1446
|
+
KE_PIN =
|
1447
|
+
T.let(:ke_pin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1448
|
+
KR_BRN =
|
1449
|
+
T.let(:kr_brn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1450
|
+
KZ_BIN =
|
1451
|
+
T.let(:kz_bin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1452
|
+
LI_UID =
|
1453
|
+
T.let(:li_uid, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1454
|
+
MX_RFC =
|
1455
|
+
T.let(:mx_rfc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1456
|
+
MY_FRP =
|
1457
|
+
T.let(:my_frp, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1458
|
+
MY_ITN =
|
1459
|
+
T.let(:my_itn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1460
|
+
MY_SST =
|
1461
|
+
T.let(:my_sst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1462
|
+
NG_TIN =
|
1463
|
+
T.let(:ng_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1464
|
+
NO_VAT =
|
1465
|
+
T.let(:no_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1466
|
+
NO_VOEC =
|
1467
|
+
T.let(:no_voec, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1468
|
+
NZ_GST =
|
1469
|
+
T.let(:nz_gst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1470
|
+
OM_VAT =
|
1471
|
+
T.let(:om_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1472
|
+
PE_RUC =
|
1473
|
+
T.let(:pe_ruc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1474
|
+
PH_TIN =
|
1475
|
+
T.let(:ph_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1476
|
+
RO_TIN =
|
1477
|
+
T.let(:ro_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1478
|
+
RS_PIB =
|
1479
|
+
T.let(:rs_pib, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1480
|
+
RU_INN =
|
1481
|
+
T.let(:ru_inn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1482
|
+
RU_KPP =
|
1483
|
+
T.let(:ru_kpp, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1484
|
+
SA_VAT =
|
1485
|
+
T.let(:sa_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1486
|
+
SG_GST =
|
1487
|
+
T.let(:sg_gst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1488
|
+
SG_UEN =
|
1489
|
+
T.let(:sg_uen, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1490
|
+
SI_TIN =
|
1491
|
+
T.let(:si_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1492
|
+
SV_NIT =
|
1493
|
+
T.let(:sv_nit, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1494
|
+
TH_VAT =
|
1495
|
+
T.let(:th_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1496
|
+
TR_TIN =
|
1497
|
+
T.let(:tr_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1498
|
+
TW_VAT =
|
1499
|
+
T.let(:tw_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1500
|
+
UA_VAT =
|
1501
|
+
T.let(:ua_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1502
|
+
US_EIN =
|
1503
|
+
T.let(:us_ein, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1504
|
+
UY_RUC =
|
1505
|
+
T.let(:uy_ruc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1506
|
+
VE_RIF =
|
1507
|
+
T.let(:ve_rif, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1508
|
+
VN_TIN =
|
1509
|
+
T.let(:vn_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1510
|
+
ZA_VAT =
|
1511
|
+
T.let(:za_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1512
|
+
|
1513
|
+
sig do
|
1514
|
+
override.returns(
|
1515
|
+
T::Array[Orb::Invoice::CustomerTaxID::Type::TaggedSymbol]
|
1516
|
+
)
|
1517
|
+
end
|
1518
|
+
def self.values
|
1519
|
+
end
|
1302
1520
|
end
|
1303
1521
|
end
|
1304
1522
|
|
1305
1523
|
module InvoiceSource
|
1306
1524
|
extend Orb::Internal::Type::Enum
|
1307
1525
|
|
1308
|
-
TaggedSymbol =
|
1526
|
+
TaggedSymbol =
|
1527
|
+
T.type_alias { T.all(Symbol, Orb::Invoice::InvoiceSource) }
|
1309
1528
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1310
1529
|
|
1311
|
-
SUBSCRIPTION =
|
1312
|
-
|
1313
|
-
|
1530
|
+
SUBSCRIPTION =
|
1531
|
+
T.let(:subscription, Orb::Invoice::InvoiceSource::TaggedSymbol)
|
1532
|
+
PARTIAL = T.let(:partial, Orb::Invoice::InvoiceSource::TaggedSymbol)
|
1533
|
+
ONE_OFF = T.let(:one_off, Orb::Invoice::InvoiceSource::TaggedSymbol)
|
1314
1534
|
|
1315
|
-
sig
|
1316
|
-
|
1535
|
+
sig do
|
1536
|
+
override.returns(T::Array[Orb::Invoice::InvoiceSource::TaggedSymbol])
|
1537
|
+
end
|
1538
|
+
def self.values
|
1539
|
+
end
|
1317
1540
|
end
|
1318
1541
|
|
1319
1542
|
class LineItem < Orb::Internal::Type::BaseModel
|
1543
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1544
|
+
|
1320
1545
|
# A unique ID for this line item.
|
1321
1546
|
sig { returns(String) }
|
1322
1547
|
attr_accessor :id
|
@@ -1333,11 +1558,11 @@ module Orb
|
|
1333
1558
|
returns(
|
1334
1559
|
T::Array[
|
1335
1560
|
T.any(
|
1336
|
-
Orb::
|
1337
|
-
Orb::
|
1338
|
-
Orb::
|
1339
|
-
Orb::
|
1340
|
-
Orb::
|
1561
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
1562
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
1563
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
1564
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
1565
|
+
Orb::Invoice::LineItem::Adjustment::Maximum
|
1341
1566
|
)
|
1342
1567
|
]
|
1343
1568
|
)
|
@@ -1357,10 +1582,10 @@ module Orb
|
|
1357
1582
|
returns(
|
1358
1583
|
T.nilable(
|
1359
1584
|
T.any(
|
1360
|
-
Orb::
|
1361
|
-
Orb::
|
1362
|
-
Orb::
|
1363
|
-
Orb::
|
1585
|
+
Orb::PercentageDiscount,
|
1586
|
+
Orb::TrialDiscount,
|
1587
|
+
Orb::UsageDiscount,
|
1588
|
+
Orb::AmountDiscount
|
1364
1589
|
)
|
1365
1590
|
)
|
1366
1591
|
)
|
@@ -1382,10 +1607,14 @@ module Orb
|
|
1382
1607
|
attr_accessor :grouping
|
1383
1608
|
|
1384
1609
|
# This field is deprecated in favor of `adjustments`.
|
1385
|
-
sig { returns(T.nilable(Orb::
|
1610
|
+
sig { returns(T.nilable(Orb::Invoice::LineItem::Maximum)) }
|
1386
1611
|
attr_reader :maximum
|
1387
1612
|
|
1388
|
-
sig
|
1613
|
+
sig do
|
1614
|
+
params(
|
1615
|
+
maximum: T.nilable(Orb::Invoice::LineItem::Maximum::OrHash)
|
1616
|
+
).void
|
1617
|
+
end
|
1389
1618
|
attr_writer :maximum
|
1390
1619
|
|
1391
1620
|
# This field is deprecated in favor of `adjustments`.
|
@@ -1393,10 +1622,14 @@ module Orb
|
|
1393
1622
|
attr_accessor :maximum_amount
|
1394
1623
|
|
1395
1624
|
# This field is deprecated in favor of `adjustments`.
|
1396
|
-
sig { returns(T.nilable(Orb::
|
1625
|
+
sig { returns(T.nilable(Orb::Invoice::LineItem::Minimum)) }
|
1397
1626
|
attr_reader :minimum
|
1398
1627
|
|
1399
|
-
sig
|
1628
|
+
sig do
|
1629
|
+
params(
|
1630
|
+
minimum: T.nilable(Orb::Invoice::LineItem::Minimum::OrHash)
|
1631
|
+
).void
|
1632
|
+
end
|
1400
1633
|
attr_writer :minimum
|
1401
1634
|
|
1402
1635
|
# This field is deprecated in favor of `adjustments`.
|
@@ -1425,34 +1658,34 @@ module Orb
|
|
1425
1658
|
returns(
|
1426
1659
|
T.nilable(
|
1427
1660
|
T.any(
|
1428
|
-
Orb::
|
1429
|
-
Orb::
|
1430
|
-
Orb::
|
1431
|
-
Orb::
|
1432
|
-
Orb::
|
1433
|
-
Orb::
|
1434
|
-
Orb::
|
1435
|
-
Orb::
|
1436
|
-
Orb::
|
1437
|
-
Orb::
|
1438
|
-
Orb::
|
1439
|
-
Orb::
|
1440
|
-
Orb::
|
1441
|
-
Orb::
|
1442
|
-
Orb::
|
1443
|
-
Orb::
|
1444
|
-
Orb::
|
1445
|
-
Orb::
|
1446
|
-
Orb::
|
1447
|
-
Orb::
|
1448
|
-
Orb::
|
1449
|
-
Orb::
|
1450
|
-
Orb::
|
1451
|
-
Orb::
|
1452
|
-
Orb::
|
1453
|
-
Orb::
|
1454
|
-
Orb::
|
1455
|
-
Orb::
|
1661
|
+
Orb::Price::Unit,
|
1662
|
+
Orb::Price::Package,
|
1663
|
+
Orb::Price::Matrix,
|
1664
|
+
Orb::Price::Tiered,
|
1665
|
+
Orb::Price::TieredBps,
|
1666
|
+
Orb::Price::Bps,
|
1667
|
+
Orb::Price::BulkBps,
|
1668
|
+
Orb::Price::Bulk,
|
1669
|
+
Orb::Price::ThresholdTotalAmount,
|
1670
|
+
Orb::Price::TieredPackage,
|
1671
|
+
Orb::Price::GroupedTiered,
|
1672
|
+
Orb::Price::TieredWithMinimum,
|
1673
|
+
Orb::Price::TieredPackageWithMinimum,
|
1674
|
+
Orb::Price::PackageWithAllocation,
|
1675
|
+
Orb::Price::UnitWithPercent,
|
1676
|
+
Orb::Price::MatrixWithAllocation,
|
1677
|
+
Orb::Price::TieredWithProration,
|
1678
|
+
Orb::Price::UnitWithProration,
|
1679
|
+
Orb::Price::GroupedAllocation,
|
1680
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1681
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1682
|
+
Orb::Price::MatrixWithDisplayName,
|
1683
|
+
Orb::Price::BulkWithProration,
|
1684
|
+
Orb::Price::GroupedTieredPackage,
|
1685
|
+
Orb::Price::MaxGroupTieredPackage,
|
1686
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1687
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1688
|
+
Orb::Price::CumulativeGroupedBulk
|
1456
1689
|
)
|
1457
1690
|
)
|
1458
1691
|
)
|
@@ -1473,9 +1706,9 @@ module Orb
|
|
1473
1706
|
returns(
|
1474
1707
|
T::Array[
|
1475
1708
|
T.any(
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1709
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
1710
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
1711
|
+
Orb::Invoice::LineItem::SubLineItem::Null
|
1479
1712
|
)
|
1480
1713
|
]
|
1481
1714
|
)
|
@@ -1488,7 +1721,7 @@ module Orb
|
|
1488
1721
|
|
1489
1722
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
1490
1723
|
# integration is configured.
|
1491
|
-
sig { returns(T::Array[Orb::
|
1724
|
+
sig { returns(T::Array[Orb::Invoice::LineItem::TaxAmount]) }
|
1492
1725
|
attr_accessor :tax_amounts
|
1493
1726
|
|
1494
1727
|
# A list of customer ids that were used to calculate the usage for this line item.
|
@@ -1499,84 +1732,83 @@ module Orb
|
|
1499
1732
|
params(
|
1500
1733
|
id: String,
|
1501
1734
|
adjusted_subtotal: String,
|
1502
|
-
adjustments:
|
1503
|
-
T
|
1504
|
-
|
1505
|
-
|
1506
|
-
|
1507
|
-
|
1508
|
-
|
1509
|
-
|
1510
|
-
|
1511
|
-
|
1735
|
+
adjustments:
|
1736
|
+
T::Array[
|
1737
|
+
T.any(
|
1738
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount::OrHash,
|
1739
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount::OrHash,
|
1740
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount::OrHash,
|
1741
|
+
Orb::Invoice::LineItem::Adjustment::Minimum::OrHash,
|
1742
|
+
Orb::Invoice::LineItem::Adjustment::Maximum::OrHash
|
1743
|
+
)
|
1744
|
+
],
|
1512
1745
|
amount: String,
|
1513
1746
|
credits_applied: String,
|
1514
|
-
discount:
|
1515
|
-
T.
|
1516
|
-
|
1517
|
-
|
1518
|
-
|
1519
|
-
|
1520
|
-
|
1521
|
-
|
1522
|
-
|
1747
|
+
discount:
|
1748
|
+
T.nilable(
|
1749
|
+
T.any(
|
1750
|
+
Orb::PercentageDiscount::OrHash,
|
1751
|
+
Orb::TrialDiscount::OrHash,
|
1752
|
+
Orb::UsageDiscount::OrHash,
|
1753
|
+
Orb::AmountDiscount::OrHash
|
1754
|
+
)
|
1755
|
+
),
|
1523
1756
|
end_date: Time,
|
1524
1757
|
filter: T.nilable(String),
|
1525
1758
|
grouping: T.nilable(String),
|
1526
|
-
maximum: T.nilable(
|
1759
|
+
maximum: T.nilable(Orb::Invoice::LineItem::Maximum::OrHash),
|
1527
1760
|
maximum_amount: T.nilable(String),
|
1528
|
-
minimum: T.nilable(
|
1761
|
+
minimum: T.nilable(Orb::Invoice::LineItem::Minimum::OrHash),
|
1529
1762
|
minimum_amount: T.nilable(String),
|
1530
1763
|
name: String,
|
1531
1764
|
partially_invoiced_amount: String,
|
1532
|
-
price:
|
1533
|
-
T.
|
1534
|
-
|
1535
|
-
|
1536
|
-
|
1537
|
-
|
1538
|
-
|
1539
|
-
|
1540
|
-
|
1541
|
-
|
1542
|
-
|
1543
|
-
|
1544
|
-
|
1545
|
-
|
1546
|
-
|
1547
|
-
|
1548
|
-
|
1549
|
-
|
1550
|
-
|
1551
|
-
|
1552
|
-
|
1553
|
-
|
1554
|
-
|
1555
|
-
|
1556
|
-
|
1557
|
-
|
1558
|
-
|
1559
|
-
|
1560
|
-
|
1561
|
-
|
1562
|
-
|
1563
|
-
|
1564
|
-
|
1765
|
+
price:
|
1766
|
+
T.nilable(
|
1767
|
+
T.any(
|
1768
|
+
Orb::Price::Unit::OrHash,
|
1769
|
+
Orb::Price::Package::OrHash,
|
1770
|
+
Orb::Price::Matrix::OrHash,
|
1771
|
+
Orb::Price::Tiered::OrHash,
|
1772
|
+
Orb::Price::TieredBps::OrHash,
|
1773
|
+
Orb::Price::Bps::OrHash,
|
1774
|
+
Orb::Price::BulkBps::OrHash,
|
1775
|
+
Orb::Price::Bulk::OrHash,
|
1776
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1777
|
+
Orb::Price::TieredPackage::OrHash,
|
1778
|
+
Orb::Price::GroupedTiered::OrHash,
|
1779
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1780
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1781
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1782
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1783
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1784
|
+
Orb::Price::TieredWithProration::OrHash,
|
1785
|
+
Orb::Price::UnitWithProration::OrHash,
|
1786
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1787
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1788
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1789
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1790
|
+
Orb::Price::BulkWithProration::OrHash,
|
1791
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1792
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1793
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1794
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1795
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1796
|
+
)
|
1797
|
+
),
|
1565
1798
|
quantity: Float,
|
1566
1799
|
start_date: Time,
|
1567
|
-
sub_line_items:
|
1568
|
-
T
|
1569
|
-
|
1570
|
-
|
1571
|
-
|
1572
|
-
|
1573
|
-
|
1574
|
-
|
1800
|
+
sub_line_items:
|
1801
|
+
T::Array[
|
1802
|
+
T.any(
|
1803
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::OrHash,
|
1804
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::OrHash,
|
1805
|
+
Orb::Invoice::LineItem::SubLineItem::Null::OrHash
|
1806
|
+
)
|
1807
|
+
],
|
1575
1808
|
subtotal: String,
|
1576
|
-
tax_amounts: T::Array[
|
1809
|
+
tax_amounts: T::Array[Orb::Invoice::LineItem::TaxAmount::OrHash],
|
1577
1810
|
usage_customer_ids: T.nilable(T::Array[String])
|
1578
|
-
)
|
1579
|
-
.returns(T.attached_class)
|
1811
|
+
).returns(T.attached_class)
|
1580
1812
|
end
|
1581
1813
|
def self.new(
|
1582
1814
|
# A unique ID for this line item.
|
@@ -1639,94 +1871,113 @@ module Orb
|
|
1639
1871
|
tax_amounts:,
|
1640
1872
|
# A list of customer ids that were used to calculate the usage for this line item.
|
1641
1873
|
usage_customer_ids:
|
1642
|
-
)
|
1874
|
+
)
|
1875
|
+
end
|
1876
|
+
|
1643
1877
|
sig do
|
1644
|
-
override
|
1645
|
-
|
1646
|
-
|
1647
|
-
|
1648
|
-
|
1649
|
-
|
1878
|
+
override.returns(
|
1879
|
+
{
|
1880
|
+
id: String,
|
1881
|
+
adjusted_subtotal: String,
|
1882
|
+
adjustments:
|
1883
|
+
T::Array[
|
1650
1884
|
T.any(
|
1651
|
-
Orb::
|
1652
|
-
Orb::
|
1653
|
-
Orb::
|
1654
|
-
Orb::
|
1655
|
-
Orb::
|
1885
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
1886
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
1887
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
1888
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
1889
|
+
Orb::Invoice::LineItem::Adjustment::Maximum
|
1656
1890
|
)
|
1657
1891
|
],
|
1658
|
-
|
1659
|
-
|
1660
|
-
|
1892
|
+
amount: String,
|
1893
|
+
credits_applied: String,
|
1894
|
+
discount:
|
1895
|
+
T.nilable(
|
1661
1896
|
T.any(
|
1662
|
-
Orb::
|
1663
|
-
Orb::
|
1664
|
-
Orb::
|
1665
|
-
Orb::
|
1897
|
+
Orb::PercentageDiscount,
|
1898
|
+
Orb::TrialDiscount,
|
1899
|
+
Orb::UsageDiscount,
|
1900
|
+
Orb::AmountDiscount
|
1666
1901
|
)
|
1667
1902
|
),
|
1668
|
-
|
1669
|
-
|
1670
|
-
|
1671
|
-
|
1672
|
-
|
1673
|
-
|
1674
|
-
|
1675
|
-
|
1676
|
-
|
1677
|
-
|
1903
|
+
end_date: Time,
|
1904
|
+
filter: T.nilable(String),
|
1905
|
+
grouping: T.nilable(String),
|
1906
|
+
maximum: T.nilable(Orb::Invoice::LineItem::Maximum),
|
1907
|
+
maximum_amount: T.nilable(String),
|
1908
|
+
minimum: T.nilable(Orb::Invoice::LineItem::Minimum),
|
1909
|
+
minimum_amount: T.nilable(String),
|
1910
|
+
name: String,
|
1911
|
+
partially_invoiced_amount: String,
|
1912
|
+
price:
|
1913
|
+
T.nilable(
|
1678
1914
|
T.any(
|
1679
|
-
Orb::
|
1680
|
-
Orb::
|
1681
|
-
Orb::
|
1682
|
-
Orb::
|
1683
|
-
Orb::
|
1684
|
-
Orb::
|
1685
|
-
Orb::
|
1686
|
-
Orb::
|
1687
|
-
Orb::
|
1688
|
-
Orb::
|
1689
|
-
Orb::
|
1690
|
-
Orb::
|
1691
|
-
Orb::
|
1692
|
-
Orb::
|
1693
|
-
Orb::
|
1694
|
-
Orb::
|
1695
|
-
Orb::
|
1696
|
-
Orb::
|
1697
|
-
Orb::
|
1698
|
-
Orb::
|
1699
|
-
Orb::
|
1700
|
-
Orb::
|
1701
|
-
Orb::
|
1702
|
-
Orb::
|
1703
|
-
Orb::
|
1704
|
-
Orb::
|
1705
|
-
Orb::
|
1706
|
-
Orb::
|
1915
|
+
Orb::Price::Unit,
|
1916
|
+
Orb::Price::Package,
|
1917
|
+
Orb::Price::Matrix,
|
1918
|
+
Orb::Price::Tiered,
|
1919
|
+
Orb::Price::TieredBps,
|
1920
|
+
Orb::Price::Bps,
|
1921
|
+
Orb::Price::BulkBps,
|
1922
|
+
Orb::Price::Bulk,
|
1923
|
+
Orb::Price::ThresholdTotalAmount,
|
1924
|
+
Orb::Price::TieredPackage,
|
1925
|
+
Orb::Price::GroupedTiered,
|
1926
|
+
Orb::Price::TieredWithMinimum,
|
1927
|
+
Orb::Price::TieredPackageWithMinimum,
|
1928
|
+
Orb::Price::PackageWithAllocation,
|
1929
|
+
Orb::Price::UnitWithPercent,
|
1930
|
+
Orb::Price::MatrixWithAllocation,
|
1931
|
+
Orb::Price::TieredWithProration,
|
1932
|
+
Orb::Price::UnitWithProration,
|
1933
|
+
Orb::Price::GroupedAllocation,
|
1934
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1935
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1936
|
+
Orb::Price::MatrixWithDisplayName,
|
1937
|
+
Orb::Price::BulkWithProration,
|
1938
|
+
Orb::Price::GroupedTieredPackage,
|
1939
|
+
Orb::Price::MaxGroupTieredPackage,
|
1940
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1941
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1942
|
+
Orb::Price::CumulativeGroupedBulk
|
1707
1943
|
)
|
1708
1944
|
),
|
1709
|
-
|
1710
|
-
|
1711
|
-
|
1945
|
+
quantity: Float,
|
1946
|
+
start_date: Time,
|
1947
|
+
sub_line_items:
|
1948
|
+
T::Array[
|
1712
1949
|
T.any(
|
1713
|
-
Orb::
|
1714
|
-
Orb::
|
1715
|
-
Orb::
|
1950
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
1951
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
1952
|
+
Orb::Invoice::LineItem::SubLineItem::Null
|
1716
1953
|
)
|
1717
1954
|
],
|
1718
|
-
|
1719
|
-
|
1720
|
-
|
1721
|
-
|
1722
|
-
|
1955
|
+
subtotal: String,
|
1956
|
+
tax_amounts: T::Array[Orb::Invoice::LineItem::TaxAmount],
|
1957
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1958
|
+
}
|
1959
|
+
)
|
1960
|
+
end
|
1961
|
+
def to_hash
|
1723
1962
|
end
|
1724
|
-
def to_hash; end
|
1725
1963
|
|
1726
1964
|
module Adjustment
|
1727
1965
|
extend Orb::Internal::Type::Union
|
1728
1966
|
|
1729
|
-
|
1967
|
+
Variants =
|
1968
|
+
T.type_alias do
|
1969
|
+
T.any(
|
1970
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
1971
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
1972
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
1973
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
1974
|
+
Orb::Invoice::LineItem::Adjustment::Maximum
|
1975
|
+
)
|
1976
|
+
end
|
1977
|
+
|
1978
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
1979
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1980
|
+
|
1730
1981
|
sig { returns(String) }
|
1731
1982
|
attr_accessor :id
|
1732
1983
|
|
@@ -1764,8 +2015,7 @@ module Orb
|
|
1764
2015
|
reason: T.nilable(String),
|
1765
2016
|
usage_discount: Float,
|
1766
2017
|
adjustment_type: Symbol
|
1767
|
-
)
|
1768
|
-
.returns(T.attached_class)
|
2018
|
+
).returns(T.attached_class)
|
1769
2019
|
end
|
1770
2020
|
def self.new(
|
1771
2021
|
id:,
|
@@ -1782,25 +2032,29 @@ module Orb
|
|
1782
2032
|
# to in a given billing period.
|
1783
2033
|
usage_discount:,
|
1784
2034
|
adjustment_type: :usage_discount
|
1785
|
-
)
|
2035
|
+
)
|
2036
|
+
end
|
2037
|
+
|
1786
2038
|
sig do
|
1787
|
-
override
|
1788
|
-
|
1789
|
-
|
1790
|
-
|
1791
|
-
|
1792
|
-
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
1796
|
-
|
1797
|
-
|
1798
|
-
|
2039
|
+
override.returns(
|
2040
|
+
{
|
2041
|
+
id: String,
|
2042
|
+
adjustment_type: Symbol,
|
2043
|
+
amount: String,
|
2044
|
+
applies_to_price_ids: T::Array[String],
|
2045
|
+
is_invoice_level: T::Boolean,
|
2046
|
+
reason: T.nilable(String),
|
2047
|
+
usage_discount: Float
|
2048
|
+
}
|
2049
|
+
)
|
2050
|
+
end
|
2051
|
+
def to_hash
|
1799
2052
|
end
|
1800
|
-
def to_hash; end
|
1801
2053
|
end
|
1802
2054
|
|
1803
|
-
class
|
2055
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
2056
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2057
|
+
|
1804
2058
|
sig { returns(String) }
|
1805
2059
|
attr_accessor :id
|
1806
2060
|
|
@@ -1838,8 +2092,7 @@ module Orb
|
|
1838
2092
|
is_invoice_level: T::Boolean,
|
1839
2093
|
reason: T.nilable(String),
|
1840
2094
|
adjustment_type: Symbol
|
1841
|
-
)
|
1842
|
-
.returns(T.attached_class)
|
2095
|
+
).returns(T.attached_class)
|
1843
2096
|
end
|
1844
2097
|
def self.new(
|
1845
2098
|
id:,
|
@@ -1856,25 +2109,29 @@ module Orb
|
|
1856
2109
|
# The reason for the adjustment.
|
1857
2110
|
reason:,
|
1858
2111
|
adjustment_type: :amount_discount
|
1859
|
-
)
|
2112
|
+
)
|
2113
|
+
end
|
2114
|
+
|
1860
2115
|
sig do
|
1861
|
-
override
|
1862
|
-
|
1863
|
-
|
1864
|
-
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1872
|
-
|
2116
|
+
override.returns(
|
2117
|
+
{
|
2118
|
+
id: String,
|
2119
|
+
adjustment_type: Symbol,
|
2120
|
+
amount: String,
|
2121
|
+
amount_discount: String,
|
2122
|
+
applies_to_price_ids: T::Array[String],
|
2123
|
+
is_invoice_level: T::Boolean,
|
2124
|
+
reason: T.nilable(String)
|
2125
|
+
}
|
2126
|
+
)
|
2127
|
+
end
|
2128
|
+
def to_hash
|
1873
2129
|
end
|
1874
|
-
def to_hash; end
|
1875
2130
|
end
|
1876
2131
|
|
1877
|
-
class
|
2132
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
2133
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2134
|
+
|
1878
2135
|
sig { returns(String) }
|
1879
2136
|
attr_accessor :id
|
1880
2137
|
|
@@ -1912,8 +2169,7 @@ module Orb
|
|
1912
2169
|
percentage_discount: Float,
|
1913
2170
|
reason: T.nilable(String),
|
1914
2171
|
adjustment_type: Symbol
|
1915
|
-
)
|
1916
|
-
.returns(T.attached_class)
|
2172
|
+
).returns(T.attached_class)
|
1917
2173
|
end
|
1918
2174
|
def self.new(
|
1919
2175
|
id:,
|
@@ -1930,25 +2186,29 @@ module Orb
|
|
1930
2186
|
# The reason for the adjustment.
|
1931
2187
|
reason:,
|
1932
2188
|
adjustment_type: :percentage_discount
|
1933
|
-
)
|
2189
|
+
)
|
2190
|
+
end
|
2191
|
+
|
1934
2192
|
sig do
|
1935
|
-
override
|
1936
|
-
|
1937
|
-
|
1938
|
-
|
1939
|
-
|
1940
|
-
|
1941
|
-
|
1942
|
-
|
1943
|
-
|
1944
|
-
|
1945
|
-
|
1946
|
-
|
2193
|
+
override.returns(
|
2194
|
+
{
|
2195
|
+
id: String,
|
2196
|
+
adjustment_type: Symbol,
|
2197
|
+
amount: String,
|
2198
|
+
applies_to_price_ids: T::Array[String],
|
2199
|
+
is_invoice_level: T::Boolean,
|
2200
|
+
percentage_discount: Float,
|
2201
|
+
reason: T.nilable(String)
|
2202
|
+
}
|
2203
|
+
)
|
2204
|
+
end
|
2205
|
+
def to_hash
|
1947
2206
|
end
|
1948
|
-
def to_hash; end
|
1949
2207
|
end
|
1950
2208
|
|
1951
|
-
class
|
2209
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
2210
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2211
|
+
|
1952
2212
|
sig { returns(String) }
|
1953
2213
|
attr_accessor :id
|
1954
2214
|
|
@@ -1991,8 +2251,7 @@ module Orb
|
|
1991
2251
|
minimum_amount: String,
|
1992
2252
|
reason: T.nilable(String),
|
1993
2253
|
adjustment_type: Symbol
|
1994
|
-
)
|
1995
|
-
.returns(T.attached_class)
|
2254
|
+
).returns(T.attached_class)
|
1996
2255
|
end
|
1997
2256
|
def self.new(
|
1998
2257
|
id:,
|
@@ -2011,26 +2270,30 @@ module Orb
|
|
2011
2270
|
# The reason for the adjustment.
|
2012
2271
|
reason:,
|
2013
2272
|
adjustment_type: :minimum
|
2014
|
-
)
|
2273
|
+
)
|
2274
|
+
end
|
2275
|
+
|
2015
2276
|
sig do
|
2016
|
-
override
|
2017
|
-
|
2018
|
-
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
2022
|
-
|
2023
|
-
|
2024
|
-
|
2025
|
-
|
2026
|
-
|
2027
|
-
|
2028
|
-
|
2277
|
+
override.returns(
|
2278
|
+
{
|
2279
|
+
id: String,
|
2280
|
+
adjustment_type: Symbol,
|
2281
|
+
amount: String,
|
2282
|
+
applies_to_price_ids: T::Array[String],
|
2283
|
+
is_invoice_level: T::Boolean,
|
2284
|
+
item_id: String,
|
2285
|
+
minimum_amount: String,
|
2286
|
+
reason: T.nilable(String)
|
2287
|
+
}
|
2288
|
+
)
|
2289
|
+
end
|
2290
|
+
def to_hash
|
2029
2291
|
end
|
2030
|
-
def to_hash; end
|
2031
2292
|
end
|
2032
2293
|
|
2033
|
-
class
|
2294
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
2295
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2296
|
+
|
2034
2297
|
sig { returns(String) }
|
2035
2298
|
attr_accessor :id
|
2036
2299
|
|
@@ -2068,8 +2331,7 @@ module Orb
|
|
2068
2331
|
maximum_amount: String,
|
2069
2332
|
reason: T.nilable(String),
|
2070
2333
|
adjustment_type: Symbol
|
2071
|
-
)
|
2072
|
-
.returns(T.attached_class)
|
2334
|
+
).returns(T.attached_class)
|
2073
2335
|
end
|
2074
2336
|
def self.new(
|
2075
2337
|
id:,
|
@@ -2086,34 +2348,38 @@ module Orb
|
|
2086
2348
|
# The reason for the adjustment.
|
2087
2349
|
reason:,
|
2088
2350
|
adjustment_type: :maximum
|
2089
|
-
)
|
2351
|
+
)
|
2352
|
+
end
|
2353
|
+
|
2090
2354
|
sig do
|
2091
|
-
override
|
2092
|
-
|
2093
|
-
|
2094
|
-
|
2095
|
-
|
2096
|
-
|
2097
|
-
|
2098
|
-
|
2099
|
-
|
2100
|
-
|
2101
|
-
|
2102
|
-
|
2355
|
+
override.returns(
|
2356
|
+
{
|
2357
|
+
id: String,
|
2358
|
+
adjustment_type: Symbol,
|
2359
|
+
amount: String,
|
2360
|
+
applies_to_price_ids: T::Array[String],
|
2361
|
+
is_invoice_level: T::Boolean,
|
2362
|
+
maximum_amount: String,
|
2363
|
+
reason: T.nilable(String)
|
2364
|
+
}
|
2365
|
+
)
|
2366
|
+
end
|
2367
|
+
def to_hash
|
2103
2368
|
end
|
2104
|
-
def to_hash; end
|
2105
2369
|
end
|
2106
2370
|
|
2107
2371
|
sig do
|
2108
|
-
override
|
2109
|
-
|
2110
|
-
|
2111
|
-
|
2372
|
+
override.returns(
|
2373
|
+
T::Array[Orb::Invoice::LineItem::Adjustment::Variants]
|
2374
|
+
)
|
2375
|
+
end
|
2376
|
+
def self.variants
|
2112
2377
|
end
|
2113
|
-
def self.variants; end
|
2114
2378
|
end
|
2115
2379
|
|
2116
2380
|
class Maximum < Orb::Internal::Type::BaseModel
|
2381
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2382
|
+
|
2117
2383
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2118
2384
|
# maximums, this can be a subset of prices.
|
2119
2385
|
sig { returns(T::Array[String]) }
|
@@ -2125,7 +2391,10 @@ module Orb
|
|
2125
2391
|
|
2126
2392
|
# This field is deprecated in favor of `adjustments`.
|
2127
2393
|
sig do
|
2128
|
-
params(
|
2394
|
+
params(
|
2395
|
+
applies_to_price_ids: T::Array[String],
|
2396
|
+
maximum_amount: String
|
2397
|
+
).returns(T.attached_class)
|
2129
2398
|
end
|
2130
2399
|
def self.new(
|
2131
2400
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -2133,12 +2402,21 @@ module Orb
|
|
2133
2402
|
applies_to_price_ids:,
|
2134
2403
|
# Maximum amount applied
|
2135
2404
|
maximum_amount:
|
2136
|
-
)
|
2137
|
-
|
2138
|
-
|
2405
|
+
)
|
2406
|
+
end
|
2407
|
+
|
2408
|
+
sig do
|
2409
|
+
override.returns(
|
2410
|
+
{ applies_to_price_ids: T::Array[String], maximum_amount: String }
|
2411
|
+
)
|
2412
|
+
end
|
2413
|
+
def to_hash
|
2414
|
+
end
|
2139
2415
|
end
|
2140
2416
|
|
2141
2417
|
class Minimum < Orb::Internal::Type::BaseModel
|
2418
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2419
|
+
|
2142
2420
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2143
2421
|
# minimums, this can be a subset of prices.
|
2144
2422
|
sig { returns(T::Array[String]) }
|
@@ -2150,7 +2428,10 @@ module Orb
|
|
2150
2428
|
|
2151
2429
|
# This field is deprecated in favor of `adjustments`.
|
2152
2430
|
sig do
|
2153
|
-
params(
|
2431
|
+
params(
|
2432
|
+
applies_to_price_ids: T::Array[String],
|
2433
|
+
minimum_amount: String
|
2434
|
+
).returns(T.attached_class)
|
2154
2435
|
end
|
2155
2436
|
def self.new(
|
2156
2437
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -2158,43 +2439,64 @@ module Orb
|
|
2158
2439
|
applies_to_price_ids:,
|
2159
2440
|
# Minimum amount applied
|
2160
2441
|
minimum_amount:
|
2161
|
-
)
|
2162
|
-
|
2163
|
-
|
2442
|
+
)
|
2443
|
+
end
|
2444
|
+
|
2445
|
+
sig do
|
2446
|
+
override.returns(
|
2447
|
+
{ applies_to_price_ids: T::Array[String], minimum_amount: String }
|
2448
|
+
)
|
2449
|
+
end
|
2450
|
+
def to_hash
|
2451
|
+
end
|
2164
2452
|
end
|
2165
2453
|
|
2166
2454
|
module SubLineItem
|
2167
2455
|
extend Orb::Internal::Type::Union
|
2168
2456
|
|
2169
|
-
|
2457
|
+
Variants =
|
2458
|
+
T.type_alias do
|
2459
|
+
T.any(
|
2460
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
2461
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
2462
|
+
Orb::Invoice::LineItem::SubLineItem::Null
|
2463
|
+
)
|
2464
|
+
end
|
2465
|
+
|
2466
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
2467
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2468
|
+
|
2170
2469
|
# The total amount for this sub line item.
|
2171
2470
|
sig { returns(String) }
|
2172
2471
|
attr_accessor :amount
|
2173
2472
|
|
2174
|
-
sig
|
2473
|
+
sig do
|
2474
|
+
returns(
|
2475
|
+
T.nilable(Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping)
|
2476
|
+
)
|
2477
|
+
end
|
2175
2478
|
attr_reader :grouping
|
2176
2479
|
|
2177
2480
|
sig do
|
2178
2481
|
params(
|
2179
|
-
grouping:
|
2180
|
-
T.
|
2181
|
-
|
2182
|
-
|
2183
|
-
|
2482
|
+
grouping:
|
2483
|
+
T.nilable(
|
2484
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping::OrHash
|
2485
|
+
)
|
2486
|
+
).void
|
2184
2487
|
end
|
2185
2488
|
attr_writer :grouping
|
2186
2489
|
|
2187
|
-
sig
|
2490
|
+
sig do
|
2491
|
+
returns(Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig)
|
2492
|
+
end
|
2188
2493
|
attr_reader :matrix_config
|
2189
2494
|
|
2190
2495
|
sig do
|
2191
2496
|
params(
|
2192
|
-
matrix_config:
|
2193
|
-
Orb::
|
2194
|
-
|
2195
|
-
)
|
2196
|
-
)
|
2197
|
-
.void
|
2497
|
+
matrix_config:
|
2498
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig::OrHash
|
2499
|
+
).void
|
2198
2500
|
end
|
2199
2501
|
attr_writer :matrix_config
|
2200
2502
|
|
@@ -2210,18 +2512,16 @@ module Orb
|
|
2210
2512
|
sig do
|
2211
2513
|
params(
|
2212
2514
|
amount: String,
|
2213
|
-
grouping:
|
2214
|
-
T.
|
2215
|
-
|
2216
|
-
|
2217
|
-
|
2218
|
-
Orb::
|
2219
|
-
),
|
2515
|
+
grouping:
|
2516
|
+
T.nilable(
|
2517
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping::OrHash
|
2518
|
+
),
|
2519
|
+
matrix_config:
|
2520
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig::OrHash,
|
2220
2521
|
name: String,
|
2221
2522
|
quantity: Float,
|
2222
2523
|
type: Symbol
|
2223
|
-
)
|
2224
|
-
.returns(T.attached_class)
|
2524
|
+
).returns(T.attached_class)
|
2225
2525
|
end
|
2226
2526
|
def self.new(
|
2227
2527
|
# The total amount for this sub line item.
|
@@ -2231,23 +2531,32 @@ module Orb
|
|
2231
2531
|
name:,
|
2232
2532
|
quantity:,
|
2233
2533
|
type: :matrix
|
2234
|
-
)
|
2534
|
+
)
|
2535
|
+
end
|
2536
|
+
|
2235
2537
|
sig do
|
2236
|
-
override
|
2237
|
-
|
2238
|
-
|
2239
|
-
|
2240
|
-
|
2241
|
-
|
2242
|
-
|
2243
|
-
|
2244
|
-
|
2245
|
-
|
2246
|
-
|
2538
|
+
override.returns(
|
2539
|
+
{
|
2540
|
+
amount: String,
|
2541
|
+
grouping:
|
2542
|
+
T.nilable(
|
2543
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping
|
2544
|
+
),
|
2545
|
+
matrix_config:
|
2546
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig,
|
2547
|
+
name: String,
|
2548
|
+
quantity: Float,
|
2549
|
+
type: Symbol
|
2550
|
+
}
|
2551
|
+
)
|
2552
|
+
end
|
2553
|
+
def to_hash
|
2247
2554
|
end
|
2248
|
-
def to_hash; end
|
2249
2555
|
|
2250
2556
|
class Grouping < Orb::Internal::Type::BaseModel
|
2557
|
+
OrHash =
|
2558
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2559
|
+
|
2251
2560
|
sig { returns(String) }
|
2252
2561
|
attr_accessor :key
|
2253
2562
|
|
@@ -2255,46 +2564,75 @@ module Orb
|
|
2255
2564
|
sig { returns(T.nilable(String)) }
|
2256
2565
|
attr_accessor :value
|
2257
2566
|
|
2258
|
-
sig
|
2567
|
+
sig do
|
2568
|
+
params(key: String, value: T.nilable(String)).returns(
|
2569
|
+
T.attached_class
|
2570
|
+
)
|
2571
|
+
end
|
2259
2572
|
def self.new(
|
2260
2573
|
key:,
|
2261
2574
|
# No value indicates the default group
|
2262
2575
|
value:
|
2263
|
-
)
|
2264
|
-
|
2265
|
-
|
2576
|
+
)
|
2577
|
+
end
|
2578
|
+
|
2579
|
+
sig do
|
2580
|
+
override.returns({ key: String, value: T.nilable(String) })
|
2581
|
+
end
|
2582
|
+
def to_hash
|
2583
|
+
end
|
2266
2584
|
end
|
2267
2585
|
|
2268
2586
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
2587
|
+
OrHash =
|
2588
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2589
|
+
|
2269
2590
|
# The ordered dimension values for this line item.
|
2270
2591
|
sig { returns(T::Array[T.nilable(String)]) }
|
2271
2592
|
attr_accessor :dimension_values
|
2272
2593
|
|
2273
|
-
sig
|
2594
|
+
sig do
|
2595
|
+
params(dimension_values: T::Array[T.nilable(String)]).returns(
|
2596
|
+
T.attached_class
|
2597
|
+
)
|
2598
|
+
end
|
2274
2599
|
def self.new(
|
2275
2600
|
# The ordered dimension values for this line item.
|
2276
2601
|
dimension_values:
|
2277
|
-
)
|
2278
|
-
|
2279
|
-
|
2602
|
+
)
|
2603
|
+
end
|
2604
|
+
|
2605
|
+
sig do
|
2606
|
+
override.returns(
|
2607
|
+
{ dimension_values: T::Array[T.nilable(String)] }
|
2608
|
+
)
|
2609
|
+
end
|
2610
|
+
def to_hash
|
2611
|
+
end
|
2280
2612
|
end
|
2281
2613
|
end
|
2282
2614
|
|
2283
|
-
class
|
2615
|
+
class Tier < Orb::Internal::Type::BaseModel
|
2616
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2617
|
+
|
2284
2618
|
# The total amount for this sub line item.
|
2285
2619
|
sig { returns(String) }
|
2286
2620
|
attr_accessor :amount
|
2287
2621
|
|
2288
|
-
sig
|
2622
|
+
sig do
|
2623
|
+
returns(
|
2624
|
+
T.nilable(Orb::Invoice::LineItem::SubLineItem::Tier::Grouping)
|
2625
|
+
)
|
2626
|
+
end
|
2289
2627
|
attr_reader :grouping
|
2290
2628
|
|
2291
2629
|
sig do
|
2292
2630
|
params(
|
2293
|
-
grouping:
|
2294
|
-
T.
|
2295
|
-
|
2296
|
-
|
2297
|
-
|
2631
|
+
grouping:
|
2632
|
+
T.nilable(
|
2633
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping::OrHash
|
2634
|
+
)
|
2635
|
+
).void
|
2298
2636
|
end
|
2299
2637
|
attr_writer :grouping
|
2300
2638
|
|
@@ -2304,14 +2642,16 @@ module Orb
|
|
2304
2642
|
sig { returns(Float) }
|
2305
2643
|
attr_accessor :quantity
|
2306
2644
|
|
2307
|
-
sig
|
2645
|
+
sig do
|
2646
|
+
returns(Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig)
|
2647
|
+
end
|
2308
2648
|
attr_reader :tier_config
|
2309
2649
|
|
2310
2650
|
sig do
|
2311
2651
|
params(
|
2312
|
-
tier_config:
|
2313
|
-
|
2314
|
-
|
2652
|
+
tier_config:
|
2653
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig::OrHash
|
2654
|
+
).void
|
2315
2655
|
end
|
2316
2656
|
attr_writer :tier_config
|
2317
2657
|
|
@@ -2321,15 +2661,16 @@ module Orb
|
|
2321
2661
|
sig do
|
2322
2662
|
params(
|
2323
2663
|
amount: String,
|
2324
|
-
grouping:
|
2325
|
-
T.
|
2326
|
-
|
2664
|
+
grouping:
|
2665
|
+
T.nilable(
|
2666
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping::OrHash
|
2667
|
+
),
|
2327
2668
|
name: String,
|
2328
2669
|
quantity: Float,
|
2329
|
-
tier_config:
|
2670
|
+
tier_config:
|
2671
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig::OrHash,
|
2330
2672
|
type: Symbol
|
2331
|
-
)
|
2332
|
-
.returns(T.attached_class)
|
2673
|
+
).returns(T.attached_class)
|
2333
2674
|
end
|
2334
2675
|
def self.new(
|
2335
2676
|
# The total amount for this sub line item.
|
@@ -2339,23 +2680,32 @@ module Orb
|
|
2339
2680
|
quantity:,
|
2340
2681
|
tier_config:,
|
2341
2682
|
type: :tier
|
2342
|
-
)
|
2683
|
+
)
|
2684
|
+
end
|
2685
|
+
|
2343
2686
|
sig do
|
2344
|
-
override
|
2345
|
-
|
2346
|
-
|
2347
|
-
|
2348
|
-
|
2349
|
-
|
2350
|
-
|
2351
|
-
|
2352
|
-
|
2353
|
-
|
2354
|
-
|
2687
|
+
override.returns(
|
2688
|
+
{
|
2689
|
+
amount: String,
|
2690
|
+
grouping:
|
2691
|
+
T.nilable(
|
2692
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping
|
2693
|
+
),
|
2694
|
+
name: String,
|
2695
|
+
quantity: Float,
|
2696
|
+
tier_config:
|
2697
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig,
|
2698
|
+
type: Symbol
|
2699
|
+
}
|
2700
|
+
)
|
2701
|
+
end
|
2702
|
+
def to_hash
|
2355
2703
|
end
|
2356
|
-
def to_hash; end
|
2357
2704
|
|
2358
2705
|
class Grouping < Orb::Internal::Type::BaseModel
|
2706
|
+
OrHash =
|
2707
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2708
|
+
|
2359
2709
|
sig { returns(String) }
|
2360
2710
|
attr_accessor :key
|
2361
2711
|
|
@@ -2363,17 +2713,29 @@ module Orb
|
|
2363
2713
|
sig { returns(T.nilable(String)) }
|
2364
2714
|
attr_accessor :value
|
2365
2715
|
|
2366
|
-
sig
|
2716
|
+
sig do
|
2717
|
+
params(key: String, value: T.nilable(String)).returns(
|
2718
|
+
T.attached_class
|
2719
|
+
)
|
2720
|
+
end
|
2367
2721
|
def self.new(
|
2368
2722
|
key:,
|
2369
2723
|
# No value indicates the default group
|
2370
2724
|
value:
|
2371
|
-
)
|
2372
|
-
|
2373
|
-
|
2725
|
+
)
|
2726
|
+
end
|
2727
|
+
|
2728
|
+
sig do
|
2729
|
+
override.returns({ key: String, value: T.nilable(String) })
|
2730
|
+
end
|
2731
|
+
def to_hash
|
2732
|
+
end
|
2374
2733
|
end
|
2375
2734
|
|
2376
2735
|
class TierConfig < Orb::Internal::Type::BaseModel
|
2736
|
+
OrHash =
|
2737
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2738
|
+
|
2377
2739
|
sig { returns(Float) }
|
2378
2740
|
attr_accessor :first_unit
|
2379
2741
|
|
@@ -2390,28 +2752,44 @@ module Orb
|
|
2390
2752
|
unit_amount: String
|
2391
2753
|
).returns(T.attached_class)
|
2392
2754
|
end
|
2393
|
-
def self.new(first_unit:, last_unit:, unit_amount:)
|
2755
|
+
def self.new(first_unit:, last_unit:, unit_amount:)
|
2756
|
+
end
|
2394
2757
|
|
2395
|
-
sig
|
2396
|
-
|
2758
|
+
sig do
|
2759
|
+
override.returns(
|
2760
|
+
{
|
2761
|
+
first_unit: Float,
|
2762
|
+
last_unit: T.nilable(Float),
|
2763
|
+
unit_amount: String
|
2764
|
+
}
|
2765
|
+
)
|
2766
|
+
end
|
2767
|
+
def to_hash
|
2768
|
+
end
|
2397
2769
|
end
|
2398
2770
|
end
|
2399
2771
|
|
2400
|
-
class
|
2772
|
+
class Null < Orb::Internal::Type::BaseModel
|
2773
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2774
|
+
|
2401
2775
|
# The total amount for this sub line item.
|
2402
2776
|
sig { returns(String) }
|
2403
2777
|
attr_accessor :amount
|
2404
2778
|
|
2405
|
-
sig
|
2779
|
+
sig do
|
2780
|
+
returns(
|
2781
|
+
T.nilable(Orb::Invoice::LineItem::SubLineItem::Null::Grouping)
|
2782
|
+
)
|
2783
|
+
end
|
2406
2784
|
attr_reader :grouping
|
2407
2785
|
|
2408
2786
|
sig do
|
2409
2787
|
params(
|
2410
|
-
grouping:
|
2411
|
-
T.
|
2412
|
-
|
2413
|
-
|
2414
|
-
|
2788
|
+
grouping:
|
2789
|
+
T.nilable(
|
2790
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping::OrHash
|
2791
|
+
)
|
2792
|
+
).void
|
2415
2793
|
end
|
2416
2794
|
attr_writer :grouping
|
2417
2795
|
|
@@ -2427,14 +2805,14 @@ module Orb
|
|
2427
2805
|
sig do
|
2428
2806
|
params(
|
2429
2807
|
amount: String,
|
2430
|
-
grouping:
|
2431
|
-
T.
|
2432
|
-
|
2808
|
+
grouping:
|
2809
|
+
T.nilable(
|
2810
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping::OrHash
|
2811
|
+
),
|
2433
2812
|
name: String,
|
2434
2813
|
quantity: Float,
|
2435
2814
|
type: Symbol
|
2436
|
-
)
|
2437
|
-
.returns(T.attached_class)
|
2815
|
+
).returns(T.attached_class)
|
2438
2816
|
end
|
2439
2817
|
def self.new(
|
2440
2818
|
# The total amount for this sub line item.
|
@@ -2443,22 +2821,30 @@ module Orb
|
|
2443
2821
|
name:,
|
2444
2822
|
quantity:,
|
2445
2823
|
type: :"'null'"
|
2446
|
-
)
|
2824
|
+
)
|
2825
|
+
end
|
2826
|
+
|
2447
2827
|
sig do
|
2448
|
-
override
|
2449
|
-
|
2450
|
-
|
2451
|
-
|
2452
|
-
|
2453
|
-
|
2454
|
-
|
2455
|
-
|
2456
|
-
|
2457
|
-
|
2828
|
+
override.returns(
|
2829
|
+
{
|
2830
|
+
amount: String,
|
2831
|
+
grouping:
|
2832
|
+
T.nilable(
|
2833
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping
|
2834
|
+
),
|
2835
|
+
name: String,
|
2836
|
+
quantity: Float,
|
2837
|
+
type: Symbol
|
2838
|
+
}
|
2839
|
+
)
|
2840
|
+
end
|
2841
|
+
def to_hash
|
2458
2842
|
end
|
2459
|
-
def to_hash; end
|
2460
2843
|
|
2461
2844
|
class Grouping < Orb::Internal::Type::BaseModel
|
2845
|
+
OrHash =
|
2846
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2847
|
+
|
2462
2848
|
sig { returns(String) }
|
2463
2849
|
attr_accessor :key
|
2464
2850
|
|
@@ -2466,27 +2852,38 @@ module Orb
|
|
2466
2852
|
sig { returns(T.nilable(String)) }
|
2467
2853
|
attr_accessor :value
|
2468
2854
|
|
2469
|
-
sig
|
2855
|
+
sig do
|
2856
|
+
params(key: String, value: T.nilable(String)).returns(
|
2857
|
+
T.attached_class
|
2858
|
+
)
|
2859
|
+
end
|
2470
2860
|
def self.new(
|
2471
2861
|
key:,
|
2472
2862
|
# No value indicates the default group
|
2473
2863
|
value:
|
2474
|
-
)
|
2475
|
-
|
2476
|
-
|
2864
|
+
)
|
2865
|
+
end
|
2866
|
+
|
2867
|
+
sig do
|
2868
|
+
override.returns({ key: String, value: T.nilable(String) })
|
2869
|
+
end
|
2870
|
+
def to_hash
|
2871
|
+
end
|
2477
2872
|
end
|
2478
2873
|
end
|
2479
2874
|
|
2480
2875
|
sig do
|
2481
|
-
override
|
2482
|
-
|
2483
|
-
|
2484
|
-
|
2876
|
+
override.returns(
|
2877
|
+
T::Array[Orb::Invoice::LineItem::SubLineItem::Variants]
|
2878
|
+
)
|
2879
|
+
end
|
2880
|
+
def self.variants
|
2485
2881
|
end
|
2486
|
-
def self.variants; end
|
2487
2882
|
end
|
2488
2883
|
|
2489
2884
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
2885
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2886
|
+
|
2490
2887
|
# The amount of additional tax incurred by this tax rate.
|
2491
2888
|
sig { returns(String) }
|
2492
2889
|
attr_accessor :amount
|
@@ -2500,8 +2897,11 @@ module Orb
|
|
2500
2897
|
attr_accessor :tax_rate_percentage
|
2501
2898
|
|
2502
2899
|
sig do
|
2503
|
-
params(
|
2504
|
-
|
2900
|
+
params(
|
2901
|
+
amount: String,
|
2902
|
+
tax_rate_description: String,
|
2903
|
+
tax_rate_percentage: T.nilable(String)
|
2904
|
+
).returns(T.attached_class)
|
2505
2905
|
end
|
2506
2906
|
def self.new(
|
2507
2907
|
# The amount of additional tax incurred by this tax rate.
|
@@ -2510,7 +2910,9 @@ module Orb
|
|
2510
2910
|
tax_rate_description:,
|
2511
2911
|
# The tax rate percentage, out of 100.
|
2512
2912
|
tax_rate_percentage:
|
2513
|
-
)
|
2913
|
+
)
|
2914
|
+
end
|
2915
|
+
|
2514
2916
|
sig do
|
2515
2917
|
override.returns(
|
2516
2918
|
{
|
@@ -2520,11 +2922,14 @@ module Orb
|
|
2520
2922
|
}
|
2521
2923
|
)
|
2522
2924
|
end
|
2523
|
-
def to_hash
|
2925
|
+
def to_hash
|
2926
|
+
end
|
2524
2927
|
end
|
2525
2928
|
end
|
2526
2929
|
|
2527
2930
|
class Maximum < Orb::Internal::Type::BaseModel
|
2931
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2932
|
+
|
2528
2933
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2529
2934
|
# maximums, this can be a subset of prices.
|
2530
2935
|
sig { returns(T::Array[String]) }
|
@@ -2535,7 +2940,10 @@ module Orb
|
|
2535
2940
|
attr_accessor :maximum_amount
|
2536
2941
|
|
2537
2942
|
sig do
|
2538
|
-
params(
|
2943
|
+
params(
|
2944
|
+
applies_to_price_ids: T::Array[String],
|
2945
|
+
maximum_amount: String
|
2946
|
+
).returns(T.attached_class)
|
2539
2947
|
end
|
2540
2948
|
def self.new(
|
2541
2949
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -2543,12 +2951,21 @@ module Orb
|
|
2543
2951
|
applies_to_price_ids:,
|
2544
2952
|
# Maximum amount applied
|
2545
2953
|
maximum_amount:
|
2546
|
-
)
|
2547
|
-
|
2548
|
-
|
2954
|
+
)
|
2955
|
+
end
|
2956
|
+
|
2957
|
+
sig do
|
2958
|
+
override.returns(
|
2959
|
+
{ applies_to_price_ids: T::Array[String], maximum_amount: String }
|
2960
|
+
)
|
2961
|
+
end
|
2962
|
+
def to_hash
|
2963
|
+
end
|
2549
2964
|
end
|
2550
2965
|
|
2551
2966
|
class Minimum < Orb::Internal::Type::BaseModel
|
2967
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
2968
|
+
|
2552
2969
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2553
2970
|
# minimums, this can be a subset of prices.
|
2554
2971
|
sig { returns(T::Array[String]) }
|
@@ -2559,7 +2976,10 @@ module Orb
|
|
2559
2976
|
attr_accessor :minimum_amount
|
2560
2977
|
|
2561
2978
|
sig do
|
2562
|
-
params(
|
2979
|
+
params(
|
2980
|
+
applies_to_price_ids: T::Array[String],
|
2981
|
+
minimum_amount: String
|
2982
|
+
).returns(T.attached_class)
|
2563
2983
|
end
|
2564
2984
|
def self.new(
|
2565
2985
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -2567,12 +2987,21 @@ module Orb
|
|
2567
2987
|
applies_to_price_ids:,
|
2568
2988
|
# Minimum amount applied
|
2569
2989
|
minimum_amount:
|
2570
|
-
)
|
2571
|
-
|
2572
|
-
|
2990
|
+
)
|
2991
|
+
end
|
2992
|
+
|
2993
|
+
sig do
|
2994
|
+
override.returns(
|
2995
|
+
{ applies_to_price_ids: T::Array[String], minimum_amount: String }
|
2996
|
+
)
|
2997
|
+
end
|
2998
|
+
def to_hash
|
2999
|
+
end
|
2573
3000
|
end
|
2574
3001
|
|
2575
3002
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
3003
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
3004
|
+
|
2576
3005
|
# The ID of the payment attempt.
|
2577
3006
|
sig { returns(String) }
|
2578
3007
|
attr_accessor :id
|
@@ -2586,7 +3015,13 @@ module Orb
|
|
2586
3015
|
attr_accessor :created_at
|
2587
3016
|
|
2588
3017
|
# The payment provider that attempted to collect the payment.
|
2589
|
-
sig
|
3018
|
+
sig do
|
3019
|
+
returns(
|
3020
|
+
T.nilable(
|
3021
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3022
|
+
)
|
3023
|
+
)
|
3024
|
+
end
|
2590
3025
|
attr_accessor :payment_provider
|
2591
3026
|
|
2592
3027
|
# The ID of the payment attempt in the payment provider.
|
@@ -2602,11 +3037,13 @@ module Orb
|
|
2602
3037
|
id: String,
|
2603
3038
|
amount: String,
|
2604
3039
|
created_at: Time,
|
2605
|
-
payment_provider:
|
3040
|
+
payment_provider:
|
3041
|
+
T.nilable(
|
3042
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::OrSymbol
|
3043
|
+
),
|
2606
3044
|
payment_provider_id: T.nilable(String),
|
2607
3045
|
succeeded: T::Boolean
|
2608
|
-
)
|
2609
|
-
.returns(T.attached_class)
|
3046
|
+
).returns(T.attached_class)
|
2610
3047
|
end
|
2611
3048
|
def self.new(
|
2612
3049
|
# The ID of the payment attempt.
|
@@ -2621,37 +3058,58 @@ module Orb
|
|
2621
3058
|
payment_provider_id:,
|
2622
3059
|
# Whether the payment attempt succeeded.
|
2623
3060
|
succeeded:
|
2624
|
-
)
|
3061
|
+
)
|
3062
|
+
end
|
3063
|
+
|
2625
3064
|
sig do
|
2626
|
-
override
|
2627
|
-
|
2628
|
-
|
2629
|
-
|
2630
|
-
|
2631
|
-
|
2632
|
-
|
2633
|
-
|
2634
|
-
|
2635
|
-
|
2636
|
-
|
3065
|
+
override.returns(
|
3066
|
+
{
|
3067
|
+
id: String,
|
3068
|
+
amount: String,
|
3069
|
+
created_at: Time,
|
3070
|
+
payment_provider:
|
3071
|
+
T.nilable(
|
3072
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3073
|
+
),
|
3074
|
+
payment_provider_id: T.nilable(String),
|
3075
|
+
succeeded: T::Boolean
|
3076
|
+
}
|
3077
|
+
)
|
3078
|
+
end
|
3079
|
+
def to_hash
|
2637
3080
|
end
|
2638
|
-
def to_hash; end
|
2639
3081
|
|
2640
3082
|
# The payment provider that attempted to collect the payment.
|
2641
3083
|
module PaymentProvider
|
2642
3084
|
extend Orb::Internal::Type::Enum
|
2643
3085
|
|
2644
|
-
TaggedSymbol =
|
3086
|
+
TaggedSymbol =
|
3087
|
+
T.type_alias do
|
3088
|
+
T.all(Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider)
|
3089
|
+
end
|
2645
3090
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2646
3091
|
|
2647
|
-
STRIPE =
|
3092
|
+
STRIPE =
|
3093
|
+
T.let(
|
3094
|
+
:stripe,
|
3095
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3096
|
+
)
|
2648
3097
|
|
2649
|
-
sig
|
2650
|
-
|
3098
|
+
sig do
|
3099
|
+
override.returns(
|
3100
|
+
T::Array[
|
3101
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3102
|
+
]
|
3103
|
+
)
|
3104
|
+
end
|
3105
|
+
def self.values
|
3106
|
+
end
|
2651
3107
|
end
|
2652
3108
|
end
|
2653
3109
|
|
2654
3110
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
3111
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
3112
|
+
|
2655
3113
|
sig { returns(T.nilable(String)) }
|
2656
3114
|
attr_accessor :city
|
2657
3115
|
|
@@ -2678,52 +3136,57 @@ module Orb
|
|
2678
3136
|
line2: T.nilable(String),
|
2679
3137
|
postal_code: T.nilable(String),
|
2680
3138
|
state: T.nilable(String)
|
2681
|
-
)
|
2682
|
-
|
3139
|
+
).returns(T.attached_class)
|
3140
|
+
end
|
3141
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
2683
3142
|
end
|
2684
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
2685
3143
|
|
2686
3144
|
sig do
|
2687
|
-
override
|
2688
|
-
|
2689
|
-
|
2690
|
-
|
2691
|
-
|
2692
|
-
|
2693
|
-
|
2694
|
-
|
2695
|
-
|
2696
|
-
|
2697
|
-
|
3145
|
+
override.returns(
|
3146
|
+
{
|
3147
|
+
city: T.nilable(String),
|
3148
|
+
country: T.nilable(String),
|
3149
|
+
line1: T.nilable(String),
|
3150
|
+
line2: T.nilable(String),
|
3151
|
+
postal_code: T.nilable(String),
|
3152
|
+
state: T.nilable(String)
|
3153
|
+
}
|
3154
|
+
)
|
3155
|
+
end
|
3156
|
+
def to_hash
|
2698
3157
|
end
|
2699
|
-
def to_hash; end
|
2700
3158
|
end
|
2701
3159
|
|
2702
3160
|
module Status
|
2703
3161
|
extend Orb::Internal::Type::Enum
|
2704
3162
|
|
2705
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
3163
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Invoice::Status) }
|
2706
3164
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2707
3165
|
|
2708
|
-
ISSUED = T.let(:issued, Orb::
|
2709
|
-
PAID = T.let(:paid, Orb::
|
2710
|
-
SYNCED = T.let(:synced, Orb::
|
2711
|
-
VOID = T.let(:void, Orb::
|
2712
|
-
DRAFT = T.let(:draft, Orb::
|
3166
|
+
ISSUED = T.let(:issued, Orb::Invoice::Status::TaggedSymbol)
|
3167
|
+
PAID = T.let(:paid, Orb::Invoice::Status::TaggedSymbol)
|
3168
|
+
SYNCED = T.let(:synced, Orb::Invoice::Status::TaggedSymbol)
|
3169
|
+
VOID = T.let(:void, Orb::Invoice::Status::TaggedSymbol)
|
3170
|
+
DRAFT = T.let(:draft, Orb::Invoice::Status::TaggedSymbol)
|
2713
3171
|
|
2714
|
-
sig { override.returns(T::Array[Orb::
|
2715
|
-
def self.values
|
3172
|
+
sig { override.returns(T::Array[Orb::Invoice::Status::TaggedSymbol]) }
|
3173
|
+
def self.values
|
3174
|
+
end
|
2716
3175
|
end
|
2717
3176
|
|
2718
3177
|
class Subscription < Orb::Internal::Type::BaseModel
|
3178
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
3179
|
+
|
2719
3180
|
sig { returns(String) }
|
2720
3181
|
attr_accessor :id
|
2721
3182
|
|
2722
3183
|
sig { params(id: String).returns(T.attached_class) }
|
2723
|
-
def self.new(id:)
|
3184
|
+
def self.new(id:)
|
3185
|
+
end
|
2724
3186
|
|
2725
|
-
sig { override.returns({id: String}) }
|
2726
|
-
def to_hash
|
3187
|
+
sig { override.returns({ id: String }) }
|
3188
|
+
def to_hash
|
3189
|
+
end
|
2727
3190
|
end
|
2728
3191
|
end
|
2729
3192
|
end
|