orb-billing 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -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 +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -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 +0 -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 +0 -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 +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -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 +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -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 +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -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 +1671 -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 +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -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 +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -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 +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/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 +1 -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 +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -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 +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -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 +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -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/type/request_parameters.rbs +3 -1
- 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
@@ -3,6 +3,8 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class CreditNote < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
# The Orb id of this credit note.
|
7
9
|
sig { returns(String) }
|
8
10
|
attr_accessor :id
|
@@ -19,10 +21,10 @@ module Orb
|
|
19
21
|
sig { returns(T.nilable(String)) }
|
20
22
|
attr_accessor :credit_note_pdf
|
21
23
|
|
22
|
-
sig { returns(Orb::
|
24
|
+
sig { returns(Orb::CreditNote::Customer) }
|
23
25
|
attr_reader :customer
|
24
26
|
|
25
|
-
sig { params(customer:
|
27
|
+
sig { params(customer: Orb::CreditNote::Customer::OrHash).void }
|
26
28
|
attr_writer :customer
|
27
29
|
|
28
30
|
# The id of the invoice resource that this credit note is applied to.
|
@@ -30,18 +32,18 @@ module Orb
|
|
30
32
|
attr_accessor :invoice_id
|
31
33
|
|
32
34
|
# All of the line items associated with this credit note.
|
33
|
-
sig { returns(T::Array[Orb::
|
35
|
+
sig { returns(T::Array[Orb::CreditNote::LineItem]) }
|
34
36
|
attr_accessor :line_items
|
35
37
|
|
36
38
|
# The maximum amount applied on the original invoice
|
37
|
-
sig { returns(T.nilable(Orb::
|
39
|
+
sig { returns(T.nilable(Orb::CreditNote::MaximumAmountAdjustment)) }
|
38
40
|
attr_reader :maximum_amount_adjustment
|
39
41
|
|
40
42
|
sig do
|
41
43
|
params(
|
42
|
-
maximum_amount_adjustment:
|
43
|
-
|
44
|
-
|
44
|
+
maximum_amount_adjustment:
|
45
|
+
T.nilable(Orb::CreditNote::MaximumAmountAdjustment::OrHash)
|
46
|
+
).void
|
45
47
|
end
|
46
48
|
attr_writer :maximum_amount_adjustment
|
47
49
|
|
@@ -53,7 +55,7 @@ module Orb
|
|
53
55
|
sig { returns(T.nilable(String)) }
|
54
56
|
attr_accessor :minimum_amount_refunded
|
55
57
|
|
56
|
-
sig { returns(T.nilable(Orb::
|
58
|
+
sig { returns(T.nilable(Orb::CreditNote::Reason::TaggedSymbol)) }
|
57
59
|
attr_accessor :reason
|
58
60
|
|
59
61
|
# The total prior to any creditable invoice-level discounts or minimums.
|
@@ -64,7 +66,7 @@ module Orb
|
|
64
66
|
sig { returns(String) }
|
65
67
|
attr_accessor :total
|
66
68
|
|
67
|
-
sig { returns(Orb::
|
69
|
+
sig { returns(Orb::CreditNote::Type::TaggedSymbol) }
|
68
70
|
attr_accessor :type
|
69
71
|
|
70
72
|
# The time at which the credit note was voided in Orb, if applicable.
|
@@ -72,10 +74,12 @@ module Orb
|
|
72
74
|
attr_accessor :voided_at
|
73
75
|
|
74
76
|
# Any discounts applied on the original invoice.
|
75
|
-
sig { returns(T.nilable(T::Array[Orb::
|
77
|
+
sig { returns(T.nilable(T::Array[Orb::CreditNote::Discount])) }
|
76
78
|
attr_reader :discounts
|
77
79
|
|
78
|
-
sig
|
80
|
+
sig do
|
81
|
+
params(discounts: T::Array[Orb::CreditNote::Discount::OrHash]).void
|
82
|
+
end
|
79
83
|
attr_writer :discounts
|
80
84
|
|
81
85
|
# The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
|
@@ -86,20 +90,20 @@ module Orb
|
|
86
90
|
created_at: Time,
|
87
91
|
credit_note_number: String,
|
88
92
|
credit_note_pdf: T.nilable(String),
|
89
|
-
customer:
|
93
|
+
customer: Orb::CreditNote::Customer::OrHash,
|
90
94
|
invoice_id: String,
|
91
|
-
line_items: T::Array[
|
92
|
-
maximum_amount_adjustment:
|
95
|
+
line_items: T::Array[Orb::CreditNote::LineItem::OrHash],
|
96
|
+
maximum_amount_adjustment:
|
97
|
+
T.nilable(Orb::CreditNote::MaximumAmountAdjustment::OrHash),
|
93
98
|
memo: T.nilable(String),
|
94
99
|
minimum_amount_refunded: T.nilable(String),
|
95
|
-
reason: T.nilable(Orb::
|
100
|
+
reason: T.nilable(Orb::CreditNote::Reason::OrSymbol),
|
96
101
|
subtotal: String,
|
97
102
|
total: String,
|
98
|
-
type: Orb::
|
103
|
+
type: Orb::CreditNote::Type::OrSymbol,
|
99
104
|
voided_at: T.nilable(Time),
|
100
|
-
discounts: T::Array[
|
101
|
-
)
|
102
|
-
.returns(T.attached_class)
|
105
|
+
discounts: T::Array[Orb::CreditNote::Discount::OrHash]
|
106
|
+
).returns(T.attached_class)
|
103
107
|
end
|
104
108
|
def self.new(
|
105
109
|
# The Orb id of this credit note.
|
@@ -131,47 +135,64 @@ module Orb
|
|
131
135
|
voided_at:,
|
132
136
|
# Any discounts applied on the original invoice.
|
133
137
|
discounts: nil
|
134
|
-
)
|
138
|
+
)
|
139
|
+
end
|
140
|
+
|
135
141
|
sig do
|
136
|
-
override
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
142
|
+
override.returns(
|
143
|
+
{
|
144
|
+
id: String,
|
145
|
+
created_at: Time,
|
146
|
+
credit_note_number: String,
|
147
|
+
credit_note_pdf: T.nilable(String),
|
148
|
+
customer: Orb::CreditNote::Customer,
|
149
|
+
invoice_id: String,
|
150
|
+
line_items: T::Array[Orb::CreditNote::LineItem],
|
151
|
+
maximum_amount_adjustment:
|
152
|
+
T.nilable(Orb::CreditNote::MaximumAmountAdjustment),
|
153
|
+
memo: T.nilable(String),
|
154
|
+
minimum_amount_refunded: T.nilable(String),
|
155
|
+
reason: T.nilable(Orb::CreditNote::Reason::TaggedSymbol),
|
156
|
+
subtotal: String,
|
157
|
+
total: String,
|
158
|
+
type: Orb::CreditNote::Type::TaggedSymbol,
|
159
|
+
voided_at: T.nilable(Time),
|
160
|
+
discounts: T::Array[Orb::CreditNote::Discount]
|
161
|
+
}
|
162
|
+
)
|
163
|
+
end
|
164
|
+
def to_hash
|
157
165
|
end
|
158
|
-
def to_hash; end
|
159
166
|
|
160
167
|
class Customer < Orb::Internal::Type::BaseModel
|
168
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
169
|
+
|
161
170
|
sig { returns(String) }
|
162
171
|
attr_accessor :id
|
163
172
|
|
164
173
|
sig { returns(T.nilable(String)) }
|
165
174
|
attr_accessor :external_customer_id
|
166
175
|
|
167
|
-
sig
|
168
|
-
|
176
|
+
sig do
|
177
|
+
params(id: String, external_customer_id: T.nilable(String)).returns(
|
178
|
+
T.attached_class
|
179
|
+
)
|
180
|
+
end
|
181
|
+
def self.new(id:, external_customer_id:)
|
182
|
+
end
|
169
183
|
|
170
|
-
sig
|
171
|
-
|
184
|
+
sig do
|
185
|
+
override.returns(
|
186
|
+
{ id: String, external_customer_id: T.nilable(String) }
|
187
|
+
)
|
188
|
+
end
|
189
|
+
def to_hash
|
190
|
+
end
|
172
191
|
end
|
173
192
|
|
174
193
|
class LineItem < Orb::Internal::Type::BaseModel
|
194
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
195
|
+
|
175
196
|
# The Orb id of this resource.
|
176
197
|
sig { returns(String) }
|
177
198
|
attr_accessor :id
|
@@ -197,16 +218,19 @@ module Orb
|
|
197
218
|
attr_accessor :subtotal
|
198
219
|
|
199
220
|
# Any tax amounts applied onto the line item.
|
200
|
-
sig { returns(T::Array[Orb::
|
221
|
+
sig { returns(T::Array[Orb::CreditNote::LineItem::TaxAmount]) }
|
201
222
|
attr_accessor :tax_amounts
|
202
223
|
|
203
224
|
# Any line item discounts from the invoice's line item.
|
204
|
-
sig
|
225
|
+
sig do
|
226
|
+
returns(T.nilable(T::Array[Orb::CreditNote::LineItem::Discount]))
|
227
|
+
end
|
205
228
|
attr_reader :discounts
|
206
229
|
|
207
230
|
sig do
|
208
|
-
params(
|
209
|
-
|
231
|
+
params(
|
232
|
+
discounts: T::Array[Orb::CreditNote::LineItem::Discount::OrHash]
|
233
|
+
).void
|
210
234
|
end
|
211
235
|
attr_writer :discounts
|
212
236
|
|
@@ -218,10 +242,9 @@ module Orb
|
|
218
242
|
name: String,
|
219
243
|
quantity: T.nilable(Float),
|
220
244
|
subtotal: String,
|
221
|
-
tax_amounts: T::Array[
|
222
|
-
discounts: T::Array[
|
223
|
-
)
|
224
|
-
.returns(T.attached_class)
|
245
|
+
tax_amounts: T::Array[Orb::CreditNote::LineItem::TaxAmount::OrHash],
|
246
|
+
discounts: T::Array[Orb::CreditNote::LineItem::Discount::OrHash]
|
247
|
+
).returns(T.attached_class)
|
225
248
|
end
|
226
249
|
def self.new(
|
227
250
|
# The Orb id of this resource.
|
@@ -240,25 +263,29 @@ module Orb
|
|
240
263
|
tax_amounts:,
|
241
264
|
# Any line item discounts from the invoice's line item.
|
242
265
|
discounts: nil
|
243
|
-
)
|
266
|
+
)
|
267
|
+
end
|
268
|
+
|
244
269
|
sig do
|
245
|
-
override
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
270
|
+
override.returns(
|
271
|
+
{
|
272
|
+
id: String,
|
273
|
+
amount: String,
|
274
|
+
item_id: String,
|
275
|
+
name: String,
|
276
|
+
quantity: T.nilable(Float),
|
277
|
+
subtotal: String,
|
278
|
+
tax_amounts: T::Array[Orb::CreditNote::LineItem::TaxAmount],
|
279
|
+
discounts: T::Array[Orb::CreditNote::LineItem::Discount]
|
280
|
+
}
|
281
|
+
)
|
282
|
+
end
|
283
|
+
def to_hash
|
258
284
|
end
|
259
|
-
def to_hash; end
|
260
285
|
|
261
286
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
287
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
288
|
+
|
262
289
|
# The amount of additional tax incurred by this tax rate.
|
263
290
|
sig { returns(String) }
|
264
291
|
attr_accessor :amount
|
@@ -272,8 +299,11 @@ module Orb
|
|
272
299
|
attr_accessor :tax_rate_percentage
|
273
300
|
|
274
301
|
sig do
|
275
|
-
params(
|
276
|
-
|
302
|
+
params(
|
303
|
+
amount: String,
|
304
|
+
tax_rate_description: String,
|
305
|
+
tax_rate_percentage: T.nilable(String)
|
306
|
+
).returns(T.attached_class)
|
277
307
|
end
|
278
308
|
def self.new(
|
279
309
|
# The amount of additional tax incurred by this tax rate.
|
@@ -282,7 +312,9 @@ module Orb
|
|
282
312
|
tax_rate_description:,
|
283
313
|
# The tax rate percentage, out of 100.
|
284
314
|
tax_rate_percentage:
|
285
|
-
)
|
315
|
+
)
|
316
|
+
end
|
317
|
+
|
286
318
|
sig do
|
287
319
|
override.returns(
|
288
320
|
{
|
@@ -292,10 +324,13 @@ module Orb
|
|
292
324
|
}
|
293
325
|
)
|
294
326
|
end
|
295
|
-
def to_hash
|
327
|
+
def to_hash
|
328
|
+
end
|
296
329
|
end
|
297
330
|
|
298
331
|
class Discount < Orb::Internal::Type::BaseModel
|
332
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
333
|
+
|
299
334
|
sig { returns(String) }
|
300
335
|
attr_accessor :id
|
301
336
|
|
@@ -305,7 +340,11 @@ module Orb
|
|
305
340
|
sig { returns(T::Array[String]) }
|
306
341
|
attr_accessor :applies_to_price_ids
|
307
342
|
|
308
|
-
sig
|
343
|
+
sig do
|
344
|
+
returns(
|
345
|
+
Orb::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol
|
346
|
+
)
|
347
|
+
end
|
309
348
|
attr_accessor :discount_type
|
310
349
|
|
311
350
|
sig { returns(Float) }
|
@@ -322,12 +361,12 @@ module Orb
|
|
322
361
|
id: String,
|
323
362
|
amount_applied: String,
|
324
363
|
applies_to_price_ids: T::Array[String],
|
325
|
-
discount_type:
|
364
|
+
discount_type:
|
365
|
+
Orb::CreditNote::LineItem::Discount::DiscountType::OrSymbol,
|
326
366
|
percentage_discount: Float,
|
327
367
|
amount_discount: T.nilable(String),
|
328
368
|
reason: T.nilable(String)
|
329
|
-
)
|
330
|
-
.returns(T.attached_class)
|
369
|
+
).returns(T.attached_class)
|
331
370
|
end
|
332
371
|
def self.new(
|
333
372
|
id:,
|
@@ -337,49 +376,82 @@ module Orb
|
|
337
376
|
percentage_discount:,
|
338
377
|
amount_discount: nil,
|
339
378
|
reason: nil
|
340
|
-
)
|
379
|
+
)
|
380
|
+
end
|
381
|
+
|
341
382
|
sig do
|
342
|
-
override
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
383
|
+
override.returns(
|
384
|
+
{
|
385
|
+
id: String,
|
386
|
+
amount_applied: String,
|
387
|
+
applies_to_price_ids: T::Array[String],
|
388
|
+
discount_type:
|
389
|
+
Orb::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol,
|
390
|
+
percentage_discount: Float,
|
391
|
+
amount_discount: T.nilable(String),
|
392
|
+
reason: T.nilable(String)
|
393
|
+
}
|
394
|
+
)
|
395
|
+
end
|
396
|
+
def to_hash
|
354
397
|
end
|
355
|
-
def to_hash; end
|
356
398
|
|
357
399
|
module DiscountType
|
358
400
|
extend Orb::Internal::Type::Enum
|
359
401
|
|
360
|
-
TaggedSymbol =
|
402
|
+
TaggedSymbol =
|
403
|
+
T.type_alias do
|
404
|
+
T.all(Symbol, Orb::CreditNote::LineItem::Discount::DiscountType)
|
405
|
+
end
|
361
406
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
362
407
|
|
363
|
-
PERCENTAGE =
|
364
|
-
|
408
|
+
PERCENTAGE =
|
409
|
+
T.let(
|
410
|
+
:percentage,
|
411
|
+
Orb::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol
|
412
|
+
)
|
413
|
+
AMOUNT =
|
414
|
+
T.let(
|
415
|
+
:amount,
|
416
|
+
Orb::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol
|
417
|
+
)
|
365
418
|
|
366
|
-
sig
|
367
|
-
|
419
|
+
sig do
|
420
|
+
override.returns(
|
421
|
+
T::Array[
|
422
|
+
Orb::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol
|
423
|
+
]
|
424
|
+
)
|
425
|
+
end
|
426
|
+
def self.values
|
427
|
+
end
|
368
428
|
end
|
369
429
|
end
|
370
430
|
end
|
371
431
|
|
372
432
|
class MaximumAmountAdjustment < Orb::Internal::Type::BaseModel
|
433
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
434
|
+
|
373
435
|
sig { returns(String) }
|
374
436
|
attr_accessor :amount_applied
|
375
437
|
|
376
|
-
sig
|
438
|
+
sig do
|
439
|
+
returns(
|
440
|
+
Orb::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol
|
441
|
+
)
|
442
|
+
end
|
377
443
|
attr_accessor :discount_type
|
378
444
|
|
379
445
|
sig { returns(Float) }
|
380
446
|
attr_accessor :percentage_discount
|
381
447
|
|
382
|
-
sig
|
448
|
+
sig do
|
449
|
+
returns(
|
450
|
+
T.nilable(
|
451
|
+
T::Array[Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice]
|
452
|
+
)
|
453
|
+
)
|
454
|
+
end
|
383
455
|
attr_accessor :applies_to_prices
|
384
456
|
|
385
457
|
sig { returns(T.nilable(String)) }
|
@@ -389,14 +461,17 @@ module Orb
|
|
389
461
|
sig do
|
390
462
|
params(
|
391
463
|
amount_applied: String,
|
392
|
-
discount_type:
|
464
|
+
discount_type:
|
465
|
+
Orb::CreditNote::MaximumAmountAdjustment::DiscountType::OrSymbol,
|
393
466
|
percentage_discount: Float,
|
394
|
-
applies_to_prices:
|
395
|
-
T
|
396
|
-
|
467
|
+
applies_to_prices:
|
468
|
+
T.nilable(
|
469
|
+
T::Array[
|
470
|
+
Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice::OrHash
|
471
|
+
]
|
472
|
+
),
|
397
473
|
reason: T.nilable(String)
|
398
|
-
)
|
399
|
-
.returns(T.attached_class)
|
474
|
+
).returns(T.attached_class)
|
400
475
|
end
|
401
476
|
def self.new(
|
402
477
|
amount_applied:,
|
@@ -408,34 +483,57 @@ module Orb
|
|
408
483
|
end
|
409
484
|
|
410
485
|
sig do
|
411
|
-
override
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
486
|
+
override.returns(
|
487
|
+
{
|
488
|
+
amount_applied: String,
|
489
|
+
discount_type:
|
490
|
+
Orb::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol,
|
491
|
+
percentage_discount: Float,
|
492
|
+
applies_to_prices:
|
493
|
+
T.nilable(
|
494
|
+
T::Array[
|
495
|
+
Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice
|
496
|
+
]
|
497
|
+
),
|
498
|
+
reason: T.nilable(String)
|
499
|
+
}
|
500
|
+
)
|
501
|
+
end
|
502
|
+
def to_hash
|
421
503
|
end
|
422
|
-
def to_hash; end
|
423
504
|
|
424
505
|
module DiscountType
|
425
506
|
extend Orb::Internal::Type::Enum
|
426
507
|
|
427
508
|
TaggedSymbol =
|
428
|
-
T.type_alias
|
509
|
+
T.type_alias do
|
510
|
+
T.all(
|
511
|
+
Symbol,
|
512
|
+
Orb::CreditNote::MaximumAmountAdjustment::DiscountType
|
513
|
+
)
|
514
|
+
end
|
429
515
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
430
516
|
|
431
517
|
PERCENTAGE =
|
432
|
-
T.let(
|
518
|
+
T.let(
|
519
|
+
:percentage,
|
520
|
+
Orb::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol
|
521
|
+
)
|
433
522
|
|
434
|
-
sig
|
435
|
-
|
523
|
+
sig do
|
524
|
+
override.returns(
|
525
|
+
T::Array[
|
526
|
+
Orb::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol
|
527
|
+
]
|
528
|
+
)
|
529
|
+
end
|
530
|
+
def self.values
|
531
|
+
end
|
436
532
|
end
|
437
533
|
|
438
534
|
class AppliesToPrice < Orb::Internal::Type::BaseModel
|
535
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
536
|
+
|
439
537
|
sig { returns(String) }
|
440
538
|
attr_accessor :id
|
441
539
|
|
@@ -443,52 +541,69 @@ module Orb
|
|
443
541
|
attr_accessor :name
|
444
542
|
|
445
543
|
sig { params(id: String, name: String).returns(T.attached_class) }
|
446
|
-
def self.new(id:, name:)
|
544
|
+
def self.new(id:, name:)
|
545
|
+
end
|
447
546
|
|
448
|
-
sig { override.returns({id: String, name: String}) }
|
449
|
-
def to_hash
|
547
|
+
sig { override.returns({ id: String, name: String }) }
|
548
|
+
def to_hash
|
549
|
+
end
|
450
550
|
end
|
451
551
|
end
|
452
552
|
|
453
553
|
module Reason
|
454
554
|
extend Orb::Internal::Type::Enum
|
455
555
|
|
456
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
556
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::CreditNote::Reason) }
|
457
557
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
458
558
|
|
459
|
-
DUPLICATE = T.let(:Duplicate, Orb::
|
460
|
-
FRAUDULENT = T.let(:Fraudulent, Orb::
|
461
|
-
ORDER_CHANGE =
|
462
|
-
|
559
|
+
DUPLICATE = T.let(:Duplicate, Orb::CreditNote::Reason::TaggedSymbol)
|
560
|
+
FRAUDULENT = T.let(:Fraudulent, Orb::CreditNote::Reason::TaggedSymbol)
|
561
|
+
ORDER_CHANGE =
|
562
|
+
T.let(:"Order change", Orb::CreditNote::Reason::TaggedSymbol)
|
563
|
+
PRODUCT_UNSATISFACTORY =
|
564
|
+
T.let(
|
565
|
+
:"Product unsatisfactory",
|
566
|
+
Orb::CreditNote::Reason::TaggedSymbol
|
567
|
+
)
|
463
568
|
|
464
|
-
sig
|
465
|
-
|
569
|
+
sig do
|
570
|
+
override.returns(T::Array[Orb::CreditNote::Reason::TaggedSymbol])
|
571
|
+
end
|
572
|
+
def self.values
|
573
|
+
end
|
466
574
|
end
|
467
575
|
|
468
576
|
module Type
|
469
577
|
extend Orb::Internal::Type::Enum
|
470
578
|
|
471
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
579
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::CreditNote::Type) }
|
472
580
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
473
581
|
|
474
|
-
REFUND = T.let(:refund, Orb::
|
475
|
-
ADJUSTMENT = T.let(:adjustment, Orb::
|
582
|
+
REFUND = T.let(:refund, Orb::CreditNote::Type::TaggedSymbol)
|
583
|
+
ADJUSTMENT = T.let(:adjustment, Orb::CreditNote::Type::TaggedSymbol)
|
476
584
|
|
477
|
-
sig { override.returns(T::Array[Orb::
|
478
|
-
def self.values
|
585
|
+
sig { override.returns(T::Array[Orb::CreditNote::Type::TaggedSymbol]) }
|
586
|
+
def self.values
|
587
|
+
end
|
479
588
|
end
|
480
589
|
|
481
590
|
class Discount < Orb::Internal::Type::BaseModel
|
591
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
592
|
+
|
482
593
|
sig { returns(String) }
|
483
594
|
attr_accessor :amount_applied
|
484
595
|
|
485
|
-
sig { returns(Orb::
|
596
|
+
sig { returns(Orb::CreditNote::Discount::DiscountType::TaggedSymbol) }
|
486
597
|
attr_accessor :discount_type
|
487
598
|
|
488
599
|
sig { returns(Float) }
|
489
600
|
attr_accessor :percentage_discount
|
490
601
|
|
491
|
-
sig
|
602
|
+
sig do
|
603
|
+
returns(
|
604
|
+
T.nilable(T::Array[Orb::CreditNote::Discount::AppliesToPrice])
|
605
|
+
)
|
606
|
+
end
|
492
607
|
attr_accessor :applies_to_prices
|
493
608
|
|
494
609
|
sig { returns(T.nilable(String)) }
|
@@ -497,12 +612,14 @@ module Orb
|
|
497
612
|
sig do
|
498
613
|
params(
|
499
614
|
amount_applied: String,
|
500
|
-
discount_type: Orb::
|
615
|
+
discount_type: Orb::CreditNote::Discount::DiscountType::OrSymbol,
|
501
616
|
percentage_discount: Float,
|
502
|
-
applies_to_prices:
|
617
|
+
applies_to_prices:
|
618
|
+
T.nilable(
|
619
|
+
T::Array[Orb::CreditNote::Discount::AppliesToPrice::OrHash]
|
620
|
+
),
|
503
621
|
reason: T.nilable(String)
|
504
|
-
)
|
505
|
-
.returns(T.attached_class)
|
622
|
+
).returns(T.attached_class)
|
506
623
|
end
|
507
624
|
def self.new(
|
508
625
|
amount_applied:,
|
@@ -514,32 +631,48 @@ module Orb
|
|
514
631
|
end
|
515
632
|
|
516
633
|
sig do
|
517
|
-
override
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
634
|
+
override.returns(
|
635
|
+
{
|
636
|
+
amount_applied: String,
|
637
|
+
discount_type:
|
638
|
+
Orb::CreditNote::Discount::DiscountType::TaggedSymbol,
|
639
|
+
percentage_discount: Float,
|
640
|
+
applies_to_prices:
|
641
|
+
T.nilable(T::Array[Orb::CreditNote::Discount::AppliesToPrice]),
|
642
|
+
reason: T.nilable(String)
|
643
|
+
}
|
644
|
+
)
|
645
|
+
end
|
646
|
+
def to_hash
|
527
647
|
end
|
528
|
-
def to_hash; end
|
529
648
|
|
530
649
|
module DiscountType
|
531
650
|
extend Orb::Internal::Type::Enum
|
532
651
|
|
533
|
-
TaggedSymbol =
|
652
|
+
TaggedSymbol =
|
653
|
+
T.type_alias do
|
654
|
+
T.all(Symbol, Orb::CreditNote::Discount::DiscountType)
|
655
|
+
end
|
534
656
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
535
657
|
|
536
|
-
PERCENTAGE =
|
658
|
+
PERCENTAGE =
|
659
|
+
T.let(
|
660
|
+
:percentage,
|
661
|
+
Orb::CreditNote::Discount::DiscountType::TaggedSymbol
|
662
|
+
)
|
537
663
|
|
538
|
-
sig
|
539
|
-
|
664
|
+
sig do
|
665
|
+
override.returns(
|
666
|
+
T::Array[Orb::CreditNote::Discount::DiscountType::TaggedSymbol]
|
667
|
+
)
|
668
|
+
end
|
669
|
+
def self.values
|
670
|
+
end
|
540
671
|
end
|
541
672
|
|
542
673
|
class AppliesToPrice < Orb::Internal::Type::BaseModel
|
674
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
675
|
+
|
543
676
|
sig { returns(String) }
|
544
677
|
attr_accessor :id
|
545
678
|
|
@@ -547,10 +680,12 @@ module Orb
|
|
547
680
|
attr_accessor :name
|
548
681
|
|
549
682
|
sig { params(id: String, name: String).returns(T.attached_class) }
|
550
|
-
def self.new(id:, name:)
|
683
|
+
def self.new(id:, name:)
|
684
|
+
end
|
551
685
|
|
552
|
-
sig { override.returns({id: String, name: String}) }
|
553
|
-
def to_hash
|
686
|
+
sig { override.returns({ id: String, name: String }) }
|
687
|
+
def to_hash
|
688
|
+
end
|
554
689
|
end
|
555
690
|
end
|
556
691
|
end
|