recurly 4.55.0 → 4.57.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: bec052486664e86016dba2616e73688fc2d084b14de08c705ef5e89d9af4a920
4
- data.tar.gz: 030cf089953c619d3000279186b9944849064094b24c9614a10cfa75e878633b
3
+ metadata.gz: '02596017f45c4a0f30364c23a90fe6eb1b0da5687651dea25146059002325f43'
4
+ data.tar.gz: ea769fbd9a052fa2c63c01bbcf281db0b9661d56acd883bb5d1c586e21682d18
5
5
  SHA512:
6
- metadata.gz: a692def551661809413225984acb0c946b692dc2ab51d5bf246e40b056b68043c47578742275726489eb702fda44a54ea2f3172ce3606b52af7ed9a160987983
7
- data.tar.gz: 3448a1ec74b6e710c07241afdae2f6081a6645b41a5f79c3b014b41174491bdb7768570ca8eb2a4c13d1084e69b60f05fb139930d591321277bf579b92e7045d
6
+ metadata.gz: 6cd2acc0f9cb1c24a299c1a93364fc21b0e401a42e3a06beadd6fd3675005dd664dd197ebd4a398abfb0a247dbccd9516dcb43f33205c44a2430f3bede685664
7
+ data.tar.gz: 4ece7465ff9bf395aa2198d81bb663ba2f011618ccf285efa520b5273ea6e4862e0fa883251f8c838fff51c86182a7b284e587845b2ca6193b14a54597dca46a
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.55.0
2
+ current_version = 4.57.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.57.0](https://github.com/recurly/recurly-client-ruby/tree/4.57.0) (2024-12-02)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.56.0...4.57.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25 [#917](https://github.com/recurly/recurly-client-ruby/pull/917) ([recurly-integrations](https://github.com/recurly-integrations))
11
+
12
+
13
+
14
+ ## [4.56.0](https://github.com/recurly/recurly-client-ruby/tree/4.56.0) (2024-10-30)
15
+
16
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.55.0...4.56.0)
17
+
18
+
19
+ **Merged Pull Requests**
20
+
21
+ - Adds bulk parameter to SubscriptionCreate and SubscriptionPurchase [#915](https://github.com/recurly/recurly-client-ruby/pull/915) ([recurly-integrations](https://github.com/recurly-integrations))
22
+
23
+
24
+
3
25
  ## [4.55.0](https://github.com/recurly/recurly-client-ruby/tree/4.55.0) (2024-08-28)
4
26
 
5
27
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.54.0...4.55.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.55'
8
+ gem 'recurly', '~> 4.57'
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.
@@ -133,6 +133,10 @@ module Recurly
133
133
  # @!attribute trial_unit
134
134
  # @return [String] Units for the plan's trial period.
135
135
  define_attribute :trial_unit, String
136
+
137
+ # @!attribute vertex_transaction_type
138
+ # @return [String] Used by Vertex for tax calculations. Possible values are `sale`, `rental`, `lease`.
139
+ define_attribute :vertex_transaction_type, String
136
140
  end
137
141
  end
138
142
  end
@@ -121,6 +121,10 @@ module Recurly
121
121
  # @!attribute trial_unit
122
122
  # @return [String] Units for the plan's trial period.
123
123
  define_attribute :trial_unit, String
124
+
125
+ # @!attribute vertex_transaction_type
126
+ # @return [String] Used by Vertex for tax calculations. Possible values are `sale`, `rental`, `lease`.
127
+ define_attribute :vertex_transaction_type, String
124
128
  end
125
129
  end
126
130
  end
@@ -22,6 +22,10 @@ module Recurly
22
22
  # @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
23
23
  define_attribute :billing_info_id, String
24
24
 
25
+ # @!attribute bulk
26
+ # @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.
27
+ define_attribute :bulk, :Boolean
28
+
25
29
  # @!attribute collection_method
26
30
  # @return [String] Collection method
27
31
  define_attribute :collection_method, String
@@ -14,6 +14,10 @@ module Recurly
14
14
  # @return [Boolean] Whether the subscription renews at the end of its term.
15
15
  define_attribute :auto_renew, :Boolean
16
16
 
17
+ # @!attribute bulk
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
+ define_attribute :bulk, :Boolean
20
+
17
21
  # @!attribute custom_fields
18
22
  # @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.
19
23
  define_attribute :custom_fields, Array, { :item_type => :CustomField }
@@ -129,6 +129,10 @@ module Recurly
129
129
  # @!attribute updated_at
130
130
  # @return [DateTime] Last updated at
131
131
  define_attribute :updated_at, DateTime
132
+
133
+ # @!attribute vertex_transaction_type
134
+ # @return [String] Used by Vertex for tax calculations. Possible values are `sale`, `rental`, `lease`.
135
+ define_attribute :vertex_transaction_type, String
132
136
  end
133
137
  end
134
138
  end
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.55.0"
2
+ VERSION = "4.57.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -9915,10 +9915,11 @@ paths:
9915
9915
  summary: Refund an invoice
9916
9916
  description: |
9917
9917
  There are two ways to do a refund:
9918
- * refund a specific amount which is divided across all the line items.
9919
- * refund quantities of line items.
9920
- If you want to refund the entire refundable amount on the invoice, the
9921
- simplest way is to do `type=amount` without specifiying an `amount`.
9918
+ * Apply a specific dollar/cent amount or percentage amount to an entire invoice, which will refund the resulting amount across all line items on the invoice.
9919
+ * If you want to refund the entire refundable amount on the invoice, the simplest way is to do `type=amount` without specifiying an `amount`.
9920
+ * Note: You must have the Credit Memos feature flag enabled on your site to utilize percentage amount refunds on invoices.
9921
+ * Apply a refund to one or more individual line items on an invoice. A line item can be refunded by a quantity amount, a specific dollar/cent amount, or a percentage amount and will only apply to the specific line item you are aiming to refund.
9922
+ * Note: You must have the Credit Memos feature flag enabled on your site to utilize specific dollar/cent amount and percentage amount refunds on line items.
9922
9923
  parameters:
9923
9924
  - "$ref": "#/components/parameters/invoice_id"
9924
9925
  requestBody:
@@ -21352,6 +21353,11 @@ components:
21352
21353
  title: Tax exempt?
21353
21354
  description: "`true` exempts tax on the plan, `false` applies tax on the
21354
21355
  plan."
21356
+ vertex_transaction_type:
21357
+ type: string
21358
+ title: Vertex Transaction Type
21359
+ description: Used by Vertex for tax calculations. Possible values are `sale`,
21360
+ `rental`, `lease`.
21355
21361
  currencies:
21356
21362
  type: array
21357
21363
  title: Pricing
@@ -21567,6 +21573,11 @@ components:
21567
21573
  title: Tax exempt?
21568
21574
  description: "`true` exempts tax on the plan, `false` applies tax on the
21569
21575
  plan."
21576
+ vertex_transaction_type:
21577
+ type: string
21578
+ title: Vertex Transaction Type
21579
+ description: Used by Vertex for tax calculations. Possible values are `sale`,
21580
+ `rental`, `lease`.
21570
21581
  currencies:
21571
21582
  type: array
21572
21583
  title: Pricing
@@ -21831,6 +21842,11 @@ components:
21831
21842
  title: Tax exempt?
21832
21843
  description: "`true` exempts tax on the plan, `false` applies tax on the
21833
21844
  plan."
21845
+ vertex_transaction_type:
21846
+ type: string
21847
+ title: Vertex Transaction Type
21848
+ description: Used by Vertex for tax calculations. Possible values are `sale`,
21849
+ `rental`, `lease`.
21834
21850
  currencies:
21835
21851
  type: array
21836
21852
  title: Pricing
@@ -23562,6 +23578,12 @@ components:
23562
23578
  title: Gift card Redemption Code
23563
23579
  description: A gift card redemption code to be redeemed on the purchase
23564
23580
  invoice.
23581
+ bulk:
23582
+ type: boolean
23583
+ description: Optional field to be used only when needing to bypass the 60
23584
+ second limit on creating subscriptions. Should only be used when creating
23585
+ subscriptions in bulk from the API.
23586
+ default: false
23565
23587
  required:
23566
23588
  - plan_code
23567
23589
  - currency
@@ -23664,6 +23686,12 @@ components:
23664
23686
  description: The new set of ramp intervals for the subscription.
23665
23687
  items:
23666
23688
  "$ref": "#/components/schemas/SubscriptionRampInterval"
23689
+ bulk:
23690
+ type: boolean
23691
+ description: Optional field to be used only when needing to bypass the 60
23692
+ second limit on creating subscriptions. Should only be used when creating
23693
+ subscriptions in bulk from the API.
23694
+ default: false
23667
23695
  required:
23668
23696
  - plan_code
23669
23697
  SubscriptionUpdate:
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.55.0
4
+ version: 4.57.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-08-28 00:00:00.000000000 Z
11
+ date: 2024-12-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -355,7 +355,7 @@ metadata:
355
355
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
356
356
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
357
357
  homepage_uri: https://github.com/recurly/recurly-client-ruby
358
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.55.0
358
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.57.0
359
359
  post_install_message:
360
360
  rdoc_options: []
361
361
  require_paths: