recurly 3.0.0.beta.3 → 3.0.0.beta.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.ruby-version +1 -0
- data/.travis.yml +3 -1
- data/README.md +9 -2
- data/lib/recurly/client.rb +42 -13
- data/lib/recurly/client/adapter.rb +9 -18
- data/lib/recurly/client/operations.rb +1179 -78
- data/lib/recurly/errors/api_errors.rb +4 -0
- data/lib/recurly/errors/network_errors.rb +1 -1
- data/lib/recurly/pager.rb +5 -1
- data/lib/recurly/requests/account_acquisition_cost.rb +18 -0
- data/lib/recurly/requests/account_acquisition_updatable.rb +5 -1
- data/lib/recurly/requests/account_create.rb +23 -3
- data/lib/recurly/requests/account_update.rb +22 -2
- data/lib/recurly/requests/add_on_create.rb +7 -3
- data/lib/recurly/requests/add_on_pricing.rb +18 -0
- data/lib/recurly/requests/add_on_update.rb +7 -3
- data/lib/recurly/requests/address.rb +4 -0
- data/lib/recurly/requests/billing_info_create.rb +4 -0
- data/lib/recurly/requests/coupon_bulk_create.rb +4 -0
- data/lib/recurly/requests/coupon_create.rb +13 -9
- data/lib/recurly/requests/coupon_pricing.rb +18 -0
- data/lib/recurly/requests/coupon_redemption_create.rb +4 -0
- data/lib/recurly/requests/coupon_update.rb +4 -0
- data/lib/recurly/requests/external_refund.rb +22 -0
- data/lib/recurly/requests/invoice_address.rb +54 -0
- data/lib/recurly/requests/invoice_create.rb +6 -2
- data/lib/recurly/requests/invoice_refund.rb +7 -3
- data/lib/recurly/requests/invoice_updatable.rb +34 -0
- data/lib/recurly/requests/line_item_create.rb +6 -2
- data/lib/recurly/requests/line_item_refund.rb +4 -0
- data/lib/recurly/requests/plan_create.rb +11 -7
- data/lib/recurly/requests/plan_hosted_pages.rb +26 -0
- data/lib/recurly/requests/plan_pricing.rb +22 -0
- data/lib/recurly/requests/plan_update.rb +11 -7
- data/lib/recurly/requests/shipping_address_create.rb +4 -0
- data/lib/recurly/requests/shipping_address_update.rb +5 -1
- data/lib/recurly/requests/subscription_add_on_create.rb +8 -0
- data/lib/recurly/requests/subscription_change_create.rb +13 -5
- data/lib/recurly/requests/subscription_create.rb +11 -7
- data/lib/recurly/requests/subscription_pause.rb +4 -0
- data/lib/recurly/requests/subscription_update.rb +8 -4
- data/lib/recurly/resource.rb +6 -6
- data/lib/recurly/resources/account.rb +27 -11
- data/lib/recurly/resources/account_acquisition.rb +9 -5
- data/lib/recurly/resources/account_acquisition_cost.rb +18 -0
- data/lib/recurly/resources/account_balance.rb +7 -3
- data/lib/recurly/resources/account_balance_amount.rb +18 -0
- data/lib/recurly/resources/account_mini.rb +18 -2
- data/lib/recurly/resources/account_note.rb +7 -3
- data/lib/recurly/resources/add_on.rb +13 -9
- data/lib/recurly/resources/add_on_mini.rb +6 -2
- data/lib/recurly/resources/add_on_pricing.rb +18 -0
- data/lib/recurly/resources/address.rb +4 -0
- data/lib/recurly/resources/billing_info.rb +12 -8
- data/lib/recurly/resources/billing_info_payment_method.rb +34 -0
- data/lib/recurly/resources/billing_info_updated_by.rb +18 -0
- data/lib/recurly/resources/coupon.rb +21 -13
- data/lib/recurly/resources/coupon_discount.rb +7 -3
- data/lib/recurly/resources/coupon_discount_pricing.rb +18 -0
- data/lib/recurly/resources/coupon_discount_trial.rb +18 -0
- data/lib/recurly/resources/coupon_mini.rb +8 -4
- data/lib/recurly/resources/coupon_redemption.rb +9 -5
- data/lib/recurly/resources/coupon_redemption_mini.rb +8 -4
- data/lib/recurly/resources/credit_payment.rb +8 -4
- data/lib/recurly/resources/custom_field.rb +4 -0
- data/lib/recurly/resources/custom_field_definition.rb +11 -7
- data/lib/recurly/resources/error.rb +6 -2
- data/lib/recurly/resources/error_may_have_transaction.rb +6 -2
- data/lib/recurly/resources/fraud_info.rb +22 -0
- data/lib/recurly/resources/invoice.rb +17 -13
- data/lib/recurly/resources/invoice_address.rb +54 -0
- data/lib/recurly/resources/invoice_collection.rb +5 -1
- data/lib/recurly/resources/invoice_mini.rb +6 -2
- data/lib/recurly/resources/line_item.rb +13 -5
- data/lib/recurly/resources/line_item_list.rb +5 -1
- data/lib/recurly/resources/plan.rb +16 -12
- data/lib/recurly/resources/plan_hosted_pages.rb +26 -0
- data/lib/recurly/resources/plan_mini.rb +6 -2
- data/lib/recurly/resources/plan_pricing.rb +22 -0
- data/lib/recurly/resources/settings.rb +7 -3
- data/lib/recurly/resources/shipping_address.rb +8 -4
- data/lib/recurly/resources/site.rb +16 -8
- data/lib/recurly/resources/subscription.rb +9 -5
- data/lib/recurly/resources/subscription_add_on.rb +4 -0
- data/lib/recurly/resources/subscription_change.rb +9 -5
- data/lib/recurly/resources/tax_info.rb +4 -0
- data/lib/recurly/resources/transaction.rb +16 -8
- data/lib/recurly/resources/transaction_payment_gateway.rb +26 -0
- data/lib/recurly/resources/transaction_payment_method.rb +34 -0
- data/lib/recurly/resources/unique_coupon_code.rb +10 -6
- data/lib/recurly/resources/user.rb +8 -4
- data/lib/recurly/schema/json_deserializer.rb +18 -20
- data/lib/recurly/schema/request_caster.rb +1 -1
- data/lib/recurly/schema/schema_validator.rb +31 -8
- data/lib/recurly/version.rb +1 -1
- data/recurly.gemspec +1 -1
- data/scripts/check-deps +28 -0
- data/scripts/install-deps +44 -0
- metadata +37 -7
@@ -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 BillingInfoPaymentMethod < Resource
|
8
|
+
|
9
|
+
# @!attribute card_type
|
10
|
+
# @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
|
11
|
+
define_attribute :card_type, String, { :enum => ["American Express", "Dankort", "Diners Club", "Discover", "Forbrugsforeningen", "JCB", "Laser", "Maestro", "MasterCard", "Test Card", "Unknown", "Visa"] }
|
12
|
+
|
13
|
+
# @!attribute exp_month
|
14
|
+
# @return [Integer] Expiration month.
|
15
|
+
define_attribute :exp_month, Integer
|
16
|
+
|
17
|
+
# @!attribute exp_year
|
18
|
+
# @return [Integer] Expiration year.
|
19
|
+
define_attribute :exp_year, Integer
|
20
|
+
|
21
|
+
# @!attribute first_six
|
22
|
+
# @return [String] Credit card number's first six digits.
|
23
|
+
define_attribute :first_six, String
|
24
|
+
|
25
|
+
# @!attribute last_four
|
26
|
+
# @return [String] Credit card number's last four digits.
|
27
|
+
define_attribute :last_four, String
|
28
|
+
|
29
|
+
# @!attribute object
|
30
|
+
# @return [String]
|
31
|
+
define_attribute :object, String
|
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 BillingInfoUpdatedBy < Resource
|
8
|
+
|
9
|
+
# @!attribute country
|
10
|
+
# @return [String] Country of IP address, if known by Recurly.
|
11
|
+
define_attribute :country, String
|
12
|
+
|
13
|
+
# @!attribute ip
|
14
|
+
# @return [String] Customer's IP address when updating their billing information.
|
15
|
+
define_attribute :ip, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -1,3 +1,7 @@
|
|
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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class Coupon < Resource
|
@@ -16,11 +20,11 @@ module Recurly
|
|
16
20
|
|
17
21
|
# @!attribute coupon_type
|
18
22
|
# @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
|
19
|
-
define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
|
23
|
+
define_attribute :coupon_type, String, { :enum => ["single_code", "bulk"] }
|
20
24
|
|
21
25
|
# @!attribute [r] created_at
|
22
26
|
# @return [DateTime] Created at
|
23
|
-
define_attribute :created_at, DateTime, {:read_only => true}
|
27
|
+
define_attribute :created_at, DateTime, { :read_only => true }
|
24
28
|
|
25
29
|
# @!attribute discount
|
26
30
|
# @return [CouponDiscount]
|
@@ -28,7 +32,7 @@ module Recurly
|
|
28
32
|
|
29
33
|
# @!attribute duration
|
30
34
|
# @return [String] - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
|
31
|
-
define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
|
35
|
+
define_attribute :duration, String, { :enum => ["forever", "single_use", "temporal"] }
|
32
36
|
|
33
37
|
# @!attribute expired_at
|
34
38
|
# @return [DateTime] The date and time the coupon was expired early or reached its `max_redemptions`.
|
@@ -40,7 +44,7 @@ module Recurly
|
|
40
44
|
|
41
45
|
# @!attribute free_trial_unit
|
42
46
|
# @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.
|
43
|
-
define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
|
47
|
+
define_attribute :free_trial_unit, String, { :enum => ["day", "week", "month"] }
|
44
48
|
|
45
49
|
# @!attribute hosted_page_description
|
46
50
|
# @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
|
@@ -48,7 +52,7 @@ module Recurly
|
|
48
52
|
|
49
53
|
# @!attribute [r] id
|
50
54
|
# @return [String] Coupon ID
|
51
|
-
define_attribute :id, String, {:read_only => true}
|
55
|
+
define_attribute :id, String, { :read_only => true }
|
52
56
|
|
53
57
|
# @!attribute invoice_description
|
54
58
|
# @return [String] Description of the coupon on the invoice.
|
@@ -68,15 +72,15 @@ module Recurly
|
|
68
72
|
|
69
73
|
# @!attribute [r] object
|
70
74
|
# @return [String] Object type
|
71
|
-
define_attribute :object, String, {:read_only => true}
|
75
|
+
define_attribute :object, String, { :read_only => true }
|
72
76
|
|
73
77
|
# @!attribute plans
|
74
78
|
# @return [Array[PlanMini]] Plans
|
75
|
-
define_attribute :plans, Array, {:item_type => :PlanMini}
|
79
|
+
define_attribute :plans, Array, { :item_type => :PlanMini }
|
76
80
|
|
77
81
|
# @!attribute plans_names
|
78
82
|
# @return [Array[String]] TODO
|
79
|
-
define_attribute :plans_names, Array, {:item_type => String}
|
83
|
+
define_attribute :plans_names, Array, { :item_type => String }
|
80
84
|
|
81
85
|
# @!attribute redeem_by
|
82
86
|
# @return [DateTime] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
|
@@ -84,11 +88,11 @@ module Recurly
|
|
84
88
|
|
85
89
|
# @!attribute redemption_resource
|
86
90
|
# @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
|
87
|
-
define_attribute :redemption_resource, String, {:enum => ["account", "subscription"]}
|
91
|
+
define_attribute :redemption_resource, String, { :enum => ["account", "subscription"] }
|
88
92
|
|
89
93
|
# @!attribute state
|
90
94
|
# @return [String] Indicates if the coupon is redeemable, and if it is not, why.
|
91
|
-
define_attribute :state, String, {:enum => ["redeemable", "maxed_out", "expired"]}
|
95
|
+
define_attribute :state, String, { :enum => ["redeemable", "maxed_out", "expired"] }
|
92
96
|
|
93
97
|
# @!attribute temporal_amount
|
94
98
|
# @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
|
@@ -96,15 +100,19 @@ module Recurly
|
|
96
100
|
|
97
101
|
# @!attribute temporal_unit
|
98
102
|
# @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
|
99
|
-
define_attribute :temporal_unit, String, {:enum => ["day", "week", "month", "year"]}
|
103
|
+
define_attribute :temporal_unit, String, { :enum => ["day", "week", "month", "year"] }
|
104
|
+
|
105
|
+
# @!attribute unique_code_template
|
106
|
+
# @return [String] On a bulk coupon, the template from which unique coupon codes are generated.
|
107
|
+
define_attribute :unique_code_template, String
|
100
108
|
|
101
109
|
# @!attribute [r] unique_coupon_codes_count
|
102
110
|
# @return [Integer] When this number reaches `max_redemptions` the coupon will no longer be redeemable.
|
103
|
-
define_attribute :unique_coupon_codes_count, Integer, {:read_only => true}
|
111
|
+
define_attribute :unique_coupon_codes_count, Integer, { :read_only => true }
|
104
112
|
|
105
113
|
# @!attribute [r] updated_at
|
106
114
|
# @return [DateTime] Last updated at
|
107
|
-
define_attribute :updated_at, DateTime, {:read_only => true}
|
115
|
+
define_attribute :updated_at, DateTime, { :read_only => true }
|
108
116
|
end
|
109
117
|
end
|
110
118
|
end
|
@@ -1,10 +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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CouponDiscount < Resource
|
4
8
|
|
5
9
|
# @!attribute currencies
|
6
|
-
# @return [Array[
|
7
|
-
define_attribute :currencies, Array, {:item_type =>
|
10
|
+
# @return [Array[CouponDiscountPricing]] This is only present when `type=fixed`.
|
11
|
+
define_attribute :currencies, Array, { :item_type => :CouponDiscountPricing }
|
8
12
|
|
9
13
|
# @!attribute percent
|
10
14
|
# @return [Integer] This is only present when `type=percent`.
|
@@ -16,7 +20,7 @@ module Recurly
|
|
16
20
|
|
17
21
|
# @!attribute type
|
18
22
|
# @return [String]
|
19
|
-
define_attribute :type, String, {:enum => ["percent", "fixed", "free_trial"]}
|
23
|
+
define_attribute :type, String, { :enum => ["percent", "fixed", "free_trial"] }
|
20
24
|
end
|
21
25
|
end
|
22
26
|
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 CouponDiscountPricing < Resource
|
8
|
+
|
9
|
+
# @!attribute amount
|
10
|
+
# @return [Float] Value of the fixed discount that this coupon applies.
|
11
|
+
define_attribute :amount, Float
|
12
|
+
|
13
|
+
# @!attribute currency
|
14
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
15
|
+
define_attribute :currency, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
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 CouponDiscountTrial < Resource
|
8
|
+
|
9
|
+
# @!attribute length
|
10
|
+
# @return [Integer] Trial length measured in the units specified by the sibling `unit` property
|
11
|
+
define_attribute :length, Integer
|
12
|
+
|
13
|
+
# @!attribute unit
|
14
|
+
# @return [String] Temporal unit of the free trial
|
15
|
+
define_attribute :unit, String, { :enum => ["day", "week", "month"] }
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -1,3 +1,7 @@
|
|
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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CouponMini < Resource
|
@@ -8,7 +12,7 @@ module Recurly
|
|
8
12
|
|
9
13
|
# @!attribute coupon_type
|
10
14
|
# @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
|
11
|
-
define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
|
15
|
+
define_attribute :coupon_type, String, { :enum => ["single_code", "bulk"] }
|
12
16
|
|
13
17
|
# @!attribute discount
|
14
18
|
# @return [CouponDiscount]
|
@@ -20,7 +24,7 @@ module Recurly
|
|
20
24
|
|
21
25
|
# @!attribute [r] id
|
22
26
|
# @return [String] Coupon ID
|
23
|
-
define_attribute :id, String, {:read_only => true}
|
27
|
+
define_attribute :id, String, { :read_only => true }
|
24
28
|
|
25
29
|
# @!attribute name
|
26
30
|
# @return [String] The internal name for the coupon.
|
@@ -28,11 +32,11 @@ module Recurly
|
|
28
32
|
|
29
33
|
# @!attribute [r] object
|
30
34
|
# @return [String] Object type
|
31
|
-
define_attribute :object, String, {:read_only => true}
|
35
|
+
define_attribute :object, String, { :read_only => true }
|
32
36
|
|
33
37
|
# @!attribute state
|
34
38
|
# @return [String] Indicates if the coupon is redeemable, and if it is not, why.
|
35
|
-
define_attribute :state, String, {:enum => ["redeemable", "maxed_out", "expired"]}
|
39
|
+
define_attribute :state, String, { :enum => ["redeemable", "maxed_out", "expired"] }
|
36
40
|
end
|
37
41
|
end
|
38
42
|
end
|
@@ -1,3 +1,7 @@
|
|
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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CouponRedemption < Resource
|
@@ -12,7 +16,7 @@ module Recurly
|
|
12
16
|
|
13
17
|
# @!attribute [r] created_at
|
14
18
|
# @return [DateTime] Created at
|
15
|
-
define_attribute :created_at, DateTime, {:read_only => true}
|
19
|
+
define_attribute :created_at, DateTime, { :read_only => true }
|
16
20
|
|
17
21
|
# @!attribute currency
|
18
22
|
# @return [String] 3-letter ISO 4217 currency code.
|
@@ -24,11 +28,11 @@ module Recurly
|
|
24
28
|
|
25
29
|
# @!attribute [r] id
|
26
30
|
# @return [String] Coupon Redemption ID
|
27
|
-
define_attribute :id, String, {:read_only => true}
|
31
|
+
define_attribute :id, String, { :read_only => true }
|
28
32
|
|
29
33
|
# @!attribute [r] object
|
30
34
|
# @return [String] Will always be `coupon`.
|
31
|
-
define_attribute :object, String, {:read_only => true}
|
35
|
+
define_attribute :object, String, { :read_only => true }
|
32
36
|
|
33
37
|
# @!attribute removed_at
|
34
38
|
# @return [DateTime] The date and time the redemption was removed from the account (un-redeemed).
|
@@ -36,11 +40,11 @@ module Recurly
|
|
36
40
|
|
37
41
|
# @!attribute state
|
38
42
|
# @return [String] Coupon Redemption state
|
39
|
-
define_attribute :state, String, {:enum => ["active", "inactive"]}
|
43
|
+
define_attribute :state, String, { :enum => ["active", "inactive"] }
|
40
44
|
|
41
45
|
# @!attribute [r] updated_at
|
42
46
|
# @return [DateTime] Last updated at
|
43
|
-
define_attribute :updated_at, DateTime, {:read_only => true}
|
47
|
+
define_attribute :updated_at, DateTime, { :read_only => true }
|
44
48
|
end
|
45
49
|
end
|
46
50
|
end
|
@@ -1,3 +1,7 @@
|
|
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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CouponRedemptionMini < Resource
|
@@ -8,7 +12,7 @@ module Recurly
|
|
8
12
|
|
9
13
|
# @!attribute [r] created_at
|
10
14
|
# @return [DateTime] Created at
|
11
|
-
define_attribute :created_at, DateTime, {:read_only => true}
|
15
|
+
define_attribute :created_at, DateTime, { :read_only => true }
|
12
16
|
|
13
17
|
# @!attribute discounted
|
14
18
|
# @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
|
@@ -16,15 +20,15 @@ module Recurly
|
|
16
20
|
|
17
21
|
# @!attribute [r] id
|
18
22
|
# @return [String] Coupon Redemption ID
|
19
|
-
define_attribute :id, String, {:read_only => true}
|
23
|
+
define_attribute :id, String, { :read_only => true }
|
20
24
|
|
21
25
|
# @!attribute [r] object
|
22
26
|
# @return [String] Will always be `coupon`.
|
23
|
-
define_attribute :object, String, {:read_only => true}
|
27
|
+
define_attribute :object, String, { :read_only => true }
|
24
28
|
|
25
29
|
# @!attribute state
|
26
30
|
# @return [String] Invoice state
|
27
|
-
define_attribute :state, String, {:enum => ["active", "inactive"]}
|
31
|
+
define_attribute :state, String, { :enum => ["active", "inactive"] }
|
28
32
|
end
|
29
33
|
end
|
30
34
|
end
|
@@ -1,3 +1,7 @@
|
|
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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CreditPayment < Resource
|
@@ -8,7 +12,7 @@ module Recurly
|
|
8
12
|
|
9
13
|
# @!attribute action
|
10
14
|
# @return [String] The action for which the credit was created.
|
11
|
-
define_attribute :action, String, {:enum => ["payment", "refund", "reduction", "write_off"]}
|
15
|
+
define_attribute :action, String, { :enum => ["payment", "refund", "reduction", "write_off"] }
|
12
16
|
|
13
17
|
# @!attribute amount
|
14
18
|
# @return [Float] Total credit payment amount applied to the charge invoice.
|
@@ -20,7 +24,7 @@ module Recurly
|
|
20
24
|
|
21
25
|
# @!attribute [r] created_at
|
22
26
|
# @return [DateTime] Created at
|
23
|
-
define_attribute :created_at, DateTime, {:read_only => true}
|
27
|
+
define_attribute :created_at, DateTime, { :read_only => true }
|
24
28
|
|
25
29
|
# @!attribute currency
|
26
30
|
# @return [String] 3-letter ISO 4217 currency code.
|
@@ -48,7 +52,7 @@ module Recurly
|
|
48
52
|
|
49
53
|
# @!attribute [r] updated_at
|
50
54
|
# @return [DateTime] Last updated at
|
51
|
-
define_attribute :updated_at, DateTime, {:read_only => true}
|
55
|
+
define_attribute :updated_at, DateTime, { :read_only => true }
|
52
56
|
|
53
57
|
# @!attribute uuid
|
54
58
|
# @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
|
@@ -56,7 +60,7 @@ module Recurly
|
|
56
60
|
|
57
61
|
# @!attribute [r] voided_at
|
58
62
|
# @return [DateTime] Voided at
|
59
|
-
define_attribute :voided_at, DateTime, {:read_only => true}
|
63
|
+
define_attribute :voided_at, DateTime, { :read_only => true }
|
60
64
|
end
|
61
65
|
end
|
62
66
|
end
|
@@ -1,3 +1,7 @@
|
|
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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CustomField < Resource
|
@@ -1,14 +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.
|
1
5
|
module Recurly
|
2
6
|
module Resources
|
3
7
|
class CustomFieldDefinition < Resource
|
4
8
|
|
5
9
|
# @!attribute [r] created_at
|
6
10
|
# @return [DateTime] Created at
|
7
|
-
define_attribute :created_at, DateTime, {:read_only => true}
|
11
|
+
define_attribute :created_at, DateTime, { :read_only => true }
|
8
12
|
|
9
13
|
# @!attribute [r] deleted_at
|
10
14
|
# @return [DateTime] Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
|
11
|
-
define_attribute :deleted_at, DateTime, {:read_only => true}
|
15
|
+
define_attribute :deleted_at, DateTime, { :read_only => true }
|
12
16
|
|
13
17
|
# @!attribute display_name
|
14
18
|
# @return [String] Used to label the field when viewing and editing the field in Recurly's admin UI.
|
@@ -16,7 +20,7 @@ module Recurly
|
|
16
20
|
|
17
21
|
# @!attribute [r] id
|
18
22
|
# @return [String] Custom field definition ID
|
19
|
-
define_attribute :id, String, {:read_only => true}
|
23
|
+
define_attribute :id, String, { :read_only => true }
|
20
24
|
|
21
25
|
# @!attribute name
|
22
26
|
# @return [String] Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
|
@@ -24,11 +28,11 @@ module Recurly
|
|
24
28
|
|
25
29
|
# @!attribute [r] object
|
26
30
|
# @return [String] Object type
|
27
|
-
define_attribute :object, String, {:read_only => true}
|
31
|
+
define_attribute :object, String, { :read_only => true }
|
28
32
|
|
29
33
|
# @!attribute related_type
|
30
34
|
# @return [String] Related Recurly object type
|
31
|
-
define_attribute :related_type, String, {:enum => ["account", "subscription"]}
|
35
|
+
define_attribute :related_type, String, { :enum => ["account", "subscription"] }
|
32
36
|
|
33
37
|
# @!attribute tooltip
|
34
38
|
# @return [String] Displayed as a tooltip when editing the field in the Recurly admin UI.
|
@@ -36,11 +40,11 @@ module Recurly
|
|
36
40
|
|
37
41
|
# @!attribute [r] updated_at
|
38
42
|
# @return [DateTime] Last updated at
|
39
|
-
define_attribute :updated_at, DateTime, {:read_only => true}
|
43
|
+
define_attribute :updated_at, DateTime, { :read_only => true }
|
40
44
|
|
41
45
|
# @!attribute user_access
|
42
46
|
# @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
|
43
|
-
define_attribute :user_access, String, {:enum => ["api_only", "read_only", "write"]}
|
47
|
+
define_attribute :user_access, String, { :enum => ["api_only", "read_only", "write"] }
|
44
48
|
end
|
45
49
|
end
|
46
50
|
end
|