Skip to content

Commit 8a52368

Browse files
fix(client): add types for path params, and update structure of unions nested in params
1 parent a865cea commit 8a52368

314 files changed

Lines changed: 9392 additions & 7818 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

lib/orb/models/alert_create_for_customer_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10+
# @!attribute customer_id
11+
#
12+
# @return [String]
13+
required :customer_id, String
14+
1015
# @!attribute currency
1116
# The case sensitive currency or custom pricing unit to use for this alert.
1217
#
@@ -25,7 +30,9 @@ class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel
2530
# @return [Array<Orb::Models::Threshold>, nil]
2631
optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
2732

28-
# @!method initialize(currency:, type:, thresholds: nil, request_options: {})
33+
# @!method initialize(customer_id:, currency:, type:, thresholds: nil, request_options: {})
34+
# @param customer_id [String]
35+
#
2936
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
3037
#
3138
# @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.

lib/orb/models/alert_create_for_external_customer_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10+
# @!attribute external_customer_id
11+
#
12+
# @return [String]
13+
required :external_customer_id, String
14+
1015
# @!attribute currency
1116
# The case sensitive currency or custom pricing unit to use for this alert.
1217
#
@@ -25,7 +30,9 @@ class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel
2530
# @return [Array<Orb::Models::Threshold>, nil]
2631
optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
2732

28-
# @!method initialize(currency:, type:, thresholds: nil, request_options: {})
33+
# @!method initialize(external_customer_id:, currency:, type:, thresholds: nil, request_options: {})
34+
# @param external_customer_id [String]
35+
#
2936
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
3037
#
3138
# @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.

lib/orb/models/alert_create_for_subscription_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10+
# @!attribute subscription_id
11+
#
12+
# @return [String]
13+
required :subscription_id, String
14+
1015
# @!attribute thresholds
1116
# The thresholds that define the values at which the alert will be triggered.
1217
#
@@ -25,7 +30,9 @@ class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel
2530
# @return [String, nil]
2631
optional :metric_id, String, nil?: true
2732

28-
# @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
33+
# @!method initialize(subscription_id:, thresholds:, type:, metric_id: nil, request_options: {})
34+
# @param subscription_id [String]
35+
#
2936
# @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
3037
#
3138
# @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.

lib/orb/models/alert_disable_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,20 @@ class AlertDisableParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10+
# @!attribute alert_configuration_id
11+
#
12+
# @return [String]
13+
required :alert_configuration_id, String
14+
1015
# @!attribute subscription_id
1116
# Used to update the status of a plan alert scoped to this subscription_id
1217
#
1318
# @return [String, nil]
1419
optional :subscription_id, String, nil?: true
1520

16-
# @!method initialize(subscription_id: nil, request_options: {})
21+
# @!method initialize(alert_configuration_id:, subscription_id: nil, request_options: {})
22+
# @param alert_configuration_id [String]
23+
#
1724
# @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
1825
#
1926
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

lib/orb/models/alert_enable_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,20 @@ class AlertEnableParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10+
# @!attribute alert_configuration_id
11+
#
12+
# @return [String]
13+
required :alert_configuration_id, String
14+
1015
# @!attribute subscription_id
1116
# Used to update the status of a plan alert scoped to this subscription_id
1217
#
1318
# @return [String, nil]
1419
optional :subscription_id, String, nil?: true
1520

16-
# @!method initialize(subscription_id: nil, request_options: {})
21+
# @!method initialize(alert_configuration_id:, subscription_id: nil, request_options: {})
22+
# @param alert_configuration_id [String]
23+
#
1724
# @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
1825
#
1926
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

lib/orb/models/alert_retrieve_params.rb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ class AlertRetrieveParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10-
# @!method initialize(request_options: {})
10+
# @!attribute alert_id
11+
#
12+
# @return [String]
13+
required :alert_id, String
14+
15+
# @!method initialize(alert_id:, request_options: {})
16+
# @param alert_id [String]
1117
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
1218
end
1319
end

lib/orb/models/alert_update_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,20 @@ class AlertUpdateParams < Orb::Internal::Type::BaseModel
77
extend Orb::Internal::Type::RequestParameters::Converter
88
include Orb::Internal::Type::RequestParameters
99

10+
# @!attribute alert_configuration_id
11+
#
12+
# @return [String]
13+
required :alert_configuration_id, String
14+
1015
# @!attribute thresholds
1116
# The thresholds that define the values at which the alert will be triggered.
1217
#
1318
# @return [Array<Orb::Models::Threshold>]
1419
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
1520

16-
# @!method initialize(thresholds:, request_options: {})
21+
# @!method initialize(alert_configuration_id:, thresholds:, request_options: {})
22+
# @param alert_configuration_id [String]
23+
#
1724
# @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
1825
#
1926
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

lib/orb/models/beta/external_plan_id_create_plan_version_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ class ExternalPlanIDCreatePlanVersionParams < Orb::Internal::Type::BaseModel
88
extend Orb::Internal::Type::RequestParameters::Converter
99
include Orb::Internal::Type::RequestParameters
1010

11+
# @!attribute external_plan_id
12+
#
13+
# @return [String]
14+
required :external_plan_id, String
15+
1116
# @!attribute version
1217
# New version number.
1318
#
@@ -80,7 +85,9 @@ class ExternalPlanIDCreatePlanVersionParams < Orb::Internal::Type::BaseModel
8085
# @return [Boolean, nil]
8186
optional :set_as_default, Orb::Internal::Type::Boolean, nil?: true
8287

83-
# @!method initialize(version:, add_adjustments: nil, add_prices: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, set_as_default: nil, request_options: {})
88+
# @!method initialize(external_plan_id:, version:, add_adjustments: nil, add_prices: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, set_as_default: nil, request_options: {})
89+
# @param external_plan_id [String]
90+
#
8491
# @param version [Integer] New version number.
8592
#
8693
# @param add_adjustments [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.

lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,14 @@ class ExternalPlanIDFetchPlanVersionParams < Orb::Internal::Type::BaseModel
1313
# @return [String]
1414
required :external_plan_id, String
1515

16-
# @!method initialize(external_plan_id:, request_options: {})
16+
# @!attribute version
17+
#
18+
# @return [String]
19+
required :version, String
20+
21+
# @!method initialize(external_plan_id:, version:, request_options: {})
1722
# @param external_plan_id [String]
23+
# @param version [String]
1824
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
1925
end
2026
end

lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,20 @@ class ExternalPlanIDSetDefaultPlanVersionParams < Orb::Internal::Type::BaseModel
88
extend Orb::Internal::Type::RequestParameters::Converter
99
include Orb::Internal::Type::RequestParameters
1010

11+
# @!attribute external_plan_id
12+
#
13+
# @return [String]
14+
required :external_plan_id, String
15+
1116
# @!attribute version
1217
# Plan version to set as the default.
1318
#
1419
# @return [Integer]
1520
required :version, Integer
1621

17-
# @!method initialize(version:, request_options: {})
22+
# @!method initialize(external_plan_id:, version:, request_options: {})
23+
# @param external_plan_id [String]
24+
#
1825
# @param version [Integer] Plan version to set as the default.
1926
#
2027
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

0 commit comments

Comments
 (0)