lib/recurly/client/operations.rb in recurly-3.18.1 vs lib/recurly/client/operations.rb in recurly-3.19.0
- old
+ new
@@ -8,11 +8,11 @@
"v2019-10-10"
end
# List sites
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_sites list_sites api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_sites list_sites api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -44,11 +44,11 @@
pager(path, **options)
end
# Fetch a site
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_site get_site api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_site get_site api documentation}
#
# @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+.
#
# @return [Resources::Site] A site.
# @example
@@ -66,11 +66,11 @@
get(path)
end
# List a site's accounts
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_accounts list_accounts api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_accounts list_accounts api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -113,11 +113,11 @@
pager(path, **options)
end
# Create an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_account create_account api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_account create_account api documentation}
#
# @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
# @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+.
#
# @return [Resources::Account] An account.
@@ -162,11 +162,11 @@
post(path, body, Requests::AccountCreate, **options)
end
# Fetch an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account get_account api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_account get_account api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Account] An account.
@@ -185,11 +185,11 @@
get(path, **options)
end
# Modify an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_account update_account api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_account update_account api documentation}
#
# @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+.
# @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
# @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+.
#
@@ -216,11 +216,11 @@
put(path, body, Requests::AccountUpdate, **options)
end
# Deactivate an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_account deactivate_account api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_account deactivate_account api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Account] An account.
@@ -239,11 +239,11 @@
delete(path, **options)
end
# Fetch an account's acquisition data
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_acquisition get_account_acquisition api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_acquisition get_account_acquisition api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::AccountAcquisition] An account's acquisition data.
@@ -262,11 +262,11 @@
get(path, **options)
end
# Update an account's acquisition data
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_account_acquisition update_account_acquisition api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_account_acquisition update_account_acquisition api documentation}
#
# @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+.
# @param body [Requests::AccountAcquisitionUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdatable}
# @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+.
#
@@ -298,11 +298,11 @@
put(path, body, Requests::AccountAcquisitionUpdatable, **options)
end
# Remove an account's acquisition data
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_account_acquisition remove_account_acquisition api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_account_acquisition remove_account_acquisition api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Empty] Acquisition data was succesfully deleted.
@@ -321,11 +321,11 @@
delete(path, **options)
end
# Reactivate an inactive account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_account reactivate_account api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_account reactivate_account api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Account] An account.
@@ -344,11 +344,11 @@
put(path, **options)
end
# Fetch an account's balance and past due status
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_balance get_account_balance api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_balance get_account_balance api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::AccountBalance] An account's balance.
@@ -367,11 +367,11 @@
get(path, **options)
end
# Fetch an account's billing information
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_billing_info get_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_billing_info get_billing_info api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::BillingInfo] An account's billing information.
@@ -390,11 +390,11 @@
get(path, **options)
end
# Set an account's billing information
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_billing_info update_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_billing_info update_billing_info api documentation}
#
# @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+.
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
# @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+.
#
@@ -421,11 +421,11 @@
put(path, body, Requests::BillingInfoCreate, **options)
end
# Remove an account's billing information
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_billing_info remove_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_billing_info remove_billing_info api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Empty] Billing information deleted
@@ -442,13 +442,37 @@
def remove_billing_info(account_id:, **options)
path = interpolate_path("/accounts/{account_id}/billing_info", account_id: account_id)
delete(path, **options)
end
+ # Verify an account's credit card billing information
+ #
+ # {https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_info verify_billing_info api documentation}
+ #
+ # @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+.
+ # @param body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
+ # @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+.
+ #
+ # @return [Resources::Transaction] Transaction information from verify.
+ # @example
+ # begin
+ # transaction = @client.verify_billing_info(account_id: account_id)
+ # puts "Got Transaction #{transaction}"
+ # rescue Recurly::Errors::NotFoundError
+ # # If the resource was not found, you may want to alert the user or
+ # # just return nil
+ # puts "Resource Not Found"
+ # end
+ #
+ def verify_billing_info(account_id:, **options)
+ path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
+ post(path, options[:body], Requests::BillingInfoVerify, **options)
+ end
+
# Get the list of billing information associated with an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_billing_infos list_billing_infos api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -478,13 +502,13 @@
def list_billing_infos(account_id:, **options)
path = interpolate_path("/accounts/{account_id}/billing_infos", account_id: account_id)
pager(path, **options)
end
- # Set an account's billing information when the wallet feature is enabled
+ # Add new billing information on an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_billing_info create_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_billing_info create_billing_info api documentation}
#
# @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+.
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
# @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+.
#
@@ -495,14 +519,14 @@
post(path, body, Requests::BillingInfoCreate, **options)
end
# Fetch a billing info
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_a_billing_info get_a_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_a_billing_info get_a_billing_info api documentation}
#
# @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+.
- # @param billing_info_id [String] Billing Info ID.
+ # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
# @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+.
#
# @return [Resources::BillingInfo] A billing info.
#
def get_a_billing_info(account_id:, billing_info_id:, **options)
@@ -510,14 +534,14 @@
get(path, **options)
end
# Update an account's billing information
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_a_billing_info update_a_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_a_billing_info update_a_billing_info api documentation}
#
# @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+.
- # @param billing_info_id [String] Billing Info ID.
+ # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
# @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+.
#
# @return [Resources::BillingInfo] Updated billing information.
#
@@ -526,14 +550,14 @@
put(path, body, Requests::BillingInfoCreate, **options)
end
# Remove an account's billing information
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_a_billing_info remove_a_billing_info api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_a_billing_info remove_a_billing_info api documentation}
#
# @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+.
- # @param billing_info_id [String] Billing Info ID.
+ # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
# @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+.
#
# @return [Resources::Empty] Billing information deleted
#
def remove_a_billing_info(account_id:, billing_info_id:, **options)
@@ -541,11 +565,11 @@
delete(path, **options)
end
# Show the coupon redemptions for an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -586,11 +610,11 @@
pager(path, **options)
end
# Show the coupon redemption that is active on an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::CouponRedemption] An active coupon redemption on an account.
@@ -609,11 +633,11 @@
get(path, **options)
end
# Generate an active coupon redemption on an account or subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon_redemption create_coupon_redemption api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon_redemption create_coupon_redemption api documentation}
#
# @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+.
# @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
# @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+.
#
@@ -640,11 +664,11 @@
post(path, body, Requests::CouponRedemptionCreate, **options)
end
# Delete the active coupon redemption from an account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_coupon_redemption remove_coupon_redemption api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_coupon_redemption remove_coupon_redemption api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::CouponRedemption] Coupon redemption deleted.
@@ -663,11 +687,11 @@
delete(path, **options)
end
# List an account's credit payments
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_credit_payments list_account_credit_payments api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_credit_payments list_account_credit_payments api documentation}
#
# @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+.
# @param limit [Integer] Limit number of records 1-200.
# @param order [String] Sort order.
# @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -697,11 +721,11 @@
pager(path, **options)
end
# List an account's invoices
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_invoices list_account_invoices api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_invoices list_account_invoices api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -749,11 +773,11 @@
pager(path, **options)
end
# Create an invoice for pending line items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_invoice create_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_invoice create_invoice api documentation}
#
# @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+.
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
# @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+.
#
@@ -780,11 +804,11 @@
post(path, body, Requests::InvoiceCreate, **options)
end
# Preview new invoice for pending line items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/preview_invoice preview_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/preview_invoice preview_invoice api documentation}
#
# @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+.
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
# @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+.
#
@@ -811,11 +835,11 @@
post(path, body, Requests::InvoiceCreate, **options)
end
# List an account's line items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_line_items list_account_line_items api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_line_items list_account_line_items api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -860,11 +884,11 @@
pager(path, **options)
end
# Create a new line item for the account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_line_item create_line_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_line_item create_line_item api documentation}
#
# @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+.
# @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
# @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+.
#
@@ -892,11 +916,11 @@
post(path, body, Requests::LineItemCreate, **options)
end
# Fetch a list of an account's notes
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -923,11 +947,11 @@
pager(path, **options)
end
# Fetch an account note
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_note get_account_note api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_account_note get_account_note api documentation}
#
# @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+.
# @param account_note_id [String] Account Note ID.
# @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+.
#
@@ -950,11 +974,11 @@
get(path, **options)
end
# Fetch a list of an account's shipping addresses
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_addresses list_shipping_addresses api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_addresses list_shipping_addresses api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -996,11 +1020,11 @@
pager(path, **options)
end
# Create a new shipping address for the account
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_address create_shipping_address api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_address create_shipping_address api documentation}
#
# @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+.
# @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
# @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+.
#
@@ -1030,11 +1054,11 @@
post(path, body, Requests::ShippingAddressCreate, **options)
end
# Fetch an account's shipping address
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_address get_shipping_address api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_address get_shipping_address api documentation}
#
# @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+.
# @param shipping_address_id [String] Shipping Address ID.
# @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+.
#
@@ -1057,11 +1081,11 @@
get(path, **options)
end
# Update an account's shipping address
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_address update_shipping_address api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_address update_shipping_address api documentation}
#
# @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+.
# @param shipping_address_id [String] Shipping Address ID.
# @param body [Requests::ShippingAddressUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressUpdate}
# @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+.
@@ -1091,11 +1115,11 @@
put(path, body, Requests::ShippingAddressUpdate, **options)
end
# Remove an account's shipping address
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_shipping_address remove_shipping_address api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_shipping_address remove_shipping_address api documentation}
#
# @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+.
# @param shipping_address_id [String] Shipping Address ID.
# @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+.
#
@@ -1118,11 +1142,11 @@
delete(path, **options)
end
# List an account's subscriptions
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_subscriptions list_account_subscriptions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_subscriptions list_account_subscriptions api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -1170,11 +1194,11 @@
pager(path, **options)
end
# List an account's transactions
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_transactions list_account_transactions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_transactions list_account_transactions api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -1218,11 +1242,11 @@
pager(path, **options)
end
# List an account's child accounts
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_child_accounts list_child_accounts api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_child_accounts list_child_accounts api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -1269,11 +1293,11 @@
pager(path, **options)
end
# List a site's account acquisition data
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_acquisition list_account_acquisition api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_acquisition list_account_acquisition api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -1311,11 +1335,11 @@
pager(path, **options)
end
# List a site's coupons
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_coupons list_coupons api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_coupons list_coupons api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -1353,11 +1377,11 @@
pager(path, **options)
end
# Create a new coupon
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon create_coupon api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_coupon create_coupon api documentation}
#
# @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
# @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+.
#
# @return [Resources::Coupon] A new coupon.
@@ -1389,11 +1413,11 @@
post(path, body, Requests::CouponCreate, **options)
end
# Fetch a coupon
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_coupon get_coupon api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_coupon get_coupon api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Coupon] A coupon.
@@ -1412,11 +1436,11 @@
get(path, **options)
end
# Update an active coupon
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_coupon update_coupon api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_coupon update_coupon api documentation}
#
# @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+.
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
# @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+.
#
@@ -1439,11 +1463,11 @@
put(path, body, Requests::CouponUpdate, **options)
end
# Expire a coupon
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_coupon deactivate_coupon api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_coupon deactivate_coupon api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Coupon] The expired Coupon
@@ -1462,11 +1486,11 @@
delete(path, **options)
end
# Restore an inactive coupon
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/restore_coupon restore_coupon api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/restore_coupon restore_coupon api documentation}
#
# @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+.
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
# @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+.
#
@@ -1488,11 +1512,11 @@
put(path, body, Requests::CouponUpdate, **options)
end
# List unique coupon codes associated with a bulk coupon
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_unique_coupon_codes list_unique_coupon_codes api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_unique_coupon_codes list_unique_coupon_codes api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -1526,11 +1550,11 @@
pager(path, **options)
end
# List a site's credit payments
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_credit_payments list_credit_payments api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_credit_payments list_credit_payments api documentation}
#
# @param limit [Integer] Limit number of records 1-200.
# @param order [String] Sort order.
# @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
# order. In descending order updated records will move behind the cursor and could
@@ -1556,11 +1580,11 @@
pager(path, **options)
end
# Fetch a credit payment
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_credit_payment get_credit_payment api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_credit_payment get_credit_payment api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::CreditPayment] A credit payment.
@@ -1570,11 +1594,11 @@
get(path, **options)
end
# List a site's custom field definitions
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_custom_field_definitions list_custom_field_definitions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_custom_field_definitions list_custom_field_definitions api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -1613,11 +1637,11 @@
pager(path, **options)
end
# Fetch an custom field definition
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_custom_field_definition get_custom_field_definition api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_custom_field_definition get_custom_field_definition api documentation}
#
# @param custom_field_definition_id [String] Custom Field Definition ID
# @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+.
#
# @return [Resources::CustomFieldDefinition] An custom field definition.
@@ -1638,11 +1662,11 @@
get(path, **options)
end
# List a site's items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_items list_items api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_items list_items api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -1681,11 +1705,11 @@
pager(path, **options)
end
# Create a new item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_item create_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_item create_item api documentation}
#
# @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
# @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+.
#
# @return [Resources::Item] A new item.
@@ -1716,11 +1740,11 @@
post(path, body, Requests::ItemCreate, **options)
end
# Fetch an item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_item get_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_item get_item api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Item] An item.
@@ -1739,11 +1763,11 @@
get(path, **options)
end
# Update an active item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_item update_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_item update_item api documentation}
#
# @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+.
# @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
# @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+.
#
@@ -1770,11 +1794,11 @@
put(path, body, Requests::ItemUpdate, **options)
end
# Deactivate an item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_item deactivate_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_item deactivate_item api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Item] An item.
@@ -1793,11 +1817,11 @@
delete(path, **options)
end
# Reactivate an inactive item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_item reactivate_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_item reactivate_item api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Item] An item.
@@ -1816,11 +1840,11 @@
put(path, **options)
end
# List a site's measured units
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_measured_unit list_measured_unit api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_measured_unit list_measured_unit api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -1854,11 +1878,11 @@
pager(path, **options)
end
# Create a new measured unit
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_measured_unit create_measured_unit api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_measured_unit create_measured_unit api documentation}
#
# @param body [Requests::MeasuredUnitCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitCreate}
# @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+.
#
# @return [Resources::MeasuredUnit] A new measured unit.
@@ -1868,11 +1892,11 @@
post(path, body, Requests::MeasuredUnitCreate, **options)
end
# Fetch a measured unit
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_measured_unit get_measured_unit api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_measured_unit get_measured_unit api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::MeasuredUnit] An item.
@@ -1882,11 +1906,11 @@
get(path, **options)
end
# Update a measured unit
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_measured_unit update_measured_unit api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_measured_unit update_measured_unit api documentation}
#
# @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+.
# @param body [Requests::MeasuredUnitUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitUpdate}
# @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+.
#
@@ -1897,11 +1921,11 @@
put(path, body, Requests::MeasuredUnitUpdate, **options)
end
# Remove a measured unit
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_measured_unit remove_measured_unit api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_measured_unit remove_measured_unit api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::MeasuredUnit] A measured unit.
@@ -1911,11 +1935,11 @@
delete(path, **options)
end
# List a site's invoices
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoices list_invoices api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoices list_invoices api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -1959,11 +1983,11 @@
pager(path, **options)
end
# Fetch an invoice
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice get_invoice api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Invoice] An invoice.
@@ -1982,11 +2006,11 @@
get(path, **options)
end
# Update an invoice
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/put_invoice put_invoice api documentation}
#
# @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+.
# @param body [Requests::InvoiceUpdatable] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdatable}
# @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+.
#
@@ -2010,11 +2034,11 @@
put(path, body, Requests::InvoiceUpdatable, **options)
end
# Fetch an invoice as a PDF
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf get_invoice_pdf api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::BinaryFile] An invoice as a PDF.
@@ -2036,11 +2060,11 @@
get(path, **options)
end
# Collect a pending or past due, automatic invoice
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documentation}
#
# @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+.
# @param body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect}
# @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+.
#
@@ -2060,11 +2084,11 @@
put(path, options[:body], Requests::InvoiceCollect, **options)
end
# Mark an open invoice as failed
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice fail_invoice api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Invoice] The updated invoice.
@@ -2083,11 +2107,11 @@
put(path, **options)
end
# Mark an open invoice as successful
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful mark_invoice_successful api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Invoice] The updated invoice.
@@ -2106,11 +2130,11 @@
put(path, **options)
end
# Reopen a closed, manual invoice
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice reopen_invoice api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Invoice] The updated invoice.
@@ -2129,11 +2153,11 @@
put(path, **options)
end
# Void a credit invoice.
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/void_invoice void_invoice api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Invoice] The updated invoice.
@@ -2152,11 +2176,11 @@
put(path, **options)
end
# Record an external payment for a manual invoices.
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/record_external_transaction record_external_transaction api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/record_external_transaction record_external_transaction api documentation}
#
# @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+.
# @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
# @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+.
#
@@ -2167,11 +2191,11 @@
post(path, body, Requests::ExternalTransaction, **options)
end
# List an invoice's line items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_line_items list_invoice_line_items api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -2216,11 +2240,11 @@
pager(path, **options)
end
# Show the coupon redemptions applied to an invoice
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -2260,11 +2284,11 @@
pager(path, **options)
end
# List an invoice's related credit or charge invoices
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices list_related_invoices api documentation}
#
# @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+.
# @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+.
#
# @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice.
@@ -2282,11 +2306,11 @@
pager(path, **options)
end
# Refund an invoice
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/refund_invoice refund_invoice api documentation}
#
# @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+.
# @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
# @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+.
#
@@ -2313,11 +2337,11 @@
post(path, body, Requests::InvoiceRefund, **options)
end
# List a site's line items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_line_items list_line_items api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_line_items list_line_items api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -2360,11 +2384,11 @@
pager(path, **options)
end
# Fetch a line item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_line_item get_line_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_line_item get_line_item api documentation}
#
# @param line_item_id [String] Line Item ID.
# @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+.
#
# @return [Resources::LineItem] A line item.
@@ -2383,11 +2407,11 @@
get(path, **options)
end
# Delete an uninvoiced line item
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_line_item remove_line_item api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_line_item remove_line_item api documentation}
#
# @param line_item_id [String] Line Item ID.
# @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+.
#
# @return [Resources::Empty] Line item deleted.
@@ -2408,11 +2432,11 @@
delete(path, **options)
end
# List a site's plans
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_plans list_plans api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_plans list_plans api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -2451,11 +2475,11 @@
pager(path, **options)
end
# Create a plan
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan create_plan api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan create_plan api documentation}
#
# @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
# @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+.
#
# @return [Resources::Plan] A plan.
@@ -2491,11 +2515,11 @@
post(path, body, Requests::PlanCreate, **options)
end
# Fetch a plan
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan get_plan api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan get_plan api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Plan] A plan.
@@ -2514,11 +2538,11 @@
get(path, **options)
end
# Update a plan
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan update_plan api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan update_plan api documentation}
#
# @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+.
# @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
# @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+.
#
@@ -2541,11 +2565,11 @@
put(path, body, Requests::PlanUpdate, **options)
end
# Remove a plan
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan remove_plan api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan remove_plan api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Plan] Plan deleted
@@ -2564,11 +2588,11 @@
delete(path, **options)
end
# List a plan's add-ons
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_plan_add_ons list_plan_add_ons api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_plan_add_ons list_plan_add_ons api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -2611,11 +2635,11 @@
pager(path, **options)
end
# Create an add-on
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan_add_on create_plan_add_on api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_plan_add_on create_plan_add_on api documentation}
#
# @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+.
# @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
# @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+.
#
@@ -2646,11 +2670,11 @@
post(path, body, Requests::AddOnCreate, **options)
end
# Fetch a plan's add-on
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan_add_on get_plan_add_on api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_plan_add_on get_plan_add_on api documentation}
#
# @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+.
# @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+.
# @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+.
#
@@ -2672,11 +2696,11 @@
get(path, **options)
end
# Update an add-on
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan_add_on update_plan_add_on api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_plan_add_on update_plan_add_on api documentation}
#
# @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+.
# @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+.
# @param body [Requests::AddOnUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnUpdate}
# @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+.
@@ -2704,11 +2728,11 @@
put(path, body, Requests::AddOnUpdate, **options)
end
# Remove an add-on
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan_add_on remove_plan_add_on api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_plan_add_on remove_plan_add_on api documentation}
#
# @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+.
# @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+.
# @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+.
#
@@ -2731,11 +2755,11 @@
delete(path, **options)
end
# List a site's add-ons
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_add_ons list_add_ons api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_add_ons list_add_ons api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -2776,11 +2800,11 @@
pager(path, **options)
end
# Fetch an add-on
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_add_on get_add_on api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_add_on get_add_on api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::AddOn] An add-on.
@@ -2799,11 +2823,11 @@
get(path, **options)
end
# List a site's shipping methods
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_methods list_shipping_methods api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_methods list_shipping_methods api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -2843,11 +2867,11 @@
pager(path, **options)
end
# Create a new shipping method
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_method create_shipping_method api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_shipping_method create_shipping_method api documentation}
#
# @param body [Requests::ShippingMethodCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodCreate}
# @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+.
#
# @return [Resources::ShippingMethod] A new shipping method.
@@ -2857,11 +2881,11 @@
post(path, body, Requests::ShippingMethodCreate, **options)
end
# Fetch a shipping method
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_method get_shipping_method api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_shipping_method get_shipping_method api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::ShippingMethod] A shipping method.
@@ -2871,11 +2895,11 @@
get(path, **options)
end
# Update an active Shipping Method
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_method update_shipping_method api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_shipping_method update_shipping_method api documentation}
#
# @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+.
# @param body [Requests::ShippingMethodUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodUpdate}
# @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+.
#
@@ -2886,11 +2910,11 @@
put(path, body, Requests::ShippingMethodUpdate, **options)
end
# Deactivate a shipping method
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_shipping_method deactivate_shipping_method api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_shipping_method deactivate_shipping_method api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::ShippingMethod] A shipping method.
@@ -2900,11 +2924,11 @@
delete(path, **options)
end
# List a site's subscriptions
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscriptions list_subscriptions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscriptions list_subscriptions api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -2948,23 +2972,22 @@
pager(path, **options)
end
# Create a new subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription create_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription create_subscription api documentation}
#
# @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
# @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+.
#
# @return [Resources::Subscription] A subscription.
# @example
# begin
# subscription_create = {
# plan_code: plan_code,
# currency: "USD",
- # # This can be an existing account or
- # # a new acocunt
+ # # This can be an existing account or a new account
# account: {
# code: account_code,
# }
# }
# subscription = @client.create_subscription(
@@ -2982,11 +3005,11 @@
post(path, body, Requests::SubscriptionCreate, **options)
end
# Fetch a subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription get_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription get_subscription api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Subscription] A subscription.
@@ -3007,11 +3030,11 @@
get(path, **options)
end
# Modify a subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/modify_subscription modify_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/modify_subscription modify_subscription api documentation}
#
# @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+.
# @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
# @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+.
#
@@ -3038,11 +3061,11 @@
put(path, body, Requests::SubscriptionUpdate, **options)
end
# Terminate a subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/terminate_subscription terminate_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/terminate_subscription terminate_subscription api documentation}
#
# @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+.
# @param refund [String] The type of refund to perform:
#
# * +full+ - Performs a full refund of the last invoice for the current subscription term.
@@ -3074,11 +3097,11 @@
delete(path, **options)
end
# Cancel a subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/cancel_subscription cancel_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/cancel_subscription cancel_subscription api documentation}
#
# @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+.
# @param body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel}
# @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+.
#
@@ -3100,11 +3123,11 @@
put(path, options[:body], Requests::SubscriptionCancel, **options)
end
# Reactivate a canceled subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_subscription reactivate_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_subscription reactivate_subscription api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Subscription] An active subscription.
@@ -3125,11 +3148,11 @@
put(path, **options)
end
# Pause subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/pause_subscription pause_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/pause_subscription pause_subscription api documentation}
#
# @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+.
# @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
# @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+.
#
@@ -3155,11 +3178,11 @@
put(path, body, Requests::SubscriptionPause, **options)
end
# Resume subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/resume_subscription resume_subscription api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/resume_subscription resume_subscription api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Subscription] A subscription.
@@ -3180,11 +3203,11 @@
put(path, **options)
end
# Convert trial subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/convert_trial convert_trial api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/convert_trial convert_trial api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Subscription] A subscription.
@@ -3192,13 +3215,26 @@
def convert_trial(subscription_id:, **options)
path = interpolate_path("/subscriptions/{subscription_id}/convert_trial", subscription_id: subscription_id)
put(path, **options)
end
+ # Fetch a preview of a subscription's renewal invoice(s)
+ #
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_preview_renewal get_preview_renewal api documentation}
+ #
+ # @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+.
+ #
+ # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
+ #
+ def get_preview_renewal(subscription_id:)
+ path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
+ get(path)
+ end
+
# Fetch a subscription's pending change
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_subscription_change get_subscription_change api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::SubscriptionChange] A subscription's pending change.
@@ -3219,11 +3255,11 @@
get(path, **options)
end
# Create a new subscription change
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription_change create_subscription_change api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_subscription_change create_subscription_change api documentation}
#
# @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+.
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
# @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+.
#
@@ -3250,11 +3286,11 @@
post(path, body, Requests::SubscriptionChangeCreate, **options)
end
# Delete the pending subscription change
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_subscription_change remove_subscription_change api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_subscription_change remove_subscription_change api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Empty] Subscription change was deleted.
@@ -3275,11 +3311,11 @@
delete(path, **options)
end
# Preview a new subscription change
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/preview_subscription_change preview_subscription_change api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/preview_subscription_change preview_subscription_change api documentation}
#
# @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+.
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
# @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+.
#
@@ -3290,11 +3326,11 @@
post(path, body, Requests::SubscriptionChangeCreate, **options)
end
# List a subscription's invoices
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -3342,11 +3378,11 @@
pager(path, **options)
end
# List a subscription's line items
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_line_items list_subscription_line_items api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_line_items list_subscription_line_items api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -3391,11 +3427,11 @@
pager(path, **options)
end
# Show the coupon redemptions for a subscription
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
#
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
@@ -3435,11 +3471,11 @@
pager(path, **options)
end
# List a subscription add-on's usage records
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_usage list_usage api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_usage list_usage api documentation}
#
# @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+.
# @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+.
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
@@ -3475,11 +3511,11 @@
pager(path, **options)
end
# Log a usage record on this subscription add-on
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_usage create_usage api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_usage create_usage api documentation}
#
# @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+.
# @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+.
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
# @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+.
@@ -3491,11 +3527,11 @@
post(path, body, Requests::UsageCreate, **options)
end
# Get a usage record
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_usage get_usage api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_usage get_usage api documentation}
#
# @param usage_id [String] Usage Record ID.
# @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+.
#
# @return [Resources::Usage] The usage record.
@@ -3505,11 +3541,11 @@
get(path, **options)
end
# Update a usage record
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/update_usage update_usage api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/update_usage update_usage api documentation}
#
# @param usage_id [String] Usage Record ID.
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
# @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+.
#
@@ -3520,11 +3556,11 @@
put(path, body, Requests::UsageCreate, **options)
end
# Delete a usage record.
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/remove_usage remove_usage api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/remove_usage remove_usage api documentation}
#
# @param usage_id [String] Usage Record ID.
# @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+.
#
# @return [Resources::Empty] Usage was successfully deleted.
@@ -3534,11 +3570,11 @@
delete(path, **options)
end
# List a site's transactions
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/list_transactions list_transactions api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_transactions list_transactions api documentation}
#
# @param ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
#
# *Important notes:*
@@ -3578,11 +3614,11 @@
pager(path, **options)
end
# Fetch a transaction
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_transaction get_transaction api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_transaction get_transaction api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::Transaction] A transaction.
@@ -3601,11 +3637,11 @@
get(path, **options)
end
# Fetch a unique coupon code
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_unique_coupon_code get_unique_coupon_code api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_unique_coupon_code get_unique_coupon_code api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::UniqueCouponCode] A unique coupon code.
@@ -3615,11 +3651,11 @@
get(path, **options)
end
# Deactivate a unique coupon code
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::UniqueCouponCode] A unique coupon code.
@@ -3629,11 +3665,11 @@
delete(path, **options)
end
# Restore a unique coupon code
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documentation}
#
# @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+.
# @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+.
#
# @return [Resources::UniqueCouponCode] A unique coupon code.
@@ -3643,11 +3679,11 @@
put(path, **options)
end
# Create a new purchase
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/create_purchase create_purchase api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/create_purchase create_purchase api documentation}
#
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
# @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+.
#
# @return [Resources::InvoiceCollection] Returns the new invoices
@@ -3683,11 +3719,11 @@
post(path, body, Requests::PurchaseCreate, **options)
end
# Preview a new purchase
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/preview_purchase preview_purchase api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/preview_purchase preview_purchase api documentation}
#
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
# @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+.
#
# @return [Resources::InvoiceCollection] Returns preview of the new invoices
@@ -3723,11 +3759,11 @@
post(path, body, Requests::PurchaseCreate, **options)
end
# List the dates that have an available export to download.
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_export_dates get_export_dates api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_export_dates get_export_dates api documentation}
#
# @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+.
#
# @return [Resources::ExportDates] Returns a list of dates.
# @example
@@ -3747,11 +3783,11 @@
get(path, **options)
end
# List of the export files that are available to download.
#
- # {https://developers.recurly.com/api/v2019-10-10#operation/get_export_files get_export_files api documenation}
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_export_files get_export_files api documentation}
#
# @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
# @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+.
#
# @return [Resources::ExportFiles] Returns a list of export files to download.
@@ -3768,8 +3804,50 @@
# end
#
def get_export_files(export_date:, **options)
path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
get(path, **options)
+ end
+
+ # Show the dunning campaigns for a site
+ #
+ # {https://developers.recurly.com/api/v2019-10-10#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
+ #
+ # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+ # order. In descending order updated records will move behind the cursor and could
+ # prevent some records from being returned.
+ #
+ #
+ # @return [Pager<Resources::DunningCampaign>] A list of the the dunning_campaigns on an account.
+ #
+ def list_dunning_campaigns(**options)
+ path = "/dunning_campaigns"
+ pager(path, **options)
+ end
+
+ # Show the settings for a dunning campaign
+ #
+ # {https://developers.recurly.com/api/v2019-10-10#operation/get_dunning_campaign get_dunning_campaign api documentation}
+ #
+ # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
+ #
+ # @return [Resources::DunningCampaign] Settings for a dunning campaign.
+ #
+ def get_dunning_campaign(dunning_campaign_id:)
+ path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
+ get(path)
+ end
+
+ # Assign a dunning campaign to multiple plans
+ #
+ # {https://developers.recurly.com/api/v2019-10-10#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
+ #
+ # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
+ #
+ # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
+ #
+ def put_dunning_campaign_bulk_update(body:)
+ path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
+ put(path, body, Requests::DunningCampaignsBulkUpdate)
end
end
end