[DE-932] Release 5.0.0 (#84)

* DE-921 DE-922 Fix problem with interval units - interval units now can be nullable in various contexts, ExtendedIntervalUnit was renamed to ExpirationIntervalUnit, now ExpirationIntervalUnit is used in SubscriptionCustomPrice, CreatePrepaidComponentPricePoint, CreateProductPricePoint, CreateOrUpdateProduct, PrepaidComponent, ProductPricePoint and Product for expirationIntervalUnit property. This enum has additional value of never (this has not changed)

* DE-921 DE-924 Reworked vaults - CurrentVault enum was renamed to AllVaults and filled with previously missing values. BankAccountVault was filled with missing values. ApplePayVault was added with the vault supporting this payment method. CreditCardVault was added with vaults supporting this payment method. PayPalVault was added with vaults supporting this payment method. Models for respective payment profiles types now use respective enums.

* DE-910 Distinguish response payment profiles based on the paymentType. PaymentProfileResponsePaymentProfile was renamed to PaymentProfile.ApplePayPaymentProfile, and PayPalPaymentProfile were added as possible PaymentProfile in PaymentProfileResponse. Fixed a bug, when response payment profile couldn't be deserialized due to missing fields.

* Added publicUrlExpires_on to the Invoice

* Added achLateReject to the InvoiceRefund

* Added tax-related properties to InvoiceTaxComponentBreakout and InvoiceTax

* SUB-4037 Add taxIncluded to ComponentCustomPrice. Added request model for Activate Event-Based Component endpoint, SubscriptionComponentActivateEventBasedComponent
productFamilyId in endpoint paths parameters is now string, to enable searching by both handle and id

* [ON-128] Add salesforceId to Customer models

.eslintignore

@@ -2,5 +2,4 @@
 .DS_Store
 node_modules
 dist
-coverage
-test
+coverage

README.md

@@ -7,10 +7,10 @@ Maxio Advanced Billing (formerly Chargify) provides an HTTP-based API that confo
 One of the many reasons to use Advanced Billing is the immense feature set and surrounding community [client libraries](page:development-tools/client-libraries).
 The Maxio API returns JSON responses as the primary and recommended format, but XML is also provided as a backwards compatible option for Merchants who require it.
 
-### Steps to make your first Maxio Advanced Billing API call
+### Steps to make your first Maxio Chargify API call
 
-1. [Sign-up](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405553861773-Testing-Intro) account.
-2. [Setup and configure authentication](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405281550477-API-Keys#api) credentials.
+1. [Sign-up](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio.zendesk.com/hc/en-us/articles/24250712113165-Testing-Overview) account.
+2. [Setup and configure authentication](https://maxio.zendesk.com/hc/en-us/articles/24294819360525-API-Keys) credentials.
 3. Submit your API request and try it out.
 4. Verify results through response.
 5. Test our integrations.
@@ -30,26 +30,26 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
 Run the following command from your project directory to install the package from npm:
 
 ```ts
-npm install @maxio-com/advanced-billing-sdk@4.0.0
+npm install @maxio-com/advanced-billing-sdk@5.0.0
 ```
 
-For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@4.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/4.0.0).
+For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@5.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/5.0.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `subdomain` | `string` | The subdomain for your Chargify site.<br>*Default*: `'subdomain'` |
-| `domain` | `string` | The Chargify server domain.<br>*Default*: `'chargify.com'` |
+| `subdomain` | `string` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |
+| `domain` | `string` | The Advanced Billing server domain.<br>*Default*: `'chargify.com'` |
 | `environment` | `Environment` | The API environment. <br> **Default: `Environment.Production`** |
 | `timeout` | `number` | Timeout for API calls.<br>*Default*: `120000` |
 | `httpClientOptions` | `Partial<HttpClientOptions>` | Stable configurable http client options. |
 | `unstableHttpClientOptions` | `any` | Unstable configurable http client options. |
-| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/$a/https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/basic-authentication.md) | The credential object for basicAuth |
+| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/auth/basic-authentication.md) | The credential object for basicAuth |
 
 ### HttpClientOptions
 
@@ -102,45 +102,45 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/$a/https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/auth/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/billing-portal.md)
-* [Component Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/component-price-points.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-products.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/controllers/webhooks.md)
 
 ## Classes Documentation
 
-* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/api-response.md)
-* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/4.0.0/doc/api-error.md)
+* [ApiResponse](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/api-response.md)
+* [ApiError](https://www.github.com/maxio-com/ab-typescript-sdk/tree/5.0.0/doc/api-error.md)
 

doc/client.md

@@ -5,13 +5,13 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `subdomain` | `string` | The subdomain for your Chargify site.<br>*Default*: `'subdomain'` |
-| `domain` | `string` | The Chargify server domain.<br>*Default*: `'chargify.com'` |
+| `subdomain` | `string` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |
+| `domain` | `string` | The Advanced Billing server domain.<br>*Default*: `'chargify.com'` |
 | `environment` | `Environment` | The API environment. <br> **Default: `Environment.Production`** |
 | `timeout` | `number` | Timeout for API calls.<br>*Default*: `120000` |
 | `httpClientOptions` | `Partial<HttpClientOptions>` | Stable configurable http client options. |
 | `unstableHttpClientOptions` | `any` | Unstable configurable http client options. |
-| `basicAuthCredentials` | [`BasicAuthCredentials`]($a/basic-authentication.md) | The credential object for basicAuth |
+| `basicAuthCredentials` | [`BasicAuthCredentials`](auth/basic-authentication.md) | The credential object for basicAuth |
 
 ## HttpClientOptions
 

doc/controllers/advance-invoice.md

@@ -17,7 +17,7 @@ const advanceInvoiceController = new AdvanceInvoiceController(client);
 
 # Issue Advance Invoice
 
-Generate an invoice in advance for a subscription's next renewal date. [Please see our docs](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404811062541-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided.
+Generate an invoice in advance for a subscription's next renewal date. [Please see our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided.
 A subscription may only have one advance invoice per billing period. Attempting to issue an advance invoice when one already exists will return an error.
 That said, regeneration of the invoice may be forced with the params `force: true`, which will void an advance invoice if one exists and generate a new one. If no advance invoice exists, a new one will be generated.
 We recommend using either the create or preview endpoints for proforma invoices to preview this advance invoice before using this endpoint to generate it.

doc/controllers/api-exports.md

@@ -55,6 +55,7 @@ const collect = {
   perPage: 100,
   page: 2
 }
+
 try {
   const { result, ...httpResponse } = await aPIExportsController.listExportedProformaInvoices(collect);
   // Get more response info...
@@ -108,6 +109,7 @@ const collect = {
   perPage: 100,
   page: 2
 }
+
 try {
   const { result, ...httpResponse } = await aPIExportsController.listExportedInvoices(collect);
   // Get more response info...
@@ -161,6 +163,7 @@ const collect = {
   perPage: 100,
   page: 2
 }
+
 try {
   const { result, ...httpResponse } = await aPIExportsController.listExportedSubscriptions(collect);
   // Get more response info...

doc/controllers/billing-portal.md

@@ -20,7 +20,7 @@ const billingPortalController = new BillingPortalController(client);
 
 ## Billing Portal Documentation
 
-Full documentation on how the Billing Portal operates within the Chargify UI can be located [here](https://chargify.zendesk.com/hc/en-us/articles/4407648972443).
+Full documentation on how the Billing Portal operates within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24252412965133-Billing-Portal-Overview).
 
 This documentation is focused on how the to configure the Billing Portal Settings, as well as Subscriber Interaction and Merchant Management of the Billing Portal.
 
@@ -30,9 +30,9 @@ You can use this endpoint to enable Billing Portal access for a Customer, with t
 
 If your customer has been invited to the Billing Portal, then they will receive a link to manage their subscription (the “Management URL”) automatically at the bottom of their statements, invoices, and receipts. **This link changes periodically for security and is only valid for 65 days.**
 
-If you need to provide your customer their Management URL through other means, you can retrieve it via the API. Because the URL is cryptographically signed with a timestamp, it is not possible for merchants to generate the URL without requesting it from Chargify.
+If you need to provide your customer their Management URL through other means, you can retrieve it via the API. Because the URL is cryptographically signed with a timestamp, it is not possible for merchants to generate the URL without requesting it from Advanced Billing.
 
-In order to prevent abuse & overuse, we ask that you request a new URL only when absolutely necessary. Management URLs are good for 65 days, so you should re-use a previously generated one as much as possible. If you use the URL frequently (such as to display on your website), please **do not** make an API request to Chargify every time.
+In order to prevent abuse & overuse, we ask that you request a new URL only when absolutely necessary. Management URLs are good for 65 days, so you should re-use a previously generated one as much as possible. If you use the URL frequently (such as to display on your website), please **do not** make an API request to Advanced Billing every time.
 
 ```ts
 async enableBillingPortalForCustomer(  customerId: number,