orb-billing 0.6.0 → 0.8.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.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +4 -0
  5. data/lib/orb/models/{plans/version_create_params.rb → beta/external_plan_id_create_plan_version_params.rb} +1980 -1744
  6. data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +22 -0
  7. data/lib/orb/models/{plans/external_plan_id_set_default_version_params.rb → beta/external_plan_id_set_default_plan_version_params.rb} +3 -3
  8. data/lib/orb/models/beta_create_plan_version_params.rb +17844 -0
  9. data/lib/orb/models/beta_fetch_plan_version_params.rb +20 -0
  10. data/lib/orb/models/{plan_set_default_version_params.rb → beta_set_default_plan_version_params.rb} +2 -2
  11. data/lib/orb/models/plan_version.rb +735 -0
  12. data/lib/orb/models/plan_version_phase.rb +70 -0
  13. data/lib/orb/models/price.rb +1114 -28
  14. data/lib/orb/models/price_evaluate_multiple_params.rb +8620 -0
  15. data/lib/orb/models/price_evaluate_multiple_response.rb +51 -0
  16. data/lib/orb/models/price_evaluate_params.rb +21 -8529
  17. data/lib/orb/models/price_evaluate_response.rb +3 -38
  18. data/lib/orb/models/subscription_create_params.rb +96 -10
  19. data/lib/orb/models/subscription_price_intervals_params.rb +48 -5
  20. data/lib/orb/models/subscription_schedule_plan_change_params.rb +100 -10
  21. data/lib/orb/models.rb +14 -2
  22. data/lib/orb/resources/beta/external_plan_id.rb +113 -0
  23. data/lib/orb/resources/beta.rb +115 -0
  24. data/lib/orb/resources/plans/external_plan_id.rb +0 -31
  25. data/lib/orb/resources/plans.rb +0 -31
  26. data/lib/orb/resources/prices.rb +69 -8
  27. data/lib/orb/version.rb +1 -1
  28. data/lib/orb.rb +12 -12
  29. data/rbi/orb/client.rbi +3 -0
  30. data/rbi/orb/models/{plans/version_create_params.rbi → beta/external_plan_id_create_plan_version_params.rbi} +3042 -2783
  31. data/rbi/orb/models/{plans/version_retrieve_params.rbi → beta/external_plan_id_fetch_plan_version_params.rbi} +10 -7
  32. data/rbi/orb/models/{plans/external_plan_id_set_default_version_params.rbi → beta/external_plan_id_set_default_plan_version_params.rbi} +3 -3
  33. data/rbi/orb/models/beta_create_plan_version_params.rbi +32809 -0
  34. data/rbi/orb/models/beta_fetch_plan_version_params.rbi +35 -0
  35. data/rbi/orb/models/{plan_set_default_version_params.rbi → beta_set_default_plan_version_params.rbi} +2 -2
  36. data/rbi/orb/models/plan_version.rbi +1367 -0
  37. data/rbi/orb/models/plan_version_phase.rbi +99 -0
  38. data/rbi/orb/models/price.rbi +3220 -184
  39. data/rbi/orb/models/price_evaluate_multiple_params.rbi +15764 -0
  40. data/rbi/orb/models/price_evaluate_multiple_response.rbi +96 -0
  41. data/rbi/orb/models/price_evaluate_params.rbi +25 -15684
  42. data/rbi/orb/models/price_evaluate_response.rbi +5 -68
  43. data/rbi/orb/models/subscription_create_params.rbi +226 -12
  44. data/rbi/orb/models/subscription_price_intervals_params.rbi +113 -6
  45. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +226 -12
  46. data/rbi/orb/models.rbi +14 -2
  47. data/rbi/orb/resources/{plans/versions.rbi → beta/external_plan_id.rbi} +42 -15
  48. data/rbi/orb/resources/beta.rbi +111 -0
  49. data/rbi/orb/resources/plans/external_plan_id.rbi +0 -22
  50. data/rbi/orb/resources/plans.rbi +0 -22
  51. data/rbi/orb/resources/prices.rbi +66 -4
  52. data/sig/orb/client.rbs +2 -0
  53. data/sig/orb/models/{plans/version_create_params.rbs → beta/external_plan_id_create_plan_version_params.rbs} +1847 -1771
  54. data/sig/orb/models/{plans/version_retrieve_params.rbs → beta/external_plan_id_fetch_plan_version_params.rbs} +7 -7
  55. data/sig/orb/models/{plans/external_plan_id_set_default_version_params.rbs → beta/external_plan_id_set_default_plan_version_params.rbs} +3 -3
  56. data/sig/orb/models/beta_create_plan_version_params.rbs +12953 -0
  57. data/sig/orb/models/beta_fetch_plan_version_params.rbs +20 -0
  58. data/sig/orb/models/{plan_set_default_version_params.rbs → beta_set_default_plan_version_params.rbs} +2 -2
  59. data/sig/orb/models/plan_version.rbs +583 -0
  60. data/sig/orb/models/plan_version_phase.rbs +60 -0
  61. data/sig/orb/models/price.rbs +1430 -86
  62. data/sig/orb/models/price_evaluate_multiple_params.rbs +6230 -0
  63. data/sig/orb/models/price_evaluate_multiple_response.rbs +50 -0
  64. data/sig/orb/models/price_evaluate_params.rbs +10 -6187
  65. data/sig/orb/models/price_evaluate_response.rbs +4 -41
  66. data/sig/orb/models/subscription_create_params.rbs +84 -8
  67. data/sig/orb/models/subscription_price_intervals_params.rbs +42 -4
  68. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +84 -8
  69. data/sig/orb/models.rbs +14 -2
  70. data/sig/orb/resources/beta/external_plan_id.rbs +34 -0
  71. data/sig/orb/resources/beta.rbs +34 -0
  72. data/sig/orb/resources/plans/external_plan_id.rbs +0 -8
  73. data/sig/orb/resources/plans.rbs +0 -8
  74. data/sig/orb/resources/prices.rbs +13 -2
  75. metadata +38 -38
  76. data/lib/orb/models/plans/external_plan_id/version_create_params.rb +0 -17948
  77. data/lib/orb/models/plans/external_plan_id/version_create_response.rb +0 -819
  78. data/lib/orb/models/plans/external_plan_id/version_retrieve_params.rb +0 -24
  79. data/lib/orb/models/plans/external_plan_id/version_retrieve_response.rb +0 -819
  80. data/lib/orb/models/plans/version_create_response.rb +0 -814
  81. data/lib/orb/models/plans/version_retrieve_params.rb +0 -22
  82. data/lib/orb/models/plans/version_retrieve_response.rb +0 -814
  83. data/lib/orb/resources/plans/external_plan_id/versions.rb +0 -88
  84. data/lib/orb/resources/plans/versions.rb +0 -86
  85. data/rbi/orb/models/plans/external_plan_id/version_create_params.rbi +0 -32668
  86. data/rbi/orb/models/plans/external_plan_id/version_create_response.rbi +0 -1562
  87. data/rbi/orb/models/plans/external_plan_id/version_retrieve_params.rbi +0 -42
  88. data/rbi/orb/models/plans/external_plan_id/version_retrieve_response.rbi +0 -1562
  89. data/rbi/orb/models/plans/version_create_response.rbi +0 -1556
  90. data/rbi/orb/models/plans/version_retrieve_response.rbi +0 -1558
  91. data/rbi/orb/resources/plans/external_plan_id/versions.rbi +0 -103
  92. data/sig/orb/models/plans/external_plan_id/version_create_params.rbs +0 -12923
  93. data/sig/orb/models/plans/external_plan_id/version_create_response.rbs +0 -664
  94. data/sig/orb/models/plans/external_plan_id/version_retrieve_params.rbs +0 -27
  95. data/sig/orb/models/plans/external_plan_id/version_retrieve_response.rbs +0 -664
  96. data/sig/orb/models/plans/version_create_response.rbs +0 -662
  97. data/sig/orb/models/plans/version_retrieve_response.rbs +0 -662
  98. data/sig/orb/resources/plans/external_plan_id/versions.rbs +0 -30
  99. data/sig/orb/resources/plans/versions.rbs +0 -28
