orb-billing 0.3.2 → 0.5.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 +39 -0
- data/README.md +95 -55
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +70 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +1 -0
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/union.rb +1 -0
- data/lib/orb/internal/util.rb +56 -0
- data/lib/orb/internal.rb +6 -0
- data/lib/orb/models/coupon.rb +4 -0
- data/lib/orb/models/coupon_create_params.rb +6 -0
- data/lib/orb/models/customer_create_params.rb +9 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +9 -0
- data/lib/orb/models/customer_update_params.rb +9 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -0
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -0
- data/lib/orb/models/discount.rb +6 -0
- data/lib/orb/models/evaluate_price_group.rb +4 -0
- data/lib/orb/models/invoice.rb +22 -0
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +22 -0
- data/lib/orb/models/invoice_level_discount.rb +4 -0
- data/lib/orb/models/invoice_line_item_create_response.rb +22 -0
- data/lib/orb/models/plan.rb +12 -0
- data/lib/orb/models/plan_create_params.rb +32 -0
- data/lib/orb/models/price.rb +35 -0
- data/lib/orb/models/subscription.rb +22 -0
- data/lib/orb/models/subscription_cancel_response.rb +22 -0
- data/lib/orb/models/subscription_change_apply_response.rb +22 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +22 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +22 -0
- data/lib/orb/models/subscription_create_params.rb +88 -0
- data/lib/orb/models/subscription_create_response.rb +22 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +89 -0
- data/lib/orb/models/subscription_price_intervals_response.rb +22 -0
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +88 -0
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +22 -0
- data/lib/orb/models/subscription_trigger_phase_response.rb +22 -0
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +22 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +22 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +22 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +22 -0
- data/lib/orb/models/subscription_update_trial_params.rb +4 -0
- data/lib/orb/models/subscription_update_trial_response.rb +22 -0
- data/lib/orb/models/subscription_usage.rb +9 -0
- data/lib/orb/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -0
- data/rbi/orb/internal/page.rbi +2 -1
- data/rbi/orb/internal/transport/base_client.rbi +31 -8
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +10 -5
- data/rbi/orb/internal/type/base_model.rbi +31 -15
- data/rbi/orb/internal/type/base_page.rbi +1 -1
- data/rbi/orb/internal/type/converter.rbi +2 -0
- data/rbi/orb/internal/type/enum.rbi +1 -0
- data/rbi/orb/internal/type/union.rbi +1 -0
- data/rbi/orb/internal/util.rbi +28 -7
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +13 -6
- data/rbi/orb/models/alert_create_for_customer_params.rbi +11 -2
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +14 -2
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +11 -2
- data/rbi/orb/models/alert_disable_params.rbi +2 -1
- data/rbi/orb/models/alert_enable_params.rbi +2 -1
- data/rbi/orb/models/alert_list_params.rbi +2 -1
- data/rbi/orb/models/alert_retrieve_params.rbi +2 -1
- data/rbi/orb/models/alert_update_params.rbi +6 -2
- data/rbi/orb/models/amount_discount.rbi +2 -1
- data/rbi/orb/models/billable_metric.rbi +2 -1
- data/rbi/orb/models/coupon.rbi +1 -1
- data/rbi/orb/models/coupon_archive_params.rbi +2 -1
- data/rbi/orb/models/coupon_create_params.rbi +16 -3
- data/rbi/orb/models/coupon_fetch_params.rbi +2 -1
- data/rbi/orb/models/coupon_list_params.rbi +2 -1
- data/rbi/orb/models/coupons/subscription_list_params.rbi +4 -1
- data/rbi/orb/models/credit_note.rbi +45 -9
- data/rbi/orb/models/credit_note_create_params.rbi +8 -2
- data/rbi/orb/models/credit_note_fetch_params.rbi +4 -1
- data/rbi/orb/models/credit_note_list_params.rbi +4 -1
- data/rbi/orb/models/customer.rbi +41 -10
- data/rbi/orb/models/customer_create_params.rbi +61 -10
- data/rbi/orb/models/customer_delete_params.rbi +4 -1
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +4 -1
- data/rbi/orb/models/customer_fetch_params.rbi +2 -1
- data/rbi/orb/models/customer_list_params.rbi +2 -1
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +7 -1
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +7 -1
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +67 -10
- data/rbi/orb/models/customer_update_params.rbi +61 -10
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +7 -1
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +21 -3
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +7 -1
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +21 -3
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +7 -1
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +21 -3
- data/rbi/orb/models/customers/cost_list_params.rbi +4 -1
- data/rbi/orb/models/customers/cost_list_response.rbi +21 -3
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +7 -1
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +7 -1
- data/rbi/orb/models/customers/credit_list_params.rbi +4 -1
- data/rbi/orb/models/customers/credit_list_response.rbi +7 -1
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +14 -2
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +133 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +14 -2
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +133 -21
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +7 -1
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +133 -21
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +7 -1
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +133 -21
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +14 -2
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +14 -2
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +14 -2
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +14 -2
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +7 -1
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +7 -1
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +7 -1
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +14 -2
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +7 -1
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +14 -2
- data/rbi/orb/models/dimensional_price_group.rbi +4 -1
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +4 -1
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +4 -1
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +7 -1
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +7 -1
- data/rbi/orb/models/dimensional_price_groups.rbi +4 -1
- data/rbi/orb/models/evaluate_price_group.rbi +2 -1
- data/rbi/orb/models/event_deprecate_params.rbi +4 -1
- data/rbi/orb/models/event_deprecate_response.rbi +4 -1
- data/rbi/orb/models/event_ingest_params.rbi +6 -2
- data/rbi/orb/models/event_ingest_response.rbi +18 -3
- data/rbi/orb/models/event_search_params.rbi +2 -1
- data/rbi/orb/models/event_search_response.rbi +11 -2
- data/rbi/orb/models/event_update_params.rbi +2 -1
- data/rbi/orb/models/event_update_response.rbi +4 -1
- data/rbi/orb/models/events/backfill_close_params.rbi +4 -1
- data/rbi/orb/models/events/backfill_close_response.rbi +7 -1
- data/rbi/orb/models/events/backfill_create_params.rbi +4 -1
- data/rbi/orb/models/events/backfill_create_response.rbi +7 -1
- data/rbi/orb/models/events/backfill_fetch_params.rbi +4 -1
- data/rbi/orb/models/events/backfill_fetch_response.rbi +7 -1
- data/rbi/orb/models/events/backfill_list_params.rbi +4 -1
- data/rbi/orb/models/events/backfill_list_response.rbi +7 -1
- data/rbi/orb/models/events/backfill_revert_params.rbi +4 -1
- data/rbi/orb/models/events/backfill_revert_response.rbi +7 -1
- data/rbi/orb/models/events/event_volumes.rbi +8 -2
- data/rbi/orb/models/events/volume_list_params.rbi +4 -1
- data/rbi/orb/models/invoice.rbi +156 -31
- data/rbi/orb/models/invoice_create_params.rbi +13 -3
- data/rbi/orb/models/invoice_fetch_params.rbi +2 -1
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +4 -1
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +212 -31
- data/rbi/orb/models/invoice_issue_params.rbi +2 -1
- data/rbi/orb/models/invoice_line_item_create_params.rbi +4 -1
- data/rbi/orb/models/invoice_line_item_create_response.rbi +119 -17
- data/rbi/orb/models/invoice_list_params.rbi +2 -1
- data/rbi/orb/models/invoice_mark_paid_params.rbi +4 -1
- data/rbi/orb/models/invoice_pay_params.rbi +2 -1
- data/rbi/orb/models/invoice_update_params.rbi +2 -1
- data/rbi/orb/models/invoice_void_params.rbi +2 -1
- data/rbi/orb/models/item.rbi +5 -2
- data/rbi/orb/models/item_create_params.rbi +2 -1
- data/rbi/orb/models/item_fetch_params.rbi +2 -1
- data/rbi/orb/models/item_list_params.rbi +2 -1
- data/rbi/orb/models/item_update_params.rbi +9 -2
- data/rbi/orb/models/metric_create_params.rbi +2 -1
- data/rbi/orb/models/metric_fetch_params.rbi +2 -1
- data/rbi/orb/models/metric_list_params.rbi +2 -1
- data/rbi/orb/models/metric_update_params.rbi +2 -1
- data/rbi/orb/models/pagination_metadata.rbi +2 -1
- data/rbi/orb/models/percentage_discount.rbi +2 -1
- data/rbi/orb/models/plan.rbi +50 -14
- data/rbi/orb/models/plan_create_params.rbi +604 -89
- data/rbi/orb/models/plan_fetch_params.rbi +2 -1
- data/rbi/orb/models/plan_list_params.rbi +2 -1
- data/rbi/orb/models/plan_update_params.rbi +2 -1
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +4 -1
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +7 -1
- data/rbi/orb/models/price.rbi +1624 -270
- data/rbi/orb/models/price_create_params.rbi +100 -18
- data/rbi/orb/models/price_evaluate_params.rbi +2 -1
- data/rbi/orb/models/price_evaluate_response.rbi +4 -1
- data/rbi/orb/models/price_fetch_params.rbi +2 -1
- data/rbi/orb/models/price_list_params.rbi +2 -1
- data/rbi/orb/models/price_update_params.rbi +2 -1
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +7 -1
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +7 -1
- data/rbi/orb/models/subscription.rbi +109 -19
- data/rbi/orb/models/subscription_cancel_params.rbi +4 -1
- data/rbi/orb/models/subscription_cancel_response.rbi +137 -20
- data/rbi/orb/models/subscription_change_apply_params.rbi +4 -1
- data/rbi/orb/models/subscription_change_apply_response.rbi +142 -21
- data/rbi/orb/models/subscription_change_cancel_params.rbi +4 -1
- data/rbi/orb/models/subscription_change_cancel_response.rbi +142 -21
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +4 -1
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +142 -21
- data/rbi/orb/models/subscription_create_params.rbi +1257 -198
- data/rbi/orb/models/subscription_create_response.rbi +137 -20
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +4 -1
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +21 -3
- data/rbi/orb/models/subscription_fetch_params.rbi +4 -1
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +4 -1
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +14 -2
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +4 -1
- data/rbi/orb/models/subscription_list_params.rbi +4 -1
- data/rbi/orb/models/subscription_price_intervals_params.rbi +731 -115
- data/rbi/orb/models/subscription_price_intervals_response.rbi +140 -20
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +1260 -198
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +140 -20
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +4 -1
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +140 -20
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +7 -1
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +140 -20
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +7 -1
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +140 -20
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +7 -1
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +140 -20
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +7 -1
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +140 -20
- data/rbi/orb/models/subscription_update_params.rbi +4 -1
- data/rbi/orb/models/subscription_update_trial_params.rbi +4 -1
- data/rbi/orb/models/subscription_update_trial_response.rbi +140 -20
- data/rbi/orb/models/subscription_usage.rbi +63 -9
- data/rbi/orb/models/subscriptions.rbi +2 -1
- data/rbi/orb/models/top_level_ping_params.rbi +2 -1
- data/rbi/orb/models/top_level_ping_response.rbi +4 -1
- data/rbi/orb/models/trial_discount.rbi +2 -1
- data/rbi/orb/models/usage_discount.rbi +2 -1
- data/rbi/orb/request_options.rbi +1 -1
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +4 -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/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- metadata +2 -2
data/rbi/orb/models/invoice.rbi
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class Invoice < Orb::Internal::Type::BaseModel
|
6
|
-
OrHash = T.type_alias { T.any(
|
6
|
+
OrHash = T.type_alias { T.any(Orb::Invoice, Orb::Internal::AnyHash) }
|
7
7
|
|
8
8
|
sig { returns(String) }
|
9
9
|
attr_accessor :id
|
@@ -646,7 +646,10 @@ module Orb
|
|
646
646
|
end
|
647
647
|
|
648
648
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
649
|
-
OrHash =
|
649
|
+
OrHash =
|
650
|
+
T.type_alias do
|
651
|
+
T.any(Orb::Invoice::AutoCollection, Orb::Internal::AnyHash)
|
652
|
+
end
|
650
653
|
|
651
654
|
# True only if auto-collection is enabled for this invoice.
|
652
655
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -713,7 +716,10 @@ module Orb
|
|
713
716
|
end
|
714
717
|
|
715
718
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
716
|
-
OrHash =
|
719
|
+
OrHash =
|
720
|
+
T.type_alias do
|
721
|
+
T.any(Orb::Invoice::BillingAddress, Orb::Internal::AnyHash)
|
722
|
+
end
|
717
723
|
|
718
724
|
sig { returns(T.nilable(String)) }
|
719
725
|
attr_accessor :city
|
@@ -763,7 +769,10 @@ module Orb
|
|
763
769
|
end
|
764
770
|
|
765
771
|
class CreditNote < Orb::Internal::Type::BaseModel
|
766
|
-
OrHash =
|
772
|
+
OrHash =
|
773
|
+
T.type_alias do
|
774
|
+
T.any(Orb::Invoice::CreditNote, Orb::Internal::AnyHash)
|
775
|
+
end
|
767
776
|
|
768
777
|
sig { returns(String) }
|
769
778
|
attr_accessor :id
|
@@ -832,7 +841,8 @@ module Orb
|
|
832
841
|
end
|
833
842
|
|
834
843
|
class Customer < Orb::Internal::Type::BaseModel
|
835
|
-
OrHash =
|
844
|
+
OrHash =
|
845
|
+
T.type_alias { T.any(Orb::Invoice::Customer, Orb::Internal::AnyHash) }
|
836
846
|
|
837
847
|
sig { returns(String) }
|
838
848
|
attr_accessor :id
|
@@ -858,7 +868,13 @@ module Orb
|
|
858
868
|
end
|
859
869
|
|
860
870
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
861
|
-
OrHash =
|
871
|
+
OrHash =
|
872
|
+
T.type_alias do
|
873
|
+
T.any(
|
874
|
+
Orb::Invoice::CustomerBalanceTransaction,
|
875
|
+
Orb::Internal::AnyHash
|
876
|
+
)
|
877
|
+
end
|
862
878
|
|
863
879
|
# A unique id for this transaction.
|
864
880
|
sig { returns(String) }
|
@@ -1061,7 +1077,13 @@ module Orb
|
|
1061
1077
|
end
|
1062
1078
|
|
1063
1079
|
class CreditNote < Orb::Internal::Type::BaseModel
|
1064
|
-
OrHash =
|
1080
|
+
OrHash =
|
1081
|
+
T.type_alias do
|
1082
|
+
T.any(
|
1083
|
+
Orb::Invoice::CustomerBalanceTransaction::CreditNote,
|
1084
|
+
Orb::Internal::AnyHash
|
1085
|
+
)
|
1086
|
+
end
|
1065
1087
|
|
1066
1088
|
# The id of the Credit note
|
1067
1089
|
sig { returns(String) }
|
@@ -1080,7 +1102,13 @@ module Orb
|
|
1080
1102
|
end
|
1081
1103
|
|
1082
1104
|
class Invoice < Orb::Internal::Type::BaseModel
|
1083
|
-
OrHash =
|
1105
|
+
OrHash =
|
1106
|
+
T.type_alias do
|
1107
|
+
T.any(
|
1108
|
+
Orb::Invoice::CustomerBalanceTransaction::Invoice,
|
1109
|
+
Orb::Internal::AnyHash
|
1110
|
+
)
|
1111
|
+
end
|
1084
1112
|
|
1085
1113
|
# The Invoice id
|
1086
1114
|
sig { returns(String) }
|
@@ -1131,7 +1159,10 @@ module Orb
|
|
1131
1159
|
end
|
1132
1160
|
|
1133
1161
|
class CustomerTaxID < Orb::Internal::Type::BaseModel
|
1134
|
-
OrHash =
|
1162
|
+
OrHash =
|
1163
|
+
T.type_alias do
|
1164
|
+
T.any(Orb::Invoice::CustomerTaxID, Orb::Internal::AnyHash)
|
1165
|
+
end
|
1135
1166
|
|
1136
1167
|
sig { returns(Orb::Invoice::CustomerTaxID::Country::TaggedSymbol) }
|
1137
1168
|
attr_accessor :country
|
@@ -1540,7 +1571,8 @@ module Orb
|
|
1540
1571
|
end
|
1541
1572
|
|
1542
1573
|
class LineItem < Orb::Internal::Type::BaseModel
|
1543
|
-
OrHash =
|
1574
|
+
OrHash =
|
1575
|
+
T.type_alias { T.any(Orb::Invoice::LineItem, Orb::Internal::AnyHash) }
|
1544
1576
|
|
1545
1577
|
# A unique ID for this line item.
|
1546
1578
|
sig { returns(String) }
|
@@ -1976,7 +2008,13 @@ module Orb
|
|
1976
2008
|
end
|
1977
2009
|
|
1978
2010
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
1979
|
-
OrHash =
|
2011
|
+
OrHash =
|
2012
|
+
T.type_alias do
|
2013
|
+
T.any(
|
2014
|
+
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
2015
|
+
Orb::Internal::AnyHash
|
2016
|
+
)
|
2017
|
+
end
|
1980
2018
|
|
1981
2019
|
sig { returns(String) }
|
1982
2020
|
attr_accessor :id
|
@@ -2053,7 +2091,13 @@ module Orb
|
|
2053
2091
|
end
|
2054
2092
|
|
2055
2093
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
2056
|
-
OrHash =
|
2094
|
+
OrHash =
|
2095
|
+
T.type_alias do
|
2096
|
+
T.any(
|
2097
|
+
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
2098
|
+
Orb::Internal::AnyHash
|
2099
|
+
)
|
2100
|
+
end
|
2057
2101
|
|
2058
2102
|
sig { returns(String) }
|
2059
2103
|
attr_accessor :id
|
@@ -2130,7 +2174,13 @@ module Orb
|
|
2130
2174
|
end
|
2131
2175
|
|
2132
2176
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
2133
|
-
OrHash =
|
2177
|
+
OrHash =
|
2178
|
+
T.type_alias do
|
2179
|
+
T.any(
|
2180
|
+
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
2181
|
+
Orb::Internal::AnyHash
|
2182
|
+
)
|
2183
|
+
end
|
2134
2184
|
|
2135
2185
|
sig { returns(String) }
|
2136
2186
|
attr_accessor :id
|
@@ -2207,7 +2257,13 @@ module Orb
|
|
2207
2257
|
end
|
2208
2258
|
|
2209
2259
|
class Minimum < Orb::Internal::Type::BaseModel
|
2210
|
-
OrHash =
|
2260
|
+
OrHash =
|
2261
|
+
T.type_alias do
|
2262
|
+
T.any(
|
2263
|
+
Orb::Invoice::LineItem::Adjustment::Minimum,
|
2264
|
+
Orb::Internal::AnyHash
|
2265
|
+
)
|
2266
|
+
end
|
2211
2267
|
|
2212
2268
|
sig { returns(String) }
|
2213
2269
|
attr_accessor :id
|
@@ -2292,7 +2348,13 @@ module Orb
|
|
2292
2348
|
end
|
2293
2349
|
|
2294
2350
|
class Maximum < Orb::Internal::Type::BaseModel
|
2295
|
-
OrHash =
|
2351
|
+
OrHash =
|
2352
|
+
T.type_alias do
|
2353
|
+
T.any(
|
2354
|
+
Orb::Invoice::LineItem::Adjustment::Maximum,
|
2355
|
+
Orb::Internal::AnyHash
|
2356
|
+
)
|
2357
|
+
end
|
2296
2358
|
|
2297
2359
|
sig { returns(String) }
|
2298
2360
|
attr_accessor :id
|
@@ -2378,7 +2440,10 @@ module Orb
|
|
2378
2440
|
end
|
2379
2441
|
|
2380
2442
|
class Maximum < Orb::Internal::Type::BaseModel
|
2381
|
-
OrHash =
|
2443
|
+
OrHash =
|
2444
|
+
T.type_alias do
|
2445
|
+
T.any(Orb::Invoice::LineItem::Maximum, Orb::Internal::AnyHash)
|
2446
|
+
end
|
2382
2447
|
|
2383
2448
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2384
2449
|
# maximums, this can be a subset of prices.
|
@@ -2415,7 +2480,10 @@ module Orb
|
|
2415
2480
|
end
|
2416
2481
|
|
2417
2482
|
class Minimum < Orb::Internal::Type::BaseModel
|
2418
|
-
OrHash =
|
2483
|
+
OrHash =
|
2484
|
+
T.type_alias do
|
2485
|
+
T.any(Orb::Invoice::LineItem::Minimum, Orb::Internal::AnyHash)
|
2486
|
+
end
|
2419
2487
|
|
2420
2488
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2421
2489
|
# minimums, this can be a subset of prices.
|
@@ -2464,7 +2532,13 @@ module Orb
|
|
2464
2532
|
end
|
2465
2533
|
|
2466
2534
|
class Matrix < Orb::Internal::Type::BaseModel
|
2467
|
-
OrHash =
|
2535
|
+
OrHash =
|
2536
|
+
T.type_alias do
|
2537
|
+
T.any(
|
2538
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
2539
|
+
Orb::Internal::AnyHash
|
2540
|
+
)
|
2541
|
+
end
|
2468
2542
|
|
2469
2543
|
# The total amount for this sub line item.
|
2470
2544
|
sig { returns(String) }
|
@@ -2555,7 +2629,12 @@ module Orb
|
|
2555
2629
|
|
2556
2630
|
class Grouping < Orb::Internal::Type::BaseModel
|
2557
2631
|
OrHash =
|
2558
|
-
T.type_alias
|
2632
|
+
T.type_alias do
|
2633
|
+
T.any(
|
2634
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping,
|
2635
|
+
Orb::Internal::AnyHash
|
2636
|
+
)
|
2637
|
+
end
|
2559
2638
|
|
2560
2639
|
sig { returns(String) }
|
2561
2640
|
attr_accessor :key
|
@@ -2585,7 +2664,12 @@ module Orb
|
|
2585
2664
|
|
2586
2665
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
2587
2666
|
OrHash =
|
2588
|
-
T.type_alias
|
2667
|
+
T.type_alias do
|
2668
|
+
T.any(
|
2669
|
+
Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig,
|
2670
|
+
Orb::Internal::AnyHash
|
2671
|
+
)
|
2672
|
+
end
|
2589
2673
|
|
2590
2674
|
# The ordered dimension values for this line item.
|
2591
2675
|
sig { returns(T::Array[T.nilable(String)]) }
|
@@ -2613,7 +2697,13 @@ module Orb
|
|
2613
2697
|
end
|
2614
2698
|
|
2615
2699
|
class Tier < Orb::Internal::Type::BaseModel
|
2616
|
-
OrHash =
|
2700
|
+
OrHash =
|
2701
|
+
T.type_alias do
|
2702
|
+
T.any(
|
2703
|
+
Orb::Invoice::LineItem::SubLineItem::Tier,
|
2704
|
+
Orb::Internal::AnyHash
|
2705
|
+
)
|
2706
|
+
end
|
2617
2707
|
|
2618
2708
|
# The total amount for this sub line item.
|
2619
2709
|
sig { returns(String) }
|
@@ -2704,7 +2794,12 @@ module Orb
|
|
2704
2794
|
|
2705
2795
|
class Grouping < Orb::Internal::Type::BaseModel
|
2706
2796
|
OrHash =
|
2707
|
-
T.type_alias
|
2797
|
+
T.type_alias do
|
2798
|
+
T.any(
|
2799
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::Grouping,
|
2800
|
+
Orb::Internal::AnyHash
|
2801
|
+
)
|
2802
|
+
end
|
2708
2803
|
|
2709
2804
|
sig { returns(String) }
|
2710
2805
|
attr_accessor :key
|
@@ -2734,7 +2829,12 @@ module Orb
|
|
2734
2829
|
|
2735
2830
|
class TierConfig < Orb::Internal::Type::BaseModel
|
2736
2831
|
OrHash =
|
2737
|
-
T.type_alias
|
2832
|
+
T.type_alias do
|
2833
|
+
T.any(
|
2834
|
+
Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig,
|
2835
|
+
Orb::Internal::AnyHash
|
2836
|
+
)
|
2837
|
+
end
|
2738
2838
|
|
2739
2839
|
sig { returns(Float) }
|
2740
2840
|
attr_accessor :first_unit
|
@@ -2770,7 +2870,13 @@ module Orb
|
|
2770
2870
|
end
|
2771
2871
|
|
2772
2872
|
class Null < Orb::Internal::Type::BaseModel
|
2773
|
-
OrHash =
|
2873
|
+
OrHash =
|
2874
|
+
T.type_alias do
|
2875
|
+
T.any(
|
2876
|
+
Orb::Invoice::LineItem::SubLineItem::Null,
|
2877
|
+
Orb::Internal::AnyHash
|
2878
|
+
)
|
2879
|
+
end
|
2774
2880
|
|
2775
2881
|
# The total amount for this sub line item.
|
2776
2882
|
sig { returns(String) }
|
@@ -2843,7 +2949,12 @@ module Orb
|
|
2843
2949
|
|
2844
2950
|
class Grouping < Orb::Internal::Type::BaseModel
|
2845
2951
|
OrHash =
|
2846
|
-
T.type_alias
|
2952
|
+
T.type_alias do
|
2953
|
+
T.any(
|
2954
|
+
Orb::Invoice::LineItem::SubLineItem::Null::Grouping,
|
2955
|
+
Orb::Internal::AnyHash
|
2956
|
+
)
|
2957
|
+
end
|
2847
2958
|
|
2848
2959
|
sig { returns(String) }
|
2849
2960
|
attr_accessor :key
|
@@ -2882,7 +2993,10 @@ module Orb
|
|
2882
2993
|
end
|
2883
2994
|
|
2884
2995
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
2885
|
-
OrHash =
|
2996
|
+
OrHash =
|
2997
|
+
T.type_alias do
|
2998
|
+
T.any(Orb::Invoice::LineItem::TaxAmount, Orb::Internal::AnyHash)
|
2999
|
+
end
|
2886
3000
|
|
2887
3001
|
# The amount of additional tax incurred by this tax rate.
|
2888
3002
|
sig { returns(String) }
|
@@ -2928,7 +3042,8 @@ module Orb
|
|
2928
3042
|
end
|
2929
3043
|
|
2930
3044
|
class Maximum < Orb::Internal::Type::BaseModel
|
2931
|
-
OrHash =
|
3045
|
+
OrHash =
|
3046
|
+
T.type_alias { T.any(Orb::Invoice::Maximum, Orb::Internal::AnyHash) }
|
2932
3047
|
|
2933
3048
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
2934
3049
|
# maximums, this can be a subset of prices.
|
@@ -2964,7 +3079,8 @@ module Orb
|
|
2964
3079
|
end
|
2965
3080
|
|
2966
3081
|
class Minimum < Orb::Internal::Type::BaseModel
|
2967
|
-
OrHash =
|
3082
|
+
OrHash =
|
3083
|
+
T.type_alias { T.any(Orb::Invoice::Minimum, Orb::Internal::AnyHash) }
|
2968
3084
|
|
2969
3085
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
2970
3086
|
# minimums, this can be a subset of prices.
|
@@ -3000,7 +3116,10 @@ module Orb
|
|
3000
3116
|
end
|
3001
3117
|
|
3002
3118
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
3003
|
-
OrHash =
|
3119
|
+
OrHash =
|
3120
|
+
T.type_alias do
|
3121
|
+
T.any(Orb::Invoice::PaymentAttempt, Orb::Internal::AnyHash)
|
3122
|
+
end
|
3004
3123
|
|
3005
3124
|
# The ID of the payment attempt.
|
3006
3125
|
sig { returns(String) }
|
@@ -3108,7 +3227,10 @@ module Orb
|
|
3108
3227
|
end
|
3109
3228
|
|
3110
3229
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
3111
|
-
OrHash =
|
3230
|
+
OrHash =
|
3231
|
+
T.type_alias do
|
3232
|
+
T.any(Orb::Invoice::ShippingAddress, Orb::Internal::AnyHash)
|
3233
|
+
end
|
3112
3234
|
|
3113
3235
|
sig { returns(T.nilable(String)) }
|
3114
3236
|
attr_accessor :city
|
@@ -3175,7 +3297,10 @@ module Orb
|
|
3175
3297
|
end
|
3176
3298
|
|
3177
3299
|
class Subscription < Orb::Internal::Type::BaseModel
|
3178
|
-
OrHash =
|
3300
|
+
OrHash =
|
3301
|
+
T.type_alias do
|
3302
|
+
T.any(Orb::Invoice::Subscription, Orb::Internal::AnyHash)
|
3303
|
+
end
|
3179
3304
|
|
3180
3305
|
sig { returns(String) }
|
3181
3306
|
attr_accessor :id
|
@@ -6,7 +6,8 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
-
OrHash =
|
9
|
+
OrHash =
|
10
|
+
T.type_alias { T.any(Orb::InvoiceCreateParams, Orb::Internal::AnyHash) }
|
10
11
|
|
11
12
|
# An ISO 4217 currency string. Must be the same as the customer's currency if it
|
12
13
|
# is set.
|
@@ -159,7 +160,10 @@ module Orb
|
|
159
160
|
end
|
160
161
|
|
161
162
|
class LineItem < Orb::Internal::Type::BaseModel
|
162
|
-
OrHash =
|
163
|
+
OrHash =
|
164
|
+
T.type_alias do
|
165
|
+
T.any(Orb::InvoiceCreateParams::LineItem, Orb::Internal::AnyHash)
|
166
|
+
end
|
163
167
|
|
164
168
|
# A date string to specify the line item's end date in the customer's timezone.
|
165
169
|
sig { returns(Date) }
|
@@ -263,7 +267,13 @@ module Orb
|
|
263
267
|
end
|
264
268
|
|
265
269
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
266
|
-
OrHash =
|
270
|
+
OrHash =
|
271
|
+
T.type_alias do
|
272
|
+
T.any(
|
273
|
+
Orb::InvoiceCreateParams::LineItem::UnitConfig,
|
274
|
+
Orb::Internal::AnyHash
|
275
|
+
)
|
276
|
+
end
|
267
277
|
|
268
278
|
# Rate per unit of usage
|
269
279
|
sig { returns(String) }
|
@@ -6,7 +6,8 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
-
OrHash =
|
9
|
+
OrHash =
|
10
|
+
T.type_alias { T.any(Orb::InvoiceFetchParams, Orb::Internal::AnyHash) }
|
10
11
|
|
11
12
|
sig do
|
12
13
|
params(request_options: Orb::RequestOptions::OrHash).returns(
|
@@ -6,7 +6,10 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
-
OrHash =
|
9
|
+
OrHash =
|
10
|
+
T.type_alias do
|
11
|
+
T.any(Orb::InvoiceFetchUpcomingParams, Orb::Internal::AnyHash)
|
12
|
+
end
|
10
13
|
|
11
14
|
sig { returns(String) }
|
12
15
|
attr_accessor :subscription_id
|