recurly 4.21.0 → 4.22.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: 461956ea7d4159327c37b2b54ce98540652bd173e3a5c8d96eebb97377090b98
4
- data.tar.gz: adf5d47eb201904c78973318eb3b4ebba0843e5c68607c3a929656fc2b505bf5
3
+ metadata.gz: ea38d9a4d3bcfd53d04e38127bcd75a152f974643151122a25d9e67293ae719c
4
+ data.tar.gz: 87f4f5d23c82902915df2665508e2ad93db45943413932e456fa983ef97d73c8
5
5
  SHA512:
6
- metadata.gz: 90d0d1aaec37a2bd5324560324eed493e4e7d3bbb5ea657e941a7d7a2e793b3cb442fd97398ad7afb49026def3928c5daaac028f90df230d9104f300d061b734
7
- data.tar.gz: '069b0be5d31e2a32eddc35e72d5342912bce1a1b95e00d718c49b7a49a654d98a8c24a78669d37d6fddf8f0b015a19abad79f3a88da22adf8d55130d6d07fdac'
6
+ metadata.gz: 916c2f6172f117706535aeed44ee39176afdaf05de6203f2088f0a29534d9fde5e4041c0aeee91411ee7ca6a5d9364b34a212bec24615c8cf8ba88148a225189
7
+ data.tar.gz: 5fe36efd973e04af109491e5bf385ffe0fc1bd6022498bbe8149f0345e4bb56c321eda85209e9fa694af99ea7f93abe6f53958a4d26c5b46f5a5aa1f3807bc54
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.21.0
2
+ current_version = 4.22.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.22.0](https://github.com/recurly/recurly-client-ruby/tree/4.22.0) (2022-10-21)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.21.1...4.22.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25(Decimal Usage and Quantities and DunningEvent new fields) [#801](https://github.com/recurly/recurly-client-ruby/pull/801) ([recurly-integrations](https://github.com/recurly-integrations))
11
+
12
+
13
+
14
+ ## [4.21.1](https://github.com/recurly/recurly-client-ruby/tree/4.21.1) (2022-09-08)
15
+
16
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.21.0...4.21.1)
17
+
18
+
19
+ **Merged Pull Requests**
20
+
21
+ - Generated Latest Changes for v2021-02-25 [#792](https://github.com/recurly/recurly-client-ruby/pull/792) ([recurly-integrations](https://github.com/recurly-integrations))
22
+
23
+
24
+
3
25
  ## [4.21.0](https://github.com/recurly/recurly-client-ruby/tree/4.21.0) (2022-09-07)
4
26
 
5
27
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.20.0...4.21.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.21'
8
+ gem 'recurly', '~> 4.22'
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.
@@ -39,7 +39,7 @@ module Recurly
39
39
  define_attribute :cvv, String
40
40
 
41
41
  # @!attribute external_hpp_type
42
- # @return [String] Use for Adyen HPP billing info.
42
+ # @return [String] Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
43
43
  define_attribute :external_hpp_type, String
44
44
 
45
45
  # @!attribute first_name
@@ -83,7 +83,7 @@ module Recurly
83
83
  define_attribute :number, String
84
84
 
85
85
  # @!attribute online_banking_payment_type
86
- # @return [String] Use for Online Banking billing info.
86
+ # @return [String] Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
87
87
  define_attribute :online_banking_payment_type, String
88
88
 
89
89
  # @!attribute paypal_billing_agreement_id
@@ -17,6 +17,10 @@ module Recurly
17
17
  # @!attribute quantity
18
18
  # @return [Integer] Line item quantity to be refunded.
19
19
  define_attribute :quantity, Integer
20
+
21
+ # @!attribute quantity_decimal
22
+ # @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
23
+ define_attribute :quantity_decimal, String
20
24
  end
21
25
  end
22
26
  end
@@ -7,7 +7,7 @@ module Recurly
7
7
  class UsageCreate < Request
8
8
 
9
9
  # @!attribute amount
10
- # @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
10
+ # @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
11
11
  define_attribute :amount, Float
12
12
 
13
13
  # @!attribute merchant_tag
@@ -58,6 +58,14 @@ module Recurly
58
58
  # @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
59
59
  define_attribute :dunning_campaign_id, String
60
60
 
61
+ # @!attribute dunning_events_sent
62
+ # @return [Integer] Number of times the event was sent.
63
+ define_attribute :dunning_events_sent, Integer
64
+
65
+ # @!attribute final_dunning_event
66
+ # @return [Boolean] Last communication attempt.
67
+ define_attribute :final_dunning_event, :Boolean
68
+
61
69
  # @!attribute has_more_line_items
62
70
  # @return [Boolean] Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
63
71
  define_attribute :has_more_line_items, :Boolean
@@ -130,6 +130,10 @@ module Recurly
130
130
  # @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
131
131
  define_attribute :quantity, Integer
132
132
 
133
+ # @!attribute quantity_decimal
134
+ # @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
135
+ define_attribute :quantity_decimal, String
136
+
133
137
  # @!attribute refund
134
138
  # @return [Boolean] Refund?
135
139
  define_attribute :refund, :Boolean
@@ -138,6 +142,10 @@ module Recurly
138
142
  # @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
139
143
  define_attribute :refunded_quantity, Integer
140
144
 
145
+ # @!attribute refunded_quantity_decimal
146
+ # @return [String] A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
147
+ define_attribute :refunded_quantity_decimal, String
148
+
141
149
  # @!attribute revenue_schedule_type
142
150
  # @return [String] Revenue schedule type
143
151
  define_attribute :revenue_schedule_type, String
@@ -15,8 +15,8 @@ module Recurly
15
15
  define_attribute :starting_billing_cycle, Integer
16
16
 
17
17
  # @!attribute unit_amount
18
- # @return [Integer] Represents the price for the ramp interval.
19
- define_attribute :unit_amount, Integer
18
+ # @return [Float] Represents the price for the ramp interval.
19
+ define_attribute :unit_amount, Float
20
20
  end
21
21
  end
22
22
  end
@@ -7,7 +7,7 @@ module Recurly
7
7
  class Usage < Resource
8
8
 
9
9
  # @!attribute amount
10
- # @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
10
+ # @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
11
11
  define_attribute :amount, Float
12
12
 
13
13
  # @!attribute billed_at
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.21.0"
2
+ VERSION = "4.22.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -18141,6 +18141,14 @@ components:
18141
18141
  description: Unique ID to identify the dunning campaign used when dunning
18142
18142
  the invoice. For sites without multiple dunning campaigns enabled, this
18143
18143
  will always be the default dunning campaign.
18144
+ dunning_events_sent:
18145
+ type: integer
18146
+ title: Dunning Event Sent
18147
+ description: Number of times the event was sent.
18148
+ final_dunning_event:
18149
+ type: boolean
18150
+ title: Final Dunning Event
18151
+ description: Last communication attempt.
18144
18152
  InvoiceCreate:
18145
18153
  type: object
18146
18154
  properties:
@@ -18622,6 +18630,14 @@ components:
18622
18630
  description: This number will be multiplied by the unit amount to compute
18623
18631
  the subtotal before any discounts or taxes.
18624
18632
  default: 1
18633
+ quantity_decimal:
18634
+ type: string
18635
+ title: Quantity Decimal
18636
+ description: A floating-point alternative to Quantity. If this value is
18637
+ present, it will be used in place of Quantity for calculations, and Quantity
18638
+ will be the rounded integer value of this number. This field supports
18639
+ up to 9 decimal places. The Decimal Quantity feature must be enabled to
18640
+ utilize this field.
18625
18641
  unit_amount:
18626
18642
  type: number
18627
18643
  format: float
@@ -18706,6 +18722,13 @@ components:
18706
18722
  title: Refunded Quantity
18707
18723
  description: For refund charges, the quantity being refunded. For non-refund
18708
18724
  charges, the total quantity refunded (possibly over multiple refunds).
18725
+ refunded_quantity_decimal:
18726
+ type: string
18727
+ title: Refunded Quantity Decimal
18728
+ description: A floating-point alternative to Refunded Quantity. For refund
18729
+ charges, the quantity being refunded. For non-refund charges, the total
18730
+ quantity refunded (possibly over multiple refunds). The Decimal Quantity
18731
+ feature must be enabled to utilize this field.
18709
18732
  credit_applied:
18710
18733
  type: number
18711
18734
  format: float
@@ -18747,6 +18770,14 @@ components:
18747
18770
  type: integer
18748
18771
  title: Quantity
18749
18772
  description: Line item quantity to be refunded.
18773
+ quantity_decimal:
18774
+ type: string
18775
+ title: Quantity Decimal
18776
+ description: A floating-point alternative to Quantity. If this value is
18777
+ present, it will be used in place of Quantity for calculations, and Quantity
18778
+ will be the rounded integer value of this number. This field supports
18779
+ up to 9 decimal places. The Decimal Quantity feature must be enabled to
18780
+ utilize this field.
18750
18781
  prorate:
18751
18782
  type: boolean
18752
18783
  title: Prorate
@@ -21302,7 +21333,9 @@ components:
21302
21333
  type: integer
21303
21334
  description: Represents how many billing cycles are left in a ramp interval.
21304
21335
  unit_amount:
21305
- type: integer
21336
+ type: number
21337
+ format: float
21338
+ title: Unit price
21306
21339
  description: Represents the price for the ramp interval.
21307
21340
  TaxInfo:
21308
21341
  type: object
@@ -21665,10 +21698,11 @@ components:
21665
21698
  amount:
21666
21699
  type: number
21667
21700
  format: float
21668
- description: The amount of usage. Can be positive, negative, or 0. No decimals
21669
- allowed, we will strip them. If the usage-based add-on is billed with
21670
- a percentage, your usage will be a monetary amount you will want to format
21671
- in cents. (e.g., $5.00 is "500").
21701
+ description: The amount of usage. Can be positive, negative, or 0. If the
21702
+ Decimal Quantity feature is enabled, this value will be rounded to nine
21703
+ decimal places. Otherwise, all digits after the decimal will be stripped.
21704
+ If the usage-based add-on is billed with a percentage, your usage should
21705
+ be a monetary amount formatted in cents (e.g., $5.00 is "500").
21672
21706
  usage_type:
21673
21707
  "$ref": "#/components/schemas/UsageTypeEnum"
21674
21708
  tier_type:
@@ -21739,10 +21773,11 @@ components:
21739
21773
  amount:
21740
21774
  type: number
21741
21775
  format: float
21742
- description: The amount of usage. Can be positive, negative, or 0. No decimals
21743
- allowed, we will strip them. If the usage-based add-on is billed with
21744
- a percentage, your usage will be a monetary amount you will want to format
21745
- in cents. (e.g., $5.00 is "500").
21776
+ description: The amount of usage. Can be positive, negative, or 0. If the
21777
+ Decimal Quantity feature is enabled, this value will be rounded to nine
21778
+ decimal places. Otherwise, all digits after the decimal will be stripped.
21779
+ If the usage-based add-on is billed with a percentage, your usage should
21780
+ be a monetary amount formatted in cents (e.g., $5.00 is "500").
21746
21781
  recording_timestamp:
21747
21782
  type: string
21748
21783
  format: date-time
@@ -23056,12 +23091,16 @@ components:
23056
23091
  - savings
23057
23092
  ExternalHppTypeEnum:
23058
23093
  type: string
23059
- description: Use for Adyen HPP billing info.
23094
+ description: Use for Adyen HPP billing info. This should only be used as part
23095
+ of a pending purchase request, when the billing info is nested inside an account
23096
+ object.
23060
23097
  enum:
23061
23098
  - adyen
23062
23099
  OnlineBankingPaymentTypeEnum:
23063
23100
  type: string
23064
- description: Use for Online Banking billing info.
23101
+ description: Use for Online Banking billing info. This should only be used as
23102
+ part of a pending purchase request, when the billing info is nested inside
23103
+ an account object.
23065
23104
  enum:
23066
23105
  - ideal
23067
23106
  - sofort
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.21.0
4
+ version: 4.22.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-09-07 00:00:00.000000000 Z
11
+ date: 2022-10-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -316,7 +316,7 @@ metadata:
316
316
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
317
317
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
318
318
  homepage_uri: https://github.com/recurly/recurly-client-ruby
319
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.21.0
319
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.22.0
320
320
  post_install_message:
321
321
  rdoc_options: []
322
322
  require_paths: