orb-billing 1.3.0 → 1.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b601ed5d994e78179694f51ebc0ba0b5311d69b34f79b2e7892c58041578856f
4
- data.tar.gz: a9b90fc941c06f7d73fd7ef1f4d14da454f565141f810477578fe12734c49149
3
+ metadata.gz: 6e7f25205b033d46508378764f840f594c62acb9f46a6bb989f0ea20d177bf2b
4
+ data.tar.gz: 598f87e26fab3f0b3e9edeb2e2667429c88895c632e3e7c54e6f52dfdf76d6b4
5
5
  SHA512:
6
- metadata.gz: c17d93b30ccf78c9470d9afcf4b17c1e50e28eea2fb0e185ef9cd6096fbfffcb46f87f851e4df7e7917e3d15bc46f88f9809dadd980e1ac75a330c3000b4109a
7
- data.tar.gz: 14c41428f656ba2549fc47c7f0d726abaa5650d659f06360e21a17116ce4a408b2a93b16c823182e8e323ac165b3b281e08971cf8f570fc51fed2feed3552afd
6
+ metadata.gz: '087918f6d861957f73c7d09be955a1f6096d97771b862266aa161f0884c18f7630facb1a94dea52d2106ec54bd17c9a87e2abca5a5f75a07ccdb9132574cd932'
7
+ data.tar.gz: c4f7448384c68735ec92d6a72e8bd667b535b8116db52c3a00fa83a0439317114e3812ad3ebe77be02f1ab56579ccd5033fecca764851a04b40a66e5877d45c0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.4.0 (2025-07-08)
4
+
5
+ Full Changelog: [v1.3.0...v1.4.0](https://github.com/orbcorp/orb-ruby/compare/v1.3.0...v1.4.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([91c8454](https://github.com/orbcorp/orb-ruby/commit/91c8454800efbd06d7a4c4c3e6ded006c838dc57))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** version bump ([be85139](https://github.com/orbcorp/orb-ruby/commit/be85139284c0f58aec01dd53cad4c11e4644171c))
15
+
3
16
  ## 1.3.0 (2025-07-04)
4
17
 
5
18
  Full Changelog: [v1.2.2...v1.3.0](https://github.com/orbcorp/orb-ruby/compare/v1.2.2...v1.3.0)
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.3.0"
18
+ gem "orb-billing", "~> 1.4.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -156,6 +156,18 @@ module Orb
156
156
  # @return [Integer]
157
157
  required :net_terms, Integer
158
158
 
159
+ # @!attribute invoice_date
160
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
161
+ # customer's timezone. If not provided, the invoice date will default to the
162
+ # credit block's effective date.
163
+ #
164
+ # @return [Date, Time, nil]
165
+ optional :invoice_date,
166
+ union: -> {
167
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate
168
+ },
169
+ nil?: true
170
+
159
171
  # @!attribute memo
160
172
  # An optional memo to display on the invoice.
161
173
  #
@@ -169,7 +181,7 @@ module Orb
169
181
  # @return [Boolean, nil]
170
182
  optional :require_successful_payment, Orb::Internal::Type::Boolean
171
183
 
172
- # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
184
+ # @!method initialize(auto_collection:, net_terms:, invoice_date: nil, memo: nil, require_successful_payment: nil)
173
185
  # Some parameter documentations has been truncated, see
174
186
  # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
175
187
  # for more details.
@@ -183,9 +195,27 @@ module Orb
183
195
  #
184
196
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
185
197
  #
198
+ # @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
199
+ #
186
200
  # @param memo [String, nil] An optional memo to display on the invoice.
187
201
  #
188
202
  # @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
203
+
204
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
205
+ # customer's timezone. If not provided, the invoice date will default to the
206
+ # credit block's effective date.
207
+ #
208
+ # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings#invoice_date
209
+ module InvoiceDate
210
+ extend Orb::Internal::Type::Union
211
+
212
+ variant Date
213
+
214
+ variant Time
215
+
216
+ # @!method self.variants
217
+ # @return [Array(Date, Time)]
218
+ end
189
219
  end
190
220
 
191
221
  # Can only be specified when `entry_type=void`. The reason for the void.
@@ -152,6 +152,18 @@ module Orb
152
152
  # @return [Integer]
153
153
  required :net_terms, Integer
154
154
 
155
+ # @!attribute invoice_date
156
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
157
+ # customer's timezone. If not provided, the invoice date will default to the
158
+ # credit block's effective date.
159
+ #
160
+ # @return [Date, Time, nil]
161
+ optional :invoice_date,
162
+ union: -> {
163
+ Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate
164
+ },
165
+ nil?: true
166
+
155
167
  # @!attribute memo
156
168
  # An optional memo to display on the invoice.
157
169
  #
@@ -165,7 +177,7 @@ module Orb
165
177
  # @return [Boolean, nil]
166
178
  optional :require_successful_payment, Orb::Internal::Type::Boolean
167
179
 
168
- # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
180
+ # @!method initialize(auto_collection:, net_terms:, invoice_date: nil, memo: nil, require_successful_payment: nil)
169
181
  # Some parameter documentations has been truncated, see
170
182
  # {Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for
171
183
  # more details.
@@ -179,9 +191,27 @@ module Orb
179
191
  #
180
192
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
181
193
  #
194
+ # @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
195
+ #
182
196
  # @param memo [String, nil] An optional memo to display on the invoice.
183
197
  #
184
198
  # @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
199
+
200
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
201
+ # customer's timezone. If not provided, the invoice date will default to the
202
+ # credit block's effective date.
203
+ #
204
+ # @see Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings#invoice_date
205
+ module InvoiceDate
206
+ extend Orb::Internal::Type::Union
207
+
208
+ variant Date
209
+
210
+ variant Time
211
+
212
+ # @!method self.variants
213
+ # @return [Array(Date, Time)]
214
+ end
185
215
  end
186
216
 
187
217
  # Can only be specified when `entry_type=void`. The reason for the void.
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.3.0"
4
+ VERSION = "1.4.0"
5
5
  end
@@ -245,6 +245,18 @@ module Orb
245
245
  sig { returns(Integer) }
246
246
  attr_accessor :net_terms
247
247
 
248
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
249
+ # customer's timezone. If not provided, the invoice date will default to the
250
+ # credit block's effective date.
251
+ sig do
252
+ returns(
253
+ T.nilable(
254
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate::Variants
255
+ )
256
+ )
257
+ end
258
+ attr_accessor :invoice_date
259
+
248
260
  # An optional memo to display on the invoice.
249
261
  sig { returns(T.nilable(String)) }
250
262
  attr_accessor :memo
@@ -265,6 +277,10 @@ module Orb
265
277
  params(
266
278
  auto_collection: T::Boolean,
267
279
  net_terms: Integer,
280
+ invoice_date:
281
+ T.nilable(
282
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate::Variants
283
+ ),
268
284
  memo: T.nilable(String),
269
285
  require_successful_payment: T::Boolean
270
286
  ).returns(T.attached_class)
@@ -277,6 +293,10 @@ module Orb
277
293
  # date for the invoice. If you intend the invoice to be due on issue, set this
278
294
  # to 0.
279
295
  net_terms:,
296
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
297
+ # customer's timezone. If not provided, the invoice date will default to the
298
+ # credit block's effective date.
299
+ invoice_date: nil,
280
300
  # An optional memo to display on the invoice.
281
301
  memo: nil,
282
302
  # If true, the new credit block will require that the corresponding invoice is
@@ -290,6 +310,10 @@ module Orb
290
310
  {
291
311
  auto_collection: T::Boolean,
292
312
  net_terms: Integer,
313
+ invoice_date:
314
+ T.nilable(
315
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate::Variants
316
+ ),
293
317
  memo: T.nilable(String),
294
318
  require_successful_payment: T::Boolean
295
319
  }
@@ -297,6 +321,25 @@ module Orb
297
321
  end
298
322
  def to_hash
299
323
  end
324
+
325
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
326
+ # customer's timezone. If not provided, the invoice date will default to the
327
+ # credit block's effective date.
328
+ module InvoiceDate
329
+ extend Orb::Internal::Type::Union
330
+
331
+ Variants = T.type_alias { T.any(Date, Time) }
332
+
333
+ sig do
334
+ override.returns(
335
+ T::Array[
336
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate::Variants
337
+ ]
338
+ )
339
+ end
340
+ def self.variants
341
+ end
342
+ end
300
343
  end
301
344
 
302
345
  # Can only be specified when `entry_type=void`. The reason for the void.
@@ -245,6 +245,18 @@ module Orb
245
245
  sig { returns(Integer) }
246
246
  attr_accessor :net_terms
247
247
 
248
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
249
+ # customer's timezone. If not provided, the invoice date will default to the
250
+ # credit block's effective date.
251
+ sig do
252
+ returns(
253
+ T.nilable(
254
+ Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate::Variants
255
+ )
256
+ )
257
+ end
258
+ attr_accessor :invoice_date
259
+
248
260
  # An optional memo to display on the invoice.
249
261
  sig { returns(T.nilable(String)) }
250
262
  attr_accessor :memo
@@ -265,6 +277,10 @@ module Orb
265
277
  params(
266
278
  auto_collection: T::Boolean,
267
279
  net_terms: Integer,
280
+ invoice_date:
281
+ T.nilable(
282
+ Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate::Variants
283
+ ),
268
284
  memo: T.nilable(String),
269
285
  require_successful_payment: T::Boolean
270
286
  ).returns(T.attached_class)
@@ -277,6 +293,10 @@ module Orb
277
293
  # date for the invoice. If you intend the invoice to be due on issue, set this
278
294
  # to 0.
279
295
  net_terms:,
296
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
297
+ # customer's timezone. If not provided, the invoice date will default to the
298
+ # credit block's effective date.
299
+ invoice_date: nil,
280
300
  # An optional memo to display on the invoice.
281
301
  memo: nil,
282
302
  # If true, the new credit block will require that the corresponding invoice is
@@ -290,6 +310,10 @@ module Orb
290
310
  {
291
311
  auto_collection: T::Boolean,
292
312
  net_terms: Integer,
313
+ invoice_date:
314
+ T.nilable(
315
+ Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate::Variants
316
+ ),
293
317
  memo: T.nilable(String),
294
318
  require_successful_payment: T::Boolean
295
319
  }
@@ -297,6 +321,25 @@ module Orb
297
321
  end
298
322
  def to_hash
299
323
  end
324
+
325
+ # An ISO 8601 format date that denotes when this invoice should be dated in the
326
+ # customer's timezone. If not provided, the invoice date will default to the
327
+ # credit block's effective date.
328
+ module InvoiceDate
329
+ extend Orb::Internal::Type::Union
330
+
331
+ Variants = T.type_alias { T.any(Date, Time) }
332
+
333
+ sig do
334
+ override.returns(
335
+ T::Array[
336
+ Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate::Variants
337
+ ]
338
+ )
339
+ end
340
+ def self.variants
341
+ end
342
+ end
300
343
  end
301
344
 
302
345
  # Can only be specified when `entry_type=void`. The reason for the void.
@@ -93,6 +93,7 @@ module Orb
93
93
  {
94
94
  auto_collection: bool,
95
95
  net_terms: Integer,
96
+ invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::invoice_date?,
96
97
  memo: String?,
97
98
  require_successful_payment: bool
98
99
  }
@@ -102,6 +103,8 @@ module Orb
102
103
 
103
104
  attr_accessor net_terms: Integer
104
105
 
106
+ attr_accessor invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::invoice_date?
107
+
105
108
  attr_accessor memo: String?
106
109
 
107
110
  attr_reader require_successful_payment: bool?
@@ -111,6 +114,7 @@ module Orb
111
114
  def initialize: (
112
115
  auto_collection: bool,
113
116
  net_terms: Integer,
117
+ ?invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::invoice_date?,
114
118
  ?memo: String?,
115
119
  ?require_successful_payment: bool
116
120
  ) -> void
@@ -118,9 +122,18 @@ module Orb
118
122
  def to_hash: -> {
119
123
  auto_collection: bool,
120
124
  net_terms: Integer,
125
+ invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::invoice_date?,
121
126
  memo: String?,
122
127
  require_successful_payment: bool
123
128
  }
129
+
130
+ type invoice_date = Date | Time
131
+
132
+ module InvoiceDate
133
+ extend Orb::Internal::Type::Union
134
+
135
+ def self?.variants: -> ::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::invoice_date]
136
+ end
124
137
  end
125
138
 
126
139
  type void_reason = :refund
@@ -93,6 +93,7 @@ module Orb
93
93
  {
94
94
  auto_collection: bool,
95
95
  net_terms: Integer,
96
+ invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::invoice_date?,
96
97
  memo: String?,
97
98
  require_successful_payment: bool
98
99
  }
@@ -102,6 +103,8 @@ module Orb
102
103
 
103
104
  attr_accessor net_terms: Integer
104
105
 
106
+ attr_accessor invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::invoice_date?
107
+
105
108
  attr_accessor memo: String?
106
109
 
107
110
  attr_reader require_successful_payment: bool?
@@ -111,6 +114,7 @@ module Orb
111
114
  def initialize: (
112
115
  auto_collection: bool,
113
116
  net_terms: Integer,
117
+ ?invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::invoice_date?,
114
118
  ?memo: String?,
115
119
  ?require_successful_payment: bool
116
120
  ) -> void
@@ -118,9 +122,18 @@ module Orb
118
122
  def to_hash: -> {
119
123
  auto_collection: bool,
120
124
  net_terms: Integer,
125
+ invoice_date: Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::invoice_date?,
121
126
  memo: String?,
122
127
  require_successful_payment: bool
123
128
  }
129
+
130
+ type invoice_date = Date | Time
131
+
132
+ module InvoiceDate
133
+ extend Orb::Internal::Type::Union
134
+
135
+ def self?.variants: -> ::Array[Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::invoice_date]
136
+ end
124
137
  end
125
138
 
126
139
  type void_reason = :refund
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: orb-billing
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-07-04 00:00:00.000000000 Z
11
+ date: 2025-07-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool