orb-billing 0.1.3 → 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/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- 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 +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- 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 +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Invoices#list
|
6
6
|
class InvoiceListParams < 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 amount
|
@@ -94,16 +93,12 @@ module Orb
|
|
94
93
|
# @return [Boolean, nil]
|
95
94
|
optional :is_recurring, Orb::Internal::Type::Boolean, nil?: true
|
96
95
|
|
97
|
-
# @!attribute
|
96
|
+
# @!attribute limit
|
98
97
|
# The number of items to fetch. Defaults to 20.
|
99
98
|
#
|
100
99
|
# @return [Integer, nil]
|
101
100
|
optional :limit, Integer
|
102
101
|
|
103
|
-
# @!parse
|
104
|
-
# # @return [Integer]
|
105
|
-
# attr_writer :limit
|
106
|
-
|
107
102
|
# @!attribute status
|
108
103
|
#
|
109
104
|
# @return [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
|
@@ -116,55 +111,51 @@ module Orb
|
|
116
111
|
# @return [String, nil]
|
117
112
|
optional :subscription_id, String, nil?: true
|
118
113
|
|
119
|
-
# @!
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
# super
|
165
|
-
# end
|
166
|
-
|
167
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
114
|
+
# @!method initialize(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
|
115
|
+
# Some parameter documentations has been truncated, see
|
116
|
+
# {Orb::Models::InvoiceListParams} for more details.
|
117
|
+
#
|
118
|
+
# @param amount [String, nil]
|
119
|
+
#
|
120
|
+
# @param amount_gt [String, nil]
|
121
|
+
#
|
122
|
+
# @param amount_lt [String, nil]
|
123
|
+
#
|
124
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
125
|
+
# ...
|
126
|
+
#
|
127
|
+
# @param customer_id [String, nil]
|
128
|
+
#
|
129
|
+
# @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
|
130
|
+
#
|
131
|
+
# @param due_date [Date, nil]
|
132
|
+
#
|
133
|
+
# @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp
|
134
|
+
# ...
|
135
|
+
#
|
136
|
+
# @param due_date_gt [Date, nil]
|
137
|
+
#
|
138
|
+
# @param due_date_lt [Date, nil]
|
139
|
+
#
|
140
|
+
# @param external_customer_id [String, nil]
|
141
|
+
#
|
142
|
+
# @param invoice_date_gt [Time, nil]
|
143
|
+
#
|
144
|
+
# @param invoice_date_gte [Time, nil]
|
145
|
+
#
|
146
|
+
# @param invoice_date_lt [Time, nil]
|
147
|
+
#
|
148
|
+
# @param invoice_date_lte [Time, nil]
|
149
|
+
#
|
150
|
+
# @param is_recurring [Boolean, nil]
|
151
|
+
#
|
152
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
153
|
+
#
|
154
|
+
# @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
|
155
|
+
#
|
156
|
+
# @param subscription_id [String, nil]
|
157
|
+
#
|
158
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
168
159
|
|
169
160
|
module DateType
|
170
161
|
extend Orb::Internal::Type::Enum
|
@@ -172,11 +163,8 @@ module Orb
|
|
172
163
|
DUE_DATE = :due_date
|
173
164
|
INVOICE_DATE = :invoice_date
|
174
165
|
|
175
|
-
|
176
|
-
|
177
|
-
# @!parse
|
178
|
-
# # @return [Array<Symbol>]
|
179
|
-
# def self.values; end
|
166
|
+
# @!method self.values
|
167
|
+
# @return [Array<Symbol>]
|
180
168
|
end
|
181
169
|
|
182
170
|
module Status
|
@@ -188,11 +176,8 @@ module Orb
|
|
188
176
|
SYNCED = :synced
|
189
177
|
VOID = :void
|
190
178
|
|
191
|
-
|
192
|
-
|
193
|
-
# @!parse
|
194
|
-
# # @return [Array<Symbol>]
|
195
|
-
# def self.values; end
|
179
|
+
# @!method self.values
|
180
|
+
# @return [Array<Symbol>]
|
196
181
|
end
|
197
182
|
end
|
198
183
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Invoices#mark_paid
|
6
6
|
class InvoiceMarkPaidParams < 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 payment_received_date
|
@@ -26,15 +25,14 @@ module Orb
|
|
26
25
|
# @return [String, nil]
|
27
26
|
optional :notes, String, nil?: true
|
28
27
|
|
29
|
-
# @!
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
|
37
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
28
|
+
# @!method initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {})
|
29
|
+
# @param payment_received_date [Date] A date string to specify the date of the payment.
|
30
|
+
#
|
31
|
+
# @param external_id [String, nil] An optional external ID to associate with the payment.
|
32
|
+
#
|
33
|
+
# @param notes [String, nil] An optional note to associate with the payment.
|
34
|
+
#
|
35
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
38
36
|
end
|
39
37
|
end
|
40
38
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Invoices#pay
|
6
6
|
class InvoicePayParams < 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::Invoices#update
|
6
6
|
class InvoiceUpdateParams < 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 metadata
|
@@ -16,13 +15,14 @@ module Orb
|
|
16
15
|
# @return [Hash{Symbol=>String, nil}, nil]
|
17
16
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
18
17
|
|
19
|
-
# @!
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
23
|
-
#
|
24
|
-
|
25
|
-
#
|
18
|
+
# @!method initialize(metadata: nil, request_options: {})
|
19
|
+
# Some parameter documentations has been truncated, see
|
20
|
+
# {Orb::Models::InvoiceUpdateParams} for more details.
|
21
|
+
#
|
22
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
23
|
+
# ...
|
24
|
+
#
|
25
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Invoices#void
|
6
6
|
class InvoiceVoidParams < 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
|
data/lib/orb/models/item.rb
CHANGED
@@ -24,19 +24,15 @@ module Orb
|
|
24
24
|
# @return [String]
|
25
25
|
required :name, String
|
26
26
|
|
27
|
-
# @!
|
28
|
-
#
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
# #
|
37
|
-
# def initialize(id:, created_at:, external_connections:, name:, **) = super
|
38
|
-
|
39
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
27
|
+
# @!method initialize(id:, created_at:, external_connections:, name:)
|
28
|
+
# The Item resource represents a sellable product or good. Items are associated
|
29
|
+
# with all line items, billable metrics, and prices and are used for defining
|
30
|
+
# external sync behavior for invoices and tax calculation purposes.
|
31
|
+
#
|
32
|
+
# @param id [String]
|
33
|
+
# @param created_at [Time]
|
34
|
+
# @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
|
35
|
+
# @param name [String]
|
40
36
|
|
41
37
|
class ExternalConnection < Orb::Internal::Type::BaseModel
|
42
38
|
# @!attribute external_connection_name
|
@@ -50,13 +46,9 @@ module Orb
|
|
50
46
|
# @return [String]
|
51
47
|
required :external_entity_id, String
|
52
48
|
|
53
|
-
# @!
|
54
|
-
#
|
55
|
-
#
|
56
|
-
# #
|
57
|
-
# def initialize(external_connection_name:, external_entity_id:, **) = super
|
58
|
-
|
59
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
49
|
+
# @!method initialize(external_connection_name:, external_entity_id:)
|
50
|
+
# @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
|
51
|
+
# @param external_entity_id [String]
|
60
52
|
|
61
53
|
# @see Orb::Models::Item::ExternalConnection#external_connection_name
|
62
54
|
module ExternalConnectionName
|
@@ -70,11 +62,8 @@ module Orb
|
|
70
62
|
AVALARA = :avalara
|
71
63
|
ANROK = :anrok
|
72
64
|
|
73
|
-
|
74
|
-
|
75
|
-
# @!parse
|
76
|
-
# # @return [Array<Symbol>]
|
77
|
-
# def self.values; end
|
65
|
+
# @!method self.values
|
66
|
+
# @return [Array<Symbol>]
|
78
67
|
end
|
79
68
|
end
|
80
69
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Items#create
|
6
6
|
class ItemCreateParams < 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 name
|
@@ -14,13 +13,10 @@ module Orb
|
|
14
13
|
# @return [String]
|
15
14
|
required :name, String
|
16
15
|
|
17
|
-
# @!
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# def initialize(name:, request_options: {}, **) = super
|
22
|
-
|
23
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
16
|
+
# @!method initialize(name:, request_options: {})
|
17
|
+
# @param name [String] The name of the item.
|
18
|
+
#
|
19
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
24
20
|
end
|
25
21
|
end
|
26
22
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Items#fetch
|
6
6
|
class ItemFetchParams < 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::Items#list
|
6
6
|
class ItemListParams < 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,24 +14,22 @@ 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
|
-
# @!
|
25
|
-
#
|
26
|
-
#
|
27
|
-
|
28
|
-
#
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
|
35
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
23
|
+
# @!method initialize(cursor: nil, limit: nil, request_options: {})
|
24
|
+
# Some parameter documentations has been truncated, see
|
25
|
+
# {Orb::Models::ItemListParams} for more details.
|
26
|
+
#
|
27
|
+
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
28
|
+
# ...
|
29
|
+
#
|
30
|
+
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
31
|
+
#
|
32
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
36
33
|
end
|
37
34
|
end
|
38
35
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Items#update
|
6
6
|
class ItemUpdateParams < 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 external_connections
|
@@ -20,14 +19,10 @@ module Orb
|
|
20
19
|
# @return [String, nil]
|
21
20
|
optional :name, String, nil?: true
|
22
21
|
|
23
|
-
# @!
|
24
|
-
#
|
25
|
-
#
|
26
|
-
#
|
27
|
-
# #
|
28
|
-
# def initialize(external_connections: nil, name: nil, request_options: {}, **) = super
|
29
|
-
|
30
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
22
|
+
# @!method initialize(external_connections: nil, name: nil, request_options: {})
|
23
|
+
# @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
|
24
|
+
# @param name [String, nil]
|
25
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
31
26
|
|
32
27
|
class ExternalConnection < Orb::Internal::Type::BaseModel
|
33
28
|
# @!attribute external_connection_name
|
@@ -41,13 +36,9 @@ module Orb
|
|
41
36
|
# @return [String]
|
42
37
|
required :external_entity_id, String
|
43
38
|
|
44
|
-
# @!
|
45
|
-
#
|
46
|
-
#
|
47
|
-
# #
|
48
|
-
# def initialize(external_connection_name:, external_entity_id:, **) = super
|
49
|
-
|
50
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
39
|
+
# @!method initialize(external_connection_name:, external_entity_id:)
|
40
|
+
# @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
|
41
|
+
# @param external_entity_id [String]
|
51
42
|
|
52
43
|
# @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name
|
53
44
|
module ExternalConnectionName
|
@@ -61,11 +52,8 @@ module Orb
|
|
61
52
|
AVALARA = :avalara
|
62
53
|
ANROK = :anrok
|
63
54
|
|
64
|
-
|
65
|
-
|
66
|
-
# @!parse
|
67
|
-
# # @return [Array<Symbol>]
|
68
|
-
# def self.values; end
|
55
|
+
# @!method self.values
|
56
|
+
# @return [Array<Symbol>]
|
69
57
|
end
|
70
58
|
end
|
71
59
|
end
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Metrics#create
|
6
6
|
class MetricCreateParams < 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 description
|
@@ -40,17 +39,22 @@ module Orb
|
|
40
39
|
# @return [Hash{Symbol=>String, nil}, nil]
|
41
40
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
42
41
|
|
43
|
-
# @!
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
|
53
|
-
#
|
42
|
+
# @!method initialize(description:, item_id:, name:, sql:, metadata: nil, request_options: {})
|
43
|
+
# Some parameter documentations has been truncated, see
|
44
|
+
# {Orb::Models::MetricCreateParams} for more details.
|
45
|
+
#
|
46
|
+
# @param description [String, nil] A description of the metric.
|
47
|
+
#
|
48
|
+
# @param item_id [String] The id of the item
|
49
|
+
#
|
50
|
+
# @param name [String] The name of the metric.
|
51
|
+
#
|
52
|
+
# @param sql [String] A sql string defining the metric.
|
53
|
+
#
|
54
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
55
|
+
# ...
|
56
|
+
#
|
57
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
54
58
|
end
|
55
59
|
end
|
56
60
|
end
|
@@ -4,16 +4,11 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Metrics#fetch
|
6
6
|
class MetricFetchParams < 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::Metrics#list
|
6
6
|
class MetricListParams < 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::MetricListParams} 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
|
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Metrics#update
|
6
6
|
class MetricUpdateParams < 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 metadata
|
@@ -16,13 +15,14 @@ module Orb
|
|
16
15
|
# @return [Hash{Symbol=>String, nil}, nil]
|
17
16
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
18
17
|
|
19
|
-
# @!
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
23
|
-
#
|
24
|
-
|
25
|
-
#
|
18
|
+
# @!method initialize(metadata: nil, request_options: {})
|
19
|
+
# Some parameter documentations has been truncated, see
|
20
|
+
# {Orb::Models::MetricUpdateParams} for more details.
|
21
|
+
#
|
22
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
23
|
+
# ...
|
24
|
+
#
|
25
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|