recurly 4.13.0 → 4.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +209 -136
- data/lib/recurly/requests/account_create.rb +1 -1
- data/lib/recurly/requests/account_purchase.rb +1 -1
- data/lib/recurly/requests/account_update.rb +1 -1
- data/lib/recurly/requests/billing_info_create.rb +8 -0
- data/lib/recurly/requests/plan_create.rb +1 -1
- data/lib/recurly/requests/plan_update.rb +1 -1
- data/lib/recurly/requests/subscription_add_on_tier.rb +1 -1
- data/lib/recurly/requests/tier.rb +1 -1
- data/lib/recurly/resources/account.rb +4 -4
- data/lib/recurly/resources/account_mini.rb +1 -1
- data/lib/recurly/resources/add_on.rb +4 -0
- data/lib/recurly/resources/invoice.rb +5 -1
- data/lib/recurly/resources/invoice_template.rb +34 -0
- data/lib/recurly/resources/percentage_tier.rb +18 -0
- data/lib/recurly/resources/{account_invoice_template.rb → percentage_tiers_by_currency.rb} +7 -7
- data/lib/recurly/resources/plan.rb +1 -1
- data/lib/recurly/resources/subscription_add_on.rb +4 -0
- data/lib/recurly/resources/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/resources/subscription_add_on_tier.rb +1 -1
- data/lib/recurly/resources/tier.rb +1 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +503 -58
- metadata +7 -4
@@ -39,7 +39,7 @@ module Recurly
|
|
39
39
|
define_attribute :custom_fields, Array, { :item_type => :CustomField }
|
40
40
|
|
41
41
|
# @!attribute dunning_campaign_id
|
42
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
42
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
43
43
|
define_attribute :dunning_campaign_id, String
|
44
44
|
|
45
45
|
# @!attribute email
|
@@ -39,7 +39,7 @@ module Recurly
|
|
39
39
|
define_attribute :custom_fields, Array, { :item_type => :CustomField }
|
40
40
|
|
41
41
|
# @!attribute dunning_campaign_id
|
42
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
42
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
43
43
|
define_attribute :dunning_campaign_id, String
|
44
44
|
|
45
45
|
# @!attribute email
|
@@ -31,7 +31,7 @@ module Recurly
|
|
31
31
|
define_attribute :custom_fields, Array, { :item_type => :CustomField }
|
32
32
|
|
33
33
|
# @!attribute dunning_campaign_id
|
34
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
34
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
35
35
|
define_attribute :dunning_campaign_id, String
|
36
36
|
|
37
37
|
# @!attribute email
|
@@ -34,6 +34,10 @@ module Recurly
|
|
34
34
|
# @return [String] *STRONGLY RECOMMENDED*
|
35
35
|
define_attribute :cvv, String
|
36
36
|
|
37
|
+
# @!attribute external_hpp_type
|
38
|
+
# @return [String] Use for Adyen HPP billing info.
|
39
|
+
define_attribute :external_hpp_type, String
|
40
|
+
|
37
41
|
# @!attribute first_name
|
38
42
|
# @return [String] First name
|
39
43
|
define_attribute :first_name, String
|
@@ -74,6 +78,10 @@ module Recurly
|
|
74
78
|
# @return [String] Credit card number, spaces and dashes are accepted.
|
75
79
|
define_attribute :number, String
|
76
80
|
|
81
|
+
# @!attribute online_banking_payment_type
|
82
|
+
# @return [String] Use for Online Banking billing info.
|
83
|
+
define_attribute :online_banking_payment_type, String
|
84
|
+
|
77
85
|
# @!attribute paypal_billing_agreement_id
|
78
86
|
# @return [String] PayPal billing agreement ID
|
79
87
|
define_attribute :paypal_billing_agreement_id, String
|
@@ -43,7 +43,7 @@ module Recurly
|
|
43
43
|
define_attribute :description, String
|
44
44
|
|
45
45
|
# @!attribute dunning_campaign_id
|
46
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
46
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
47
47
|
define_attribute :dunning_campaign_id, String
|
48
48
|
|
49
49
|
# @!attribute hosted_pages
|
@@ -39,7 +39,7 @@ module Recurly
|
|
39
39
|
define_attribute :description, String
|
40
40
|
|
41
41
|
# @!attribute dunning_campaign_id
|
42
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
42
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
43
43
|
define_attribute :dunning_campaign_id, String
|
44
44
|
|
45
45
|
# @!attribute hosted_pages
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :unit_amount_decimal, String
|
20
20
|
|
21
21
|
# @!attribute usage_percentage
|
22
|
-
# @return [String]
|
22
|
+
# @return [String] This field is deprecated. Do not used it anymore for percentage tiers subscription add ons. Use the percentage_tiers object instead.
|
23
23
|
define_attribute :usage_percentage, String
|
24
24
|
end
|
25
25
|
end
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :ending_quantity, Integer
|
16
16
|
|
17
17
|
# @!attribute usage_percentage
|
18
|
-
# @return [String]
|
18
|
+
# @return [String] This field is deprecated. Do not used it anymore for percentage tiers add ons. Use the percentage_tiers object instead.
|
19
19
|
define_attribute :usage_percentage, String
|
20
20
|
end
|
21
21
|
end
|
@@ -43,7 +43,7 @@ module Recurly
|
|
43
43
|
define_attribute :deleted_at, DateTime
|
44
44
|
|
45
45
|
# @!attribute dunning_campaign_id
|
46
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
46
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
47
47
|
define_attribute :dunning_campaign_id, String
|
48
48
|
|
49
49
|
# @!attribute email
|
@@ -90,9 +90,9 @@ module Recurly
|
|
90
90
|
# @return [String]
|
91
91
|
define_attribute :id, String
|
92
92
|
|
93
|
-
# @!attribute
|
94
|
-
# @return [
|
95
|
-
define_attribute :
|
93
|
+
# @!attribute invoice_template_id
|
94
|
+
# @return [String] Unique ID to identify an invoice template. Available when the Invoice Customization feature is enabled. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
|
95
|
+
define_attribute :invoice_template_id, String
|
96
96
|
|
97
97
|
# @!attribute last_name
|
98
98
|
# @return [String]
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :company, String
|
20
20
|
|
21
21
|
# @!attribute dunning_campaign_id
|
22
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
22
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
23
23
|
define_attribute :dunning_campaign_id, String
|
24
24
|
|
25
25
|
# @!attribute email
|
@@ -74,6 +74,10 @@ module Recurly
|
|
74
74
|
# @return [Boolean] Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
|
75
75
|
define_attribute :optional, :Boolean
|
76
76
|
|
77
|
+
# @!attribute percentage_tiers
|
78
|
+
# @return [Array[PercentageTiersByCurrency]] Percentage Tiers
|
79
|
+
define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
|
80
|
+
|
77
81
|
# @!attribute plan_id
|
78
82
|
# @return [String] Plan ID
|
79
83
|
define_attribute :plan_id, String
|
@@ -55,7 +55,7 @@ module Recurly
|
|
55
55
|
define_attribute :due_at, DateTime
|
56
56
|
|
57
57
|
# @!attribute dunning_campaign_id
|
58
|
-
# @return [String] Unique ID to identify the dunning campaign used when dunning the invoice.
|
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
61
|
# @!attribute has_more_line_items
|
@@ -146,6 +146,10 @@ module Recurly
|
|
146
146
|
# @return [DateTime] Last updated at
|
147
147
|
define_attribute :updated_at, DateTime
|
148
148
|
|
149
|
+
# @!attribute uuid
|
150
|
+
# @return [String] Invoice UUID
|
151
|
+
define_attribute :uuid, String
|
152
|
+
|
149
153
|
# @!attribute vat_number
|
150
154
|
# @return [String] VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
|
151
155
|
define_attribute :vat_number, String
|
@@ -0,0 +1,34 @@
|
|
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 InvoiceTemplate < Resource
|
8
|
+
|
9
|
+
# @!attribute code
|
10
|
+
# @return [String] Invoice template code.
|
11
|
+
define_attribute :code, String
|
12
|
+
|
13
|
+
# @!attribute created_at
|
14
|
+
# @return [DateTime] When the invoice template was created in Recurly.
|
15
|
+
define_attribute :created_at, DateTime
|
16
|
+
|
17
|
+
# @!attribute description
|
18
|
+
# @return [String] Invoice template description.
|
19
|
+
define_attribute :description, String
|
20
|
+
|
21
|
+
# @!attribute id
|
22
|
+
# @return [String]
|
23
|
+
define_attribute :id, String
|
24
|
+
|
25
|
+
# @!attribute name
|
26
|
+
# @return [String] Invoice template name.
|
27
|
+
define_attribute :name, String
|
28
|
+
|
29
|
+
# @!attribute updated_at
|
30
|
+
# @return [DateTime] When the invoice template was updated in Recurly.
|
31
|
+
define_attribute :updated_at, DateTime
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,18 @@
|
|
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 PercentageTier < Resource
|
8
|
+
|
9
|
+
# @!attribute ending_amount
|
10
|
+
# @return [Float] Ending amount for the tier. Allows up to 2 decimal places. The last tier ending_amount is null.
|
11
|
+
define_attribute :ending_amount, Float
|
12
|
+
|
13
|
+
# @!attribute usage_percentage
|
14
|
+
# @return [String] Decimal usage percentage.
|
15
|
+
define_attribute :usage_percentage, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -4,15 +4,15 @@
|
|
4
4
|
# need and we will usher them to the appropriate places.
|
5
5
|
module Recurly
|
6
6
|
module Resources
|
7
|
-
class
|
7
|
+
class PercentageTiersByCurrency < Resource
|
8
8
|
|
9
|
-
# @!attribute
|
10
|
-
# @return [String]
|
11
|
-
define_attribute :
|
9
|
+
# @!attribute currency
|
10
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
11
|
+
define_attribute :currency, String
|
12
12
|
|
13
|
-
# @!attribute
|
14
|
-
# @return [
|
15
|
-
define_attribute :
|
13
|
+
# @!attribute tiers
|
14
|
+
# @return [Array[PercentageTier]] Tiers
|
15
|
+
define_attribute :tiers, Array, { :item_type => :PercentageTier }
|
16
16
|
end
|
17
17
|
end
|
18
18
|
end
|
@@ -47,7 +47,7 @@ module Recurly
|
|
47
47
|
define_attribute :description, String
|
48
48
|
|
49
49
|
# @!attribute dunning_campaign_id
|
50
|
-
# @return [String] Unique ID to identify a dunning campaign.
|
50
|
+
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
51
51
|
define_attribute :dunning_campaign_id, String
|
52
52
|
|
53
53
|
# @!attribute hosted_pages
|
@@ -30,6 +30,10 @@ module Recurly
|
|
30
30
|
# @return [String] Object type
|
31
31
|
define_attribute :object, String
|
32
32
|
|
33
|
+
# @!attribute percentage_tiers
|
34
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.
|
35
|
+
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
36
|
+
|
33
37
|
# @!attribute quantity
|
34
38
|
# @return [Integer] Add-on quantity
|
35
39
|
define_attribute :quantity, Integer
|
@@ -0,0 +1,18 @@
|
|
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 SubscriptionAddOnPercentageTier < Resource
|
8
|
+
|
9
|
+
# @!attribute ending_amount
|
10
|
+
# @return [Float] Ending amount
|
11
|
+
define_attribute :ending_amount, Float
|
12
|
+
|
13
|
+
# @!attribute usage_percentage
|
14
|
+
# @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0.
|
15
|
+
define_attribute :usage_percentage, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :unit_amount_decimal, String
|
20
20
|
|
21
21
|
# @!attribute usage_percentage
|
22
|
-
# @return [String]
|
22
|
+
# @return [String] This field is deprecated. Do not used it anymore for percentage tiers subscription add ons. Use the percentage_tiers object instead.
|
23
23
|
define_attribute :usage_percentage, String
|
24
24
|
end
|
25
25
|
end
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :ending_quantity, Integer
|
16
16
|
|
17
17
|
# @!attribute usage_percentage
|
18
|
-
# @return [String]
|
18
|
+
# @return [String] This field is deprecated. Do not used it anymore for percentage tiers add ons. Use the percentage_tiers object instead.
|
19
19
|
define_attribute :usage_percentage, String
|
20
20
|
end
|
21
21
|
end
|
data/lib/recurly/version.rb
CHANGED