Merge pull request #364 from recurly/v3-v2021-02-25-21650785939

Generated Latest Changes for v2021-02-25

Author: cbarton

lib/recurly.d.ts

@@ -983,6 +983,10 @@ export declare class CouponRedemption {
    * Will always be `coupon`.
    */
   object?: string | null;
+  /**
+   * The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+   */
+  uuid?: string | null;
   /**
    * The Account on which the coupon was applied.
    */
@@ -2110,6 +2114,10 @@ export declare class InvoiceCollection {
    * Credit invoices
    */
   creditInvoices?: Invoice[] | null;
+  /**
+   * Verification transactions (used for free trial payment method validation)
+   */
+  verificationTransactions?: Transaction[] | null;
 
 }
 
@@ -2295,7 +2303,7 @@ export declare class Subscription {
    */
   netTermsType?: string | null;
   /**
-   * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. 
+   * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. 
    */
   creditApplicationPolicy?: CreditApplicationPolicy | null;
   /**
@@ -2765,6 +2773,10 @@ export declare class CreditApplicationPolicy {
    * Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically 
    */
   mode?: string | null;
+  /**
+   * Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`. 
+   */
+  allowedOrigins?: string[] | null;
 
 }
 
@@ -4737,7 +4749,7 @@ export interface InvoiceCreate {
     */
   netTermsType?: string | null;
   /**
-    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. 
+    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. 
     */
   creditApplicationPolicy?: CreditApplicationPolicy | null;
   /**
@@ -4764,6 +4776,10 @@ export interface CreditApplicationPolicy {
     * Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically 
     */
   mode?: string | null;
+  /**
+    * Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`. 
+    */
+  allowedOrigins?: string[] | null;
 
 }
 
@@ -6538,7 +6554,7 @@ export interface SubscriptionCreate {
     */
   netTermsType?: string | null;
   /**
-    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. 
+    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. 
     */
   creditApplicationPolicy?: CreditApplicationPolicy | null;
   /**
@@ -6735,7 +6751,7 @@ export interface SubscriptionUpdate {
     */
   netTermsType?: string | null;
   /**
-    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. 
+    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. 
     */
   creditApplicationPolicy?: CreditApplicationPolicy | null;
   /**
@@ -7019,7 +7035,7 @@ export interface PurchaseCreate {
     */
   netTermsType?: string | null;
   /**
-    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. 
+    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. 
     */
   creditApplicationPolicyOverride?: CreditApplicationPolicy | null;
   /**
@@ -7263,7 +7279,7 @@ export interface SubscriptionPurchase {
     */
   rampIntervals?: SubscriptionRampInterval[] | null;
   /**
-    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. 
+    * Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. 
     */
   creditApplicationPolicy?: CreditApplicationPolicy | null;
   /**
@@ -8062,6 +8078,28 @@ export declare class Client {
    * @return {Promise<CouponRedemption>} Coupon redemption deleted.
    */
   removeCouponRedemption(accountId: string): Promise<CouponRedemption>;
+  /**
+   * Show the coupon redemption
+   *
+   * API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_coupon_redemption
+   *
+   * 
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} A coupon redemption.
+   */
+  getCouponRedemption(accountId: string, couponRedemptionId: string): Promise<CouponRedemption>;
+  /**
+   * Delete the coupon redemption
+   *
+   * API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption_by_id
+   *
+   * 
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} Coupon redemption deleted.
+   */
+  removeCouponRedemptionById(accountId: string, couponRedemptionId: string): Promise<CouponRedemption>;
   /**
    * List an account's credit payments
    *
@@ -11243,6 +11281,28 @@ endpoint to obtain only the newly generated `UniqueCouponCodes`.
    * @return {Pager<CouponRedemption>} A list of the the coupon redemptions on a subscription.
    */
   listSubscriptionCouponRedemptions(subscriptionId: string, options?: object): Pager<CouponRedemption>;
+  /**
+   * Show the coupon redemption for a subscription
+   *
+   * API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_coupon_redemption
+   *
+   * 
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} The coupon redemption on a subscription.
+   */
+  getSubscriptionCouponRedemption(subscriptionId: string, couponRedemptionId: string): Promise<CouponRedemption>;
+  /**
+   * Delete the coupon redemption from a subscription
+   *
+   * API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_coupon_redemption
+   *
+   * 
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} Coupon redemption deleted.
+   */
+  removeSubscriptionCouponRedemption(subscriptionId: string, couponRedemptionId: string): Promise<CouponRedemption>;
   /**
    * List a subscription add-on's usage records
    *

lib/recurly/Client.js

@@ -833,6 +833,38 @@ class Client extends BaseClient {
     return this._makeRequest('DELETE', path, null, options)
   }
 
+  /**
+   * Show the coupon redemption
+   *
+   * API docs: {@link https://developers.recurly.com/api/v2021-02-25#operation/get_coupon_redemption}
+   *
+   *
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} A coupon redemption.
+   */
+  async getCouponRedemption (accountId, couponRedemptionId, options = {}) {
+    let path = '/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}'
+    path = this._interpolatePath(path, { 'account_id': accountId, 'coupon_redemption_id': couponRedemptionId })
+    return this._makeRequest('GET', path, null, options)
+  }
+
+  /**
+   * Delete the coupon redemption
+   *
+   * API docs: {@link https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption_by_id}
+   *
+   *
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} Coupon redemption deleted.
+   */
+  async removeCouponRedemptionById (accountId, couponRedemptionId, options = {}) {
+    let path = '/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}'
+    path = this._interpolatePath(path, { 'account_id': accountId, 'coupon_redemption_id': couponRedemptionId })
+    return this._makeRequest('DELETE', path, null, options)
+  }
+
   /**
    * List an account's credit payments
    *
@@ -4642,6 +4674,38 @@ endpoint to obtain only the newly generated `UniqueCouponCodes`.
     return new Pager(this, path, options)
   }
 
+  /**
+   * Show the coupon redemption for a subscription
+   *
+   * API docs: {@link https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_coupon_redemption}
+   *
+   *
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} The coupon redemption on a subscription.
+   */
+  async getSubscriptionCouponRedemption (subscriptionId, couponRedemptionId, options = {}) {
+    let path = '/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}'
+    path = this._interpolatePath(path, { 'subscription_id': subscriptionId, 'coupon_redemption_id': couponRedemptionId })
+    return this._makeRequest('GET', path, null, options)
+  }
+
+  /**
+   * Delete the coupon redemption from a subscription
+   *
+   * API docs: {@link https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_coupon_redemption}
+   *
+   *
+   * @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 {string} couponRedemptionId - Coupon Redemption ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
+   * @return {Promise<CouponRedemption>} Coupon redemption deleted.
+   */
+  async removeSubscriptionCouponRedemption (subscriptionId, couponRedemptionId, options = {}) {
+    let path = '/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}'
+    path = this._interpolatePath(path, { 'subscription_id': subscriptionId, 'coupon_redemption_id': couponRedemptionId })
+    return this._makeRequest('DELETE', path, null, options)
+  }
+
   /**
    * List a subscription add-on's usage records
    *

lib/recurly/resources/CouponRedemption.js

@@ -23,6 +23,7 @@ const Resource = require('../Resource')
  * @prop {string} state - Coupon Redemption state
  * @prop {string} subscriptionId - Subscription ID
  * @prop {Date} updatedAt - Last updated at
+ * @prop {string} uuid - The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
  */
 class CouponRedemption extends Resource {
   static getSchema () {
@@ -37,7 +38,8 @@ class CouponRedemption extends Resource {
       removedAt: Date,
       state: String,
       subscriptionId: String,
-      updatedAt: Date
+      updatedAt: Date,
+      uuid: String
     }
   }
 }

lib/recurly/resources/CreditApplicationPolicy.js

@@ -12,11 +12,13 @@ const Resource = require('../Resource')
 /**
  * CreditApplicationPolicy
  * @typedef {Object} CreditApplicationPolicy
+ * @prop {Array.<string>} allowedOrigins - Optional array of credit invoice origin types to allow when mode is `all`. If not specified when mode is `all`, credits from all origins are applied. Only valid when mode is `all`.
  * @prop {string} mode - Determines which credit invoices are applied to invoices: - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
  */
 class CreditApplicationPolicy extends Resource {
   static getSchema () {
     return {
+      allowedOrigins: Array,
       mode: String
     }
   }

lib/recurly/resources/InvoiceCollection.js

@@ -15,13 +15,15 @@ const Resource = require('../Resource')
  * @prop {Invoice} chargeInvoice
  * @prop {Array.<Invoice>} creditInvoices - Credit invoices
  * @prop {string} object - Object type
+ * @prop {Array.<Transaction>} verificationTransactions - Verification transactions (used for free trial payment method validation)
  */
 class InvoiceCollection extends Resource {
   static getSchema () {
     return {
       chargeInvoice: 'Invoice',
       creditInvoices: ['Invoice'],
-      object: String
+      object: String,
+      verificationTransactions: ['Transaction']
     }
   }
 }

lib/recurly/resources/Subscription.js

@@ -27,7 +27,7 @@ const Resource = require('../Resource')
  * @prop {Date} convertedAt - When the subscription was converted from a gift card.
  * @prop {Array.<CouponRedemptionMini>} couponRedemptions - Returns subscription level coupon redemptions that are tied to this subscription.
  * @prop {Date} createdAt - Created at
- * @prop {CreditApplicationPolicy} creditApplicationPolicy - Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior.
+ * @prop {CreditApplicationPolicy} creditApplicationPolicy - Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied.
  * @prop {string} currency - 3-letter ISO 4217 currency code.
  * @prop {Date} currentPeriodEndsAt - Current billing period ends at
  * @prop {Date} currentPeriodStartedAt - Current billing period started at