recurly 4.25.0 → 4.26.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 83cc9874a222552398eccba8e97f844e448644398831199e20e9eeb09d91443a
4
- data.tar.gz: dab0e9563f9771f46d4be709e33394305f8c59bc77fa2cd4394106cef1edd8a6
3
+ metadata.gz: 389eea1b74d78e485eb08e34495178d7a383a9ac748e7e7f9f94ff7361520603
4
+ data.tar.gz: 22d328b1f98319385cde050be1199a3ec8d7b5f41ab833d7a9013ba87761ff72
5
5
  SHA512:
6
- metadata.gz: beeb8fd85be7c0b63d7f2ab7c786684e774d731a3d3f501aba66428bb6de7e58c79fd0e4ab6786790e58195cd675c286f259bb98cb0652366a0ab49b885fed11
7
- data.tar.gz: a2bb85d2f395c94dbe172aabbc281d0e30f6ffd034d85368616a2a921cee68fc6836ae75dbb023299edc2b8b4d31a61f382d9e43e6f130e10a9130bd5d7a2148
6
+ metadata.gz: a76f723999341f4e174891b7b17033ffdf21c563cabdd8709d648de76f51bb7374a8293b3ac255d95b571f92a1a1e889a07e9cedea9626fe7e659fbc90b165c2
7
+ data.tar.gz: 703c91e9c0f5ca8e76f04dd3bf74f81d2355d205dcd92d90a03d3f2bac48ff84ded8b09c63b55b885856f06d123814f83674142a532ec572f132bffaead3ab3e
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 4.25.0
2
+ current_version = 4.26.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
data/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.26.0](https://github.com/recurly/recurly-client-ruby/tree/4.26.0) (2022-11-17)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.25.0...4.26.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2021-02-25 (Apply Credit Balance feature) [#811](https://github.com/recurly/recurly-client-ruby/pull/811) ([recurly-integrations](https://github.com/recurly-integrations))
11
+
12
+
13
+
3
14
  ## [4.25.0](https://github.com/recurly/recurly-client-ruby/tree/4.25.0) (2022-11-15)
4
15
 
5
16
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.24.0...4.25.0)
data/GETTING_STARTED.md CHANGED
@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
5
5
  In your Gemfile, add `recurly` as a dependency.
6
6
 
7
7
  ```ruby
8
- gem 'recurly', '~> 4.25'
8
+ gem 'recurly', '~> 4.26'
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.
@@ -2236,6 +2236,21 @@ module Recurly
2236
2236
  get(path, **options)
2237
2237
  end
2238
2238
 
2239
+ # Apply available credit to a pending or past due charge invoice
2240
+ #
2241
+ # {https://developers.recurly.com/api/v2021-02-25#operation/apply_credit_balance apply_credit_balance api documentation}
2242
+ #
2243
+ # @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+.
2244
+ # @param params [Hash] Optional query string parameters:
2245
+ # :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+.
2246
+ #
2247
+ # @return [Resources::Invoice] The updated invoice.
2248
+ #
2249
+ def apply_credit_balance(invoice_id:, **options)
2250
+ path = interpolate_path("/invoices/{invoice_id}/apply_credit_balance", invoice_id: invoice_id)
2251
+ put(path, **options)
2252
+ end
2253
+
2239
2254
  # Collect a pending or past due, automatic invoice
2240
2255
  #
2241
2256
  # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documentation}
@@ -10,6 +10,10 @@ module Recurly
10
10
  # @return [Float] Total amount the account is past due.
11
11
  define_attribute :amount, Float
12
12
 
13
+ # @!attribute available_credit_amount
14
+ # @return [Float] Total amount of the open balances on credit invoices for the account.
15
+ define_attribute :available_credit_amount, Float
16
+
13
17
  # @!attribute currency
14
18
  # @return [String] 3-letter ISO 4217 currency code.
15
19
  define_attribute :currency, String
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "4.25.0"
2
+ VERSION = "4.26.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -358,7 +358,7 @@ paths:
358
358
  description: |
359
359
  This route is most useful for finding a site's ID for subsequent requests.
360
360
 
361
- See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
361
+ See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
362
362
  tags:
363
363
  - site
364
364
  parameters:
@@ -571,8 +571,8 @@ paths:
571
571
  - account
572
572
  operationId: list_accounts
573
573
  summary: List a site's accounts
574
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
575
- to use pagination in the API and Client Libraries.
574
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
575
+ to learn how to use pagination in the API and Client Libraries.
576
576
  parameters:
577
577
  - "$ref": "#/components/parameters/ids"
578
578
  - "$ref": "#/components/parameters/limit"
@@ -2502,8 +2502,8 @@ paths:
2502
2502
  - billing_infos
2503
2503
  operationId: list_billing_infos
2504
2504
  summary: Get the list of billing information associated with an account
2505
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
2506
- to use pagination in the API and Client Libraries.
2505
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
2506
+ to learn how to use pagination in the API and Client Libraries.
2507
2507
  parameters:
2508
2508
  - "$ref": "#/components/parameters/account_id"
2509
2509
  - "$ref": "#/components/parameters/ids"
@@ -2707,8 +2707,8 @@ paths:
2707
2707
  - coupon_redemption
2708
2708
  operationId: list_account_coupon_redemptions
2709
2709
  summary: List the coupon redemptions for an account
2710
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
2711
- to use pagination in the API and Client Libraries.
2710
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
2711
+ to learn how to use pagination in the API and Client Libraries.
2712
2712
  parameters:
2713
2713
  - "$ref": "#/components/parameters/account_id"
2714
2714
  - "$ref": "#/components/parameters/ids"
@@ -2804,8 +2804,8 @@ paths:
2804
2804
  - coupon_redemption
2805
2805
  operationId: list_active_coupon_redemptions
2806
2806
  summary: List the coupon redemptions that are active on an account
2807
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
2808
- to use pagination in the API and Client Libraries.
2807
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
2808
+ to learn how to use pagination in the API and Client Libraries.
2809
2809
  parameters:
2810
2810
  - "$ref": "#/components/parameters/account_id"
2811
2811
  responses:
@@ -3132,8 +3132,8 @@ paths:
3132
3132
  - credit_payment
3133
3133
  operationId: list_account_credit_payments
3134
3134
  summary: List an account's credit payments
3135
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3136
- to use pagination in the API and Client Libraries.
3135
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3136
+ to learn how to use pagination in the API and Client Libraries.
3137
3137
  parameters:
3138
3138
  - "$ref": "#/components/parameters/account_id"
3139
3139
  - "$ref": "#/components/parameters/limit"
@@ -3239,8 +3239,8 @@ paths:
3239
3239
  - invoice
3240
3240
  operationId: list_account_invoices
3241
3241
  summary: List an account's invoices
3242
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3243
- to use pagination in the API and Client Libraries.
3242
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3243
+ to learn how to use pagination in the API and Client Libraries.
3244
3244
  parameters:
3245
3245
  - "$ref": "#/components/parameters/account_id"
3246
3246
  - "$ref": "#/components/parameters/ids"
@@ -3681,8 +3681,8 @@ paths:
3681
3681
  - line_item
3682
3682
  operationId: list_account_line_items
3683
3683
  summary: List an account's line items
3684
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3685
- to use pagination in the API and Client Libraries.
3684
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3685
+ to learn how to use pagination in the API and Client Libraries.
3686
3686
  parameters:
3687
3687
  - "$ref": "#/components/parameters/account_id"
3688
3688
  - "$ref": "#/components/parameters/ids"
@@ -3957,8 +3957,8 @@ paths:
3957
3957
  - note
3958
3958
  operationId: list_account_notes
3959
3959
  summary: List an account's notes
3960
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3961
- to use pagination in the API and Client Libraries.
3960
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3961
+ to learn how to use pagination in the API and Client Libraries.
3962
3962
  parameters:
3963
3963
  - "$ref": "#/components/parameters/account_id"
3964
3964
  - "$ref": "#/components/parameters/ids"
@@ -4171,8 +4171,8 @@ paths:
4171
4171
  - shipping_address
4172
4172
  operationId: list_shipping_addresses
4173
4173
  summary: Fetch a list of an account's shipping addresses
4174
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4175
- to use pagination in the API and Client Libraries.
4174
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4175
+ to learn how to use pagination in the API and Client Libraries.
4176
4176
  parameters:
4177
4177
  - "$ref": "#/components/parameters/account_id"
4178
4178
  - "$ref": "#/components/parameters/ids"
@@ -4853,8 +4853,8 @@ paths:
4853
4853
  - subscription
4854
4854
  operationId: list_account_subscriptions
4855
4855
  summary: List an account's subscriptions
4856
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4857
- to use pagination in the API and Client Libraries.
4856
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4857
+ to learn how to use pagination in the API and Client Libraries.
4858
4858
  parameters:
4859
4859
  - "$ref": "#/components/parameters/account_id"
4860
4860
  - "$ref": "#/components/parameters/ids"
@@ -4957,8 +4957,8 @@ paths:
4957
4957
  - transaction
4958
4958
  operationId: list_account_transactions
4959
4959
  summary: List an account's transactions
4960
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4961
- to use pagination in the API and Client Libraries.
4960
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4961
+ to learn how to use pagination in the API and Client Libraries.
4962
4962
  parameters:
4963
4963
  - "$ref": "#/components/parameters/account_id"
4964
4964
  - "$ref": "#/components/parameters/ids"
@@ -5063,8 +5063,8 @@ paths:
5063
5063
  - account
5064
5064
  operationId: list_child_accounts
5065
5065
  summary: List an account's child accounts
5066
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
5067
- to use pagination in the API and Client Libraries.
5066
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
5067
+ to learn how to use pagination in the API and Client Libraries.
5068
5068
  parameters:
5069
5069
  - "$ref": "#/components/parameters/account_id"
5070
5070
  - "$ref": "#/components/parameters/ids"
@@ -5146,8 +5146,8 @@ paths:
5146
5146
  - account_acquisition
5147
5147
  operationId: list_account_acquisition
5148
5148
  summary: List a site's account acquisition data
5149
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
5150
- to use pagination in the API and Client Libraries.
5149
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
5150
+ to learn how to use pagination in the API and Client Libraries.
5151
5151
  parameters:
5152
5152
  - "$ref": "#/components/parameters/ids"
5153
5153
  - "$ref": "#/components/parameters/limit"
@@ -5245,8 +5245,8 @@ paths:
5245
5245
  - coupon
5246
5246
  operationId: list_coupons
5247
5247
  summary: List a site's coupons
5248
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
5249
- to use pagination in the API and Client Libraries.
5248
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
5249
+ to learn how to use pagination in the API and Client Libraries.
5250
5250
  parameters:
5251
5251
  - "$ref": "#/components/parameters/ids"
5252
5252
  - "$ref": "#/components/parameters/limit"
@@ -6009,8 +6009,8 @@ paths:
6009
6009
  - unique_coupon_code
6010
6010
  operationId: list_unique_coupon_codes
6011
6011
  summary: List unique coupon codes associated with a bulk coupon
6012
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6013
- to use pagination in the API and Client Libraries.
6012
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6013
+ to learn how to use pagination in the API and Client Libraries.
6014
6014
  parameters:
6015
6015
  - "$ref": "#/components/parameters/coupon_id"
6016
6016
  - "$ref": "#/components/parameters/ids"
@@ -6045,8 +6045,8 @@ paths:
6045
6045
  - credit_payment
6046
6046
  operationId: list_credit_payments
6047
6047
  summary: List a site's credit payments
6048
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6049
- to use pagination in the API and Client Libraries.
6048
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6049
+ to learn how to use pagination in the API and Client Libraries.
6050
6050
  parameters:
6051
6051
  - "$ref": "#/components/parameters/limit"
6052
6052
  - "$ref": "#/components/parameters/order"
@@ -6175,8 +6175,8 @@ paths:
6175
6175
  - custom_field_definition
6176
6176
  operationId: list_custom_field_definitions
6177
6177
  summary: List a site's custom field definitions
6178
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6179
- to use pagination in the API and Client Libraries.
6178
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6179
+ to learn how to use pagination in the API and Client Libraries.
6180
6180
  parameters:
6181
6181
  - "$ref": "#/components/parameters/ids"
6182
6182
  - "$ref": "#/components/parameters/limit"
@@ -6400,8 +6400,8 @@ paths:
6400
6400
  - account
6401
6401
  operationId: list_invoice_template_accounts
6402
6402
  summary: List an invoice template's associated accounts
6403
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6404
- to use pagination in the API and Client Libraries.
6403
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6404
+ to learn how to use pagination in the API and Client Libraries.
6405
6405
  parameters:
6406
6406
  - "$ref": "#/components/parameters/invoice_template_id"
6407
6407
  - "$ref": "#/components/parameters/ids"
@@ -6445,8 +6445,8 @@ paths:
6445
6445
  - item
6446
6446
  operationId: list_items
6447
6447
  summary: List a site's items
6448
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6449
- to use pagination in the API and Client Libraries.
6448
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6449
+ to learn how to use pagination in the API and Client Libraries.
6450
6450
  parameters:
6451
6451
  - "$ref": "#/components/parameters/ids"
6452
6452
  - "$ref": "#/components/parameters/limit"
@@ -7280,8 +7280,8 @@ paths:
7280
7280
  - measured_unit
7281
7281
  operationId: list_measured_unit
7282
7282
  summary: List a site's measured units
7283
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
7284
- to use pagination in the API and Client Libraries.
7283
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7284
+ to learn how to use pagination in the API and Client Libraries.
7285
7285
  parameters:
7286
7286
  - "$ref": "#/components/parameters/ids"
7287
7287
  - "$ref": "#/components/parameters/limit"
@@ -7460,8 +7460,8 @@ paths:
7460
7460
  - external_products
7461
7461
  operationId: list_external_products
7462
7462
  summary: List a site's external products
7463
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
7464
- to use pagination in the API and Client Libraries.
7463
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7464
+ to learn how to use pagination in the API and Client Libraries.
7465
7465
  parameters:
7466
7466
  - "$ref": "#/components/parameters/sort_dates"
7467
7467
  responses:
@@ -7518,8 +7518,8 @@ paths:
7518
7518
  - external_subscriptions
7519
7519
  operationId: list_external_subscriptions
7520
7520
  summary: List a site's external subscriptions
7521
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
7522
- to use pagination in the API and Client Libraries.
7521
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7522
+ to learn how to use pagination in the API and Client Libraries.
7523
7523
  parameters:
7524
7524
  - "$ref": "#/components/parameters/sort_dates"
7525
7525
  responses:
@@ -7583,8 +7583,8 @@ paths:
7583
7583
  - invoice
7584
7584
  operationId: list_invoices
7585
7585
  summary: List a site's invoices
7586
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
7587
- to use pagination in the API and Client Libraries.
7586
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7587
+ to learn how to use pagination in the API and Client Libraries.
7588
7588
  parameters:
7589
7589
  - "$ref": "#/components/parameters/ids"
7590
7590
  - "$ref": "#/components/parameters/limit"
@@ -8084,6 +8084,44 @@ paths:
8084
8084
  // Something bad happened... tell the user so that they can fix it?
8085
8085
  echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
8086
8086
  }
8087
+ "/invoices/{invoice_id}/apply_credit_balance":
8088
+ put:
8089
+ tags:
8090
+ - invoice
8091
+ operationId: apply_credit_balance
8092
+ summary: Apply available credit to a pending or past due charge invoice
8093
+ description: Apply credit payment to the outstanding balance on an existing
8094
+ charge invoice from an account’s available balance from existing credit invoices.
8095
+ parameters:
8096
+ - "$ref": "#/components/parameters/site_id"
8097
+ - "$ref": "#/components/parameters/invoice_id"
8098
+ responses:
8099
+ '200':
8100
+ description: The updated invoice.
8101
+ content:
8102
+ application/json:
8103
+ schema:
8104
+ "$ref": "#/components/schemas/Invoice"
8105
+ '404':
8106
+ description: Incorrect site or invoice ID.
8107
+ content:
8108
+ application/json:
8109
+ schema:
8110
+ "$ref": "#/components/schemas/Error"
8111
+ '422':
8112
+ description: Tried applying credit to a legacy or closed invoice or there
8113
+ was an error processing the credit payment.
8114
+ content:
8115
+ application/json:
8116
+ schema:
8117
+ "$ref": "#/components/schemas/Error"
8118
+ default:
8119
+ description: Unexpected error.
8120
+ content:
8121
+ application/json:
8122
+ schema:
8123
+ "$ref": "#/components/schemas/Error"
8124
+ x-code-samples: []
8087
8125
  "/invoices/{invoice_id}/collect":
8088
8126
  put:
8089
8127
  tags:
@@ -8768,8 +8806,8 @@ paths:
8768
8806
  - line_item
8769
8807
  operationId: list_invoice_line_items
8770
8808
  summary: List an invoice's line items
8771
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
8772
- to use pagination in the API and Client Libraries.
8809
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
8810
+ to learn how to use pagination in the API and Client Libraries.
8773
8811
  parameters:
8774
8812
  - "$ref": "#/components/parameters/invoice_id"
8775
8813
  - "$ref": "#/components/parameters/ids"
@@ -8878,8 +8916,8 @@ paths:
8878
8916
  - coupon_redemption
8879
8917
  operationId: list_invoice_coupon_redemptions
8880
8918
  summary: List the coupon redemptions applied to an invoice
8881
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
8882
- to use pagination in the API and Client Libraries.
8919
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
8920
+ to learn how to use pagination in the API and Client Libraries.
8883
8921
  parameters:
8884
8922
  - "$ref": "#/components/parameters/invoice_id"
8885
8923
  - "$ref": "#/components/parameters/ids"
@@ -8978,7 +9016,7 @@ paths:
8978
9016
  For a charge invoice the related invoices will be credit invoices.
8979
9017
  For a credit invoice the related invoices will be charge invoices.
8980
9018
 
8981
- See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
9019
+ See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
8982
9020
  parameters:
8983
9021
  - "$ref": "#/components/parameters/invoice_id"
8984
9022
  responses:
@@ -9232,8 +9270,8 @@ paths:
9232
9270
  - line_item
9233
9271
  operationId: list_line_items
9234
9272
  summary: List a site's line items
9235
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
9236
- to use pagination in the API and Client Libraries.
9273
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
9274
+ to learn how to use pagination in the API and Client Libraries.
9237
9275
  parameters:
9238
9276
  - "$ref": "#/components/parameters/ids"
9239
9277
  - "$ref": "#/components/parameters/limit"
@@ -9573,8 +9611,8 @@ paths:
9573
9611
  - plan
9574
9612
  operationId: list_plans
9575
9613
  summary: List a site's plans
9576
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
9577
- to use pagination in the API and Client Libraries.
9614
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
9615
+ to learn how to use pagination in the API and Client Libraries.
9578
9616
  parameters:
9579
9617
  - "$ref": "#/components/parameters/ids"
9580
9618
  - "$ref": "#/components/parameters/limit"
@@ -10242,8 +10280,8 @@ paths:
10242
10280
  - add-on
10243
10281
  operationId: list_plan_add_ons
10244
10282
  summary: List a plan's add-ons
10245
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
10246
- to use pagination in the API and Client Libraries.
10283
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
10284
+ to learn how to use pagination in the API and Client Libraries.
10247
10285
  parameters:
10248
10286
  - "$ref": "#/components/parameters/plan_id"
10249
10287
  - "$ref": "#/components/parameters/ids"
@@ -10908,8 +10946,8 @@ paths:
10908
10946
  - add-on
10909
10947
  operationId: list_add_ons
10910
10948
  summary: List a site's add-ons
10911
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
10912
- to use pagination in the API and Client Libraries.
10949
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
10950
+ to learn how to use pagination in the API and Client Libraries.
10913
10951
  parameters:
10914
10952
  - "$ref": "#/components/parameters/ids"
10915
10953
  - "$ref": "#/components/parameters/limit"
@@ -11126,8 +11164,8 @@ paths:
11126
11164
  - shipping_method
11127
11165
  operationId: list_shipping_methods
11128
11166
  summary: List a site's shipping methods
11129
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
11130
- to use pagination in the API and Client Libraries.
11167
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
11168
+ to learn how to use pagination in the API and Client Libraries.
11131
11169
  parameters:
11132
11170
  - "$ref": "#/components/parameters/ids"
11133
11171
  - "$ref": "#/components/parameters/limit"
@@ -11372,8 +11410,8 @@ paths:
11372
11410
  - subscription
11373
11411
  operationId: list_subscriptions
11374
11412
  summary: List a site's subscriptions
11375
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
11376
- to use pagination in the API and Client Libraries.
11413
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
11414
+ to learn how to use pagination in the API and Client Libraries.
11377
11415
  parameters:
11378
11416
  - "$ref": "#/components/parameters/ids"
11379
11417
  - "$ref": "#/components/parameters/limit"
@@ -13252,8 +13290,8 @@ paths:
13252
13290
  - invoice
13253
13291
  operationId: list_subscription_invoices
13254
13292
  summary: List a subscription's invoices
13255
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13256
- to use pagination in the API and Client Libraries.
13293
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13294
+ to learn how to use pagination in the API and Client Libraries.
13257
13295
  parameters:
13258
13296
  - "$ref": "#/components/parameters/subscription_id"
13259
13297
  - "$ref": "#/components/parameters/ids"
@@ -13356,8 +13394,8 @@ paths:
13356
13394
  - line_item
13357
13395
  operationId: list_subscription_line_items
13358
13396
  summary: List a subscription's line items
13359
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13360
- to use pagination in the API and Client Libraries.
13397
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13398
+ to learn how to use pagination in the API and Client Libraries.
13361
13399
  parameters:
13362
13400
  - "$ref": "#/components/parameters/subscription_id"
13363
13401
  - "$ref": "#/components/parameters/ids"
@@ -13463,8 +13501,8 @@ paths:
13463
13501
  - coupon_redemption
13464
13502
  operationId: list_subscription_coupon_redemptions
13465
13503
  summary: List the coupon redemptions for a subscription
13466
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13467
- to use pagination in the API and Client Libraries.
13504
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13505
+ to learn how to use pagination in the API and Client Libraries.
13468
13506
  parameters:
13469
13507
  - "$ref": "#/components/parameters/subscription_id"
13470
13508
  - "$ref": "#/components/parameters/ids"
@@ -13762,8 +13800,8 @@ paths:
13762
13800
  - transaction
13763
13801
  operationId: list_transactions
13764
13802
  summary: List a site's transactions
13765
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13766
- to use pagination in the API and Client Libraries.
13803
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13804
+ to learn how to use pagination in the API and Client Libraries.
13767
13805
  parameters:
13768
13806
  - "$ref": "#/components/parameters/ids"
13769
13807
  - "$ref": "#/components/parameters/limit"
@@ -15043,8 +15081,8 @@ paths:
15043
15081
  - dunning_campaigns
15044
15082
  operationId: list_dunning_campaigns
15045
15083
  summary: List the dunning campaigns for a site
15046
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
15047
- to use pagination in the API and Client Libraries.
15084
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
15085
+ to learn how to use pagination in the API and Client Libraries.
15048
15086
  parameters:
15049
15087
  - "$ref": "#/components/parameters/sort_dates"
15050
15088
  responses:
@@ -15146,8 +15184,8 @@ paths:
15146
15184
  - invoice_templates
15147
15185
  operationId: list_invoice_templates
15148
15186
  summary: Show the invoice templates for a site
15149
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
15150
- to use pagination in the API and Client Libraries.
15187
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
15188
+ to learn how to use pagination in the API and Client Libraries.
15151
15189
  parameters:
15152
15190
  - "$ref": "#/components/parameters/sort_dates"
15153
15191
  responses:
@@ -15241,8 +15279,8 @@ paths:
15241
15279
  - account
15242
15280
  operationId: list_account_external_subscriptions
15243
15281
  summary: List an account's external subscriptions
15244
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
15245
- to use pagination in the API and Client Libraries.
15282
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
15283
+ to learn how to use pagination in the API and Client Libraries.
15246
15284
  parameters:
15247
15285
  - "$ref": "#/components/parameters/sort_dates"
15248
15286
  responses:
@@ -16400,9 +16438,15 @@ components:
16400
16438
  processing_prepayment_amount:
16401
16439
  type: number
16402
16440
  format: float
16403
- title: Amount
16441
+ title: Processing Prepayment Amount
16404
16442
  description: Total amount for the prepayment credit invoices in a `processing`
16405
16443
  state on the account.
16444
+ available_credit_amount:
16445
+ type: number
16446
+ format: float
16447
+ title: Available Credit Amount
16448
+ description: Total amount of the open balances on credit invoices for the
16449
+ account.
16406
16450
  InvoiceAddress:
16407
16451
  allOf:
16408
16452
  - "$ref": "#/components/schemas/Address"
@@ -23314,7 +23358,9 @@ components:
23314
23358
  - Dankort
23315
23359
  - Diners Club
23316
23360
  - Discover
23361
+ - ELO
23317
23362
  - Forbrugsforeningen
23363
+ - Hipercard
23318
23364
  - JCB
23319
23365
  - Laser
23320
23366
  - Maestro
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: recurly
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.25.0
4
+ version: 4.26.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-11-15 00:00:00.000000000 Z
11
+ date: 2022-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -326,7 +326,7 @@ metadata:
326
326
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
327
327
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
328
328
  homepage_uri: https://github.com/recurly/recurly-client-ruby
329
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.25.0
329
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.26.0
330
330
  post_install_message:
331
331
  rdoc_options: []
332
332
  require_paths: