orb-billing 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +34 -0
- data/README.md +59 -49
- data/lib/orb/client.rb +4 -4
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +4 -8
- data/lib/orb/internal/transport/base_client.rb +7 -7
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +32 -14
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +4 -0
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +9 -5
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +4 -0
- data/lib/orb/internal/util.rb +69 -61
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +4 -4
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/enum.rbi +3 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
- data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/union.rbi +3 -0
- data/rbi/lib/orb/internal/util.rbi +24 -19
- data/rbi/lib/orb/internal.rbi +0 -1
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +14 -12
- metadata +8 -5
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Coupons#fetch
|
6
6
|
class CouponFetchParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
|
-
# @!
|
12
|
-
#
|
13
|
-
# #
|
14
|
-
# def initialize(request_options: {}, **) = super
|
15
|
-
|
16
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
17
12
|
end
|
18
13
|
end
|
19
14
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Coupons#list
|
6
6
|
class CouponListParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute cursor
|
@@ -15,16 +14,12 @@ module Orb
|
|
15
14
|
# @return [String, nil]
|
16
15
|
optional :cursor, String, nil?: true
|
17
16
|
|
18
|
-
# @!attribute
|
17
|
+
# @!attribute limit
|
19
18
|
# The number of items to fetch. Defaults to 20.
|
20
19
|
#
|
21
20
|
# @return [Integer, nil]
|
22
21
|
optional :limit, Integer
|
23
22
|
|
24
|
-
# @!parse
|
25
|
-
# # @return [Integer]
|
26
|
-
# attr_writer :limit
|
27
|
-
|
28
23
|
# @!attribute redemption_code
|
29
24
|
# Filter to coupons matching this redemption code.
|
30
25
|
#
|
@@ -38,16 +33,21 @@ module Orb
|
|
38
33
|
# @return [Boolean, nil]
|
39
34
|
optional :show_archived, Orb::Internal::Type::Boolean, nil?: true
|
40
35
|
|
41
|
-
# @!
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
|
50
|
-
#
|
36
|
+
# @!method initialize(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
|
37
|
+
# Some parameter documentations has been truncated, see
|
38
|
+
# {Orb::Models::CouponListParams} for more details.
|
39
|
+
#
|
40
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
41
|
+
# ...
|
42
|
+
#
|
43
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
44
|
+
#
|
45
|
+
# @param redemption_code [String, nil] Filter to coupons matching this redemption code.
|
46
|
+
#
|
47
|
+
# @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou
|
48
|
+
# ...
|
49
|
+
#
|
50
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
51
51
|
end
|
52
52
|
end
|
53
53
|
end
|
@@ -5,8 +5,7 @@ module Orb
|
|
5
5
|
module Coupons
|
6
6
|
# @see Orb::Resources::Coupons::Subscriptions#list
|
7
7
|
class SubscriptionListParams < Orb::Internal::Type::BaseModel
|
8
|
-
|
9
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
8
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
10
9
|
include Orb::Internal::Type::RequestParameters
|
11
10
|
|
12
11
|
# @!attribute cursor
|
@@ -16,24 +15,22 @@ module Orb
|
|
16
15
|
# @return [String, nil]
|
17
16
|
optional :cursor, String, nil?: true
|
18
17
|
|
19
|
-
# @!attribute
|
18
|
+
# @!attribute limit
|
20
19
|
# The number of items to fetch. Defaults to 20.
|
21
20
|
#
|
22
21
|
# @return [Integer, nil]
|
23
22
|
optional :limit, Integer
|
24
23
|
|
25
|
-
# @!
|
26
|
-
#
|
27
|
-
#
|
28
|
-
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
|
36
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
24
|
+
# @!method initialize(cursor: nil, limit: nil, request_options: {})
|
25
|
+
# Some parameter documentations has been truncated, see
|
26
|
+
# {Orb::Models::Coupons::SubscriptionListParams} for more details.
|
27
|
+
#
|
28
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
29
|
+
# ...
|
30
|
+
#
|
31
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
32
|
+
#
|
33
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
37
34
|
end
|
38
35
|
end
|
39
36
|
end
|
@@ -91,60 +91,47 @@ module Orb
|
|
91
91
|
# @return [Time, nil]
|
92
92
|
required :voided_at, Time, nil?: true
|
93
93
|
|
94
|
-
# @!attribute
|
94
|
+
# @!attribute discounts
|
95
95
|
# Any discounts applied on the original invoice.
|
96
96
|
#
|
97
97
|
# @return [Array<Orb::Models::CreditNote::Discount>, nil]
|
98
98
|
optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::Discount] }
|
99
99
|
|
100
|
-
# @!
|
101
|
-
#
|
102
|
-
#
|
103
|
-
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
# minimum_amount_refunded:,
|
136
|
-
# reason:,
|
137
|
-
# subtotal:,
|
138
|
-
# total:,
|
139
|
-
# type:,
|
140
|
-
# voided_at:,
|
141
|
-
# discounts: nil,
|
142
|
-
# **
|
143
|
-
# )
|
144
|
-
# super
|
145
|
-
# end
|
146
|
-
|
147
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
100
|
+
# @!method initialize(id:, created_at:, credit_note_number:, credit_note_pdf:, customer:, invoice_id:, line_items:, maximum_amount_adjustment:, memo:, minimum_amount_refunded:, reason:, subtotal:, total:, type:, voided_at:, discounts: nil)
|
101
|
+
# The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
|
102
|
+
# been applied to a particular invoice.
|
103
|
+
#
|
104
|
+
# @param id [String] The Orb id of this credit note.
|
105
|
+
#
|
106
|
+
# @param created_at [Time] The creation time of the resource in Orb.
|
107
|
+
#
|
108
|
+
# @param credit_note_number [String] The unique identifier for credit notes.
|
109
|
+
#
|
110
|
+
# @param credit_note_pdf [String, nil] A URL to a PDF of the credit note.
|
111
|
+
#
|
112
|
+
# @param customer [Orb::Models::CreditNote::Customer]
|
113
|
+
#
|
114
|
+
# @param invoice_id [String] The id of the invoice resource that this credit note is applied to.
|
115
|
+
#
|
116
|
+
# @param line_items [Array<Orb::Models::CreditNote::LineItem>] All of the line items associated with this credit note.
|
117
|
+
#
|
118
|
+
# @param maximum_amount_adjustment [Orb::Models::CreditNote::MaximumAmountAdjustment, nil] The maximum amount applied on the original invoice
|
119
|
+
#
|
120
|
+
# @param memo [String, nil] An optional memo supplied on the credit note.
|
121
|
+
#
|
122
|
+
# @param minimum_amount_refunded [String, nil] Any credited amount from the applied minimum on the invoice.
|
123
|
+
#
|
124
|
+
# @param reason [Symbol, Orb::Models::CreditNote::Reason, nil]
|
125
|
+
#
|
126
|
+
# @param subtotal [String] The total prior to any creditable invoice-level discounts or minimums.
|
127
|
+
#
|
128
|
+
# @param total [String] The total including creditable invoice-level discounts or minimums, and tax.
|
129
|
+
#
|
130
|
+
# @param type [Symbol, Orb::Models::CreditNote::Type]
|
131
|
+
#
|
132
|
+
# @param voided_at [Time, nil] The time at which the credit note was voided in Orb, if applicable.
|
133
|
+
#
|
134
|
+
# @param discounts [Array<Orb::Models::CreditNote::Discount>] Any discounts applied on the original invoice.
|
148
135
|
|
149
136
|
# @see Orb::Models::CreditNote#customer
|
150
137
|
class Customer < Orb::Internal::Type::BaseModel
|
@@ -158,13 +145,9 @@ module Orb
|
|
158
145
|
# @return [String, nil]
|
159
146
|
required :external_customer_id, String, nil?: true
|
160
147
|
|
161
|
-
# @!
|
162
|
-
#
|
163
|
-
#
|
164
|
-
# #
|
165
|
-
# def initialize(id:, external_customer_id:, **) = super
|
166
|
-
|
167
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
148
|
+
# @!method initialize(id:, external_customer_id:)
|
149
|
+
# @param id [String]
|
150
|
+
# @param external_customer_id [String, nil]
|
168
151
|
end
|
169
152
|
|
170
153
|
class LineItem < Orb::Internal::Type::BaseModel
|
@@ -210,29 +193,28 @@ module Orb
|
|
210
193
|
# @return [Array<Orb::Models::CreditNote::LineItem::TaxAmount>]
|
211
194
|
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::LineItem::TaxAmount] }
|
212
195
|
|
213
|
-
# @!attribute
|
196
|
+
# @!attribute discounts
|
214
197
|
# Any line item discounts from the invoice's line item.
|
215
198
|
#
|
216
199
|
# @return [Array<Orb::Models::CreditNote::LineItem::Discount>, nil]
|
217
200
|
optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote::LineItem::Discount] }
|
218
201
|
|
219
|
-
# @!
|
220
|
-
#
|
221
|
-
#
|
222
|
-
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
|
235
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
202
|
+
# @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil)
|
203
|
+
# @param id [String] The Orb id of this resource.
|
204
|
+
#
|
205
|
+
# @param amount [String] The amount of the line item, including any line item minimums and discounts.
|
206
|
+
#
|
207
|
+
# @param item_id [String] The id of the item associated with this line item.
|
208
|
+
#
|
209
|
+
# @param name [String] The name of the corresponding invoice line item.
|
210
|
+
#
|
211
|
+
# @param quantity [Float, nil] An optional quantity credited.
|
212
|
+
#
|
213
|
+
# @param subtotal [String] The amount of the line item, excluding any line item minimums and discounts.
|
214
|
+
#
|
215
|
+
# @param tax_amounts [Array<Orb::Models::CreditNote::LineItem::TaxAmount>] Any tax amounts applied onto the line item.
|
216
|
+
#
|
217
|
+
# @param discounts [Array<Orb::Models::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
|
236
218
|
|
237
219
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
238
220
|
# @!attribute amount
|
@@ -253,14 +235,12 @@ module Orb
|
|
253
235
|
# @return [String, nil]
|
254
236
|
required :tax_rate_percentage, String, nil?: true
|
255
237
|
|
256
|
-
# @!
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
|
263
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
238
|
+
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
239
|
+
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
240
|
+
#
|
241
|
+
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
242
|
+
#
|
243
|
+
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
264
244
|
end
|
265
245
|
|
266
246
|
class Discount < Orb::Internal::Type::BaseModel
|
@@ -299,29 +279,14 @@ module Orb
|
|
299
279
|
# @return [String, nil]
|
300
280
|
optional :reason, String, nil?: true
|
301
281
|
|
302
|
-
# @!
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
# #
|
311
|
-
# def initialize(
|
312
|
-
# id:,
|
313
|
-
# amount_applied:,
|
314
|
-
# applies_to_price_ids:,
|
315
|
-
# discount_type:,
|
316
|
-
# percentage_discount:,
|
317
|
-
# amount_discount: nil,
|
318
|
-
# reason: nil,
|
319
|
-
# **
|
320
|
-
# )
|
321
|
-
# super
|
322
|
-
# end
|
323
|
-
|
324
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
282
|
+
# @!method initialize(id:, amount_applied:, applies_to_price_ids:, discount_type:, percentage_discount:, amount_discount: nil, reason: nil)
|
283
|
+
# @param id [String]
|
284
|
+
# @param amount_applied [String]
|
285
|
+
# @param applies_to_price_ids [Array<String>]
|
286
|
+
# @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
|
287
|
+
# @param percentage_discount [Float]
|
288
|
+
# @param amount_discount [String, nil]
|
289
|
+
# @param reason [String, nil]
|
325
290
|
|
326
291
|
# @see Orb::Models::CreditNote::LineItem::Discount#discount_type
|
327
292
|
module DiscountType
|
@@ -330,11 +295,8 @@ module Orb
|
|
330
295
|
PERCENTAGE = :percentage
|
331
296
|
AMOUNT = :amount
|
332
297
|
|
333
|
-
|
334
|
-
|
335
|
-
# @!parse
|
336
|
-
# # @return [Array<Symbol>]
|
337
|
-
# def self.values; end
|
298
|
+
# @!method self.values
|
299
|
+
# @return [Array<Symbol>]
|
338
300
|
end
|
339
301
|
end
|
340
302
|
end
|
@@ -368,18 +330,14 @@ module Orb
|
|
368
330
|
# @return [String, nil]
|
369
331
|
optional :reason, String, nil?: true
|
370
332
|
|
371
|
-
# @!
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
# #
|
380
|
-
# def initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil, **) = super
|
381
|
-
|
382
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
333
|
+
# @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil)
|
334
|
+
# The maximum amount applied on the original invoice
|
335
|
+
#
|
336
|
+
# @param amount_applied [String]
|
337
|
+
# @param discount_type [Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType]
|
338
|
+
# @param percentage_discount [Float]
|
339
|
+
# @param applies_to_prices [Array<Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
|
340
|
+
# @param reason [String, nil]
|
383
341
|
|
384
342
|
# @see Orb::Models::CreditNote::MaximumAmountAdjustment#discount_type
|
385
343
|
module DiscountType
|
@@ -387,11 +345,8 @@ module Orb
|
|
387
345
|
|
388
346
|
PERCENTAGE = :percentage
|
389
347
|
|
390
|
-
|
391
|
-
|
392
|
-
# @!parse
|
393
|
-
# # @return [Array<Symbol>]
|
394
|
-
# def self.values; end
|
348
|
+
# @!method self.values
|
349
|
+
# @return [Array<Symbol>]
|
395
350
|
end
|
396
351
|
|
397
352
|
class AppliesToPrice < Orb::Internal::Type::BaseModel
|
@@ -405,13 +360,9 @@ module Orb
|
|
405
360
|
# @return [String]
|
406
361
|
required :name, String
|
407
362
|
|
408
|
-
# @!
|
409
|
-
#
|
410
|
-
#
|
411
|
-
# #
|
412
|
-
# def initialize(id:, name:, **) = super
|
413
|
-
|
414
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
363
|
+
# @!method initialize(id:, name:)
|
364
|
+
# @param id [String]
|
365
|
+
# @param name [String]
|
415
366
|
end
|
416
367
|
end
|
417
368
|
|
@@ -424,11 +375,8 @@ module Orb
|
|
424
375
|
ORDER_CHANGE = :"Order change"
|
425
376
|
PRODUCT_UNSATISFACTORY = :"Product unsatisfactory"
|
426
377
|
|
427
|
-
|
428
|
-
|
429
|
-
# @!parse
|
430
|
-
# # @return [Array<Symbol>]
|
431
|
-
# def self.values; end
|
378
|
+
# @!method self.values
|
379
|
+
# @return [Array<Symbol>]
|
432
380
|
end
|
433
381
|
|
434
382
|
# @see Orb::Models::CreditNote#type
|
@@ -438,11 +386,8 @@ module Orb
|
|
438
386
|
REFUND = :refund
|
439
387
|
ADJUSTMENT = :adjustment
|
440
388
|
|
441
|
-
|
442
|
-
|
443
|
-
# @!parse
|
444
|
-
# # @return [Array<Symbol>]
|
445
|
-
# def self.values; end
|
389
|
+
# @!method self.values
|
390
|
+
# @return [Array<Symbol>]
|
446
391
|
end
|
447
392
|
|
448
393
|
class Discount < Orb::Internal::Type::BaseModel
|
@@ -473,16 +418,12 @@ module Orb
|
|
473
418
|
# @return [String, nil]
|
474
419
|
optional :reason, String, nil?: true
|
475
420
|
|
476
|
-
# @!
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
481
|
-
#
|
482
|
-
# #
|
483
|
-
# def initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil, **) = super
|
484
|
-
|
485
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
421
|
+
# @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil)
|
422
|
+
# @param amount_applied [String]
|
423
|
+
# @param discount_type [Symbol, Orb::Models::CreditNote::Discount::DiscountType]
|
424
|
+
# @param percentage_discount [Float]
|
425
|
+
# @param applies_to_prices [Array<Orb::Models::CreditNote::Discount::AppliesToPrice>, nil]
|
426
|
+
# @param reason [String, nil]
|
486
427
|
|
487
428
|
# @see Orb::Models::CreditNote::Discount#discount_type
|
488
429
|
module DiscountType
|
@@ -490,11 +431,8 @@ module Orb
|
|
490
431
|
|
491
432
|
PERCENTAGE = :percentage
|
492
433
|
|
493
|
-
|
494
|
-
|
495
|
-
# @!parse
|
496
|
-
# # @return [Array<Symbol>]
|
497
|
-
# def self.values; end
|
434
|
+
# @!method self.values
|
435
|
+
# @return [Array<Symbol>]
|
498
436
|
end
|
499
437
|
|
500
438
|
class AppliesToPrice < Orb::Internal::Type::BaseModel
|
@@ -508,13 +446,9 @@ module Orb
|
|
508
446
|
# @return [String]
|
509
447
|
required :name, String
|
510
448
|
|
511
|
-
# @!
|
512
|
-
#
|
513
|
-
#
|
514
|
-
# #
|
515
|
-
# def initialize(id:, name:, **) = super
|
516
|
-
|
517
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
449
|
+
# @!method initialize(id:, name:)
|
450
|
+
# @param id [String]
|
451
|
+
# @param name [String]
|
518
452
|
end
|
519
453
|
end
|
520
454
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::CreditNotes#create
|
6
6
|
class CreditNoteCreateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute line_items
|
@@ -25,15 +24,14 @@ module Orb
|
|
25
24
|
# @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
|
26
25
|
optional :reason, enum: -> { Orb::Models::CreditNoteCreateParams::Reason }, nil?: true
|
27
26
|
|
28
|
-
# @!
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
|
36
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
27
|
+
# @!method initialize(line_items:, memo: nil, reason: nil, request_options: {})
|
28
|
+
# @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
|
29
|
+
#
|
30
|
+
# @param memo [String, nil] An optional memo to attach to the credit note.
|
31
|
+
#
|
32
|
+
# @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
|
33
|
+
#
|
34
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
37
35
|
|
38
36
|
class LineItem < Orb::Internal::Type::BaseModel
|
39
37
|
# @!attribute amount
|
@@ -48,13 +46,10 @@ module Orb
|
|
48
46
|
# @return [String]
|
49
47
|
required :invoice_line_item_id, String
|
50
48
|
|
51
|
-
# @!
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
# def initialize(amount:, invoice_line_item_id:, **) = super
|
56
|
-
|
57
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
49
|
+
# @!method initialize(amount:, invoice_line_item_id:)
|
50
|
+
# @param amount [String] The total amount in the invoice's currency to credit this line item.
|
51
|
+
#
|
52
|
+
# @param invoice_line_item_id [String] The ID of the line item to credit.
|
58
53
|
end
|
59
54
|
|
60
55
|
# An optional reason for the credit note.
|
@@ -66,11 +61,8 @@ module Orb
|
|
66
61
|
ORDER_CHANGE = :order_change
|
67
62
|
PRODUCT_UNSATISFACTORY = :product_unsatisfactory
|
68
63
|
|
69
|
-
|
70
|
-
|
71
|
-
# @!parse
|
72
|
-
# # @return [Array<Symbol>]
|
73
|
-
# def self.values; end
|
64
|
+
# @!method self.values
|
65
|
+
# @return [Array<Symbol>]
|
74
66
|
end
|
75
67
|
end
|
76
68
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::CreditNotes#fetch
|
6
6
|
class CreditNoteFetchParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
|
-
# @!
|
12
|
-
#
|
13
|
-
# #
|
14
|
-
# def initialize(request_options: {}, **) = super
|
15
|
-
|
16
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
17
12
|
end
|
18
13
|
end
|
19
14
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::CreditNotes#list
|
6
6
|
class CreditNoteListParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute created_at_gt
|
@@ -35,39 +34,30 @@ module Orb
|
|
35
34
|
# @return [String, nil]
|
36
35
|
optional :cursor, String, nil?: true
|
37
36
|
|
38
|
-
# @!attribute
|
37
|
+
# @!attribute limit
|
39
38
|
# The number of items to fetch. Defaults to 20.
|
40
39
|
#
|
41
40
|
# @return [Integer, nil]
|
42
41
|
optional :limit, Integer
|
43
42
|
|
44
|
-
# @!
|
45
|
-
#
|
46
|
-
#
|
47
|
-
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
# cursor: nil,
|
63
|
-
# limit: nil,
|
64
|
-
# request_options: {},
|
65
|
-
# **
|
66
|
-
# )
|
67
|
-
# super
|
68
|
-
# end
|
69
|
-
|
70
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
43
|
+
# @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
|
44
|
+
# Some parameter documentations has been truncated, see
|
45
|
+
# {Orb::Models::CreditNoteListParams} for more details.
|
46
|
+
#
|
47
|
+
# @param created_at_gt [Time, nil]
|
48
|
+
#
|
49
|
+
# @param created_at_gte [Time, nil]
|
50
|
+
#
|
51
|
+
# @param created_at_lt [Time, nil]
|
52
|
+
#
|
53
|
+
# @param created_at_lte [Time, nil]
|
54
|
+
#
|
55
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
56
|
+
# ...
|
57
|
+
#
|
58
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
59
|
+
#
|
60
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
71
61
|
end
|
72
62
|
end
|
73
63
|
end
|