recurly 3.28.0 → 3.29.1

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.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +1 -1
  3. data/.github/workflows/ci.yml +3 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/pr-review.yml +27 -0
  6. data/CHANGELOG.md +22 -0
  7. data/GETTING_STARTED.md +1 -1
  8. data/lib/data/ca-certificates.crt +0 -40
  9. data/lib/recurly/client/operations.rb +92 -40
  10. data/lib/recurly/errors/api_errors.rb +0 -31
  11. data/lib/recurly/requests/account_create.rb +4 -0
  12. data/lib/recurly/requests/account_purchase.rb +4 -0
  13. data/lib/recurly/requests/account_update.rb +4 -0
  14. data/lib/recurly/requests/add_on_create.rb +1 -1
  15. data/lib/recurly/requests/add_on_update.rb +1 -1
  16. data/lib/recurly/requests/address.rb +4 -0
  17. data/lib/recurly/requests/billing_info_create.rb +13 -1
  18. data/lib/recurly/requests/billing_info_verify.rb +4 -0
  19. data/lib/recurly/requests/billing_info_verify_cvv.rb +26 -0
  20. data/lib/recurly/requests/credit_application_policy.rb +18 -0
  21. data/lib/recurly/requests/custom_field.rb +8 -0
  22. data/lib/recurly/requests/gateway_attributes.rb +1 -1
  23. data/lib/recurly/requests/invoice_address.rb +4 -0
  24. data/lib/recurly/requests/invoice_create.rb +9 -1
  25. data/lib/recurly/requests/item_create.rb +1 -1
  26. data/lib/recurly/requests/item_update.rb +1 -1
  27. data/lib/recurly/requests/line_item_create.rb +5 -1
  28. data/lib/recurly/requests/plan_create.rb +1 -1
  29. data/lib/recurly/requests/plan_update.rb +1 -1
  30. data/lib/recurly/requests/purchase_create.rb +8 -0
  31. data/lib/recurly/requests/shipping_address_create.rb +4 -0
  32. data/lib/recurly/requests/shipping_address_update.rb +4 -0
  33. data/lib/recurly/requests/subscription_create.rb +13 -1
  34. data/lib/recurly/requests/subscription_purchase.rb +21 -1
  35. data/lib/recurly/requests/subscription_update.rb +8 -0
  36. data/lib/recurly/resources/account.rb +4 -0
  37. data/lib/recurly/resources/add_on.rb +1 -1
  38. data/lib/recurly/resources/address.rb +4 -0
  39. data/lib/recurly/resources/credit_application_policy.rb +18 -0
  40. data/lib/recurly/resources/custom_field.rb +8 -0
  41. data/lib/recurly/resources/gateway_attributes.rb +1 -1
  42. data/lib/recurly/resources/invoice.rb +8 -0
  43. data/lib/recurly/resources/invoice_address.rb +4 -0
  44. data/lib/recurly/resources/item.rb +1 -1
  45. data/lib/recurly/resources/line_item.rb +6 -2
  46. data/lib/recurly/resources/payment_method.rb +4 -0
  47. data/lib/recurly/resources/plan.rb +1 -1
  48. data/lib/recurly/resources/shipping_address.rb +4 -0
  49. data/lib/recurly/resources/subscription.rb +8 -0
  50. data/lib/recurly/resources/subscription_ramp_interval_response.rb +8 -0
  51. data/lib/recurly/resources/tax_detail.rb +4 -4
  52. data/lib/recurly/resources/tax_info.rb +1 -1
  53. data/lib/recurly/version.rb +1 -1
  54. data/openapi/api.yaml +10784 -301
  55. metadata +11 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f358220bcde59e70cefed04b0f39869b5e976a2f5b8051bf0938d9a2d98659fe
4
- data.tar.gz: fb89656186be6d4a34d042daf0a7fe46d0e36cc272441c102df9141354c37966
3
+ metadata.gz: fd9765341ee9d05206afe55144081c3dbcf60a9c8506b1d15db77b5e33e1e448
4
+ data.tar.gz: 7115cf93abdec02b6e25137c0854365f43c4c0e9771a6cce20384c6cea46193c
5
5
  SHA512:
