Skip to content

[DE-1099] Release 6.1.0 #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maciej-nedza merged 1 commit into from
Jan 21, 2025
Merged

[DE-1099] Release 6.1.0 #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ License:
The MIT License (MIT)
http://opensource.org/licenses/MIT

Copyright (c) 2014 - 2024 APIMATIC Limited
Copyright (c) 2014 - 2025 APIMATIC Limited

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
82 changes: 41 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,19 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json

## Install the Package

The package is compatible with Python versions `3 >=3.7, <= 3.11`.
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==6.0.0
pip install maxio-advanced-billing-sdk==6.1.0
```

You can also view the package at:
https://pypi.python.org/pypi/maxio-advanced-billing-sdk/6.0.0
https://pypi.python.org/pypi/maxio-advanced-billing-sdk/6.1.0

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/client.md)
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/client.md)

The following parameters are configurable for the API Client:

Expand All @@ -55,7 +55,7 @@ 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']** |
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |

The API client can be initialized as follows:

Expand Down Expand Up @@ -85,46 +85,46 @@ 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/6.0.0/doc/auth/basic-authentication.md)
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/auth/basic-authentication.md)

## List of APIs

* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/api-exports.md)
* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/advance-invoice.md)
* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/billing-portal.md)
* [Component Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/component-price-points.md)
* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/custom-fields.md)
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/events-based-billing-segments.md)
* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/payment-profiles.md)
* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/product-families.md)
* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/product-price-points.md)
* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/proforma-invoices.md)
* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/reason-codes.md)
* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/referral-codes.md)
* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/sales-commissions.md)
* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-components.md)
* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-groups.md)
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-group-invoice-account.md)
* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-group-status.md)
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-invoice-account.md)
* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-notes.md)
* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-products.md)
* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscription-status.md)
* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/coupons.md)
* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/components.md)
* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/customers.md)
* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/events.md)
* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/insights.md)
* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/invoices.md)
* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/offers.md)
* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/products.md)
* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/sites.md)
* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/subscriptions.md)
* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/controllers/webhooks.md)
* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/api-exports.md)
* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/advance-invoice.md)
* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/billing-portal.md)
* [Component Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/component-price-points.md)
* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/custom-fields.md)
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/events-based-billing-segments.md)
* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/payment-profiles.md)
* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/product-families.md)
* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/product-price-points.md)
* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/proforma-invoices.md)
* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/reason-codes.md)
* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/referral-codes.md)
* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/sales-commissions.md)
* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-components.md)
* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-groups.md)
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-group-invoice-account.md)
* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-group-status.md)
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-invoice-account.md)
* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-notes.md)
* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-products.md)
* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscription-status.md)
* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/coupons.md)
* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/components.md)
* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/customers.md)
* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/events.md)
* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/insights.md)
* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/invoices.md)
* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/offers.md)
* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/products.md)
* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/sites.md)
* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/subscriptions.md)
* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/controllers/webhooks.md)

## Classes Documentation

* [Utility Classes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/6.0.0/doc/http-request.md)
* [Utility Classes](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/6.1.0/doc/http-request.md)

6 changes: 3 additions & 3 deletions advancedbilling/controllers/advance_invoice_controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ def issue_advance_invoice(self,

Args:
subscription_id (int): The Chargify id of the subscription
body (IssueAdvanceInvoiceRequest, optional): TODO: type
description here.
body (IssueAdvanceInvoiceRequest, optional): The request body
parameter.

Returns:
Invoice: Response from the API. Created
Expand Down Expand Up @@ -149,7 +149,7 @@ def void_advance_invoice(self,

Args:
subscription_id (int): The Chargify id of the subscription
body (VoidInvoiceRequest, optional): TODO: type description here.
body (VoidInvoiceRequest, optional): The request body parameter.

Returns:
Invoice: Response from the API. Created
Expand Down
2 changes: 1 addition & 1 deletion advancedbilling/controllers/base_controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class BaseController(object):

@staticmethod
def user_agent():
return 'AB SDK Python:6.0.0 on OS {os-info}'
return 'AB SDK Python:6.1.0 on OS {os-info}'

@staticmethod
def user_agent_parameters():
Expand Down
20 changes: 10 additions & 10 deletions advancedbilling/controllers/component_price_points_controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ def create_component_price_point(self,

Args:
component_id (int): The Advanced Billing id of the component
body (CreateComponentPricePointRequest, optional): TODO: type
description here.
body (CreateComponentPricePointRequest, optional): The request
body parameter.

Returns:
ComponentPricePointResponse: Response from the API. OK
Expand Down Expand Up @@ -235,8 +235,8 @@ def bulk_create_component_price_points(self,
Args:
component_id (str): The Advanced Billing id of the component for
which you want to fetch price points.
body (CreateComponentPricePointsRequest, optional): TODO: type
description here.
body (CreateComponentPricePointsRequest, optional): The request
body parameter.

Returns:
ComponentPricePointsResponse: Response from the API. OK
Expand Down Expand Up @@ -300,8 +300,8 @@ def update_component_price_point(self,
When using the handle, it must be prefixed with `handle:`.
Example: `123` for an integer ID, or
`handle:example-price_point-handle` for a string handle.
body (UpdateComponentPricePointRequest, optional): TODO: type
description here.
body (UpdateComponentPricePointRequest, optional): The request
body parameter.

Returns:
ComponentPricePointResponse: Response from the API. OK
Expand Down Expand Up @@ -529,8 +529,8 @@ def create_currency_prices(self,

Args:
price_point_id (int): The Advanced Billing id of the price point
body (CreateCurrencyPricesRequest, optional): TODO: type
description here.
body (CreateCurrencyPricesRequest, optional): The request body
parameter.

Returns:
ComponentCurrencyPricesResponse: Response from the API. OK
Expand Down Expand Up @@ -581,8 +581,8 @@ def update_currency_prices(self,

Args:
price_point_id (int): The Advanced Billing id of the price point
body (UpdateCurrencyPricesRequest, optional): TODO: type
description here.
body (UpdateCurrencyPricesRequest, optional): The request body
parameter.

Returns:
ComponentCurrencyPricesResponse: Response from the API. OK
Expand Down
24 changes: 12 additions & 12 deletions advancedbilling/controllers/components_controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ def create_metered_component(self,
Args:
product_family_id (str): Either the product family's id or its
handle prefixed with `handle:`
body (CreateMeteredComponent, optional): TODO: type description
here.
body (CreateMeteredComponent, optional): The request body
parameter.

Returns:
ComponentResponse: Response from the API. Created
Expand Down Expand Up @@ -121,8 +121,8 @@ def create_quantity_based_component(self,
Args:
product_family_id (str): Either the product family's id or its
handle prefixed with `handle:`
body (CreateQuantityBasedComponent, optional): TODO: type
description here.
body (CreateQuantityBasedComponent, optional): The request body
parameter.

Returns:
ComponentResponse: Response from the API. Created
Expand Down Expand Up @@ -179,7 +179,7 @@ def create_on_off_component(self,
Args:
product_family_id (str): Either the product family's id or its
handle prefixed with `handle:`
body (CreateOnOffComponent, optional): TODO: type description here.
body (CreateOnOffComponent, optional): The request body parameter.

Returns:
ComponentResponse: Response from the API. Created
Expand Down Expand Up @@ -240,8 +240,8 @@ def create_prepaid_usage_component(self,
Args:
product_family_id (str): Either the product family's id or its
handle prefixed with `handle:`
body (CreatePrepaidComponent, optional): TODO: type description
here.
body (CreatePrepaidComponent, optional): The request body
parameter.

Returns:
ComponentResponse: Response from the API. Created
Expand Down Expand Up @@ -306,7 +306,7 @@ def create_event_based_component(self,
Args:
product_family_id (str): Either the product family's id or its
handle prefixed with `handle:`
body (CreateEBBComponent, optional): TODO: type description here.
body (CreateEBBComponent, optional): The request body parameter.

Returns:
ComponentResponse: Response from the API. Created
Expand Down Expand Up @@ -454,8 +454,8 @@ def update_product_family_component(self,
component_id (str): Either the Advanced Billing id of the
component or the handle for the component prefixed with
`handle:`
body (UpdateComponentRequest, optional): TODO: type description
here.
body (UpdateComponentRequest, optional): The request body
parameter.

Returns:
ComponentResponse: Response from the API. OK
Expand Down Expand Up @@ -671,8 +671,8 @@ def update_component(self,

Args:
component_id (str): The id or handle of the component
body (UpdateComponentRequest, optional): TODO: type description
here.
body (UpdateComponentRequest, optional): The request body
parameter.

Returns:
ComponentResponse: Response from the API. OK
Expand Down
11 changes: 5 additions & 6 deletions advancedbilling/controllers/coupons_controller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def create_coupon(self,
Args:
product_family_id (int): The Advanced Billing id of the product
family to which the coupon belongs
body (CouponRequest, optional): TODO: type description here.
body (CouponRequest, optional): The request body parameter.

Returns:
CouponResponse: Response from the API. Created
Expand Down Expand Up @@ -322,7 +322,7 @@ def update_coupon(self,
product_family_id (int): The Advanced Billing id of the product
family to which the coupon belongs
coupon_id (int): The Advanced Billing id of the coupon
body (CouponRequest, optional): TODO: type description here.
body (CouponRequest, optional): The request body parameter.

Returns:
CouponResponse: Response from the API. OK
Expand Down Expand Up @@ -627,8 +627,7 @@ def create_or_update_coupon_currency_prices(self,

Args:
coupon_id (int): The Advanced Billing id of the coupon
body (CouponCurrencyRequest, optional): TODO: type description
here.
body (CouponCurrencyRequest, optional): The request body parameter.

Returns:
CouponCurrencyResponse: Response from the API. OK
Expand Down Expand Up @@ -715,7 +714,7 @@ def create_coupon_subcodes(self,

Args:
coupon_id (int): The Advanced Billing id of the coupon
body (CouponSubcodes, optional): TODO: type description here.
body (CouponSubcodes, optional): The request body parameter.

Returns:
CouponSubcodesResponse: Response from the API. OK
Expand Down Expand Up @@ -836,7 +835,7 @@ def update_coupon_subcodes(self,

Args:
coupon_id (int): The Advanced Billing id of the coupon
body (CouponSubcodes, optional): TODO: type description here.
body (CouponSubcodes, optional): The request body parameter.

Returns:
CouponSubcodesResponse: Response from the API. OK
Expand Down
Loading
Loading