@@ -1,88 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Orb
4
- module Resources
5
- class Plans
6
- class ExternalPlanID
7
- class Versions
8
- # This API endpoint is in beta and its interface may change. It is recommended for
9
- # use only in test mode.
10
- #
11
- # This endpoint allows the creation of a new plan version for an existing plan.
12
- #
13
- # @overload create(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: {})
14
- #
15
- # @param external_plan_id [String]
16
- #
17
- # @param version [Integer] New version number.
18
- #
19
- # @param add_adjustments [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.
20
- #
21
- # @param add_prices [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::AddPrice>, nil] Additional prices to be added to the plan.
22
- #
23
- # @param remove_adjustments [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::RemoveAdjustment>, nil] Adjustments to be removed from the plan.
24
- #
25
- # @param remove_prices [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::RemovePrice>, nil] Prices to be removed from the plan.
26
- #
27
- # @param replace_adjustments [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::ReplaceAdjustment>, nil] Adjustments to be replaced with additional adjustments on the plan.
28
- #
29
- # @param replace_prices [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::ReplacePrice>, nil] Prices to be replaced with additional prices on the plan.
30
- #
31
- # @param set_as_default [Boolean, nil] Set this new plan version as the default
32
- #
33
- # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
34
- #
35
- # @return [Orb::Models::Plans::ExternalPlanID::VersionCreateResponse]
36
- #
37
- # @see Orb::Models::Plans::ExternalPlanID::VersionCreateParams
38
- def create(external_plan_id, params)
39
- parsed, options = Orb::Plans::ExternalPlanID::VersionCreateParams.dump_request(params)
40
- @client.request(
41
- method: :post,
42
- path: ["plans/external_plan_id/%1$s/versions", external_plan_id],
43
- body: parsed,
44
- model: Orb::Models::Plans::ExternalPlanID::VersionCreateResponse,
45
- options: options
46
- )
47
- end
48
-
49
- # This API endpoint is in beta and its interface may change. It is recommended for
50
- # use only in test mode.
51
- #
52
- # This endpoint is used to fetch a plan version. It returns the phases, prices,
53
- # and adjustments present on this version of the plan.
54
- #
55
- # @overload retrieve(version, external_plan_id:, request_options: {})
56
- #
57
- # @param version [String]
58
- # @param external_plan_id [String]
59
- # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
60
- #
61
- # @return [Orb::Models::Plans::ExternalPlanID::VersionRetrieveResponse]
62
- #
63
- # @see Orb::Models::Plans::ExternalPlanID::VersionRetrieveParams
64
- def retrieve(version, params)
65
- parsed, options = Orb::Plans::ExternalPlanID::VersionRetrieveParams.dump_request(params)
66
- external_plan_id =
67
- parsed.delete(:external_plan_id) do
68
- raise ArgumentError.new("missing required path argument #{_1}")
69
- end
70
- @client.request(
71
- method: :get,
72
- path: ["plans/external_plan_id/%1$s/versions/%2$s", external_plan_id, version],
73
- model: Orb::Models::Plans::ExternalPlanID::VersionRetrieveResponse,
74
- options: options
75
- )
76
- end
77
-
78
- # @api private
79
- #
80
- # @param client [Orb::Client]
81
- def initialize(client:)
82
- @client = client
83
- end
84
- end
85
- end
86
- end
87
- end
88
- end
@@ -1,86 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Orb
4
- module Resources
5
- class Plans
6
- class Versions
7
- # This API endpoint is in beta and its interface may change. It is recommended for
8
- # use only in test mode.
9
- #
10
- # This endpoint allows the creation of a new plan version for an existing plan.
11
- #
12
- # @overload create(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: {})
13
- #
14
- # @param plan_id [String]
15
- #
16
- # @param version [Integer] New version number.
17
- #
18
- # @param add_adjustments [Array<Orb::Models::Plans::VersionCreateParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.
19
- #
20
- # @param add_prices [Array<Orb::Models::Plans::VersionCreateParams::AddPrice>, nil] Additional prices to be added to the plan.
21
- #
22
- # @param remove_adjustments [Array<Orb::Models::Plans::VersionCreateParams::RemoveAdjustment>, nil] Adjustments to be removed from the plan.
23
- #
24
- # @param remove_prices [Array<Orb::Models::Plans::VersionCreateParams::RemovePrice>, nil] Prices to be removed from the plan.
25
- #
26
- # @param replace_adjustments [Array<Orb::Models::Plans::VersionCreateParams::ReplaceAdjustment>, nil] Adjustments to be replaced with additional adjustments on the plan.
27
- #
28
- # @param replace_prices [Array<Orb::Models::Plans::VersionCreateParams::ReplacePrice>, nil] Prices to be replaced with additional prices on the plan.
29
- #
30
- # @param set_as_default [Boolean, nil] Set this new plan version as the default
31
- #
32
- # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
33
- #
34
- # @return [Orb::Models::Plans::VersionCreateResponse]
35
- #
36
- # @see Orb::Models::Plans::VersionCreateParams
37
- def create(plan_id, params)
38
- parsed, options = Orb::Plans::VersionCreateParams.dump_request(params)
39
- @client.request(
40
- method: :post,
41
- path: ["plans/%1$s/versions", plan_id],
42
- body: parsed,
43
- model: Orb::Models::Plans::VersionCreateResponse,
44
- options: options
45
- )
46
- end
47
-
48
- # This API endpoint is in beta and its interface may change. It is recommended for
49
- # use only in test mode.
50
- #
51
- # This endpoint is used to fetch a plan version. It returns the phases, prices,
52
- # and adjustments present on this version of the plan.
53
- #
54
- # @overload retrieve(version, plan_id:, request_options: {})
55
- #
56
- # @param version [String]
57
- # @param plan_id [String]
58
- # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
59
- #
60
- # @return [Orb::Models::Plans::VersionRetrieveResponse]
61
- #
62
- # @see Orb::Models::Plans::VersionRetrieveParams
63
- def retrieve(version, params)
64
- parsed, options = Orb::Plans::VersionRetrieveParams.dump_request(params)
65
- plan_id =
66
- parsed.delete(:plan_id) do
67
- raise ArgumentError.new("missing required path argument #{_1}")
68
- end
69
- @client.request(
70
- method: :get,
71
- path: ["plans/%1$s/versions/%2$s", plan_id, version],
72
- model: Orb::Models::Plans::VersionRetrieveResponse,
73
- options: options
74
- )
75
- end
76
-
77
- # @api private
78
- #
79
- # @param client [Orb::Client]
80
- def initialize(client:)
81
- @client = client
82
- end
83
- end
84
- end
85
- end
86
- end