orb-billing 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- 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 +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -8
- 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 +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -51
- 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 +14 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
- 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 +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
- 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 +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -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 +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
- 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 +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -800
- 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 +1706 -1724
- 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 +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -57
- 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 +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -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 +24 -0
- data/lib/orb/request_options.rb +4 -0
- 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 +14 -33
- 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 +3 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.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 +3 -9
- 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 +32 -52
- 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 +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- 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 +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- 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 +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- 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 +110 -172
- 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 +2 -64
- 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 +2 -36
- 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 +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- 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 +1194 -1730
- 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 +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- 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 +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- 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 +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- 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 +20 -60
- 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/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 +2 -2
data/rbi/orb/models/invoice.rbi
CHANGED
@@ -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(Orb::Invoice, 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,73 @@ 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 =
|
650
|
+
T.type_alias do
|
651
|
+
T.any(Orb::Invoice::AutoCollection, Orb::Internal::AnyHash)
|
652
|
+
end
|
653
|
+
|
625
654
|
# True only if auto-collection is enabled for this invoice.
|
626
655
|
sig { returns(T.nilable(T::Boolean)) }
|
627
656
|
attr_accessor :enabled
|
@@ -651,8 +680,7 @@ module Orb
|
|
651
680
|
next_attempt_at: T.nilable(Time),
|
652
681
|
num_attempts: T.nilable(Integer),
|
653
682
|
previously_attempted_at: T.nilable(Time)
|
654
|
-
)
|
655
|
-
.returns(T.attached_class)
|
683
|
+
).returns(T.attached_class)
|
656
684
|
end
|
657
685
|
def self.new(
|
658
686
|
# True only if auto-collection is enabled for this invoice.
|
@@ -670,22 +698,29 @@ module Orb
|
|
670
698
|
# if dunning has been exhausted (`previously_attempted_at` is non-null, but
|
671
699
|
# `next_attempt_time` is null).
|
672
700
|
previously_attempted_at:
|
673
|
-
)
|
701
|
+
)
|
702
|
+
end
|
703
|
+
|
674
704
|
sig do
|
675
|
-
override
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
705
|
+
override.returns(
|
706
|
+
{
|
707
|
+
enabled: T.nilable(T::Boolean),
|
708
|
+
next_attempt_at: T.nilable(Time),
|
709
|
+
num_attempts: T.nilable(Integer),
|
710
|
+
previously_attempted_at: T.nilable(Time)
|
711
|
+
}
|
712
|
+
)
|
713
|
+
end
|
714
|
+
def to_hash
|
684
715
|
end
|
685
|
-
def to_hash; end
|
686
716
|
end
|
687
717
|
|
688
718
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
719
|
+
OrHash =
|
720
|
+
T.type_alias do
|
721
|
+
T.any(Orb::Invoice::BillingAddress, Orb::Internal::AnyHash)
|
722
|
+
end
|
723
|
+
|
689
724
|
sig { returns(T.nilable(String)) }
|
690
725
|
attr_accessor :city
|
691
726
|
|
@@ -712,28 +747,33 @@ module Orb
|
|
712
747
|
line2: T.nilable(String),
|
713
748
|
postal_code: T.nilable(String),
|
714
749
|
state: T.nilable(String)
|
715
|
-
)
|
716
|
-
|
750
|
+
).returns(T.attached_class)
|
751
|
+
end
|
752
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
717
753
|
end
|
718
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
719
754
|
|
720
755
|
sig do
|
721
|
-
override
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
756
|
+
override.returns(
|
757
|
+
{
|
758
|
+
city: T.nilable(String),
|
759
|
+
country: T.nilable(String),
|
760
|
+
line1: T.nilable(String),
|
761
|
+
line2: T.nilable(String),
|
762
|
+
postal_code: T.nilable(String),
|
763
|
+
state: T.nilable(String)
|
764
|
+
}
|
765
|
+
)
|
766
|
+
end
|
767
|
+
def to_hash
|
732
768
|
end
|
733
|
-
def to_hash; end
|
734
769
|
end
|
735
770
|
|
736
771
|
class CreditNote < Orb::Internal::Type::BaseModel
|
772
|
+
OrHash =
|
773
|
+
T.type_alias do
|
774
|
+
T.any(Orb::Invoice::CreditNote, Orb::Internal::AnyHash)
|
775
|
+
end
|
776
|
+
|
737
777
|
sig { returns(String) }
|
738
778
|
attr_accessor :id
|
739
779
|
|
@@ -767,8 +807,7 @@ module Orb
|
|
767
807
|
total: String,
|
768
808
|
type: String,
|
769
809
|
voided_at: T.nilable(Time)
|
770
|
-
)
|
771
|
-
.returns(T.attached_class)
|
810
|
+
).returns(T.attached_class)
|
772
811
|
end
|
773
812
|
def self.new(
|
774
813
|
id:,
|
@@ -781,44 +820,71 @@ module Orb
|
|
781
820
|
# If the credit note has a status of `void`, this gives a timestamp when the
|
782
821
|
# credit note was voided.
|
783
822
|
voided_at:
|
784
|
-
)
|
823
|
+
)
|
824
|
+
end
|
825
|
+
|
785
826
|
sig do
|
786
|
-
override
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
827
|
+
override.returns(
|
828
|
+
{
|
829
|
+
id: String,
|
830
|
+
credit_note_number: String,
|
831
|
+
memo: T.nilable(String),
|
832
|
+
reason: String,
|
833
|
+
total: String,
|
834
|
+
type: String,
|
835
|
+
voided_at: T.nilable(Time)
|
836
|
+
}
|
837
|
+
)
|
838
|
+
end
|
839
|
+
def to_hash
|
798
840
|
end
|
799
|
-
def to_hash; end
|
800
841
|
end
|
801
842
|
|
802
843
|
class Customer < Orb::Internal::Type::BaseModel
|
844
|
+
OrHash =
|
845
|
+
T.type_alias { T.any(Orb::Invoice::Customer, Orb::Internal::AnyHash) }
|
846
|
+
|
803
847
|
sig { returns(String) }
|
804
848
|
attr_accessor :id
|
805
849
|
|
806
850
|
sig { returns(T.nilable(String)) }
|
807
851
|
attr_accessor :external_customer_id
|
808
852
|
|
809
|
-
sig
|
810
|
-
|
853
|
+
sig do
|
854
|
+
params(id: String, external_customer_id: T.nilable(String)).returns(
|
855
|
+
T.attached_class
|
856
|
+
)
|
857
|
+
end
|
858
|
+
def self.new(id:, external_customer_id:)
|
859
|
+
end
|
811
860
|
|
812
|
-
sig
|
813
|
-
|
861
|
+
sig do
|
862
|
+
override.returns(
|
863
|
+
{ id: String, external_customer_id: T.nilable(String) }
|
864
|
+
)
|
865
|
+
end
|
866
|
+
def to_hash
|
867
|
+
end
|
814
868
|
end
|
815
869
|
|
816
870
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
871
|
+
OrHash =
|
872
|
+
T.type_alias do
|
873
|
+
T.any(
|
874
|
+
Orb::Invoice::CustomerBalanceTransaction,
|
875
|
+
Orb::Internal::AnyHash
|
876
|
+
)
|
877
|
+
end
|
878
|
+
|
817
879
|
# A unique id for this transaction.
|
818
880
|
sig { returns(String) }
|
819
881
|
attr_accessor :id
|
820
882
|
|
821
|
-
sig
|
883
|
+
sig do
|
884
|
+
returns(
|
885
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
886
|
+
)
|
887
|
+
end
|
822
888
|
attr_accessor :action
|
823
889
|
|
824
890
|
# The value of the amount changed in the transaction.
|
@@ -829,14 +895,20 @@ module Orb
|
|
829
895
|
sig { returns(Time) }
|
830
896
|
attr_accessor :created_at
|
831
897
|
|
832
|
-
sig
|
898
|
+
sig do
|
899
|
+
returns(
|
900
|
+
T.nilable(Orb::Invoice::CustomerBalanceTransaction::CreditNote)
|
901
|
+
)
|
902
|
+
end
|
833
903
|
attr_reader :credit_note
|
834
904
|
|
835
905
|
sig do
|
836
906
|
params(
|
837
|
-
credit_note:
|
838
|
-
|
839
|
-
|
907
|
+
credit_note:
|
908
|
+
T.nilable(
|
909
|
+
Orb::Invoice::CustomerBalanceTransaction::CreditNote::OrHash
|
910
|
+
)
|
911
|
+
).void
|
840
912
|
end
|
841
913
|
attr_writer :credit_note
|
842
914
|
|
@@ -849,14 +921,18 @@ module Orb
|
|
849
921
|
sig { returns(String) }
|
850
922
|
attr_accessor :ending_balance
|
851
923
|
|
852
|
-
sig
|
924
|
+
sig do
|
925
|
+
returns(T.nilable(Orb::Invoice::CustomerBalanceTransaction::Invoice))
|
926
|
+
end
|
853
927
|
attr_reader :invoice
|
854
928
|
|
855
929
|
sig do
|
856
930
|
params(
|
857
|
-
invoice:
|
858
|
-
|
859
|
-
|
931
|
+
invoice:
|
932
|
+
T.nilable(
|
933
|
+
Orb::Invoice::CustomerBalanceTransaction::Invoice::OrHash
|
934
|
+
)
|
935
|
+
).void
|
860
936
|
end
|
861
937
|
attr_writer :invoice
|
862
938
|
|
@@ -865,23 +941,30 @@ module Orb
|
|
865
941
|
sig { returns(String) }
|
866
942
|
attr_accessor :starting_balance
|
867
943
|
|
868
|
-
sig
|
944
|
+
sig do
|
945
|
+
returns(Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol)
|
946
|
+
end
|
869
947
|
attr_accessor :type
|
870
948
|
|
871
949
|
sig do
|
872
950
|
params(
|
873
951
|
id: String,
|
874
|
-
action: Orb::
|
952
|
+
action: Orb::Invoice::CustomerBalanceTransaction::Action::OrSymbol,
|
875
953
|
amount: String,
|
876
954
|
created_at: Time,
|
877
|
-
credit_note:
|
955
|
+
credit_note:
|
956
|
+
T.nilable(
|
957
|
+
Orb::Invoice::CustomerBalanceTransaction::CreditNote::OrHash
|
958
|
+
),
|
878
959
|
description: T.nilable(String),
|
879
960
|
ending_balance: String,
|
880
|
-
invoice:
|
961
|
+
invoice:
|
962
|
+
T.nilable(
|
963
|
+
Orb::Invoice::CustomerBalanceTransaction::Invoice::OrHash
|
964
|
+
),
|
881
965
|
starting_balance: String,
|
882
|
-
type: Orb::
|
883
|
-
)
|
884
|
-
.returns(T.attached_class)
|
966
|
+
type: Orb::Invoice::CustomerBalanceTransaction::Type::OrSymbol
|
967
|
+
).returns(T.attached_class)
|
885
968
|
end
|
886
969
|
def self.new(
|
887
970
|
# A unique id for this transaction.
|
@@ -902,56 +985,106 @@ module Orb
|
|
902
985
|
# customer's currency.
|
903
986
|
starting_balance:,
|
904
987
|
type:
|
905
|
-
)
|
988
|
+
)
|
989
|
+
end
|
990
|
+
|
906
991
|
sig do
|
907
|
-
override
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
|
914
|
-
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
992
|
+
override.returns(
|
993
|
+
{
|
994
|
+
id: String,
|
995
|
+
action:
|
996
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol,
|
997
|
+
amount: String,
|
998
|
+
created_at: Time,
|
999
|
+
credit_note:
|
1000
|
+
T.nilable(Orb::Invoice::CustomerBalanceTransaction::CreditNote),
|
1001
|
+
description: T.nilable(String),
|
1002
|
+
ending_balance: String,
|
1003
|
+
invoice:
|
1004
|
+
T.nilable(Orb::Invoice::CustomerBalanceTransaction::Invoice),
|
1005
|
+
starting_balance: String,
|
1006
|
+
type: Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1007
|
+
}
|
1008
|
+
)
|
1009
|
+
end
|
1010
|
+
def to_hash
|
922
1011
|
end
|
923
|
-
def to_hash; end
|
924
1012
|
|
925
1013
|
module Action
|
926
1014
|
extend Orb::Internal::Type::Enum
|
927
1015
|
|
928
|
-
TaggedSymbol =
|
1016
|
+
TaggedSymbol =
|
1017
|
+
T.type_alias do
|
1018
|
+
T.all(Symbol, Orb::Invoice::CustomerBalanceTransaction::Action)
|
1019
|
+
end
|
929
1020
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
930
1021
|
|
931
1022
|
APPLIED_TO_INVOICE =
|
932
|
-
T.let(
|
1023
|
+
T.let(
|
1024
|
+
:applied_to_invoice,
|
1025
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1026
|
+
)
|
933
1027
|
MANUAL_ADJUSTMENT =
|
934
|
-
T.let(
|
1028
|
+
T.let(
|
1029
|
+
:manual_adjustment,
|
1030
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1031
|
+
)
|
935
1032
|
PRORATED_REFUND =
|
936
|
-
T.let(
|
1033
|
+
T.let(
|
1034
|
+
:prorated_refund,
|
1035
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1036
|
+
)
|
937
1037
|
REVERT_PRORATED_REFUND =
|
938
|
-
T.let(
|
1038
|
+
T.let(
|
1039
|
+
:revert_prorated_refund,
|
1040
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1041
|
+
)
|
939
1042
|
RETURN_FROM_VOIDING =
|
940
|
-
T.let(
|
1043
|
+
T.let(
|
1044
|
+
:return_from_voiding,
|
1045
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1046
|
+
)
|
941
1047
|
CREDIT_NOTE_APPLIED =
|
942
|
-
T.let(
|
1048
|
+
T.let(
|
1049
|
+
:credit_note_applied,
|
1050
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1051
|
+
)
|
943
1052
|
CREDIT_NOTE_VOIDED =
|
944
|
-
T.let(
|
1053
|
+
T.let(
|
1054
|
+
:credit_note_voided,
|
1055
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1056
|
+
)
|
945
1057
|
OVERPAYMENT_REFUND =
|
946
|
-
T.let(
|
1058
|
+
T.let(
|
1059
|
+
:overpayment_refund,
|
1060
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1061
|
+
)
|
947
1062
|
EXTERNAL_PAYMENT =
|
948
|
-
T.let(
|
1063
|
+
T.let(
|
1064
|
+
:external_payment,
|
1065
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1066
|
+
)
|
949
1067
|
|
950
|
-
sig
|
951
|
-
|
1068
|
+
sig do
|
1069
|
+
override.returns(
|
1070
|
+
T::Array[
|
1071
|
+
Orb::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
|
1072
|
+
]
|
1073
|
+
)
|
1074
|
+
end
|
1075
|
+
def self.values
|
1076
|
+
end
|
952
1077
|
end
|
953
1078
|
|
954
1079
|
class CreditNote < Orb::Internal::Type::BaseModel
|
1080
|
+
OrHash =
|
1081
|
+
T.type_alias do
|
1082
|
+
T.any(
|
1083
|
+
Orb::Invoice::CustomerBalanceTransaction::CreditNote,
|
1084
|
+
Orb::Internal::AnyHash
|
1085
|
+
)
|
1086
|
+
end
|
1087
|
+
|
955
1088
|
# The id of the Credit note
|
956
1089
|
sig { returns(String) }
|
957
1090
|
attr_accessor :id
|
@@ -960,12 +1093,23 @@ module Orb
|
|
960
1093
|
def self.new(
|
961
1094
|
# The id of the Credit note
|
962
1095
|
id:
|
963
|
-
)
|
964
|
-
|
965
|
-
|
1096
|
+
)
|
1097
|
+
end
|
1098
|
+
|
1099
|
+
sig { override.returns({ id: String }) }
|
1100
|
+
def to_hash
|
1101
|
+
end
|
966
1102
|
end
|
967
1103
|
|
968
1104
|
class Invoice < Orb::Internal::Type::BaseModel
|
1105
|
+
OrHash =
|
1106
|
+
T.type_alias do
|
1107
|
+
T.any(
|
1108
|
+
Orb::Invoice::CustomerBalanceTransaction::Invoice,
|
1109
|
+
Orb::Internal::AnyHash
|
1110
|
+
)
|
1111
|
+
end
|
1112
|
+
|
969
1113
|
# The Invoice id
|
970
1114
|
sig { returns(String) }
|
971
1115
|
attr_accessor :id
|
@@ -974,30 +1118,56 @@ module Orb
|
|
974
1118
|
def self.new(
|
975
1119
|
# The Invoice id
|
976
1120
|
id:
|
977
|
-
)
|
978
|
-
|
979
|
-
|
1121
|
+
)
|
1122
|
+
end
|
1123
|
+
|
1124
|
+
sig { override.returns({ id: String }) }
|
1125
|
+
def to_hash
|
1126
|
+
end
|
980
1127
|
end
|
981
1128
|
|
982
1129
|
module Type
|
983
1130
|
extend Orb::Internal::Type::Enum
|
984
1131
|
|
985
|
-
TaggedSymbol =
|
1132
|
+
TaggedSymbol =
|
1133
|
+
T.type_alias do
|
1134
|
+
T.all(Symbol, Orb::Invoice::CustomerBalanceTransaction::Type)
|
1135
|
+
end
|
986
1136
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
987
1137
|
|
988
|
-
INCREMENT =
|
989
|
-
|
1138
|
+
INCREMENT =
|
1139
|
+
T.let(
|
1140
|
+
:increment,
|
1141
|
+
Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1142
|
+
)
|
1143
|
+
DECREMENT =
|
1144
|
+
T.let(
|
1145
|
+
:decrement,
|
1146
|
+
Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1147
|
+
)
|
990
1148
|
|
991
|
-
sig
|
992
|
-
|
1149
|
+
sig do
|
1150
|
+
override.returns(
|
1151
|
+
T::Array[
|
1152
|
+
Orb::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
|
1153
|
+
]
|
1154
|
+
)
|
1155
|
+
end
|
1156
|
+
def self.values
|
1157
|
+
end
|
993
1158
|
end
|
994
1159
|
end
|
995
1160
|
|
996
1161
|
class CustomerTaxID < Orb::Internal::Type::BaseModel
|
997
|
-
|
1162
|
+
OrHash =
|
1163
|
+
T.type_alias do
|
1164
|
+
T.any(Orb::Invoice::CustomerTaxID, Orb::Internal::AnyHash)
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
sig { returns(Orb::Invoice::CustomerTaxID::Country::TaggedSymbol) }
|
998
1168
|
attr_accessor :country
|
999
1169
|
|
1000
|
-
sig { returns(Orb::
|
1170
|
+
sig { returns(Orb::Invoice::CustomerTaxID::Type::TaggedSymbol) }
|
1001
1171
|
attr_accessor :type
|
1002
1172
|
|
1003
1173
|
sig { returns(String) }
|
@@ -1110,213 +1280,300 @@ module Orb
|
|
1110
1280
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
1111
1281
|
sig do
|
1112
1282
|
params(
|
1113
|
-
country: Orb::
|
1114
|
-
type: Orb::
|
1283
|
+
country: Orb::Invoice::CustomerTaxID::Country::OrSymbol,
|
1284
|
+
type: Orb::Invoice::CustomerTaxID::Type::OrSymbol,
|
1115
1285
|
value: String
|
1116
|
-
)
|
1117
|
-
|
1286
|
+
).returns(T.attached_class)
|
1287
|
+
end
|
1288
|
+
def self.new(country:, type:, value:)
|
1118
1289
|
end
|
1119
|
-
def self.new(country:, type:, value:); end
|
1120
1290
|
|
1121
1291
|
sig do
|
1122
|
-
override
|
1123
|
-
|
1124
|
-
|
1125
|
-
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1292
|
+
override.returns(
|
1293
|
+
{
|
1294
|
+
country: Orb::Invoice::CustomerTaxID::Country::TaggedSymbol,
|
1295
|
+
type: Orb::Invoice::CustomerTaxID::Type::TaggedSymbol,
|
1296
|
+
value: String
|
1297
|
+
}
|
1298
|
+
)
|
1299
|
+
end
|
1300
|
+
def to_hash
|
1130
1301
|
end
|
1131
|
-
def to_hash; end
|
1132
1302
|
|
1133
1303
|
module Country
|
1134
1304
|
extend Orb::Internal::Type::Enum
|
1135
1305
|
|
1136
|
-
TaggedSymbol =
|
1306
|
+
TaggedSymbol =
|
1307
|
+
T.type_alias { T.all(Symbol, Orb::Invoice::CustomerTaxID::Country) }
|
1137
1308
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1138
1309
|
|
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
|
-
|
1310
|
+
AD = T.let(:AD, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1311
|
+
AE = T.let(:AE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1312
|
+
AR = T.let(:AR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1313
|
+
AT = T.let(:AT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1314
|
+
AU = T.let(:AU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1315
|
+
BE = T.let(:BE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1316
|
+
BG = T.let(:BG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1317
|
+
BH = T.let(:BH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1318
|
+
BO = T.let(:BO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1319
|
+
BR = T.let(:BR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1320
|
+
CA = T.let(:CA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1321
|
+
CH = T.let(:CH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1322
|
+
CL = T.let(:CL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1323
|
+
CN = T.let(:CN, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1324
|
+
CO = T.let(:CO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1325
|
+
CR = T.let(:CR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1326
|
+
CY = T.let(:CY, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1327
|
+
CZ = T.let(:CZ, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1328
|
+
DE = T.let(:DE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1329
|
+
DK = T.let(:DK, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1330
|
+
EE = T.let(:EE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1331
|
+
DO = T.let(:DO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1332
|
+
EC = T.let(:EC, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1333
|
+
EG = T.let(:EG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1334
|
+
ES = T.let(:ES, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1335
|
+
EU = T.let(:EU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1336
|
+
FI = T.let(:FI, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1337
|
+
FR = T.let(:FR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1338
|
+
GB = T.let(:GB, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1339
|
+
GE = T.let(:GE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1340
|
+
GR = T.let(:GR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1341
|
+
HK = T.let(:HK, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1342
|
+
HR = T.let(:HR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1343
|
+
HU = T.let(:HU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1344
|
+
ID = T.let(:ID, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1345
|
+
IE = T.let(:IE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1346
|
+
IL = T.let(:IL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1347
|
+
IN = T.let(:IN, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1348
|
+
IS = T.let(:IS, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1349
|
+
IT = T.let(:IT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1350
|
+
JP = T.let(:JP, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1351
|
+
KE = T.let(:KE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1352
|
+
KR = T.let(:KR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1353
|
+
KZ = T.let(:KZ, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1354
|
+
LI = T.let(:LI, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1355
|
+
LT = T.let(:LT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1356
|
+
LU = T.let(:LU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1357
|
+
LV = T.let(:LV, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1358
|
+
MT = T.let(:MT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1359
|
+
MX = T.let(:MX, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1360
|
+
MY = T.let(:MY, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1361
|
+
NG = T.let(:NG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1362
|
+
NL = T.let(:NL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1363
|
+
NO = T.let(:NO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1364
|
+
NZ = T.let(:NZ, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1365
|
+
OM = T.let(:OM, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1366
|
+
PE = T.let(:PE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1367
|
+
PH = T.let(:PH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1368
|
+
PL = T.let(:PL, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1369
|
+
PT = T.let(:PT, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1370
|
+
RO = T.let(:RO, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1371
|
+
RS = T.let(:RS, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1372
|
+
RU = T.let(:RU, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1373
|
+
SA = T.let(:SA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1374
|
+
SE = T.let(:SE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1375
|
+
SG = T.let(:SG, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1376
|
+
SI = T.let(:SI, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1377
|
+
SK = T.let(:SK, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1378
|
+
SV = T.let(:SV, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1379
|
+
TH = T.let(:TH, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1380
|
+
TR = T.let(:TR, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1381
|
+
TW = T.let(:TW, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1382
|
+
UA = T.let(:UA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1383
|
+
US = T.let(:US, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1384
|
+
UY = T.let(:UY, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1385
|
+
VE = T.let(:VE, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1386
|
+
VN = T.let(:VN, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1387
|
+
ZA = T.let(:ZA, Orb::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
1388
|
+
|
1389
|
+
sig do
|
1390
|
+
override.returns(
|
1391
|
+
T::Array[Orb::Invoice::CustomerTaxID::Country::TaggedSymbol]
|
1392
|
+
)
|
1393
|
+
end
|
1394
|
+
def self.values
|
1395
|
+
end
|
1220
1396
|
end
|
1221
1397
|
|
1222
1398
|
module Type
|
1223
1399
|
extend Orb::Internal::Type::Enum
|
1224
1400
|
|
1225
|
-
TaggedSymbol =
|
1401
|
+
TaggedSymbol =
|
1402
|
+
T.type_alias { T.all(Symbol, Orb::Invoice::CustomerTaxID::Type) }
|
1226
1403
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1227
1404
|
|
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
|
-
|
1405
|
+
AD_NRT =
|
1406
|
+
T.let(:ad_nrt, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1407
|
+
AE_TRN =
|
1408
|
+
T.let(:ae_trn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1409
|
+
AR_CUIT =
|
1410
|
+
T.let(:ar_cuit, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1411
|
+
EU_VAT =
|
1412
|
+
T.let(:eu_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1413
|
+
AU_ABN =
|
1414
|
+
T.let(:au_abn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1415
|
+
AU_ARN =
|
1416
|
+
T.let(:au_arn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1417
|
+
BG_UIC =
|
1418
|
+
T.let(:bg_uic, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1419
|
+
BH_VAT =
|
1420
|
+
T.let(:bh_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1421
|
+
BO_TIN =
|
1422
|
+
T.let(:bo_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1423
|
+
BR_CNPJ =
|
1424
|
+
T.let(:br_cnpj, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1425
|
+
BR_CPF =
|
1426
|
+
T.let(:br_cpf, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1427
|
+
CA_BN = T.let(:ca_bn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1428
|
+
CA_GST_HST =
|
1429
|
+
T.let(:ca_gst_hst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1430
|
+
CA_PST_BC =
|
1431
|
+
T.let(:ca_pst_bc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1432
|
+
CA_PST_MB =
|
1433
|
+
T.let(:ca_pst_mb, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1434
|
+
CA_PST_SK =
|
1435
|
+
T.let(:ca_pst_sk, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1436
|
+
CA_QST =
|
1437
|
+
T.let(:ca_qst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1438
|
+
CH_VAT =
|
1439
|
+
T.let(:ch_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1440
|
+
CL_TIN =
|
1441
|
+
T.let(:cl_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1442
|
+
CN_TIN =
|
1443
|
+
T.let(:cn_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1444
|
+
CO_NIT =
|
1445
|
+
T.let(:co_nit, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1446
|
+
CR_TIN =
|
1447
|
+
T.let(:cr_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1448
|
+
DO_RCN =
|
1449
|
+
T.let(:do_rcn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1450
|
+
EC_RUC =
|
1451
|
+
T.let(:ec_ruc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1452
|
+
EG_TIN =
|
1453
|
+
T.let(:eg_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1454
|
+
ES_CIF =
|
1455
|
+
T.let(:es_cif, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1456
|
+
EU_OSS_VAT =
|
1457
|
+
T.let(:eu_oss_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1458
|
+
GB_VAT =
|
1459
|
+
T.let(:gb_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1460
|
+
GE_VAT =
|
1461
|
+
T.let(:ge_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1462
|
+
HK_BR = T.let(:hk_br, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1463
|
+
HU_TIN =
|
1464
|
+
T.let(:hu_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1465
|
+
ID_NPWP =
|
1466
|
+
T.let(:id_npwp, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1467
|
+
IL_VAT =
|
1468
|
+
T.let(:il_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1469
|
+
IN_GST =
|
1470
|
+
T.let(:in_gst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1471
|
+
IS_VAT =
|
1472
|
+
T.let(:is_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1473
|
+
JP_CN = T.let(:jp_cn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1474
|
+
JP_RN = T.let(:jp_rn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1475
|
+
JP_TRN =
|
1476
|
+
T.let(:jp_trn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1477
|
+
KE_PIN =
|
1478
|
+
T.let(:ke_pin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1479
|
+
KR_BRN =
|
1480
|
+
T.let(:kr_brn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1481
|
+
KZ_BIN =
|
1482
|
+
T.let(:kz_bin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1483
|
+
LI_UID =
|
1484
|
+
T.let(:li_uid, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1485
|
+
MX_RFC =
|
1486
|
+
T.let(:mx_rfc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1487
|
+
MY_FRP =
|
1488
|
+
T.let(:my_frp, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1489
|
+
MY_ITN =
|
1490
|
+
T.let(:my_itn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1491
|
+
MY_SST =
|
1492
|
+
T.let(:my_sst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1493
|
+
NG_TIN =
|
1494
|
+
T.let(:ng_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1495
|
+
NO_VAT =
|
1496
|
+
T.let(:no_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1497
|
+
NO_VOEC =
|
1498
|
+
T.let(:no_voec, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1499
|
+
NZ_GST =
|
1500
|
+
T.let(:nz_gst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1501
|
+
OM_VAT =
|
1502
|
+
T.let(:om_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1503
|
+
PE_RUC =
|
1504
|
+
T.let(:pe_ruc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1505
|
+
PH_TIN =
|
1506
|
+
T.let(:ph_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1507
|
+
RO_TIN =
|
1508
|
+
T.let(:ro_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1509
|
+
RS_PIB =
|
1510
|
+
T.let(:rs_pib, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1511
|
+
RU_INN =
|
1512
|
+
T.let(:ru_inn, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1513
|
+
RU_KPP =
|
1514
|
+
T.let(:ru_kpp, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1515
|
+
SA_VAT =
|
1516
|
+
T.let(:sa_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1517
|
+
SG_GST =
|
1518
|
+
T.let(:sg_gst, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1519
|
+
SG_UEN =
|
1520
|
+
T.let(:sg_uen, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1521
|
+
SI_TIN =
|
1522
|
+
T.let(:si_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1523
|
+
SV_NIT =
|
1524
|
+
T.let(:sv_nit, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1525
|
+
TH_VAT =
|
1526
|
+
T.let(:th_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1527
|
+
TR_TIN =
|
1528
|
+
T.let(:tr_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1529
|
+
TW_VAT =
|
1530
|
+
T.let(:tw_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1531
|
+
UA_VAT =
|
1532
|
+
T.let(:ua_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1533
|
+
US_EIN =
|
1534
|
+
T.let(:us_ein, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1535
|
+
UY_RUC =
|
1536
|
+
T.let(:uy_ruc, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1537
|
+
VE_RIF =
|
1538
|
+
T.let(:ve_rif, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1539
|
+
VN_TIN =
|
1540
|
+
T.let(:vn_tin, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1541
|
+
ZA_VAT =
|
1542
|
+
T.let(:za_vat, Orb::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
1543
|
+
|
1544
|
+
sig do
|
1545
|
+
override.returns(
|
1546
|
+
T::Array[Orb::Invoice::CustomerTaxID::Type::TaggedSymbol]
|
1547
|
+
)
|
1548
|
+
end
|
1549
|
+
def self.values
|
1550
|
+
end
|
1302
1551
|
end
|
1303
1552
|
end
|
1304
1553
|
|
1305
1554
|
module InvoiceSource
|
1306
1555
|
extend Orb::Internal::Type::Enum
|
1307
1556
|
|
1308
|
-
TaggedSymbol =
|
1557
|
+
TaggedSymbol =
|
1558
|
+
T.type_alias { T.all(Symbol, Orb::Invoice::InvoiceSource) }
|
1309
1559
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1310
1560
|
|
1311
|
-
SUBSCRIPTION =
|
1312
|
-
|
1313
|
-
|
1561
|
+
SUBSCRIPTION =
|
1562
|
+
T.let(:subscription, Orb::Invoice::InvoiceSource::TaggedSymbol)
|
1563
|
+
PARTIAL = T.let(:partial, Orb::Invoice::InvoiceSource::TaggedSymbol)
|
1564
|
+
ONE_OFF = T.let(:one_off, Orb::Invoice::InvoiceSource::TaggedSymbol)
|
1314
1565
|
|
1315
|
-
sig
|
1316
|
-
|
1566
|
+
sig do
|
1567
|
+
override.returns(T::Array[Orb::Invoice::InvoiceSource::TaggedSymbol])
|
1568
|
+
end
|
1569
|
+
def self.values
|
1570
|
+
end
|
1317
1571
|
end
|
1318
1572
|
|
1319
1573
|
class LineItem < Orb::Internal::Type::BaseModel
|
1574
|
+
OrHash =
|
1575
|
+
T.type_alias { T.any(Orb::Invoice::LineItem, Orb::Internal::AnyHash) }
|
1576
|
+
|
1320
1577
|
# A unique ID for this line item.
|
1321
1578
|
sig { returns(String) }
|
1322
1579
|
attr_accessor :id
|
@@ -1333,11 +1590,11 @@ module Orb
|
|
1333
1590
|
returns(
|
1334
1591
|
T::Array[
|
1335
1592
|
T.any(
|
1336
|
-
Orb::
|
1337
|
-
Orb::
|
1338
|
-
Orb::
|
1339
|
-
Orb::
|
1340
|
-
Orb::
|
1593
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
1594
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
1595
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
1596
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
1597
|
+
Orb::Invoice::LineItem::Adjustment::Maximum
|
1341
1598
|
)
|
1342
1599
|
]
|
1343
1600
|
)
|
@@ -1357,10 +1614,10 @@ module Orb
|
|
1357
1614
|
returns(
|
1358
1615
|
T.nilable(
|
1359
1616
|
T.any(
|
1360
|
-
Orb::
|
1361
|
-
Orb::
|
1362
|
-
Orb::
|
1363
|
-
Orb::
|
1617
|
+
Orb::PercentageDiscount,
|
1618
|
+
Orb::TrialDiscount,
|
1619
|
+
Orb::UsageDiscount,
|
1620
|
+
Orb::AmountDiscount
|
1364
1621
|
)
|
1365
1622
|
)
|
1366
1623
|
)
|
@@ -1382,10 +1639,14 @@ module Orb
|
|
1382
1639
|
attr_accessor :grouping
|
1383
1640
|
|
1384
1641
|
# This field is deprecated in favor of `adjustments`.
|
1385
|
-
sig { returns(T.nilable(Orb::
|
1642
|
+
sig { returns(T.nilable(Orb::Invoice::LineItem::Maximum)) }
|
1386
1643
|
attr_reader :maximum
|
1387
1644
|
|
1388
|
-
sig
|
1645
|
+
sig do
|
1646
|
+
params(
|
1647
|
+
maximum: T.nilable(Orb::Invoice::LineItem::Maximum::OrHash)
|
1648
|
+
).void
|
1649
|
+
end
|
1389
1650
|
attr_writer :maximum
|
1390
1651
|
|
1391
1652
|
# This field is deprecated in favor of `adjustments`.
|
@@ -1393,10 +1654,14 @@ module Orb
|
|
1393
1654
|
attr_accessor :maximum_amount
|
1394
1655
|
|
1395
1656
|
# This field is deprecated in favor of `adjustments`.
|
1396
|
-
sig { returns(T.nilable(Orb::
|
1657
|
+
sig { returns(T.nilable(Orb::Invoice::LineItem::Minimum)) }
|
1397
1658
|
attr_reader :minimum
|
1398
1659
|
|
1399
|
-
sig
|
1660
|
+
sig do
|
1661
|
+
params(
|
1662
|
+
minimum: T.nilable(Orb::Invoice::LineItem::Minimum::OrHash)
|
1663
|
+
).void
|
1664
|
+
end
|
1400
1665
|
attr_writer :minimum
|
1401
1666
|
|
1402
1667
|
# This field is deprecated in favor of `adjustments`.
|
@@ -1425,34 +1690,34 @@ module Orb
|
|
1425
1690
|
returns(
|
1426
1691
|
T.nilable(
|
1427
1692
|
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::
|
1693
|
+
Orb::Price::Unit,
|
1694
|
+
Orb::Price::Package,
|
1695
|
+
Orb::Price::Matrix,
|
1696
|
+
Orb::Price::Tiered,
|
1697
|
+
Orb::Price::TieredBps,
|
1698
|
+
Orb::Price::Bps,
|
1699
|
+
Orb::Price::BulkBps,
|
1700
|
+
Orb::Price::Bulk,
|
1701
|
+
Orb::Price::ThresholdTotalAmount,
|
1702
|
+
Orb::Price::TieredPackage,
|
1703
|
+
Orb::Price::GroupedTiered,
|
1704
|
+
Orb::Price::TieredWithMinimum,
|
1705
|
+
Orb::Price::TieredPackageWithMinimum,
|
1706
|
+
Orb::Price::PackageWithAllocation,
|
1707
|
+
Orb::Price::UnitWithPercent,
|
1708
|
+
Orb::Price::MatrixWithAllocation,
|
1709
|
+
Orb::Price::TieredWithProration,
|
1710
|
+
Orb::Price::UnitWithProration,
|
1711
|
+
Orb::Price::GroupedAllocation,
|
1712
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1713
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1714
|
+
Orb::Price::MatrixWithDisplayName,
|
1715
|
+
Orb::Price::BulkWithProration,
|
1716
|
+
Orb::Price::GroupedTieredPackage,
|
1717
|
+
Orb::Price::MaxGroupTieredPackage,
|
1718
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1719
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1720
|
+
Orb::Price::CumulativeGroupedBulk
|
1456
1721
|
)
|
1457
1722
|
)
|
1458
1723
|
)
|
@@ -1473,9 +1738,9 @@ module Orb
|
|
1473
1738
|
returns(
|
1474
1739
|
T::Array[
|
1475
1740
|
T.any(
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1741
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
1742
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
1743
|
+
Orb::Invoice::LineItem::SubLineItem::Null
|
1479
1744
|
)
|
1480
1745
|
]
|
1481
1746
|
)
|
@@ -1488,7 +1753,7 @@ module Orb
|
|
1488
1753
|
|
1489
1754
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
1490
1755
|
# integration is configured.
|
1491
|
-
sig { returns(T::Array[Orb::
|
1756
|
+
sig { returns(T::Array[Orb::Invoice::LineItem::TaxAmount]) }
|
1492
1757
|
attr_accessor :tax_amounts
|
1493
1758
|
|
1494
1759
|
# A list of customer ids that were used to calculate the usage for this line item.
|
@@ -1499,84 +1764,83 @@ module Orb
|
|
1499
1764
|
params(
|
1500
1765
|
id: String,
|
1501
1766
|
adjusted_subtotal: String,
|
1502
|
-
adjustments:
|
1503
|
-
T
|
1504
|
-
|
1505
|
-
|
1506
|
-
|
1507
|
-
|
1508
|
-
|
1509
|
-
|
1510
|
-
|
1511
|
-
|
1767
|
+
adjustments:
|
1768
|
+
T::Array[
|
1769
|
+
T.any(
|
1770
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount::OrHash,
|
1771
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount::OrHash,
|
1772
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount::OrHash,
|
1773
|
+
Orb::Invoice::LineItem::Adjustment::Minimum::OrHash,
|
1774
|
+
Orb::Invoice::LineItem::Adjustment::Maximum::OrHash
|
1775
|
+
)
|
1776
|
+
],
|
1512
1777
|
amount: String,
|
1513
1778
|
credits_applied: String,
|
1514
|
-
discount:
|
1515
|
-
T.
|
1516
|
-
|
1517
|
-
|
1518
|
-
|
1519
|
-
|
1520
|
-
|
1521
|
-
|
1522
|
-
|
1779
|
+
discount:
|
1780
|
+
T.nilable(
|
1781
|
+
T.any(
|
1782
|
+
Orb::PercentageDiscount::OrHash,
|
1783
|
+
Orb::TrialDiscount::OrHash,
|
1784
|
+
Orb::UsageDiscount::OrHash,
|
1785
|
+
Orb::AmountDiscount::OrHash
|
1786
|
+
)
|
1787
|
+
),
|
1523
1788
|
end_date: Time,
|
1524
1789
|
filter: T.nilable(String),
|
1525
1790
|
grouping: T.nilable(String),
|
1526
|
-
maximum: T.nilable(
|
1791
|
+
maximum: T.nilable(Orb::Invoice::LineItem::Maximum::OrHash),
|
1527
1792
|
maximum_amount: T.nilable(String),
|
1528
|
-
minimum: T.nilable(
|
1793
|
+
minimum: T.nilable(Orb::Invoice::LineItem::Minimum::OrHash),
|
1529
1794
|
minimum_amount: T.nilable(String),
|
1530
1795
|
name: String,
|
1531
1796
|
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
|
-
|
1797
|
+
price:
|
1798
|
+
T.nilable(
|
1799
|
+
T.any(
|
1800
|
+
Orb::Price::Unit::OrHash,
|
1801
|
+
Orb::Price::Package::OrHash,
|
1802
|
+
Orb::Price::Matrix::OrHash,
|
1803
|
+
Orb::Price::Tiered::OrHash,
|
1804
|
+
Orb::Price::TieredBps::OrHash,
|
1805
|
+
Orb::Price::Bps::OrHash,
|
1806
|
+
Orb::Price::BulkBps::OrHash,
|
1807
|
+
Orb::Price::Bulk::OrHash,
|
1808
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1809
|
+
Orb::Price::TieredPackage::OrHash,
|
1810
|
+
Orb::Price::GroupedTiered::OrHash,
|
1811
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1812
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1813
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1814
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1815
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1816
|
+
Orb::Price::TieredWithProration::OrHash,
|
1817
|
+
Orb::Price::UnitWithProration::OrHash,
|
1818
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1819
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1820
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1821
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1822
|
+
Orb::Price::BulkWithProration::OrHash,
|
1823
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1824
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1825
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1826
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1827
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1828
|
+
)
|
1829
|
+
),
|
1565
1830
|
quantity: Float,
|
1566
1831
|
start_date: Time,
|
1567
|
-
sub_line_items:
|
1568
|
-
T
|
1569
|
-
|
1570
|
-
|
1571
|
-
|
1572
|
-
|
1573
|
-
|
1574
|
-
|
1832
|
+
sub_line_items:
|
1833
|
+
T::Array[
|
1834
|
+
T.any(
|
1835
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::OrHash,
|
1836
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::OrHash,
|
1837
|
+
Orb::Invoice::LineItem::SubLineItem::Null::OrHash
|
1838
|
+
)
|
1839
|
+
],
|
1575
1840
|
subtotal: String,
|
1576
|
-
tax_amounts: T::Array[
|
1841
|
+
tax_amounts: T::Array[Orb::Invoice::LineItem::TaxAmount::OrHash],
|
1577
1842
|
usage_customer_ids: T.nilable(T::Array[String])
|
1578
|
-
)
|
1579
|
-
.returns(T.attached_class)
|
1843
|
+
).returns(T.attached_class)
|
1580
1844
|
end
|
1581
1845
|
def self.new(
|
1582
1846
|
# A unique ID for this line item.
|
@@ -1639,94 +1903,119 @@ module Orb
|
|
1639
1903
|
tax_amounts:,
|
1640
1904
|
# A list of customer ids that were used to calculate the usage for this line item.
|
1641
1905
|
usage_customer_ids:
|
1642
|
-
)
|
1906
|
+
)
|
1907
|
+
end
|
1908
|
+
|
1643
1909
|
sig do
|
1644
|
-
override
|
1645
|
-
|
1646
|
-
|
1647
|
-
|
1648
|
-
|
1649
|
-
|
1910
|
+
override.returns(
|
1911
|
+
{
|
1912
|
+
id: String,
|
1913
|
+
adjusted_subtotal: String,
|
1914
|
+
adjustments:
|
1915
|
+
T::Array[
|
1650
1916
|
T.any(
|
1651
|
-
Orb::
|
1652
|
-
Orb::
|
1653
|
-
Orb::
|
1654
|
-
Orb::
|
1655
|
-
Orb::
|
1917
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
1918
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
1919
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
1920
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
1921
|
+
Orb::Invoice::LineItem::Adjustment::Maximum
|
1656
1922
|
)
|
1657
1923
|
],
|
1658
|
-
|
1659
|
-
|
1660
|
-
|
1924
|
+
amount: String,
|
1925
|
+
credits_applied: String,
|
1926
|
+
discount:
|
1927
|
+
T.nilable(
|
1661
1928
|
T.any(
|
1662
|
-
Orb::
|
1663
|
-
Orb::
|
1664
|
-
Orb::
|
1665
|
-
Orb::
|
1929
|
+
Orb::PercentageDiscount,
|
1930
|
+
Orb::TrialDiscount,
|
1931
|
+
Orb::UsageDiscount,
|
1932
|
+
Orb::AmountDiscount
|
1666
1933
|
)
|
1667
1934
|
),
|
1668
|
-
|
1669
|
-
|
1670
|
-
|
1671
|
-
|
1672
|
-
|
1673
|
-
|
1674
|
-
|
1675
|
-
|
1676
|
-
|
1677
|
-
|
1935
|
+
end_date: Time,
|
1936
|
+
filter: T.nilable(String),
|
1937
|
+
grouping: T.nilable(String),
|
1938
|
+
maximum: T.nilable(Orb::Invoice::LineItem::Maximum),
|
1939
|
+
maximum_amount: T.nilable(String),
|
1940
|
+
minimum: T.nilable(Orb::Invoice::LineItem::Minimum),
|
1941
|
+
minimum_amount: T.nilable(String),
|
1942
|
+
name: String,
|
1943
|
+
partially_invoiced_amount: String,
|
1944
|
+
price:
|
1945
|
+
T.nilable(
|
1678
1946
|
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::
|
1947
|
+
Orb::Price::Unit,
|
1948
|
+
Orb::Price::Package,
|
1949
|
+
Orb::Price::Matrix,
|
1950
|
+
Orb::Price::Tiered,
|
1951
|
+
Orb::Price::TieredBps,
|
1952
|
+
Orb::Price::Bps,
|
1953
|
+
Orb::Price::BulkBps,
|
1954
|
+
Orb::Price::Bulk,
|
1955
|
+
Orb::Price::ThresholdTotalAmount,
|
1956
|
+
Orb::Price::TieredPackage,
|
1957
|
+
Orb::Price::GroupedTiered,
|
1958
|
+
Orb::Price::TieredWithMinimum,
|
1959
|
+
Orb::Price::TieredPackageWithMinimum,
|
1960
|
+
Orb::Price::PackageWithAllocation,
|
1961
|
+
Orb::Price::UnitWithPercent,
|
1962
|
+
Orb::Price::MatrixWithAllocation,
|
1963
|
+
Orb::Price::TieredWithProration,
|
1964
|
+
Orb::Price::UnitWithProration,
|
1965
|
+
Orb::Price::GroupedAllocation,
|
1966
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1967
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1968
|
+
Orb::Price::MatrixWithDisplayName,
|
1969
|
+
Orb::Price::BulkWithProration,
|
1970
|
+
Orb::Price::GroupedTieredPackage,
|
1971
|
+
Orb::Price::MaxGroupTieredPackage,
|
1972
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1973
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1974
|
+
Orb::Price::CumulativeGroupedBulk
|
1707
1975
|
)
|
1708
1976
|
),
|
1709
|
-
|
1710
|
-
|
1711
|
-
|
1977
|
+
quantity: Float,
|
1978
|
+
start_date: Time,
|
1979
|
+
sub_line_items:
|
1980
|
+
T::Array[
|
1712
1981
|
T.any(
|
1713
|
-
Orb::
|
1714
|
-
Orb::
|
1715
|
-
Orb::
|
1982
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
1983
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
1984
|
+
Orb::Invoice::LineItem::SubLineItem::Null
|
1716
1985
|
)
|
1717
1986
|
],
|
1718
|
-
|
1719
|
-
|
1720
|
-
|
1721
|
-
|
1722
|
-
|
1987
|
+
subtotal: String,
|
1988
|
+
tax_amounts: T::Array[Orb::Invoice::LineItem::TaxAmount],
|
1989
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1990
|
+
}
|
1991
|
+
)
|
1992
|
+
end
|
1993
|
+
def to_hash
|
1723
1994
|
end
|
1724
|
-
def to_hash; end
|
1725
1995
|
|
1726
1996
|
module Adjustment
|
1727
1997
|
extend Orb::Internal::Type::Union
|
1728
1998
|
|
1999
|
+
Variants =
|
2000
|
+
T.type_alias do
|
2001
|
+
T.any(
|
2002
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
2003
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
2004
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
2005
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
2006
|
+
Orb::Invoice::LineItem::Adjustment::Maximum
|
2007
|
+
)
|
2008
|
+
end
|
2009
|
+
|
1729
2010
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
2011
|
+
OrHash =
|
2012
|
+
T.type_alias do
|
2013
|
+
T.any(
|
2014
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
2015
|
+
Orb::Internal::AnyHash
|
2016
|
+
)
|
2017
|
+
end
|
2018
|
+
|
1730
2019
|
sig { returns(String) }
|
1731
2020
|
attr_accessor :id
|
1732
2021
|
|
@@ -1764,8 +2053,7 @@ module Orb
|
|
1764
2053
|
reason: T.nilable(String),
|
1765
2054
|
usage_discount: Float,
|
1766
2055
|
adjustment_type: Symbol
|
1767
|
-
)
|
1768
|
-
.returns(T.attached_class)
|
2056
|
+
).returns(T.attached_class)
|
1769
2057
|
end
|
1770
2058
|
def self.new(
|
1771
2059
|
id:,
|
@@ -1782,25 +2070,35 @@ module Orb
|
|
1782
2070
|
# to in a given billing period.
|
1783
2071
|
usage_discount:,
|
1784
2072
|
adjustment_type: :usage_discount
|
1785
|
-
)
|
2073
|
+
)
|
2074
|
+
end
|
2075
|
+
|
1786
2076
|
sig do
|
1787
|
-
override
|
1788
|
-
|
1789
|
-
|
1790
|
-
|
1791
|
-
|
1792
|
-
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
1796
|
-
|
1797
|
-
|
1798
|
-
|
2077
|
+
override.returns(
|
2078
|
+
{
|
2079
|
+
id: String,
|
2080
|
+
adjustment_type: Symbol,
|
2081
|
+
amount: String,
|
2082
|
+
applies_to_price_ids: T::Array[String],
|
2083
|
+
is_invoice_level: T::Boolean,
|
2084
|
+
reason: T.nilable(String),
|
2085
|
+
usage_discount: Float
|
2086
|
+
}
|
2087
|
+
)
|
2088
|
+
end
|
2089
|
+
def to_hash
|
1799
2090
|
end
|
1800
|
-
def to_hash; end
|
1801
2091
|
end
|
1802
2092
|
|
1803
2093
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
2094
|
+
OrHash =
|
2095
|
+
T.type_alias do
|
2096
|
+
T.any(
|
2097
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
2098
|
+
Orb::Internal::AnyHash
|
2099
|
+
)
|
2100
|
+
end
|
2101
|
+
|
1804
2102
|
sig { returns(String) }
|
1805
2103
|
attr_accessor :id
|
1806
2104
|
|
@@ -1838,8 +2136,7 @@ module Orb
|
|
1838
2136
|
is_invoice_level: T::Boolean,
|
1839
2137
|
reason: T.nilable(String),
|
1840
2138
|
adjustment_type: Symbol
|
1841
|
-
)
|
1842
|
-
.returns(T.attached_class)
|
2139
|
+
).returns(T.attached_class)
|
1843
2140
|
end
|
1844
2141
|
def self.new(
|
1845
2142
|
id:,
|
@@ -1856,25 +2153,35 @@ module Orb
|
|
1856
2153
|
# The reason for the adjustment.
|
1857
2154
|
reason:,
|
1858
2155
|
adjustment_type: :amount_discount
|
1859
|
-
)
|
2156
|
+
)
|
2157
|
+
end
|
2158
|
+
|
1860
2159
|
sig do
|
1861
|
-
override
|
1862
|
-
|
1863
|
-
|
1864
|
-
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1872
|
-
|
2160
|
+
override.returns(
|
2161
|
+
{
|
2162
|
+
id: String,
|
2163
|
+
adjustment_type: Symbol,
|
2164
|
+
amount: String,
|
2165
|
+
amount_discount: String,
|
2166
|
+
applies_to_price_ids: T::Array[String],
|
2167
|
+
is_invoice_level: T::Boolean,
|
2168
|
+
reason: T.nilable(String)
|
2169
|
+
}
|
2170
|
+
)
|
2171
|
+
end
|
2172
|
+
def to_hash
|
1873
2173
|
end
|
1874
|
-
def to_hash; end
|
1875
2174
|
end
|
1876
2175
|
|
1877
2176
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
2177
|
+
OrHash =
|
2178
|
+
T.type_alias do
|
2179
|
+
T.any(
|
2180
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
2181
|
+
Orb::Internal::AnyHash
|
2182
|
+
)
|
2183
|
+
end
|
2184
|
+
|
1878
2185
|
sig { returns(String) }
|
1879
2186
|
attr_accessor :id
|
1880
2187
|
|
@@ -1912,8 +2219,7 @@ module Orb
|
|
1912
2219
|
percentage_discount: Float,
|
1913
2220
|
reason: T.nilable(String),
|
1914
2221
|
adjustment_type: Symbol
|
1915
|
-
)
|
1916
|
-
.returns(T.attached_class)
|
2222
|
+
).returns(T.attached_class)
|
1917
2223
|
end
|
1918
2224
|
def self.new(
|
1919
2225
|
id:,
|
@@ -1930,25 +2236,35 @@ module Orb
|
|
1930
2236
|
# The reason for the adjustment.
|
1931
2237
|
reason:,
|
1932
2238
|
adjustment_type: :percentage_discount
|
1933
|
-
)
|
2239
|
+
)
|
2240
|
+
end
|
2241
|
+
|
1934
2242
|
sig do
|
1935
|
-
override
|
1936
|
-
|
1937
|
-
|
1938
|
-
|
1939
|
-
|
1940
|
-
|
1941
|
-
|
1942
|
-
|
1943
|
-
|
1944
|
-
|
1945
|
-
|
1946
|
-
|
2243
|
+
override.returns(
|
2244
|
+
{
|
2245
|
+
id: String,
|
2246
|
+
adjustment_type: Symbol,
|
2247
|
+
amount: String,
|
2248
|
+
applies_to_price_ids: T::Array[String],
|
2249
|
+
is_invoice_level: T::Boolean,
|
2250
|
+
percentage_discount: Float,
|
2251
|
+
reason: T.nilable(String)
|
2252
|
+
}
|
2253
|
+
)
|
2254
|
+
end
|
2255
|
+
def to_hash
|
1947
2256
|
end
|
1948
|
-
def to_hash; end
|
1949
2257
|
end
|
1950
2258
|
|
1951
2259
|
class Minimum < Orb::Internal::Type::BaseModel
|
2260
|
+
OrHash =
|
2261
|
+
T.type_alias do
|
2262
|
+
T.any(
|
2263
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
2264
|
+
Orb::Internal::AnyHash
|
2265
|
+
)
|
2266
|
+
end
|
2267
|
+
|
1952
2268
|
sig { returns(String) }
|
1953
2269
|
attr_accessor :id
|
1954
2270
|
|
@@ -1991,8 +2307,7 @@ module Orb
|
|
1991
2307
|
minimum_amount: String,
|
1992
2308
|
reason: T.nilable(String),
|
1993
2309
|
adjustment_type: Symbol
|
1994
|
-
)
|
1995
|
-
.returns(T.attached_class)
|
2310
|
+
).returns(T.attached_class)
|
1996
2311
|
end
|
1997
2312
|
def self.new(
|
1998
2313
|
id:,
|
@@ -2011,26 +2326,36 @@ module Orb
|
|
2011
2326
|
# The reason for the adjustment.
|
2012
2327
|
reason:,
|
2013
2328
|
adjustment_type: :minimum
|
2014
|
-
)
|
2329
|
+
)
|
2330
|
+
end
|
2331
|
+
|
2015
2332
|
sig do
|
2016
|
-
override
|
2017
|
-
|
2018
|
-
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
2022
|
-
|
2023
|
-
|
2024
|
-
|
2025
|
-
|
2026
|
-
|
2027
|
-
|
2028
|
-
|
2333
|
+
override.returns(
|
2334
|
+
{
|
2335
|
+
id: String,
|
2336
|
+
adjustment_type: Symbol,
|
2337
|
+
amount: String,
|
2338
|
+
applies_to_price_ids: T::Array[String],
|
2339
|
+
is_invoice_level: T::Boolean,
|
2340
|
+
item_id: String,
|
2341
|
+
minimum_amount: String,
|
2342
|
+
reason: T.nilable(String)
|
2343
|
+
}
|
2344
|
+
)
|
2345
|
+
end
|
2346
|
+
def to_hash
|
2029
2347
|
end
|
2030
|
-
def to_hash; end
|
2031
2348
|
end
|
2032
2349
|
|
2033
2350
|
class Maximum < Orb::Internal::Type::BaseModel
|
2351
|
+
OrHash =
|
2352
|
+
T.type_alias do
|
2353
|
+
T.any(
|
2354
|
+
Orb::Invoice::LineItem::Adjustment::Maximum,
|
2355
|
+
Orb::Internal::AnyHash
|
2356
|
+
)
|
2357
|
+
end
|
2358
|
+
|
2034
2359
|
sig { returns(String) }
|
2035
2360
|
attr_accessor :id
|
2036
2361
|
|
@@ -2068,8 +2393,7 @@ module Orb
|
|
2068
2393
|
maximum_amount: String,
|
2069
2394
|
reason: T.nilable(String),
|
2070
2395
|
adjustment_type: Symbol
|
2071
|
-
)
|
2072
|
-
.returns(T.attached_class)
|
2396
|
+
).returns(T.attached_class)
|
2073
2397
|
end
|
2074
2398
|
def self.new(
|
2075
2399
|
id:,
|
@@ -2086,34 +2410,41 @@ module Orb
|
|
2086
2410
|
# The reason for the adjustment.
|
2087
2411
|
reason:,
|
2088
2412
|
adjustment_type: :maximum
|
2089
|
-
)
|
2413
|
+
)
|
2414
|
+
end
|
2415
|
+
|
2090
2416
|
sig do
|
2091
|
-
override
|
2092
|
-
|
2093
|
-
|
2094
|
-
|
2095
|
-
|
2096
|
-
|
2097
|
-
|
2098
|
-
|
2099
|
-
|
2100
|
-
|
2101
|
-
|
2102
|
-
|
2417
|
+
override.returns(
|
2418
|
+
{
|
2419
|
+
id: String,
|
2420
|
+
adjustment_type: Symbol,
|
2421
|
+
amount: String,
|
2422
|
+
applies_to_price_ids: T::Array[String],
|
2423
|
+
is_invoice_level: T::Boolean,
|
2424
|
+
maximum_amount: String,
|
2425
|
+
reason: T.nilable(String)
|
2426
|
+
}
|
2427
|
+
)
|
2428
|
+
end
|
2429
|
+
def to_hash
|
2103
2430
|
end
|
2104
|
-
def to_hash; end
|
2105
2431
|
end
|
2106
2432
|
|
2107
2433
|
sig do
|
2108
|
-
override
|
2109
|
-
|
2110
|
-
|
2111
|
-
|
2434
|
+
override.returns(
|
2435
|
+
T::Array[Orb::Invoice::LineItem::Adjustment::Variants]
|
2436
|
+
)
|
2437
|
+
end
|
2438
|
+
def self.variants
|
2112
2439
|
end
|
2113
|
-
def self.variants; end
|
2114
2440
|
end
|
2115
2441
|
|
2116
2442
|
class Maximum < Orb::Internal::Type::BaseModel
|
2443
|
+
OrHash =
|
2444
|
+
T.type_alias do
|
2445
|
+
T.any(Orb::Invoice::LineItem::Maximum, Orb::Internal::AnyHash)
|
2446
|
+
end
|
2447
|
+
|
2117
2448
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2118
2449
|
# maximums, this can be a subset of prices.
|
2119
2450
|
sig { returns(T::Array[String]) }
|
@@ -2125,7 +2456,10 @@ module Orb
|
|
2125
2456
|
|
2126
2457
|
# This field is deprecated in favor of `adjustments`.
|
2127
2458
|
sig do
|
2128
|
-
params(
|
2459
|
+
params(
|
2460
|
+
applies_to_price_ids: T::Array[String],
|
2461
|
+
maximum_amount: String
|
2462
|
+
).returns(T.attached_class)
|
2129
2463
|
end
|
2130
2464
|
def self.new(
|
2131
2465
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -2133,12 +2467,24 @@ module Orb
|
|
2133
2467
|
applies_to_price_ids:,
|
2134
2468
|
# Maximum amount applied
|
2135
2469
|
maximum_amount:
|
2136
|
-
)
|
2137
|
-
|
2138
|
-
|
2470
|
+
)
|
2471
|
+
end
|
2472
|
+
|
2473
|
+
sig do
|
2474
|
+
override.returns(
|
2475
|
+
{ applies_to_price_ids: T::Array[String], maximum_amount: String }
|
2476
|
+
)
|
2477
|
+
end
|
2478
|
+
def to_hash
|
2479
|
+
end
|
2139
2480
|
end
|
2140
2481
|
|
2141
2482
|
class Minimum < Orb::Internal::Type::BaseModel
|
2483
|
+
OrHash =
|
2484
|
+
T.type_alias do
|
2485
|
+
T.any(Orb::Invoice::LineItem::Minimum, Orb::Internal::AnyHash)
|
2486
|
+
end
|
2487
|
+
|
2142
2488
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2143
2489
|
# minimums, this can be a subset of prices.
|
2144
2490
|
sig { returns(T::Array[String]) }
|
@@ -2150,7 +2496,10 @@ module Orb
|
|
2150
2496
|
|
2151
2497
|
# This field is deprecated in favor of `adjustments`.
|
2152
2498
|
sig do
|
2153
|
-
params(
|
2499
|
+
params(
|
2500
|
+
applies_to_price_ids: T::Array[String],
|
2501
|
+
minimum_amount: String
|
2502
|
+
).returns(T.attached_class)
|
2154
2503
|
end
|
2155
2504
|
def self.new(
|
2156
2505
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -2158,38 +2507,70 @@ module Orb
|
|
2158
2507
|
applies_to_price_ids:,
|
2159
2508
|
# Minimum amount applied
|
2160
2509
|
minimum_amount:
|
2161
|
-
)
|
2162
|
-
|
2163
|
-
|
2510
|
+
)
|
2511
|
+
end
|
2512
|
+
|
2513
|
+
sig do
|
2514
|
+
override.returns(
|
2515
|
+
{ applies_to_price_ids: T::Array[String], minimum_amount: String }
|
2516
|
+
)
|
2517
|
+
end
|
2518
|
+
def to_hash
|
2519
|
+
end
|
2164
2520
|
end
|
2165
2521
|
|
2166
2522
|
module SubLineItem
|
2167
2523
|
extend Orb::Internal::Type::Union
|
2168
2524
|
|
2525
|
+
Variants =
|
2526
|
+
T.type_alias do
|
2527
|
+
T.any(
|
2528
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
2529
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
2530
|
+
Orb::Invoice::LineItem::SubLineItem::Null
|
2531
|
+
)
|
2532
|
+
end
|
2533
|
+
|
2169
2534
|
class Matrix < Orb::Internal::Type::BaseModel
|
2535
|
+
OrHash =
|
2536
|
+
T.type_alias do
|
2537
|
+
T.any(
|
2538
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
2539
|
+
Orb::Internal::AnyHash
|
2540
|
+
)
|
2541
|
+
end
|
2542
|
+
|
2170
2543
|
# The total amount for this sub line item.
|
2171
2544
|
sig { returns(String) }
|
2172
2545
|
attr_accessor :amount
|
2173
2546
|
|
2174
|
-
sig
|
2547
|
+
sig do
|
2548
|
+
returns(
|
2549
|
+
T.nilable(Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping)
|
2550
|
+
)
|
2551
|
+
end
|
2175
2552
|
attr_reader :grouping
|
2176
2553
|
|
2177
2554
|
sig do
|
2178
2555
|
params(
|
2179
|
-
grouping:
|
2180
|
-
|
2181
|
-
|
2556
|
+
grouping:
|
2557
|
+
T.nilable(
|
2558
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping::OrHash
|
2559
|
+
)
|
2560
|
+
).void
|
2182
2561
|
end
|
2183
2562
|
attr_writer :grouping
|
2184
2563
|
|
2185
|
-
sig
|
2564
|
+
sig do
|
2565
|
+
returns(Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig)
|
2566
|
+
end
|
2186
2567
|
attr_reader :matrix_config
|
2187
2568
|
|
2188
2569
|
sig do
|
2189
2570
|
params(
|
2190
|
-
matrix_config:
|
2191
|
-
|
2192
|
-
|
2571
|
+
matrix_config:
|
2572
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig::OrHash
|
2573
|
+
).void
|
2193
2574
|
end
|
2194
2575
|
attr_writer :matrix_config
|
2195
2576
|
|
@@ -2205,13 +2586,16 @@ module Orb
|
|
2205
2586
|
sig do
|
2206
2587
|
params(
|
2207
2588
|
amount: String,
|
2208
|
-
grouping:
|
2209
|
-
|
2589
|
+
grouping:
|
2590
|
+
T.nilable(
|
2591
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping::OrHash
|
2592
|
+
),
|
2593
|
+
matrix_config:
|
2594
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig::OrHash,
|
2210
2595
|
name: String,
|
2211
2596
|
quantity: Float,
|
2212
2597
|
type: Symbol
|
2213
|
-
)
|
2214
|
-
.returns(T.attached_class)
|
2598
|
+
).returns(T.attached_class)
|
2215
2599
|
end
|
2216
2600
|
def self.new(
|
2217
2601
|
# The total amount for this sub line item.
|
@@ -2221,23 +2605,37 @@ module Orb
|
|
2221
2605
|
name:,
|
2222
2606
|
quantity:,
|
2223
2607
|
type: :matrix
|
2224
|
-
)
|
2608
|
+
)
|
2609
|
+
end
|
2610
|
+
|
2225
2611
|
sig do
|
2226
|
-
override
|
2227
|
-
|
2228
|
-
|
2229
|
-
|
2230
|
-
|
2231
|
-
|
2232
|
-
|
2233
|
-
|
2234
|
-
|
2235
|
-
|
2236
|
-
|
2612
|
+
override.returns(
|
2613
|
+
{
|
2614
|
+
amount: String,
|
2615
|
+
grouping:
|
2616
|
+
T.nilable(
|
2617
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping
|
2618
|
+
),
|
2619
|
+
matrix_config:
|
2620
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig,
|
2621
|
+
name: String,
|
2622
|
+
quantity: Float,
|
2623
|
+
type: Symbol
|
2624
|
+
}
|
2625
|
+
)
|
2626
|
+
end
|
2627
|
+
def to_hash
|
2237
2628
|
end
|
2238
|
-
def to_hash; end
|
2239
2629
|
|
2240
2630
|
class Grouping < Orb::Internal::Type::BaseModel
|
2631
|
+
OrHash =
|
2632
|
+
T.type_alias do
|
2633
|
+
T.any(
|
2634
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping,
|
2635
|
+
Orb::Internal::AnyHash
|
2636
|
+
)
|
2637
|
+
end
|
2638
|
+
|
2241
2639
|
sig { returns(String) }
|
2242
2640
|
attr_accessor :key
|
2243
2641
|
|
@@ -2245,44 +2643,86 @@ module Orb
|
|
2245
2643
|
sig { returns(T.nilable(String)) }
|
2246
2644
|
attr_accessor :value
|
2247
2645
|
|
2248
|
-
sig
|
2646
|
+
sig do
|
2647
|
+
params(key: String, value: T.nilable(String)).returns(
|
2648
|
+
T.attached_class
|
2649
|
+
)
|
2650
|
+
end
|
2249
2651
|
def self.new(
|
2250
2652
|
key:,
|
2251
2653
|
# No value indicates the default group
|
2252
2654
|
value:
|
2253
|
-
)
|
2254
|
-
|
2255
|
-
|
2655
|
+
)
|
2656
|
+
end
|
2657
|
+
|
2658
|
+
sig do
|
2659
|
+
override.returns({ key: String, value: T.nilable(String) })
|
2660
|
+
end
|
2661
|
+
def to_hash
|
2662
|
+
end
|
2256
2663
|
end
|
2257
2664
|
|
2258
2665
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
2666
|
+
OrHash =
|
2667
|
+
T.type_alias do
|
2668
|
+
T.any(
|
2669
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig,
|
2670
|
+
Orb::Internal::AnyHash
|
2671
|
+
)
|
2672
|
+
end
|
2673
|
+
|
2259
2674
|
# The ordered dimension values for this line item.
|
2260
2675
|
sig { returns(T::Array[T.nilable(String)]) }
|
2261
2676
|
attr_accessor :dimension_values
|
2262
2677
|
|
2263
|
-
sig
|
2678
|
+
sig do
|
2679
|
+
params(dimension_values: T::Array[T.nilable(String)]).returns(
|
2680
|
+
T.attached_class
|
2681
|
+
)
|
2682
|
+
end
|
2264
2683
|
def self.new(
|
2265
2684
|
# The ordered dimension values for this line item.
|
2266
2685
|
dimension_values:
|
2267
|
-
)
|
2268
|
-
|
2269
|
-
|
2686
|
+
)
|
2687
|
+
end
|
2688
|
+
|
2689
|
+
sig do
|
2690
|
+
override.returns(
|
2691
|
+
{ dimension_values: T::Array[T.nilable(String)] }
|
2692
|
+
)
|
2693
|
+
end
|
2694
|
+
def to_hash
|
2695
|
+
end
|
2270
2696
|
end
|
2271
2697
|
end
|
2272
2698
|
|
2273
2699
|
class Tier < Orb::Internal::Type::BaseModel
|
2700
|
+
OrHash =
|
2701
|
+
T.type_alias do
|
2702
|
+
T.any(
|
2703
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
2704
|
+
Orb::Internal::AnyHash
|
2705
|
+
)
|
2706
|
+
end
|
2707
|
+
|
2274
2708
|
# The total amount for this sub line item.
|
2275
2709
|
sig { returns(String) }
|
2276
2710
|
attr_accessor :amount
|
2277
2711
|
|
2278
|
-
sig
|
2712
|
+
sig do
|
2713
|
+
returns(
|
2714
|
+
T.nilable(Orb::Invoice::LineItem::SubLineItem::Tier::Grouping)
|
2715
|
+
)
|
2716
|
+
end
|
2279
2717
|
attr_reader :grouping
|
2280
2718
|
|
2281
2719
|
sig do
|
2282
2720
|
params(
|
2283
|
-
grouping:
|
2284
|
-
|
2285
|
-
|
2721
|
+
grouping:
|
2722
|
+
T.nilable(
|
2723
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping::OrHash
|
2724
|
+
)
|
2725
|
+
).void
|
2286
2726
|
end
|
2287
2727
|
attr_writer :grouping
|
2288
2728
|
|
@@ -2292,14 +2732,16 @@ module Orb
|
|
2292
2732
|
sig { returns(Float) }
|
2293
2733
|
attr_accessor :quantity
|
2294
2734
|
|
2295
|
-
sig
|
2735
|
+
sig do
|
2736
|
+
returns(Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig)
|
2737
|
+
end
|
2296
2738
|
attr_reader :tier_config
|
2297
2739
|
|
2298
2740
|
sig do
|
2299
2741
|
params(
|
2300
|
-
tier_config:
|
2301
|
-
|
2302
|
-
|
2742
|
+
tier_config:
|
2743
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig::OrHash
|
2744
|
+
).void
|
2303
2745
|
end
|
2304
2746
|
attr_writer :tier_config
|
2305
2747
|
|
@@ -2309,13 +2751,16 @@ module Orb
|
|
2309
2751
|
sig do
|
2310
2752
|
params(
|
2311
2753
|
amount: String,
|
2312
|
-
grouping:
|
2754
|
+
grouping:
|
2755
|
+
T.nilable(
|
2756
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping::OrHash
|
2757
|
+
),
|
2313
2758
|
name: String,
|
2314
2759
|
quantity: Float,
|
2315
|
-
tier_config:
|
2760
|
+
tier_config:
|
2761
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig::OrHash,
|
2316
2762
|
type: Symbol
|
2317
|
-
)
|
2318
|
-
.returns(T.attached_class)
|
2763
|
+
).returns(T.attached_class)
|
2319
2764
|
end
|
2320
2765
|
def self.new(
|
2321
2766
|
# The total amount for this sub line item.
|
@@ -2325,23 +2770,37 @@ module Orb
|
|
2325
2770
|
quantity:,
|
2326
2771
|
tier_config:,
|
2327
2772
|
type: :tier
|
2328
|
-
)
|
2773
|
+
)
|
2774
|
+
end
|
2775
|
+
|
2329
2776
|
sig do
|
2330
|
-
override
|
2331
|
-
|
2332
|
-
|
2333
|
-
|
2334
|
-
|
2335
|
-
|
2336
|
-
|
2337
|
-
|
2338
|
-
|
2339
|
-
|
2340
|
-
|
2777
|
+
override.returns(
|
2778
|
+
{
|
2779
|
+
amount: String,
|
2780
|
+
grouping:
|
2781
|
+
T.nilable(
|
2782
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping
|
2783
|
+
),
|
2784
|
+
name: String,
|
2785
|
+
quantity: Float,
|
2786
|
+
tier_config:
|
2787
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig,
|
2788
|
+
type: Symbol
|
2789
|
+
}
|
2790
|
+
)
|
2791
|
+
end
|
2792
|
+
def to_hash
|
2341
2793
|
end
|
2342
|
-
def to_hash; end
|
2343
2794
|
|
2344
2795
|
class Grouping < Orb::Internal::Type::BaseModel
|
2796
|
+
OrHash =
|
2797
|
+
T.type_alias do
|
2798
|
+
T.any(
|
2799
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping,
|
2800
|
+
Orb::Internal::AnyHash
|
2801
|
+
)
|
2802
|
+
end
|
2803
|
+
|
2345
2804
|
sig { returns(String) }
|
2346
2805
|
attr_accessor :key
|
2347
2806
|
|
@@ -2349,17 +2808,34 @@ module Orb
|
|
2349
2808
|
sig { returns(T.nilable(String)) }
|
2350
2809
|
attr_accessor :value
|
2351
2810
|
|
2352
|
-
sig
|
2811
|
+
sig do
|
2812
|
+
params(key: String, value: T.nilable(String)).returns(
|
2813
|
+
T.attached_class
|
2814
|
+
)
|
2815
|
+
end
|
2353
2816
|
def self.new(
|
2354
2817
|
key:,
|
2355
2818
|
# No value indicates the default group
|
2356
2819
|
value:
|
2357
|
-
)
|
2358
|
-
|
2359
|
-
|
2820
|
+
)
|
2821
|
+
end
|
2822
|
+
|
2823
|
+
sig do
|
2824
|
+
override.returns({ key: String, value: T.nilable(String) })
|
2825
|
+
end
|
2826
|
+
def to_hash
|
2827
|
+
end
|
2360
2828
|
end
|
2361
2829
|
|
2362
2830
|
class TierConfig < Orb::Internal::Type::BaseModel
|
2831
|
+
OrHash =
|
2832
|
+
T.type_alias do
|
2833
|
+
T.any(
|
2834
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig,
|
2835
|
+
Orb::Internal::AnyHash
|
2836
|
+
)
|
2837
|
+
end
|
2838
|
+
|
2363
2839
|
sig { returns(Float) }
|
2364
2840
|
attr_accessor :first_unit
|
2365
2841
|
|
@@ -2376,26 +2852,50 @@ module Orb
|
|
2376
2852
|
unit_amount: String
|
2377
2853
|
).returns(T.attached_class)
|
2378
2854
|
end
|
2379
|
-
def self.new(first_unit:, last_unit:, unit_amount:)
|
2855
|
+
def self.new(first_unit:, last_unit:, unit_amount:)
|
2856
|
+
end
|
2380
2857
|
|
2381
|
-
sig
|
2382
|
-
|
2858
|
+
sig do
|
2859
|
+
override.returns(
|
2860
|
+
{
|
2861
|
+
first_unit: Float,
|
2862
|
+
last_unit: T.nilable(Float),
|
2863
|
+
unit_amount: String
|
2864
|
+
}
|
2865
|
+
)
|
2866
|
+
end
|
2867
|
+
def to_hash
|
2868
|
+
end
|
2383
2869
|
end
|
2384
2870
|
end
|
2385
2871
|
|
2386
2872
|
class Null < Orb::Internal::Type::BaseModel
|
2873
|
+
OrHash =
|
2874
|
+
T.type_alias do
|
2875
|
+
T.any(
|
2876
|
+
Orb::Invoice::LineItem::SubLineItem::Null,
|
2877
|
+
Orb::Internal::AnyHash
|
2878
|
+
)
|
2879
|
+
end
|
2880
|
+
|
2387
2881
|
# The total amount for this sub line item.
|
2388
2882
|
sig { returns(String) }
|
2389
2883
|
attr_accessor :amount
|
2390
2884
|
|
2391
|
-
sig
|
2885
|
+
sig do
|
2886
|
+
returns(
|
2887
|
+
T.nilable(Orb::Invoice::LineItem::SubLineItem::Null::Grouping)
|
2888
|
+
)
|
2889
|
+
end
|
2392
2890
|
attr_reader :grouping
|
2393
2891
|
|
2394
2892
|
sig do
|
2395
2893
|
params(
|
2396
|
-
grouping:
|
2397
|
-
|
2398
|
-
|
2894
|
+
grouping:
|
2895
|
+
T.nilable(
|
2896
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping::OrHash
|
2897
|
+
)
|
2898
|
+
).void
|
2399
2899
|
end
|
2400
2900
|
attr_writer :grouping
|
2401
2901
|
|
@@ -2411,12 +2911,14 @@ module Orb
|
|
2411
2911
|
sig do
|
2412
2912
|
params(
|
2413
2913
|
amount: String,
|
2414
|
-
grouping:
|
2914
|
+
grouping:
|
2915
|
+
T.nilable(
|
2916
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping::OrHash
|
2917
|
+
),
|
2415
2918
|
name: String,
|
2416
2919
|
quantity: Float,
|
2417
2920
|
type: Symbol
|
2418
|
-
)
|
2419
|
-
.returns(T.attached_class)
|
2921
|
+
).returns(T.attached_class)
|
2420
2922
|
end
|
2421
2923
|
def self.new(
|
2422
2924
|
# The total amount for this sub line item.
|
@@ -2425,22 +2927,35 @@ module Orb
|
|
2425
2927
|
name:,
|
2426
2928
|
quantity:,
|
2427
2929
|
type: :"'null'"
|
2428
|
-
)
|
2930
|
+
)
|
2931
|
+
end
|
2932
|
+
|
2429
2933
|
sig do
|
2430
|
-
override
|
2431
|
-
|
2432
|
-
|
2433
|
-
|
2434
|
-
|
2435
|
-
|
2436
|
-
|
2437
|
-
|
2438
|
-
|
2439
|
-
|
2934
|
+
override.returns(
|
2935
|
+
{
|
2936
|
+
amount: String,
|
2937
|
+
grouping:
|
2938
|
+
T.nilable(
|
2939
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping
|
2940
|
+
),
|
2941
|
+
name: String,
|
2942
|
+
quantity: Float,
|
2943
|
+
type: Symbol
|
2944
|
+
}
|
2945
|
+
)
|
2946
|
+
end
|
2947
|
+
def to_hash
|
2440
2948
|
end
|
2441
|
-
def to_hash; end
|
2442
2949
|
|
2443
2950
|
class Grouping < Orb::Internal::Type::BaseModel
|
2951
|
+
OrHash =
|
2952
|
+
T.type_alias do
|
2953
|
+
T.any(
|
2954
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping,
|
2955
|
+
Orb::Internal::AnyHash
|
2956
|
+
)
|
2957
|
+
end
|
2958
|
+
|
2444
2959
|
sig { returns(String) }
|
2445
2960
|
attr_accessor :key
|
2446
2961
|
|
@@ -2448,27 +2963,41 @@ module Orb
|
|
2448
2963
|
sig { returns(T.nilable(String)) }
|
2449
2964
|
attr_accessor :value
|
2450
2965
|
|
2451
|
-
sig
|
2966
|
+
sig do
|
2967
|
+
params(key: String, value: T.nilable(String)).returns(
|
2968
|
+
T.attached_class
|
2969
|
+
)
|
2970
|
+
end
|
2452
2971
|
def self.new(
|
2453
2972
|
key:,
|
2454
2973
|
# No value indicates the default group
|
2455
2974
|
value:
|
2456
|
-
)
|
2457
|
-
|
2458
|
-
|
2975
|
+
)
|
2976
|
+
end
|
2977
|
+
|
2978
|
+
sig do
|
2979
|
+
override.returns({ key: String, value: T.nilable(String) })
|
2980
|
+
end
|
2981
|
+
def to_hash
|
2982
|
+
end
|
2459
2983
|
end
|
2460
2984
|
end
|
2461
2985
|
|
2462
2986
|
sig do
|
2463
|
-
override
|
2464
|
-
|
2465
|
-
|
2466
|
-
|
2987
|
+
override.returns(
|
2988
|
+
T::Array[Orb::Invoice::LineItem::SubLineItem::Variants]
|
2989
|
+
)
|
2990
|
+
end
|
2991
|
+
def self.variants
|
2467
2992
|
end
|
2468
|
-
def self.variants; end
|
2469
2993
|
end
|
2470
2994
|
|
2471
2995
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
2996
|
+
OrHash =
|
2997
|
+
T.type_alias do
|
2998
|
+
T.any(Orb::Invoice::LineItem::TaxAmount, Orb::Internal::AnyHash)
|
2999
|
+
end
|
3000
|
+
|
2472
3001
|
# The amount of additional tax incurred by this tax rate.
|
2473
3002
|
sig { returns(String) }
|
2474
3003
|
attr_accessor :amount
|
@@ -2482,8 +3011,11 @@ module Orb
|
|
2482
3011
|
attr_accessor :tax_rate_percentage
|
2483
3012
|
|
2484
3013
|
sig do
|
2485
|
-
params(
|
2486
|
-
|
3014
|
+
params(
|
3015
|
+
amount: String,
|
3016
|
+
tax_rate_description: String,
|
3017
|
+
tax_rate_percentage: T.nilable(String)
|
3018
|
+
).returns(T.attached_class)
|
2487
3019
|
end
|
2488
3020
|
def self.new(
|
2489
3021
|
# The amount of additional tax incurred by this tax rate.
|
@@ -2492,7 +3024,9 @@ module Orb
|
|
2492
3024
|
tax_rate_description:,
|
2493
3025
|
# The tax rate percentage, out of 100.
|
2494
3026
|
tax_rate_percentage:
|
2495
|
-
)
|
3027
|
+
)
|
3028
|
+
end
|
3029
|
+
|
2496
3030
|
sig do
|
2497
3031
|
override.returns(
|
2498
3032
|
{
|
@@ -2502,11 +3036,15 @@ module Orb
|
|
2502
3036
|
}
|
2503
3037
|
)
|
2504
3038
|
end
|
2505
|
-
def to_hash
|
3039
|
+
def to_hash
|
3040
|
+
end
|
2506
3041
|
end
|
2507
3042
|
end
|
2508
3043
|
|
2509
3044
|
class Maximum < Orb::Internal::Type::BaseModel
|
3045
|
+
OrHash =
|
3046
|
+
T.type_alias { T.any(Orb::Invoice::Maximum, Orb::Internal::AnyHash) }
|
3047
|
+
|
2510
3048
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2511
3049
|
# maximums, this can be a subset of prices.
|
2512
3050
|
sig { returns(T::Array[String]) }
|
@@ -2517,7 +3055,10 @@ module Orb
|
|
2517
3055
|
attr_accessor :maximum_amount
|
2518
3056
|
|
2519
3057
|
sig do
|
2520
|
-
params(
|
3058
|
+
params(
|
3059
|
+
applies_to_price_ids: T::Array[String],
|
3060
|
+
maximum_amount: String
|
3061
|
+
).returns(T.attached_class)
|
2521
3062
|
end
|
2522
3063
|
def self.new(
|
2523
3064
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -2525,12 +3066,22 @@ module Orb
|
|
2525
3066
|
applies_to_price_ids:,
|
2526
3067
|
# Maximum amount applied
|
2527
3068
|
maximum_amount:
|
2528
|
-
)
|
2529
|
-
|
2530
|
-
|
3069
|
+
)
|
3070
|
+
end
|
3071
|
+
|
3072
|
+
sig do
|
3073
|
+
override.returns(
|
3074
|
+
{ applies_to_price_ids: T::Array[String], maximum_amount: String }
|
3075
|
+
)
|
3076
|
+
end
|
3077
|
+
def to_hash
|
3078
|
+
end
|
2531
3079
|
end
|
2532
3080
|
|
2533
3081
|
class Minimum < Orb::Internal::Type::BaseModel
|
3082
|
+
OrHash =
|
3083
|
+
T.type_alias { T.any(Orb::Invoice::Minimum, Orb::Internal::AnyHash) }
|
3084
|
+
|
2534
3085
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2535
3086
|
# minimums, this can be a subset of prices.
|
2536
3087
|
sig { returns(T::Array[String]) }
|
@@ -2541,7 +3092,10 @@ module Orb
|
|
2541
3092
|
attr_accessor :minimum_amount
|
2542
3093
|
|
2543
3094
|
sig do
|
2544
|
-
params(
|
3095
|
+
params(
|
3096
|
+
applies_to_price_ids: T::Array[String],
|
3097
|
+
minimum_amount: String
|
3098
|
+
).returns(T.attached_class)
|
2545
3099
|
end
|
2546
3100
|
def self.new(
|
2547
3101
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -2549,12 +3103,24 @@ module Orb
|
|
2549
3103
|
applies_to_price_ids:,
|
2550
3104
|
# Minimum amount applied
|
2551
3105
|
minimum_amount:
|
2552
|
-
)
|
2553
|
-
|
2554
|
-
|
3106
|
+
)
|
3107
|
+
end
|
3108
|
+
|
3109
|
+
sig do
|
3110
|
+
override.returns(
|
3111
|
+
{ applies_to_price_ids: T::Array[String], minimum_amount: String }
|
3112
|
+
)
|
3113
|
+
end
|
3114
|
+
def to_hash
|
3115
|
+
end
|
2555
3116
|
end
|
2556
3117
|
|
2557
3118
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
3119
|
+
OrHash =
|
3120
|
+
T.type_alias do
|
3121
|
+
T.any(Orb::Invoice::PaymentAttempt, Orb::Internal::AnyHash)
|
3122
|
+
end
|
3123
|
+
|
2558
3124
|
# The ID of the payment attempt.
|
2559
3125
|
sig { returns(String) }
|
2560
3126
|
attr_accessor :id
|
@@ -2568,7 +3134,13 @@ module Orb
|
|
2568
3134
|
attr_accessor :created_at
|
2569
3135
|
|
2570
3136
|
# The payment provider that attempted to collect the payment.
|
2571
|
-
sig
|
3137
|
+
sig do
|
3138
|
+
returns(
|
3139
|
+
T.nilable(
|
3140
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3141
|
+
)
|
3142
|
+
)
|
3143
|
+
end
|
2572
3144
|
attr_accessor :payment_provider
|
2573
3145
|
|
2574
3146
|
# The ID of the payment attempt in the payment provider.
|
@@ -2584,11 +3156,13 @@ module Orb
|
|
2584
3156
|
id: String,
|
2585
3157
|
amount: String,
|
2586
3158
|
created_at: Time,
|
2587
|
-
payment_provider:
|
3159
|
+
payment_provider:
|
3160
|
+
T.nilable(
|
3161
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::OrSymbol
|
3162
|
+
),
|
2588
3163
|
payment_provider_id: T.nilable(String),
|
2589
3164
|
succeeded: T::Boolean
|
2590
|
-
)
|
2591
|
-
.returns(T.attached_class)
|
3165
|
+
).returns(T.attached_class)
|
2592
3166
|
end
|
2593
3167
|
def self.new(
|
2594
3168
|
# The ID of the payment attempt.
|
@@ -2603,37 +3177,61 @@ module Orb
|
|
2603
3177
|
payment_provider_id:,
|
2604
3178
|
# Whether the payment attempt succeeded.
|
2605
3179
|
succeeded:
|
2606
|
-
)
|
3180
|
+
)
|
3181
|
+
end
|
3182
|
+
|
2607
3183
|
sig do
|
2608
|
-
override
|
2609
|
-
|
2610
|
-
|
2611
|
-
|
2612
|
-
|
2613
|
-
|
2614
|
-
|
2615
|
-
|
2616
|
-
|
2617
|
-
|
2618
|
-
|
3184
|
+
override.returns(
|
3185
|
+
{
|
3186
|
+
id: String,
|
3187
|
+
amount: String,
|
3188
|
+
created_at: Time,
|
3189
|
+
payment_provider:
|
3190
|
+
T.nilable(
|
3191
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3192
|
+
),
|
3193
|
+
payment_provider_id: T.nilable(String),
|
3194
|
+
succeeded: T::Boolean
|
3195
|
+
}
|
3196
|
+
)
|
3197
|
+
end
|
3198
|
+
def to_hash
|
2619
3199
|
end
|
2620
|
-
def to_hash; end
|
2621
3200
|
|
2622
3201
|
# The payment provider that attempted to collect the payment.
|
2623
3202
|
module PaymentProvider
|
2624
3203
|
extend Orb::Internal::Type::Enum
|
2625
3204
|
|
2626
|
-
TaggedSymbol =
|
3205
|
+
TaggedSymbol =
|
3206
|
+
T.type_alias do
|
3207
|
+
T.all(Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider)
|
3208
|
+
end
|
2627
3209
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2628
3210
|
|
2629
|
-
STRIPE =
|
3211
|
+
STRIPE =
|
3212
|
+
T.let(
|
3213
|
+
:stripe,
|
3214
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3215
|
+
)
|
2630
3216
|
|
2631
|
-
sig
|
2632
|
-
|
3217
|
+
sig do
|
3218
|
+
override.returns(
|
3219
|
+
T::Array[
|
3220
|
+
Orb::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
|
3221
|
+
]
|
3222
|
+
)
|
3223
|
+
end
|
3224
|
+
def self.values
|
3225
|
+
end
|
2633
3226
|
end
|
2634
3227
|
end
|
2635
3228
|
|
2636
3229
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
3230
|
+
OrHash =
|
3231
|
+
T.type_alias do
|
3232
|
+
T.any(Orb::Invoice::ShippingAddress, Orb::Internal::AnyHash)
|
3233
|
+
end
|
3234
|
+
|
2637
3235
|
sig { returns(T.nilable(String)) }
|
2638
3236
|
attr_accessor :city
|
2639
3237
|
|
@@ -2660,52 +3258,60 @@ module Orb
|
|
2660
3258
|
line2: T.nilable(String),
|
2661
3259
|
postal_code: T.nilable(String),
|
2662
3260
|
state: T.nilable(String)
|
2663
|
-
)
|
2664
|
-
|
3261
|
+
).returns(T.attached_class)
|
3262
|
+
end
|
3263
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
2665
3264
|
end
|
2666
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
2667
3265
|
|
2668
3266
|
sig do
|
2669
|
-
override
|
2670
|
-
|
2671
|
-
|
2672
|
-
|
2673
|
-
|
2674
|
-
|
2675
|
-
|
2676
|
-
|
2677
|
-
|
2678
|
-
|
2679
|
-
|
3267
|
+
override.returns(
|
3268
|
+
{
|
3269
|
+
city: T.nilable(String),
|
3270
|
+
country: T.nilable(String),
|
3271
|
+
line1: T.nilable(String),
|
3272
|
+
line2: T.nilable(String),
|
3273
|
+
postal_code: T.nilable(String),
|
3274
|
+
state: T.nilable(String)
|
3275
|
+
}
|
3276
|
+
)
|
3277
|
+
end
|
3278
|
+
def to_hash
|
2680
3279
|
end
|
2681
|
-
def to_hash; end
|
2682
3280
|
end
|
2683
3281
|
|
2684
3282
|
module Status
|
2685
3283
|
extend Orb::Internal::Type::Enum
|
2686
3284
|
|
2687
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
3285
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Invoice::Status) }
|
2688
3286
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2689
3287
|
|
2690
|
-
ISSUED = T.let(:issued, Orb::
|
2691
|
-
PAID = T.let(:paid, Orb::
|
2692
|
-
SYNCED = T.let(:synced, Orb::
|
2693
|
-
VOID = T.let(:void, Orb::
|
2694
|
-
DRAFT = T.let(:draft, Orb::
|
3288
|
+
ISSUED = T.let(:issued, Orb::Invoice::Status::TaggedSymbol)
|
3289
|
+
PAID = T.let(:paid, Orb::Invoice::Status::TaggedSymbol)
|
3290
|
+
SYNCED = T.let(:synced, Orb::Invoice::Status::TaggedSymbol)
|
3291
|
+
VOID = T.let(:void, Orb::Invoice::Status::TaggedSymbol)
|
3292
|
+
DRAFT = T.let(:draft, Orb::Invoice::Status::TaggedSymbol)
|
2695
3293
|
|
2696
|
-
sig { override.returns(T::Array[Orb::
|
2697
|
-
def self.values
|
3294
|
+
sig { override.returns(T::Array[Orb::Invoice::Status::TaggedSymbol]) }
|
3295
|
+
def self.values
|
3296
|
+
end
|
2698
3297
|
end
|
2699
3298
|
|
2700
3299
|
class Subscription < Orb::Internal::Type::BaseModel
|
3300
|
+
OrHash =
|
3301
|
+
T.type_alias do
|
3302
|
+
T.any(Orb::Invoice::Subscription, Orb::Internal::AnyHash)
|
3303
|
+
end
|
3304
|
+
|
2701
3305
|
sig { returns(String) }
|
2702
3306
|
attr_accessor :id
|
2703
3307
|
|
2704
3308
|
sig { params(id: String).returns(T.attached_class) }
|
2705
|
-
def self.new(id:)
|
3309
|
+
def self.new(id:)
|
3310
|
+
end
|
2706
3311
|
|
2707
|
-
sig { override.returns({id: String}) }
|
2708
|
-
def to_hash
|
3312
|
+
sig { override.returns({ id: String }) }
|
3313
|
+
def to_hash
|
3314
|
+
end
|
2709
3315
|
end
|
2710
3316
|
end
|
2711
3317
|
end
|