orb-billing 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1706 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +3 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -30,8 +30,8 @@ module Orb
|
|
30
30
|
|
31
31
|
# @!attribute customer
|
32
32
|
#
|
33
|
-
# @return [Orb::
|
34
|
-
required :customer, -> { Orb::
|
33
|
+
# @return [Orb::CreditNote::Customer]
|
34
|
+
required :customer, -> { Orb::CreditNote::Customer }
|
35
35
|
|
36
36
|
# @!attribute invoice_id
|
37
37
|
# The id of the invoice resource that this credit note is applied to.
|
@@ -42,14 +42,14 @@ module Orb
|
|
42
42
|
# @!attribute line_items
|
43
43
|
# All of the line items associated with this credit note.
|
44
44
|
#
|
45
|
-
# @return [Array<Orb::
|
46
|
-
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::
|
45
|
+
# @return [Array<Orb::CreditNote::LineItem>]
|
46
|
+
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem] }
|
47
47
|
|
48
48
|
# @!attribute maximum_amount_adjustment
|
49
49
|
# The maximum amount applied on the original invoice
|
50
50
|
#
|
51
|
-
# @return [Orb::
|
52
|
-
required :maximum_amount_adjustment, -> { Orb::
|
51
|
+
# @return [Orb::CreditNote::MaximumAmountAdjustment, nil]
|
52
|
+
required :maximum_amount_adjustment, -> { Orb::CreditNote::MaximumAmountAdjustment }, nil?: true
|
53
53
|
|
54
54
|
# @!attribute memo
|
55
55
|
# An optional memo supplied on the credit note.
|
@@ -65,8 +65,8 @@ module Orb
|
|
65
65
|
|
66
66
|
# @!attribute reason
|
67
67
|
#
|
68
|
-
# @return [Symbol, Orb::
|
69
|
-
required :reason, enum: -> { Orb::
|
68
|
+
# @return [Symbol, Orb::CreditNote::Reason, nil]
|
69
|
+
required :reason, enum: -> { Orb::CreditNote::Reason }, nil?: true
|
70
70
|
|
71
71
|
# @!attribute subtotal
|
72
72
|
# The total prior to any creditable invoice-level discounts or minimums.
|
@@ -82,8 +82,8 @@ module Orb
|
|
82
82
|
|
83
83
|
# @!attribute type
|
84
84
|
#
|
85
|
-
# @return [Symbol, Orb::
|
86
|
-
required :type, enum: -> { Orb::
|
85
|
+
# @return [Symbol, Orb::CreditNote::Type]
|
86
|
+
required :type, enum: -> { Orb::CreditNote::Type }
|
87
87
|
|
88
88
|
# @!attribute voided_at
|
89
89
|
# The time at which the credit note was voided in Orb, if applicable.
|
@@ -94,8 +94,8 @@ module Orb
|
|
94
94
|
# @!attribute discounts
|
95
95
|
# Any discounts applied on the original invoice.
|
96
96
|
#
|
97
|
-
# @return [Array<Orb::
|
98
|
-
optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::
|
97
|
+
# @return [Array<Orb::CreditNote::Discount>, nil]
|
98
|
+
optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::Discount] }
|
99
99
|
|
100
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
101
|
# The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
|
@@ -109,31 +109,31 @@ module Orb
|
|
109
109
|
#
|
110
110
|
# @param credit_note_pdf [String, nil] A URL to a PDF of the credit note.
|
111
111
|
#
|
112
|
-
# @param customer [Orb::
|
112
|
+
# @param customer [Orb::CreditNote::Customer]
|
113
113
|
#
|
114
114
|
# @param invoice_id [String] The id of the invoice resource that this credit note is applied to.
|
115
115
|
#
|
116
|
-
# @param line_items [Array<Orb::
|
116
|
+
# @param line_items [Array<Orb::CreditNote::LineItem>] All of the line items associated with this credit note.
|
117
117
|
#
|
118
|
-
# @param maximum_amount_adjustment [Orb::
|
118
|
+
# @param maximum_amount_adjustment [Orb::CreditNote::MaximumAmountAdjustment, nil] The maximum amount applied on the original invoice
|
119
119
|
#
|
120
120
|
# @param memo [String, nil] An optional memo supplied on the credit note.
|
121
121
|
#
|
122
122
|
# @param minimum_amount_refunded [String, nil] Any credited amount from the applied minimum on the invoice.
|
123
123
|
#
|
124
|
-
# @param reason [Symbol, Orb::
|
124
|
+
# @param reason [Symbol, Orb::CreditNote::Reason, nil]
|
125
125
|
#
|
126
126
|
# @param subtotal [String] The total prior to any creditable invoice-level discounts or minimums.
|
127
127
|
#
|
128
128
|
# @param total [String] The total including creditable invoice-level discounts or minimums, and tax.
|
129
129
|
#
|
130
|
-
# @param type [Symbol, Orb::
|
130
|
+
# @param type [Symbol, Orb::CreditNote::Type]
|
131
131
|
#
|
132
132
|
# @param voided_at [Time, nil] The time at which the credit note was voided in Orb, if applicable.
|
133
133
|
#
|
134
|
-
# @param discounts [Array<Orb::
|
134
|
+
# @param discounts [Array<Orb::CreditNote::Discount>] Any discounts applied on the original invoice.
|
135
135
|
|
136
|
-
# @see Orb::
|
136
|
+
# @see Orb::CreditNote#customer
|
137
137
|
class Customer < Orb::Internal::Type::BaseModel
|
138
138
|
# @!attribute id
|
139
139
|
#
|
@@ -190,14 +190,14 @@ module Orb
|
|
190
190
|
# @!attribute tax_amounts
|
191
191
|
# Any tax amounts applied onto the line item.
|
192
192
|
#
|
193
|
-
# @return [Array<Orb::
|
194
|
-
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::
|
193
|
+
# @return [Array<Orb::CreditNote::LineItem::TaxAmount>]
|
194
|
+
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem::TaxAmount] }
|
195
195
|
|
196
196
|
# @!attribute discounts
|
197
197
|
# Any line item discounts from the invoice's line item.
|
198
198
|
#
|
199
|
-
# @return [Array<Orb::
|
200
|
-
optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::
|
199
|
+
# @return [Array<Orb::CreditNote::LineItem::Discount>, nil]
|
200
|
+
optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem::Discount] }
|
201
201
|
|
202
202
|
# @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil)
|
203
203
|
# @param id [String] The Orb id of this resource.
|
@@ -212,9 +212,9 @@ module Orb
|
|
212
212
|
#
|
213
213
|
# @param subtotal [String] The amount of the line item, excluding any line item minimums and discounts.
|
214
214
|
#
|
215
|
-
# @param tax_amounts [Array<Orb::
|
215
|
+
# @param tax_amounts [Array<Orb::CreditNote::LineItem::TaxAmount>] Any tax amounts applied onto the line item.
|
216
216
|
#
|
217
|
-
# @param discounts [Array<Orb::
|
217
|
+
# @param discounts [Array<Orb::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
|
218
218
|
|
219
219
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
220
220
|
# @!attribute amount
|
@@ -261,8 +261,8 @@ module Orb
|
|
261
261
|
|
262
262
|
# @!attribute discount_type
|
263
263
|
#
|
264
|
-
# @return [Symbol, Orb::
|
265
|
-
required :discount_type, enum: -> { Orb::
|
264
|
+
# @return [Symbol, Orb::CreditNote::LineItem::Discount::DiscountType]
|
265
|
+
required :discount_type, enum: -> { Orb::CreditNote::LineItem::Discount::DiscountType }
|
266
266
|
|
267
267
|
# @!attribute percentage_discount
|
268
268
|
#
|
@@ -283,12 +283,12 @@ module Orb
|
|
283
283
|
# @param id [String]
|
284
284
|
# @param amount_applied [String]
|
285
285
|
# @param applies_to_price_ids [Array<String>]
|
286
|
-
# @param discount_type [Symbol, Orb::
|
286
|
+
# @param discount_type [Symbol, Orb::CreditNote::LineItem::Discount::DiscountType]
|
287
287
|
# @param percentage_discount [Float]
|
288
288
|
# @param amount_discount [String, nil]
|
289
289
|
# @param reason [String, nil]
|
290
290
|
|
291
|
-
# @see Orb::
|
291
|
+
# @see Orb::CreditNote::LineItem::Discount#discount_type
|
292
292
|
module DiscountType
|
293
293
|
extend Orb::Internal::Type::Enum
|
294
294
|
|
@@ -301,7 +301,7 @@ module Orb
|
|
301
301
|
end
|
302
302
|
end
|
303
303
|
|
304
|
-
# @see Orb::
|
304
|
+
# @see Orb::CreditNote#maximum_amount_adjustment
|
305
305
|
class MaximumAmountAdjustment < Orb::Internal::Type::BaseModel
|
306
306
|
# @!attribute amount_applied
|
307
307
|
#
|
@@ -310,8 +310,8 @@ module Orb
|
|
310
310
|
|
311
311
|
# @!attribute discount_type
|
312
312
|
#
|
313
|
-
# @return [Symbol, Orb::
|
314
|
-
required :discount_type, enum: -> { Orb::
|
313
|
+
# @return [Symbol, Orb::CreditNote::MaximumAmountAdjustment::DiscountType]
|
314
|
+
required :discount_type, enum: -> { Orb::CreditNote::MaximumAmountAdjustment::DiscountType }
|
315
315
|
|
316
316
|
# @!attribute percentage_discount
|
317
317
|
#
|
@@ -320,9 +320,11 @@ module Orb
|
|
320
320
|
|
321
321
|
# @!attribute applies_to_prices
|
322
322
|
#
|
323
|
-
# @return [Array<Orb::
|
323
|
+
# @return [Array<Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
|
324
324
|
optional :applies_to_prices,
|
325
|
-
-> {
|
325
|
+
-> {
|
326
|
+
Orb::Internal::Type::ArrayOf[Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice]
|
327
|
+
},
|
326
328
|
nil?: true
|
327
329
|
|
328
330
|
# @!attribute reason
|
@@ -334,12 +336,12 @@ module Orb
|
|
334
336
|
# The maximum amount applied on the original invoice
|
335
337
|
#
|
336
338
|
# @param amount_applied [String]
|
337
|
-
# @param discount_type [Symbol, Orb::
|
339
|
+
# @param discount_type [Symbol, Orb::CreditNote::MaximumAmountAdjustment::DiscountType]
|
338
340
|
# @param percentage_discount [Float]
|
339
|
-
# @param applies_to_prices [Array<Orb::
|
341
|
+
# @param applies_to_prices [Array<Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice>, nil]
|
340
342
|
# @param reason [String, nil]
|
341
343
|
|
342
|
-
# @see Orb::
|
344
|
+
# @see Orb::CreditNote::MaximumAmountAdjustment#discount_type
|
343
345
|
module DiscountType
|
344
346
|
extend Orb::Internal::Type::Enum
|
345
347
|
|
@@ -366,7 +368,7 @@ module Orb
|
|
366
368
|
end
|
367
369
|
end
|
368
370
|
|
369
|
-
# @see Orb::
|
371
|
+
# @see Orb::CreditNote#reason
|
370
372
|
module Reason
|
371
373
|
extend Orb::Internal::Type::Enum
|
372
374
|
|
@@ -379,7 +381,7 @@ module Orb
|
|
379
381
|
# @return [Array<Symbol>]
|
380
382
|
end
|
381
383
|
|
382
|
-
# @see Orb::
|
384
|
+
# @see Orb::CreditNote#type
|
383
385
|
module Type
|
384
386
|
extend Orb::Internal::Type::Enum
|
385
387
|
|
@@ -398,8 +400,8 @@ module Orb
|
|
398
400
|
|
399
401
|
# @!attribute discount_type
|
400
402
|
#
|
401
|
-
# @return [Symbol, Orb::
|
402
|
-
required :discount_type, enum: -> { Orb::
|
403
|
+
# @return [Symbol, Orb::CreditNote::Discount::DiscountType]
|
404
|
+
required :discount_type, enum: -> { Orb::CreditNote::Discount::DiscountType }
|
403
405
|
|
404
406
|
# @!attribute percentage_discount
|
405
407
|
#
|
@@ -408,9 +410,9 @@ module Orb
|
|
408
410
|
|
409
411
|
# @!attribute applies_to_prices
|
410
412
|
#
|
411
|
-
# @return [Array<Orb::
|
413
|
+
# @return [Array<Orb::CreditNote::Discount::AppliesToPrice>, nil]
|
412
414
|
optional :applies_to_prices,
|
413
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::
|
415
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::Discount::AppliesToPrice] },
|
414
416
|
nil?: true
|
415
417
|
|
416
418
|
# @!attribute reason
|
@@ -420,12 +422,12 @@ module Orb
|
|
420
422
|
|
421
423
|
# @!method initialize(amount_applied:, discount_type:, percentage_discount:, applies_to_prices: nil, reason: nil)
|
422
424
|
# @param amount_applied [String]
|
423
|
-
# @param discount_type [Symbol, Orb::
|
425
|
+
# @param discount_type [Symbol, Orb::CreditNote::Discount::DiscountType]
|
424
426
|
# @param percentage_discount [Float]
|
425
|
-
# @param applies_to_prices [Array<Orb::
|
427
|
+
# @param applies_to_prices [Array<Orb::CreditNote::Discount::AppliesToPrice>, nil]
|
426
428
|
# @param reason [String, nil]
|
427
429
|
|
428
|
-
# @see Orb::
|
430
|
+
# @see Orb::CreditNote::Discount#discount_type
|
429
431
|
module DiscountType
|
430
432
|
extend Orb::Internal::Type::Enum
|
431
433
|
|
@@ -9,8 +9,8 @@ module Orb
|
|
9
9
|
|
10
10
|
# @!attribute line_items
|
11
11
|
#
|
12
|
-
# @return [Array<Orb::
|
13
|
-
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::
|
12
|
+
# @return [Array<Orb::CreditNoteCreateParams::LineItem>]
|
13
|
+
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNoteCreateParams::LineItem] }
|
14
14
|
|
15
15
|
# @!attribute memo
|
16
16
|
# An optional memo to attach to the credit note.
|
@@ -21,15 +21,15 @@ module Orb
|
|
21
21
|
# @!attribute reason
|
22
22
|
# An optional reason for the credit note.
|
23
23
|
#
|
24
|
-
# @return [Symbol, Orb::
|
25
|
-
optional :reason, enum: -> { Orb::
|
24
|
+
# @return [Symbol, Orb::CreditNoteCreateParams::Reason, nil]
|
25
|
+
optional :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }, nil?: true
|
26
26
|
|
27
27
|
# @!method initialize(line_items:, memo: nil, reason: nil, request_options: {})
|
28
|
-
# @param line_items [Array<Orb::
|
28
|
+
# @param line_items [Array<Orb::CreditNoteCreateParams::LineItem>]
|
29
29
|
#
|
30
30
|
# @param memo [String, nil] An optional memo to attach to the credit note.
|
31
31
|
#
|
32
|
-
# @param reason [Symbol, Orb::
|
32
|
+
# @param reason [Symbol, Orb::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
|
33
33
|
#
|
34
34
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
35
35
|
|
data/lib/orb/models/customer.rb
CHANGED
@@ -27,8 +27,8 @@ module Orb
|
|
27
27
|
|
28
28
|
# @!attribute billing_address
|
29
29
|
#
|
30
|
-
# @return [Orb::
|
31
|
-
required :billing_address, -> { Orb::
|
30
|
+
# @return [Orb::Customer::BillingAddress, nil]
|
31
|
+
required :billing_address, -> { Orb::Customer::BillingAddress }, nil?: true
|
32
32
|
|
33
33
|
# @!attribute created_at
|
34
34
|
#
|
@@ -69,8 +69,8 @@ module Orb
|
|
69
69
|
# @!attribute hierarchy
|
70
70
|
# The hierarchical relationships for this customer.
|
71
71
|
#
|
72
|
-
# @return [Orb::
|
73
|
-
required :hierarchy, -> { Orb::
|
72
|
+
# @return [Orb::Customer::Hierarchy]
|
73
|
+
required :hierarchy, -> { Orb::Customer::Hierarchy }
|
74
74
|
|
75
75
|
# @!attribute metadata
|
76
76
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -92,8 +92,8 @@ module Orb
|
|
92
92
|
# When not in test mode, the connection must first be configured in the Orb
|
93
93
|
# webapp.
|
94
94
|
#
|
95
|
-
# @return [Symbol, Orb::
|
96
|
-
required :payment_provider, enum: -> { Orb::
|
95
|
+
# @return [Symbol, Orb::Customer::PaymentProvider, nil]
|
96
|
+
required :payment_provider, enum: -> { Orb::Customer::PaymentProvider }, nil?: true
|
97
97
|
|
98
98
|
# @!attribute payment_provider_id
|
99
99
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
@@ -109,8 +109,8 @@ module Orb
|
|
109
109
|
|
110
110
|
# @!attribute shipping_address
|
111
111
|
#
|
112
|
-
# @return [Orb::
|
113
|
-
required :shipping_address, -> { Orb::
|
112
|
+
# @return [Orb::Customer::ShippingAddress, nil]
|
113
|
+
required :shipping_address, -> { Orb::Customer::ShippingAddress }, nil?: true
|
114
114
|
|
115
115
|
# @!attribute tax_id
|
116
116
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
@@ -219,8 +219,8 @@ module Orb
|
|
219
219
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
220
220
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
221
221
|
#
|
222
|
-
# @return [Orb::
|
223
|
-
required :tax_id, -> { Orb::
|
222
|
+
# @return [Orb::Customer::TaxID, nil]
|
223
|
+
required :tax_id, -> { Orb::Customer::TaxID }, nil?: true
|
224
224
|
|
225
225
|
# @!attribute timezone
|
226
226
|
# A timezone identifier from the IANA timezone database, such as
|
@@ -232,19 +232,17 @@ module Orb
|
|
232
232
|
|
233
233
|
# @!attribute accounting_sync_configuration
|
234
234
|
#
|
235
|
-
# @return [Orb::
|
236
|
-
optional :accounting_sync_configuration,
|
237
|
-
-> { Orb::Models::Customer::AccountingSyncConfiguration },
|
238
|
-
nil?: true
|
235
|
+
# @return [Orb::Customer::AccountingSyncConfiguration, nil]
|
236
|
+
optional :accounting_sync_configuration, -> { Orb::Customer::AccountingSyncConfiguration }, nil?: true
|
239
237
|
|
240
238
|
# @!attribute reporting_configuration
|
241
239
|
#
|
242
|
-
# @return [Orb::
|
243
|
-
optional :reporting_configuration, -> { Orb::
|
240
|
+
# @return [Orb::Customer::ReportingConfiguration, nil]
|
241
|
+
optional :reporting_configuration, -> { Orb::Customer::ReportingConfiguration }, nil?: true
|
244
242
|
|
245
243
|
# @!method initialize(id:, additional_emails:, auto_collection:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, reporting_configuration: nil)
|
246
|
-
# Some parameter documentations has been truncated, see {Orb::
|
247
|
-
#
|
244
|
+
# Some parameter documentations has been truncated, see {Orb::Customer} for more
|
245
|
+
# details.
|
248
246
|
#
|
249
247
|
# A customer is a buyer of your products, and the other party to the billing
|
250
248
|
# relationship.
|
@@ -273,50 +271,43 @@ module Orb
|
|
273
271
|
#
|
274
272
|
# @param balance [String] The customer's current balance in their currency.
|
275
273
|
#
|
276
|
-
# @param billing_address [Orb::
|
274
|
+
# @param billing_address [Orb::Customer::BillingAddress, nil]
|
277
275
|
#
|
278
276
|
# @param created_at [Time]
|
279
277
|
#
|
280
278
|
# @param currency [String, nil]
|
281
279
|
#
|
282
280
|
# @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
|
283
|
-
# ...
|
284
281
|
#
|
285
282
|
# @param email_delivery [Boolean]
|
286
283
|
#
|
287
284
|
# @param exempt_from_automated_tax [Boolean, nil]
|
288
285
|
#
|
289
286
|
# @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
|
290
|
-
# ...
|
291
287
|
#
|
292
|
-
# @param hierarchy [Orb::
|
288
|
+
# @param hierarchy [Orb::Customer::Hierarchy] The hierarchical relationships for this customer.
|
293
289
|
#
|
294
290
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
295
|
-
# ...
|
296
291
|
#
|
297
292
|
# @param name [String] The full name of the customer
|
298
293
|
#
|
299
|
-
# @param payment_provider [Symbol, Orb::
|
300
|
-
# ...
|
294
|
+
# @param payment_provider [Symbol, Orb::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
301
295
|
#
|
302
296
|
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
303
|
-
# ...
|
304
297
|
#
|
305
298
|
# @param portal_url [String, nil]
|
306
299
|
#
|
307
|
-
# @param shipping_address [Orb::
|
300
|
+
# @param shipping_address [Orb::Customer::ShippingAddress, nil]
|
308
301
|
#
|
309
|
-
# @param tax_id [Orb::
|
310
|
-
# ...
|
302
|
+
# @param tax_id [Orb::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
311
303
|
#
|
312
304
|
# @param timezone [String] A timezone identifier from the IANA timezone database, such as "America/Los_Ange
|
313
|
-
# ...
|
314
305
|
#
|
315
|
-
# @param accounting_sync_configuration [Orb::
|
306
|
+
# @param accounting_sync_configuration [Orb::Customer::AccountingSyncConfiguration, nil]
|
316
307
|
#
|
317
|
-
# @param reporting_configuration [Orb::
|
308
|
+
# @param reporting_configuration [Orb::Customer::ReportingConfiguration, nil]
|
318
309
|
|
319
|
-
# @see Orb::
|
310
|
+
# @see Orb::Customer#billing_address
|
320
311
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
321
312
|
# @!attribute city
|
322
313
|
#
|
@@ -357,23 +348,23 @@ module Orb
|
|
357
348
|
# @param state [String, nil]
|
358
349
|
end
|
359
350
|
|
360
|
-
# @see Orb::
|
351
|
+
# @see Orb::Customer#hierarchy
|
361
352
|
class Hierarchy < Orb::Internal::Type::BaseModel
|
362
353
|
# @!attribute children
|
363
354
|
#
|
364
|
-
# @return [Array<Orb::
|
365
|
-
required :children, -> { Orb::Internal::Type::ArrayOf[Orb::
|
355
|
+
# @return [Array<Orb::Customer::Hierarchy::Child>]
|
356
|
+
required :children, -> { Orb::Internal::Type::ArrayOf[Orb::Customer::Hierarchy::Child] }
|
366
357
|
|
367
358
|
# @!attribute parent
|
368
359
|
#
|
369
|
-
# @return [Orb::
|
370
|
-
required :parent, -> { Orb::
|
360
|
+
# @return [Orb::Customer::Hierarchy::Parent, nil]
|
361
|
+
required :parent, -> { Orb::Customer::Hierarchy::Parent }, nil?: true
|
371
362
|
|
372
363
|
# @!method initialize(children:, parent:)
|
373
364
|
# The hierarchical relationships for this customer.
|
374
365
|
#
|
375
|
-
# @param children [Array<Orb::
|
376
|
-
# @param parent [Orb::
|
366
|
+
# @param children [Array<Orb::Customer::Hierarchy::Child>]
|
367
|
+
# @param parent [Orb::Customer::Hierarchy::Parent, nil]
|
377
368
|
|
378
369
|
class Child < Orb::Internal::Type::BaseModel
|
379
370
|
# @!attribute id
|
@@ -391,7 +382,7 @@ module Orb
|
|
391
382
|
# @param external_customer_id [String, nil]
|
392
383
|
end
|
393
384
|
|
394
|
-
# @see Orb::
|
385
|
+
# @see Orb::Customer::Hierarchy#parent
|
395
386
|
class Parent < Orb::Internal::Type::BaseModel
|
396
387
|
# @!attribute id
|
397
388
|
#
|
@@ -413,7 +404,7 @@ module Orb
|
|
413
404
|
# When not in test mode, the connection must first be configured in the Orb
|
414
405
|
# webapp.
|
415
406
|
#
|
416
|
-
# @see Orb::
|
407
|
+
# @see Orb::Customer#payment_provider
|
417
408
|
module PaymentProvider
|
418
409
|
extend Orb::Internal::Type::Enum
|
419
410
|
|
@@ -427,7 +418,7 @@ module Orb
|
|
427
418
|
# @return [Array<Symbol>]
|
428
419
|
end
|
429
420
|
|
430
|
-
# @see Orb::
|
421
|
+
# @see Orb::Customer#shipping_address
|
431
422
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
432
423
|
# @!attribute city
|
433
424
|
#
|
@@ -468,17 +459,17 @@ module Orb
|
|
468
459
|
# @param state [String, nil]
|
469
460
|
end
|
470
461
|
|
471
|
-
# @see Orb::
|
462
|
+
# @see Orb::Customer#tax_id
|
472
463
|
class TaxID < Orb::Internal::Type::BaseModel
|
473
464
|
# @!attribute country
|
474
465
|
#
|
475
|
-
# @return [Symbol, Orb::
|
476
|
-
required :country, enum: -> { Orb::
|
466
|
+
# @return [Symbol, Orb::Customer::TaxID::Country]
|
467
|
+
required :country, enum: -> { Orb::Customer::TaxID::Country }
|
477
468
|
|
478
469
|
# @!attribute type
|
479
470
|
#
|
480
|
-
# @return [Symbol, Orb::
|
481
|
-
required :type, enum: -> { Orb::
|
471
|
+
# @return [Symbol, Orb::Customer::TaxID::Type]
|
472
|
+
required :type, enum: -> { Orb::Customer::TaxID::Type }
|
482
473
|
|
483
474
|
# @!attribute value
|
484
475
|
#
|
@@ -592,11 +583,11 @@ module Orb
|
|
592
583
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
593
584
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
594
585
|
#
|
595
|
-
# @param country [Symbol, Orb::
|
596
|
-
# @param type [Symbol, Orb::
|
586
|
+
# @param country [Symbol, Orb::Customer::TaxID::Country]
|
587
|
+
# @param type [Symbol, Orb::Customer::TaxID::Type]
|
597
588
|
# @param value [String]
|
598
589
|
|
599
|
-
# @see Orb::
|
590
|
+
# @see Orb::Customer::TaxID#country
|
600
591
|
module Country
|
601
592
|
extend Orb::Internal::Type::Enum
|
602
593
|
|
@@ -683,7 +674,7 @@ module Orb
|
|
683
674
|
# @return [Array<Symbol>]
|
684
675
|
end
|
685
676
|
|
686
|
-
# @see Orb::
|
677
|
+
# @see Orb::Customer::TaxID#type
|
687
678
|
module Type
|
688
679
|
extend Orb::Internal::Type::Enum
|
689
680
|
|
@@ -764,13 +755,15 @@ module Orb
|
|
764
755
|
end
|
765
756
|
end
|
766
757
|
|
767
|
-
# @see Orb::
|
758
|
+
# @see Orb::Customer#accounting_sync_configuration
|
768
759
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
769
760
|
# @!attribute accounting_providers
|
770
761
|
#
|
771
|
-
# @return [Array<Orb::
|
762
|
+
# @return [Array<Orb::Customer::AccountingSyncConfiguration::AccountingProvider>]
|
772
763
|
required :accounting_providers,
|
773
|
-
-> {
|
764
|
+
-> {
|
765
|
+
Orb::Internal::Type::ArrayOf[Orb::Customer::AccountingSyncConfiguration::AccountingProvider]
|
766
|
+
}
|
774
767
|
|
775
768
|
# @!attribute excluded
|
776
769
|
#
|
@@ -778,7 +771,7 @@ module Orb
|
|
778
771
|
required :excluded, Orb::Internal::Type::Boolean
|
779
772
|
|
780
773
|
# @!method initialize(accounting_providers:, excluded:)
|
781
|
-
# @param accounting_providers [Array<Orb::
|
774
|
+
# @param accounting_providers [Array<Orb::Customer::AccountingSyncConfiguration::AccountingProvider>]
|
782
775
|
# @param excluded [Boolean]
|
783
776
|
|
784
777
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
@@ -789,15 +782,15 @@ module Orb
|
|
789
782
|
|
790
783
|
# @!attribute provider_type
|
791
784
|
#
|
792
|
-
# @return [Symbol, Orb::
|
785
|
+
# @return [Symbol, Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
|
793
786
|
required :provider_type,
|
794
|
-
enum: -> { Orb::
|
787
|
+
enum: -> { Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType }
|
795
788
|
|
796
789
|
# @!method initialize(external_provider_id:, provider_type:)
|
797
790
|
# @param external_provider_id [String, nil]
|
798
|
-
# @param provider_type [Symbol, Orb::
|
791
|
+
# @param provider_type [Symbol, Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
|
799
792
|
|
800
|
-
# @see Orb::
|
793
|
+
# @see Orb::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type
|
801
794
|
module ProviderType
|
802
795
|
extend Orb::Internal::Type::Enum
|
803
796
|
|
@@ -810,7 +803,7 @@ module Orb
|
|
810
803
|
end
|
811
804
|
end
|
812
805
|
|
813
|
-
# @see Orb::
|
806
|
+
# @see Orb::Customer#reporting_configuration
|
814
807
|
class ReportingConfiguration < Orb::Internal::Type::BaseModel
|
815
808
|
# @!attribute exempt
|
816
809
|
#
|