Merge pull request #331 from recurly/v3-v2019-10-10-9227329778

Generated Latest Changes for v2019-10-10

lib/recurly.d.ts

@@ -80,6 +80,10 @@ export declare class Address {
    * Country, 2-letter ISO 3166-1 alpha-2 code.
    */
   country?: string | null;
+  /**
+   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   */
+  geoCode?: string | null;
 
 }
 
@@ -223,6 +227,10 @@ export declare class Account {
    * The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
    */
   customFields?: CustomField[] | null;
+  /**
+   * The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+   */
+  entityUseCode?: string | null;
 
 }
 
@@ -261,6 +269,10 @@ export declare class ShippingAddress {
    * Country, 2-letter ISO 3166-1 alpha-2 code.
    */
   country?: string | null;
+  /**
+   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   */
+  geoCode?: string | null;
   /**
    * Created at
    */
@@ -355,6 +367,10 @@ export declare class PaymentMethod {
    * Gateway specific attributes associated with this PaymentMethod
    */
   gatewayAttributes?: GatewayAttributes | null;
+  /**
+   * Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
+   */
+  cardNetworkPreference?: string | null;
   /**
    * Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
    */
@@ -380,7 +396,7 @@ export declare class PaymentMethod {
 
 export declare class GatewayAttributes {
   /**
-   * Used by Adyen gateways. The Shopper Reference value used when the external token was created.
+   * Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. For Braintree the PayPal PayerID is populated in the response.
    */
   accountReference?: string | null;
 
@@ -1280,6 +1296,10 @@ export declare class InvoiceAddress {
    * Country, 2-letter ISO 3166-1 alpha-2 code.
    */
   country?: string | null;
+  /**
+   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   */
+  geoCode?: string | null;
 
 }
 
@@ -2102,6 +2122,14 @@ export declare class SubscriptionRampIntervalResponse {
    * Represents how many billing cycles are left in a ramp interval.
    */
   remainingBillingCycles?: number | null;
+  /**
+   * Date the ramp interval starts
+   */
+  startingOn?: Date | null;
+  /**
+   * Date the ramp interval ends
+   */
+  endingOn?: Date | null;
   /**
    * Represents the price for the ramp interval.
    */
@@ -3082,6 +3110,10 @@ export interface AccountCreate {
     * The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
     */
   customFields?: CustomField[] | null;
+  /**
+    * The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+    */
+  entityUseCode?: string | null;
 
 }
 
@@ -3140,6 +3172,10 @@ export interface ShippingAddressCreate {
     * Country, 2-letter ISO 3166-1 alpha-2 code.
     */
   country?: string | null;
+  /**
+    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    */
+  geoCode?: string | null;
 
 }
 
@@ -3180,6 +3216,10 @@ export interface Address {
     * Country, 2-letter ISO 3166-1 alpha-2 code.
     */
   country?: string | null;
+  /**
+    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    */
+  geoCode?: string | null;
 
 }
 
@@ -3241,6 +3281,10 @@ export interface BillingInfoCreate {
     * Additional attributes to send to the gateway.
     */
   gatewayAttributes?: GatewayAttributes | null;
+  /**
+    * Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
+    */
+  cardNetworkPreference?: string | null;
   /**
     * Amazon billing agreement ID
     */
@@ -3249,6 +3293,10 @@ export interface BillingInfoCreate {
     * PayPal billing agreement ID
     */
   paypalBillingAgreementId?: string | null;
+  /**
+    * Roku's CIB if billing through Roku
+    */
+  rokuBillingAgreementId?: string | null;
   /**
     * Fraud Session ID
     */
@@ -3310,7 +3358,7 @@ export interface BillingInfoCreate {
 
 export interface GatewayAttributes {
   /**
-    * Used by Adyen gateways. The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code.
+    * Used by Adyen and Braintree gateways. For Adyen The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code. For Braintree the PayPal PayerID is populated in the response.
     */
   accountReference?: string | null;
 
@@ -3390,6 +3438,10 @@ export interface AccountUpdate {
     * The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
     */
   customFields?: CustomField[] | null;
+  /**
+    * The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+    */
+  entityUseCode?: string | null;
 
 }
 
@@ -3564,6 +3616,10 @@ export interface ShippingAddressUpdate {
     * Country, 2-letter ISO 3166-1 alpha-2 code.
     */
   country?: string | null;
+  /**
+    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    */
+  geoCode?: string | null;
 
 }
 
@@ -3933,6 +3989,10 @@ export interface InvoiceAddress {
     * Country, 2-letter ISO 3166-1 alpha-2 code.
     */
   country?: string | null;
+  /**
+    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    */
+  geoCode?: string | null;
 
 }
 
@@ -5089,6 +5149,10 @@ export interface AccountPurchase {
     * The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
     */
   customFields?: CustomField[] | null;
+  /**
+    * The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+    */
+  entityUseCode?: string | null;
 
 }
 
@@ -5908,6 +5972,7 @@ export declare class Client {
    *   * Records are returned in an arbitrary order. Since results are all
    *     returned at once you can sort the records yourself.
    *   
+   * @param {string} options.state - Invoice state.
    * @param {number} options.limit - Limit number of records 1-200.
    * @param {string} options.order - Sort order.
    * @param {string} options.sort - Sort field. You *really* only want to sort by `updated_at` in ascending
@@ -7043,6 +7108,7 @@ export declare class Client {
    *   * Records are returned in an arbitrary order. Since results are all
    *     returned at once you can sort the records yourself.
    *   
+   * @param {string} options.state - Invoice state.
    * @param {number} options.limit - Limit number of records 1-200.
    * @param {string} options.order - Sort order.
    * @param {string} options.sort - Sort field. You *really* only want to sort by `updated_at` in ascending
@@ -8443,6 +8509,7 @@ export declare class Client {
    *   * Records are returned in an arbitrary order. Since results are all
    *     returned at once you can sort the records yourself.
    *   
+   * @param {string} options.state - Invoice state.
    * @param {number} options.limit - Limit number of records 1-200.
    * @param {string} options.order - Sort order.
    * @param {string} options.sort - Sort field. You *really* only want to sort by `updated_at` in ascending

lib/recurly/Client.js

@@ -838,6 +838,7 @@ class Client extends BaseClient {
    *   * Records are returned in an arbitrary order. Since results are all
    *     returned at once you can sort the records yourself.
    *
+   * @param {string} options.state - Invoice state.
    * @param {number} options.limit - Limit number of records 1-200.
    * @param {string} options.order - Sort order.
    * @param {string} options.sort - Sort field. You *really* only want to sort by `updated_at` in ascending
@@ -2163,6 +2164,7 @@ class Client extends BaseClient {
    *   * Records are returned in an arbitrary order. Since results are all
    *     returned at once you can sort the records yourself.
    *
+   * @param {string} options.state - Invoice state.
    * @param {number} options.limit - Limit number of records 1-200.
    * @param {string} options.order - Sort order.
    * @param {string} options.sort - Sort field. You *really* only want to sort by `updated_at` in ascending
@@ -3815,6 +3817,7 @@ class Client extends BaseClient {
    *   * Records are returned in an arbitrary order. Since results are all
    *     returned at once you can sort the records yourself.
    *
+   * @param {string} options.state - Invoice state.
    * @param {number} options.limit - Limit number of records 1-200.
    * @param {string} options.order - Sort order.
    * @param {string} options.sort - Sort field. You *really* only want to sort by `updated_at` in ascending

lib/recurly/resources/Account.js

@@ -23,6 +23,7 @@ const Resource = require('../Resource')
  * @prop {Date} deletedAt - If present, when the account was last marked inactive.
  * @prop {string} dunningCampaignId - Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
  * @prop {string} email - The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+ * @prop {string} entityUseCode - The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
  * @prop {string} exemptionCertificate - The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
  * @prop {string} firstName
  * @prop {boolean} hasActiveSubscription - Indicates if the account has an active subscription.
@@ -59,6 +60,7 @@ class Account extends Resource {
       deletedAt: Date,
       dunningCampaignId: String,
       email: String,
+      entityUseCode: String,
       exemptionCertificate: String,
       firstName: String,
       hasActiveSubscription: Boolean,

lib/recurly/resources/Address.js

@@ -15,6 +15,7 @@ const Resource = require('../Resource')
  * @prop {string} city - City
  * @prop {string} country - Country, 2-letter ISO 3166-1 alpha-2 code.
  * @prop {string} firstName - First name
+ * @prop {string} geoCode - Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
  * @prop {string} lastName - Last name
  * @prop {string} phone - Phone number
  * @prop {string} postalCode - Zip or postal code.
@@ -28,6 +29,7 @@ class Address extends Resource {
       city: String,
       country: String,
       firstName: String,
+      geoCode: String,
       lastName: String,
       phone: String,
       postalCode: String,

lib/recurly/resources/GatewayAttributes.js

@@ -12,7 +12,7 @@ const Resource = require('../Resource')
 /**
  * GatewayAttributes
  * @typedef {Object} GatewayAttributes
- * @prop {string} accountReference - Used by Adyen gateways. The Shopper Reference value used when the external token was created.
+ * @prop {string} accountReference - Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. For Braintree the PayPal PayerID is populated in the response.
  */
 class GatewayAttributes extends Resource {
   static getSchema () {

lib/recurly/resources/InvoiceAddress.js

@@ -16,6 +16,7 @@ const Resource = require('../Resource')
  * @prop {string} company - Company
  * @prop {string} country - Country, 2-letter ISO 3166-1 alpha-2 code.
  * @prop {string} firstName - First name
+ * @prop {string} geoCode - Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
  * @prop {string} lastName - Last name
  * @prop {string} nameOnAccount - Name on account
  * @prop {string} phone - Phone number
@@ -31,6 +32,7 @@ class InvoiceAddress extends Resource {
       company: String,
       country: String,
       firstName: String,
+      geoCode: String,
       lastName: String,
       nameOnAccount: String,
       phone: String,

lib/recurly/resources/PaymentMethod.js

@@ -14,6 +14,7 @@ const Resource = require('../Resource')
  * @typedef {Object} PaymentMethod
  * @prop {string} accountType - The bank account type. Only present for ACH payment methods.
  * @prop {string} billingAgreementId - Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
+ * @prop {string} cardNetworkPreference - Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
  * @prop {string} cardType - Visa, MasterCard, American Express, Discover, JCB, etc.
  * @prop {string} ccBinCountry - The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
  * @prop {number} expMonth - Expiration month.
@@ -34,6 +35,7 @@ class PaymentMethod extends Resource {
     return {
       accountType: String,
       billingAgreementId: String,
+      cardNetworkPreference: String,
       cardType: String,
       ccBinCountry: String,
       expMonth: Number,

lib/recurly/resources/ShippingAddress.js

@@ -19,6 +19,7 @@ const Resource = require('../Resource')
  * @prop {Date} createdAt - Created at
  * @prop {string} email
  * @prop {string} firstName
+ * @prop {string} geoCode - Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
  * @prop {string} id - Shipping Address ID
  * @prop {string} lastName
  * @prop {string} nickname
@@ -41,6 +42,7 @@ class ShippingAddress extends Resource {
       createdAt: Date,
       email: String,
       firstName: String,
+      geoCode: String,
       id: String,
       lastName: String,
       nickname: String,

lib/recurly/resources/SubscriptionRampIntervalResponse.js

@@ -12,15 +12,19 @@ const Resource = require('../Resource')
 /**
  * SubscriptionRampIntervalResponse
  * @typedef {Object} SubscriptionRampIntervalResponse
+ * @prop {Date} endingOn - Date the ramp interval ends
  * @prop {number} remainingBillingCycles - Represents how many billing cycles are left in a ramp interval.
  * @prop {number} startingBillingCycle - Represents the billing cycle where a ramp interval starts.
+ * @prop {Date} startingOn - Date the ramp interval starts
  * @prop {number} unitAmount - Represents the price for the ramp interval.
  */
 class SubscriptionRampIntervalResponse extends Resource {
   static getSchema () {
     return {
+      endingOn: Date,
       remainingBillingCycles: Number,
       startingBillingCycle: Number,
+      startingOn: Date,
       unitAmount: Number
     }
   }