6
- metadata.gz: af696c3da92306020d79701b60a4134c536349f0946b399dab177af36f519fc2d2947ac1c49e3fdf6c3fecdaaa05820f0cb1eb32859eead6585b4f607664f3e8
7
- data.tar.gz: 1b241b8ea83c74e31e653af77d8992ad1f2cd38a19732bb3030244b89ddf0820d84e55175333c1368e29ab2e8204d98429cb9af7941f10b04ac433e9f1f6be5d
6
+ metadata.gz: b297044e5091ddb1f3ce44e06700349aa44f5783a33c9e74c24136933c2379b423e545ccf32ff27315e2077b07e470b084aa3be3fe195c71b4c0567e14e1f195
7
+ data.tar.gz: 83eba8d233f670a41a6b975be7487e7b92fb21cff3382e836218288e08b3c1d9c917e46adda10fd67957e2cde74561a9d10f966c33f32bf593fb6f534a2cbe89
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 3.28.0
2
+ current_version = 3.29.1
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
@@ -5,11 +5,11 @@ concurrency:
5
5
  cancel-in-progress: true
6
6
  jobs:
7
7
  build:
8
- runs-on: ubuntu-latest
8
+ runs-on: ubuntu-24.04
9
9
  name: Ruby ${{ matrix.ruby }} tests
10
10
  strategy:
11
11
  matrix:
12
- ruby: [2.4, 2.5, 2.6, 2.7, 3.0]
12
+ ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
13
13
  steps:
14
14
  - uses: actions/checkout@v3
15
15
  - name: Setup ruby
@@ -20,7 +20,7 @@ jobs:
20
20
  - run: ./scripts/test
21
21
  buildall:
22
22
  if: ${{ always() }}
23
- runs-on: ubuntu-latest
23
+ runs-on: ubuntu-24.04
24
24
  name: Build (matrix)
25
25
  needs: build
26
26
  steps:
@@ -6,7 +6,7 @@ name: Documentation
6
6
  jobs:
7
7
  build:
8
8
  name: Publish
9
- runs-on: ubuntu-latest
9
+ runs-on: ubuntu-24.04
10
10
  steps:
11
11
  - uses: actions/checkout@v2
12
12
 
@@ -0,0 +1,27 @@
1
+ name: PR Review
2
+
3
+ on:
4
+ pull_request:
5
+ types:
6
+ - opened
7
+ - repoened
8
+ - edited
9
+ - synchronize
10
+ - labeled
11
+ - unlabeled
12
+
13
+ concurrency:
14
+ group: ${{ github.workflow }} - ${{ github.ref }}
15
+ cancel-in-progress: true
16
+
17
+ jobs:
18
+ label-checker:
19
+ runs-on: ubuntu-latest
20
+ name: Label Checker
21
+ steps:
22
+ - name: Check Labels
23
+ uses: docker://agilepathway/pull-request-label-checker:latest
24
+ with:
25
+ one_of: V3
26
+ repo_token: ${{ secrets.GITHUB_TOKEN }}
27
+
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.29.1](https://github.com/recurly/recurly-client-ruby/tree/3.29.1) (2026-10-23)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.29.0...3.29.1)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2019-10-10 [#977](https://github.com/recurly/recurly-client-ruby/pull/977) ([recurly-integrations](https://github.com/recurly-integrations))
11
+
12
+
13
+
14
+ ## [3.29.0](https://github.com/recurly/recurly-client-ruby/tree/3.29.0) (2024-05-24)
15
+
16
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.28.0...3.29.0)
17
+
18
+
19
+ **Merged Pull Requests**
20
+
21
+ - Generated Latest Changes for v2019-10-10 [#903](https://github.com/recurly/recurly-client-ruby/pull/903) ([recurly-integrations](https://github.com/recurly-integrations))
22
+
23
+
24
+
3
25
  ## [3.28.0](https://github.com/recurly/recurly-client-ruby/tree/3.28.0) (2023-05-23)
4
26
 
5
27
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.27.0...3.28.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', '~> 3.28'
8
+ gem 'recurly', '~> 3.29'
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.
@@ -261,30 +261,6 @@ gn2Z9DH2canPLAEnpQW5qrJITirvn5NSUZU8UnOOVkwXQMAJKOSLakhT2+zNVVXxxvjpoixMptEm
261
261
  X36vWkzaH6byHCx+rgIW0lbQL1dTR+iS
262
262
  -----END CERTIFICATE-----
263
263
 
264
- Comodo AAA Services root
265
- ========================
266
- -----BEGIN CERTIFICATE-----
267
- MIIEMjCCAxqgAwIBAgIBATANBgkqhkiG9w0BAQUFADB7MQswCQYDVQQGEwJHQjEbMBkGA1UECAwS
268
- R3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHDAdTYWxmb3JkMRowGAYDVQQKDBFDb21vZG8gQ0Eg
269
- TGltaXRlZDEhMB8GA1UEAwwYQUFBIENlcnRpZmljYXRlIFNlcnZpY2VzMB4XDTA0MDEwMTAwMDAw
270
- MFoXDTI4MTIzMTIzNTk1OVowezELMAkGA1UEBhMCR0IxGzAZBgNVBAgMEkdyZWF0ZXIgTWFuY2hl
271
- c3RlcjEQMA4GA1UEBwwHU2FsZm9yZDEaMBgGA1UECgwRQ29tb2RvIENBIExpbWl0ZWQxITAfBgNV
272
- BAMMGEFBQSBDZXJ0aWZpY2F0ZSBTZXJ2aWNlczCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
273
- ggEBAL5AnfRu4ep2hxxNRUSOvkbIgwadwSr+GB+O5AL686tdUIoWMQuaBtDFcCLNSS1UY8y2bmhG
274
- C1Pqy0wkwLxyTurxFa70VJoSCsN6sjNg4tqJVfMiWPPe3M/vg4aijJRPn2jymJBGhCfHdr/jzDUs
275
- i14HZGWCwEiwqJH5YZ92IFCokcdmtet4YgNW8IoaE+oxox6gmf049vYnMlhvB/VruPsUK6+3qszW
276
- Y19zjNoFmag4qMsXeDZRrOme9Hg6jc8P2ULimAyrL58OAd7vn5lJ8S3frHRNG5i1R8XlKdH5kBjH
277
- Ypy+g8cmez6KJcfA3Z3mNWgQIJ2P2N7Sw4ScDV7oL8kCAwEAAaOBwDCBvTAdBgNVHQ4EFgQUoBEK
278
- Iz6W8Qfs4q8p74Klf9AwpLQwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wewYDVR0f
279
- BHQwcjA4oDagNIYyaHR0cDovL2NybC5jb21vZG9jYS5jb20vQUFBQ2VydGlmaWNhdGVTZXJ2aWNl
280
- cy5jcmwwNqA0oDKGMGh0dHA6Ly9jcmwuY29tb2RvLm5ldC9BQUFDZXJ0aWZpY2F0ZVNlcnZpY2Vz
281
- LmNybDANBgkqhkiG9w0BAQUFAAOCAQEACFb8AvCb6P+k+tZ7xkSAzk/ExfYAWMymtrwUSWgEdujm
282
- 7l3sAg9g1o1QGE8mTgHj5rCl7r+8dFRBv/38ErjHT1r0iWAFf2C3BUrz9vHCv8S5dIa2LX1rzNLz
283
- Rt0vxuBqw8M0Ayx9lt1awg6nCpnBBYurDC/zXDrPbDdVCYfeU0BsWO/8tqtlbgT2G9w84FoVxp7Z
284
- 8VlIMCFlA2zs6SFz7JsDoeA3raAVGI/6ugLOpyypEBMs1OUIJqsil2D4kF501KKaU73yqWjgom7C
285
- 12yxow+ev+to51byrvLjKzg6CYG1a4XXvi3tPxq3smPi9WIsgtRqAEFQ8TmDn5XpNpaYbg==
286
- -----END CERTIFICATE-----
287
-
288
264
  QuoVadis Root CA
289
265
  ================
290
266
  -----BEGIN CERTIFICATE-----
@@ -3347,22 +3323,6 @@ U80Bv2noWgbyRQuQ+q7hv53yrlc8pa6yVvSLZUDp/TGBLPQ5Cdjua6e0ph0VpZj3AYHYhX3zUVxx
3347
3323
  iN66zB+Afko=
3348
3324
  -----END CERTIFICATE-----
3349
3325
 
3350
- emSign ECC Root CA - G3
3351
- =======================
3352
- -----BEGIN CERTIFICATE-----
3353
- MIICTjCCAdOgAwIBAgIKPPYHqWhwDtqLhDAKBggqhkjOPQQDAzBrMQswCQYDVQQGEwJJTjETMBEG
3354
- A1UECxMKZW1TaWduIFBLSTElMCMGA1UEChMcZU11ZGhyYSBUZWNobm9sb2dpZXMgTGltaXRlZDEg
3355
- MB4GA1UEAxMXZW1TaWduIEVDQyBSb290IENBIC0gRzMwHhcNMTgwMjE4MTgzMDAwWhcNNDMwMjE4
3356
- MTgzMDAwWjBrMQswCQYDVQQGEwJJTjETMBEGA1UECxMKZW1TaWduIFBLSTElMCMGA1UEChMcZU11
3357
- ZGhyYSBUZWNobm9sb2dpZXMgTGltaXRlZDEgMB4GA1UEAxMXZW1TaWduIEVDQyBSb290IENBIC0g
3358
- RzMwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQjpQy4LRL1KPOxst3iAhKAnjlfSU2fySU0WXTsuwYc
3359
- 58Byr+iuL+FBVIcUqEqy6HyC5ltqtdyzdc6LBtCGI79G1Y4PPwT01xySfvalY8L1X44uT6EYGQIr
3360
- MgqCZH0Wk9GjQjBAMB0GA1UdDgQWBBR8XQKEE9TMipuBzhccLikenEhjQjAOBgNVHQ8BAf8EBAMC
3361
- AQYwDwYDVR0TAQH/BAUwAwEB/zAKBggqhkjOPQQDAwNpADBmAjEAvvNhzwIQHWSVB7gYboiFBS+D
3362
- CBeQyh+KTOgNG3qxrdWBCUfvO6wIBHxcmbHtRwfSAjEAnbpV/KlK6O3t5nYBQnvI+GDZjVGLVTv7
3363
- jHvrZQnD+JbNR6iC8hZVdyR+EhCVBCyj
3364
- -----END CERTIFICATE-----
3365
-
3366
3326
  emSign Root CA - C1
3367
3327
  ===================
3368
3328
  -----BEGIN CERTIFICATE-----
@@ -109,7 +109,7 @@ module Recurly
109
109
  # end
110
110
  #
111
111
  def list_accounts(**options)
112
- path = interpolate_path("/accounts")
112
+ path = "/accounts"
113
113
  pager(path, **options)
114
114
  end
115
115
 
@@ -159,7 +159,7 @@ module Recurly
159
159
  # end
160
160
  #
161
161
  def create_account(body:, **options)
162
- path = interpolate_path("/accounts")
162
+ path = "/accounts"
163
163
  post(path, body, Requests::AccountCreate, **options)
164
164
  end
165
165
 
@@ -469,6 +469,21 @@ module Recurly
469
469
  post(path, options[:body], Requests::BillingInfoVerify, **options)
470
470
  end
471
471
 
472
+ # Verify an account's credit card billing cvv
473
+ #
474
+ # {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_info_cvv verify_billing_info_cvv api documentation}
475
+ #
476
+ # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
477
+ # @param body [Requests::BillingInfoVerifyCVV] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerifyCVV}
478
+ # @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+.
479
+ #
480
+ # @return [Resources::Transaction] Transaction information from verify.
481
+ #
482
+ def verify_billing_info_cvv(account_id:, body:, **options)
483
+ path = interpolate_path("/accounts/{account_id}/billing_info/verify_cvv", account_id: account_id)
484
+ post(path, body, Requests::BillingInfoVerifyCVV, **options)
485
+ end
486
+
472
487
  # Get the list of billing information associated with an account
473
488
  #
474
489
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api documentation}
@@ -566,6 +581,38 @@ module Recurly
566
581
  delete(path, **options)
