orb-billing 1.6.0 → 1.7.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: f3f5680937e041cc9ffbb5053850aa48cbbaa99f9bd8ae054bbe18d547c9404c
4
- data.tar.gz: 1cca78b8b0c0767a23a4a7e9d01a715e00ef5d7644348896a07b7b497a835ae9
3
+ metadata.gz: c2d0c4a4d09df50af007b4fdb30bab19a35a3841ab39a9c91417b23c5a1c2dd3
4
+ data.tar.gz: ad68ccefacec87801c1614a0886c49bec12c12614112d57dcd201c12b286968c
5
5
  SHA512:
6
- metadata.gz: 4f3d60e893a9dc4ce1c150585169a1e281ab6f88f92517b2e4fd0f1ae07d25d3cc83aa19128bbbaec7f509ecdecea336bba5c1d314f7bcb3bb970d31c008bdbf
7
- data.tar.gz: 592341b112aeba6378a1b8ebc52436b4b663410b67d6561cd8071f3bf04a3790f452c825599a40679fdd77b7e81f375896922964683114476fe7a917461ac0c2
6
+ metadata.gz: 5a45c2386ef7dbe71fe6f15792e7471cb57aae04c6cfd2d6399b63f10ea54386f36cc750a6691a88e982199a911debc748ebaf7abcc129d8e28d28a5fc6085b3
7
+ data.tar.gz: 41d387c383177267bd4806fe341df92d69d2a07de4815e07c221fe4fcefde6395f45053249eb9d75eed95bea8e6d14ec953da1ee47c80c5c02b7d1c0aea09f6d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.7.0 (2025-07-16)
4
+
5
+ Full Changelog: [v1.6.0...v1.7.0](https://github.com/orbcorp/orb-ruby/compare/v1.6.0...v1.7.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([78865a0](https://github.com/orbcorp/orb-ruby/commit/78865a03cdc7ca40dacad41ef18546f8bbee1593))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** version bump ([811d9b6](https://github.com/orbcorp/orb-ruby/commit/811d9b63cef236992ab6cef658877c4cec96f61a))
15
+
3
16
  ## 1.6.0 (2025-07-16)
4
17
 
5
18
  Full Changelog: [v1.5.1...v1.6.0](https://github.com/orbcorp/orb-ruby/compare/v1.5.1...v1.6.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.6.0"
18
+ gem "orb-billing", "~> 1.7.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -19,10 +19,10 @@ module Orb
19
19
  required :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }
20
20
 
21
21
  # @!attribute end_date
22
- # An optional date string to specify the global credit note service period end
23
- # date in the customer's timezone. This will be applied to all line items. If not
24
- # provided, line items will use their original invoice line item service periods.
25
- # This date is inclusive.
22
+ # A date string to specify the global credit note service period end date in the
23
+ # customer's timezone. This will be applied to all line items that don't have
24
+ # their own individual service periods specified. If not provided, line items will
25
+ # use their original invoice line item service periods. This date is inclusive.
26
26
  #
27
27
  # @return [Date, nil]
28
28
  optional :end_date, Date, nil?: true
@@ -34,10 +34,10 @@ module Orb
34
34
  optional :memo, String, nil?: true
35
35
 
36
36
  # @!attribute start_date
37
- # An optional date string to specify the global credit note service period end
38
- # date in the customer's timezone. This will be applied to all line items. If not
39
- # provided, line items will use their original invoice line item service periods.
40
- # This date is inclusive.
37
+ # A date string to specify the global credit note service period start date in the
38
+ # customer's timezone. This will be applied to all line items that don't have
39
+ # their own individual service periods specified. If not provided, line items will
40
+ # use their original invoice line item service periods. This date is inclusive.
41
41
  #
42
42
  # @return [Date, nil]
43
43
  optional :start_date, Date, nil?: true
@@ -50,11 +50,11 @@ module Orb
50
50
  #
51
51
  # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
52
52
  #
53
- # @param end_date [Date, nil] An optional date string to specify the global credit note service period end dat
53
+ # @param end_date [Date, nil] A date string to specify the global credit note service period end date in the c
54
54
  #
55
55
  # @param memo [String, nil] An optional memo to attach to the credit note.
56
56
  #
57
- # @param start_date [Date, nil] An optional date string to specify the global credit note service period end dat
57
+ # @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
58
58
  #
59
59
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
60
60
 
@@ -72,21 +72,20 @@ module Orb
72
72
  required :invoice_line_item_id, String
73
73
 
74
74
  # @!attribute end_date
75
- # An optional date string to specify this line item's credit note service period
76
- # end date in the customer's timezone. If provided, this will be used for this
77
- # specific line item. If not provided, will use the global end_date if available,
78
- # otherwise defaults to the original invoice line item's end date. This date is
79
- # inclusive.
75
+ # A date string to specify this line item's credit note service period end date in
76
+ # the customer's timezone. If provided, this will be used for this specific line
77
+ # item. If not provided, will use the global end_date if available, otherwise
78
+ # defaults to the original invoice line item's end date. This date is inclusive.
80
79
  #
81
80
  # @return [Date, nil]
82
81
  optional :end_date, Date, nil?: true
83
82
 
84
83
  # @!attribute start_date
85
- # An optional date string to specify this line item's credit note service period
86
- # start date in the customer's timezone. If provided, this will be used for this
87
- # specific line item. If not provided, will use the global start_date if
88
- # available, otherwise defaults to the original invoice line item's start date.
89
- # This date is inclusive.
84
+ # A date string to specify this line item's credit note service period start date
85
+ # in the customer's timezone. If provided, this will be used for this specific
86
+ # line item. If not provided, will use the global start_date if available,
87
+ # otherwise defaults to the original invoice line item's start date. This date is
88
+ # inclusive.
90
89
  #
91
90
  # @return [Date, nil]
92
91
  optional :start_date, Date, nil?: true
@@ -99,9 +98,9 @@ module Orb
99
98
  #
100
99
  # @param invoice_line_item_id [String] The ID of the line item to credit.
101
100
  #
102
- # @param end_date [Date, nil] An optional date string to specify this line item's credit note service period e
101
+ # @param end_date [Date, nil] A date string to specify this line item's credit note service period end date in
103
102
  #
104
- # @param start_date [Date, nil] An optional date string to specify this line item's credit note service period s
103
+ # @param start_date [Date, nil] A date string to specify this line item's credit note service period start date
105
104
  end
106
105
 
107
106
  # An optional reason for the credit note.
@@ -40,11 +40,11 @@ module Orb
40
40
  #
41
41
  # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
42
42
  #
43
- # @param end_date [Date, nil] An optional date string to specify the global credit note service period end dat
43
+ # @param end_date [Date, nil] A date string to specify the global credit note service period end date in the c
44
44
  #
45
45
  # @param memo [String, nil] An optional memo to attach to the credit note.
46
46
  #
47
- # @param start_date [Date, nil] An optional date string to specify the global credit note service period end dat
47
+ # @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
48
48
  #
49
49
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
50
50
  #
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.6.0"
4
+ VERSION = "1.7.0"
5
5
  end
@@ -18,10 +18,10 @@ module Orb
18
18
  sig { returns(Orb::CreditNoteCreateParams::Reason::OrSymbol) }
19
19
  attr_accessor :reason
20
20
 
21
- # An optional date string to specify the global credit note service period end
22
- # date in the customer's timezone. This will be applied to all line items. If not
23
- # provided, line items will use their original invoice line item service periods.
24
- # This date is inclusive.
21
+ # A date string to specify the global credit note service period end date in the
22
+ # customer's timezone. This will be applied to all line items that don't have
23
+ # their own individual service periods specified. If not provided, line items will
24
+ # use their original invoice line item service periods. This date is inclusive.
25
25
  sig { returns(T.nilable(Date)) }
26
26
  attr_accessor :end_date
27
27
 
@@ -29,10 +29,10 @@ module Orb
29
29
  sig { returns(T.nilable(String)) }
30
30
  attr_accessor :memo
31
31
 
32
- # An optional date string to specify the global credit note service period end
33
- # date in the customer's timezone. This will be applied to all line items. If not
34
- # provided, line items will use their original invoice line item service periods.
35
- # This date is inclusive.
32
+ # A date string to specify the global credit note service period start date in the
33
+ # customer's timezone. This will be applied to all line items that don't have
34
+ # their own individual service periods specified. If not provided, line items will
35
+ # use their original invoice line item service periods. This date is inclusive.
36
36
  sig { returns(T.nilable(Date)) }
37
37
  attr_accessor :start_date
38
38
 
@@ -50,17 +50,17 @@ module Orb
50
50
  line_items:,
51
51
  # An optional reason for the credit note.
52
52
  reason:,
53
- # An optional date string to specify the global credit note service period end
54
- # date in the customer's timezone. This will be applied to all line items. If not
55
- # provided, line items will use their original invoice line item service periods.
56
- # This date is inclusive.
53
+ # A date string to specify the global credit note service period end date in the
54
+ # customer's timezone. This will be applied to all line items that don't have
55
+ # their own individual service periods specified. If not provided, line items will
56
+ # use their original invoice line item service periods. This date is inclusive.
57
57
  end_date: nil,
58
58
  # An optional memo to attach to the credit note.
59
59
  memo: nil,
60
- # An optional date string to specify the global credit note service period end
61
- # date in the customer's timezone. This will be applied to all line items. If not
62
- # provided, line items will use their original invoice line item service periods.
63
- # This date is inclusive.
60
+ # A date string to specify the global credit note service period start date in the
61
+ # customer's timezone. This will be applied to all line items that don't have
62
+ # their own individual service periods specified. If not provided, line items will
63
+ # use their original invoice line item service periods. This date is inclusive.
64
64
  start_date: nil,
65
65
  request_options: {}
66
66
  )
@@ -95,19 +95,18 @@ module Orb
95
95
  sig { returns(String) }
96
96
  attr_accessor :invoice_line_item_id
97
97
 
98
- # An optional date string to specify this line item's credit note service period
99
- # end date in the customer's timezone. If provided, this will be used for this
100
- # specific line item. If not provided, will use the global end_date if available,
101
- # otherwise defaults to the original invoice line item's end date. This date is
102
- # inclusive.
98
+ # A date string to specify this line item's credit note service period end date in
99
+ # the customer's timezone. If provided, this will be used for this specific line
100
+ # item. If not provided, will use the global end_date if available, otherwise
101
+ # defaults to the original invoice line item's end date. This date is inclusive.
103
102
  sig { returns(T.nilable(Date)) }
104
103
  attr_accessor :end_date
105
104
 
106
- # An optional date string to specify this line item's credit note service period
107
- # start date in the customer's timezone. If provided, this will be used for this
108
- # specific line item. If not provided, will use the global start_date if
109
- # available, otherwise defaults to the original invoice line item's start date.
110
- # This date is inclusive.
105
+ # A date string to specify this line item's credit note service period start date
106
+ # in the customer's timezone. If provided, this will be used for this specific
107
+ # line item. If not provided, will use the global start_date if available,
108
+ # otherwise defaults to the original invoice line item's start date. This date is
109
+ # inclusive.
111
110
  sig { returns(T.nilable(Date)) }
