recurly 4.38.0 → 4.40.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aa823beffdec114f5d986cfb91ec4bb6a5cba19405c8cfaca99ad2e86afce539
4
- data.tar.gz: 210e3425783dce9f8fcb61e214e565341fe8baad3838010f40bce46cff32946a
3
+ metadata.gz: 516898930f6b60b8f1a395185faef9f1202df9b635708656ffa68cd83dd1fb1e
4
+ data.tar.gz: 2c8e9afc6c23e0998b38911c4c46845a9d0d10c008cbc65e666889dc3ada67d5
5
5
  SHA512:
6
- metadata.gz: 65e58303ed5ed372250923908976d6be83697160dab1b45d499d6ef1a876d07f4b129faccf6ecb26005c1c0e18c08d80e5e16d5288731f9f600b2c3ceabaf72a
7
- data.tar.gz: 810071a34225cbb1598730a1ff16b2cf8fad9a64bd6fc3c13a09dc3c23a496f5b788daffcb06eca9da0e380ae38eef589a0cf17c5315b1227e5199cb543c90d2
6
+ metadata.gz: 56f7cbbc66edb19a6a3702dd2402c93acea4d42a18862c4c97dc475f6f21cdc06bbdc12d3147b1338e49c6b10a334d83688a00de069bfeb576f6ab58ad017244
7
+ data.tar.gz: d414f601498ca69ccd18e703e36426d52bcfc427ce14f6fee1b2efc41f9f6ef63b34ed526e0960d339e6bd61980b82aee3a0d7e69b2c1768ba29f2ecb4c49d3f
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.38.0
2
+ current_version = 4.40.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
@@ -0,0 +1,27 @@
1
+ name: PR Review
2
+
3
+ on:
4
+ pull_request:
5
+ types:
6
+ - opened
7
+ - repoened
8
+ - edited
9
+ - synchronize
10
+ - labeled
11
+ - unlabeled
12
+
13
+ concurrency:
14
+ group: ${{ github.workflow }} - ${{ github.ref }}
15
+ cancel-in-progress: true
16
+
17
+ jobs:
18
+ label-checker:
19
+ runs-on: ubuntu-latest
20
+ name: Label Checker
21
+ steps:
22
+ - name: Check Labels
23
+ uses: docker://agilepathway/pull-request-label-checker:latest
24
+ with:
25
+ one_of: V4
26
+ repo_token: ${{ secrets.GITHUB_TOKEN }}
27
+
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.40.0](https://github.com/recurly/recurly-client-ruby/tree/4.40.0) (2023-07-27)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.38.0...4.40.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25 (Ramp Dates, Net Terms, Invoice Business Entity) [#860](https://github.com/recurly/recurly-client-ruby/pull/860) ([recurly-integrations](https://github.com/recurly-integrations))
11
+ - Generated Latest Changes for v2021-02-25 (App Management - External Subscriptions) [#859](https://github.com/recurly/recurly-client-ruby/pull/859) ([recurly-integrations](https://github.com/recurly-integrations))
12
+
13
+
14
+
3
15
  ## [4.38.0](https://github.com/recurly/recurly-client-ruby/tree/4.38.0) (2023-06-01)
4
16
 
5
17
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.37.0...4.38.0)
@@ -160,6 +172,9 @@
160
172
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.23.0...4.24.0)
161
173
 
162
174
 
175
+ **Merged Pull Requests**
176
+
177
+ - Add Webhooks::verify_signature [#794](https://github.com/recurly/recurly-client-ruby/pull/794) ([jguidry-recurly](https://github.com/jguidry-recurly))
163
178
 
164
179
 
165
180
 
data/GETTING_STARTED.md CHANGED
@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
5
5
  In your Gemfile, add `recurly` as a dependency.
6
6
 
7
7
  ```ruby
8
- gem 'recurly', '~> 4.38'
8
+ gem 'recurly', '~> 4.40'
9
9
  ```
10
10
 
11
11
  > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
@@ -23,9 +23,13 @@ module Recurly
23
23
  define_attribute :currency, String
24
24
 
25
25
  # @!attribute net_terms
26
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
26
+ # @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
27
27
  define_attribute :net_terms, Integer
28
28
 
29
+ # @!attribute net_terms_type
30
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
31
+ define_attribute :net_terms_type, String
32
+
29
33
  # @!attribute po_number
30
34
  # @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
31
35
  define_attribute :po_number, String
@@ -47,9 +47,13 @@ module Recurly
47
47
  define_attribute :line_items, Array, { :item_type => :LineItemCreate }
48
48
 
49
49
  # @!attribute net_terms
50
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
50
+ # @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
51
51
  define_attribute :net_terms, Integer
52
52
 
53
+ # @!attribute net_terms_type
54
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
55
+ define_attribute :net_terms_type, String
56
+
53
57
  # @!attribute po_number
54
58
  # @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
55
59
  define_attribute :po_number, String
@@ -27,9 +27,13 @@ module Recurly
27
27
  define_attribute :custom_fields, Array, { :item_type => :CustomField }
28
28
 
29
29
  # @!attribute net_terms
30
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
30
+ # @return [Integer] Integer normally paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
31
31
  define_attribute :net_terms, Integer
32
32
 
33
+ # @!attribute net_terms_type
34
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
35
+ define_attribute :net_terms_type, String
36
+
33
37
  # @!attribute plan_code
34
38
  # @return [String] If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
35
39
  define_attribute :plan_code, String
@@ -51,9 +51,13 @@ module Recurly
51
51
  define_attribute :gift_card_redemption_code, String
52
52
 
53
53
  # @!attribute net_terms
54
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
54
+ # @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
55
55
  define_attribute :net_terms, Integer
56
56
 
57
+ # @!attribute net_terms_type
58
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
59
+ define_attribute :net_terms_type, String
60
+
57
61
  # @!attribute next_bill_date
58
62
  # @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
59
63
  define_attribute :next_bill_date, DateTime
@@ -31,9 +31,13 @@ module Recurly
31
31
  define_attribute :gateway_code, String
32
32
 
33
33
  # @!attribute net_terms
34
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
34
+ # @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
35
35
  define_attribute :net_terms, Integer
36
36
 
37
+ # @!attribute net_terms_type
38
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
39
+ define_attribute :net_terms_type, String
40
+
37
41
  # @!attribute next_bill_date
38
42
  # @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.
39
43
  define_attribute :next_bill_date, DateTime
@@ -22,6 +22,10 @@ module Recurly
22
22
  # @return [Boolean] An indication of whether or not the external subscription will auto-renew at the expiration date.
23
23
  define_attribute :auto_renew, :Boolean
24
24
 
25
+ # @!attribute canceled_at
26
+ # @return [DateTime] When the external subscription was canceled in the external platform.
27
+ define_attribute :canceled_at, DateTime
28
+
25
29
  # @!attribute created_at
26
30
  # @return [DateTime] When the external subscription was created in Recurly.
27
31
  define_attribute :created_at, DateTime
@@ -42,6 +46,10 @@ module Recurly
42
46
  # @return [String] System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
43
47
  define_attribute :id, String
44
48
 
49
+ # @!attribute in_grace_period
50
+ # @return [Boolean] An indication of whether or not the external subscription is in a grace period.
51
+ define_attribute :in_grace_period, :Boolean
52
+
45
53
  # @!attribute last_purchased
46
54
  # @return [DateTime] When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
47
55
  define_attribute :last_purchased, DateTime
@@ -55,9 +63,17 @@ module Recurly
55
63
  define_attribute :quantity, Integer
56
64
 
57
65
  # @!attribute state
58
- # @return [String] External subscriptions can be active, canceled, expired, or future.
66
+ # @return [String] External subscriptions can be active, canceled, expired, or past_due.
59
67
  define_attribute :state, String
60
68
 
69
+ # @!attribute trial_ends_at
70
+ # @return [DateTime] When the external subscription trial period ends in the external platform.
71
+ define_attribute :trial_ends_at, DateTime
72
+
73
+ # @!attribute trial_started_at
74
+ # @return [DateTime] When the external subscription trial period started in the external platform.
75
+ define_attribute :trial_started_at, DateTime
76
+
61
77
  # @!attribute updated_at
62
78
  # @return [DateTime] When the external subscription was updated in Recurly.
63
79
  define_attribute :updated_at, DateTime
@@ -83,9 +83,13 @@ module Recurly
83
83
  define_attribute :line_items, Array, { :item_type => :LineItem }
84
84
 
85
85
  # @!attribute net_terms
86
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
86
+ # @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
87
87
  define_attribute :net_terms, Integer
88
88
 
89
+ # @!attribute net_terms_type
90
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
91
+ define_attribute :net_terms_type, String
92
+
89
93
  # @!attribute number
90
94
  # @return [String] If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
91
95
  define_attribute :number, String
@@ -6,6 +6,10 @@ module Recurly
6
6
  module Resources
7
7
  class InvoiceMini < Resource
8
8
 
9
+ # @!attribute business_entity_id
10
+ # @return [String] Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled.
11
+ define_attribute :business_entity_id, String
12
+
9
13
  # @!attribute id
10
14
  # @return [String] Invoice ID
11
15
  define_attribute :id, String
@@ -103,9 +103,13 @@ module Recurly
103
103
  define_attribute :id, String
104
104
 
105
105
  # @!attribute net_terms
106
- # @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after its created. If an invoice is due net 30, it will become past due at 31 days exactly.
106
+ # @return [Integer] Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For any value, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
107
107
  define_attribute :net_terms, Integer
108
108
 
109
+ # @!attribute net_terms_type
110
+ # @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month. This field is only available when the EOM Net Terms feature is enabled.
111
+ define_attribute :net_terms_type, String
112
+
109
113
  # @!attribute object
110
114
  # @return [String] Object type
111
115
  define_attribute :object, String
@@ -6,6 +6,10 @@ module Recurly
6
6
  module Resources
7
7
  class SubscriptionRampIntervalResponse < Resource
8
8
 
9
+ # @!attribute ending_on
10
+ # @return [DateTime] Date the ramp interval ends
11
+ define_attribute :ending_on, DateTime
12
+
9
13
  # @!attribute remaining_billing_cycles
10
14
  # @return [Integer] Represents how many billing cycles are left in a ramp interval.
11
15
  define_attribute :remaining_billing_cycles, Integer
@@ -14,6 +18,10 @@ module Recurly
14
18
  # @return [Integer] Represents the billing cycle where a ramp interval starts.
15
19
  define_attribute :starting_billing_cycle, Integer
16
20
 
21
+ # @!attribute starting_on
22
+ # @return [DateTime] Date the ramp interval starts
23
+ define_attribute :starting_on, DateTime
24
+
17
25
  # @!attribute unit_amount
18
26
  # @return [Float] Represents the price for the ramp interval.
19
27
  define_attribute :unit_amount, Float
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.38.0"
2
+ VERSION = "4.40.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -15202,7 +15202,7 @@ paths:
15202
15202
 
15203
15203
  Use for **Adyen HPP** and **Online Banking** transaction requests.
15204
15204
  This runs the validations but not the transactions.
15205
- The API request allows the inclusion of one of the following fields: **external_hpp_type** with `'adyen'` and **online_banking_payment_type** with `'ideal'` or `'sofort'` in the **billing_info** object.
15205
+ The API request allows the inclusion of the following field: **external_hpp_type** with `'adyen'` in the **billing_info** object.
15206
15206
 
15207
15207
  For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
15208
15208
 
@@ -18291,6 +18291,7 @@ components:
18291
18291
  "$ref": "#/components/schemas/ExternalHppTypeEnum"
18292
18292
  online_banking_payment_type:
18293
18293
  "$ref": "#/components/schemas/OnlineBankingPaymentTypeEnum"
18294
+ deprecated: true
18294
18295
  card_type:
18295
18296
  "$ref": "#/components/schemas/CardTypeEnum"
18296
18297
  BillingInfoVerify:
@@ -19332,13 +19333,24 @@ components:
19332
19333
  net_terms:
19333
19334
  type: integer
19334
19335
  title: Net terms
19335
- description: Integer representing the number of days after an invoice's
19336
- creation that the invoice will become past due. If an invoice's net terms
19337
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
19338
- after it’s created. If an invoice is due net 30, it will become past due
19339
- at 31 days exactly.
19336
+ description: |-
19337
+ Integer paired with `Net Terms Type` and representing the number
19338
+ of days past the current date (for `net` Net Terms Type) or days after
19339
+ the last day of the current month (for `eom` Net Terms Type) that the
19340
+ invoice will become past due. For any value, an additional 24 hours is
19341
+ added to ensure the customer has the entire last day to make payment before
19342
+ becoming past due. For example:
19343
+
19344
+ If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
19345
+ If an invoice is due `net 30`, it will become past due at 31 days exactly.
19346
+ If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
19347
+
19348
+ When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
19349
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
19340
19350
  minimum: 0
19341
19351
  default: 0
19352
+ net_terms_type:
19353
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
19342
19354
  address:
19343
19355
  "$ref": "#/components/schemas/InvoiceAddress"
19344
19356
  shipping_address:
@@ -19516,13 +19528,24 @@ components:
19516
19528
  net_terms:
19517
19529
  type: integer
19518
19530
  title: Net terms
19519
- description: Integer representing the number of days after an invoice's
19520
- creation that the invoice will become past due. If an invoice's net terms
19521
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
19522
- after it’s created. If an invoice is due net 30, it will become past due
19523
- at 31 days exactly.
19524
- default: 0
19531
+ description: |-
19532
+ Integer paired with `Net Terms Type` and representing the number
19533
+ of days past the current date (for `net` Net Terms Type) or days after
19534
+ the last day of the current month (for `eom` Net Terms Type) that the
19535
+ invoice will become past due. For any value, an additional 24 hours is
19536
+ added to ensure the customer has the entire last day to make payment before
19537
+ becoming past due. For example:
19538
+
19539
+ If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
19540
+ If an invoice is due `net 30`, it will become past due at 31 days exactly.
19541
+ If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
19542
+
19543
+ When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
19544
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
19525
19545
  minimum: 0
19546
+ default: 0
19547
+ net_terms_type:
19548
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
19526
19549
  po_number:
19527
19550
  type: string
19528
19551
  title: Purchase order number
@@ -19629,6 +19652,11 @@ components:
19629
19652
  number:
19630
19653
  type: string
19631
19654
  title: Invoice number
19655
+ business_entity_id:
19656
+ type: string
19657
+ title: Business Entity ID
19658
+ description: Unique ID to identify the business entity assigned to the invoice.
19659
+ Available when the `Multiple Business Entities` feature is enabled.
19632
19660
  type:
19633
19661
  title: Invoice type
19634
19662
  "$ref": "#/components/schemas/InvoiceTypeEnum"
@@ -21600,13 +21628,24 @@ components:
21600
21628
  net_terms:
21601
21629
  type: integer
21602
21630
  title: Net terms
21603
- description: Integer representing the number of days after an invoice's
21604
- creation that the invoice will become past due. If an invoice's net terms
21605
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
21606
- after it’s created. If an invoice is due net 30, it will become past due
21607
- at 31 days exactly.
21631
+ description: |-
21632
+ Integer paired with `Net Terms Type` and representing the number
21633
+ of days past the current date (for `net` Net Terms Type) or days after
21634
+ the last day of the current month (for `eom` Net Terms Type) that the
21635
+ invoice will become past due. For any value, an additional 24 hours is
21636
+ added to ensure the customer has the entire last day to make payment before
21637
+ becoming past due. For example:
21638
+
21639
+ If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
21640
+ If an invoice is due `net 30`, it will become past due at 31 days exactly.
21641
+ If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
21642
+
21643
+ When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
21644
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
21608
21645
  minimum: 0
21609
21646
  default: 0
21647
+ net_terms_type:
21648
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
21610
21649
  terms_and_conditions:
21611
21650
  type: string
21612
21651
  title: Terms and conditions
@@ -22162,13 +22201,17 @@ components:
22162
22201
  net_terms:
22163
22202
  type: integer
22164
22203
  title: Net terms
22165
- description: Integer representing the number of days after an invoice's
22166
- creation that the invoice will become past due. If an invoice's net terms
22167
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
22168
- after it’s created. If an invoice is due net 30, it will become past due
22169
- at 31 days exactly.
22204
+ description: |-
22205
+ Integer normally paired with `Net Terms Type` and representing the number of days past
22206
+ the current date (for `net` Net Terms Type) or days after the last day of the current
22207
+ month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription
22208
+ change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters.
22209
+
22210
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
22170
22211
  minimum: 0
22171
22212
  default: 0
22213
+ net_terms_type:
22214
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
22172
22215
  transaction_type:
22173
22216
  description: An optional type designation for the payment gateway transaction
22174
22217
  created by this request. Supports 'moto' value, which is the acronym for
@@ -22373,13 +22416,24 @@ components:
22373
22416
  net_terms:
22374
22417
  type: integer
22375
22418
  title: Net terms
22376
- description: Integer representing the number of days after an invoice's
22377
- creation that the invoice will become past due. If an invoice's net terms
22378
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
22379
- after it’s created. If an invoice is due net 30, it will become past due
22380
- at 31 days exactly.
22419
+ description: |-
22420
+ Integer paired with `Net Terms Type` and representing the number
22421
+ of days past the current date (for `net` Net Terms Type) or days after
22422
+ the last day of the current month (for `eom` Net Terms Type) that the
22423
+ invoice will become past due. For any value, an additional 24 hours is
22424
+ added to ensure the customer has the entire last day to make payment before
22425
+ becoming past due. For example:
22426
+
22427
+ If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
22428
+ If an invoice is due `net 30`, it will become past due at 31 days exactly.
22429
+ If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
22430
+
22431
+ When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
22432
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
22381
22433
  minimum: 0
22382
22434
  default: 0
22435
+ net_terms_type:
22436
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
22383
22437
  transaction_type:
22384
22438
  description: An optional type designation for the payment gateway transaction
22385
22439
  created by this request. Supports 'moto' value, which is the acronym for
@@ -22549,13 +22603,24 @@ components:
22549
22603
  net_terms:
22550
22604
  type: integer
22551
22605
  title: Terms that the subscription is due on
22552
- description: Integer representing the number of days after an invoice's
22553
- creation that the invoice will become past due. If an invoice's net terms
22554
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
22555
- after it’s created. If an invoice is due net 30, it will become past due
22556
- at 31 days exactly.
22606
+ description: |-
22607
+ Integer paired with `Net Terms Type` and representing the number
22608
+ of days past the current date (for `net` Net Terms Type) or days after
22609
+ the last day of the current month (for `eom` Net Terms Type) that the
22610
+ invoice will become past due. For any value, an additional 24 hours is
22611
+ added to ensure the customer has the entire last day to make payment before
22612
+ becoming past due. For example:
22613
+
22614
+ If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
22615
+ If an invoice is due `net 30`, it will become past due at 31 days exactly.
22616
+ If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
22617
+
22618
+ When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
22619
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
22557
22620
  minimum: 0
22558
22621
  default: 0
22622
+ net_terms_type:
22623
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
22559
22624
  gateway_code:
22560
22625
  type: string
22561
22626
  title: Gateway Code
@@ -22694,6 +22759,14 @@ components:
22694
22759
  remaining_billing_cycles:
22695
22760
  type: integer
22696
22761
  description: Represents how many billing cycles are left in a ramp interval.
22762
+ starting_on:
22763
+ type: string
22764
+ format: date-time
22765
+ title: Date the ramp interval starts
22766
+ ending_on:
22767
+ type: string
22768
+ format: date-time
22769
+ title: Date the ramp interval ends
22697
22770
  unit_amount:
22698
22771
  type: number
22699
22772
  format: float
@@ -23253,13 +23326,24 @@ components:
23253
23326
  net_terms:
23254
23327
  type: integer
23255
23328
  title: Net terms
23256
- description: Integer representing the number of days after an invoice's
23257
- creation that the invoice will become past due. If an invoice's net terms
23258
- are set to '0', it is due 'On Receipt' and will become past due 24 hours
23259
- after it’s created. If an invoice is due net 30, it will become past due
23260
- at 31 days exactly.
23329
+ description: |-
23330
+ Integer paired with `Net Terms Type` and representing the number
23331
+ of days past the current date (for `net` Net Terms Type) or days after
23332
+ the last day of the current month (for `eom` Net Terms Type) that the
23333
+ invoice will become past due. For any value, an additional 24 hours is
23334
+ added to ensure the customer has the entire last day to make payment before
23335
+ becoming past due. For example:
23336
+
23337
+ If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
23338
+ If an invoice is due `net 30`, it will become past due at 31 days exactly.
23339
+ If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
23340
+
23341
+ When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
23342
+ For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
23261
23343
  minimum: 0
23262
23344
  default: 0
23345
+ net_terms_type:
23346
+ "$ref": "#/components/schemas/NetTermsTypeEnum"
23263
23347
  terms_and_conditions:
23264
23348
  type: string
23265
23349
  title: Terms and conditions
@@ -23765,6 +23849,12 @@ components:
23765
23849
  description: An indication of whether or not the external subscription will
23766
23850
  auto-renew at the expiration date.
23767
23851
  default: false
23852
+ in_grace_period:
23853
+ type: boolean
23854
+ title: In grace period
23855
+ description: An indication of whether or not the external subscription is
23856
+ in a grace period.
23857
+ default: false
23768
23858
  app_identifier:
23769
23859
  type: string
23770
23860
  title: App identifier
@@ -23778,18 +23868,37 @@ components:
23778
23868
  state:
23779
23869
  type: string
23780
23870
  description: External subscriptions can be active, canceled, expired, or
23781
- future.
23871
+ past_due.
23872
+ default: active
23782
23873
  activated_at:
23783
23874
  type: string
23784
23875
  format: date-time
23785
23876
  title: Activated at
23786
23877
  description: When the external subscription was activated in the external
23787
23878
  platform.
23879
+ canceled_at:
23880
+ type: string
23881
+ format: date-time
23882
+ title: Canceled at
23883
+ description: When the external subscription was canceled in the external
23884
+ platform.
23788
23885
  expires_at:
23789
23886
  type: string
23790
23887
  format: date-time
23791
23888
  title: Expires at
23792
23889
  description: When the external subscription expires in the external platform.
23890
+ trial_started_at:
23891
+ type: string
23892
+ format: date-time
23893
+ title: Trial started at
23894
+ description: When the external subscription trial period started in the
23895
+ external platform.
23896
+ trial_ends_at:
23897
+ type: string
23898
+ format: date-time
23899
+ title: Trial ends at
23900
+ description: When the external subscription trial period ends in the external
23901
+ platform.
23793
23902
  created_at:
23794
23903
  type: string
23795
23904
  format: date-time
@@ -24773,6 +24882,19 @@ components:
24773
24882
  - at_range_start
24774
24883
  - evenly
24775
24884
  - never
24885
+ NetTermsTypeEnum:
24886
+ type: string
24887
+ title: Net Terms Type
24888
+ description: |
24889
+ Optionally supplied string that may be either `net` or `eom` (end-of-month).
24890
+ When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date.
24891
+ When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
24892
+
24893
+ This field is only available when the EOM Net Terms feature is enabled.
24894
+ enum:
24895
+ - net
24896
+ - eom
24897
+ default: net
24776
24898
  InvoiceTypeEnum:
24777
24899
  type: string
24778
24900
  enum:
@@ -25039,6 +25161,7 @@ components:
25039
25161
  - venmo
25040
25162
  - wire_transfer
25041
25163
  - braintree_v_zero
25164
+ - boleto
25042
25165
  CardTypeEnum:
25043
25166
  type: string
25044
25167
  enum:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: recurly
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.38.0
4
+ version: 4.40.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-01 00:00:00.000000000 Z
11
+ date: 2023-07-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -121,6 +121,7 @@ files:
121
121
  - ".github/ISSUE_TEMPLATE/question-or-other.md"
122
122
  - ".github/workflows/ci.yml"
123
123
  - ".github/workflows/docs.yml"
124
+ - ".github/workflows/pr-review.yml"
124
125
  - ".gitignore"
125
126
  - ".rspec"
126
127
  - ".yardopts"
@@ -344,7 +345,7 @@ metadata:
344
345
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
345
346
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
346
347
  homepage_uri: https://github.com/recurly/recurly-client-ruby
347
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.38.0
348
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.40.0
348
349
  post_install_message:
349
350
  rdoc_options: []
350
351
  require_paths: