Merge pull request #372 from recurly/v3-v2021-02-25-26175519407

Generated Latest Changes for v2021-02-25

Author: sgilrodriguez

lib/recurly.d.ts

@@ -73,7 +73,7 @@ export declare class Address {
    */
   country?: string | null;
   /**
-   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
    */
   geoCode?: string | null;
 
@@ -278,7 +278,7 @@ export declare class ShippingAddress {
    */
   country?: string | null;
   /**
-   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
    */
   geoCode?: string | null;
   /**
@@ -496,6 +496,14 @@ export declare class CustomField {
    * Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
    */
   value?: string | null;
+  /**
+   * The type of record this custom field was automatically copied from. Only present when the field was copied from another record.
+   */
+  sourceRecordType?: string | null;
+  /**
+   * The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
+   */
+  sourceRecordId?: string | null;
 
 }
 
@@ -945,7 +953,7 @@ export declare class AddressWithName {
    */
   country?: string | null;
   /**
-   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
    */
   geoCode?: string | null;
 
@@ -1069,11 +1077,11 @@ export declare class Coupon {
    */
   duration?: string | null;
   /**
-   * If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+   * If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for. When `temporal_unit` is "billing_period", this is the number of complete billing cycles.
    */
   temporalAmount?: number | null;
   /**
-   * If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+   * If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for. Use "billing_period" to apply the coupon for a fixed number of billing cycles. Requires `redemption_resource=subscription`.
    */
   temporalUnit?: string | null;
   /**
@@ -1728,6 +1736,10 @@ export declare class Invoice {
    * Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled.
    */
   businessEntityId?: string | null;
+  /**
+   * A list of custom fields that were on the account at the time of invoice creation and were marked to be displayed on invoices. Read-only; cannot be set directly on the invoice.
+   */
+  customFields?: CustomField[] | null;
 
 }
 
@@ -1769,7 +1781,7 @@ export declare class InvoiceAddress {
    */
   country?: string | null;
   /**
-   * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+   * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
    */
   geoCode?: string | null;
   /**
@@ -4354,7 +4366,7 @@ export interface ShippingAddressCreate {
     */
   postalCode?: string | null;
   /**
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     */
   geoCode?: string | null;
   /**
@@ -4394,7 +4406,7 @@ export interface Address {
     */
   country?: string | null;
   /**
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     */
   geoCode?: string | null;
 
@@ -4583,6 +4595,14 @@ export interface CustomField {
     * Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
     */
   value?: string | null;
+  /**
+    * The type of record this custom field was automatically copied from. Only present when the field was copied from another record.
+    */
+  sourceRecordType?: string | null;
+  /**
+    * The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
+    */
+  sourceRecordId?: string | null;
 
 }
 
@@ -4943,7 +4963,7 @@ export interface ShippingAddressUpdate {
     */
   country?: string | null;
   /**
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     */
   geoCode?: string | null;
 
@@ -5023,11 +5043,11 @@ export interface CouponCreate {
     */
   duration?: string | null;
   /**
-    * If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+    * If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for. When `temporal_unit` is "billing_period", this is the number of complete billing cycles.
     */
   temporalAmount?: number | null;
   /**
-    * If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+    * If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for. Use "billing_period" to apply the coupon for a fixed number of billing cycles. Requires `redemption_resource=subscription`.
     */
   temporalUnit?: string | null;
   /**
@@ -5621,7 +5641,7 @@ export interface InvoiceAddress {
     */
   country?: string | null;
   /**
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     */
   geoCode?: string | null;
   /**

lib/recurly/resources/Address.js

@@ -14,7 +14,7 @@ const Resource = require('../Resource')
  * @typedef {Object} Address
  * @prop {string} city - City
  * @prop {string} country - Country, 2-letter ISO 3166-1 alpha-2 code.
- * @prop {string} geoCode - Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+ * @prop {string} geoCode - Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
  * @prop {string} phone - Phone number
  * @prop {string} postalCode - Zip or postal code.
  * @prop {string} region - State or province.

lib/recurly/resources/AddressWithName.js

@@ -15,7 +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} geoCode - Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
  * @prop {string} lastName - Last name
  * @prop {string} phone - Phone number
  * @prop {string} postalCode - Zip or postal code.

lib/recurly/resources/Coupon.js

@@ -35,8 +35,8 @@ const Resource = require('../Resource')
  * @prop {Date} redeemBy - The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
  * @prop {string} redemptionResource - Whether the discount is for all eligible charges on the account, or only a specific subscription.
  * @prop {string} state - Indicates if the coupon is redeemable, and if it is not, why.
- * @prop {number} temporalAmount - If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
- * @prop {string} temporalUnit - If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+ * @prop {number} temporalAmount - If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for. When `temporal_unit` is "billing_period", this is the number of complete billing cycles.
+ * @prop {string} temporalUnit - If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for. Use "billing_period" to apply the coupon for a fixed number of billing cycles. Requires `redemption_resource=subscription`.
  * @prop {string} uniqueCodeTemplate - On a bulk coupon, the template from which unique coupon codes are generated.
  * @prop {Object} uniqueCouponCode - Will be populated when the Coupon being returned is a `UniqueCouponCode`.
  * @prop {number} uniqueCouponCodesCount - When this number reaches `max_redemptions` the coupon will no longer be redeemable.

lib/recurly/resources/CustomField.js

@@ -13,12 +13,16 @@ const Resource = require('../Resource')
  * CustomField
  * @typedef {Object} CustomField
  * @prop {string} name - Fields must be created in the UI before values can be assigned to them.
+ * @prop {string} sourceRecordId - The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
+ * @prop {string} sourceRecordType - The type of record this custom field was automatically copied from. Only present when the field was copied from another record.
  * @prop {string} value - Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
  */
 class CustomField extends Resource {
   static getSchema () {
     return {
       name: String,
+      sourceRecordId: String,
+      sourceRecordType: String,
       value: String
     }
   }

lib/recurly/resources/Invoice.js

@@ -22,6 +22,7 @@ const Resource = require('../Resource')
  * @prop {Date} createdAt - Created at
  * @prop {Array.<CreditPayment>} creditPayments - Credit payments
  * @prop {string} currency - 3-letter ISO 4217 currency code.
+ * @prop {Array.<CustomField>} customFields - A list of custom fields that were on the account at the time of invoice creation and were marked to be displayed on invoices. Read-only; cannot be set directly on the invoice.
  * @prop {string} customerNotes - This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.
  * @prop {number} discount - Total discounts applied to this invoice.
  * @prop {Date} dueAt - Date invoice is due. This is the date the net terms are reached.
@@ -71,6 +72,7 @@ class Invoice extends Resource {
       createdAt: Date,
       creditPayments: ['CreditPayment'],
       currency: String,
+      customFields: ['CustomField'],
       customerNotes: String,
       discount: Number,
       dueAt: Date,

lib/recurly/resources/InvoiceAddress.js

@@ -16,7 +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} geoCode - Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
  * @prop {string} lastName - Last name
  * @prop {string} nameOnAccount - Name on account
  * @prop {string} phone - Phone number

lib/recurly/resources/ShippingAddress.js

@@ -19,7 +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} geoCode - Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
  * @prop {string} id - Shipping Address ID
  * @prop {string} lastName
  * @prop {string} nickname