[DE-799] Add missing nullable types

- Made some properties nullable
- Added fixes for Subscription Invoice Account endpoints
- ListSubscriptionComponents include query parameter becomes list with additional possible value, `HISTORIC_USAGES`

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](../../doc/models/invoice.md) 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-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.
 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/invoices.md

@@ -481,6 +481,19 @@ try {
 
 Use this endpoint to retrieve the details for an invoice.
 
+## PDF Invoice retrieval
+
+Individual PDF Invoices can be retrieved by using the "Accept" header application/pdf or appending .pdf as the format portion of the URL:
+
+```curl -u <api_key>:x -H
+Accept:application/pdf -H
+https://acme.chargify.com/invoices/inv_8gd8tdhtd3hgr.pdf > output_file.pdf
+URL: `https://<subdomain>.chargify.com/invoices/<uid>.<format>`
+Method: GET
+Required parameters: `uid`
+Response: A single Invoice.
+```
+
 ```ts
 async readInvoice(
   uid: string,

doc/controllers/payment-profiles.md

@@ -225,6 +225,34 @@ The following example creates a customer, bank account and mandate in Stripe:
 }
 ```
 
+## Stripe BACS Direct Debit
+
+Contact the support team to enable this payment method.
+For more information on Stripe BACS Direct Debit, please view the following resources:
+
++ [Full documentation on Stripe BACS Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit)
+
+### Stripe BACS Direct Debit Payment Profiles
+
+The following example creates a customer, bank account and mandate in Stripe:
+
+```json
+{
+  "payment_profile": {
+    "customer_id": "24907598",
+    "bank_name": "British bank",
+    "bank_branch_code": "108800",
+    "bank_account_number": "00012345"
+    "payment_type": "bank_account",
+    "billing_address": "Test",
+    "billing_city": "London",
+    "billing_state": "LND",
+    "billing_zip": "12345",
+    "billing_country": "GB"
+  }
+}
+```
+
 ## 3D Secure - Checkout
 
 It may happen that a payment needs 3D Secure Authentication when the payment profile is created; this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response:

doc/controllers/subscription-components.md

@@ -122,7 +122,7 @@ async listSubscriptionComponents(
   sort?: ListSubscriptionComponentsSort,
   startDate?: string,
   startDatetime?: string,
-  include?: ListSubscriptionComponentsInclude,
+  include?: ListSubscriptionComponentsInclude[],
   requestOptions?: RequestOptions
 ): Promise<ApiResponse<SubscriptionComponentResponse[]>>
 ```
@@ -142,7 +142,7 @@ async listSubscriptionComponents(
 | `sort` | [`ListSubscriptionComponentsSort \| undefined`](../../doc/models/list-subscription-components-sort.md) | Query, Optional | The attribute by which to sort. Use in query `sort=updated_at`. |
 | `startDate` | `string \| undefined` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. |
 | `startDatetime` | `string \| undefined` | Query, Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of start_date. |
-| `include` | [`ListSubscriptionComponentsInclude \| undefined`](../../doc/models/list-subscription-components-include.md) | Query, Optional | Allows including additional data in the response. Use in query `include=subscription`. |
+| `include` | [`ListSubscriptionComponentsInclude[] \| undefined`](../../doc/models/list-subscription-components-include.md) | Query, Optional | Allows including additional data in the response. Use in query `include=subscription,historic_usages`. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type
@@ -168,7 +168,10 @@ const collect = {
     3
   ],
   sort: ListSubscriptionComponentsSort.UpdatedAt,
-  include: ListSubscriptionComponentsInclude.Subscription
+  include: [
+    ListSubscriptionComponentsInclude.Subscription,
+    ListSubscriptionComponentsInclude.HistoricUsages
+  ]
 }
 try {
   const { result, ...httpResponse } = await subscriptionComponentsController.listSubscriptionComponents(collect);
@@ -1673,7 +1676,7 @@ async listSubscriptionComponentsForSite(
 | `subscriptionIds` | `number[] \| undefined` | Query, Optional | Allows fetching components allocation with matching subscription id based on provided ids. Use in query `subscription_ids=1,2,3`. |
 | `pricePointIds` | [`IncludeNotNull \| undefined`](../../doc/models/include-not-null.md) | Query, Optional | Allows fetching components allocation only if price point id is present. Use in query `price_point_ids=not_null`. |
 | `productFamilyIds` | `number[] \| undefined` | Query, Optional | Allows fetching components allocation with matching product family id based on provided ids. Use in query `product_family_ids=1,2,3`. |
-| `include` | [`ListSubscriptionComponentsInclude \| undefined`](../../doc/models/list-subscription-components-include.md) | Query, Optional | Allows including additional data in the response. Use in query `include=subscription`. |
+| `include` | [`ListSubscriptionComponentsInclude \| undefined`](../../doc/models/list-subscription-components-include.md) | Query, Optional | Allows including additional data in the response. Use in query `include=subscription,historic_usages`. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type

doc/controllers/subscription-invoice-account.md

@@ -253,7 +253,6 @@ const subscriptionId = 222;
 const body: IssueServiceCreditRequest = {
   serviceCredit: {
     amount: '1',
-    memo: 'Courtesy credit',
   },
 };
 
@@ -284,6 +283,12 @@ try {
 }
 ```
 
+## Errors
+
+| HTTP Status Code | Error Description | Exception Class |
+|  --- | --- | --- |
+| 422 | Unprocessable Entity (WebDAV) | `ApiError` |
+
 
 # Deduct Service Credit
 
@@ -340,7 +345,7 @@ try {
 
 | HTTP Status Code | Error Description | Exception Class |
 |  --- | --- | --- |
-| 422 | Unprocessable Entity (WebDAV) | [`ErrorListResponseError`](../../doc/models/error-list-response-error.md) |
+| 422 | Unprocessable Entity (WebDAV) | `ApiError` |
 
 
 # Refund Prepayment
@@ -352,7 +357,7 @@ The amount may be passed either as a decimal, with `amount`, or an integer in ce
 ```ts
 async refundPrepayment(
   subscriptionId: number,
-  prepaymentId: string,
+  prepaymentId: bigint,
   body?: RefundPrepaymentRequest,
   requestOptions?: RequestOptions
 ): Promise<ApiResponse<PrepaymentResponse>>
@@ -363,7 +368,7 @@ async refundPrepayment(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `subscriptionId` | `number` | Template, Required | The Chargify id of the subscription |
-| `prepaymentId` | `string` | Template, Required | id of prepayment |
+| `prepaymentId` | `bigint` | Template, Required | id of prepayment |
 | `body` | [`RefundPrepaymentRequest \| undefined`](../../doc/models/refund-prepayment-request.md) | Body, Optional | - |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
@@ -376,7 +381,7 @@ async refundPrepayment(
 ```ts
 const subscriptionId = 222;
 
-const prepaymentId = 'prepayment_id8';
+const prepaymentId = BigInt(228);
 
 try {
   const { result, ...httpResponse } = await subscriptionInvoiceAccountController.refundPrepayment(
@@ -399,5 +404,5 @@ try {
 |  --- | --- | --- |
 | 400 | Bad Request | [`RefundPrepaymentBaseErrorsResponseError`](../../doc/models/refund-prepayment-base-errors-response-error.md) |
 | 404 | Not Found | `ApiError` |
-| 422 | Unprocessable Entity | [`RefundPrepaymentAggregatedErrorsResponseError`](../../doc/models/refund-prepayment-aggregated-errors-response-error.md) |
+| 422 | Unprocessable Entity | `ApiError` |
 

doc/controllers/subscriptions.md

@@ -364,13 +364,13 @@ For more information on Stripe Direct Debit, please view the following two resou
 
 For more information on Stripe Direct Debit, please view the following two resources:
 
-+ [Payment Profiles via API for Stripe BECS Direct Debit](https://developers.chargify.com/docs/api-docs/1f10a4f170405-create-payment-profile#stripe-becs-direct-debit)
++ [Payment Profiles via API for Stripe BECS Direct Debit]($e/Payment%20Profiles/createPaymentProfile)
 
 + [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit)
 
-+ [Using Chargify.js with Stripe SEPA or BECS Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway)
++ [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal example](page:development-tools/chargify-js/examples#minimal-example-with-sepa-becs-or-bacs-direct-debit-stripe-gateway)
 
-+ [Using Chargify.js with Stripe BECS Direct Debit - full example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#full-example-with-becs-direct-debit-stripe-gateway)
++ [Using Chargify.js with Stripe BECS Direct Debit - full example](page:development-tools/chargify-js/examples#full-example-with-becs-direct-debit-stripe-gateway)
 
 ```json
 {
@@ -391,6 +391,42 @@ For more information on Stripe Direct Debit, please view the following two resou
 }
 ```
 
+## Subscription using Stripe BACS Direct Debit
+
+For more information on Stripe Direct Debit, please view the following two resources:
+
++ [Payment Profiles via API for Stripe BACS Direct Debit]($e/Payment%20Profiles/createPaymentProfile)
+
++ [Full documentation on Stripe Direct Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-Stripe-SEPA-and-BECS-Direct-Debit)
+
++ [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal example](page:development-tools/chargify-js/examples#minimal-example-with-sepa-becs-or-bacs-direct-debit-stripe-gateway)
+
++ [Using Chargify.js with Stripe BACS Direct Debit - full example](page:development-tools/chargify-js/examples#full-example-with-bacs-direct-debit-stripe-gateway)
+
+```json
+{
+  "subscription": {
+    "product_handle": "gold-product",
+    "customer_attributes": {
+      "first_name": "Jane",
+      "last_name": "Doe",
+      "email": "[email protected]"
+    },
+    "bank_account_attributes": {
+      "bank_name": "Test Bank",
+      "bank_branch_code": "108800",
+      "bank_account_number": "00012345",
+      "payment_type": "bank_account",
+      "billing_address": "123 Main St.",
+      "billing_city": "London",
+      "billing_state": "LND",
+      "billing_zip": "W1A 1AA",
+      "billing_country": "GB"
+    }
+  }
+}
+```
+
 ## 3D Secure - Stripe
 
 It may happen that a payment needs 3D Secure Authentication when the subscription is created; this is referred to in our help docs as a [post-authentication flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response:

doc/models/billing-manifest.md

@@ -14,9 +14,9 @@
 | `totalDiscountInCents` | `bigint \| undefined` | Optional | - |
 | `totalTaxInCents` | `bigint \| undefined` | Optional | - |
 | `subtotalInCents` | `bigint \| undefined` | Optional | - |
-| `startDate` | `string \| undefined` | Optional | - |
-| `endDate` | `string \| undefined` | Optional | - |
-| `periodType` | `string \| undefined` | Optional | - |
+| `startDate` | `string \| null \| undefined` | Optional | - |
+| `endDate` | `string \| null \| undefined` | Optional | - |
+| `periodType` | `string \| null \| undefined` | Optional | - |
 | `existingBalanceInCents` | `bigint \| undefined` | Optional | - |
 
 ## Example (as JSON)

doc/models/component-price-point.md

@@ -15,7 +15,7 @@
 | `name` | `string \| undefined` | Optional | - |
 | `pricingScheme` | [`PricingScheme \| undefined`](../../doc/models/pricing-scheme.md) | Optional | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. |
 | `componentId` | `number \| undefined` | Optional | - |
-| `handle` | `string \| undefined` | Optional | - |
+| `handle` | `string \| null \| undefined` | Optional | - |
 | `archivedAt` | `string \| null \| undefined` | Optional | - |
 | `createdAt` | `string \| undefined` | Optional | - |
 | `updatedAt` | `string \| undefined` | Optional | - |

doc/models/component.md

@@ -26,7 +26,7 @@
 | `overagePrices` | [`ComponentPrice[] \| null \| undefined`](../../doc/models/component-price.md) | Optional | An array of price brackets. If the component uses the ‘per_unit’ pricing scheme, this array will be empty. |
 | `prices` | [`ComponentPrice[] \| null \| undefined`](../../doc/models/component-price.md) | Optional | An array of price brackets. If the component uses the ‘per_unit’ pricing scheme, this array will be empty. |
 | `pricePointCount` | `number \| undefined` | Optional | Count for the number of price points associated with the component |
-| `pricePointsUrl` | `string \| undefined` | Optional | URL that points to the location to read the existing price points via GET request |
+| `pricePointsUrl` | `string \| null \| undefined` | Optional | URL that points to the location to read the existing price points via GET request |
 | `defaultPricePointName` | `string \| undefined` | Optional | - |
 | `taxCode` | `string \| null \| undefined` | Optional | A string representing the tax code related to the component type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters. |
 | `recurring` | `boolean \| undefined` | Optional | - |

doc/models/coupon.md

@@ -30,7 +30,7 @@
 | `archivedAt` | `string \| null \| undefined` | Optional | - |
 | `conversionLimit` | `string \| null \| undefined` | Optional | - |
 | `stackable` | `boolean \| undefined` | Optional | - |
-| `compoundingStrategy` | [`CouponCompoundingStrategy \| undefined`](../../doc/models/containers/coupon-compounding-strategy.md) | Optional | This is a container for any-of cases. |
+| `compoundingStrategy` | [`CompoundingStrategy \| null \| undefined`](../../doc/models/compounding-strategy.md) | Optional | - |
 | `useSiteExchangeRate` | `boolean \| undefined` | Optional | - |
 | `createdAt` | `string \| undefined` | Optional | - |
 | `updatedAt` | `string \| undefined` | Optional | - |

doc/models/create-offer-component.md

@@ -10,13 +10,15 @@
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `componentId` | `number \| undefined` | Optional | - |
+| `pricePointId` | `number \| undefined` | Optional | - |
 | `startingQuantity` | `number \| undefined` | Optional | - |
 
 ## Example (as JSON)
 
 ```json
 {
   "component_id": 242,
+  "price_point_id": 10,
   "starting_quantity": 50
 }
 ```

doc/models/create-offer-request.md

@@ -24,10 +24,12 @@
     "components": [
       {
         "component_id": 108,
+        "price_point_id": 124,
         "starting_quantity": 84
       },
       {
         "component_id": 108,
+        "price_point_id": 124,
         "starting_quantity": 84
       }
     ],

doc/models/create-offer.md

@@ -29,10 +29,12 @@
   "components": [
     {
       "component_id": 108,
+      "price_point_id": 124,
       "starting_quantity": 84
     },
     {
       "component_id": 108,
+      "price_point_id": 124,
       "starting_quantity": 84
     }
   ],

doc/models/create-payment-profile.md

@@ -36,8 +36,8 @@
 | `bankName` | `string \| undefined` | Optional | (Required when creating with ACH or GoCardless, optional with Stripe Direct Debit). The name of the bank where the customerʼs account resides |
 | `bankIban` | `string \| undefined` | Optional | (Optional when creating with GoCardless, required with Stripe Direct Debit). International Bank Account Number. Alternatively, local bank details can be provided |
 | `bankRoutingNumber` | `string \| undefined` | Optional | (Required when creating with ACH. Optional when creating a subscription with GoCardless). The routing number of the bank. It becomes bank_code while passing via GoCardless API |
-| `bankAccountNumber` | `string \| undefined` | Optional | (Required when creating with ACH, GoCardless, Stripe BECS Direct Debit and bank_iban is blank) The customerʼs bank account number |
-| `bankBranchCode` | `string \| undefined` | Optional | (Optional when creating with GoCardless, required with Stripe BECS Direct Debit) Branch code. Alternatively, an IBAN can be provided |
+| `bankAccountNumber` | `string \| undefined` | Optional | (Required when creating with ACH, GoCardless, Stripe BECS or BACS Direct Debit, and bank_iban is blank) The customerʼs bank account number |
+| `bankBranchCode` | `string \| undefined` | Optional | (Optional when creating with GoCardless, required with Stripe BECS or BACS Direct Debit) Branch/Sort code. Alternatively, an IBAN can be provided |
 | `bankAccountType` | [`BankAccountType \| undefined`](../../doc/models/bank-account-type.md) | Optional | Defaults to checking |
 | `bankAccountHolderType` | [`BankAccountHolderType \| undefined`](../../doc/models/bank-account-holder-type.md) | Optional | Defaults to personal |
 | `lastFour` | `string \| undefined` | Optional | (Optional) Used for creating subscription with payment profile imported using vault_token, for proper display in Advanced Billing UI |

doc/models/deduct-service-credit.md

@@ -10,7 +10,7 @@
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `amount` | [`DeductServiceCreditAmount`](../../doc/models/containers/deduct-service-credit-amount.md) | Required | This is a container for one-of cases. |
-| `memo` | `string` | Required | - |
+| `memo` | `string \| undefined` | Optional | - |
 
 ## Example (as JSON)
 

doc/models/historic-usage.md

@@ -0,0 +1,27 @@
+
+# Historic Usage
+
+An optional object for Event Based Components, will be returned if provided `include=historic_usages` query param.
+
+## Structure
+
+`HistoricUsage`
+
+## Fields
+
+| Name | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `totalUsageQuantity` | `number \| undefined` | Optional | Total usage of a component for billing period |
+| `billingPeriodStartsAt` | `string \| undefined` | Optional | Start date of billing period |
+| `billingPeriodEndsAt` | `string \| undefined` | Optional | End date of billing period |
+
+## Example (as JSON)
+
+```json
+{
+  "total_usage_quantity": 26.6,
+  "billing_period_starts_at": "2016-03-13T12:52:32.123Z",
+  "billing_period_ends_at": "2016-03-13T12:52:32.123Z"
+}
+```
+