112
111
  attr_accessor :start_date
113
112
 
@@ -124,17 +123,16 @@ module Orb
124
123
  amount:,
125
124
  # The ID of the line item to credit.
126
125
  invoice_line_item_id:,
127
- # An optional date string to specify this line item's credit note service period
128
- # end date in the customer's timezone. If provided, this will be used for this
129
- # specific line item. If not provided, will use the global end_date if available,
130
- # otherwise defaults to the original invoice line item's end date. This date is
131
- # inclusive.
126
+ # A date string to specify this line item's credit note service period end date in
127
+ # the customer's timezone. If provided, this will be used for this specific line
128
+ # item. If not provided, will use the global end_date if available, otherwise
129
+ # defaults to the original invoice line item's end date. This date is inclusive.
132
130
  end_date: nil,
133
- # An optional date string to specify this line item's credit note service period
134
- # start date in the customer's timezone. If provided, this will be used for this
135
- # specific line item. If not provided, will use the global start_date if
136
- # available, otherwise defaults to the original invoice line item's start date.
137
- # This date is inclusive.
131
+ # A date string to specify this line item's credit note service period start date
132
+ # in the customer's timezone. If provided, this will be used for this specific
133
+ # line item. If not provided, will use the global start_date if available,
134
+ # otherwise defaults to the original invoice line item's start date. This date is
135
+ # inclusive.
138
136
  start_date: nil
139
137
  )
140
138
  end
@@ -44,17 +44,17 @@ module Orb
44
44
  line_items:,
45
45
  # An optional reason for the credit note.
46
46
  reason:,
47
- # An optional date string to specify the global credit note service period end
48
- # date in the customer's timezone. This will be applied to all line items. If not
49
- # provided, line items will use their original invoice line item service periods.
50
- # This date is inclusive.
47
+ # A date string to specify the global credit note service period end date in the
48
+ # customer's timezone. This will be applied to all line items that don't have
49
+ # their own individual service periods specified. If not provided, line items will
50
+ # use their original invoice line item service periods. This date is inclusive.
51
51
  end_date: nil,
52
52
  # An optional memo to attach to the credit note.
53
53
  memo: nil,
54
- # An optional date string to specify the global credit note service period end
55
- # date in the customer's timezone. This will be applied to all line items. If not
56
- # provided, line items will use their original invoice line item service periods.
57
- # This date is inclusive.
54
+ # A date string to specify the global credit note service period start date in the
55
+ # customer's timezone. This will be applied to all line items that don't have
56
+ # their own individual service periods specified. If not provided, line items will
57
+ # use their original invoice line item service periods. This date is inclusive.
58
58
  start_date: nil,
59
59
  request_options: {}
60
60
  )
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.6.0
4
+ version: 1.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb