orb-billing 1.19.0 → 1.20.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a0e9f9d106ba6d107bb06596b005e2e4c621b376df39023df0095d8e22a18ac4
4
- data.tar.gz: f120ab27fa32dd20d14d57de98aa570c3ea0bb661949f94762d76ba766393d97
3
+ metadata.gz: d233a9d1222a0499c1c31d820e16f278d8e3b69b8109a4e85c957d9ae1f9d4e3
4
+ data.tar.gz: 39f6c487d29c575cfce7516bc222e50cf44fa363f4b312cfad0c265935b1ae21
5
5
  SHA512:
6
- metadata.gz: 53d08338a98760e83533d01f385736a61e271af2fe7e041d7d47f8b82bb8b7422fd910398eca0e4bb4943a9886a8a4c7f41dd2cccf37df726004939393588367
7
- data.tar.gz: 7b42d27acda539c3bda1cbd4f80451bb6f1d87a4c4e7a062600cf77e258c98c750939cd8e25b32e50d242942ca8d6080c00e3450cc0fb80b1fd9d8cfa51d7a62
6
+ metadata.gz: 34b5b37a78bcd161a21343120d933c9af2fb30611e885e13a39e583113b8b6c0be29ca15dd682fca7396bb5d4f9fd3ba9ef74b33ad31eeb1f156fd34db564ff5
7
+ data.tar.gz: e302d847f9c0e21da245d3122dc604c3701173627df5397a0166475189f3404ee2bbf2f5f439e17f5894e999fc3e200e84b4e43caf2e2f7c4b825365be0c5140
data/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.20.0](https://github.com/orbcorp/orb-ruby/compare/v1.19.0...v1.20.0) (2026-07-22)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** support `end_of_invoice` effective time for plan version migrations ([305afc4](https://github.com/orbcorp/orb-ruby/commit/305afc4b47e9742a969991774a6f45f68a52bee2))
9
+
3
10
  ## [1.19.0](https://github.com/orbcorp/orb-ruby/compare/v1.18.0...v1.19.0) (2026-07-17)
4
11
 
5
12
 
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "orb-billing", "~> 1.19.0"
18
+ gem "orb-billing", "~> 1.20.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -12,8 +12,9 @@ module Orb
12
12
  required :id, String
13
13
 
14
14
  # @!attribute effective_time
15
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
16
- # when scheduled to be at the end of the current billing period.
15
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
16
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
17
+ # when scheduled to be at the start of the next invoice.
17
18
  #
18
19
  # @return [Date, Time, Symbol, Orb::Models::Plans::MigrationCancelResponse::EffectiveTime, nil]
19
20
  required :effective_time,
@@ -39,14 +40,15 @@ module Orb
39
40
  #
40
41
  # @param id [String] Unique identifier for this plan version change.
41
42
  #
42
- # @param effective_time [Date, Time, Symbol, Orb::Models::Plans::MigrationCancelResponse::EffectiveTime, nil] When the migration takes effect. Can be a specific date/time, or 'end_of_term' w
43
+ # @param effective_time [Date, Time, Symbol, Orb::Models::Plans::MigrationCancelResponse::EffectiveTime, nil] When the migration takes effect. Can be a specific date/time, 'end_of_term' when
43
44
  #
44
45
  # @param plan_id [String] The ID of the plan being migrated.
45
46
  #
46
47
  # @param status [Symbol, Orb::Models::Plans::MigrationCancelResponse::Status] Current status of the migration: 'not_started', 'in_progress', 'completed', 'act
47
48
 
48
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
49
- # when scheduled to be at the end of the current billing period.
49
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
50
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
51
+ # when scheduled to be at the start of the next invoice.
50
52
  #
51
53
  # @see Orb::Models::Plans::MigrationCancelResponse#effective_time
52
54
  module EffectiveTime
@@ -58,6 +60,8 @@ module Orb
58
60
 
59
61
  variant const: -> { Orb::Models::Plans::MigrationCancelResponse::EffectiveTime::END_OF_TERM }
60
62
 
63
+ variant const: -> { Orb::Models::Plans::MigrationCancelResponse::EffectiveTime::END_OF_INVOICE }
64
+
61
65
  # @!method self.variants
62
66
  # @return [Array(Date, Time, Symbol)]
63
67
 
@@ -68,6 +72,7 @@ module Orb
68
72
  # @!group
69
73
 
70
74
  END_OF_TERM = :end_of_term
75
+ END_OF_INVOICE = :end_of_invoice
71
76
 
72
77
  # @!endgroup
73
78
  end
@@ -12,8 +12,9 @@ module Orb
12
12
  required :id, String
13
13
 
14
14
  # @!attribute effective_time
15
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
16
- # when scheduled to be at the end of the current billing period.
15
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
16
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
17
+ # when scheduled to be at the start of the next invoice.
17
18
  #
18
19
  # @return [Date, Time, Symbol, Orb::Models::Plans::MigrationListResponse::EffectiveTime, nil]
19
20
  required :effective_time,
@@ -39,14 +40,15 @@ module Orb
39
40
  #
40
41
  # @param id [String] Unique identifier for this plan version change.
41
42
  #
42
- # @param effective_time [Date, Time, Symbol, Orb::Models::Plans::MigrationListResponse::EffectiveTime, nil] When the migration takes effect. Can be a specific date/time, or 'end_of_term' w
43
+ # @param effective_time [Date, Time, Symbol, Orb::Models::Plans::MigrationListResponse::EffectiveTime, nil] When the migration takes effect. Can be a specific date/time, 'end_of_term' when
43
44
  #
44
45
  # @param plan_id [String] The ID of the plan being migrated.
45
46
  #
46
47
  # @param status [Symbol, Orb::Models::Plans::MigrationListResponse::Status] Current status of the migration: 'not_started', 'in_progress', 'completed', 'act
47
48
 
48
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
49
- # when scheduled to be at the end of the current billing period.
49
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
50
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
51
+ # when scheduled to be at the start of the next invoice.
50
52
  #
51
53
  # @see Orb::Models::Plans::MigrationListResponse#effective_time
52
54
  module EffectiveTime
@@ -58,6 +60,8 @@ module Orb
58
60
 
59
61
  variant const: -> { Orb::Models::Plans::MigrationListResponse::EffectiveTime::END_OF_TERM }
60
62
 
63
+ variant const: -> { Orb::Models::Plans::MigrationListResponse::EffectiveTime::END_OF_INVOICE }
64
+
61
65
  # @!method self.variants
62
66
  # @return [Array(Date, Time, Symbol)]
63
67
 
@@ -68,6 +72,7 @@ module Orb
68
72
  # @!group
69
73
 
70
74
  END_OF_TERM = :end_of_term
75
+ END_OF_INVOICE = :end_of_invoice
71
76
 
72
77
  # @!endgroup
73
78
  end
@@ -12,8 +12,9 @@ module Orb
12
12
  required :id, String
13
13
 
14
14
  # @!attribute effective_time
15
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
16
- # when scheduled to be at the end of the current billing period.
15
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
16
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
17
+ # when scheduled to be at the start of the next invoice.
17
18
  #
18
19
  # @return [Date, Time, Symbol, Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime, nil]
19
20
  required :effective_time,
@@ -39,14 +40,15 @@ module Orb
39
40
  #
40
41
  # @param id [String] Unique identifier for this plan version change.
41
42
  #
42
- # @param effective_time [Date, Time, Symbol, Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime, nil] When the migration takes effect. Can be a specific date/time, or 'end_of_term' w
43
+ # @param effective_time [Date, Time, Symbol, Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime, nil] When the migration takes effect. Can be a specific date/time, 'end_of_term' when
43
44
  #
44
45
  # @param plan_id [String] The ID of the plan being migrated.
45
46
  #
46
47
  # @param status [Symbol, Orb::Models::Plans::MigrationRetrieveResponse::Status] Current status of the migration: 'not_started', 'in_progress', 'completed', 'act
47
48
 
48
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
49
- # when scheduled to be at the end of the current billing period.
49
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
50
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
51
+ # when scheduled to be at the start of the next invoice.
50
52
  #
51
53
  # @see Orb::Models::Plans::MigrationRetrieveResponse#effective_time
52
54
  module EffectiveTime
@@ -58,6 +60,8 @@ module Orb
58
60
 
59
61
  variant const: -> { Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime::END_OF_TERM }
60
62
 
63
+ variant const: -> { Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime::END_OF_INVOICE }
64
+
61
65
  # @!method self.variants
62
66
  # @return [Array(Date, Time, Symbol)]
63
67
 
@@ -68,6 +72,7 @@ module Orb
68
72
  # @!group
69
73
 
70
74
  END_OF_TERM = :end_of_term
75
+ END_OF_INVOICE = :end_of_invoice
71
76
 
72
77
  # @!endgroup
73
78
  end
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.19.0"
4
+ VERSION = "1.20.0"
5
5
  end
@@ -16,8 +16,9 @@ module Orb
16
16
  sig { returns(String) }
17
17
  attr_accessor :id
18
18
 
19
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
20
- # when scheduled to be at the end of the current billing period.
19
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
20
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
21
+ # when scheduled to be at the start of the next invoice.
21
22
  sig do
22
23
  returns(
23
24
  T.nilable(
@@ -59,8 +60,9 @@ module Orb
59
60
  def self.new(
60
61
  # Unique identifier for this plan version change.
61
62
  id:,
62
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
63
- # when scheduled to be at the end of the current billing period.
63
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
64
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
65
+ # when scheduled to be at the start of the next invoice.
64
66
  effective_time:,
65
67
  # The ID of the plan being migrated.
66
68
  plan_id:,
@@ -87,8 +89,9 @@ module Orb
87
89
  def to_hash
88
90
  end
89
91
 
90
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
91
- # when scheduled to be at the end of the current billing period.
92
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
93
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
94
+ # when scheduled to be at the start of the next invoice.
92
95
  module EffectiveTime
93
96
  extend Orb::Internal::Type::Union
94
97
 
@@ -125,6 +128,11 @@ module Orb
125
128
  :end_of_term,
126
129
  Orb::Models::Plans::MigrationCancelResponse::EffectiveTime::TaggedSymbol
127
130
  )
131
+ END_OF_INVOICE =
132
+ T.let(
133
+ :end_of_invoice,
134
+ Orb::Models::Plans::MigrationCancelResponse::EffectiveTime::TaggedSymbol
135
+ )
128
136
  end
129
137
 
130
138
  # Current status of the migration: 'not_started', 'in_progress', 'completed',
@@ -16,8 +16,9 @@ module Orb
16
16
  sig { returns(String) }
17
17
  attr_accessor :id
18
18
 
19
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
20
- # when scheduled to be at the end of the current billing period.
19
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
20
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
21
+ # when scheduled to be at the start of the next invoice.
21
22
  sig do
22
23
  returns(
23
24
  T.nilable(
@@ -58,8 +59,9 @@ module Orb
58
59
  def self.new(
59
60
  # Unique identifier for this plan version change.
60
61
  id:,
61
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
62
- # when scheduled to be at the end of the current billing period.
62
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
63
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
64
+ # when scheduled to be at the start of the next invoice.
63
65
  effective_time:,
64
66
  # The ID of the plan being migrated.
65
67
  plan_id:,
@@ -86,8 +88,9 @@ module Orb
86
88
  def to_hash
87
89
  end
88
90
 
89
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
90
- # when scheduled to be at the end of the current billing period.
91
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
92
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
93
+ # when scheduled to be at the start of the next invoice.
91
94
  module EffectiveTime
92
95
  extend Orb::Internal::Type::Union
93
96
 
@@ -124,6 +127,11 @@ module Orb
124
127
  :end_of_term,
125
128
  Orb::Models::Plans::MigrationListResponse::EffectiveTime::TaggedSymbol
126
129
  )
130
+ END_OF_INVOICE =
131
+ T.let(
132
+ :end_of_invoice,
133
+ Orb::Models::Plans::MigrationListResponse::EffectiveTime::TaggedSymbol
134
+ )
127
135
  end
128
136
 
129
137
  # Current status of the migration: 'not_started', 'in_progress', 'completed',
@@ -16,8 +16,9 @@ module Orb
16
16
  sig { returns(String) }
17
17
  attr_accessor :id
18
18
 
19
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
20
- # when scheduled to be at the end of the current billing period.
19
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
20
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
21
+ # when scheduled to be at the start of the next invoice.
21
22
  sig do
22
23
  returns(
23
24
  T.nilable(
@@ -59,8 +60,9 @@ module Orb
59
60
  def self.new(
60
61
  # Unique identifier for this plan version change.
61
62
  id:,
62
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
63
- # when scheduled to be at the end of the current billing period.
63
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
64
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
65
+ # when scheduled to be at the start of the next invoice.
64
66
  effective_time:,
65
67
  # The ID of the plan being migrated.
66
68
  plan_id:,
@@ -87,8 +89,9 @@ module Orb
87
89
  def to_hash
88
90
  end
89
91
 
90
- # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
91
- # when scheduled to be at the end of the current billing period.
92
+ # When the migration takes effect. Can be a specific date/time, 'end_of_term' when
93
+ # scheduled to be at the end of the current billing period, or 'end_of_invoice'
94
+ # when scheduled to be at the start of the next invoice.
92
95
  module EffectiveTime
93
96
  extend Orb::Internal::Type::Union
94
97
 
@@ -125,6 +128,11 @@ module Orb
125
128
  :end_of_term,
126
129
  Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime::TaggedSymbol
127
130
  )
131
+ END_OF_INVOICE =
132
+ T.let(
133
+ :end_of_invoice,
134
+ Orb::Models::Plans::MigrationRetrieveResponse::EffectiveTime::TaggedSymbol
135
+ )
128
136
  end
129
137
 
130
138
  # Current status of the migration: 'not_started', 'in_progress', 'completed',
@@ -32,7 +32,7 @@ module Orb
32
32
  status: Orb::Models::Plans::MigrationCancelResponse::status
33
33
  }
34
34
 
35
- type effective_time = Date | Time | :end_of_term
35
+ type effective_time = Date | Time | :end_of_term | :end_of_invoice
36
36
 
37
37
  module EffectiveTime
38
38
  extend Orb::Internal::Type::Union
@@ -40,6 +40,7 @@ module Orb
40
40
  def self?.variants: -> ::Array[Orb::Models::Plans::MigrationCancelResponse::effective_time]
41
41
 
42
42
  END_OF_TERM: :end_of_term
43
+ END_OF_INVOICE: :end_of_invoice
43
44
  end
44
45
 
45
46
  type status =
@@ -32,7 +32,7 @@ module Orb
32
32
  status: Orb::Models::Plans::MigrationListResponse::status
33
33
  }
34
34
 
35
- type effective_time = Date | Time | :end_of_term
35
+ type effective_time = Date | Time | :end_of_term | :end_of_invoice
36
36
 
37
37
  module EffectiveTime
38
38
  extend Orb::Internal::Type::Union
@@ -40,6 +40,7 @@ module Orb
40
40
  def self?.variants: -> ::Array[Orb::Models::Plans::MigrationListResponse::effective_time]
41
41
 
42
42
  END_OF_TERM: :end_of_term
43
+ END_OF_INVOICE: :end_of_invoice
43
44
  end
44
45
 
45
46
  type status =
@@ -32,7 +32,7 @@ module Orb
32
32
  status: Orb::Models::Plans::MigrationRetrieveResponse::status
33
33
  }
34
34
 
35
- type effective_time = Date | Time | :end_of_term
35
+ type effective_time = Date | Time | :end_of_term | :end_of_invoice
36
36
 
37
37
  module EffectiveTime
38
38
  extend Orb::Internal::Type::Union
@@ -40,6 +40,7 @@ module Orb
40
40
  def self?.variants: -> ::Array[Orb::Models::Plans::MigrationRetrieveResponse::effective_time]
41
41
 
42
42
  END_OF_TERM: :end_of_term
43
+ END_OF_INVOICE: :end_of_invoice
43
44
  end
44
45
 
45
46
  type status =
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: orb-billing
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.19.0
4
+ version: 1.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb