Merge pull request #118 from recurly/v3-v2019-10-10

Latest Features

lib/recurly.d.ts

@@ -335,6 +335,10 @@ export interface PaymentMethod {
    * Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
    */
   billingAgreementId: string | null;
+  /**
+   * The name associated with the bank account.
+   */
+  nameOnAccount: string | null;
   /**
    * The bank account type. Only present for ACH payment methods.
    */
@@ -1290,7 +1294,7 @@ export interface LineItem {
    */
   accountingCode: string | null;
   /**
-   * For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line itmes it will be the item's `external_sku`.
+   * For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.
    */
   productCode: string | null;
   /**
@@ -1774,6 +1778,10 @@ export interface SubscriptionAddOn {
    * This is priced in the subscription's currency.
    */
   unitAmount: number | null;
+  /**
+   * Revenue schedule type
+   */
+  revenueScheduleType: string | null;
   /**
    * The type of tiering used by the Add-on.
    */
@@ -2291,6 +2299,10 @@ export interface ShippingMethod {
    * The name of the shipping method displayed to customers.
    */
   name: string | null;
+  /**
+   * Accounting code for shipping method.
+   */
+  accountingCode: string | null;
   /**
    * Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are:  - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable 
    */
@@ -2356,6 +2368,7 @@ export declare class Client {
    *   order. In descending order updated records will move behind the cursor and could
    *   prevent some records from being returned.
    *   
+   * @param params.state - Filter by state.
    * @return {Pager<Site>} A list of sites.
    */
   listSites(params?: object): Pager<Site>;

lib/recurly/Client.js

@@ -52,6 +52,7 @@ class Client extends BaseClient {
    *   order. In descending order updated records will move behind the cursor and could
    *   prevent some records from being returned.
    *
+   * @param {string} options.params.state - Filter by state.
    * @return {Pager<Site>} A list of sites.
    */
   listSites (options = {}) {

lib/recurly/resources/LineItem.js

@@ -37,7 +37,7 @@ const Resource = require('../Resource')
  * @prop {string} planCode - If the line item is a charge or credit for a plan or add-on, this is the plan's code.
  * @prop {string} planId - If the line item is a charge or credit for a plan or add-on, this is the plan's ID.
  * @prop {string} previousLineItemId - Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
- * @prop {string} productCode - For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line itmes it will be the item's `external_sku`.
+ * @prop {string} productCode - For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.
  * @prop {number} prorationRate - When a line item has been prorated, this is the rate of the proration. Proration rates were made available for line items created after March 30, 2017. For line items created prior to that date, the proration rate will be `null`, even if the line item was prorated.
  * @prop {number} quantity - This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
  * @prop {boolean} refund - Refund?

lib/recurly/resources/PaymentMethod.js

@@ -22,6 +22,7 @@ const Resource = require('../Resource')
  * @prop {string} gatewayToken - A token used in place of a credit card in order to perform transactions.
  * @prop {string} lastFour - Credit card number's last four digits. Will refer to bank account if payment method is ACH.
  * @prop {string} lastTwo - The IBAN bank account's last two digits.
+ * @prop {string} nameOnAccount - The name associated with the bank account.
  * @prop {string} object
  * @prop {string} routingNumber - The bank account's routing number. Only present for ACH payment methods.
  * @prop {string} routingNumberBank - The bank name of this routing number.
@@ -39,6 +40,7 @@ class PaymentMethod extends Resource {
       gatewayToken: String,
       lastFour: String,
       lastTwo: String,
+      nameOnAccount: String,
       object: String,
       routingNumber: String,
       routingNumberBank: String

lib/recurly/resources/ShippingMethod.js

@@ -12,6 +12,7 @@ const Resource = require('../Resource')
 /**
  * ShippingMethod
  * @typedef {Object} ShippingMethod
+ * @prop {string} accountingCode - Accounting code for shipping method.
  * @prop {string} code - The internal name used identify the shipping method.
  * @prop {Date} createdAt - Created at
  * @prop {Date} deletedAt - Deleted at
@@ -24,6 +25,7 @@ const Resource = require('../Resource')
 class ShippingMethod extends Resource {
   static getSchema () {
     return {
+      accountingCode: String,
       code: String,
       createdAt: Date,
       deletedAt: Date,

lib/recurly/resources/SubscriptionAddOn.js

@@ -18,6 +18,7 @@ const Resource = require('../Resource')
  * @prop {string} id - Subscription Add-on ID
  * @prop {string} object - Object type
  * @prop {number} quantity - Add-on quantity
+ * @prop {string} revenueScheduleType - Revenue schedule type
  * @prop {string} subscriptionId - Subscription ID
  * @prop {string} tierType - The type of tiering used by the Add-on.
  * @prop {Array.<SubscriptionAddOnTier>} tiers - Empty unless `tier_type` is `tiered`, `volume`, or `stairstep`.
@@ -33,6 +34,7 @@ class SubscriptionAddOn extends Resource {
       id: String,
       object: String,
       quantity: Number,
+      revenueScheduleType: String,
       subscriptionId: String,
       tierType: String,
       tiers: ['SubscriptionAddOnTier'],