567
582
  end
568
583
 
584
+ # Verify a billing information's credit card
585
+ #
586
+ # {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_infos verify_billing_infos api documentation}
587
+ #
588
+ # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
589
+ # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
590
+ # @param body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
591
+ # @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+.
592
+ #
593
+ # @return [Resources::Transaction] Transaction information from verify.
594
+ #
595
+ def verify_billing_infos(account_id:, billing_info_id:, **options)
596
+ path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify", account_id: account_id, billing_info_id: billing_info_id)
597
+ post(path, options[:body], Requests::BillingInfoVerify, **options)
598
+ end
599
+
600
+ # Verify a billing information's credit card cvv
601
+ #
602
+ # {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_infos_cvv verify_billing_infos_cvv api documentation}
603
+ #
604
+ # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
605
+ # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
606
+ # @param body [Requests::BillingInfoVerifyCVV] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerifyCVV}
607
+ # @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+.
608
+ #
609
+ # @return [Resources::Transaction] Transaction information from verify.
610
+ #
611
+ def verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **options)
612
+ path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv", account_id: account_id, billing_info_id: billing_info_id)
613
+ post(path, body, Requests::BillingInfoVerifyCVV, **options)
614
+ end
615
+
569
616
  # List the coupon redemptions for an account
570
617
  #
571
618
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
@@ -739,6 +786,7 @@ module Recurly
739
786
  # * Records are returned in an arbitrary order. Since results are all
740
787
  # returned at once you can sort the records yourself.
741
788
  #
789
+ # @param state [String] Invoice state.
742
790
  # @param limit [Integer] Limit number of records 1-200.
743
791
  # @param order [String] Sort order.
744
792
  # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -1332,7 +1380,7 @@ module Recurly
1332
1380
  # end
1333
1381
  #
1334
1382
  def list_account_acquisition(**options)
1335
- path = interpolate_path("/acquisitions")
1383
+ path = "/acquisitions"
1336
1384
  pager(path, **options)
1337
1385
  end
1338
1386
 
@@ -1374,7 +1422,7 @@ module Recurly
1374
1422
  # end
1375
1423
  #
1376
1424
  def list_coupons(**options)
1377
- path = interpolate_path("/coupons")
1425
+ path = "/coupons"
1378
1426
  pager(path, **options)
1379
1427
  end
1380
1428
 
@@ -1410,7 +1458,7 @@ module Recurly
1410
1458
  # end
1411
1459
  #
1412
1460
  def create_coupon(body:, **options)
1413
- path = interpolate_path("/coupons")
1461
+ path = "/coupons"
1414
1462
  post(path, body, Requests::CouponCreate, **options)
1415
1463
  end
1416
1464
 
@@ -1577,7 +1625,7 @@ module Recurly
1577
1625
  # end
1578
1626
  #
1579
1627
  def list_credit_payments(**options)
1580
- path = interpolate_path("/credit_payments")
1628
+ path = "/credit_payments"
1581
1629
  pager(path, **options)
1582
1630
  end
1583
1631
 
@@ -1634,7 +1682,7 @@ module Recurly
1634
1682
  # end
1635
1683
  #
1636
1684
  def list_custom_field_definitions(**options)
1637
- path = interpolate_path("/custom_field_definitions")
1685
+ path = "/custom_field_definitions"
1638
1686
  pager(path, **options)
1639
1687
  end
1640
1688
 
@@ -1702,7 +1750,7 @@ module Recurly
1702
1750
  # end
1703
1751
  #
1704
1752
  def list_items(**options)
1705
- path = interpolate_path("/items")
1753
+ path = "/items"
1706
1754
  pager(path, **options)
1707
1755
  end
1708
1756
 
@@ -1737,7 +1785,7 @@ module Recurly
1737
1785
  # end
1738
1786
  #
1739
1787
  def create_item(body:, **options)
1740
- path = interpolate_path("/items")
1788
+ path = "/items"
1741
1789
  post(path, body, Requests::ItemCreate, **options)
1742
1790
  end
1743
1791
 
@@ -1875,7 +1923,7 @@ module Recurly
1875
1923
  # @return [Pager<Resources::MeasuredUnit>] A list of the site's measured units.
1876
1924
  #
1877
1925
  def list_measured_unit(**options)
1878
- path = interpolate_path("/measured_units")
1926
+ path = "/measured_units"
1879
1927
  pager(path, **options)
1880
1928
  end
1881
1929
 
@@ -1889,7 +1937,7 @@ module Recurly
1889
1937
  # @return [Resources::MeasuredUnit] A new measured unit.
1890
1938
  #
1891
1939
  def create_measured_unit(body:, **options)
1892
- path = interpolate_path("/measured_units")
1940
+ path = "/measured_units"
1893
1941
  post(path, body, Requests::MeasuredUnitCreate, **options)
1894
1942
  end
1895
1943
 
@@ -1952,6 +2000,7 @@ module Recurly
1952
2000
  # * Records are returned in an arbitrary order. Since results are all
1953
2001
  # returned at once you can sort the records yourself.
1954
2002
  #
2003
+ # @param state [String] Invoice state.
1955
2004
  # @param limit [Integer] Limit number of records 1-200.
1956
2005
  # @param order [String] Sort order.
1957
2006
  # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -1980,7 +2029,7 @@ module Recurly
1980
2029
  # end
1981
2030
  #
1982
2031
  def list_invoices(**options)
1983
- path = interpolate_path("/invoices")
2032
+ path = "/invoices"
1984
2033
  pager(path, **options)
1985
2034
  end
1986
2035
 
@@ -1988,7 +2037,7 @@ module Recurly
1988
2037
  #
1989
2038
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api documentation}
1990
2039
  #
1991
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2040
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
1992
2041
  # @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+.
1993
2042
  #
1994
2043
  # @return [Resources::Invoice] An invoice.
@@ -2011,7 +2060,7 @@ module Recurly
2011
2060
  #
2012
2061
  # {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api documentation}
2013
2062
  #
2014
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2063
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2015
2064
  # @param body [Requests::InvoiceUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdatable}
2016
2065
  # @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+.
2017
2066
  #
@@ -2039,7 +2088,7 @@ module Recurly
2039
2088
  #
2040
2089
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api documentation}
2041
2090
  #
2042
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2091
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2043
2092
  # @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+.
2044
2093
  #
2045
2094
  # @return [Resources::BinaryFile] An invoice as a PDF.
@@ -2065,7 +2114,7 @@ module Recurly
2065
2114
  #
2066
2115
  # {https://developers.recurly.com/api/v2019-10-10#operation/apply_credit_balance apply_credit_balance api documentation}
2067
2116
  #
2068
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2117
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2069
2118
  # @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+.
2070
2119
  #
2071
2120
  # @return [Resources::Invoice] The updated invoice.
@@ -2088,7 +2137,7 @@ module Recurly
2088
2137
  #
2089
2138
  # {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documentation}
2090
2139
  #
2091
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2140
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2092
2141
  # @param body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
2093
2142
  # @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+.
2094
2143
  #
@@ -2112,7 +2161,7 @@ module Recurly
2112
2161
  #
2113
2162
  # {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api documentation}
2114
2163
  #
2115
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2164
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2116
2165
  # @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+.
2117
2166
  #
2118
2167
  # @return [Resources::Invoice] The updated invoice.
@@ -2135,7 +2184,7 @@ module Recurly
2135
2184
  #
2136
2185
  # {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api documentation}
2137
2186
  #
2138
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2187
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2139
2188
  # @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+.
2140
2189
  #
2141
2190
  # @return [Resources::Invoice] The updated invoice.
@@ -2158,7 +2207,7 @@ module Recurly
2158
2207
  #
2159
2208
  # {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api documentation}
2160
2209
  #
2161
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2210
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2162
2211
  # @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+.
2163
2212
  #
2164
2213
  # @return [Resources::Invoice] The updated invoice.
@@ -2181,7 +2230,7 @@ module Recurly
2181
2230
  #
2182
2231
  # {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api documentation}
2183
2232
  #
2184
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2233
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2185
2234
  # @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+.
2186
2235
  #
2187
2236
  # @return [Resources::Invoice] The updated invoice.
@@ -2204,7 +2253,7 @@ module Recurly
2204
2253
  #
2205
2254
  # {https://developers.recurly.com/api/v2019-10-10#operation/record_external_transaction record_external_transaction api documentation}
2206
2255
  #
2207
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2256
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2208
2257
  # @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
2209
2258
  # @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+.
2210
2259
  #
@@ -2219,7 +2268,7 @@ module Recurly
2219
2268
  #
2220
2269
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api documentation}
2221
2270
  #
2222
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2271
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2223
2272
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2224
2273
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2225
2274
  #
@@ -2268,7 +2317,7 @@ module Recurly
2268
2317
  #
2269
2318
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
2270
2319
  #
2271
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2320
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2272
2321
  # @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
2273
2322
  # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
2274
2323
  #
@@ -2312,7 +2361,7 @@ module Recurly
2312
2361
  #
2313
2362
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api documentation}
2314
2363
  #
2315
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2364
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2316
2365
  # @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+.
2317
2366
  #
2318
2367
  # @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
@@ -2334,7 +2383,7 @@ module Recurly
2334
2383
  #
2335
2384
  # {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api documentation}
2336
2385
  #
2337
- # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
2386
+ # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+. For number with prefix or country code, use +number-+ and +prefix+, e.g. +number-TEST-FR1001+
2338
2387
  # @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
2339
2388
  # @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+.
2340
2389
  #
@@ -2404,7 +2453,7 @@ module Recurly
2404
2453
  # end
2405
2454
  #
2406
2455
  def list_line_items(**options)
2407
- path = interpolate_path("/line_items")
2456
+ path = "/line_items"
2408
2457
  pager(path, **options)
2409
2458
  end
2410
2459
 
@@ -2495,7 +2544,7 @@ module Recurly
2495
2544
  # end
2496
2545
  #
2497
2546
  def list_plans(**options)
2498
- path = interpolate_path("/plans")
2547
+ path = "/plans"
2499
2548
  pager(path, **options)
2500
2549
  end
2501
2550
 
@@ -2535,7 +2584,7 @@ module Recurly
2535
2584
  # end
2536
2585
  #
2537
2586
  def create_plan(body:, **options)
2538
- path = interpolate_path("/plans")
2587
+ path = "/plans"
2539
2588
  post(path, body, Requests::PlanCreate, **options)
2540
2589
  end
2541
2590
 
@@ -2820,7 +2869,7 @@ module Recurly
2820
2869
  # end
2821
2870
  #
2822
2871
  def list_add_ons(**options)
2823
- path = interpolate_path("/add_ons")
2872
+ path = "/add_ons"
2824
2873
  pager(path, **options)
2825
2874
  end
2826
2875
 
@@ -2887,7 +2936,7 @@ module Recurly
2887
2936
  # end
2888
2937
  #
2889
2938
  def list_shipping_methods(**options)
2890
- path = interpolate_path("/shipping_methods")
2939
+ path = "/shipping_methods"
2891
2940
  pager(path, **options)
2892
2941
  end
2893
2942
 
@@ -2901,7 +2950,7 @@ module Recurly
2901
2950
  # @return [Resources::ShippingMethod] A new shipping method.
2902
2951
  #
2903
2952
  def create_shipping_method(body:, **options)
2904
- path = interpolate_path("/shipping_methods")
2953
+ path = "/shipping_methods"
2905
2954
  post(path, body, Requests::ShippingMethodCreate, **options)
2906
2955
  end
2907
2956
 
@@ -2992,7 +3041,7 @@ module Recurly
2992
3041
  # end
2993
3042
  #
2994
3043
  def list_subscriptions(**options)
2995
- path = interpolate_path("/subscriptions")
3044
+ path = "/subscriptions"
2996
3045
  pager(path, **options)
2997
3046
  end
2998
3047
 
@@ -3025,7 +3074,7 @@ module Recurly
3025
3074
  # end
3026
3075
  #
3027
3076
  def create_subscription(body:, **options)
3028
- path = interpolate_path("/subscriptions")
3077
+ path = "/subscriptions"
3029
3078
  post(path, body, Requests::SubscriptionCreate, **options)
3030
3079
  end
3031
3080
 
@@ -3246,12 +3295,13 @@ module Recurly
3246
3295
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_preview_renewal get_preview_renewal api documentation}
3247
3296
  #
3248
3297
  # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3298
+ # @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+.
3249
3299
  #
3250
3300
  # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
3251
3301
  #
3252
- def get_preview_renewal(subscription_id:)
3302
+ def get_preview_renewal(subscription_id:, **options)
3253
3303
  path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
3254
- get(path)
3304
+ get(path, **options)
3255
3305
  end
3256
3306
 
3257
3307
  # Fetch a subscription's pending change
@@ -3367,6 +3417,7 @@ module Recurly
3367
3417
  # * Records are returned in an arbitrary order. Since results are all
3368
3418
  # returned at once you can sort the records yourself.
3369
3419
  #
3420
+ # @param state [String] Invoice state.
3370
3421
  # @param limit [Integer] Limit number of records 1-200.
3371
3422
  # @param order [String] Sort order.
3372
3423
  # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -3634,7 +3685,7 @@ module Recurly
3634
3685
  # end
3635
3686
  #
3636
3687
  def list_transactions(**options)
3637
- path = interpolate_path("/transactions")
3688
+ path = "/transactions"
3638
3689
  pager(path, **options)
3639
3690
  end
3640
3691
 
@@ -3739,7 +3790,7 @@ module Recurly
3739
3790
  # end
3740
3791
  #
3741
3792
  def create_purchase(body:, **options)
3742
- path = interpolate_path("/purchases")
3793
+ path = "/purchases"
3743
3794
  post(path, body, Requests::PurchaseCreate, **options)
3744
3795
  end
3745
3796
 
@@ -3779,7 +3830,7 @@ module Recurly
3779
3830
  # end
3780
3831
  #
3781
3832
  def preview_purchase(body:, **options)
3782
- path = interpolate_path("/purchases/preview")
3833
+ path = "/purchases/preview"
3783
3834
  post(path, body, Requests::PurchaseCreate, **options)
3784
3835
  end
3785
3836
 
@@ -3803,7 +3854,7 @@ module Recurly
3803
3854
  # end
3804
3855
  #
3805
3856
  def get_export_dates(**options)
3806
- path = interpolate_path("/export_dates")
3857
+ path = "/export_dates"
3807
3858
  get(path, **options)
3808
3859
  end
3809
3860
 
@@ -3840,6 +3891,7 @@ module Recurly
3840
3891
  # order. In descending order updated records will move behind the cursor and could
3841
3892
  # prevent some records from being returned.
3842
3893
  #
3894
+ # @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+.
3843
3895
  #
3844
3896
  # @return [Pager<Resources::DunningCampaign>] A list of the the dunning_campaigns on an account.
3845
3897
  #