diff --git a/docs/index.html b/docs/index.html index 377073ef..04126507 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2432,7 +2432,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -2685,7 +2685,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -4233,7 +4233,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -4703,7 +4703,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -4904,7 +4904,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -5375,7 +5375,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -5744,7 +5744,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -6003,7 +6003,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -6704,7 +6704,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -6936,7 +6936,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -7181,7 +7181,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -7428,7 +7428,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -7626,7 +7626,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -8207,7 +8207,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -8405,7 +8405,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -8672,7 +8672,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -8988,7 +8988,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -9737,7 +9737,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -10311,7 +10311,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -10326,9 +10326,10 @@

- - - options.params.body + + + + options.body InvoiceCollect @@ -10338,9 +10339,6 @@

- - - @@ -10843,7 +10841,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -11094,7 +11092,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -11492,7 +11490,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -11928,7 +11926,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -12591,7 +12589,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -13206,7 +13204,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -13499,7 +13497,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -13780,7 +13778,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -14345,7 +14343,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -14500,7 +14498,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -14515,9 +14513,10 @@

- - - options.params.body + + + + options.body SubscriptionCancel @@ -14527,9 +14526,6 @@

- - - @@ -15327,7 +15323,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -15560,7 +15556,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -15811,7 +15807,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request @@ -15985,7 +15981,7 @@

= {} - Optional configurations for the request (Currently only params is supported) + Optional configurations for the request diff --git a/lib/recurly/Client.js b/lib/recurly/Client.js index d4b6c71e..a2efd09f 100644 --- a/lib/recurly/Client.js +++ b/lib/recurly/Client.js @@ -32,7 +32,7 @@ class Client extends BaseClient { * console.log(site.subdomain) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -87,7 +87,7 @@ class Client extends BaseClient { * console.log(account.code) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -519,7 +519,7 @@ class Client extends BaseClient { * * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -625,7 +625,7 @@ class Client extends BaseClient { * } * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {number} options.params.limit - Limit number of records 1-200. * @param {string} options.params.order - Sort order. @@ -654,7 +654,7 @@ class Client extends BaseClient { * * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -775,7 +775,7 @@ class Client extends BaseClient { * * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -861,7 +861,7 @@ class Client extends BaseClient { * } * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -928,7 +928,7 @@ class Client extends BaseClient { * } * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1107,7 +1107,7 @@ class Client extends BaseClient { * * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1154,7 +1154,7 @@ class Client extends BaseClient { * * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1197,7 +1197,7 @@ class Client extends BaseClient { * * * @param {string} accountId - Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1242,7 +1242,7 @@ class Client extends BaseClient { * API docs: {@link https://developers.recurly.com/api/v2019-10-10#operation/list_account_acquisition} * * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1288,7 +1288,7 @@ class Client extends BaseClient { * console.log(coupon.code) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1405,7 +1405,7 @@ class Client extends BaseClient { * * * @param {string} couponId - Coupon ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-10off`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1451,7 +1451,7 @@ class Client extends BaseClient { * console.log(payment.uuid) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {number} options.params.limit - Limit number of records 1-200. * @param {string} options.params.order - Sort order. @@ -1500,7 +1500,7 @@ class Client extends BaseClient { * console.log(definition.displayName) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1577,7 +1577,7 @@ class Client extends BaseClient { * console.log(item.code) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1789,7 +1789,7 @@ class Client extends BaseClient { * console.log(invoice.number) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -1956,9 +1956,9 @@ class Client extends BaseClient { * } * * @param {string} invoiceId - Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. - * @param {InvoiceCollect} options.params.body - The object representing the JSON request to send to the server. It should conform to the schema of {InvoiceCollect} + * @param {InvoiceCollect} options.body - The object representing the JSON request to send to the server. It should conform to the schema of {InvoiceCollect} * @return {Promise} The updated invoice. */ async collectInvoice (invoiceId, options = {}) { @@ -2081,7 +2081,7 @@ class Client extends BaseClient { * * * @param {string} invoiceId - Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2125,7 +2125,7 @@ class Client extends BaseClient { * * * @param {string} invoiceId - Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2228,7 +2228,7 @@ class Client extends BaseClient { * console.log(`Item ${item.id} for ${item.amount}`) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2337,7 +2337,7 @@ class Client extends BaseClient { * console.log(plan.code) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2513,7 +2513,7 @@ class Client extends BaseClient { * * * @param {string} planId - Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2619,7 +2619,7 @@ class Client extends BaseClient { * API docs: {@link https://developers.recurly.com/api/v2019-10-10#operation/list_add_ons} * * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2675,7 +2675,7 @@ class Client extends BaseClient { * API docs: {@link https://developers.recurly.com/api/v2019-10-10#operation/list_shipping_methods} * * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2736,7 +2736,7 @@ class Client extends BaseClient { * console.log(subscription.uuid) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -2901,7 +2901,7 @@ class Client extends BaseClient { * } * * @param {string} subscriptionId - Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {string} options.params.refund - The type of refund to perform: * @@ -2943,9 +2943,9 @@ class Client extends BaseClient { * } * * @param {string} subscriptionId - Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. - * @param {SubscriptionCancel} options.params.body - The object representing the JSON request to send to the server. It should conform to the schema of {SubscriptionCancel} + * @param {SubscriptionCancel} options.body - The object representing the JSON request to send to the server. It should conform to the schema of {SubscriptionCancel} * @return {Promise} A canceled or failed subscription. */ async cancelSubscription (subscriptionId, options = {}) { @@ -3135,7 +3135,7 @@ class Client extends BaseClient { * * * @param {string} subscriptionId - Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -3182,7 +3182,7 @@ class Client extends BaseClient { * * * @param {string} subscriptionId - Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -3226,7 +3226,7 @@ class Client extends BaseClient { * * * @param {string} subscriptionId - Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`. - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. @@ -3270,7 +3270,7 @@ class Client extends BaseClient { * console.log(transaction.uuid) * } * - * @param {Object} options - Optional configurations for the request (Currently only params is supported) + * @param {Object} options - Optional configurations for the request * @param {Object} options.params - The optional url parameters for this request. * @param {Array.} options.params.ids - Filter results by their IDs. Up to 200 IDs can be passed at once using * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.