orb-billing 1.10.0 → 1.11.1

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.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/customer.rb +139 -100
  5. data/lib/orb/models/customer_create_params.rb +139 -100
  6. data/lib/orb/models/customer_tax_id.rb +214 -102
  7. data/lib/orb/models/customer_update_by_external_id_params.rb +139 -100
  8. data/lib/orb/models/customer_update_params.rb +139 -100
  9. data/lib/orb/models/dimensional_price_group_update_params.rb +38 -0
  10. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +44 -0
  11. data/lib/orb/models/invoice.rb +141 -102
  12. data/lib/orb/models/invoice_fetch_upcoming_response.rb +141 -102
  13. data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
  14. data/lib/orb/models/per_price_cost.rb +2 -2
  15. data/lib/orb/models/plan.rb +2 -2
  16. data/lib/orb/models/plan_version.rb +2 -2
  17. data/lib/orb/models/price.rb +245 -1
  18. data/lib/orb/models/price_interval.rb +2 -2
  19. data/lib/orb/models.rb +2 -0
  20. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +36 -0
  21. data/lib/orb/resources/dimensional_price_groups.rb +31 -0
  22. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  23. data/lib/orb/resources/prices.rb +4 -4
  24. data/lib/orb/version.rb +1 -1
  25. data/lib/orb.rb +2 -0
  26. data/rbi/orb/models/customer.rbi +278 -200
  27. data/rbi/orb/models/customer_create_params.rbi +278 -200
  28. data/rbi/orb/models/customer_tax_id.rbi +214 -102
  29. data/rbi/orb/models/customer_update_by_external_id_params.rbi +278 -200
  30. data/rbi/orb/models/customer_update_params.rbi +278 -200
  31. data/rbi/orb/models/dimensional_price_group_update_params.rbi +61 -0
  32. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +66 -0
  33. data/rbi/orb/models/invoice.rbi +280 -201
  34. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +280 -201
  35. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
  36. data/rbi/orb/models/per_price_cost.rbi +2 -1
  37. data/rbi/orb/models/plan.rbi +2 -1
  38. data/rbi/orb/models/plan_version.rbi +2 -1
  39. data/rbi/orb/models/price.rbi +384 -1
  40. data/rbi/orb/models/price_interval.rbi +2 -1
  41. data/rbi/orb/models.rbi +3 -0
  42. data/rbi/orb/resources/customers.rbi +417 -300
  43. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +26 -0
  44. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -0
  45. data/sig/orb/models/customer_tax_id.rbs +150 -4
  46. data/sig/orb/models/dimensional_price_group_update_params.rbs +31 -0
  47. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +33 -0
  48. data/sig/orb/models/price.rbs +179 -0
  49. data/sig/orb/models.rbs +2 -0
  50. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +7 -0
  51. data/sig/orb/resources/dimensional_price_groups.rbs +7 -0
  52. metadata +8 -2
@@ -73,6 +73,8 @@ module Orb
73
73
 
74
74
  variant :cumulative_grouped_bulk, -> { Orb::Price::CumulativeGroupedBulk }
75
75
 
76
+ variant :grouped_with_min_max_thresholds, -> { Orb::Price::GroupedWithMinMaxThresholds }
77
+
76
78
  class Unit < Orb::Internal::Type::BaseModel
77
79
  # @!attribute id
78
80
  #
@@ -6814,8 +6816,250 @@ module Orb
6814
6816
  end
6815
6817
  end
6816
6818
 
6819
+ class GroupedWithMinMaxThresholds < Orb::Internal::Type::BaseModel
6820
+ # @!attribute id
6821
+ #
6822
+ # @return [String]
6823
+ required :id, String
6824
+
6825
+ # @!attribute billable_metric
6826
+ #
6827
+ # @return [Orb::Models::BillableMetricTiny, nil]
6828
+ required :billable_metric, -> { Orb::BillableMetricTiny }, nil?: true
6829
+
6830
+ # @!attribute billing_cycle_configuration
6831
+ #
6832
+ # @return [Orb::Models::BillingCycleConfiguration]
6833
+ required :billing_cycle_configuration, -> { Orb::BillingCycleConfiguration }
6834
+
6835
+ # @!attribute cadence
6836
+ #
6837
+ # @return [Symbol, Orb::Models::Price::GroupedWithMinMaxThresholds::Cadence]
6838
+ required :cadence, enum: -> { Orb::Price::GroupedWithMinMaxThresholds::Cadence }
6839
+
6840
+ # @!attribute conversion_rate
6841
+ #
6842
+ # @return [Float, nil]
6843
+ required :conversion_rate, Float, nil?: true
6844
+
6845
+ # @!attribute conversion_rate_config
6846
+ #
6847
+ # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
6848
+ required :conversion_rate_config,
6849
+ union: -> { Orb::Price::GroupedWithMinMaxThresholds::ConversionRateConfig },
6850
+ nil?: true
6851
+
6852
+ # @!attribute created_at
6853
+ #
6854
+ # @return [Time]
6855
+ required :created_at, Time
6856
+
6857
+ # @!attribute credit_allocation
6858
+ #
6859
+ # @return [Orb::Models::Allocation, nil]
6860
+ required :credit_allocation, -> { Orb::Allocation }, nil?: true
6861
+
6862
+ # @!attribute currency
6863
+ #
6864
+ # @return [String]
6865
+ required :currency, String
6866
+
6867
+ # @!attribute discount
6868
+ # @deprecated
6869
+ #
6870
+ # @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
6871
+ required :discount, union: -> { Orb::Discount }, nil?: true
6872
+
6873
+ # @!attribute external_price_id
6874
+ #
6875
+ # @return [String, nil]
6876
+ required :external_price_id, String, nil?: true
6877
+
6878
+ # @!attribute fixed_price_quantity
6879
+ #
6880
+ # @return [Float, nil]
6881
+ required :fixed_price_quantity, Float, nil?: true
6882
+
6883
+ # @!attribute grouped_with_min_max_thresholds_config
6884
+ #
6885
+ # @return [Hash{Symbol=>Object}]
6886
+ required :grouped_with_min_max_thresholds_config,
6887
+ Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
6888
+
6889
+ # @!attribute invoicing_cycle_configuration
6890
+ #
6891
+ # @return [Orb::Models::BillingCycleConfiguration, nil]
6892
+ required :invoicing_cycle_configuration, -> { Orb::BillingCycleConfiguration }, nil?: true
6893
+
6894
+ # @!attribute item
6895
+ #
6896
+ # @return [Orb::Models::ItemSlim]
6897
+ required :item, -> { Orb::ItemSlim }
6898
+
6899
+ # @!attribute maximum
6900
+ # @deprecated
6901
+ #
6902
+ # @return [Orb::Models::Maximum, nil]
6903
+ required :maximum, -> { Orb::Maximum }, nil?: true
6904
+
6905
+ # @!attribute maximum_amount
6906
+ # @deprecated
6907
+ #
6908
+ # @return [String, nil]
6909
+ required :maximum_amount, String, nil?: true
6910
+
6911
+ # @!attribute metadata
6912
+ # User specified key-value pairs for the resource. If not present, this defaults
6913
+ # to an empty dictionary. Individual keys can be removed by setting the value to
6914
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
6915
+ # `null`.
6916
+ #
6917
+ # @return [Hash{Symbol=>String}]
6918
+ required :metadata, Orb::Internal::Type::HashOf[String]
6919
+
6920
+ # @!attribute minimum
6921
+ # @deprecated
6922
+ #
6923
+ # @return [Orb::Models::Minimum, nil]
6924
+ required :minimum, -> { Orb::Minimum }, nil?: true
6925
+
6926
+ # @!attribute minimum_amount
6927
+ # @deprecated
6928
+ #
6929
+ # @return [String, nil]
6930
+ required :minimum_amount, String, nil?: true
6931
+
6932
+ # @!attribute model_type
6933
+ #
6934
+ # @return [Symbol, :grouped_with_min_max_thresholds]
6935
+ required :model_type, const: :grouped_with_min_max_thresholds
6936
+
6937
+ # @!attribute name
6938
+ #
6939
+ # @return [String]
6940
+ required :name, String
6941
+
6942
+ # @!attribute plan_phase_order
6943
+ #
6944
+ # @return [Integer, nil]
6945
+ required :plan_phase_order, Integer, nil?: true
6946
+
6947
+ # @!attribute price_type
6948
+ #
6949
+ # @return [Symbol, Orb::Models::Price::GroupedWithMinMaxThresholds::PriceType]
6950
+ required :price_type, enum: -> { Orb::Price::GroupedWithMinMaxThresholds::PriceType }
6951
+
6952
+ # @!attribute replaces_price_id
6953
+ # The price id this price replaces. This price will take the place of the replaced
6954
+ # price in plan version migrations.
6955
+ #
6956
+ # @return [String, nil]
6957
+ required :replaces_price_id, String, nil?: true
6958
+
6959
+ # @!attribute dimensional_price_configuration
6960
+ #
6961
+ # @return [Orb::Models::DimensionalPriceConfiguration, nil]
6962
+ optional :dimensional_price_configuration, -> { Orb::DimensionalPriceConfiguration }, nil?: true
6963
+
6964
+ # @!method initialize(id:, billable_metric:, billing_cycle_configuration:, cadence:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_min_max_thresholds_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, model_type: :grouped_with_min_max_thresholds)
6965
+ # Some parameter documentations has been truncated, see
6966
+ # {Orb::Models::Price::GroupedWithMinMaxThresholds} for more details.
6967
+ #
6968
+ # @param id [String]
6969
+ #
6970
+ # @param billable_metric [Orb::Models::BillableMetricTiny, nil]
6971
+ #
6972
+ # @param billing_cycle_configuration [Orb::Models::BillingCycleConfiguration]
6973
+ #
6974
+ # @param cadence [Symbol, Orb::Models::Price::GroupedWithMinMaxThresholds::Cadence]
6975
+ #
6976
+ # @param conversion_rate [Float, nil]
6977
+ #
6978
+ # @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
6979
+ #
6980
+ # @param created_at [Time]
6981
+ #
6982
+ # @param credit_allocation [Orb::Models::Allocation, nil]
6983
+ #
6984
+ # @param currency [String]
6985
+ #
6986
+ # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
6987
+ #
6988
+ # @param external_price_id [String, nil]
6989
+ #
6990
+ # @param fixed_price_quantity [Float, nil]
6991
+ #
6992
+ # @param grouped_with_min_max_thresholds_config [Hash{Symbol=>Object}]
6993
+ #
6994
+ # @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
6995
+ #
6996
+ # @param item [Orb::Models::ItemSlim]
6997
+ #
6998
+ # @param maximum [Orb::Models::Maximum, nil]
6999
+ #
7000
+ # @param maximum_amount [String, nil]
7001
+ #
7002
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
7003
+ #
7004
+ # @param minimum [Orb::Models::Minimum, nil]
7005
+ #
7006
+ # @param minimum_amount [String, nil]
7007
+ #
7008
+ # @param name [String]
7009
+ #
7010
+ # @param plan_phase_order [Integer, nil]
7011
+ #
7012
+ # @param price_type [Symbol, Orb::Models::Price::GroupedWithMinMaxThresholds::PriceType]
7013
+ #
7014
+ # @param replaces_price_id [String, nil] The price id this price replaces. This price will take the place of the replaced
7015
+ #
7016
+ # @param dimensional_price_configuration [Orb::Models::DimensionalPriceConfiguration, nil]
7017
+ #
7018
+ # @param model_type [Symbol, :grouped_with_min_max_thresholds]
7019
+
7020
+ # @see Orb::Models::Price::GroupedWithMinMaxThresholds#cadence
7021
+ module Cadence
7022
+ extend Orb::Internal::Type::Enum
7023
+
7024
+ ONE_TIME = :one_time
7025
+ MONTHLY = :monthly
7026
+ QUARTERLY = :quarterly
7027
+ SEMI_ANNUAL = :semi_annual
7028
+ ANNUAL = :annual
7029
+ CUSTOM = :custom
7030
+
7031
+ # @!method self.values
7032
+ # @return [Array<Symbol>]
7033
+ end
7034
+
7035
+ # @see Orb::Models::Price::GroupedWithMinMaxThresholds#conversion_rate_config
7036
+ module ConversionRateConfig
7037
+ extend Orb::Internal::Type::Union
7038
+
7039
+ discriminator :conversion_rate_type
7040
+
7041
+ variant :unit, -> { Orb::UnitConversionRateConfig }
7042
+
7043
+ variant :tiered, -> { Orb::TieredConversionRateConfig }
7044
+
7045
+ # @!method self.variants
7046
+ # @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
7047
+ end
7048
+
7049
+ # @see Orb::Models::Price::GroupedWithMinMaxThresholds#price_type
7050
+ module PriceType
7051
+ extend Orb::Internal::Type::Enum
7052
+
7053
+ USAGE_PRICE = :usage_price
7054
+ FIXED_PRICE = :fixed_price
7055
+
7056
+ # @!method self.values
7057
+ # @return [Array<Symbol>]
7058
+ end
7059
+ end
7060
+
6817
7061
  # @!method self.variants
6818
- # @return [Array(Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk)]
7062
+ # @return [Array(Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds)]
6819
7063
  end
6820
7064
  end
6821
7065
  end
@@ -64,7 +64,7 @@ module Orb
64
64
  # For more on the types of prices, see
65
65
  # [the core concepts documentation](/core-concepts#plan-and-price)
66
66
  #
67
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
67
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds]
68
68
  required :price, union: -> { Orb::Price }
69
69
 
70
70
  # @!attribute start_date
@@ -103,7 +103,7 @@ module Orb
103
103
  #
104
104
  # @param fixed_fee_quantity_transitions [Array<Orb::Models::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
105
105
  #
106
- # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
106
+ # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds] The Price resource represents a price that can be billed on a subscription, resu
107
107
  #
108
108
  # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
109
109
  #
data/lib/orb/models.rb CHANGED
@@ -180,6 +180,8 @@ module Orb
180
180
 
181
181
  DimensionalPriceGroupsAPI = Orb::Models::DimensionalPriceGroupsAPI
182
182
 
183
+ DimensionalPriceGroupUpdateParams = Orb::Models::DimensionalPriceGroupUpdateParams
184
+
183
185
  Discount = Orb::Models::Discount
184
186
 
185
187
  DiscountOverride = Orb::Models::DiscountOverride
@@ -26,6 +26,42 @@ module Orb
26
26
  )
27
27
  end
28
28
 
29
+ # Some parameter documentations has been truncated, see
30
+ # {Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams}
31
+ # for more details.
32
+ #
33
+ # This endpoint can be used to update the `external_dimensional_price_group_id`
34
+ # and `metadata` of an existing dimensional price group. Other fields on a
35
+ # dimensional price group are currently immutable.
36
+ #
37
+ # @overload update(path_external_dimensional_price_group_id, body_external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
38
+ #
39
+ # @param path_external_dimensional_price_group_id [String]
40
+ #
41
+ # @param body_external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
42
+ #
43
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
44
+ #
45
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
46
+ #
47
+ # @return [Orb::Models::DimensionalPriceGroup]
48
+ #
49
+ # @see Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams
50
+ def update(path_external_dimensional_price_group_id, params = {})
51
+ parsed, options =
52
+ Orb::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams.dump_request(params)
53
+ @client.request(
54
+ method: :put,
55
+ path: [
56
+ "dimensional_price_groups/external_dimensional_price_group_id/%1$s",
57
+ path_external_dimensional_price_group_id
58
+ ],
59
+ body: parsed,
60
+ model: Orb::DimensionalPriceGroup,
61
+ options: options
62
+ )
63
+ end
64
+
29
65
  # @api private
30
66
  #
31
67
  # @param client [Orb::Client]
@@ -65,6 +65,37 @@ module Orb
65
65
  )
66
66
  end
67
67
 
68
+ # Some parameter documentations has been truncated, see
69
+ # {Orb::Models::DimensionalPriceGroupUpdateParams} for more details.
70
+ #
71
+ # This endpoint can be used to update the `external_dimensional_price_group_id`
72
+ # and `metadata` of an existing dimensional price group. Other fields on a
73
+ # dimensional price group are currently immutable.
74
+ #
75
+ # @overload update(dimensional_price_group_id, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
76
+ #
77
+ # @param dimensional_price_group_id [String]
78
+ #
79
+ # @param external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
80
+ #
81
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
82
+ #
83
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
84
+ #
85
+ # @return [Orb::Models::DimensionalPriceGroup]
86
+ #
87
+ # @see Orb::Models::DimensionalPriceGroupUpdateParams
88
+ def update(dimensional_price_group_id, params = {})
89
+ parsed, options = Orb::DimensionalPriceGroupUpdateParams.dump_request(params)
90
+ @client.request(
91
+ method: :put,
92
+ path: ["dimensional_price_groups/%1$s", dimensional_price_group_id],
93
+ body: parsed,
94
+ model: Orb::DimensionalPriceGroup,
95
+ options: options
96
+ )
97
+ end
98
+
68
99
  # Some parameter documentations has been truncated, see
69
100
  # {Orb::Models::DimensionalPriceGroupListParams} for more details.
70
101
  #
@@ -19,7 +19,7 @@ module Orb
19
19
  #
20
20
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
21
21
  #
22
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
22
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds]
23
23
  #
24
24
  # @see Orb::Models::Prices::ExternalPriceIDUpdateParams
25
25
  def update(external_price_id, params = {})
@@ -42,7 +42,7 @@ module Orb
42
42
  # @param external_price_id [String]
43
43
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
44
44
  #
45
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
45
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds]
46
46
  #
47
47
  # @see Orb::Models::Prices::ExternalPriceIDFetchParams
48
48
  def fetch(external_price_id, params = {})
@@ -112,7 +112,7 @@ module Orb
112
112
  #
113
113
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
114
114
  #
115
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
115
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds]
116
116
  #
117
117
  # @see Orb::Models::PriceCreateParams
118
118
  def create(params)
@@ -135,7 +135,7 @@ module Orb
135
135
  #
136
136
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
137
137
  #
138
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
138
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds]
139
139
  #
140
140
  # @see Orb::Models::PriceUpdateParams
141
141
  def update(price_id, params = {})
@@ -163,7 +163,7 @@ module Orb
163
163
  #
164
164
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
165
165
  #
166
- # @return [Orb::Internal::Page<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>]
166
+ # @return [Orb::Internal::Page<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds>]
167
167
  #
168
168
  # @see Orb::Models::PriceListParams
169
169
  def list(params = {})
@@ -353,7 +353,7 @@ module Orb
353
353
  # @param price_id [String]
354
354
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
355
355
  #
356
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
356
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds]
357
357
  #
358
358
  # @see Orb::Models::PriceFetchParams
359
359
  def fetch(price_id, params = {})
data/lib/orb/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Orb
4
- VERSION = "1.10.0"
4
+ VERSION = "1.11.1"
5
5
  end
data/lib/orb.rb CHANGED
@@ -160,7 +160,9 @@ require_relative "orb/models/dimensional_price_group_create_params"
160
160
  require_relative "orb/models/dimensional_price_group_list_params"
161
161
  require_relative "orb/models/dimensional_price_group_retrieve_params"
162
162
  require_relative "orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params"
163
+ require_relative "orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params"
163
164
  require_relative "orb/models/dimensional_price_groups"
165
+ require_relative "orb/models/dimensional_price_group_update_params"
164
166
  require_relative "orb/models/discount"
165
167
  require_relative "orb/models/discount_override"
166
168
  require_relative "orb/models/evaluate_price_group"