Skip to content

Commit dd5de92

Browse files
maciej-nedzamaciej-nedza
authored
[DE-988] Release 5.1.0 (#144)
- Add `imported` to subscription `cancellation_method` - Add `id` filter to List Products API
1 parent 9c593ab commit dd5de92

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+335
-194
lines changed

‎README.md‎

Lines changed: 50 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ Install the SDK by adding the following dependency in your project's pom.xml fil
3333
<dependency>
3434
<groupId>com.maxio</groupId>
3535
<artifactId>advanced-billing-sdk</artifactId>
36-
<version>5.0.0</version>
36+
<version>5.1.0</version>
3737
</dependency>
3838
```
3939

4040
You can also view the package at:
41-
https://central.sonatype.com/artifact/com.maxio/advanced-billing-sdk/5.0.0
41+
https://central.sonatype.com/artifact/com.maxio/advanced-billing-sdk/5.1.0
4242

4343
## Initialize the API Client
4444

45-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/client.md)
45+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/client.md)
4646

4747
The following parameters are configurable for the API Client:
4848

@@ -51,8 +51,8 @@ The following parameters are configurable for the API Client:
5151
| `subdomain` | `String` | The subdomain for your Advanced Billing site.<br>*Default*: `"subdomain"` |
5252
| `domain` | `String` | The Advanced Billing server domain.<br>*Default*: `"chargify.com"` |
5353
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
54-
| `httpClientConfig` | [`Consumer<HttpClientConfiguration.Builder>`](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
55-
| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
54+
| `httpClientConfig` | [`Consumer<HttpClientConfiguration.Builder>`](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
55+
| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
5656

5757
The API client can be initialized as follows:
5858

@@ -86,54 +86,55 @@ The SDK can be configured to use a different environment for making API calls. A
8686

8787
This API uses the following authentication schemes.
8888

89-
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/auth/basic-authentication.md)
89+
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/auth/basic-authentication.md)
9090

9191
## List of APIs
9292

93-
* [API Exports](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/api-exports.md)
94-
* [Advance Invoice](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/advance-invoice.md)
95-
* [Billing Portal](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/billing-portal.md)
96-
* [Component Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/component-price-points.md)
97-
* [Custom Fields](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/custom-fields.md)
98-
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/events-based-billing-segments.md)
99-
* [Payment Profiles](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/payment-profiles.md)
100-
* [Product Families](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/product-families.md)
101-
* [Product Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/product-price-points.md)
102-
* [Proforma Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/proforma-invoices.md)
103-
* [Reason Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/reason-codes.md)
104-
* [Referral Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/referral-codes.md)
105-
* [Sales Commissions](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/sales-commissions.md)
106-
* [Subscription Components](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-components.md)
107-
* [Subscription Groups](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-groups.md)
108-
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-group-invoice-account.md)
109-
* [Subscription Group Status](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-group-status.md)
110-
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-invoice-account.md)
111-
* [Subscription Notes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-notes.md)
112-
* [Subscription Products](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-products.md)
113-
* [Subscription Status](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscription-status.md)
114-
* [Coupons](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/coupons.md)
115-
* [Components](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/components.md)
116-
* [Customers](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/customers.md)
117-
* [Events](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/events.md)
118-
* [Insights](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/insights.md)
119-
* [Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/invoices.md)
120-
* [Offers](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/offers.md)
121-
* [Products](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/products.md)
122-
* [Sites](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/sites.md)
123-
* [Subscriptions](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/subscriptions.md)
124-
* [Webhooks](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/controllers/webhooks.md)
93+
* [API Exports](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/api-exports.md)
94+
* [Advance Invoice](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/advance-invoice.md)
95+
* [Billing Portal](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/billing-portal.md)
96+
* [Component Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/component-price-points.md)
97+
* [Custom Fields](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/custom-fields.md)
98+
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/events-based-billing-segments.md)
99+
* [Payment Profiles](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/payment-profiles.md)
100+
* [Product Families](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/product-families.md)
101+
* [Product Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/product-price-points.md)
102+
* [Proforma Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/proforma-invoices.md)
103+
* [Reason Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/reason-codes.md)
104+
* [Referral Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/referral-codes.md)
105+
* [Sales Commissions](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/sales-commissions.md)
106+
* [Subscription Components](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-components.md)
107+
* [Subscription Groups](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-groups.md)
108+
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-group-invoice-account.md)
109+
* [Subscription Group Status](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-group-status.md)
110+
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-invoice-account.md)
111+
* [Subscription Notes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-notes.md)
112+
* [Subscription Products](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-products.md)
113+
* [Subscription Status](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscription-status.md)
114+
* [Coupons](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/coupons.md)
115+
* [Components](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/components.md)
116+
* [Customers](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/customers.md)
117+
* [Events](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/events.md)
118+
* [Insights](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/insights.md)
119+
* [Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/invoices.md)
120+
* [Offers](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/offers.md)
121+
* [Products](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/products.md)
122+
* [Sites](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/sites.md)
123+
* [Subscriptions](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/subscriptions.md)
124+
* [Webhooks](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/controllers/webhooks.md)
125125

126126
## Classes Documentation
127127

128-
* [Utility Classes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/utility-classes.md)
129-
* [HttpRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-request.md)
130-
* [HttpResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-response.md)
131-
* [HttpStringResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-string-response.md)
132-
* [HttpContext](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-context.md)
133-
* [HttpBodyRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-body-request.md)
134-
* [Headers](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/headers.md)
135-
* [ApiException](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/api-exception.md)
136-
* [Configuration Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/configuration-interface.md)
137-
* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-client-configuration.md)
138-
* [HttpClientConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/5.0.0/doc/http-client-configuration-builder.md)
128+
* [Utility Classes](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/utility-classes.md)
129+
* [HttpRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-request.md)
130+
* [HttpResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-response.md)
131+
* [HttpStringResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-string-response.md)
132+
* [HttpContext](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-context.md)
133+
* [HttpBodyRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-body-request.md)
134+
* [HttpCallback Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-callback-interface.md)
135+
* [Headers](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/headers.md)
136+
* [ApiException](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/api-exception.md)
137+
* [Configuration Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/configuration-interface.md)
138+
* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-client-configuration.md)
139+
* [HttpClientConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/5.1.0/doc/http-client-configuration-builder.md)
139140

‎doc/controllers/api-exports.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ List<ProformaInvoice> listExportedProformaInvoices(
3737
| Parameter | Type | Tags | Description |
3838
| --- | --- | --- | --- |
3939
| `batchId` | `String` | Template, Required | Id of a Batch Job. |
40-
| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.<br>Default value is 100.<br>The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000. |
41-
| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`. |
40+
| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.<br>Default value is 100.<br>The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.<br>**Default**: `100`<br>**Constraints**: `>= 1`, `<= 10000` |
41+
| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`.<br>**Default**: `1`<br>**Constraints**: `>= 1` |
4242

4343
## Response Type
4444

@@ -87,8 +87,8 @@ List<Invoice> listExportedInvoices(
8787
| Parameter | Type | Tags | Description |
8888
| --- | --- | --- | --- |
8989
| `batchId` | `String` | Template, Required | Id of a Batch Job. |
90-
| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.<br>Default value is 100.<br>The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000. |
91-
| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`. |
90+
| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.<br>Default value is 100.<br>The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.<br>**Default**: `100`<br>**Constraints**: `>= 1`, `<= 10000` |
91+
| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`.<br>**Default**: `1`<br>**Constraints**: `>= 1` |
9292

9393
## Response Type
9494

@@ -137,8 +137,8 @@ List<Subscription> listExportedSubscriptions(
137137
| Parameter | Type | Tags | Description |
138138
| --- | --- | --- | --- |
139139
| `batchId` | `String` | Template, Required | Id of a Batch Job. |
140-
| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.<br>Default value is 100.<br>The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000. |
141-
| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`. |
140+
| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.<br>Default value is 100.<br>The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.<br>**Default**: `100`<br>**Constraints**: `>= 1`, `<= 10000` |
141+
| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.<br>Use in query `page=1`.<br>**Default**: `1`<br>**Constraints**: `>= 1` |
142142

143143
## Response Type
144144

0 commit comments

Comments
 (0)