Release 10.0.0

README.md

@@ -30,22 +30,22 @@ The package is compatible with Python versions `3.7+`.
 Install the package from PyPi using the following pip command:
 
 ```bash
-pip install maxio-advanced-billing-sdk==9.1.0
+pip install maxio-advanced-billing-sdk==10.0.0
 ```
 
 You can also view the package at:
-https://pypi.python.org/pypi/maxio-advanced-billing-sdk/9.1.0
+https://pypi.python.org/pypi/maxio-advanced-billing-sdk/10.0.0
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
 | site | `str` | The subdomain for your Advanced Billing site.<br>*Default*: `"subdomain"` |
-| environment | [`Environment`](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/README.md#environments) | The API environment. <br> **Default: `Environment.US`** |
+| environment | [`Environment`](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.US`** |
 | http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
 | override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
 | http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
@@ -54,8 +54,8 @@ The following parameters are configurable for the API Client:
 | backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
 | retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
-| proxy_settings | [`ProxySettings`](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+| proxy_settings | [`ProxySettings`](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
 
 The API client can be initialized as follows:
 
@@ -85,7 +85,7 @@ from advancedbilling.advanced_billing_client import AdvancedBillingClient
 client = AdvancedBillingClient.from_environment(dotenv_path='/path/to/.env')
 ```
 
-See the [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/environment-based-client-initialization.md) section for details.
+See the [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/environment-based-client-initialization.md) section for details.
 
 ## Environments
 
@@ -102,60 +102,60 @@ 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-python-sdk/tree/9.1.0/doc/auth/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/auth/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/billing-portal.md)
-* [Component Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/component-price-points.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-products.md)
-* [Subscription Renewals](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-renewals.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-products.md)
+* [Subscription Renewals](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-renewals.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/controllers/webhooks.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/environment-based-client-initialization.md)
+* [ProxySettings](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/environment-based-client-initialization.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/http-request.md)
+* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/api-helper.md)
-* [HttpDateTime](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/http-date-time.md)
-* [RFC3339DateTime](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/rfc3339-date-time.md)
-* [UnixDateTime](https://www.github.com/maxio-com/ab-python-sdk/tree/9.1.0/doc/unix-date-time.md)
+* [ApiHelper](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/api-helper.md)
+* [HttpDateTime](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/http-date-time.md)
+* [RFC3339DateTime](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/rfc3339-date-time.md)
+* [UnixDateTime](https://www.github.com/maxio-com/ab-python-sdk/tree/10.0.0/doc/unix-date-time.md)
 

advancedbilling/controllers/advance_invoice_controller.py

@@ -42,21 +42,21 @@ def issue_advance_invoice(self,
         """Perform a POST request to
         /subscriptions/{subscription_id}/advance_invoice/issue.json.
 
-        Generate an invoice in advance for a subscription's next renewal date. [See
-        our
-        docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice
-        -In-Advance) for more information on advance invoices, including eligibility
-        for 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
+        Issues an invoice in advance for a subscription's next renewal date. For the
+        most part, advance invoices function like any other invoice, except they are
+        issued early and have special behavior upon being voided. For more
+        information on advance invoices, including eligibility for generating one,
+        see [Issue Invoice In
+        Advance](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invo
+        ice-In-Advance).
+        A subscription can only have one advance invoice per billing period.
+        Attempting to issue an advance invoice when one already exists returns 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.
+        Regeneration of the invoice can be forced with the params `force: true`,
+        which voids an advance invoice if one exists and generates a new one. If no
+        advance invoice exists, a new one is generated.
+        Consider using either the create or preview endpoints for proforma invoices
+        to preview this advance invoice before using this endpoint to generate it.
 
         Args:
             subscription_id (int): The Chargify id of the subscription.
@@ -147,12 +147,12 @@ def void_advance_invoice(self,
         """Perform a POST request to
         /subscriptions/{subscription_id}/advance_invoice/void.json.
 
-        Void a subscription's existing advance invoice. Once voided, it can later be
+        Voids a subscription's existing advance invoice. Once voided, it can later be
         regenerated if desired.
-        A `reason` is required in order to void, and the invoice must have an open
-        status. Voiding will cause any prepayments and credits that were applied to
-        the invoice to be returned to the subscription. For a full overview of the
-        impact of voiding, [see our help docs]($m/Invoice).
+        A `reason` is required to void, and the invoice must have an open status.
+        Voiding causes any prepayments and credits that were applied to the invoice
+        to be returned to the subscription.
+        For a full overview of the impact of voiding, see [Invoice]($m/Invoice).
 
         Args:
             subscription_id (int): The Chargify id of the subscription.

advancedbilling/controllers/api_exports_controller.py

@@ -245,8 +245,8 @@ def list_exported_subscriptions(self,
     def export_proforma_invoices(self):
         """Perform a POST request to /api_exports/proforma_invoices.json.
 
-        Creates a proforma invoices export and returns a batch job object.
-        It is only available for Relationship Invoicing architecture.
+        Creates a proforma invoices export and returns a batch job object. Proforma
+        invoices are only available on Relationship Invoicing sites.
 
         Returns:
             BatchJobResponse: Response from the API. Created
@@ -346,7 +346,8 @@ def read_proforma_invoices_export(self,
         """Perform a GET request to
         /api_exports/proforma_invoices/{batch_id}.json.
 
-        Returns a batch job object for a proforma invoices export.
+        Returns a batch job object for a proforma invoices export. Proforma invoices
+        are only available on Relationship Invoicing sites.
 
         Args:
             batch_id (str): Id of a Batch Job.

advancedbilling/controllers/base_controller.py

@@ -31,7 +31,7 @@ class BaseController(object):
     @staticmethod
     def user_agent():
         """Return UserAgent value."""
-        return "AB SDK Python:9.1.0 on OS {os-info}"
+        return "AB SDK Python:10.0.0 on OS {os-info}"
 
     @staticmethod
     def user_agent_parameters():