Skip to content

Commit

Permalink
Automated commit message
Browse files Browse the repository at this point in the history
  • Loading branch information
@maxio-sdk
maxio-sdk committed Feb 2, 2024
1 parent b4c505c commit f020979
Show file tree
Hide file tree
Showing 30 changed files with 272 additions and 272 deletions.
32 changes: 16 additions & 16 deletions doc/controllers/components.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ ComponentsController componentsController = client.getComponentsController();
* [Create on Off Component](../../doc/controllers/components.md#create-on-off-component)
* [Create Prepaid Usage Component](../../doc/controllers/components.md#create-prepaid-usage-component)
* [Create Event Based Component](../../doc/controllers/components.md#create-event-based-component)
* [Read Component by Handle](../../doc/controllers/components.md#read-component-by-handle)
* [Read Component by Id](../../doc/controllers/components.md#read-component-by-id)
* [Find Component](../../doc/controllers/components.md#find-component)
* [Read Component](../../doc/controllers/components.md#read-component)
* [Update Product Family Component](../../doc/controllers/components.md#update-product-family-component)
* [Archive Component](../../doc/controllers/components.md#archive-component)
* [List Components](../../doc/controllers/components.md#list-components)
* [Update Component](../../doc/controllers/components.md#update-component)
* [Update Default Price Point for Component](../../doc/controllers/components.md#update-default-price-point-for-component)
* [Promote Component Price Point to Default](../../doc/controllers/components.md#promote-component-price-point-to-default)
* [List Components for Product Family](../../doc/controllers/components.md#list-components-for-product-family)
* [Create Component Price Point](../../doc/controllers/components.md#create-component-price-point)
* [List Component Price Points](../../doc/controllers/components.md#list-component-price-points)
* [Create Component Price Points](../../doc/controllers/components.md#create-component-price-points)
* [Bulk Create Component Price Points](../../doc/controllers/components.md#bulk-create-component-price-points)
* [Update Component Price Point](../../doc/controllers/components.md#update-component-price-point)
* [Archive Component Price Point](../../doc/controllers/components.md#archive-component-price-point)
* [Unarchive Component Price Point](../../doc/controllers/components.md#unarchive-component-price-point)
Expand Down Expand Up @@ -659,12 +659,12 @@ try {
| 422 | Unprocessable Entity (WebDAV) | [`ErrorListResponseException`](../../doc/models/error-list-response-exception.md) |


# Read Component by Handle
# Find Component

This request will return information regarding a component having the handle you provide. You can identify your components with a handle so you don't have to save or reference the IDs we generate.

```java
ComponentResponse readComponentByHandle(
ComponentResponse findComponent(
final String handle)
```

Expand All @@ -684,7 +684,7 @@ ComponentResponse readComponentByHandle(
String handle = "handle6";

try {
ComponentResponse result = componentsController.readComponentByHandle(handle);
ComponentResponse result = componentsController.findComponent(handle);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down Expand Up @@ -724,14 +724,14 @@ try {
```


# Read Component by Id
# Read Component

This request will return information regarding a component from a specific product family.

You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`.

```java
ComponentResponse readComponentById(
ComponentResponse readComponent(
final int productFamilyId,
final String componentId)
```
Expand All @@ -754,7 +754,7 @@ int productFamilyId = 140;
String componentId = "component_id8";

try {
ComponentResponse result = componentsController.readComponentById(productFamilyId, componentId);
ComponentResponse result = componentsController.readComponent(productFamilyId, componentId);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down Expand Up @@ -1173,7 +1173,7 @@ try {
| 422 | Unprocessable Entity (WebDAV) | [`ErrorListResponseException`](../../doc/models/error-list-response-exception.md) |


# Update Default Price Point for Component
# Promote Component Price Point to Default

Sets a new default price point for the component. This new default will apply to all new subscriptions going forward - existing subscriptions will remain on their current price point.

Expand All @@ -1182,7 +1182,7 @@ See [Price Points Documentation](https://chargify.zendesk.com/hc/en-us/articles/
Note: Custom price points are not able to be set as the default for a component.

```java
ComponentResponse updateDefaultPricePointForComponent(
ComponentResponse promoteComponentPricePointToDefault(
final int componentId,
final int pricePointId)
```
Expand All @@ -1205,7 +1205,7 @@ int componentId = 222;
int pricePointId = 10;

try {
ComponentResponse result = componentsController.updateDefaultPricePointForComponent(componentId, pricePointId);
ComponentResponse result = componentsController.promoteComponentPricePointToDefault(componentId, pricePointId);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down Expand Up @@ -1566,12 +1566,12 @@ try {
```


# Create Component Price Points
# Bulk Create Component Price Points

Use this endpoint to create multiple component price points in one request.

```java
ComponentPricePointsResponse createComponentPricePoints(
ComponentPricePointsResponse bulkCreateComponentPricePoints(
final String componentId,
final CreateComponentPricePointsRequest body)
```
Expand Down Expand Up @@ -1655,7 +1655,7 @@ CreateComponentPricePointsRequest body = new CreateComponentPricePointsRequest.B
.build();

try {
ComponentPricePointsResponse result = componentsController.createComponentPricePoints(componentId, body);
ComponentPricePointsResponse result = componentsController.bulkCreateComponentPricePoints(componentId, body);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down
16 changes: 8 additions & 8 deletions doc/controllers/coupons.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ CouponsController couponsController = client.getCouponsController();

* [Create Coupon](../../doc/controllers/coupons.md#create-coupon)
* [List Coupons for Product Family](../../doc/controllers/coupons.md#list-coupons-for-product-family)
* [Read Coupon by Code](../../doc/controllers/coupons.md#read-coupon-by-code)
* [Find Coupon](../../doc/controllers/coupons.md#find-coupon)
* [Read Coupon](../../doc/controllers/coupons.md#read-coupon)
* [Update Coupon](../../doc/controllers/coupons.md#update-coupon)
* [Archive Coupon](../../doc/controllers/coupons.md#archive-coupon)
* [List Coupons](../../doc/controllers/coupons.md#list-coupons)
* [Read Coupon Usage](../../doc/controllers/coupons.md#read-coupon-usage)
* [Validate Coupon](../../doc/controllers/coupons.md#validate-coupon)
* [Update Coupon Currency Prices](../../doc/controllers/coupons.md#update-coupon-currency-prices)
* [Create or Update Coupon Currency Prices](../../doc/controllers/coupons.md#create-or-update-coupon-currency-prices)
* [Create Coupon Subcodes](../../doc/controllers/coupons.md#create-coupon-subcodes)
* [List Coupon Subcodes](../../doc/controllers/coupons.md#list-coupon-subcodes)
* [Update Coupon Subcodes](../../doc/controllers/coupons.md#update-coupon-subcodes)
Expand Down Expand Up @@ -257,14 +257,14 @@ try {
```


# Read Coupon by Code
# Find Coupon

You can search for a coupon via the API with the find method. By passing a code parameter, the find will attempt to locate a coupon that matches that code. If no coupon is found, a 404 is returned.

If you have more than one product family and if the coupon you are trying to find does not belong to the default product family in your site, then you will need to specify (either in the url or as a query string param) the product family id.

```java
CouponResponse readCouponByCode(
CouponResponse findCoupon(
final Integer productFamilyId,
final String code)
```
Expand All @@ -284,7 +284,7 @@ CouponResponse readCouponByCode(

```java
try {
CouponResponse result = couponsController.readCouponByCode(null, null);
CouponResponse result = couponsController.findCoupon(null, null);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down Expand Up @@ -811,14 +811,14 @@ try {
| 404 | Not Found | [`SingleStringErrorResponseException`](../../doc/models/single-string-error-response-exception.md) |


# Update Coupon Currency Prices
# Create or Update Coupon Currency Prices

This endpoint allows you to create and/or update currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage.

Currency pricing for coupons must mirror the setup of the primary coupon pricing - if the primary coupon is percentage based, you will not be able to define pricing in non-primary currencies.

```java
CouponCurrencyResponse updateCouponCurrencyPrices(
CouponCurrencyResponse createOrUpdateCouponCurrencyPrices(
final int couponId,
final CouponCurrencyRequest body)
```
Expand Down Expand Up @@ -855,7 +855,7 @@ CouponCurrencyRequest body = new CouponCurrencyRequest.Builder(
.build();

try {
CouponCurrencyResponse result = couponsController.updateCouponCurrencyPrices(couponId, body);
CouponCurrencyResponse result = couponsController.createOrUpdateCouponCurrencyPrices(couponId, body);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down
16 changes: 8 additions & 8 deletions doc/controllers/events-based-billing-segments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ EventsBasedBillingSegmentsController eventsBasedBillingSegmentsController = clie
* [List Segments for Price Point](../../doc/controllers/events-based-billing-segments.md#list-segments-for-price-point)
* [Update Segment](../../doc/controllers/events-based-billing-segments.md#update-segment)
* [Delete Segment](../../doc/controllers/events-based-billing-segments.md#delete-segment)
* [Create Segments](../../doc/controllers/events-based-billing-segments.md#create-segments)
* [Update Segments](../../doc/controllers/events-based-billing-segments.md#update-segments)
* [Bulk Create Segments](../../doc/controllers/events-based-billing-segments.md#bulk-create-segments)
* [Bulk Update Segments](../../doc/controllers/events-based-billing-segments.md#bulk-update-segments)


# Create Segment
Expand Down Expand Up @@ -256,7 +256,7 @@ try {
| 422 | Unprocessable Entity (WebDAV) | `ApiException` |


# Create Segments
# Bulk Create Segments

This endpoint allows you to create multiple segments in one request. The array of segments can contain up to `2000` records.

Expand All @@ -265,7 +265,7 @@ If any of the records contain an error the whole request would fail and none of
You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax.

```java
ListSegmentsResponse createSegments(
ListSegmentsResponse bulkCreateSegments(
final String componentId,
final String pricePointId,
final BulkCreateSegments body)
Expand All @@ -289,7 +289,7 @@ ListSegmentsResponse createSegments(
String componentId = "component_id8";
String pricePointId = "price_point_id8";
try {
ListSegmentsResponse result = eventsBasedBillingSegmentsController.createSegments(componentId, pricePointId, null);
ListSegmentsResponse result = eventsBasedBillingSegmentsController.bulkCreateSegments(componentId, pricePointId, null);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand All @@ -306,7 +306,7 @@ try {
| 422 | Unprocessable Entity (WebDAV) | [`EventBasedBillingSegmentException`](../../doc/models/event-based-billing-segment-exception.md) |


# Update Segments
# Bulk Update Segments

This endpoint allows you to update multiple segments in one request. The array of segments can contain up to `1000` records.

Expand All @@ -315,7 +315,7 @@ If any of the records contain an error the whole request would fail and none of
You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax.

```java
ListSegmentsResponse updateSegments(
ListSegmentsResponse bulkUpdateSegments(
final String componentId,
final String pricePointId,
final BulkUpdateSegments body)
Expand All @@ -339,7 +339,7 @@ ListSegmentsResponse updateSegments(
String componentId = "component_id8";
String pricePointId = "price_point_id8";
try {
ListSegmentsResponse result = eventsBasedBillingSegmentsController.updateSegments(componentId, pricePointId, null);
ListSegmentsResponse result = eventsBasedBillingSegmentsController.bulkUpdateSegments(componentId, pricePointId, null);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down
12 changes: 6 additions & 6 deletions doc/controllers/insights.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ InsightsController insightsController = client.getInsightsController();

* [Read Site Stats](../../doc/controllers/insights.md#read-site-stats)
* [Read Mrr](../../doc/controllers/insights.md#read-mrr)
* [Read Mrr Movements](../../doc/controllers/insights.md#read-mrr-movements)
* [List Mrr Movements](../../doc/controllers/insights.md#list-mrr-movements)
* [List Mrr Per Subscription](../../doc/controllers/insights.md#list-mrr-per-subscription)


Expand Down Expand Up @@ -126,7 +126,7 @@ try {
```


# Read Mrr Movements
# List Mrr Movements

**This endpoint is deprecated.**

Expand Down Expand Up @@ -156,8 +156,8 @@ Usage includes revenue from:
* Prepaid Usage Components

```java
ListMRRResponse readMrrMovements(
final ReadMrrMovementsInput input)
ListMRRResponse listMrrMovements(
final ListMrrMovementsInput input)
```

## Parameters
Expand All @@ -176,13 +176,13 @@ ListMRRResponse readMrrMovements(
## Example Usage

```java
ReadMrrMovementsInput readMrrMovementsInput = new ReadMrrMovementsInput.Builder()
ListMrrMovementsInput listMrrMovementsInput = new ListMrrMovementsInput.Builder()
.page(2)
.perPage(20)
.build();

try {
ListMRRResponse result = insightsController.readMrrMovements(readMrrMovementsInput);
ListMRRResponse result = insightsController.listMrrMovements(listMrrMovementsInput);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down
20 changes: 10 additions & 10 deletions doc/controllers/invoices.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ InvoicesController invoicesController = client.getInvoicesController();
* [Read Invoice](../../doc/controllers/invoices.md#read-invoice)
* [List Invoice Events](../../doc/controllers/invoices.md#list-invoice-events)
* [Record Payment for Invoice](../../doc/controllers/invoices.md#record-payment-for-invoice)
* [Record External Payment for Invoices](../../doc/controllers/invoices.md#record-external-payment-for-invoices)
* [Record Payment for Multiple Invoices](../../doc/controllers/invoices.md#record-payment-for-multiple-invoices)
* [List Credit Notes](../../doc/controllers/invoices.md#list-credit-notes)
* [Read Credit Note](../../doc/controllers/invoices.md#read-credit-note)
* [Record Payment for Subscription](../../doc/controllers/invoices.md#record-payment-for-subscription)
* [Reopen Invoice](../../doc/controllers/invoices.md#reopen-invoice)
* [Void Invoice](../../doc/controllers/invoices.md#void-invoice)
* [List Invoice Segments](../../doc/controllers/invoices.md#list-invoice-segments)
* [List Consolidated Invoice Segments](../../doc/controllers/invoices.md#list-consolidated-invoice-segments)
* [Create Invoice](../../doc/controllers/invoices.md#create-invoice)
* [Send Invoice](../../doc/controllers/invoices.md#send-invoice)
* [Preview Customer Information Changes](../../doc/controllers/invoices.md#preview-customer-information-changes)
Expand Down Expand Up @@ -1128,7 +1128,7 @@ try {
```


# Record External Payment for Invoices
# Record Payment for Multiple Invoices

This API call should be used when you want to record an external payment against multiple invoices.

Expand Down Expand Up @@ -1158,7 +1158,7 @@ In order apply a payment to multiple invoices, at minimum, specify the `amount`
Note that the invoice payment amounts must be greater than 0. Total amount must be greater or equal to invoices payment amount sum.

```java
MultiInvoicePaymentResponse recordExternalPaymentForInvoices(
MultiInvoicePaymentResponse recordPaymentForMultipleInvoices(
final CreateMultiInvoicePaymentRequest body)
```

Expand Down Expand Up @@ -1201,7 +1201,7 @@ CreateMultiInvoicePaymentRequest body = new CreateMultiInvoicePaymentRequest.Bui
.build();

try {
MultiInvoicePaymentResponse result = invoicesController.recordExternalPaymentForInvoices(body);
MultiInvoicePaymentResponse result = invoicesController.recordPaymentForMultipleInvoices(body);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down Expand Up @@ -2073,13 +2073,13 @@ try {
| 422 | Unprocessable Entity (WebDAV) | [`ErrorListResponseException`](../../doc/models/error-list-response-exception.md) |


# List Invoice Segments
# List Consolidated Invoice Segments

Invoice segments returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`.

```java
ConsolidatedInvoice listInvoiceSegments(
final ListInvoiceSegmentsInput input)
ConsolidatedInvoice listConsolidatedInvoiceSegments(
final ListConsolidatedInvoiceSegmentsInput input)
```

## Parameters
Expand All @@ -2098,7 +2098,7 @@ ConsolidatedInvoice listInvoiceSegments(
## Example Usage

```java
ListInvoiceSegmentsInput listInvoiceSegmentsInput = new ListInvoiceSegmentsInput.Builder(
ListConsolidatedInvoiceSegmentsInput listConsolidatedInvoiceSegmentsInput = new ListConsolidatedInvoiceSegmentsInput.Builder(
"invoice_uid0"
)
.page(2)
Expand All @@ -2107,7 +2107,7 @@ ListInvoiceSegmentsInput listInvoiceSegmentsInput = new ListInvoiceSegmentsInput
.build();

try {
ConsolidatedInvoice result = invoicesController.listInvoiceSegments(listInvoiceSegmentsInput);
ConsolidatedInvoice result = invoicesController.listConsolidatedInvoiceSegments(listConsolidatedInvoiceSegmentsInput);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down
Loading

0 comments on commit f020979

Please sign in to comment.