recurly 3.12.0 → 3.13.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 +4 -4
- data/.bumpversion.cfg +1 -1
- data/CHANGELOG.md +14 -2
- data/GETTING_STARTED.md +1 -1
- data/README.md +1 -1
- data/lib/recurly/client/operations.rb +27 -0
- data/lib/recurly/requests/add_on_create.rb +2 -2
- data/lib/recurly/requests/line_item_create.rb +1 -1
- data/lib/recurly/requests/subscription_add_on_create.rb +2 -2
- data/lib/recurly/resources/coupon.rb +9 -1
- data/lib/recurly/resources/export_dates.rb +18 -0
- data/lib/recurly/resources/export_file.rb +22 -0
- data/lib/recurly/resources/export_files.rb +18 -0
- data/lib/recurly/resources/unique_coupon_code.rb +8 -0
- data/lib/recurly/resources/usage.rb +8 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +176 -12
- metadata +6 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7c48112c86ab321b7bb9d86cfcccf0e1189cd202c83a075c4432b7c626364a07
|
4
|
+
data.tar.gz: 7e43cc5263d62818e7520468a23de1e8a7f80cf7d3060a9e08651aeb7c424e82
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d5e0f86d3a84696d2f3b23bb19ecd5188f49befd73350e2db32a2aa833e0e0c94e1ad1dbcf20d1f0ed964b1e0e1c8b581038c3beece02e452e7e81878e47bc5e
|
7
|
+
data.tar.gz: 0c4f56e756ded152b7a25399168a4a595c003678f52ef14cce0c7e41d3f716aff94fc9b21d5cec9ce4ab9d95b0ae160bcba210b75fa4941fc67f5ebe2f4c268f
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,8 +1,20 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
-
## [3.
|
3
|
+
## [3.13.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
|
4
4
|
|
5
|
-
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.12.0...HEAD)
|
6
|
+
|
7
|
+
**Implemented enhancements:**
|
8
|
+
|
9
|
+
- Latest Changes for 2019-10-10 \(Automated Exports, additional resource data attributes\) [\#638](https://github.com/recurly/recurly-client-ruby/pull/638) ([douglasmiller](https://github.com/douglasmiller))
|
10
|
+
|
11
|
+
**Merged pull requests:**
|
12
|
+
|
13
|
+
- Release 3.13.0 [\#639](https://github.com/recurly/recurly-client-ruby/pull/639) ([douglasmiller](https://github.com/douglasmiller))
|
14
|
+
|
15
|
+
## [3.12.0](https://github.com/recurly/recurly-client-ruby/tree/3.12.0) (2020-08-31)
|
16
|
+
|
17
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.11.0...3.12.0)
|
6
18
|
|
7
19
|
**Implemented enhancements:**
|
8
20
|
|
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', '~> 3.
|
8
|
+
gem 'recurly', '~> 3.13'
|
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.
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Recurly
|
2
2
|
|
3
3
|
[](https://rubygems.org/gems/recurly)
|
4
|
-
[](
|
4
|
+
[](CODE_OF_CONDUCT.md)
|
5
5
|
|
6
6
|
This repository houses the official ruby client for Recurly's V3 API.
|
7
7
|
|
@@ -3597,5 +3597,32 @@ module Recurly
|
|
3597
3597
|
path = interpolate_path("/purchases/preview")
|
3598
3598
|
post(path, body, Requests::PurchaseCreate, **options)
|
3599
3599
|
end
|
3600
|
+
|
3601
|
+
# List the dates that have an available export to download.
|
3602
|
+
#
|
3603
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_export_dates get_export_dates api documenation}
|
3604
|
+
#
|
3605
|
+
# @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3606
|
+
#
|
3607
|
+
# @return [Resources::ExportDates] Returns a list of dates.
|
3608
|
+
#
|
3609
|
+
def get_export_dates(**options)
|
3610
|
+
path = interpolate_path("/export_dates")
|
3611
|
+
get(path, **options)
|
3612
|
+
end
|
3613
|
+
|
3614
|
+
# List of the export files that are available to download.
|
3615
|
+
#
|
3616
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_export_files get_export_files api documenation}
|
3617
|
+
#
|
3618
|
+
# @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
|
3619
|
+
# @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
3620
|
+
#
|
3621
|
+
# @return [Resources::ExportFiles] Returns a list of export files to download.
|
3622
|
+
#
|
3623
|
+
def get_export_files(export_date:, **options)
|
3624
|
+
path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
|
3625
|
+
get(path, **options)
|
3626
|
+
end
|
3600
3627
|
end
|
3601
3628
|
end
|
@@ -75,7 +75,7 @@ module Recurly
|
|
75
75
|
define_attribute :tax_code, String
|
76
76
|
|
77
77
|
# @!attribute tier_type
|
78
|
-
# @return [String] The pricing model for the add-on. For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based).
|
78
|
+
# @return [String] The pricing model for the add-on. For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
|
79
79
|
define_attribute :tier_type, String
|
80
80
|
|
81
81
|
# @!attribute tiers
|
@@ -87,7 +87,7 @@ module Recurly
|
|
87
87
|
define_attribute :usage_percentage, Float
|
88
88
|
|
89
89
|
# @!attribute usage_type
|
90
|
-
# @return [String] Type of usage, required if `add_on_type` is `usage`.
|
90
|
+
# @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
|
91
91
|
define_attribute :usage_type, String
|
92
92
|
end
|
93
93
|
end
|
@@ -43,7 +43,7 @@ module Recurly
|
|
43
43
|
define_attribute :item_id, String
|
44
44
|
|
45
45
|
# @!attribute origin
|
46
|
-
# @return [String]
|
46
|
+
# @return [String] Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements. Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true. This origin creates a charge and opposite credit on the account to be used for future invoices.
|
47
47
|
define_attribute :origin, String
|
48
48
|
|
49
49
|
# @!attribute product_code
|
@@ -23,7 +23,7 @@ module Recurly
|
|
23
23
|
define_attribute :revenue_schedule_type, String
|
24
24
|
|
25
25
|
# @!attribute tiers
|
26
|
-
# @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
|
26
|
+
# @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
|
27
27
|
define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
|
28
28
|
|
29
29
|
# @!attribute unit_amount
|
@@ -31,7 +31,7 @@ module Recurly
|
|
31
31
|
define_attribute :unit_amount, Float
|
32
32
|
|
33
33
|
# @!attribute usage_percentage
|
34
|
-
# @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers.
|
34
|
+
# @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
|
35
35
|
define_attribute :usage_percentage, Float
|
36
36
|
end
|
37
37
|
end
|
@@ -14,6 +14,14 @@ module Recurly
|
|
14
14
|
# @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
|
15
15
|
define_attribute :applies_to_non_plan_charges, :Boolean
|
16
16
|
|
17
|
+
# @!attribute bulk_coupon_code
|
18
|
+
# @return [String] The Coupon code of the parent Bulk Coupon
|
19
|
+
define_attribute :bulk_coupon_code, String
|
20
|
+
|
21
|
+
# @!attribute bulk_coupon_id
|
22
|
+
# @return [String] The Coupon ID of the parent Bulk Coupon
|
23
|
+
define_attribute :bulk_coupon_id, String
|
24
|
+
|
17
25
|
# @!attribute code
|
18
26
|
# @return [String] The code the customer enters to redeem the coupon.
|
19
27
|
define_attribute :code, String
|
@@ -79,7 +87,7 @@ module Recurly
|
|
79
87
|
define_attribute :plans, Array, { :item_type => :PlanMini }
|
80
88
|
|
81
89
|
# @!attribute plans_names
|
82
|
-
# @return [Array[String]]
|
90
|
+
# @return [Array[String]] A list of plan names for which this coupon applies.
|
83
91
|
define_attribute :plans_names, Array, { :item_type => String }
|
84
92
|
|
85
93
|
# @!attribute redeem_by
|
@@ -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 ExportDates < Resource
|
8
|
+
|
9
|
+
# @!attribute dates
|
10
|
+
# @return [Array[String]] An array of dates that have available exports.
|
11
|
+
define_attribute :dates, Array, { :item_type => String }
|
12
|
+
|
13
|
+
# @!attribute object
|
14
|
+
# @return [String] Object type
|
15
|
+
define_attribute :object, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,22 @@
|
|
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 ExportFile < Resource
|
8
|
+
|
9
|
+
# @!attribute href
|
10
|
+
# @return [String] A presigned link to download the export file.
|
11
|
+
define_attribute :href, String
|
12
|
+
|
13
|
+
# @!attribute md5sum
|
14
|
+
# @return [String] MD5 hash of the export file.
|
15
|
+
define_attribute :md5sum, String
|
16
|
+
|
17
|
+
# @!attribute name
|
18
|
+
# @return [String] Name of the export file.
|
19
|
+
define_attribute :name, String
|
20
|
+
end
|
21
|
+
end
|
22
|
+
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 ExportFiles < Resource
|
8
|
+
|
9
|
+
# @!attribute files
|
10
|
+
# @return [Array[ExportFile]]
|
11
|
+
define_attribute :files, Array, { :item_type => :ExportFile }
|
12
|
+
|
13
|
+
# @!attribute object
|
14
|
+
# @return [String] Object type
|
15
|
+
define_attribute :object, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -6,6 +6,14 @@ module Recurly
|
|
6
6
|
module Resources
|
7
7
|
class UniqueCouponCode < Resource
|
8
8
|
|
9
|
+
# @!attribute bulk_coupon_code
|
10
|
+
# @return [String] The Coupon code of the parent Bulk Coupon
|
11
|
+
define_attribute :bulk_coupon_code, String
|
12
|
+
|
13
|
+
# @!attribute bulk_coupon_id
|
14
|
+
# @return [String] The Coupon ID of the parent Bulk Coupon
|
15
|
+
define_attribute :bulk_coupon_id, String
|
16
|
+
|
9
17
|
# @!attribute code
|
10
18
|
# @return [String] The code the customer enters to redeem the coupon.
|
11
19
|
define_attribute :code, String
|
@@ -46,10 +46,18 @@ module Recurly
|
|
46
46
|
# @return [Array[SubscriptionAddOnTier]] The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = null
|
47
47
|
define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
|
48
48
|
|
49
|
+
# @!attribute unit_amount
|
50
|
+
# @return [Float] Unit price
|
51
|
+
define_attribute :unit_amount, Float
|
52
|
+
|
49
53
|
# @!attribute updated_at
|
50
54
|
# @return [DateTime] When the usage record was billed on an invoice.
|
51
55
|
define_attribute :updated_at, DateTime
|
52
56
|
|
57
|
+
# @!attribute usage_percentage
|
58
|
+
# @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
|
59
|
+
define_attribute :usage_percentage, Float
|
60
|
+
|
53
61
|
# @!attribute usage_timestamp
|
54
62
|
# @return [DateTime] When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
|
55
63
|
define_attribute :usage_timestamp, DateTime
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -158,6 +158,7 @@ x-tagGroups:
|
|
158
158
|
- shipping_address
|
159
159
|
- purchase
|
160
160
|
- usage
|
161
|
+
- automated_exports
|
161
162
|
- name: Products and Promotions
|
162
163
|
tags:
|
163
164
|
- item
|
@@ -282,6 +283,9 @@ tags:
|
|
282
283
|
- name: shipping_method
|
283
284
|
x-displayName: Shipping Method
|
284
285
|
description: Shipping methods offered to send products to customers.
|
286
|
+
- name: automated_exports
|
287
|
+
x-displayName: Automated Exports
|
288
|
+
description: Automated exports of customer data.
|
285
289
|
paths:
|
286
290
|
"/sites":
|
287
291
|
get:
|
@@ -13627,6 +13631,79 @@ paths:
|
|
13627
13631
|
{\n\t\tfmt.Printf(\"Failed validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
13628
13632
|
Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Preview Charge
|
13629
13633
|
Invoice %v\", collection.ChargeInvoice)"
|
13634
|
+
"/sites/{site_id}/export_dates":
|
13635
|
+
parameters:
|
13636
|
+
- "$ref": "#/components/parameters/site_id"
|
13637
|
+
get:
|
13638
|
+
tags:
|
13639
|
+
- automated_exports
|
13640
|
+
operationId: get_export_dates
|
13641
|
+
summary: List the dates that have an available export to download.
|
13642
|
+
description: Returns a list of dates for which export files are available for
|
13643
|
+
download.
|
13644
|
+
responses:
|
13645
|
+
'200':
|
13646
|
+
description: Returns a list of dates.
|
13647
|
+
content:
|
13648
|
+
application/json:
|
13649
|
+
schema:
|
13650
|
+
"$ref": "#/components/schemas/ExportDates"
|
13651
|
+
'400':
|
13652
|
+
description: Invalid or unpermitted parameter.
|
13653
|
+
content:
|
13654
|
+
application/json:
|
13655
|
+
schema:
|
13656
|
+
"$ref": "#/components/schemas/Error"
|
13657
|
+
'404':
|
13658
|
+
description: Incorrect site ID.
|
13659
|
+
content:
|
13660
|
+
application/json:
|
13661
|
+
schema:
|
13662
|
+
"$ref": "#/components/schemas/Error"
|
13663
|
+
default:
|
13664
|
+
description: Unexpected error.
|
13665
|
+
content:
|
13666
|
+
application/json:
|
13667
|
+
schema:
|
13668
|
+
"$ref": "#/components/schemas/Error"
|
13669
|
+
x-code-samples: []
|
13670
|
+
"/sites/{site_id}/export_dates/{export_date}/export_files":
|
13671
|
+
parameters:
|
13672
|
+
- "$ref": "#/components/parameters/site_id"
|
13673
|
+
- "$ref": "#/components/parameters/export_date"
|
13674
|
+
get:
|
13675
|
+
tags:
|
13676
|
+
- automated_exports
|
13677
|
+
operationId: get_export_files
|
13678
|
+
summary: List of the export files that are available to download.
|
13679
|
+
description: Returns a list of presigned URLs to download export files for the
|
13680
|
+
given date, with their MD5 sums.
|
13681
|
+
responses:
|
13682
|
+
'200':
|
13683
|
+
description: Returns a list of export files to download.
|
13684
|
+
content:
|
13685
|
+
application/json:
|
13686
|
+
schema:
|
13687
|
+
"$ref": "#/components/schemas/ExportFiles"
|
13688
|
+
'400':
|
13689
|
+
description: Invalid or unpermitted parameter.
|
13690
|
+
content:
|
13691
|
+
application/json:
|
13692
|
+
schema:
|
13693
|
+
"$ref": "#/components/schemas/Error"
|
13694
|
+
'404':
|
13695
|
+
description: Incorrect site ID or date.
|
13696
|
+
content:
|
13697
|
+
application/json:
|
13698
|
+
schema:
|
13699
|
+
"$ref": "#/components/schemas/Error"
|
13700
|
+
default:
|
13701
|
+
description: Unexpected error.
|
13702
|
+
content:
|
13703
|
+
application/json:
|
13704
|
+
schema:
|
13705
|
+
"$ref": "#/components/schemas/Error"
|
13706
|
+
x-code-samples: []
|
13630
13707
|
servers:
|
13631
13708
|
- url: https://v3.recurly.com
|
13632
13709
|
components:
|
@@ -13991,6 +14068,14 @@ components:
|
|
13991
14068
|
- credit
|
13992
14069
|
- non-legacy
|
13993
14070
|
- legacy
|
14071
|
+
export_date:
|
14072
|
+
name: export_date
|
14073
|
+
in: path
|
14074
|
+
description: Date for which to get a list of available automated export files.
|
14075
|
+
Date must be in YYYY-MM-DD format.
|
14076
|
+
required: true
|
14077
|
+
schema:
|
14078
|
+
type: string
|
13994
14079
|
securitySchemes:
|
13995
14080
|
api_key:
|
13996
14081
|
type: http
|
@@ -15103,7 +15188,10 @@ components:
|
|
15103
15188
|
- price
|
15104
15189
|
- percentage
|
15105
15190
|
title: Usage Type
|
15106
|
-
description:
|
15191
|
+
description: |
|
15192
|
+
Type of usage, required if `add_on_type` is `usage`. See our
|
15193
|
+
[Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
|
15194
|
+
for an overview of how to configure usage add-ons.
|
15107
15195
|
usage_percentage:
|
15108
15196
|
type: number
|
15109
15197
|
format: float
|
@@ -15216,7 +15304,9 @@ components:
|
|
15216
15304
|
title: Tier type
|
15217
15305
|
description: |
|
15218
15306
|
The pricing model for the add-on. For more information,
|
15219
|
-
[click here](https://docs.recurly.com/docs/billing-models#section-quantity-based).
|
15307
|
+
[click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See
|
15308
|
+
our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview
|
15309
|
+
of how to configure quantity-based pricing models.
|
15220
15310
|
default: flat
|
15221
15311
|
enum:
|
15222
15312
|
- flat
|
@@ -15671,8 +15761,8 @@ components:
|
|
15671
15761
|
default: false
|
15672
15762
|
plans_names:
|
15673
15763
|
type: array
|
15674
|
-
title:
|
15675
|
-
description:
|
15764
|
+
title: Plan names
|
15765
|
+
description: A list of plan names for which this coupon applies.
|
15676
15766
|
items:
|
15677
15767
|
type: string
|
15678
15768
|
plans:
|
@@ -15695,7 +15785,7 @@ components:
|
|
15695
15785
|
"$ref": "#/components/schemas/CouponDiscount"
|
15696
15786
|
coupon_type:
|
15697
15787
|
type: string
|
15698
|
-
title:
|
15788
|
+
title: Coupon type
|
15699
15789
|
description: Whether the coupon is "single_code" or "bulk". Bulk coupons
|
15700
15790
|
will require a `unique_code_template` and will generate unique codes through
|
15701
15791
|
the `/generate` endpoint.
|
@@ -15719,6 +15809,15 @@ components:
|
|
15719
15809
|
description: The date and time the coupon will expire and can no longer
|
15720
15810
|
be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
|
15721
15811
|
format: date-time
|
15812
|
+
bulk_coupon_id:
|
15813
|
+
type: string
|
15814
|
+
title: Bulk Coupon ID
|
15815
|
+
description: The Coupon ID of the parent Bulk Coupon
|
15816
|
+
readOnly: true
|
15817
|
+
bulk_coupon_code:
|
15818
|
+
type: string
|
15819
|
+
title: Bulk Coupon code
|
15820
|
+
description: The Coupon code of the parent Bulk Coupon
|
15722
15821
|
redeemed_at:
|
15723
15822
|
type: string
|
15724
15823
|
title: Redeemed at
|
@@ -15974,7 +16073,7 @@ components:
|
|
15974
16073
|
"$ref": "#/components/schemas/CouponDiscount"
|
15975
16074
|
coupon_type:
|
15976
16075
|
type: string
|
15977
|
-
title:
|
16076
|
+
title: Coupon type
|
15978
16077
|
description: Whether the coupon is "single_code" or "bulk". Bulk coupons
|
15979
16078
|
will require a `unique_code_template` and will generate unique codes through
|
15980
16079
|
the `/generate` endpoint.
|
@@ -16611,6 +16710,7 @@ components:
|
|
16611
16710
|
- credit
|
16612
16711
|
- gift_card
|
16613
16712
|
- write_off
|
16713
|
+
- prepayment
|
16614
16714
|
state:
|
16615
16715
|
type: string
|
16616
16716
|
title: Invoice state
|
@@ -17579,12 +17679,16 @@ components:
|
|
17579
17679
|
origin:
|
17580
17680
|
type: string
|
17581
17681
|
title: Origin
|
17582
|
-
description:
|
17583
|
-
and `type` is `credit`.
|
17584
|
-
|
17585
|
-
|
17682
|
+
description: Origin `external_gift_card` is allowed if the Gift Cards feature
|
17683
|
+
is enabled on your site and `type` is `credit`. Set this value in order
|
17684
|
+
to track gift card credits from external gift cards (like InComm). It
|
17685
|
+
also skips billing information requirements. Origin `prepayment` is only
|
17686
|
+
allowed if `type` is `charge` and `tax_exempt` is left blank or set to
|
17687
|
+
true. This origin creates a charge and opposite credit on the account
|
17688
|
+
to be used for future invoices.
|
17586
17689
|
enum:
|
17587
17690
|
- external_gift_card
|
17691
|
+
- prepayment
|
17588
17692
|
start_date:
|
17589
17693
|
type: string
|
17590
17694
|
format: date-time
|
@@ -18990,7 +19094,8 @@ components:
|
|
18990
19094
|
If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
|
18991
19095
|
must include one to many tiers with `ending_quantity` and `unit_amount`.
|
18992
19096
|
There must be one tier with an `ending_quantity` of 999999999 which is the
|
18993
|
-
default if not provided.
|
19097
|
+
default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
|
19098
|
+
for an overview of how to configure quantity-based pricing models.
|
18994
19099
|
usage_percentage:
|
18995
19100
|
type: number
|
18996
19101
|
format: float
|
@@ -18998,7 +19103,8 @@ components:
|
|
18998
19103
|
description: The percentage taken of the monetary amount of usage tracked.
|
18999
19104
|
This can be up to 4 decimal places. A value between 0.0 and 100.0. Required
|
19000
19105
|
if `add_on_type` is usage and `usage_type` is percentage. Must be omitted
|
19001
|
-
otherwise. `usage_percentage` does not support tiers.
|
19106
|
+
otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
|
19107
|
+
for an overview of how to configure usage add-ons.
|
19002
19108
|
revenue_schedule_type:
|
19003
19109
|
type: string
|
19004
19110
|
title: Revenue schedule type
|
@@ -20042,6 +20148,7 @@ components:
|
|
20042
20148
|
to current datetime.
|
20043
20149
|
UniqueCouponCode:
|
20044
20150
|
type: object
|
20151
|
+
description: A unique coupon code for a bulk coupon.
|
20045
20152
|
properties:
|
20046
20153
|
id:
|
20047
20154
|
type: string
|
@@ -20064,6 +20171,15 @@ components:
|
|
20064
20171
|
- maxed_out
|
20065
20172
|
- expired
|
20066
20173
|
- inactive
|
20174
|
+
bulk_coupon_id:
|
20175
|
+
type: string
|
20176
|
+
title: Bulk Coupon ID
|
20177
|
+
description: The Coupon ID of the parent Bulk Coupon
|
20178
|
+
readOnly: true
|
20179
|
+
bulk_coupon_code:
|
20180
|
+
type: string
|
20181
|
+
title: Bulk Coupon code
|
20182
|
+
description: The Coupon code of the parent Bulk Coupon
|
20067
20183
|
created_at:
|
20068
20184
|
type: string
|
20069
20185
|
title: Created at
|
@@ -20162,6 +20278,16 @@ components:
|
|
20162
20278
|
format: date-time
|
20163
20279
|
description: When the usage actually happened. This will define the line
|
20164
20280
|
item dates this usage is billed under and is important for revenue recognition.
|
20281
|
+
usage_percentage:
|
20282
|
+
type: number
|
20283
|
+
format: float
|
20284
|
+
title: Usage Percentage
|
20285
|
+
description: The percentage taken of the monetary amount of usage tracked.
|
20286
|
+
This can be up to 4 decimal places. A value between 0.0 and 100.0.
|
20287
|
+
unit_amount:
|
20288
|
+
type: number
|
20289
|
+
format: float
|
20290
|
+
title: Unit price
|
20165
20291
|
billed_at:
|
20166
20292
|
type: string
|
20167
20293
|
format: date-time
|
@@ -20657,3 +20783,41 @@ components:
|
|
20657
20783
|
a transaction. Pass this value to Recurly.js so it can continue
|
20658
20784
|
the challenge flow.
|
20659
20785
|
maxLength: 22
|
20786
|
+
ExportDates:
|
20787
|
+
type: object
|
20788
|
+
properties:
|
20789
|
+
object:
|
20790
|
+
type: string
|
20791
|
+
title: Object type
|
20792
|
+
readOnly: true
|
20793
|
+
dates:
|
20794
|
+
type: array
|
20795
|
+
items:
|
20796
|
+
type: string
|
20797
|
+
title: An array of dates that have available exports.
|
20798
|
+
ExportFiles:
|
20799
|
+
type: object
|
20800
|
+
properties:
|
20801
|
+
object:
|
20802
|
+
type: string
|
20803
|
+
title: Object type
|
20804
|
+
readOnly: true
|
20805
|
+
files:
|
20806
|
+
type: array
|
20807
|
+
items:
|
20808
|
+
"$ref": "#/components/schemas/ExportFile"
|
20809
|
+
ExportFile:
|
20810
|
+
type: object
|
20811
|
+
properties:
|
20812
|
+
name:
|
20813
|
+
type: string
|
20814
|
+
title: Filename
|
20815
|
+
description: Name of the export file.
|
20816
|
+
md5sum:
|
20817
|
+
type: string
|
20818
|
+
title: MD5 hash of the export file
|
20819
|
+
description: MD5 hash of the export file.
|
20820
|
+
href:
|
20821
|
+
type: string
|
20822
|
+
title: A link to the export file
|
20823
|
+
description: A presigned link to download the export file.
|
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: 3.
|
4
|
+
version: 3.13.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Recurly
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-09-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -229,6 +229,9 @@ files:
|
|
229
229
|
- lib/recurly/resources/custom_field_definition.rb
|
230
230
|
- lib/recurly/resources/error.rb
|
231
231
|
- lib/recurly/resources/error_may_have_transaction.rb
|
232
|
+
- lib/recurly/resources/export_dates.rb
|
233
|
+
- lib/recurly/resources/export_file.rb
|
234
|
+
- lib/recurly/resources/export_files.rb
|
232
235
|
- lib/recurly/resources/fraud_info.rb
|
233
236
|
- lib/recurly/resources/invoice.rb
|
234
237
|
- lib/recurly/resources/invoice_address.rb
|
@@ -290,7 +293,7 @@ metadata:
|
|
290
293
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
291
294
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
292
295
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
293
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.
|
296
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.13.0
|
294
297
|
post_install_message:
|
295
298
|
rdoc_options: []
|
296
299
|
require_paths:
|