Generated Latest Changes for v2019-10-10

lib/recurly.d.ts

@@ -210,7 +210,7 @@ export declare class Account {
    */
   billTo?: string | null;
   /**
-   * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+   * 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.
    */
   dunningCampaignId?: string | null;
   address?: Address | null;
@@ -531,7 +531,7 @@ export declare class AccountMini {
   parentAccountId?: string | null;
   billTo?: string | null;
   /**
-   * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+   * 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.
    */
   dunningCampaignId?: string | null;
 
@@ -1201,7 +1201,7 @@ export declare class Invoice {
    */
   closedAt?: Date | null;
   /**
-   * Unique ID to identify the dunning campaign used when dunning the invoice. Available when the Dunning Campaigns feature is enabled. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+   * Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
    */
   dunningCampaignId?: string | null;
 
@@ -2344,7 +2344,7 @@ export declare class Plan {
    */
   allowAnyItemOnSubscriptions?: boolean | null;
   /**
-   * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+   * Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
    */
   dunningCampaignId?: string | null;
   /**
@@ -2941,7 +2941,7 @@ export interface AccountCreate {
     */
   transactionType?: string | null;
   /**
-    * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+    * 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.
     */
   dunningCampaignId?: string | null;
   address?: Address | null;
@@ -3229,7 +3229,7 @@ export interface AccountUpdate {
     */
   transactionType?: string | null;
   /**
-    * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+    * 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.
     */
   dunningCampaignId?: string | null;
   address?: Address | null;
@@ -3966,7 +3966,7 @@ export interface PlanCreate {
     */
   allowAnyItemOnSubscriptions?: boolean | null;
   /**
-    * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+    * Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
     */
   dunningCampaignId?: string | null;
 
@@ -4210,7 +4210,7 @@ export interface PlanUpdate {
     */
   allowAnyItemOnSubscriptions?: boolean | null;
   /**
-    * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+    * Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
     */
   dunningCampaignId?: string | null;
 
@@ -4852,7 +4852,7 @@ export interface AccountPurchase {
     */
   transactionType?: string | null;
   /**
-    * Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+    * 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.
     */
   dunningCampaignId?: string | null;
   address?: Address | null;

lib/recurly/resources/Account.js

@@ -21,7 +21,7 @@ const Resource = require('../Resource')
  * @prop {Date} createdAt - When the account was created.
  * @prop {Array.<CustomField>} customFields - 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.
  * @prop {Date} deletedAt - If present, when the account was last marked inactive.
- * @prop {string} dunningCampaignId - Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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} 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} 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

lib/recurly/resources/AccountMini.js

@@ -15,7 +15,7 @@ const Resource = require('../Resource')
  * @prop {string} billTo
  * @prop {string} code - The unique identifier of the account.
  * @prop {string} company
- * @prop {string} dunningCampaignId - Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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} 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.
  * @prop {string} firstName
  * @prop {string} id

lib/recurly/resources/Invoice.js

@@ -24,7 +24,7 @@ const Resource = require('../Resource')
  * @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.
- * @prop {string} dunningCampaignId - Unique ID to identify the dunning campaign used when dunning the invoice. Available when the Dunning Campaigns feature is enabled. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+ * @prop {string} dunningCampaignId - Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
  * @prop {string} id - Invoice ID
  * @prop {LineItemList} lineItems
  * @prop {number} netTerms - Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.

lib/recurly/resources/Plan.js

@@ -22,7 +22,7 @@ const Resource = require('../Resource')
  * @prop {Array.<PlanPricing>} currencies - Pricing
  * @prop {Date} deletedAt - Deleted at
  * @prop {string} description - Optional description, not displayed.
- * @prop {string} dunningCampaignId - Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+ * @prop {string} dunningCampaignId - Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
  * @prop {PlanHostedPages} hostedPages - Hosted pages settings
  * @prop {string} id - Plan ID
  * @prop {number} intervalLength - Length of the plan's billing interval in `interval_unit`.

openapi/api.yaml

@@ -14163,9 +14163,14 @@ paths:
               var_dump($e);
           }
       - lang: Go
-        source: "collection, err := client.PreviewPurchase(purchaseReq)\nif e, ok
-          := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeValidation
-          {\n\t\tfmt.Printf(\"Failed validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
+        source: "purchaseReq := &recurly.PurchaseCreate{\n\tCurrency: recurly.String(\"USD\"),\n\tAccount:
+          &recurly.AccountPurchase{\n\t\tCode: recurly.String(account.Code),\n\t},\n\tSubscriptions:
+          []recurly.SubscriptionPurchase{\n\t\t{\n\t\t\tPlanCode:     recurly.String(plan.Code),\n\t\t\tNextBillDate:
+          recurly.Time(time.Date(2078, time.November, 10, 23, 0, 0, 0, time.UTC)),\n\t\t},\n\t},\n\tShipping:
+          &recurly.ShippingPurchase{\n\t\tAddressId: recurly.String(shippingAddressID),\n\t},\n}\ncollection,
+          err := client.PreviewPurchase(purchaseReq)\nif e, ok := err.(*recurly.Error);
+          ok {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
+          validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Preview Charge
           Invoice %v\", collection.ChargeInvoice)"
   "/sites/{site_id}/export_dates":
@@ -15495,11 +15500,10 @@ components:
         dunning_campaign_id:
           type: string
           title: Dunning Campaign ID
-          description: Unique ID to identify a dunning campaign. Available when the
-            Dunning Campaigns feature is enabled. 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.
+          description: 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.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -15605,11 +15609,10 @@ components:
         dunning_campaign_id:
           type: string
           title: Dunning Campaign ID
-          description: Unique ID to identify a dunning campaign. Available when the
-            Dunning Campaigns feature is enabled. 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.
+          description: 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.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -15678,11 +15681,10 @@ components:
         dunning_campaign_id:
           type: string
           title: Dunning Campaign ID
-          description: Unique ID to identify a dunning campaign. Available when the
-            Dunning Campaigns feature is enabled. 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.
+          description: 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.
     AccountBalance:
       type: object
       properties:
@@ -17851,9 +17853,8 @@ components:
           type: string
           title: Dunning Campaign ID
           description: Unique ID to identify the dunning campaign used when dunning
-            the invoice. Available when the Dunning Campaigns feature is enabled.
-            For sites without multiple dunning campaigns enabled, this will always
-            be the default dunning campaign.
+            the invoice. For sites without multiple dunning campaigns enabled, this
+            will always be the default dunning campaign.
     InvoiceCreate:
       type: object
       properties:
@@ -18889,11 +18890,10 @@ components:
         dunning_campaign_id:
           type: string
           title: Dunning Campaign ID
-          description: Unique ID to identify a dunning campaign. Available when the
-            Dunning Campaigns feature is enabled. Used to specify if a non-default
-            dunning campaign should be assigned to this plan. For sites without multiple
-            dunning campaigns enabled, the default dunning campaign will always be
-            used.
+          description: Unique ID to identify a dunning campaign. Used to specify if
+            a non-default dunning campaign should be assigned to this plan. For sites
+            without multiple dunning campaigns enabled, the default dunning campaign
+            will always be used.
         created_at:
           type: string
           format: date-time
@@ -19069,11 +19069,10 @@ components:
         dunning_campaign_id:
           type: string
           title: Dunning Campaign ID
-          description: Unique ID to identify a dunning campaign. Available when the
-            Dunning Campaigns feature is enabled. Used to specify if a non-default
-            dunning campaign should be assigned to this plan. For sites without multiple
-            dunning campaigns enabled, the default dunning campaign will always be
-            used.
+          description: Unique ID to identify a dunning campaign. Used to specify if
+            a non-default dunning campaign should be assigned to this plan. For sites
+            without multiple dunning campaigns enabled, the default dunning campaign
+            will always be used.
       required:
       - code
       - name
@@ -19273,11 +19272,10 @@ components:
         dunning_campaign_id:
           type: string
           title: Dunning Campaign ID
-          description: Unique ID to identify a dunning campaign. Available when the
-            Dunning Campaigns feature is enabled. Used to specify if a non-default
-            dunning campaign should be assigned to this plan. For sites without multiple
-            dunning campaigns enabled, the default dunning campaign will always be
-            used.
+          description: Unique ID to identify a dunning campaign. Used to specify if
+            a non-default dunning campaign should be assigned to this plan. For sites
+            without multiple dunning campaigns enabled, the default dunning campaign
+            will always be used.
     AddOnPricing:
       type: object
       properties: