recurly 4.11.0 → 4.14.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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +1 -1
  3. data/CHANGELOG.md +35 -0
  4. data/GETTING_STARTED.md +9 -1
  5. data/lib/recurly/client/operations.rb +250 -134
  6. data/lib/recurly/client.rb +14 -2
  7. data/lib/recurly/errors/api_errors.rb +2 -0
  8. data/lib/recurly/requests/account_create.rb +5 -1
  9. data/lib/recurly/requests/account_purchase.rb +5 -1
  10. data/lib/recurly/requests/account_update.rb +5 -1
  11. data/lib/recurly/requests/add_on_create.rb +2 -2
  12. data/lib/recurly/requests/billing_info_create.rb +9 -1
  13. data/lib/recurly/requests/line_item_create.rb +2 -2
  14. data/lib/recurly/requests/plan_create.rb +1 -1
  15. data/lib/recurly/requests/plan_update.rb +1 -1
  16. data/lib/recurly/requests/subscription_add_on_tier.rb +1 -1
  17. data/lib/recurly/requests/tier.rb +1 -1
  18. data/lib/recurly/resources/account.rb +5 -1
  19. data/lib/recurly/resources/account_mini.rb +1 -1
  20. data/lib/recurly/resources/add_on.rb +4 -0
  21. data/lib/recurly/resources/invoice.rb +5 -1
  22. data/lib/recurly/resources/invoice_template.rb +34 -0
  23. data/lib/recurly/resources/line_item.rb +3 -3
  24. data/lib/recurly/resources/percentage_tier.rb +18 -0
  25. data/lib/recurly/resources/percentage_tiers_by_currency.rb +18 -0
  26. data/lib/recurly/resources/plan.rb +1 -1
  27. data/lib/recurly/resources/subscription_add_on.rb +4 -0
  28. data/lib/recurly/resources/subscription_add_on_percentage_tier.rb +18 -0
  29. data/lib/recurly/resources/subscription_add_on_tier.rb +1 -1
  30. data/lib/recurly/resources/tier.rb +1 -1
  31. data/lib/recurly/version.rb +1 -1
  32. data/openapi/api.yaml +573 -52
  33. metadata +7 -3
@@ -10,7 +10,7 @@ module Recurly
10
10
 
11
11
  # List sites
12
12
  #
13
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api documenation}
13
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api documentation}
14
14
  #
15
15
  # @param params [Hash] Optional query string parameters:
16
16
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -50,7 +50,7 @@ module Recurly
50
50
 
51
51
  # Fetch a site
52
52
  #
53
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_site get_site api documenation}
53
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_site get_site api documentation}
54
54
  #
55
55
  # @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+.
56
56
  # @param params [Hash] Optional query string parameters:
@@ -73,7 +73,7 @@ module Recurly
73
73
 
74
74
  # List a site's accounts
75
75
  #
76
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api documenation}
76
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api documentation}
77
77
  #
78
78
  # @param params [Hash] Optional query string parameters:
79
79
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -123,7 +123,7 @@ module Recurly
123
123
 
124
124
  # Create an account
125
125
  #
126
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_account create_account api documenation}
126
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_account create_account api documentation}
127
127
  #
128
128
  # @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
129
129
  # @param params [Hash] Optional query string parameters:
@@ -172,7 +172,7 @@ module Recurly
172
172
 
173
173
  # Fetch an account
174
174
  #
175
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_account get_account api documenation}
175
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account get_account api documentation}
176
176
  #
177
177
  # @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+.
178
178
  # @param params [Hash] Optional query string parameters:
@@ -195,7 +195,7 @@ module Recurly
195
195
 
196
196
  # Update an account
197
197
  #
198
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_account update_account api documenation}
198
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_account update_account api documentation}
199
199
  #
200
200
  # @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+.
201
201
  # @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
@@ -226,7 +226,7 @@ module Recurly
226
226
 
227
227
  # Deactivate an account
228
228
  #
229
- # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account deactivate_account api documenation}
229
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account deactivate_account api documentation}
230
230
  #
231
231
  # @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+.
232
232
  # @param params [Hash] Optional query string parameters:
@@ -249,7 +249,7 @@ module Recurly
249
249
 
250
250
  # Fetch an account's acquisition data
251
251
  #
252
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition get_account_acquisition api documenation}
252
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition get_account_acquisition api documentation}
253
253
  #
254
254
  # @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+.
255
255
  # @param params [Hash] Optional query string parameters:
@@ -272,7 +272,7 @@ module Recurly
272
272
 
273
273
  # Update an account's acquisition data
274
274
  #
275
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition update_account_acquisition api documenation}
275
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition update_account_acquisition api documentation}
276
276
  #
277
277
  # @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+.
278
278
  # @param body [Requests::AccountAcquisitionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdate}
@@ -308,7 +308,7 @@ module Recurly
308
308
 
309
309
  # Remove an account's acquisition data
310
310
  #
311
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition remove_account_acquisition api documenation}
311
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition remove_account_acquisition api documentation}
312
312
  #
313
313
  # @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+.
314
314
  # @param params [Hash] Optional query string parameters:
@@ -331,7 +331,7 @@ module Recurly
331
331
 
332
332
  # Reactivate an inactive account
333
333
  #
334
- # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account reactivate_account api documenation}
334
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account reactivate_account api documentation}
335
335
  #
336
336
  # @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+.
337
337
  # @param params [Hash] Optional query string parameters:
@@ -354,7 +354,7 @@ module Recurly
354
354
 
355
355
  # Fetch an account's balance and past due status
356
356
  #
357
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance get_account_balance api documenation}
357
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance get_account_balance api documentation}
358
358
  #
359
359
  # @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+.
360
360
  # @param params [Hash] Optional query string parameters:
@@ -377,7 +377,7 @@ module Recurly
377
377
 
378
378
  # Fetch an account's billing information
379
379
  #
380
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info get_billing_info api documenation}
380
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info get_billing_info api documentation}
381
381
  #
382
382
  # @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+.
383
383
  # @param params [Hash] Optional query string parameters:
@@ -400,7 +400,7 @@ module Recurly
400
400
 
401
401
  # Set an account's billing information
402
402
  #
403
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info update_billing_info api documenation}
403
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info update_billing_info api documentation}
404
404
  #
405
405
  # @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+.
406
406
  # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
@@ -431,7 +431,7 @@ module Recurly
431
431
 
432
432
  # Remove an account's billing information
433
433
  #
434
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info remove_billing_info api documenation}
434
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info remove_billing_info api documentation}
435
435
  #
436
436
  # @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+.
437
437
  # @param params [Hash] Optional query string parameters:
@@ -454,7 +454,7 @@ module Recurly
454
454
 
455
455
  # Verify an account's credit card billing information
456
456
  #
457
- # {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documenation}
457
+ # {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documentation}
458
458
  #
459
459
  # @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+.
460
460
  # @param params [Hash] Optional query string parameters:
@@ -478,7 +478,7 @@ module Recurly
478
478
 
479
479
  # Get the list of billing information associated with an account
480
480
  #
481
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documenation}
481
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documentation}
482
482
  #
483
483
  # @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+.
484
484
  # @param params [Hash] Optional query string parameters:
@@ -514,7 +514,7 @@ module Recurly
514
514
 
515
515
  # Add new billing information on an account
516
516
  #
517
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documenation}
517
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documentation}
518
518
  #
519
519
  # @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+.
520
520
  # @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
@@ -529,7 +529,7 @@ module Recurly
529
529
 
530
530
  # Fetch a billing info
531
531
  #
532
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info get_a_billing_info api documenation}
532
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info get_a_billing_info api documentation}
533
533
  #
534
534
  # @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+.
535
535
  # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
@@ -544,7 +544,7 @@ module Recurly
544
544
 
545
545
  # Update an account's billing information
546
546
  #
547
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info update_a_billing_info api documenation}
547
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info update_a_billing_info api documentation}
548
548
  #
549
549
  # @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+.
550
550
  # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
@@ -560,7 +560,7 @@ module Recurly
560
560
 
561
561
  # Remove an account's billing information
562
562
  #
563
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info remove_a_billing_info api documenation}
563
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info remove_a_billing_info api documentation}
564
564
  #
565
565
  # @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+.
566
566
  # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
@@ -575,7 +575,7 @@ module Recurly
575
575
 
576
576
  # Show the coupon redemptions for an account
577
577
  #
578
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documenation}
578
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
579
579
  #
580
580
  # @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+.
581
581
  # @param params [Hash] Optional query string parameters:
@@ -623,7 +623,7 @@ module Recurly
623
623
 
624
624
  # Show the coupon redemptions that are active on an account
625
625
  #
626
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documenation}
626
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documentation}
627
627
  #
628
628
  # @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+.
629
629
  # @param params [Hash] Optional query string parameters:
@@ -645,7 +645,7 @@ module Recurly
645
645
 
646
646
  # Generate an active coupon redemption on an account or subscription
647
647
  #
648
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption create_coupon_redemption api documenation}
648
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption create_coupon_redemption api documentation}
649
649
  #
650
650
  # @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+.
651
651
  # @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
@@ -676,7 +676,7 @@ module Recurly
676
676
 
677
677
  # Delete the active coupon redemption from an account
678
678
  #
679
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption remove_coupon_redemption api documenation}
679
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption remove_coupon_redemption api documentation}
680
680
  #
681
681
  # @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+.
682
682
  # @param params [Hash] Optional query string parameters:
@@ -699,7 +699,7 @@ module Recurly
699
699
 
700
700
  # List an account's credit payments
701
701
  #
702
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api documenation}
702
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api documentation}
703
703
  #
704
704
  # @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+.
705
705
  # @param params [Hash] Optional query string parameters:
@@ -736,7 +736,7 @@ module Recurly
736
736
 
737
737
  # List an account's invoices
738
738
  #
739
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documenation}
739
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documentation}
740
740
  #
741
741
  # @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+.
742
742
  # @param params [Hash] Optional query string parameters:
@@ -791,7 +791,7 @@ module Recurly
791
791
 
792
792
  # Create an invoice for pending line items
793
793
  #
794
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice create_invoice api documenation}
794
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice create_invoice api documentation}
795
795
  #
796
796
  # @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+.
797
797
  # @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
@@ -822,7 +822,7 @@ module Recurly
822
822
 
823
823
  # Preview new invoice for pending line items
824
824
  #
825
- # {https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice preview_invoice api documenation}
825
+ # {https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice preview_invoice api documentation}
826
826
  #
827
827
  # @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+.
828
828
  # @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
@@ -853,7 +853,7 @@ module Recurly
853
853
 
854
854
  # List an account's line items
855
855
  #
856
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items list_account_line_items api documenation}
856
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items list_account_line_items api documentation}
857
857
  #
858
858
  # @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+.
859
859
  # @param params [Hash] Optional query string parameters:
@@ -905,7 +905,7 @@ module Recurly
905
905
 
906
906
  # Create a new line item for the account
907
907
  #
908
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_line_item create_line_item api documenation}
908
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_line_item create_line_item api documentation}
909
909
  #
910
910
  # @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+.
911
911
  # @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
@@ -937,7 +937,7 @@ module Recurly
937
937
 
938
938
  # Fetch a list of an account's notes
939
939
  #
940
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documenation}
940
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documentation}
941
941
  #
942
942
  # @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+.
943
943
  # @param params [Hash] Optional query string parameters:
@@ -971,7 +971,7 @@ module Recurly
971
971
 
972
972
  # Fetch an account note
973
973
  #
974
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documenation}
974
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documentation}
975
975
  #
976
976
  # @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+.
977
977
  # @param account_note_id [String] Account Note ID.
@@ -998,7 +998,7 @@ module Recurly
998
998
 
999
999
  # Fetch a list of an account's shipping addresses
1000
1000
  #
1001
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documenation}
1001
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documentation}
1002
1002
  #
1003
1003
  # @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+.
1004
1004
  # @param params [Hash] Optional query string parameters:
@@ -1047,7 +1047,7 @@ module Recurly
1047
1047
 
1048
1048
  # Create a new shipping address for the account
1049
1049
  #
1050
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address create_shipping_address api documenation}
1050
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address create_shipping_address api documentation}
1051
1051
  #
1052
1052
  # @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+.
1053
1053
  # @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
@@ -1081,7 +1081,7 @@ module Recurly
1081
1081
 
1082
1082
  # Fetch an account's shipping address
1083
1083
  #
1084
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address get_shipping_address api documenation}
1084
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address get_shipping_address api documentation}
1085
1085
  #
1086
1086
  # @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+.
1087
1087
  # @param shipping_address_id [String] Shipping Address ID.
@@ -1108,7 +1108,7 @@ module Recurly
1108
1108
 
1109
1109
  # Update an account's shipping address
1110
1110
  #
1111
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address update_shipping_address api documenation}
1111
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address update_shipping_address api documentation}
1112
1112
  #
1113
1113
  # @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+.
1114
1114
  # @param shipping_address_id [String] Shipping Address ID.
@@ -1142,7 +1142,7 @@ module Recurly
1142
1142
 
1143
1143
  # Remove an account's shipping address
1144
1144
  #
1145
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address remove_shipping_address api documenation}
1145
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address remove_shipping_address api documentation}
1146
1146
  #
1147
1147
  # @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+.
1148
1148
  # @param shipping_address_id [String] Shipping Address ID.
@@ -1169,7 +1169,7 @@ module Recurly
1169
1169
 
1170
1170
  # List an account's subscriptions
1171
1171
  #
1172
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions list_account_subscriptions api documenation}
1172
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions list_account_subscriptions api documentation}
1173
1173
  #
1174
1174
  # @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+.
1175
1175
  # @param params [Hash] Optional query string parameters:
@@ -1224,7 +1224,7 @@ module Recurly
1224
1224
 
1225
1225
  # List an account's transactions
1226
1226
  #
1227
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions list_account_transactions api documenation}
1227
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions list_account_transactions api documentation}
1228
1228
  #
1229
1229
  # @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+.
1230
1230
  # @param params [Hash] Optional query string parameters:
@@ -1275,7 +1275,7 @@ module Recurly
1275
1275
 
1276
1276
  # List an account's child accounts
1277
1277
  #
1278
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts list_child_accounts api documenation}
1278
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts list_child_accounts api documentation}
1279
1279
  #
1280
1280
  # @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+.
1281
1281
  # @param params [Hash] Optional query string parameters:
@@ -1329,7 +1329,7 @@ module Recurly
1329
1329
 
1330
1330
  # List a site's account acquisition data
1331
1331
  #
1332
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api documenation}
1332
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api documentation}
1333
1333
  #
1334
1334
  # @param params [Hash] Optional query string parameters:
1335
1335
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -1374,7 +1374,7 @@ module Recurly
1374
1374
 
1375
1375
  # List a site's coupons
1376
1376
  #
1377
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api documenation}
1377
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api documentation}
1378
1378
  #
1379
1379
  # @param params [Hash] Optional query string parameters:
1380
1380
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -1419,7 +1419,7 @@ module Recurly
1419
1419
 
1420
1420
  # Create a new coupon
1421
1421
  #
1422
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon create_coupon api documenation}
1422
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon create_coupon api documentation}
1423
1423
  #
1424
1424
  # @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
1425
1425
  # @param params [Hash] Optional query string parameters:
@@ -1455,7 +1455,7 @@ module Recurly
1455
1455
 
1456
1456
  # Fetch a coupon
1457
1457
  #
1458
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon get_coupon api documenation}
1458
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon get_coupon api documentation}
1459
1459
  #
1460
1460
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1461
1461
  # @param params [Hash] Optional query string parameters:
@@ -1478,7 +1478,7 @@ module Recurly
1478
1478
 
1479
1479
  # Update an active coupon
1480
1480
  #
1481
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_coupon update_coupon api documenation}
1481
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_coupon update_coupon api documentation}
1482
1482
  #
1483
1483
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1484
1484
  # @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
@@ -1505,7 +1505,7 @@ module Recurly
1505
1505
 
1506
1506
  # Expire a coupon
1507
1507
  #
1508
- # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon deactivate_coupon api documenation}
1508
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon deactivate_coupon api documentation}
1509
1509
  #
1510
1510
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1511
1511
  # @param params [Hash] Optional query string parameters:
@@ -1528,7 +1528,7 @@ module Recurly
1528
1528
 
1529
1529
  # Generate unique coupon codes
1530
1530
  #
1531
- # {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_unique_coupon_codes api documenation}
1531
+ # {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_unique_coupon_codes api documentation}
1532
1532
  #
1533
1533
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1534
1534
  # @param body [Requests::CouponBulkCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponBulkCreate}
@@ -1543,7 +1543,7 @@ module Recurly
1543
1543
 
1544
1544
  # Restore an inactive coupon
1545
1545
  #
1546
- # {https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon restore_coupon api documenation}
1546
+ # {https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon restore_coupon api documentation}
1547
1547
  #
1548
1548
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1549
1549
  # @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
@@ -1558,7 +1558,7 @@ module Recurly
1558
1558
 
1559
1559
  # List unique coupon codes associated with a bulk coupon
1560
1560
  #
1561
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes list_unique_coupon_codes api documenation}
1561
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes list_unique_coupon_codes api documentation}
1562
1562
  #
1563
1563
  # @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
1564
1564
  # @param params [Hash] Optional query string parameters:
@@ -1596,7 +1596,7 @@ module Recurly
1596
1596
 
1597
1597
  # List a site's credit payments
1598
1598
  #
1599
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api documenation}
1599
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api documentation}
1600
1600
  #
1601
1601
  # @param params [Hash] Optional query string parameters:
1602
1602
  # :limit [Integer] Limit number of records 1-200.
@@ -1629,7 +1629,7 @@ module Recurly
1629
1629
 
1630
1630
  # Fetch a credit payment
1631
1631
  #
1632
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment get_credit_payment api documenation}
1632
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment get_credit_payment api documentation}
1633
1633
  #
1634
1634
  # @param credit_payment_id [String] Credit Payment ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
1635
1635
  # @param params [Hash] Optional query string parameters:
@@ -1643,7 +1643,7 @@ module Recurly
1643
1643
 
1644
1644
  # List a site's custom field definitions
1645
1645
  #
1646
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api documenation}
1646
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api documentation}
1647
1647
  #
1648
1648
  # @param params [Hash] Optional query string parameters:
1649
1649
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -1689,7 +1689,7 @@ module Recurly
1689
1689
 
1690
1690
  # Fetch an custom field definition
1691
1691
  #
1692
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api documenation}
1692
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api documentation}
1693
1693
  #
1694
1694
  # @param custom_field_definition_id [String] Custom Field Definition ID
1695
1695
  # @param params [Hash] Optional query string parameters:
@@ -1712,9 +1712,52 @@ module Recurly
1712
1712
  get(path, **options)
1713
1713
  end
1714
1714
 
1715
+ # List an invoice template's associated accounts
1716
+ #
1717
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts list_invoice_template_accounts api documentation}
1718
+ #
1719
+ # @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
1720
+ # @param params [Hash] Optional query string parameters:
1721
+ # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
1722
+ # commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
1723
+ #
1724
+ # *Important notes:*
1725
+ #
1726
+ # * The +ids+ parameter cannot be used with any other ordering or filtering
1727
+ # parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
1728
+ # * Invalid or unknown IDs will be ignored, so you should check that the
1729
+ # results correspond to your request.
1730
+ # * Records are returned in an arbitrary order. Since results are all
1731
+ # returned at once you can sort the records yourself.
1732
+ #
1733
+ # :limit [Integer] Limit number of records 1-200.
1734
+ # :order [String] Sort order.
1735
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
1736
+ # order. In descending order updated records will move behind the cursor and could
1737
+ # prevent some records from being returned.
1738
+ #
1739
+ # :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
1740
+ # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1741
+ #
1742
+ # :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
1743
+ # *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
1744
+ #
1745
+ # :email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
1746
+ # :subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
1747
+ # +canceled+, or +future+ state.
1748
+ #
1749
+ # :past_due [String] Filter for accounts with an invoice in the +past_due+ state.
1750
+ #
1751
+ # @return [Pager<Resources::Account>] A list of an invoice template's associated accounts.
1752
+ #
1753
+ def list_invoice_template_accounts(invoice_template_id:, **options)
1754
+ path = interpolate_path("/invoice_templates/{invoice_template_id}/accounts", invoice_template_id: invoice_template_id)
1755
+ pager(path, **options)
1756
+ end
1757
+
1715
1758
  # List a site's items
1716
1759
  #
1717
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documenation}
1760
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documentation}
1718
1761
  #
1719
1762
  # @param params [Hash] Optional query string parameters:
1720
1763
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -1760,7 +1803,7 @@ module Recurly
1760
1803
 
1761
1804
  # Create a new item
1762
1805
  #
1763
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_item create_item api documenation}
1806
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_item create_item api documentation}
1764
1807
  #
1765
1808
  # @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
1766
1809
  # @param params [Hash] Optional query string parameters:
@@ -1795,7 +1838,7 @@ module Recurly
1795
1838
 
1796
1839
  # Fetch an item
1797
1840
  #
1798
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_item get_item api documenation}
1841
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_item get_item api documentation}
1799
1842
  #
1800
1843
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1801
1844
  # @param params [Hash] Optional query string parameters:
@@ -1818,7 +1861,7 @@ module Recurly
1818
1861
 
1819
1862
  # Update an active item
1820
1863
  #
1821
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_item update_item api documenation}
1864
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_item update_item api documentation}
1822
1865
  #
1823
1866
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1824
1867
  # @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
@@ -1849,7 +1892,7 @@ module Recurly
1849
1892
 
1850
1893
  # Deactivate an item
1851
1894
  #
1852
- # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item deactivate_item api documenation}
1895
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item deactivate_item api documentation}
1853
1896
  #
1854
1897
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1855
1898
  # @param params [Hash] Optional query string parameters:
@@ -1872,7 +1915,7 @@ module Recurly
1872
1915
 
1873
1916
  # Reactivate an inactive item
1874
1917
  #
1875
- # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item reactivate_item api documenation}
1918
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item reactivate_item api documentation}
1876
1919
  #
1877
1920
  # @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
1878
1921
  # @param params [Hash] Optional query string parameters:
@@ -1895,7 +1938,7 @@ module Recurly
1895
1938
 
1896
1939
  # List a site's measured units
1897
1940
  #
1898
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api documenation}
1941
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api documentation}
1899
1942
  #
1900
1943
  # @param params [Hash] Optional query string parameters:
1901
1944
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -1933,7 +1976,7 @@ module Recurly
1933
1976
 
1934
1977
  # Create a new measured unit
1935
1978
  #
1936
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit create_measured_unit api documenation}
1979
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit create_measured_unit api documentation}
1937
1980
  #
1938
1981
  # @param body [Requests::MeasuredUnitCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitCreate}
1939
1982
  # @param params [Hash] Optional query string parameters:
@@ -1947,7 +1990,7 @@ module Recurly
1947
1990
 
1948
1991
  # Fetch a measured unit
1949
1992
  #
1950
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit get_measured_unit api documenation}
1993
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit get_measured_unit api documentation}
1951
1994
  #
1952
1995
  # @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
1953
1996
  # @param params [Hash] Optional query string parameters:
@@ -1961,7 +2004,7 @@ module Recurly
1961
2004
 
1962
2005
  # Update a measured unit
1963
2006
  #
1964
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit update_measured_unit api documenation}
2007
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit update_measured_unit api documentation}
1965
2008
  #
1966
2009
  # @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
1967
2010
  # @param body [Requests::MeasuredUnitUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitUpdate}
@@ -1976,7 +2019,7 @@ module Recurly
1976
2019
 
1977
2020
  # Remove a measured unit
1978
2021
  #
1979
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit remove_measured_unit api documenation}
2022
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit remove_measured_unit api documentation}
1980
2023
  #
1981
2024
  # @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
1982
2025
  # @param params [Hash] Optional query string parameters:
@@ -1990,7 +2033,7 @@ module Recurly
1990
2033
 
1991
2034
  # List a site's invoices
1992
2035
  #
1993
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documenation}
2036
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}
1994
2037
  #
1995
2038
  # @param params [Hash] Optional query string parameters:
1996
2039
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -2041,7 +2084,7 @@ module Recurly
2041
2084
 
2042
2085
  # Fetch an invoice
2043
2086
  #
2044
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api documenation}
2087
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api documentation}
2045
2088
  #
2046
2089
  # @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+.
2047
2090
  # @param params [Hash] Optional query string parameters:
@@ -2064,7 +2107,7 @@ module Recurly
2064
2107
 
2065
2108
  # Update an invoice
2066
2109
  #
2067
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api documenation}
2110
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api documentation}
2068
2111
  #
2069
2112
  # @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+.
2070
2113
  # @param body [Requests::InvoiceUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdate}
@@ -2092,7 +2135,7 @@ module Recurly
2092
2135
 
2093
2136
  # Fetch an invoice as a PDF
2094
2137
  #
2095
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api documenation}
2138
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api documentation}
2096
2139
  #
2097
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+.
2098
2141
  # @param params [Hash] Optional query string parameters:
@@ -2118,7 +2161,7 @@ module Recurly
2118
2161
 
2119
2162
  # Collect a pending or past due, automatic invoice
2120
2163
  #
2121
- # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documenation}
2164
+ # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documentation}
2122
2165
  #
2123
2166
  # @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+.
2124
2167
  # @param params [Hash] Optional query string parameters:
@@ -2142,7 +2185,7 @@ module Recurly
2142
2185
 
2143
2186
  # Mark an open invoice as failed
2144
2187
  #
2145
- # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api documenation}
2188
+ # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api documentation}
2146
2189
  #
2147
2190
  # @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+.
2148
2191
  # @param params [Hash] Optional query string parameters:
@@ -2165,7 +2208,7 @@ module Recurly
2165
2208
 
2166
2209
  # Mark an open invoice as successful
2167
2210
  #
2168
- # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api documenation}
2211
+ # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api documentation}
2169
2212
  #
2170
2213
  # @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+.
2171
2214
  # @param params [Hash] Optional query string parameters:
@@ -2188,7 +2231,7 @@ module Recurly
2188
2231
 
2189
2232
  # Reopen a closed, manual invoice
2190
2233
  #
2191
- # {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api documenation}
2234
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api documentation}
2192
2235
  #
2193
2236
  # @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+.
2194
2237
  # @param params [Hash] Optional query string parameters:
@@ -2211,7 +2254,7 @@ module Recurly
2211
2254
 
2212
2255
  # Void a credit invoice.
2213
2256
  #
2214
- # {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api documenation}
2257
+ # {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api documentation}
2215
2258
  #
2216
2259
  # @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+.
2217
2260
  # @param params [Hash] Optional query string parameters:
@@ -2234,7 +2277,7 @@ module Recurly
2234
2277
 
2235
2278
  # Record an external payment for a manual invoices.
2236
2279
  #
2237
- # {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api documenation}
2280
+ # {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api documentation}
2238
2281
  #
2239
2282
  # @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+.
2240
2283
  # @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
@@ -2249,7 +2292,7 @@ module Recurly
2249
2292
 
2250
2293
  # List an invoice's line items
2251
2294
  #
2252
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api documenation}
2295
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api documentation}
2253
2296
  #
2254
2297
  # @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+.
2255
2298
  # @param params [Hash] Optional query string parameters:
@@ -2301,7 +2344,7 @@ module Recurly
2301
2344
 
2302
2345
  # Show the coupon redemptions applied to an invoice
2303
2346
  #
2304
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documenation}
2347
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
2305
2348
  #
2306
2349
  # @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+.
2307
2350
  # @param params [Hash] Optional query string parameters:
@@ -2348,7 +2391,7 @@ module Recurly
2348
2391
 
2349
2392
  # List an invoice's related credit or charge invoices
2350
2393
  #
2351
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api documenation}
2394
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api documentation}
2352
2395
  #
2353
2396
  # @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+.
2354
2397
  # @param params [Hash] Optional query string parameters:
@@ -2373,7 +2416,7 @@ module Recurly
2373
2416
 
2374
2417
  # Refund an invoice
2375
2418
  #
2376
- # {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api documenation}
2419
+ # {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api documentation}
2377
2420
  #
2378
2421
  # @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+.
2379
2422
  # @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
@@ -2404,7 +2447,7 @@ module Recurly
2404
2447
 
2405
2448
  # List a site's line items
2406
2449
  #
2407
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documenation}
2450
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documentation}
2408
2451
  #
2409
2452
  # @param params [Hash] Optional query string parameters:
2410
2453
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -2454,7 +2497,7 @@ module Recurly
2454
2497
 
2455
2498
  # Fetch a line item
2456
2499
  #
2457
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api documenation}
2500
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api documentation}
2458
2501
  #
2459
2502
  # @param line_item_id [String] Line Item ID.
2460
2503
  # @param params [Hash] Optional query string parameters:
@@ -2477,7 +2520,7 @@ module Recurly
2477
2520
 
2478
2521
  # Delete an uninvoiced line item
2479
2522
  #
2480
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api documenation}
2523
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api documentation}
2481
2524
  #
2482
2525
  # @param line_item_id [String] Line Item ID.
2483
2526
  # @param params [Hash] Optional query string parameters:
@@ -2502,7 +2545,7 @@ module Recurly
2502
2545
 
2503
2546
  # List a site's plans
2504
2547
  #
2505
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api documenation}
2548
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api documentation}
2506
2549
  #
2507
2550
  # @param params [Hash] Optional query string parameters:
2508
2551
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -2548,7 +2591,7 @@ module Recurly
2548
2591
 
2549
2592
  # Create a plan
2550
2593
  #
2551
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan create_plan api documenation}
2594
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan create_plan api documentation}
2552
2595
  #
2553
2596
  # @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
2554
2597
  # @param params [Hash] Optional query string parameters:
@@ -2588,7 +2631,7 @@ module Recurly
2588
2631
 
2589
2632
  # Fetch a plan
2590
2633
  #
2591
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan get_plan api documenation}
2634
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan get_plan api documentation}
2592
2635
  #
2593
2636
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2594
2637
  # @param params [Hash] Optional query string parameters:
@@ -2611,7 +2654,7 @@ module Recurly
2611
2654
 
2612
2655
  # Update a plan
2613
2656
  #
2614
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan update_plan api documenation}
2657
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan update_plan api documentation}
2615
2658
  #
2616
2659
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2617
2660
  # @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
@@ -2638,7 +2681,7 @@ module Recurly
2638
2681
 
2639
2682
  # Remove a plan
2640
2683
  #
2641
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan remove_plan api documenation}
2684
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan remove_plan api documentation}
2642
2685
  #
2643
2686
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2644
2687
  # @param params [Hash] Optional query string parameters:
@@ -2661,7 +2704,7 @@ module Recurly
2661
2704
 
2662
2705
  # List a plan's add-ons
2663
2706
  #
2664
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons list_plan_add_ons api documenation}
2707
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons list_plan_add_ons api documentation}
2665
2708
  #
2666
2709
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2667
2710
  # @param params [Hash] Optional query string parameters:
@@ -2711,7 +2754,7 @@ module Recurly
2711
2754
 
2712
2755
  # Create an add-on
2713
2756
  #
2714
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on create_plan_add_on api documenation}
2757
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on create_plan_add_on api documentation}
2715
2758
  #
2716
2759
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2717
2760
  # @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
@@ -2746,7 +2789,7 @@ module Recurly
2746
2789
 
2747
2790
  # Fetch a plan's add-on
2748
2791
  #
2749
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan_add_on get_plan_add_on api documenation}
2792
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan_add_on get_plan_add_on api documentation}
2750
2793
  #
2751
2794
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2752
2795
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
@@ -2772,7 +2815,7 @@ module Recurly
2772
2815
 
2773
2816
  # Update an add-on
2774
2817
  #
2775
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan_add_on update_plan_add_on api documenation}
2818
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan_add_on update_plan_add_on api documentation}
2776
2819
  #
2777
2820
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2778
2821
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
@@ -2804,7 +2847,7 @@ module Recurly
2804
2847
 
2805
2848
  # Remove an add-on
2806
2849
  #
2807
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan_add_on remove_plan_add_on api documenation}
2850
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan_add_on remove_plan_add_on api documentation}
2808
2851
  #
2809
2852
  # @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2810
2853
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
@@ -2831,7 +2874,7 @@ module Recurly
2831
2874
 
2832
2875
  # List a site's add-ons
2833
2876
  #
2834
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documenation}
2877
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documentation}
2835
2878
  #
2836
2879
  # @param params [Hash] Optional query string parameters:
2837
2880
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -2879,7 +2922,7 @@ module Recurly
2879
2922
 
2880
2923
  # Fetch an add-on
2881
2924
  #
2882
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_add_on get_add_on api documenation}
2925
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_add_on get_add_on api documentation}
2883
2926
  #
2884
2927
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
2885
2928
  # @param params [Hash] Optional query string parameters:
@@ -2902,7 +2945,7 @@ module Recurly
2902
2945
 
2903
2946
  # List a site's shipping methods
2904
2947
  #
2905
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api documenation}
2948
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api documentation}
2906
2949
  #
2907
2950
  # @param params [Hash] Optional query string parameters:
2908
2951
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -2949,7 +2992,7 @@ module Recurly
2949
2992
 
2950
2993
  # Create a new shipping method
2951
2994
  #
2952
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_method create_shipping_method api documenation}
2995
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_method create_shipping_method api documentation}
2953
2996
  #
2954
2997
  # @param body [Requests::ShippingMethodCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodCreate}
2955
2998
  # @param params [Hash] Optional query string parameters:
@@ -2963,7 +3006,7 @@ module Recurly
2963
3006
 
2964
3007
  # Fetch a shipping method
2965
3008
  #
2966
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_shipping_method api documenation}
3009
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_shipping_method api documentation}
2967
3010
  #
2968
3011
  # @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
2969
3012
  # @param params [Hash] Optional query string parameters:
@@ -2977,7 +3020,7 @@ module Recurly
2977
3020
 
2978
3021
  # Update an active Shipping Method
2979
3022
  #
2980
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_method update_shipping_method api documenation}
3023
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_method update_shipping_method api documentation}
2981
3024
  #
2982
3025
  # @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
2983
3026
  # @param body [Requests::ShippingMethodUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodUpdate}
@@ -2992,7 +3035,7 @@ module Recurly
2992
3035
 
2993
3036
  # Deactivate a shipping method
2994
3037
  #
2995
- # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_shipping_method deactivate_shipping_method api documenation}
3038
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_shipping_method deactivate_shipping_method api documentation}
2996
3039
  #
2997
3040
  # @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
2998
3041
  # @param params [Hash] Optional query string parameters:
@@ -3006,7 +3049,7 @@ module Recurly
3006
3049
 
3007
3050
  # List a site's subscriptions
3008
3051
  #
3009
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api documenation}
3052
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api documentation}
3010
3053
  #
3011
3054
  # @param params [Hash] Optional query string parameters:
3012
3055
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -3057,7 +3100,7 @@ module Recurly
3057
3100
 
3058
3101
  # Create a new subscription
3059
3102
  #
3060
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription create_subscription api documenation}
3103
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription create_subscription api documentation}
3061
3104
  #
3062
3105
  # @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
3063
3106
  # @param params [Hash] Optional query string parameters:
@@ -3090,7 +3133,7 @@ module Recurly
3090
3133
 
3091
3134
  # Fetch a subscription
3092
3135
  #
3093
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription get_subscription api documenation}
3136
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription get_subscription api documentation}
3094
3137
  #
3095
3138
  # @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+.
3096
3139
  # @param params [Hash] Optional query string parameters:
@@ -3115,7 +3158,7 @@ module Recurly
3115
3158
 
3116
3159
  # Update a subscription
3117
3160
  #
3118
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_subscription api documenation}
3161
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_subscription api documentation}
3119
3162
  #
3120
3163
  # @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+.
3121
3164
  # @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
@@ -3146,7 +3189,7 @@ module Recurly
3146
3189
 
3147
3190
  # Terminate a subscription
3148
3191
  #
3149
- # {https://developers.recurly.com/api/v2021-02-25#operation/terminate_subscription terminate_subscription api documenation}
3192
+ # {https://developers.recurly.com/api/v2021-02-25#operation/terminate_subscription terminate_subscription api documentation}
3150
3193
  #
3151
3194
  # @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+.
3152
3195
  # @param params [Hash] Optional query string parameters:
@@ -3182,7 +3225,7 @@ module Recurly
3182
3225
 
3183
3226
  # Cancel a subscription
3184
3227
  #
3185
- # {https://developers.recurly.com/api/v2021-02-25#operation/cancel_subscription cancel_subscription api documenation}
3228
+ # {https://developers.recurly.com/api/v2021-02-25#operation/cancel_subscription cancel_subscription api documentation}
3186
3229
  #
3187
3230
  # @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+.
3188
3231
  # @param params [Hash] Optional query string parameters:
@@ -3208,7 +3251,7 @@ module Recurly
3208
3251
 
3209
3252
  # Reactivate a canceled subscription
3210
3253
  #
3211
- # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_subscription reactivate_subscription api documenation}
3254
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_subscription reactivate_subscription api documentation}
3212
3255
  #
3213
3256
  # @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+.
3214
3257
  # @param params [Hash] Optional query string parameters:
@@ -3233,7 +3276,7 @@ module Recurly
3233
3276
 
3234
3277
  # Pause subscription
3235
3278
  #
3236
- # {https://developers.recurly.com/api/v2021-02-25#operation/pause_subscription pause_subscription api documenation}
3279
+ # {https://developers.recurly.com/api/v2021-02-25#operation/pause_subscription pause_subscription api documentation}
3237
3280
  #
3238
3281
  # @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+.
3239
3282
  # @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
@@ -3263,7 +3306,7 @@ module Recurly
3263
3306
 
3264
3307
  # Resume subscription
3265
3308
  #
3266
- # {https://developers.recurly.com/api/v2021-02-25#operation/resume_subscription resume_subscription api documenation}
3309
+ # {https://developers.recurly.com/api/v2021-02-25#operation/resume_subscription resume_subscription api documentation}
3267
3310
  #
3268
3311
  # @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+.
3269
3312
  # @param params [Hash] Optional query string parameters:
@@ -3288,7 +3331,7 @@ module Recurly
3288
3331
 
3289
3332
  # Convert trial subscription
3290
3333
  #
3291
- # {https://developers.recurly.com/api/v2021-02-25#operation/convert_trial convert_trial api documenation}
3334
+ # {https://developers.recurly.com/api/v2021-02-25#operation/convert_trial convert_trial api documentation}
3292
3335
  #
3293
3336
  # @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+.
3294
3337
  # @param params [Hash] Optional query string parameters:
@@ -3302,7 +3345,7 @@ module Recurly
3302
3345
 
3303
3346
  # Fetch a preview of a subscription's renewal invoice(s)
3304
3347
  #
3305
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api documenation}
3348
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api documentation}
3306
3349
  #
3307
3350
  # @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+.
3308
3351
  # @param params [Hash] Optional query string parameters:
@@ -3316,7 +3359,7 @@ module Recurly
3316
3359
 
3317
3360
  # Fetch a subscription's pending change
3318
3361
  #
3319
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api documenation}
3362
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api documentation}
3320
3363
  #
3321
3364
  # @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+.
3322
3365
  # @param params [Hash] Optional query string parameters:
@@ -3341,7 +3384,7 @@ module Recurly
3341
3384
 
3342
3385
  # Create a new subscription change
3343
3386
  #
3344
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription_change create_subscription_change api documenation}
3387
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription_change create_subscription_change api documentation}
3345
3388
  #
3346
3389
  # @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+.
3347
3390
  # @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
@@ -3372,7 +3415,7 @@ module Recurly
3372
3415
 
3373
3416
  # Delete the pending subscription change
3374
3417
  #
3375
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_change remove_subscription_change api documenation}
3418
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_change remove_subscription_change api documentation}
3376
3419
  #
3377
3420
  # @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+.
3378
3421
  # @param params [Hash] Optional query string parameters:
@@ -3397,7 +3440,7 @@ module Recurly
3397
3440
 
3398
3441
  # Preview a new subscription change
3399
3442
  #
3400
- # {https://developers.recurly.com/api/v2021-02-25#operation/preview_subscription_change preview_subscription_change api documenation}
3443
+ # {https://developers.recurly.com/api/v2021-02-25#operation/preview_subscription_change preview_subscription_change api documentation}
3401
3444
  #
3402
3445
  # @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+.
3403
3446
  # @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
@@ -3412,7 +3455,7 @@ module Recurly
3412
3455
 
3413
3456
  # List a subscription's invoices
3414
3457
  #
3415
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_invoices list_subscription_invoices api documenation}
3458
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_invoices list_subscription_invoices api documentation}
3416
3459
  #
3417
3460
  # @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+.
3418
3461
  # @param params [Hash] Optional query string parameters:
@@ -3467,7 +3510,7 @@ module Recurly
3467
3510
 
3468
3511
  # List a subscription's line items
3469
3512
  #
3470
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_line_items list_subscription_line_items api documenation}
3513
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_line_items list_subscription_line_items api documentation}
3471
3514
  #
3472
3515
  # @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+.
3473
3516
  # @param params [Hash] Optional query string parameters:
@@ -3519,7 +3562,7 @@ module Recurly
3519
3562
 
3520
3563
  # Show the coupon redemptions for a subscription
3521
3564
  #
3522
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documenation}
3565
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
3523
3566
  #
3524
3567
  # @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+.
3525
3568
  # @param params [Hash] Optional query string parameters:
@@ -3566,7 +3609,7 @@ module Recurly
3566
3609
 
3567
3610
  # List a subscription add-on's usage records
3568
3611
  #
3569
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api documenation}
3612
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api documentation}
3570
3613
  #
3571
3614
  # @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+.
3572
3615
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
@@ -3606,7 +3649,7 @@ module Recurly
3606
3649
 
3607
3650
  # Log a usage record on this subscription add-on
3608
3651
  #
3609
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_usage create_usage api documenation}
3652
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_usage create_usage api documentation}
3610
3653
  #
3611
3654
  # @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+.
3612
3655
  # @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
@@ -3622,7 +3665,7 @@ module Recurly
3622
3665
 
3623
3666
  # Get a usage record
3624
3667
  #
3625
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api documenation}
3668
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api documentation}
3626
3669
  #
3627
3670
  # @param usage_id [String] Usage Record ID.
3628
3671
  # @param params [Hash] Optional query string parameters:
@@ -3636,7 +3679,7 @@ module Recurly
3636
3679
 
3637
3680
  # Update a usage record
3638
3681
  #
3639
- # {https://developers.recurly.com/api/v2021-02-25#operation/update_usage update_usage api documenation}
3682
+ # {https://developers.recurly.com/api/v2021-02-25#operation/update_usage update_usage api documentation}
3640
3683
  #
3641
3684
  # @param usage_id [String] Usage Record ID.
3642
3685
  # @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
@@ -3651,7 +3694,7 @@ module Recurly
3651
3694
 
3652
3695
  # Delete a usage record.
3653
3696
  #
3654
- # {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api documenation}
3697
+ # {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api documentation}
3655
3698
  #
3656
3699
  # @param usage_id [String] Usage Record ID.
3657
3700
  # @param params [Hash] Optional query string parameters:
@@ -3665,7 +3708,7 @@ module Recurly
3665
3708
 
3666
3709
  # List a site's transactions
3667
3710
  #
3668
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api documenation}
3711
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api documentation}
3669
3712
  #
3670
3713
  # @param params [Hash] Optional query string parameters:
3671
3714
  # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
@@ -3712,7 +3755,7 @@ module Recurly
3712
3755
 
3713
3756
  # Fetch a transaction
3714
3757
  #
3715
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_transaction get_transaction api documenation}
3758
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_transaction get_transaction api documentation}
3716
3759
  #
3717
3760
  # @param transaction_id [String] Transaction ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
3718
3761
  # @param params [Hash] Optional query string parameters:
@@ -3735,7 +3778,7 @@ module Recurly
3735
3778
 
3736
3779
  # Fetch a unique coupon code
3737
3780
  #
3738
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_unique_coupon_code get_unique_coupon_code api documenation}
3781
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_unique_coupon_code get_unique_coupon_code api documentation}
3739
3782
  #
3740
3783
  # @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
3741
3784
  # @param params [Hash] Optional query string parameters:
@@ -3749,7 +3792,7 @@ module Recurly
3749
3792
 
3750
3793
  # Deactivate a unique coupon code
3751
3794
  #
3752
- # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documenation}
3795
+ # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documentation}
3753
3796
  #
3754
3797
  # @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
3755
3798
  # @param params [Hash] Optional query string parameters:
@@ -3763,7 +3806,7 @@ module Recurly
3763
3806
 
3764
3807
  # Restore a unique coupon code
3765
3808
  #
3766
- # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documenation}
3809
+ # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documentation}
3767
3810
  #
3768
3811
  # @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
3769
3812
  # @param params [Hash] Optional query string parameters:
@@ -3777,7 +3820,7 @@ module Recurly
3777
3820
 
3778
3821
  # Create a new purchase
3779
3822
  #
3780
- # {https://developers.recurly.com/api/v2021-02-25#operation/create_purchase create_purchase api documenation}
3823
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_purchase create_purchase api documentation}
3781
3824
  #
3782
3825
  # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
3783
3826
  # @param params [Hash] Optional query string parameters:
@@ -3817,7 +3860,7 @@ module Recurly
3817
3860
 
3818
3861
  # Preview a new purchase
3819
3862
  #
3820
- # {https://developers.recurly.com/api/v2021-02-25#operation/preview_purchase preview_purchase api documenation}
3863
+ # {https://developers.recurly.com/api/v2021-02-25#operation/preview_purchase preview_purchase api documentation}
3821
3864
  #
3822
3865
  # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
3823
3866
  # @param params [Hash] Optional query string parameters:
@@ -3855,9 +3898,51 @@ module Recurly
3855
3898
  post(path, body, Requests::PurchaseCreate, **options)
3856
3899
  end
3857
3900
 
3901
+ # Create a pending purchase
3902
+ #
3903
+ # {https://developers.recurly.com/api/v2021-02-25#operation/create_pending_purchase create_pending_purchase api documentation}
3904
+ #
3905
+ # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
3906
+ # @param params [Hash] Optional query string parameters:
3907
+ #
3908
+ # @return [Resources::InvoiceCollection] Returns the pending invoice
3909
+ # @example
3910
+ # begin
3911
+ # purchase = {
3912
+ # currency: 'EUR',
3913
+ # account: {
3914
+ # code: account_code,
3915
+ # email: 'benjamin@example.com',
3916
+ # billing_info: {
3917
+ # first_name: 'Benjamin',
3918
+ # last_name: 'Du Monde',
3919
+ # online_banking_payment_type: 'ideal'
3920
+ # },
3921
+ # },
3922
+ # line_items: [
3923
+ # {
3924
+ # currency: 'EUR',
3925
+ # unit_amount: 1000,
3926
+ # type: 'charge'
3927
+ # }
3928
+ # ]
3929
+ # }
3930
+ # invoice_collection = @client.create_pending_purchase(body: purchase)
3931
+ # puts "Created ChargeInvoice with UUID: #{invoice_collection.charge_invoice.uuid}"
3932
+ # rescue Recurly::Errors::ValidationError => e
3933
+ # # If the request was invalid, you may want to tell your user
3934
+ # # why. You can find the invalid params and reasons in e.recurly_error.params
3935
+ # puts "ValidationError: #{e.recurly_error.params}"
3936
+ # end
3937
+ #
3938
+ def create_pending_purchase(body:, **options)
3939
+ path = "/purchases/pending"
3940
+ post(path, body, Requests::PurchaseCreate, **options)
3941
+ end
3942
+
3858
3943
  # List the dates that have an available export to download.
3859
3944
  #
3860
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documenation}
3945
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documentation}
3861
3946
  #
3862
3947
  # @param params [Hash] Optional query string parameters:
3863
3948
  #
@@ -3881,7 +3966,7 @@ module Recurly
3881
3966
 
3882
3967
  # List of the export files that are available to download.
3883
3968
  #
3884
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_files get_export_files api documenation}
3969
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_files get_export_files api documentation}
3885
3970
  #
3886
3971
  # @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
3887
3972
  # @param params [Hash] Optional query string parameters:
@@ -3906,7 +3991,7 @@ module Recurly
3906
3991
 
3907
3992
  # Show the dunning campaigns for a site
3908
3993
  #
3909
- # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documenation}
3994
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
3910
3995
  #
3911
3996
  # @param params [Hash] Optional query string parameters:
3912
3997
  # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -3923,7 +4008,7 @@ module Recurly
3923
4008
 
3924
4009
  # Show the settings for a dunning campaign
3925
4010
  #
3926
- # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documenation}
4011
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation}
3927
4012
  #
3928
4013
  # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
3929
4014
  # @param params [Hash] Optional query string parameters:
@@ -3937,7 +4022,7 @@ module Recurly
3937
4022
 
3938
4023
  # Assign a dunning campaign to multiple plans
3939
4024
  #
3940
- # {https://developers.recurly.com/api/v2021-02-25#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documenation}
4025
+ # {https://developers.recurly.com/api/v2021-02-25#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
3941
4026
  #
3942
4027
  # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
3943
4028
  # @param params [Hash] Optional query string parameters:
@@ -3948,5 +4033,36 @@ module Recurly
3948
4033
  path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
3949
4034
  put(path, body, Requests::DunningCampaignsBulkUpdate, **options)
3950
4035
  end
4036
+
4037
+ # Show the invoice templates for a site
4038
+ #
4039
+ # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_templates list_invoice_templates api documentation}
4040
+ #
4041
+ # @param params [Hash] Optional query string parameters:
4042
+ # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
4043
+ # order. In descending order updated records will move behind the cursor and could
4044
+ # prevent some records from being returned.
4045
+ #
4046
+ #
4047
+ # @return [Pager<Resources::InvoiceTemplate>] A list of the the invoice templates on a site.
4048
+ #
4049
+ def list_invoice_templates(**options)
4050
+ path = "/invoice_templates"
4051
+ pager(path, **options)
4052
+ end
4053
+
4054
+ # Show the settings for an invoice template
4055
+ #
4056
+ # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_template get_invoice_template api documentation}
4057
+ #
4058
+ # @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
4059
+ # @param params [Hash] Optional query string parameters:
4060
+ #
4061
+ # @return [Resources::InvoiceTemplate] Settings for an invoice template.
4062
+ #
4063
+ def get_invoice_template(invoice_template_id:, **options)
4064
+ path = interpolate_path("/invoice_templates/{invoice_template_id}", invoice_template_id: invoice_template_id)
4065
+ get(path, **options)
4066
+ end
3951
4067
  end
3952
4068
  end