recurly 3.18.1 → 3.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/.changelog_config.yaml +11 -0
- data/.github/workflows/docs.yml +1 -1
- data/.travis.yml +2 -0
- data/CHANGELOG.md +231 -163
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +212 -134
- data/lib/recurly/client.rb +5 -3
- data/lib/recurly/errors/api_errors.rb +2 -0
- data/lib/recurly/pager.rb +1 -1
- data/lib/recurly/requests/account_create.rb +4 -0
- data/lib/recurly/requests/account_purchase.rb +4 -0
- data/lib/recurly/requests/account_update.rb +4 -0
- data/lib/recurly/requests/add_on_create.rb +3 -3
- data/lib/recurly/requests/add_on_pricing.rb +4 -0
- data/lib/recurly/requests/add_on_update.rb +1 -1
- data/lib/recurly/requests/address.rb +1 -1
- data/lib/recurly/requests/billing_info_create.rb +6 -2
- data/lib/recurly/requests/billing_info_verify.rb +14 -0
- data/lib/recurly/requests/dunning_campaigns_bulk_update.rb +18 -0
- data/lib/recurly/requests/invoice_address.rb +1 -1
- data/lib/recurly/requests/invoice_collect.rb +1 -1
- data/lib/recurly/requests/line_item_create.rb +6 -2
- data/lib/recurly/requests/plan_create.rb +4 -0
- data/lib/recurly/requests/plan_pricing.rb +4 -0
- data/lib/recurly/requests/plan_update.rb +4 -0
- data/lib/recurly/requests/pricing.rb +4 -0
- data/lib/recurly/requests/purchase_create.rb +1 -1
- data/lib/recurly/requests/shipping_address_create.rb +1 -1
- data/lib/recurly/requests/shipping_address_update.rb +1 -1
- data/lib/recurly/requests/subscription_change_billing_info_create.rb +14 -0
- data/lib/recurly/requests/subscription_change_create.rb +8 -0
- data/lib/recurly/requests/subscription_create.rb +6 -2
- data/lib/recurly/requests/subscription_pause.rb +1 -1
- data/lib/recurly/requests/subscription_purchase.rb +6 -2
- data/lib/recurly/requests/subscription_update.rb +5 -1
- data/lib/recurly/resources/account.rb +4 -0
- data/lib/recurly/resources/account_mini.rb +4 -0
- data/lib/recurly/resources/add_on_pricing.rb +4 -0
- data/lib/recurly/resources/address.rb +1 -1
- data/lib/recurly/resources/billing_info.rb +5 -1
- data/lib/recurly/resources/billing_info_updated_by.rb +1 -1
- data/lib/recurly/resources/dunning_campaign.rb +50 -0
- data/lib/recurly/resources/dunning_campaigns_bulk_update_response.rb +18 -0
- data/lib/recurly/resources/dunning_cycle.rb +58 -0
- data/lib/recurly/resources/dunning_interval.rb +18 -0
- data/lib/recurly/resources/invoice.rb +6 -2
- data/lib/recurly/resources/invoice_address.rb +1 -1
- data/lib/recurly/resources/line_item.rb +7 -3
- data/lib/recurly/resources/payment_method.rb +4 -0
- data/lib/recurly/resources/plan.rb +4 -0
- data/lib/recurly/resources/plan_pricing.rb +4 -0
- data/lib/recurly/resources/pricing.rb +4 -0
- data/lib/recurly/resources/shipping_address.rb +1 -1
- data/lib/recurly/resources/subscription.rb +4 -0
- data/lib/recurly/resources/subscription_change.rb +8 -0
- data/lib/recurly/resources/subscription_change_billing_info.rb +14 -0
- data/lib/recurly/resources/subscription_change_preview.rb +8 -0
- data/lib/recurly/resources/tax_detail.rb +26 -0
- data/lib/recurly/resources/tax_info.rb +4 -0
- data/lib/recurly/resources/transaction.rb +5 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +796 -122
- data/scripts/build +2 -2
- data/scripts/format +2 -2
- data/scripts/prepare-release +43 -29
- data/scripts/release +5 -20
- metadata +16 -9
- data/.github_changelog_generator +0 -8
- data/scripts/bump +0 -11
- data/scripts/changelog +0 -14
@@ -10,7 +10,7 @@ module Recurly
|
|
10
10
|
|
11
11
|
# List sites
|
12
12
|
#
|
13
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_sites list_sites api
|
13
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_sites list_sites api documentation}
|
14
14
|
#
|
15
15
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
16
16
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -46,7 +46,7 @@ module Recurly
|
|
46
46
|
|
47
47
|
# Fetch a site
|
48
48
|
#
|
49
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_site get_site api
|
49
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_site get_site api documentation}
|
50
50
|
#
|
51
51
|
# @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+.
|
52
52
|
#
|
@@ -68,7 +68,7 @@ module Recurly
|
|
68
68
|
|
69
69
|
# List a site's accounts
|
70
70
|
#
|
71
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_accounts list_accounts api
|
71
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_accounts list_accounts api documentation}
|
72
72
|
#
|
73
73
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
74
74
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -115,7 +115,7 @@ module Recurly
|
|
115
115
|
|
116
116
|
# Create an account
|
117
117
|
#
|
118
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_account create_account api
|
118
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_account create_account api documentation}
|
119
119
|
#
|
120
120
|
# @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
|
121
121
|
# @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+.
|
@@ -164,7 +164,7 @@ module Recurly
|
|
164
164
|
|
165
165
|
# Fetch an account
|
166
166
|
#
|
167
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account get_account api
|
167
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account get_account api documentation}
|
168
168
|
#
|
169
169
|
# @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+.
|
170
170
|
# @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+.
|
@@ -187,7 +187,7 @@ module Recurly
|
|
187
187
|
|
188
188
|
# Modify an account
|
189
189
|
#
|
190
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_account update_account api
|
190
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_account update_account api documentation}
|
191
191
|
#
|
192
192
|
# @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+.
|
193
193
|
# @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
|
@@ -218,7 +218,7 @@ module Recurly
|
|
218
218
|
|
219
219
|
# Deactivate an account
|
220
220
|
#
|
221
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_account deactivate_account api
|
221
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_account deactivate_account api documentation}
|
222
222
|
#
|
223
223
|
# @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+.
|
224
224
|
# @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+.
|
@@ -241,7 +241,7 @@ module Recurly
|
|
241
241
|
|
242
242
|
# Fetch an account's acquisition data
|
243
243
|
#
|
244
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account_acquisition get_account_acquisition api
|
244
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account_acquisition get_account_acquisition api documentation}
|
245
245
|
#
|
246
246
|
# @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+.
|
247
247
|
# @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+.
|
@@ -264,7 +264,7 @@ module Recurly
|
|
264
264
|
|
265
265
|
# Update an account's acquisition data
|
266
266
|
#
|
267
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_account_acquisition update_account_acquisition api
|
267
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_account_acquisition update_account_acquisition api documentation}
|
268
268
|
#
|
269
269
|
# @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+.
|
270
270
|
# @param body [Requests::AccountAcquisitionUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdatable}
|
@@ -300,7 +300,7 @@ module Recurly
|
|
300
300
|
|
301
301
|
# Remove an account's acquisition data
|
302
302
|
#
|
303
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_account_acquisition remove_account_acquisition api
|
303
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_account_acquisition remove_account_acquisition api documentation}
|
304
304
|
#
|
305
305
|
# @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+.
|
306
306
|
# @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+.
|
@@ -323,7 +323,7 @@ module Recurly
|
|
323
323
|
|
324
324
|
# Reactivate an inactive account
|
325
325
|
#
|
326
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_account reactivate_account api
|
326
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_account reactivate_account api documentation}
|
327
327
|
#
|
328
328
|
# @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+.
|
329
329
|
# @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+.
|
@@ -346,7 +346,7 @@ module Recurly
|
|
346
346
|
|
347
347
|
# Fetch an account's balance and past due status
|
348
348
|
#
|
349
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account_balance get_account_balance api
|
349
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account_balance get_account_balance api documentation}
|
350
350
|
#
|
351
351
|
# @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+.
|
352
352
|
# @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+.
|
@@ -369,7 +369,7 @@ module Recurly
|
|
369
369
|
|
370
370
|
# Fetch an account's billing information
|
371
371
|
#
|
372
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_billing_info get_billing_info api
|
372
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_billing_info get_billing_info api documentation}
|
373
373
|
#
|
374
374
|
# @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+.
|
375
375
|
# @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+.
|
@@ -392,7 +392,7 @@ module Recurly
|
|
392
392
|
|
393
393
|
# Set an account's billing information
|
394
394
|
#
|
395
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_billing_info update_billing_info api
|
395
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_billing_info update_billing_info api documentation}
|
396
396
|
#
|
397
397
|
# @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+.
|
398
398
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
@@ -423,7 +423,7 @@ module Recurly
|
|
423
423
|
|
424
424
|
# Remove an account's billing information
|
425
425
|
#
|
426
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_billing_info remove_billing_info api
|
426
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_billing_info remove_billing_info api documentation}
|
427
427
|
#
|
428
428
|
# @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+.
|
429
429
|
# @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+.
|
@@ -444,9 +444,33 @@ module Recurly
|
|
444
444
|
delete(path, **options)
|
445
445
|
end
|
446
446
|
|
447
|
+
# Verify an account's credit card billing information
|
448
|
+
#
|
449
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_info verify_billing_info api documentation}
|
450
|
+
#
|
451
|
+
# @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+.
|
452
|
+
# @param body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
|
453
|
+
# @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+.
|
454
|
+
#
|
455
|
+
# @return [Resources::Transaction] Transaction information from verify.
|
456
|
+
# @example
|
457
|
+
# begin
|
458
|
+
# transaction = @client.verify_billing_info(account_id: account_id)
|
459
|
+
# puts "Got Transaction #{transaction}"
|
460
|
+
# rescue Recurly::Errors::NotFoundError
|
461
|
+
# # If the resource was not found, you may want to alert the user or
|
462
|
+
# # just return nil
|
463
|
+
# puts "Resource Not Found"
|
464
|
+
# end
|
465
|
+
#
|
466
|
+
def verify_billing_info(account_id:, **options)
|
467
|
+
path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
|
468
|
+
post(path, options[:body], Requests::BillingInfoVerify, **options)
|
469
|
+
end
|
470
|
+
|
447
471
|
# Get the list of billing information associated with an account
|
448
472
|
#
|
449
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api
|
473
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api documentation}
|
450
474
|
#
|
451
475
|
# @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+.
|
452
476
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -480,9 +504,9 @@ module Recurly
|
|
480
504
|
pager(path, **options)
|
481
505
|
end
|
482
506
|
|
483
|
-
#
|
507
|
+
# Add new billing information on an account
|
484
508
|
#
|
485
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_billing_info create_billing_info api
|
509
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_billing_info create_billing_info api documentation}
|
486
510
|
#
|
487
511
|
# @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+.
|
488
512
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
@@ -497,10 +521,10 @@ module Recurly
|
|
497
521
|
|
498
522
|
# Fetch a billing info
|
499
523
|
#
|
500
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_a_billing_info get_a_billing_info api
|
524
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_a_billing_info get_a_billing_info api documentation}
|
501
525
|
#
|
502
526
|
# @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+.
|
503
|
-
# @param billing_info_id [String] Billing Info ID.
|
527
|
+
# @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
|
504
528
|
# @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+.
|
505
529
|
#
|
506
530
|
# @return [Resources::BillingInfo] A billing info.
|
@@ -512,10 +536,10 @@ module Recurly
|
|
512
536
|
|
513
537
|
# Update an account's billing information
|
514
538
|
#
|
515
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_a_billing_info update_a_billing_info api
|
539
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_a_billing_info update_a_billing_info api documentation}
|
516
540
|
#
|
517
541
|
# @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+.
|
518
|
-
# @param billing_info_id [String] Billing Info ID.
|
542
|
+
# @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
|
519
543
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
520
544
|
# @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+.
|
521
545
|
#
|
@@ -528,10 +552,10 @@ module Recurly
|
|
528
552
|
|
529
553
|
# Remove an account's billing information
|
530
554
|
#
|
531
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_a_billing_info remove_a_billing_info api
|
555
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_a_billing_info remove_a_billing_info api documentation}
|
532
556
|
#
|
533
557
|
# @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+.
|
534
|
-
# @param billing_info_id [String] Billing Info ID.
|
558
|
+
# @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
|
535
559
|
# @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+.
|
536
560
|
#
|
537
561
|
# @return [Resources::Empty] Billing information deleted
|
@@ -543,7 +567,7 @@ module Recurly
|
|
543
567
|
|
544
568
|
# Show the coupon redemptions for an account
|
545
569
|
#
|
546
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api
|
570
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
|
547
571
|
#
|
548
572
|
# @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+.
|
549
573
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -588,7 +612,7 @@ module Recurly
|
|
588
612
|
|
589
613
|
# Show the coupon redemption that is active on an account
|
590
614
|
#
|
591
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api
|
615
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documentation}
|
592
616
|
#
|
593
617
|
# @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+.
|
594
618
|
# @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+.
|
@@ -611,7 +635,7 @@ module Recurly
|
|
611
635
|
|
612
636
|
# Generate an active coupon redemption on an account or subscription
|
613
637
|
#
|
614
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon_redemption create_coupon_redemption api
|
638
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon_redemption create_coupon_redemption api documentation}
|
615
639
|
#
|
616
640
|
# @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+.
|
617
641
|
# @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
|
@@ -642,7 +666,7 @@ module Recurly
|
|
642
666
|
|
643
667
|
# Delete the active coupon redemption from an account
|
644
668
|
#
|
645
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_coupon_redemption remove_coupon_redemption api
|
669
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_coupon_redemption remove_coupon_redemption api documentation}
|
646
670
|
#
|
647
671
|
# @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+.
|
648
672
|
# @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+.
|
@@ -665,7 +689,7 @@ module Recurly
|
|
665
689
|
|
666
690
|
# List an account's credit payments
|
667
691
|
#
|
668
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_credit_payments list_account_credit_payments api
|
692
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_credit_payments list_account_credit_payments api documentation}
|
669
693
|
#
|
670
694
|
# @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+.
|
671
695
|
# @param limit [Integer] Limit number of records 1-200.
|
@@ -699,7 +723,7 @@ module Recurly
|
|
699
723
|
|
700
724
|
# List an account's invoices
|
701
725
|
#
|
702
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_invoices list_account_invoices api
|
726
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_invoices list_account_invoices api documentation}
|
703
727
|
#
|
704
728
|
# @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
729
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -751,7 +775,7 @@ module Recurly
|
|
751
775
|
|
752
776
|
# Create an invoice for pending line items
|
753
777
|
#
|
754
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_invoice create_invoice api
|
778
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_invoice create_invoice api documentation}
|
755
779
|
#
|
756
780
|
# @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+.
|
757
781
|
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
|
@@ -782,7 +806,7 @@ module Recurly
|
|
782
806
|
|
783
807
|
# Preview new invoice for pending line items
|
784
808
|
#
|
785
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/preview_invoice preview_invoice api
|
809
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/preview_invoice preview_invoice api documentation}
|
786
810
|
#
|
787
811
|
# @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+.
|
788
812
|
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
|
@@ -813,7 +837,7 @@ module Recurly
|
|
813
837
|
|
814
838
|
# List an account's line items
|
815
839
|
#
|
816
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_line_items list_account_line_items api
|
840
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_line_items list_account_line_items api documentation}
|
817
841
|
#
|
818
842
|
# @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+.
|
819
843
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -862,7 +886,7 @@ module Recurly
|
|
862
886
|
|
863
887
|
# Create a new line item for the account
|
864
888
|
#
|
865
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_line_item create_line_item api
|
889
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_line_item create_line_item api documentation}
|
866
890
|
#
|
867
891
|
# @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+.
|
868
892
|
# @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
|
@@ -894,7 +918,7 @@ module Recurly
|
|
894
918
|
|
895
919
|
# Fetch a list of an account's notes
|
896
920
|
#
|
897
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api
|
921
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api documentation}
|
898
922
|
#
|
899
923
|
# @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+.
|
900
924
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -925,7 +949,7 @@ module Recurly
|
|
925
949
|
|
926
950
|
# Fetch an account note
|
927
951
|
#
|
928
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account_note get_account_note api
|
952
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_account_note get_account_note api documentation}
|
929
953
|
#
|
930
954
|
# @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+.
|
931
955
|
# @param account_note_id [String] Account Note ID.
|
@@ -952,7 +976,7 @@ module Recurly
|
|
952
976
|
|
953
977
|
# Fetch a list of an account's shipping addresses
|
954
978
|
#
|
955
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_addresses list_shipping_addresses api
|
979
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_addresses list_shipping_addresses api documentation}
|
956
980
|
#
|
957
981
|
# @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+.
|
958
982
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -998,7 +1022,7 @@ module Recurly
|
|
998
1022
|
|
999
1023
|
# Create a new shipping address for the account
|
1000
1024
|
#
|
1001
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_address create_shipping_address api
|
1025
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_address create_shipping_address api documentation}
|
1002
1026
|
#
|
1003
1027
|
# @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
1028
|
# @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
|
@@ -1032,7 +1056,7 @@ module Recurly
|
|
1032
1056
|
|
1033
1057
|
# Fetch an account's shipping address
|
1034
1058
|
#
|
1035
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_address get_shipping_address api
|
1059
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_address get_shipping_address api documentation}
|
1036
1060
|
#
|
1037
1061
|
# @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+.
|
1038
1062
|
# @param shipping_address_id [String] Shipping Address ID.
|
@@ -1059,7 +1083,7 @@ module Recurly
|
|
1059
1083
|
|
1060
1084
|
# Update an account's shipping address
|
1061
1085
|
#
|
1062
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_address update_shipping_address api
|
1086
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_address update_shipping_address api documentation}
|
1063
1087
|
#
|
1064
1088
|
# @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+.
|
1065
1089
|
# @param shipping_address_id [String] Shipping Address ID.
|
@@ -1093,7 +1117,7 @@ module Recurly
|
|
1093
1117
|
|
1094
1118
|
# Remove an account's shipping address
|
1095
1119
|
#
|
1096
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_shipping_address remove_shipping_address api
|
1120
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_shipping_address remove_shipping_address api documentation}
|
1097
1121
|
#
|
1098
1122
|
# @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+.
|
1099
1123
|
# @param shipping_address_id [String] Shipping Address ID.
|
@@ -1120,7 +1144,7 @@ module Recurly
|
|
1120
1144
|
|
1121
1145
|
# List an account's subscriptions
|
1122
1146
|
#
|
1123
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_subscriptions list_account_subscriptions api
|
1147
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_subscriptions list_account_subscriptions api documentation}
|
1124
1148
|
#
|
1125
1149
|
# @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+.
|
1126
1150
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1172,7 +1196,7 @@ module Recurly
|
|
1172
1196
|
|
1173
1197
|
# List an account's transactions
|
1174
1198
|
#
|
1175
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_transactions list_account_transactions api
|
1199
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_transactions list_account_transactions api documentation}
|
1176
1200
|
#
|
1177
1201
|
# @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+.
|
1178
1202
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1220,7 +1244,7 @@ module Recurly
|
|
1220
1244
|
|
1221
1245
|
# List an account's child accounts
|
1222
1246
|
#
|
1223
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_child_accounts list_child_accounts api
|
1247
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_child_accounts list_child_accounts api documentation}
|
1224
1248
|
#
|
1225
1249
|
# @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+.
|
1226
1250
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1271,7 +1295,7 @@ module Recurly
|
|
1271
1295
|
|
1272
1296
|
# List a site's account acquisition data
|
1273
1297
|
#
|
1274
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_acquisition list_account_acquisition api
|
1298
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_account_acquisition list_account_acquisition api documentation}
|
1275
1299
|
#
|
1276
1300
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1277
1301
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1313,7 +1337,7 @@ module Recurly
|
|
1313
1337
|
|
1314
1338
|
# List a site's coupons
|
1315
1339
|
#
|
1316
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_coupons list_coupons api
|
1340
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_coupons list_coupons api documentation}
|
1317
1341
|
#
|
1318
1342
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1319
1343
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1355,7 +1379,7 @@ module Recurly
|
|
1355
1379
|
|
1356
1380
|
# Create a new coupon
|
1357
1381
|
#
|
1358
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon create_coupon api
|
1382
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon create_coupon api documentation}
|
1359
1383
|
#
|
1360
1384
|
# @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
|
1361
1385
|
# @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+.
|
@@ -1391,7 +1415,7 @@ module Recurly
|
|
1391
1415
|
|
1392
1416
|
# Fetch a coupon
|
1393
1417
|
#
|
1394
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_coupon get_coupon api
|
1418
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_coupon get_coupon api documentation}
|
1395
1419
|
#
|
1396
1420
|
# @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+.
|
1397
1421
|
# @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+.
|
@@ -1414,7 +1438,7 @@ module Recurly
|
|
1414
1438
|
|
1415
1439
|
# Update an active coupon
|
1416
1440
|
#
|
1417
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_coupon update_coupon api
|
1441
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_coupon update_coupon api documentation}
|
1418
1442
|
#
|
1419
1443
|
# @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+.
|
1420
1444
|
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
|
@@ -1441,7 +1465,7 @@ module Recurly
|
|
1441
1465
|
|
1442
1466
|
# Expire a coupon
|
1443
1467
|
#
|
1444
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_coupon deactivate_coupon api
|
1468
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_coupon deactivate_coupon api documentation}
|
1445
1469
|
#
|
1446
1470
|
# @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+.
|
1447
1471
|
# @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+.
|
@@ -1464,7 +1488,7 @@ module Recurly
|
|
1464
1488
|
|
1465
1489
|
# Restore an inactive coupon
|
1466
1490
|
#
|
1467
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/restore_coupon restore_coupon api
|
1491
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/restore_coupon restore_coupon api documentation}
|
1468
1492
|
#
|
1469
1493
|
# @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+.
|
1470
1494
|
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
|
@@ -1490,7 +1514,7 @@ module Recurly
|
|
1490
1514
|
|
1491
1515
|
# List unique coupon codes associated with a bulk coupon
|
1492
1516
|
#
|
1493
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_unique_coupon_codes list_unique_coupon_codes api
|
1517
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_unique_coupon_codes list_unique_coupon_codes api documentation}
|
1494
1518
|
#
|
1495
1519
|
# @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+.
|
1496
1520
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1528,7 +1552,7 @@ module Recurly
|
|
1528
1552
|
|
1529
1553
|
# List a site's credit payments
|
1530
1554
|
#
|
1531
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_credit_payments list_credit_payments api
|
1555
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_credit_payments list_credit_payments api documentation}
|
1532
1556
|
#
|
1533
1557
|
# @param limit [Integer] Limit number of records 1-200.
|
1534
1558
|
# @param order [String] Sort order.
|
@@ -1558,7 +1582,7 @@ module Recurly
|
|
1558
1582
|
|
1559
1583
|
# Fetch a credit payment
|
1560
1584
|
#
|
1561
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_credit_payment get_credit_payment api
|
1585
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_credit_payment get_credit_payment api documentation}
|
1562
1586
|
#
|
1563
1587
|
# @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+.
|
1564
1588
|
# @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+.
|
@@ -1572,7 +1596,7 @@ module Recurly
|
|
1572
1596
|
|
1573
1597
|
# List a site's custom field definitions
|
1574
1598
|
#
|
1575
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_custom_field_definitions list_custom_field_definitions api
|
1599
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_custom_field_definitions list_custom_field_definitions api documentation}
|
1576
1600
|
#
|
1577
1601
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1578
1602
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1615,7 +1639,7 @@ module Recurly
|
|
1615
1639
|
|
1616
1640
|
# Fetch an custom field definition
|
1617
1641
|
#
|
1618
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_custom_field_definition get_custom_field_definition api
|
1642
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_custom_field_definition get_custom_field_definition api documentation}
|
1619
1643
|
#
|
1620
1644
|
# @param custom_field_definition_id [String] Custom Field Definition ID
|
1621
1645
|
# @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+.
|
@@ -1640,7 +1664,7 @@ module Recurly
|
|
1640
1664
|
|
1641
1665
|
# List a site's items
|
1642
1666
|
#
|
1643
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_items list_items api
|
1667
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_items list_items api documentation}
|
1644
1668
|
#
|
1645
1669
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1646
1670
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1683,7 +1707,7 @@ module Recurly
|
|
1683
1707
|
|
1684
1708
|
# Create a new item
|
1685
1709
|
#
|
1686
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_item create_item api
|
1710
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_item create_item api documentation}
|
1687
1711
|
#
|
1688
1712
|
# @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
|
1689
1713
|
# @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+.
|
@@ -1718,7 +1742,7 @@ module Recurly
|
|
1718
1742
|
|
1719
1743
|
# Fetch an item
|
1720
1744
|
#
|
1721
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_item get_item api
|
1745
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_item get_item api documentation}
|
1722
1746
|
#
|
1723
1747
|
# @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+.
|
1724
1748
|
# @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+.
|
@@ -1741,7 +1765,7 @@ module Recurly
|
|
1741
1765
|
|
1742
1766
|
# Update an active item
|
1743
1767
|
#
|
1744
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_item update_item api
|
1768
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_item update_item api documentation}
|
1745
1769
|
#
|
1746
1770
|
# @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+.
|
1747
1771
|
# @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
|
@@ -1772,7 +1796,7 @@ module Recurly
|
|
1772
1796
|
|
1773
1797
|
# Deactivate an item
|
1774
1798
|
#
|
1775
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_item deactivate_item api
|
1799
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_item deactivate_item api documentation}
|
1776
1800
|
#
|
1777
1801
|
# @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+.
|
1778
1802
|
# @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+.
|
@@ -1795,7 +1819,7 @@ module Recurly
|
|
1795
1819
|
|
1796
1820
|
# Reactivate an inactive item
|
1797
1821
|
#
|
1798
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_item reactivate_item api
|
1822
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_item reactivate_item api documentation}
|
1799
1823
|
#
|
1800
1824
|
# @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
1825
|
# @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+.
|
@@ -1818,7 +1842,7 @@ module Recurly
|
|
1818
1842
|
|
1819
1843
|
# List a site's measured units
|
1820
1844
|
#
|
1821
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_measured_unit list_measured_unit api
|
1845
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_measured_unit list_measured_unit api documentation}
|
1822
1846
|
#
|
1823
1847
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1824
1848
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1856,7 +1880,7 @@ module Recurly
|
|
1856
1880
|
|
1857
1881
|
# Create a new measured unit
|
1858
1882
|
#
|
1859
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_measured_unit create_measured_unit api
|
1883
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_measured_unit create_measured_unit api documentation}
|
1860
1884
|
#
|
1861
1885
|
# @param body [Requests::MeasuredUnitCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitCreate}
|
1862
1886
|
# @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+.
|
@@ -1870,7 +1894,7 @@ module Recurly
|
|
1870
1894
|
|
1871
1895
|
# Fetch a measured unit
|
1872
1896
|
#
|
1873
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_measured_unit get_measured_unit api
|
1897
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_measured_unit get_measured_unit api documentation}
|
1874
1898
|
#
|
1875
1899
|
# @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+.
|
1876
1900
|
# @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+.
|
@@ -1884,7 +1908,7 @@ module Recurly
|
|
1884
1908
|
|
1885
1909
|
# Update a measured unit
|
1886
1910
|
#
|
1887
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_measured_unit update_measured_unit api
|
1911
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_measured_unit update_measured_unit api documentation}
|
1888
1912
|
#
|
1889
1913
|
# @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+.
|
1890
1914
|
# @param body [Requests::MeasuredUnitUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitUpdate}
|
@@ -1899,7 +1923,7 @@ module Recurly
|
|
1899
1923
|
|
1900
1924
|
# Remove a measured unit
|
1901
1925
|
#
|
1902
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_measured_unit remove_measured_unit api
|
1926
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_measured_unit remove_measured_unit api documentation}
|
1903
1927
|
#
|
1904
1928
|
# @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+.
|
1905
1929
|
# @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+.
|
@@ -1913,7 +1937,7 @@ module Recurly
|
|
1913
1937
|
|
1914
1938
|
# List a site's invoices
|
1915
1939
|
#
|
1916
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_invoices list_invoices api
|
1940
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_invoices list_invoices api documentation}
|
1917
1941
|
#
|
1918
1942
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1919
1943
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1961,7 +1985,7 @@ module Recurly
|
|
1961
1985
|
|
1962
1986
|
# Fetch an invoice
|
1963
1987
|
#
|
1964
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api
|
1988
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api documentation}
|
1965
1989
|
#
|
1966
1990
|
# @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+.
|
1967
1991
|
# @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+.
|
@@ -1984,7 +2008,7 @@ module Recurly
|
|
1984
2008
|
|
1985
2009
|
# Update an invoice
|
1986
2010
|
#
|
1987
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api
|
2011
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api documentation}
|
1988
2012
|
#
|
1989
2013
|
# @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+.
|
1990
2014
|
# @param body [Requests::InvoiceUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdatable}
|
@@ -2012,7 +2036,7 @@ module Recurly
|
|
2012
2036
|
|
2013
2037
|
# Fetch an invoice as a PDF
|
2014
2038
|
#
|
2015
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api
|
2039
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api documentation}
|
2016
2040
|
#
|
2017
2041
|
# @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+.
|
2018
2042
|
# @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+.
|
@@ -2038,7 +2062,7 @@ module Recurly
|
|
2038
2062
|
|
2039
2063
|
# Collect a pending or past due, automatic invoice
|
2040
2064
|
#
|
2041
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api
|
2065
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documentation}
|
2042
2066
|
#
|
2043
2067
|
# @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+.
|
2044
2068
|
# @param body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
|
@@ -2062,7 +2086,7 @@ module Recurly
|
|
2062
2086
|
|
2063
2087
|
# Mark an open invoice as failed
|
2064
2088
|
#
|
2065
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api
|
2089
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api documentation}
|
2066
2090
|
#
|
2067
2091
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2068
2092
|
# @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
@@ -2085,7 +2109,7 @@ module Recurly
|
|
2085
2109
|
|
2086
2110
|
# Mark an open invoice as successful
|
2087
2111
|
#
|
2088
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api
|
2112
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api documentation}
|
2089
2113
|
#
|
2090
2114
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2091
2115
|
# @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+.
|
@@ -2108,7 +2132,7 @@ module Recurly
|
|
2108
2132
|
|
2109
2133
|
# Reopen a closed, manual invoice
|
2110
2134
|
#
|
2111
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api
|
2135
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api documentation}
|
2112
2136
|
#
|
2113
2137
|
# @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+.
|
2114
2138
|
# @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+.
|
@@ -2131,7 +2155,7 @@ module Recurly
|
|
2131
2155
|
|
2132
2156
|
# Void a credit invoice.
|
2133
2157
|
#
|
2134
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api
|
2158
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api documentation}
|
2135
2159
|
#
|
2136
2160
|
# @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+.
|
2137
2161
|
# @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+.
|
@@ -2154,7 +2178,7 @@ module Recurly
|
|
2154
2178
|
|
2155
2179
|
# Record an external payment for a manual invoices.
|
2156
2180
|
#
|
2157
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/record_external_transaction record_external_transaction api
|
2181
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/record_external_transaction record_external_transaction api documentation}
|
2158
2182
|
#
|
2159
2183
|
# @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+.
|
2160
2184
|
# @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
|
@@ -2169,7 +2193,7 @@ module Recurly
|
|
2169
2193
|
|
2170
2194
|
# List an invoice's line items
|
2171
2195
|
#
|
2172
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api
|
2196
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api documentation}
|
2173
2197
|
#
|
2174
2198
|
# @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+.
|
2175
2199
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2218,7 +2242,7 @@ module Recurly
|
|
2218
2242
|
|
2219
2243
|
# Show the coupon redemptions applied to an invoice
|
2220
2244
|
#
|
2221
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api
|
2245
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
|
2222
2246
|
#
|
2223
2247
|
# @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+.
|
2224
2248
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2262,7 +2286,7 @@ module Recurly
|
|
2262
2286
|
|
2263
2287
|
# List an invoice's related credit or charge invoices
|
2264
2288
|
#
|
2265
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api
|
2289
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api documentation}
|
2266
2290
|
#
|
2267
2291
|
# @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+.
|
2268
2292
|
# @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+.
|
@@ -2284,7 +2308,7 @@ module Recurly
|
|
2284
2308
|
|
2285
2309
|
# Refund an invoice
|
2286
2310
|
#
|
2287
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api
|
2311
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api documentation}
|
2288
2312
|
#
|
2289
2313
|
# @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+.
|
2290
2314
|
# @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
|
@@ -2315,7 +2339,7 @@ module Recurly
|
|
2315
2339
|
|
2316
2340
|
# List a site's line items
|
2317
2341
|
#
|
2318
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_line_items list_line_items api
|
2342
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_line_items list_line_items api documentation}
|
2319
2343
|
#
|
2320
2344
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
2321
2345
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -2362,7 +2386,7 @@ module Recurly
|
|
2362
2386
|
|
2363
2387
|
# Fetch a line item
|
2364
2388
|
#
|
2365
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_line_item get_line_item api
|
2389
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_line_item get_line_item api documentation}
|
2366
2390
|
#
|
2367
2391
|
# @param line_item_id [String] Line Item ID.
|
2368
2392
|
# @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+.
|
@@ -2385,7 +2409,7 @@ module Recurly
|
|
2385
2409
|
|
2386
2410
|
# Delete an uninvoiced line item
|
2387
2411
|
#
|
2388
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_line_item remove_line_item api
|
2412
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_line_item remove_line_item api documentation}
|
2389
2413
|
#
|
2390
2414
|
# @param line_item_id [String] Line Item ID.
|
2391
2415
|
# @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+.
|
@@ -2410,7 +2434,7 @@ module Recurly
|
|
2410
2434
|
|
2411
2435
|
# List a site's plans
|
2412
2436
|
#
|
2413
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_plans list_plans api
|
2437
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_plans list_plans api documentation}
|
2414
2438
|
#
|
2415
2439
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
2416
2440
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -2453,7 +2477,7 @@ module Recurly
|
|
2453
2477
|
|
2454
2478
|
# Create a plan
|
2455
2479
|
#
|
2456
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_plan create_plan api
|
2480
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_plan create_plan api documentation}
|
2457
2481
|
#
|
2458
2482
|
# @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
|
2459
2483
|
# @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+.
|
@@ -2493,7 +2517,7 @@ module Recurly
|
|
2493
2517
|
|
2494
2518
|
# Fetch a plan
|
2495
2519
|
#
|
2496
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_plan get_plan api
|
2520
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_plan get_plan api documentation}
|
2497
2521
|
#
|
2498
2522
|
# @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+.
|
2499
2523
|
# @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+.
|
@@ -2516,7 +2540,7 @@ module Recurly
|
|
2516
2540
|
|
2517
2541
|
# Update a plan
|
2518
2542
|
#
|
2519
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_plan update_plan api
|
2543
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_plan update_plan api documentation}
|
2520
2544
|
#
|
2521
2545
|
# @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+.
|
2522
2546
|
# @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
|
@@ -2543,7 +2567,7 @@ module Recurly
|
|
2543
2567
|
|
2544
2568
|
# Remove a plan
|
2545
2569
|
#
|
2546
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan remove_plan api
|
2570
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan remove_plan api documentation}
|
2547
2571
|
#
|
2548
2572
|
# @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+.
|
2549
2573
|
# @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+.
|
@@ -2566,7 +2590,7 @@ module Recurly
|
|
2566
2590
|
|
2567
2591
|
# List a plan's add-ons
|
2568
2592
|
#
|
2569
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_plan_add_ons list_plan_add_ons api
|
2593
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_plan_add_ons list_plan_add_ons api documentation}
|
2570
2594
|
#
|
2571
2595
|
# @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+.
|
2572
2596
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2613,7 +2637,7 @@ module Recurly
|
|
2613
2637
|
|
2614
2638
|
# Create an add-on
|
2615
2639
|
#
|
2616
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_plan_add_on create_plan_add_on api
|
2640
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_plan_add_on create_plan_add_on api documentation}
|
2617
2641
|
#
|
2618
2642
|
# @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+.
|
2619
2643
|
# @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
|
@@ -2648,7 +2672,7 @@ module Recurly
|
|
2648
2672
|
|
2649
2673
|
# Fetch a plan's add-on
|
2650
2674
|
#
|
2651
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_plan_add_on get_plan_add_on api
|
2675
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_plan_add_on get_plan_add_on api documentation}
|
2652
2676
|
#
|
2653
2677
|
# @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+.
|
2654
2678
|
# @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+.
|
@@ -2674,7 +2698,7 @@ module Recurly
|
|
2674
2698
|
|
2675
2699
|
# Update an add-on
|
2676
2700
|
#
|
2677
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_plan_add_on update_plan_add_on api
|
2701
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_plan_add_on update_plan_add_on api documentation}
|
2678
2702
|
#
|
2679
2703
|
# @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+.
|
2680
2704
|
# @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+.
|
@@ -2706,7 +2730,7 @@ module Recurly
|
|
2706
2730
|
|
2707
2731
|
# Remove an add-on
|
2708
2732
|
#
|
2709
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan_add_on remove_plan_add_on api
|
2733
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan_add_on remove_plan_add_on api documentation}
|
2710
2734
|
#
|
2711
2735
|
# @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+.
|
2712
2736
|
# @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+.
|
@@ -2733,7 +2757,7 @@ module Recurly
|
|
2733
2757
|
|
2734
2758
|
# List a site's add-ons
|
2735
2759
|
#
|
2736
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_add_ons list_add_ons api
|
2760
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_add_ons list_add_ons api documentation}
|
2737
2761
|
#
|
2738
2762
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
2739
2763
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -2778,7 +2802,7 @@ module Recurly
|
|
2778
2802
|
|
2779
2803
|
# Fetch an add-on
|
2780
2804
|
#
|
2781
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_add_on get_add_on api
|
2805
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_add_on get_add_on api documentation}
|
2782
2806
|
#
|
2783
2807
|
# @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+.
|
2784
2808
|
# @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+.
|
@@ -2801,7 +2825,7 @@ module Recurly
|
|
2801
2825
|
|
2802
2826
|
# List a site's shipping methods
|
2803
2827
|
#
|
2804
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_methods list_shipping_methods api
|
2828
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_methods list_shipping_methods api documentation}
|
2805
2829
|
#
|
2806
2830
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
2807
2831
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -2845,7 +2869,7 @@ module Recurly
|
|
2845
2869
|
|
2846
2870
|
# Create a new shipping method
|
2847
2871
|
#
|
2848
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_method create_shipping_method api
|
2872
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_method create_shipping_method api documentation}
|
2849
2873
|
#
|
2850
2874
|
# @param body [Requests::ShippingMethodCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodCreate}
|
2851
2875
|
# @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+.
|
@@ -2859,7 +2883,7 @@ module Recurly
|
|
2859
2883
|
|
2860
2884
|
# Fetch a shipping method
|
2861
2885
|
#
|
2862
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_method get_shipping_method api
|
2886
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_method get_shipping_method api documentation}
|
2863
2887
|
#
|
2864
2888
|
# @param 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+.
|
2865
2889
|
# @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+.
|
@@ -2873,7 +2897,7 @@ module Recurly
|
|
2873
2897
|
|
2874
2898
|
# Update an active Shipping Method
|
2875
2899
|
#
|
2876
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_method update_shipping_method api
|
2900
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_method update_shipping_method api documentation}
|
2877
2901
|
#
|
2878
2902
|
# @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+.
|
2879
2903
|
# @param body [Requests::ShippingMethodUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodUpdate}
|
@@ -2888,7 +2912,7 @@ module Recurly
|
|
2888
2912
|
|
2889
2913
|
# Deactivate a shipping method
|
2890
2914
|
#
|
2891
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_shipping_method deactivate_shipping_method api
|
2915
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_shipping_method deactivate_shipping_method api documentation}
|
2892
2916
|
#
|
2893
2917
|
# @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+.
|
2894
2918
|
# @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+.
|
@@ -2902,7 +2926,7 @@ module Recurly
|
|
2902
2926
|
|
2903
2927
|
# List a site's subscriptions
|
2904
2928
|
#
|
2905
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscriptions list_subscriptions api
|
2929
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscriptions list_subscriptions api documentation}
|
2906
2930
|
#
|
2907
2931
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
2908
2932
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -2950,7 +2974,7 @@ module Recurly
|
|
2950
2974
|
|
2951
2975
|
# Create a new subscription
|
2952
2976
|
#
|
2953
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription create_subscription api
|
2977
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription create_subscription api documentation}
|
2954
2978
|
#
|
2955
2979
|
# @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
|
2956
2980
|
# @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+.
|
@@ -2961,8 +2985,7 @@ module Recurly
|
|
2961
2985
|
# subscription_create = {
|
2962
2986
|
# plan_code: plan_code,
|
2963
2987
|
# currency: "USD",
|
2964
|
-
# # This can be an existing account or
|
2965
|
-
# # a new acocunt
|
2988
|
+
# # This can be an existing account or a new account
|
2966
2989
|
# account: {
|
2967
2990
|
# code: account_code,
|
2968
2991
|
# }
|
@@ -2984,7 +3007,7 @@ module Recurly
|
|
2984
3007
|
|
2985
3008
|
# Fetch a subscription
|
2986
3009
|
#
|
2987
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription get_subscription api
|
3010
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription get_subscription api documentation}
|
2988
3011
|
#
|
2989
3012
|
# @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+.
|
2990
3013
|
# @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+.
|
@@ -3009,7 +3032,7 @@ module Recurly
|
|
3009
3032
|
|
3010
3033
|
# Modify a subscription
|
3011
3034
|
#
|
3012
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/modify_subscription modify_subscription api
|
3035
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/modify_subscription modify_subscription api documentation}
|
3013
3036
|
#
|
3014
3037
|
# @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+.
|
3015
3038
|
# @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
|
@@ -3040,7 +3063,7 @@ module Recurly
|
|
3040
3063
|
|
3041
3064
|
# Terminate a subscription
|
3042
3065
|
#
|
3043
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/terminate_subscription terminate_subscription api
|
3066
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/terminate_subscription terminate_subscription api documentation}
|
3044
3067
|
#
|
3045
3068
|
# @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+.
|
3046
3069
|
# @param refund [String] The type of refund to perform:
|
@@ -3076,7 +3099,7 @@ module Recurly
|
|
3076
3099
|
|
3077
3100
|
# Cancel a subscription
|
3078
3101
|
#
|
3079
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/cancel_subscription cancel_subscription api
|
3102
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/cancel_subscription cancel_subscription api documentation}
|
3080
3103
|
#
|
3081
3104
|
# @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+.
|
3082
3105
|
# @param body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
|
@@ -3102,7 +3125,7 @@ module Recurly
|
|
3102
3125
|
|
3103
3126
|
# Reactivate a canceled subscription
|
3104
3127
|
#
|
3105
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_subscription reactivate_subscription api
|
3128
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_subscription reactivate_subscription api documentation}
|
3106
3129
|
#
|
3107
3130
|
# @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+.
|
3108
3131
|
# @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+.
|
@@ -3127,7 +3150,7 @@ module Recurly
|
|
3127
3150
|
|
3128
3151
|
# Pause subscription
|
3129
3152
|
#
|
3130
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/pause_subscription pause_subscription api
|
3153
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/pause_subscription pause_subscription api documentation}
|
3131
3154
|
#
|
3132
3155
|
# @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+.
|
3133
3156
|
# @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
|
@@ -3157,7 +3180,7 @@ module Recurly
|
|
3157
3180
|
|
3158
3181
|
# Resume subscription
|
3159
3182
|
#
|
3160
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/resume_subscription resume_subscription api
|
3183
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/resume_subscription resume_subscription api documentation}
|
3161
3184
|
#
|
3162
3185
|
# @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+.
|
3163
3186
|
# @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+.
|
@@ -3182,7 +3205,7 @@ module Recurly
|
|
3182
3205
|
|
3183
3206
|
# Convert trial subscription
|
3184
3207
|
#
|
3185
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/convert_trial convert_trial api
|
3208
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/convert_trial convert_trial api documentation}
|
3186
3209
|
#
|
3187
3210
|
# @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
3211
|
# @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+.
|
@@ -3194,9 +3217,22 @@ module Recurly
|
|
3194
3217
|
put(path, **options)
|
3195
3218
|
end
|
3196
3219
|
|
3220
|
+
# Fetch a preview of a subscription's renewal invoice(s)
|
3221
|
+
#
|
3222
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_preview_renewal get_preview_renewal api documentation}
|
3223
|
+
#
|
3224
|
+
# @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+.
|
3225
|
+
#
|
3226
|
+
# @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
|
3227
|
+
#
|
3228
|
+
def get_preview_renewal(subscription_id:)
|
3229
|
+
path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
|
3230
|
+
get(path)
|
3231
|
+
end
|
3232
|
+
|
3197
3233
|
# Fetch a subscription's pending change
|
3198
3234
|
#
|
3199
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api
|
3235
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api documentation}
|
3200
3236
|
#
|
3201
3237
|
# @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+.
|
3202
3238
|
# @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+.
|
@@ -3221,7 +3257,7 @@ module Recurly
|
|
3221
3257
|
|
3222
3258
|
# Create a new subscription change
|
3223
3259
|
#
|
3224
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription_change create_subscription_change api
|
3260
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription_change create_subscription_change api documentation}
|
3225
3261
|
#
|
3226
3262
|
# @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+.
|
3227
3263
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
@@ -3252,7 +3288,7 @@ module Recurly
|
|
3252
3288
|
|
3253
3289
|
# Delete the pending subscription change
|
3254
3290
|
#
|
3255
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_subscription_change remove_subscription_change api
|
3291
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_subscription_change remove_subscription_change api documentation}
|
3256
3292
|
#
|
3257
3293
|
# @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+.
|
3258
3294
|
# @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+.
|
@@ -3277,7 +3313,7 @@ module Recurly
|
|
3277
3313
|
|
3278
3314
|
# Preview a new subscription change
|
3279
3315
|
#
|
3280
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/preview_subscription_change preview_subscription_change api
|
3316
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/preview_subscription_change preview_subscription_change api documentation}
|
3281
3317
|
#
|
3282
3318
|
# @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+.
|
3283
3319
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
@@ -3292,7 +3328,7 @@ module Recurly
|
|
3292
3328
|
|
3293
3329
|
# List a subscription's invoices
|
3294
3330
|
#
|
3295
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api
|
3331
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api documentation}
|
3296
3332
|
#
|
3297
3333
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3298
3334
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -3344,7 +3380,7 @@ module Recurly
|
|
3344
3380
|
|
3345
3381
|
# List a subscription's line items
|
3346
3382
|
#
|
3347
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_line_items list_subscription_line_items api
|
3383
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_line_items list_subscription_line_items api documentation}
|
3348
3384
|
#
|
3349
3385
|
# @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+.
|
3350
3386
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -3393,7 +3429,7 @@ module Recurly
|
|
3393
3429
|
|
3394
3430
|
# Show the coupon redemptions for a subscription
|
3395
3431
|
#
|
3396
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api
|
3432
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
|
3397
3433
|
#
|
3398
3434
|
# @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+.
|
3399
3435
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -3437,7 +3473,7 @@ module Recurly
|
|
3437
3473
|
|
3438
3474
|
# List a subscription add-on's usage records
|
3439
3475
|
#
|
3440
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_usage list_usage api
|
3476
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_usage list_usage api documentation}
|
3441
3477
|
#
|
3442
3478
|
# @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+.
|
3443
3479
|
# @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+.
|
@@ -3477,7 +3513,7 @@ module Recurly
|
|
3477
3513
|
|
3478
3514
|
# Log a usage record on this subscription add-on
|
3479
3515
|
#
|
3480
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_usage create_usage api
|
3516
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_usage create_usage api documentation}
|
3481
3517
|
#
|
3482
3518
|
# @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+.
|
3483
3519
|
# @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+.
|
@@ -3493,7 +3529,7 @@ module Recurly
|
|
3493
3529
|
|
3494
3530
|
# Get a usage record
|
3495
3531
|
#
|
3496
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_usage get_usage api
|
3532
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_usage get_usage api documentation}
|
3497
3533
|
#
|
3498
3534
|
# @param usage_id [String] Usage Record ID.
|
3499
3535
|
# @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+.
|
@@ -3507,7 +3543,7 @@ module Recurly
|
|
3507
3543
|
|
3508
3544
|
# Update a usage record
|
3509
3545
|
#
|
3510
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/update_usage update_usage api
|
3546
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/update_usage update_usage api documentation}
|
3511
3547
|
#
|
3512
3548
|
# @param usage_id [String] Usage Record ID.
|
3513
3549
|
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
|
@@ -3522,7 +3558,7 @@ module Recurly
|
|
3522
3558
|
|
3523
3559
|
# Delete a usage record.
|
3524
3560
|
#
|
3525
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_usage remove_usage api
|
3561
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/remove_usage remove_usage api documentation}
|
3526
3562
|
#
|
3527
3563
|
# @param usage_id [String] Usage Record ID.
|
3528
3564
|
# @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+.
|
@@ -3536,7 +3572,7 @@ module Recurly
|
|
3536
3572
|
|
3537
3573
|
# List a site's transactions
|
3538
3574
|
#
|
3539
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/list_transactions list_transactions api
|
3575
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_transactions list_transactions api documentation}
|
3540
3576
|
#
|
3541
3577
|
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
3542
3578
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -3580,7 +3616,7 @@ module Recurly
|
|
3580
3616
|
|
3581
3617
|
# Fetch a transaction
|
3582
3618
|
#
|
3583
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_transaction get_transaction api
|
3619
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_transaction get_transaction api documentation}
|
3584
3620
|
#
|
3585
3621
|
# @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+.
|
3586
3622
|
# @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+.
|
@@ -3603,7 +3639,7 @@ module Recurly
|
|
3603
3639
|
|
3604
3640
|
# Fetch a unique coupon code
|
3605
3641
|
#
|
3606
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_unique_coupon_code get_unique_coupon_code api
|
3642
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_unique_coupon_code get_unique_coupon_code api documentation}
|
3607
3643
|
#
|
3608
3644
|
# @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+.
|
3609
3645
|
# @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+.
|
@@ -3617,7 +3653,7 @@ module Recurly
|
|
3617
3653
|
|
3618
3654
|
# Deactivate a unique coupon code
|
3619
3655
|
#
|
3620
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api
|
3656
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documentation}
|
3621
3657
|
#
|
3622
3658
|
# @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+.
|
3623
3659
|
# @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+.
|
@@ -3631,7 +3667,7 @@ module Recurly
|
|
3631
3667
|
|
3632
3668
|
# Restore a unique coupon code
|
3633
3669
|
#
|
3634
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api
|
3670
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documentation}
|
3635
3671
|
#
|
3636
3672
|
# @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+.
|
3637
3673
|
# @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+.
|
@@ -3645,7 +3681,7 @@ module Recurly
|
|
3645
3681
|
|
3646
3682
|
# Create a new purchase
|
3647
3683
|
#
|
3648
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/create_purchase create_purchase api
|
3684
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/create_purchase create_purchase api documentation}
|
3649
3685
|
#
|
3650
3686
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3651
3687
|
# @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+.
|
@@ -3685,7 +3721,7 @@ module Recurly
|
|
3685
3721
|
|
3686
3722
|
# Preview a new purchase
|
3687
3723
|
#
|
3688
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/preview_purchase preview_purchase api
|
3724
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/preview_purchase preview_purchase api documentation}
|
3689
3725
|
#
|
3690
3726
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3691
3727
|
# @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+.
|
@@ -3725,7 +3761,7 @@ module Recurly
|
|
3725
3761
|
|
3726
3762
|
# List the dates that have an available export to download.
|
3727
3763
|
#
|
3728
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_export_dates get_export_dates api
|
3764
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_export_dates get_export_dates api documentation}
|
3729
3765
|
#
|
3730
3766
|
# @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+.
|
3731
3767
|
#
|
@@ -3749,7 +3785,7 @@ module Recurly
|
|
3749
3785
|
|
3750
3786
|
# List of the export files that are available to download.
|
3751
3787
|
#
|
3752
|
-
# {https://developers.recurly.com/api/v2019-10-10#operation/get_export_files get_export_files api
|
3788
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_export_files get_export_files api documentation}
|
3753
3789
|
#
|
3754
3790
|
# @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
|
3755
3791
|
# @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+.
|
@@ -3771,5 +3807,47 @@ module Recurly
|
|
3771
3807
|
path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
|
3772
3808
|
get(path, **options)
|
3773
3809
|
end
|
3810
|
+
|
3811
|
+
# Show the dunning campaigns for a site
|
3812
|
+
#
|
3813
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
|
3814
|
+
#
|
3815
|
+
# @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
|
3816
|
+
# order. In descending order updated records will move behind the cursor and could
|
3817
|
+
# prevent some records from being returned.
|
3818
|
+
#
|
3819
|
+
#
|
3820
|
+
# @return [Pager<Resources::DunningCampaign>] A list of the the dunning_campaigns on an account.
|
3821
|
+
#
|
3822
|
+
def list_dunning_campaigns(**options)
|
3823
|
+
path = "/dunning_campaigns"
|
3824
|
+
pager(path, **options)
|
3825
|
+
end
|
3826
|
+
|
3827
|
+
# Show the settings for a dunning campaign
|
3828
|
+
#
|
3829
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/get_dunning_campaign get_dunning_campaign api documentation}
|
3830
|
+
#
|
3831
|
+
# @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
|
3832
|
+
#
|
3833
|
+
# @return [Resources::DunningCampaign] Settings for a dunning campaign.
|
3834
|
+
#
|
3835
|
+
def get_dunning_campaign(dunning_campaign_id:)
|
3836
|
+
path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
|
3837
|
+
get(path)
|
3838
|
+
end
|
3839
|
+
|
3840
|
+
# Assign a dunning campaign to multiple plans
|
3841
|
+
#
|
3842
|
+
# {https://developers.recurly.com/api/v2019-10-10#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
|
3843
|
+
#
|
3844
|
+
# @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
|
3845
|
+
#
|
3846
|
+
# @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
|
3847
|
+
#
|
3848
|
+
def put_dunning_campaign_bulk_update(body:)
|
3849
|
+
path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
|
3850
|
+
put(path, body, Requests::DunningCampaignsBulkUpdate)
|
3851
|
+
end
|
3774
3852
|
end
|
3775
3853
|
end
|