lib/recurly/client/operations.rb in recurly-4.13.0 vs lib/recurly/client/operations.rb in recurly-4.14.0

- old
+ new

@@ -8,11 +8,11 @@ "v2021-02-25" end # List sites # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -48,11 +48,11 @@ pager(path, **options) end # Fetch a site # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_site get_site api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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+. # @param params [Hash] Optional query string parameters: # # @return [Resources::Site] A site. @@ -71,11 +71,11 @@ get(path, **options) end # List a site's accounts # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -121,11 +121,11 @@ pager(path, **options) end # Create an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_account create_account api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Account] An account. @@ -170,11 +170,11 @@ post(path, body, Requests::AccountCreate, **options) end # Fetch an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_account get_account api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Account] An account. @@ -193,11 +193,11 @@ get(path, **options) end # Update an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_account update_account api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -224,11 +224,11 @@ put(path, body, Requests::AccountUpdate, **options) end # Deactivate an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account deactivate_account api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Account] An account. @@ -247,11 +247,11 @@ delete(path, **options) end # Fetch an account's acquisition data # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition get_account_acquisition api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::AccountAcquisition] An account's acquisition data. @@ -270,11 +270,11 @@ get(path, **options) end # Update an account's acquisition data # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition update_account_acquisition api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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::AccountAcquisitionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdate} # @param params [Hash] Optional query string parameters: # @@ -306,11 +306,11 @@ put(path, body, Requests::AccountAcquisitionUpdate, **options) end # Remove an account's acquisition data # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition remove_account_acquisition api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Empty] Acquisition data was succesfully deleted. @@ -329,11 +329,11 @@ delete(path, **options) end # Reactivate an inactive account # - # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account reactivate_account api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Account] An account. @@ -352,11 +352,11 @@ put(path, **options) end # Fetch an account's balance and past due status # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance get_account_balance api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::AccountBalance] An account's balance. @@ -375,11 +375,11 @@ get(path, **options) end # Fetch an account's billing information # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info get_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::BillingInfo] An account's billing information. @@ -398,11 +398,11 @@ get(path, **options) end # Set an account's billing information # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info update_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -429,11 +429,11 @@ put(path, body, Requests::BillingInfoCreate, **options) end # Remove an account's billing information # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info remove_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Empty] Billing information deleted @@ -452,11 +452,11 @@ delete(path, **options) end # Verify an account's credit card billing information # - # {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify} # @@ -476,11 +476,11 @@ post(path, options[:body], Requests::BillingInfoVerify, **options) end # Get the list of billing information associated with an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -512,11 +512,11 @@ pager(path, **options) end # Add new billing information on an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -527,11 +527,11 @@ post(path, body, Requests::BillingInfoCreate, **options) end # Fetch a billing info # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info get_a_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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. Can ONLY be used for sites utilizing the Wallet feature. # @param params [Hash] Optional query string parameters: # @@ -542,11 +542,11 @@ get(path, **options) end # Update an account's billing information # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info update_a_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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. 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 params [Hash] Optional query string parameters: @@ -558,11 +558,11 @@ put(path, body, Requests::BillingInfoCreate, **options) end # Remove an account's billing information # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info remove_a_billing_info api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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. Can ONLY be used for sites utilizing the Wallet feature. # @param params [Hash] Optional query string parameters: # @@ -573,11 +573,11 @@ delete(path, **options) end # Show the coupon redemptions for an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -621,11 +621,11 @@ pager(path, **options) end # Show the coupon redemptions that are active on an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_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 params [Hash] Optional query string parameters: # # @return [Pager<Resources::CouponRedemption>] Active coupon redemptions on an account. @@ -643,11 +643,11 @@ pager(path, **options) end # Generate an active coupon redemption on an account or subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption create_coupon_redemption api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -674,11 +674,11 @@ post(path, body, Requests::CouponRedemptionCreate, **options) end # Delete the active coupon redemption from an account # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption remove_coupon_redemption api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::CouponRedemption] Coupon redemption deleted. @@ -697,11 +697,11 @@ delete(path, **options) end # List an account's credit payments # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :limit [Integer] Limit number of records 1-200. # :order [String] Sort order. @@ -734,11 +734,11 @@ pager(path, **options) end # List an account's invoices # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -789,11 +789,11 @@ pager(path, **options) end # Create an invoice for pending line items # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice create_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -820,11 +820,11 @@ post(path, body, Requests::InvoiceCreate, **options) end # Preview new invoice for pending line items # - # {https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice preview_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -851,11 +851,11 @@ post(path, body, Requests::InvoiceCreate, **options) end # List an account's line items # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items list_account_line_items api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -903,11 +903,11 @@ pager(path, **options) end # Create a new line item for the account # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_line_item create_line_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -935,11 +935,11 @@ post(path, body, Requests::LineItemCreate, **options) end # Fetch a list of an account's notes # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -969,11 +969,11 @@ pager(path, **options) end # Fetch an account note # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -996,11 +996,11 @@ get(path, **options) end # Fetch a list of an account's shipping addresses # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -1045,11 +1045,11 @@ pager(path, **options) end # Create a new shipping address for the account # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address create_shipping_address api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -1079,11 +1079,11 @@ post(path, body, Requests::ShippingAddressCreate, **options) end # Fetch an account's shipping address # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address get_shipping_address api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -1106,11 +1106,11 @@ get(path, **options) end # Update an account's shipping address # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address update_shipping_address api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: @@ -1140,11 +1140,11 @@ put(path, body, Requests::ShippingAddressUpdate, **options) end # Remove an account's shipping address # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address remove_shipping_address api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -1167,11 +1167,11 @@ delete(path, **options) end # List an account's subscriptions # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions list_account_subscriptions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -1222,11 +1222,11 @@ pager(path, **options) end # List an account's transactions # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions list_account_transactions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -1273,11 +1273,11 @@ pager(path, **options) end # List an account's child accounts # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts list_child_accounts api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -1327,11 +1327,11 @@ pager(path, **options) end # List a site's account acquisition data # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -1372,11 +1372,11 @@ pager(path, **options) end # List a site's coupons # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -1417,11 +1417,11 @@ pager(path, **options) end # Create a new coupon # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon create_coupon api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Coupon] A new coupon. @@ -1453,11 +1453,11 @@ post(path, body, Requests::CouponCreate, **options) end # Fetch a coupon # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon get_coupon api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Coupon] A coupon. @@ -1476,11 +1476,11 @@ get(path, **options) end # Update an active coupon # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_coupon update_coupon api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -1503,11 +1503,11 @@ put(path, body, Requests::CouponUpdate, **options) end # Expire a coupon # - # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon deactivate_coupon api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Coupon] The expired Coupon @@ -1526,11 +1526,11 @@ delete(path, **options) end # Generate unique coupon codes # - # {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_unique_coupon_codes api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_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 body [Requests::CouponBulkCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponBulkCreate} # @param params [Hash] Optional query string parameters: # @@ -1541,11 +1541,11 @@ post(path, body, Requests::CouponBulkCreate, **options) end # Restore an inactive coupon # - # {https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon restore_coupon api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -1556,11 +1556,11 @@ put(path, body, Requests::CouponUpdate, **options) end # List unique coupon codes associated with a bulk coupon # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes list_unique_coupon_codes api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -1594,11 +1594,11 @@ pager(path, **options) end # List a site's credit payments # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api documentation} # # @param params [Hash] Optional query string parameters: # :limit [Integer] Limit number of records 1-200. # :order [String] Sort order. # :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending @@ -1627,11 +1627,11 @@ pager(path, **options) end # Fetch a credit payment # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment get_credit_payment api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::CreditPayment] A credit payment. @@ -1641,11 +1641,11 @@ get(path, **options) end # List a site's custom field definitions # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -1687,11 +1687,11 @@ pager(path, **options) end # Fetch an custom field definition # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api documentation} # # @param custom_field_definition_id [String] Custom Field Definition ID # @param params [Hash] Optional query string parameters: # # @return [Resources::CustomFieldDefinition] An custom field definition. @@ -1712,13 +1712,13 @@ get(path, **options) end # List an invoice template's associated accounts # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts list_invoice_template_accounts api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts list_invoice_template_accounts api documentation} # - # @param invoice_template_id [String] Invoice template ID. + # @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+. # @param params [Hash] Optional query string parameters: # :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:* @@ -1755,11 +1755,11 @@ pager(path, **options) end # List a site's items # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -1801,11 +1801,11 @@ pager(path, **options) end # Create a new item # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_item create_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Item] A new item. @@ -1836,11 +1836,11 @@ post(path, body, Requests::ItemCreate, **options) end # Fetch an item # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_item get_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Item] An item. @@ -1859,11 +1859,11 @@ get(path, **options) end # Update an active item # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_item update_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -1890,11 +1890,11 @@ put(path, body, Requests::ItemUpdate, **options) end # Deactivate an item # - # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item deactivate_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Item] An item. @@ -1913,11 +1913,11 @@ delete(path, **options) end # Reactivate an inactive item # - # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item reactivate_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Item] An item. @@ -1936,11 +1936,11 @@ put(path, **options) end # List a site's measured units # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -1974,11 +1974,11 @@ pager(path, **options) end # Create a new measured unit # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit create_measured_unit api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::MeasuredUnit] A new measured unit. @@ -1988,11 +1988,11 @@ post(path, body, Requests::MeasuredUnitCreate, **options) end # Fetch a measured unit # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit get_measured_unit api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::MeasuredUnit] An item. @@ -2002,11 +2002,11 @@ get(path, **options) end # Update a measured unit # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit update_measured_unit api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2017,11 +2017,11 @@ put(path, body, Requests::MeasuredUnitUpdate, **options) end # Remove a measured unit # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit remove_measured_unit api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::MeasuredUnit] A measured unit. @@ -2031,11 +2031,11 @@ delete(path, **options) end # List a site's invoices # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -2082,11 +2082,11 @@ pager(path, **options) end # Fetch an invoice # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Invoice] An invoice. @@ -2105,11 +2105,11 @@ get(path, **options) end # Update an invoice # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_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::InvoiceUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdate} # @param params [Hash] Optional query string parameters: # @@ -2133,11 +2133,11 @@ put(path, body, Requests::InvoiceUpdate, **options) end # Fetch an invoice as a PDF # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::BinaryFile] An invoice as a PDF. @@ -2159,11 +2159,11 @@ get(path, **options) end # Collect a pending or past due, automatic invoice # - # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :body [Requests::InvoiceCollect] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCollect} # @@ -2183,11 +2183,11 @@ put(path, options[:body], Requests::InvoiceCollect, **options) end # Mark an open invoice as failed # - # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed 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 params [Hash] Optional query string parameters: # # @return [Resources::Invoice] The updated invoice. @@ -2206,11 +2206,11 @@ put(path, **options) end # Mark an open invoice as successful # - # {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Invoice] The updated invoice. @@ -2229,11 +2229,11 @@ put(path, **options) end # Reopen a closed, manual invoice # - # {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Invoice] The updated invoice. @@ -2252,11 +2252,11 @@ put(path, **options) end # Void a credit invoice. # - # {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Invoice] The updated invoice. @@ -2275,11 +2275,11 @@ put(path, **options) end # Record an external payment for a manual invoices. # - # {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2290,11 +2290,11 @@ post(path, body, Requests::ExternalTransaction, **options) end # List an invoice's line items # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -2342,11 +2342,11 @@ pager(path, **options) end # Show the coupon redemptions applied to an invoice # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -2389,11 +2389,11 @@ pager(path, **options) end # List an invoice's related credit or charge invoices # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Pager<Resources::Invoice>] A list of the credit or charge invoices associated with the invoice. @@ -2414,11 +2414,11 @@ pager(path, **options) end # Refund an invoice # - # {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2445,11 +2445,11 @@ post(path, body, Requests::InvoiceRefund, **options) end # List a site's line items # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -2495,11 +2495,11 @@ pager(path, **options) end # Fetch a line item # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api documentation} # # @param line_item_id [String] Line Item ID. # @param params [Hash] Optional query string parameters: # # @return [Resources::LineItem] A line item. @@ -2518,11 +2518,11 @@ get(path, **options) end # Delete an uninvoiced line item # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api documentation} # # @param line_item_id [String] Line Item ID. # @param params [Hash] Optional query string parameters: # # @return [Resources::Empty] Line item deleted. @@ -2543,11 +2543,11 @@ delete(path, **options) end # List a site's plans # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -2589,11 +2589,11 @@ pager(path, **options) end # Create a plan # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan create_plan api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Plan] A plan. @@ -2629,11 +2629,11 @@ post(path, body, Requests::PlanCreate, **options) end # Fetch a plan # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan get_plan api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Plan] A plan. @@ -2652,11 +2652,11 @@ get(path, **options) end # Update a plan # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan update_plan api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2679,11 +2679,11 @@ put(path, body, Requests::PlanUpdate, **options) end # Remove a plan # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan remove_plan api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Plan] Plan deleted @@ -2702,11 +2702,11 @@ delete(path, **options) end # List a plan's add-ons # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons list_plan_add_ons api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -2752,11 +2752,11 @@ pager(path, **options) end # Create an add-on # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on create_plan_add_on api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2787,11 +2787,11 @@ post(path, body, Requests::AddOnCreate, **options) end # Fetch a plan's add-on # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_plan_add_on get_plan_add_on api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2813,11 +2813,11 @@ get(path, **options) end # Update an add-on # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_plan_add_on update_plan_add_on api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: @@ -2845,11 +2845,11 @@ put(path, body, Requests::AddOnUpdate, **options) end # Remove an add-on # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan_add_on remove_plan_add_on api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -2872,11 +2872,11 @@ delete(path, **options) end # List a site's add-ons # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -2920,11 +2920,11 @@ pager(path, **options) end # Fetch an add-on # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_add_on get_add_on api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::AddOn] An add-on. @@ -2943,11 +2943,11 @@ get(path, **options) end # List a site's shipping methods # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -2990,11 +2990,11 @@ pager(path, **options) end # Create a new shipping method # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_method create_shipping_method api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::ShippingMethod] A new shipping method. @@ -3004,11 +3004,11 @@ post(path, body, Requests::ShippingMethodCreate, **options) end # Fetch a shipping method # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_shipping_method api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_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 params [Hash] Optional query string parameters: # # @return [Resources::ShippingMethod] A shipping method. @@ -3018,11 +3018,11 @@ get(path, **options) end # Update an active Shipping Method # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_method update_shipping_method api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -3033,11 +3033,11 @@ put(path, body, Requests::ShippingMethodUpdate, **options) end # Deactivate a shipping method # - # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_shipping_method deactivate_shipping_method api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::ShippingMethod] A shipping method. @@ -3047,11 +3047,11 @@ delete(path, **options) end # List a site's subscriptions # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -3098,11 +3098,11 @@ pager(path, **options) end # Create a new subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription create_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Subscription] A subscription. @@ -3131,11 +3131,11 @@ post(path, body, Requests::SubscriptionCreate, **options) end # Fetch a subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription get_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Subscription] A subscription. @@ -3156,11 +3156,11 @@ get(path, **options) end # Update a subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_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 params [Hash] Optional query string parameters: # @@ -3187,11 +3187,11 @@ put(path, body, Requests::SubscriptionUpdate, **options) end # Terminate a subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/terminate_subscription terminate_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :refund [String] The type of refund to perform: # @@ -3223,11 +3223,11 @@ delete(path, **options) end # Cancel a subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/cancel_subscription cancel_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :body [Requests::SubscriptionCancel] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCancel} # @@ -3249,11 +3249,11 @@ put(path, options[:body], Requests::SubscriptionCancel, **options) end # Reactivate a canceled subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_subscription reactivate_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Subscription] An active subscription. @@ -3274,11 +3274,11 @@ put(path, **options) end # Pause subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/pause_subscription pause_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -3304,11 +3304,11 @@ put(path, body, Requests::SubscriptionPause, **options) end # Resume subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/resume_subscription resume_subscription api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Subscription] A subscription. @@ -3329,11 +3329,11 @@ put(path, **options) end # Convert trial subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/convert_trial convert_trial api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Subscription] A subscription. @@ -3343,11 +3343,11 @@ put(path, **options) end # Fetch a preview of a subscription's renewal invoice(s) # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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+. # @param params [Hash] Optional query string parameters: # # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s). @@ -3357,11 +3357,11 @@ get(path, **options) end # Fetch a subscription's pending change # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::SubscriptionChange] A subscription's pending change. @@ -3382,11 +3382,11 @@ get(path, **options) end # Create a new subscription change # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription_change create_subscription_change api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -3413,11 +3413,11 @@ post(path, body, Requests::SubscriptionChangeCreate, **options) end # Delete the pending subscription change # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_change remove_subscription_change api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Empty] Subscription change was deleted. @@ -3438,11 +3438,11 @@ delete(path, **options) end # Preview a new subscription change # - # {https://developers.recurly.com/api/v2021-02-25#operation/preview_subscription_change preview_subscription_change api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -3453,11 +3453,11 @@ post(path, body, Requests::SubscriptionChangeCreate, **options) end # List a subscription's invoices # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_invoices list_subscription_invoices api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -3508,11 +3508,11 @@ pager(path, **options) end # List a subscription's line items # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_line_items list_subscription_line_items api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -3560,11 +3560,11 @@ pager(path, **options) end # Show the coupon redemptions for a subscription # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :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+. @@ -3607,11 +3607,11 @@ pager(path, **options) end # List a subscription add-on's usage records # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using @@ -3647,11 +3647,11 @@ pager(path, **options) end # Log a usage record on this subscription add-on # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_usage create_usage api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: @@ -3663,11 +3663,11 @@ post(path, body, Requests::UsageCreate, **options) end # Get a usage record # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api documentation} # # @param usage_id [String] Usage Record ID. # @param params [Hash] Optional query string parameters: # # @return [Resources::Usage] The usage record. @@ -3677,11 +3677,11 @@ get(path, **options) end # Update a usage record # - # {https://developers.recurly.com/api/v2021-02-25#operation/update_usage update_usage api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # @@ -3692,11 +3692,11 @@ put(path, body, Requests::UsageCreate, **options) end # Delete a usage record. # - # {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api documentation} # # @param usage_id [String] Usage Record ID. # @param params [Hash] Optional query string parameters: # # @return [Resources::Empty] Usage was successfully deleted. @@ -3706,11 +3706,11 @@ delete(path, **options) end # List a site's transactions # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api documentation} # # @param params [Hash] Optional query string parameters: # :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+. # @@ -3753,11 +3753,11 @@ pager(path, **options) end # Fetch a transaction # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_transaction get_transaction api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::Transaction] A transaction. @@ -3776,11 +3776,11 @@ get(path, **options) end # Fetch a unique coupon code # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_unique_coupon_code get_unique_coupon_code api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::UniqueCouponCode] A unique coupon code. @@ -3790,11 +3790,11 @@ get(path, **options) end # Deactivate a unique coupon code # - # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::UniqueCouponCode] A unique coupon code. @@ -3804,11 +3804,11 @@ delete(path, **options) end # Restore a unique coupon code # - # {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::UniqueCouponCode] A unique coupon code. @@ -3818,11 +3818,11 @@ put(path, **options) end # Create a new purchase # - # {https://developers.recurly.com/api/v2021-02-25#operation/create_purchase create_purchase api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::InvoiceCollection] Returns the new invoices @@ -3858,11 +3858,11 @@ post(path, body, Requests::PurchaseCreate, **options) end # Preview a new purchase # - # {https://developers.recurly.com/api/v2021-02-25#operation/preview_purchase preview_purchase api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::InvoiceCollection] Returns preview of the new invoices @@ -3896,13 +3896,55 @@ def preview_purchase(body:, **options) path = "/purchases/preview" post(path, body, Requests::PurchaseCreate, **options) end + # Create a pending purchase + # + # {https://developers.recurly.com/api/v2021-02-25#operation/create_pending_purchase create_pending_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 params [Hash] Optional query string parameters: + # + # @return [Resources::InvoiceCollection] Returns the pending invoice + # @example + # begin + # purchase = { + # currency: 'EUR', + # account: { + # code: account_code, + # email: 'benjamin@example.com', + # billing_info: { + # first_name: 'Benjamin', + # last_name: 'Du Monde', + # online_banking_payment_type: 'ideal' + # }, + # }, + # line_items: [ + # { + # currency: 'EUR', + # unit_amount: 1000, + # type: 'charge' + # } + # ] + # } + # invoice_collection = @client.create_pending_purchase(body: purchase) + # puts "Created ChargeInvoice with UUID: #{invoice_collection.charge_invoice.uuid}" + # rescue Recurly::Errors::ValidationError => e + # # If the request was invalid, you may want to tell your user + # # why. You can find the invalid params and reasons in e.recurly_error.params + # puts "ValidationError: #{e.recurly_error.params}" + # end + # + def create_pending_purchase(body:, **options) + path = "/purchases/pending" + post(path, body, Requests::PurchaseCreate, **options) + end + # List the dates that have an available export to download. # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documentation} # # @param params [Hash] Optional query string parameters: # # @return [Resources::ExportDates] Returns a list of dates. # @example @@ -3922,11 +3964,11 @@ get(path, **options) end # List of the export files that are available to download. # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_files get_export_files api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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 params [Hash] Optional query string parameters: # # @return [Resources::ExportFiles] Returns a list of export files to download. @@ -3947,11 +3989,11 @@ get(path, **options) end # Show the dunning campaigns for a site # - # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documentation} # # @param params [Hash] Optional query string parameters: # :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. @@ -3964,11 +4006,11 @@ pager(path, **options) end # Show the settings for a dunning campaign # - # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documenation} + # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation} # # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+. # @param params [Hash] Optional query string parameters: # # @return [Resources::DunningCampaign] Settings for a dunning campaign. @@ -3978,18 +4020,49 @@ get(path, **options) end # Assign a dunning campaign to multiple plans # - # {https://developers.recurly.com/api/v2021-02-25#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documenation} + # {https://developers.recurly.com/api/v2021-02-25#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} # @param params [Hash] Optional query string parameters: # # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans. # def put_dunning_campaign_bulk_update(body:, **options) path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update" put(path, body, Requests::DunningCampaignsBulkUpdate, **options) + end + + # Show the invoice templates for a site + # + # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_templates list_invoice_templates api documentation} + # + # @param params [Hash] Optional query string parameters: + # :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::InvoiceTemplate>] A list of the the invoice templates on a site. + # + def list_invoice_templates(**options) + path = "/invoice_templates" + pager(path, **options) + end + + # Show the settings for an invoice template + # + # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_template get_invoice_template api documentation} + # + # @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+. + # @param params [Hash] Optional query string parameters: + # + # @return [Resources::InvoiceTemplate] Settings for an invoice template. + # + def get_invoice_template(invoice_template_id:, **options) + path = interpolate_path("/invoice_templates/{invoice_template_id}", invoice_template_id: invoice_template_id) + get(path, **options) end end end