recurly 4.71.0 → 4.72.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: 42e8b8e3547704b809680999049a5d3e7d66ff9f0859abdec410dee69011441c
4
- data.tar.gz: 5fe92e11806fa71bf3e154ec695e8dd6b7940330a674a212c613860eda117d31
3
+ metadata.gz: 25fa7c5cd1876eaa642a719d75302975e397412c96b366f8b64464cf0df90db9
4
+ data.tar.gz: 547b8eb4eb2b7dcea5168318c7b26e1e73e268cc2811800e448556acc370474e
5
5
  SHA512:
6
- metadata.gz: dbea3904c94356bd7b6829d0efec530e50068bd4395627f385a3afdba673dabd96f14617e4e77767cb99d4965ed8776a95c07915538f543eea947d447ae13483
7
- data.tar.gz: 23131949b9eaa434268afd9e55dec326f9aa53a03822371221337e193ba5047c8f3439fa1f1142039f960c74be2f7b2b61296278ea71ca54f75e03d4ac5bdf05
6
+ metadata.gz: d2930a35d7d93f30c2ab985e2f67b5e426515a114e4e1c4e2665e3ee32610e68ad87bef398b93a13091cd6fac9852e0a28333175cb8347a18fe9dbd8522912e5
7
+ data.tar.gz: 072f25b4c994eaffbd7c0017de0e027096f520e3fd29da6fa13c3f3618636269470f9f55398623804a68cad626d9d9dd1c3263c508e93a3fed99d13ac7fe0819
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.71.0
2
+ current_version = 4.72.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.72.0](https://github.com/recurly/recurly-client-ruby/tree/4.72.0) (2025-12-11)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.71.0...4.72.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25 [#945](https://github.com/recurly/recurly-client-ruby/pull/945) ([recurly-integrations](https://github.com/recurly-integrations))
11
+ - Generated Latest Changes for v2021-02-25 [#942](https://github.com/recurly/recurly-client-ruby/pull/942) ([recurly-integrations](https://github.com/recurly-integrations))
12
+
13
+
14
+
3
15
  ## [4.71.0](https://github.com/recurly/recurly-client-ruby/tree/4.71.0) (2025-11-05)
4
16
 
5
17
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.70.0...4.71.0)
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.71'
8
+ gem 'recurly', '~> 4.72'
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.
@@ -0,0 +1,14 @@
1
+ # This file is automatically created by Recurly's OpenAPI generation process
2
+ # and thus any edits you make by hand will be lost. If you wish to make a
3
+ # change to this file, please create a Github issue explaining the changes you
4
+ # need and we will usher them to the appropriate places.
5
+ module Recurly
6
+ module Requests
7
+ class CreditApplicationPolicy < Request
8
+
9
+ # @!attribute mode
10
+ # @return [String] Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
11
+ define_attribute :mode, String
12
+ end
13
+ end
14
+ end
@@ -22,6 +22,10 @@ module Recurly
22
22
  # @return [String] The product code or SKU of the gift card product.
23
23
  define_attribute :product_code, String
24
24
 
25
+ # @!attribute tax_service_opt_out
26
+ # @return [Boolean] Set to `true` to bypass sending the purchase to your configured tax service. Defaults to `false`.
27
+ define_attribute :tax_service_opt_out, :Boolean
28
+
25
29
  # @!attribute unit_amount
26
30
  # @return [Float] The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.
27
31
  define_attribute :unit_amount, Float
@@ -22,6 +22,10 @@ module Recurly
22
22
  # @return [String] An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
23
23
  define_attribute :collection_method, String
24
24
 
25
+ # @!attribute credit_application_policy
26
+ # @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
27
+ define_attribute :credit_application_policy, :CreditApplicationPolicy
28
+
25
29
  # @!attribute credit_customer_notes
26
30
  # @return [String] This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
27
31
  define_attribute :credit_customer_notes, String
@@ -49,6 +53,10 @@ module Recurly
49
53
  # @!attribute vat_reverse_charge_notes
50
54
  # @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
51
55
  define_attribute :vat_reverse_charge_notes, String
56
+
57
+ # @!attribute vertex_transaction_type
58
+ # @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
59
+ define_attribute :vertex_transaction_type, String
52
60
  end
53
61
  end
54
62
  end
@@ -109,6 +109,10 @@ module Recurly
109
109
  # @!attribute unit_amount
110
110
  # @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
111
111
  define_attribute :unit_amount, Float
112
+
113
+ # @!attribute vertex_transaction_type
114
+ # @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
115
+ define_attribute :vertex_transaction_type, String
112
116
  end
113
117
  end
114
118
  end
@@ -30,6 +30,10 @@ module Recurly
30
30
  # @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
31
31
  define_attribute :coupon_codes, Array, { :item_type => String }
32
32
 
33
+ # @!attribute credit_application_policy_override
34
+ # @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
35
+ define_attribute :credit_application_policy_override, :CreditApplicationPolicy
36
+
33
37
  # @!attribute credit_customer_notes
34
38
  # @return [String] Notes to be put on the credit invoice resulting from credits in the purchase, if any.
35
39
  define_attribute :credit_customer_notes, String
@@ -89,6 +93,10 @@ module Recurly
89
93
  # @!attribute vat_reverse_charge_notes
90
94
  # @return [String] VAT reverse charge notes for cross border European tax settlement.
91
95
  define_attribute :vat_reverse_charge_notes, String
96
+
97
+ # @!attribute vertex_transaction_type
98
+ # @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
99
+ define_attribute :vertex_transaction_type, String
92
100
  end
93
101
  end
94
102
  end
@@ -42,6 +42,10 @@ module Recurly
42
42
  # @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
43
43
  define_attribute :coupon_codes, Array, { :item_type => String }
44
44
 
45
+ # @!attribute credit_application_policy
46
+ # @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
47
+ define_attribute :credit_application_policy, :CreditApplicationPolicy
48
+
45
49
  # @!attribute credit_customer_notes
46
50
  # @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
47
51
  define_attribute :credit_customer_notes, String
@@ -18,6 +18,10 @@ module Recurly
18
18
  # @return [Boolean] Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.
19
19
  define_attribute :bulk, :Boolean
20
20
 
21
+ # @!attribute credit_application_policy
22
+ # @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
23
+ define_attribute :credit_application_policy, :CreditApplicationPolicy
24
+
21
25
  # @!attribute custom_fields
22
26
  # @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
23
27
  define_attribute :custom_fields, Array, { :item_type => :CustomField }
@@ -18,6 +18,10 @@ module Recurly
18
18
  # @return [String] Change collection method
19
19
  define_attribute :collection_method, String
20
20
 
21
+ # @!attribute credit_application_policy
22
+ # @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
23
+ define_attribute :credit_application_policy, :CreditApplicationPolicy
24
+
21
25
  # @!attribute custom_fields
22
26
  # @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
23
27
  define_attribute :custom_fields, Array, { :item_type => :CustomField }
@@ -0,0 +1,14 @@
1
+ # This file is automatically created by Recurly's OpenAPI generation process
2
+ # and thus any edits you make by hand will be lost. If you wish to make a
3
+ # change to this file, please create a Github issue explaining the changes you
4
+ # need and we will usher them to the appropriate places.
5
+ module Recurly
6
+ module Resources
7
+ class CreditApplicationPolicy < Resource
8
+
9
+ # @!attribute mode
10
+ # @return [String] Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
11
+ define_attribute :mode, String
12
+ end
13
+ end
14
+ end
@@ -241,6 +241,10 @@ module Recurly
241
241
  # @!attribute uuid
242
242
  # @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
243
243
  define_attribute :uuid, String
244
+
245
+ # @!attribute vertex_transaction_type
246
+ # @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
247
+ define_attribute :vertex_transaction_type, String
244
248
  end
245
249
  end
246
250
  end
@@ -10,6 +10,18 @@ module Recurly
10
10
  # @return [String] 3-letter ISO 4217 currency code.
11
11
  define_attribute :currency, String
12
12
 
13
+ # @!attribute date
14
+ # @return [String] The date of the conversion rate.
15
+ define_attribute :date, String
16
+
17
+ # @!attribute rate
18
+ # @return [String] The conversion rate to the currency.
19
+ define_attribute :rate, String
20
+
21
+ # @!attribute source
22
+ # @return [String] The source of the conversion rate.
23
+ define_attribute :source, String
24
+
13
25
  # @!attribute subtotal_in_cents
14
26
  # @return [Float] The subtotal converted to the currency.
15
27
  define_attribute :subtotal_in_cents, Float
@@ -66,6 +66,10 @@ module Recurly
66
66
  # @return [DateTime] Created at
67
67
  define_attribute :created_at, DateTime
68
68
 
69
+ # @!attribute credit_application_policy
70
+ # @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
71
+ define_attribute :credit_application_policy, :CreditApplicationPolicy
72
+
69
73
  # @!attribute currency
70
74
  # @return [String] 3-letter ISO 4217 currency code.
71
75
  define_attribute :currency, String
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.71.0"
2
+ VERSION = "4.72.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -20911,6 +20911,8 @@ components:
20911
20911
  default: 0
20912
20912
  net_terms_type:
20913
20913
  "$ref": "#/components/schemas/NetTermsTypeEnum"
20914
+ credit_application_policy:
20915
+ "$ref": "#/components/schemas/CreditApplicationPolicy"
20914
20916
  po_number:
20915
20917
  type: string
20916
20918
  title: Purchase order number
@@ -20932,6 +20934,8 @@ components:
20932
20934
  will default to the VAT Reverse Charge Notes text specified on the Tax
20933
20935
  Settings page in your Recurly admin, unless custom notes were created
20934
20936
  with the original subscription.
20937
+ vertex_transaction_type:
20938
+ "$ref": "#/components/schemas/VertexTransactionTypeEnum"
20935
20939
  required:
20936
20940
  - currency
20937
20941
  InvoiceCollect:
@@ -21462,6 +21466,8 @@ components:
21462
21466
  Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
21463
21467
  for more available t/s types.
21464
21468
  minimum: 0
21469
+ vertex_transaction_type:
21470
+ "$ref": "#/components/schemas/VertexTransactionTypeEnum"
21465
21471
  tax_code:
21466
21472
  type: string
21467
21473
  maxLength: 50
@@ -21717,6 +21723,8 @@ components:
21717
21723
  for more available t/s types. If an `Item` is associated to the `LineItem`,
21718
21724
  then the `avalara_service_type` must be absent.
21719
21725
  minimum: 0
21726
+ vertex_transaction_type:
21727
+ "$ref": "#/components/schemas/VertexTransactionTypeEnum"
21720
21728
  tax_code:
21721
21729
  type: string
21722
21730
  maxLength: 50
@@ -22507,6 +22515,19 @@ components:
22507
22515
  format: float
22508
22516
  title: Tax In Cents
22509
22517
  description: The tax converted to the currency.
22518
+ rate:
22519
+ type: string
22520
+ title: Rate
22521
+ description: The conversion rate to the currency.
22522
+ source:
22523
+ type: string
22524
+ title: Source
22525
+ description: The source of the conversion rate.
22526
+ date:
22527
+ type: string
22528
+ title: Date
22529
+ format: date
22530
+ description: The date of the conversion rate.
22510
22531
  ShippingAddressCreate:
22511
22532
  type: object
22512
22533
  properties:
@@ -23125,6 +23146,8 @@ components:
23125
23146
  default: 0
23126
23147
  net_terms_type:
23127
23148
  "$ref": "#/components/schemas/NetTermsTypeEnum"
23149
+ credit_application_policy:
23150
+ "$ref": "#/components/schemas/CreditApplicationPolicy"
23128
23151
  terms_and_conditions:
23129
23152
  type: string
23130
23153
  title: Terms and conditions
@@ -23976,6 +23999,8 @@ components:
23976
23999
  default: 0
23977
24000
  net_terms_type:
23978
24001
  "$ref": "#/components/schemas/NetTermsTypeEnum"
24002
+ credit_application_policy:
24003
+ "$ref": "#/components/schemas/CreditApplicationPolicy"
23979
24004
  gateway_code:
23980
24005
  type: string
23981
24006
  title: Gateway Code
@@ -24107,6 +24132,8 @@ components:
24107
24132
  description: The new set of ramp intervals for the subscription.
24108
24133
  items:
24109
24134
  "$ref": "#/components/schemas/SubscriptionRampInterval"
24135
+ credit_application_policy:
24136
+ "$ref": "#/components/schemas/CreditApplicationPolicy"
24110
24137
  bulk:
24111
24138
  type: boolean
24112
24139
  description: Optional field to be used only when needing to bypass the 60
@@ -24195,6 +24222,8 @@ components:
24195
24222
  default: 0
24196
24223
  net_terms_type:
24197
24224
  "$ref": "#/components/schemas/NetTermsTypeEnum"
24225
+ credit_application_policy:
24226
+ "$ref": "#/components/schemas/CreditApplicationPolicy"
24198
24227
  gateway_code:
24199
24228
  type: string
24200
24229
  title: Gateway Code
@@ -25033,6 +25062,8 @@ components:
25033
25062
  default: 0
25034
25063
  net_terms_type:
25035
25064
  "$ref": "#/components/schemas/NetTermsTypeEnum"
25065
+ credit_application_policy_override:
25066
+ "$ref": "#/components/schemas/CreditApplicationPolicy"
25036
25067
  terms_and_conditions:
25037
25068
  type: string
25038
25069
  title: Terms and conditions
@@ -25055,6 +25086,8 @@ components:
25055
25086
  type: string
25056
25087
  title: VAT reverse charge notes
25057
25088
  description: VAT reverse charge notes for cross border European tax settlement.
25089
+ vertex_transaction_type:
25090
+ "$ref": "#/components/schemas/VertexTransactionTypeEnum"
25058
25091
  credit_customer_notes:
25059
25092
  type: string
25060
25093
  title: Credit customer notes
@@ -26471,6 +26504,11 @@ components:
26471
26504
  type: string
26472
26505
  description: 3-letter ISO 4217 currency code.
26473
26506
  maxLength: 3
26507
+ tax_service_opt_out:
26508
+ title: Tax service opt-out
26509
+ type: boolean
26510
+ description: Set to `true` to bypass sending the purchase to your configured
26511
+ tax service. Defaults to `false`.
26474
26512
  delivery:
26475
26513
  title: Delivery details
26476
26514
  description: The delivery details for the gift card.
@@ -26735,6 +26773,15 @@ components:
26735
26773
  enum:
26736
26774
  - charge
26737
26775
  - credit
26776
+ VertexTransactionTypeEnum:
26777
+ type: string
26778
+ title: Vertex Transaction Type
26779
+ description: Used by Vertex for tax calculations. Possible values are sale,
26780
+ rental, lease.
26781
+ enum:
26782
+ - sale
26783
+ - rental
26784
+ - lease
26738
26785
  FilterTransactionTypeEnum:
26739
26786
  type: string
26740
26787
  enum:
@@ -27038,6 +27085,28 @@ components:
27038
27085
  enum:
27039
27086
  - automatic
27040
27087
  - manual
27088
+ CreditApplicationPolicy:
27089
+ type: object
27090
+ title: Credit Application Policy
27091
+ description: |
27092
+ Controls whether credit invoices are automatically applied to new invoices.
27093
+ The `mode` field determines the application behavior.
27094
+ properties:
27095
+ mode:
27096
+ "$ref": "#/components/schemas/CreditApplicationModeEnum"
27097
+ required:
27098
+ - mode
27099
+ CreditApplicationModeEnum:
27100
+ type: string
27101
+ title: Credit Application Mode
27102
+ description: |
27103
+ Determines which credit invoices are applied to invoices:
27104
+ - `all`: All available credit invoices are applied (default)
27105
+ - `none`: No credit invoices are applied automatically
27106
+ enum:
27107
+ - all
27108
+ - none
27109
+ default: all
27041
27110
  InvoiceRefundTypeEnum:
27042
27111
  type: string
27043
27112
  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.71.0
4
+ version: 4.72.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-11-05 00:00:00.000000000 Z
11
+ date: 2025-12-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: base64
@@ -183,6 +183,7 @@ files:
183
183
  - lib/recurly/requests/coupon_pricing.rb
184
184
  - lib/recurly/requests/coupon_redemption_create.rb
185
185
  - lib/recurly/requests/coupon_update.rb
186
+ - lib/recurly/requests/credit_application_policy.rb
186
187
  - lib/recurly/requests/custom_field.rb
187
188
  - lib/recurly/requests/dunning_campaigns_bulk_update.rb
188
189
  - lib/recurly/requests/external_account_create.rb
@@ -282,6 +283,7 @@ files:
282
283
  - lib/recurly/resources/coupon_mini.rb
283
284
  - lib/recurly/resources/coupon_redemption.rb
284
285
  - lib/recurly/resources/coupon_redemption_mini.rb
286
+ - lib/recurly/resources/credit_application_policy.rb
285
287
  - lib/recurly/resources/credit_payment.rb
286
288
  - lib/recurly/resources/custom_field.rb
287
289
  - lib/recurly/resources/custom_field_definition.rb
@@ -387,7 +389,7 @@ metadata:
387
389
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
388
390
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
389
391
  homepage_uri: https://github.com/recurly/recurly-client-ruby
390
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.71.0
392
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.72.0
391
393
  post_install_message:
392
394
  rdoc_options: []
393
395
  require_paths: