Skip to content
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

Jump to bottom

[DE-736] Merge proforma invoice and preview proforma #112

Merged
merged 2 commits into from
Feb 22, 2024
Merged

[DE-736] Merge proforma invoice and preview proforma #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a20fa9
Automated commit message
maxio-sdk Feb 22, 2024
09a057d
[DE-736] Fix test after adding kind to Invoice line item
maciej-nedza Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/controllers/proforma-invoices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Only proforma invoices with a `consolidation_level` of parent are returned.
By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to true.

```java
ProformaInvoice listSubscriptionGroupProformaInvoices(
ListProformaInvoicesResponse listSubscriptionGroupProformaInvoices(
final String uid)
```

Expand All @@ -86,15 +86,15 @@ ProformaInvoice listSubscriptionGroupProformaInvoices(

## Response Type

[`ProformaInvoice`](../../doc/models/proforma-invoice.md)
[`ListProformaInvoicesResponse`](../../doc/models/list-proforma-invoices-response.md)

## Example Usage

```java
String uid = "uid0";

try {
ProformaInvoice result = proformaInvoicesController.listSubscriptionGroupProformaInvoices(uid);
ListProformaInvoicesResponse result = proformaInvoicesController.listSubscriptionGroupProformaInvoices(uid);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down Expand Up @@ -323,7 +323,7 @@ If all the data returned in the preview is as expected, you may then create a st
Alternatively, if you have some proforma invoices already, you may make a preview call to determine whether any billing information for the subscription's upcoming renewal has changed.

```java
ProformaInvoicePreview previewProformaInvoice(
ProformaInvoice previewProformaInvoice(
final int subscriptionId)
```

Expand All @@ -335,15 +335,15 @@ ProformaInvoicePreview previewProformaInvoice(

## Response Type

[`ProformaInvoicePreview`](../../doc/models/proforma-invoice-preview.md)
[`ProformaInvoice`](../../doc/models/proforma-invoice.md)

## Example Usage

```java
int subscriptionId = 222;

try {
ProformaInvoicePreview result = proformaInvoicesController.previewProformaInvoice(subscriptionId);
ProformaInvoice result = proformaInvoicesController.previewProformaInvoice(subscriptionId);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
Expand Down
2 changes: 1 addition & 1 deletion doc/models/event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| `Key` | `String` | Required | **Constraints**: *Minimum Length*: `1` | String getKey() | setKey(String key) |
| `Message` | `String` | Required | **Constraints**: *Minimum Length*: `1` | String getMessage() | setMessage(String message) |
| `SubscriptionId` | `Integer` | Required | - | Integer getSubscriptionId() | setSubscriptionId(Integer subscriptionId) |
| `CustomerId` | `int` | Required | - | int getCustomerId() | setCustomerId(int customerId) |
| `CustomerId` | `Integer` | Required | - | Integer getCustomerId() | setCustomerId(Integer customerId) |
| `CreatedAt` | `ZonedDateTime` | Required | - | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
| `EventSpecificData` | [`EventEventSpecificData`](../../doc/models/containers/event-event-specific-data.md) | Required | This is a container for one-of cases. | EventEventSpecificData getEventSpecificData() | setEventSpecificData(EventEventSpecificData eventSpecificData) |

Expand Down
1 change: 1 addition & 0 deletions doc/models/invoice-line-item.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
| `ComponentCostData` | [`InvoiceLineItemComponentCostData2`](../../doc/models/containers/invoice-line-item-component-cost-data-2.md) | Optional | This is a container for one-of cases. | InvoiceLineItemComponentCostData2 getComponentCostData() | setComponentCostData(InvoiceLineItemComponentCostData2 componentCostData) |
| `ProductPricePointId` | `Integer` | Optional | The price point ID of the line item's product | Integer getProductPricePointId() | setProductPricePointId(Integer productPricePointId) |
| `CustomItem` | `Boolean` | Optional | - | Boolean getCustomItem() | setCustomItem(Boolean customItem) |
| `Kind` | `String` | Optional | - | String getKind() | setKind(String kind) |

## Example (as JSON)

Expand Down
60 changes: 0 additions & 60 deletions doc/models/proforma-invoice-preview.md
View file
Open in desktop

This file was deleted.

21 changes: 10 additions & 11 deletions src/main/java/com/maxio/advancedbilling/controllers/ProformaInvoicesController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
import com.maxio.advancedbilling.models.ListProformaInvoicesInput;
import com.maxio.advancedbilling.models.ListProformaInvoicesResponse;
import com.maxio.advancedbilling.models.ProformaInvoice;
import com.maxio.advancedbilling.models.ProformaInvoicePreview;
import com.maxio.advancedbilling.models.SignupProformaPreviewResponse;
import com.maxio.advancedbilling.models.VoidInvoiceRequest;
import io.apimatic.core.ApiCall;
Expand Down Expand Up @@ -90,21 +89,21 @@ private ApiCall<Void, ApiException> prepareCreateConsolidatedProformaInvoiceRequ
* `line_items`, `discounts`, `taxes`, `credits`, `payments`, `custom_fields`. To include
* breakdowns, pass the specific field as a key in the query with a value set to true.
* @param uid Required parameter: The uid of the subscription group
* @return Returns the ProformaInvoice response from the API call
* @return Returns the ListProformaInvoicesResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public ProformaInvoice listSubscriptionGroupProformaInvoices(
public ListProformaInvoicesResponse listSubscriptionGroupProformaInvoices(
final String uid) throws ApiException, IOException {
return prepareListSubscriptionGroupProformaInvoicesRequest(uid).execute();
}

/**
* Builds the ApiCall object for listSubscriptionGroupProformaInvoices.
*/
private ApiCall<ProformaInvoice, ApiException> prepareListSubscriptionGroupProformaInvoicesRequest(
private ApiCall<ListProformaInvoicesResponse, ApiException> prepareListSubscriptionGroupProformaInvoicesRequest(
final String uid) throws IOException {
return new ApiCall.Builder<ProformaInvoice, ApiException>()
return new ApiCall.Builder<ListProformaInvoicesResponse, ApiException>()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
Expand All @@ -117,7 +116,7 @@ private ApiCall<ProformaInvoice, ApiException> prepareListSubscriptionGroupProfo
.httpMethod(HttpMethod.GET))
.responseHandler(responseHandler -> responseHandler
.deserializer(
response -> ApiHelper.deserialize(response, ProformaInvoice.class))
response -> ApiHelper.deserialize(response, ListProformaInvoicesResponse.class))
.nullify404(false)
.localErrorCase("404",
ErrorCase.setTemplate("Not Found:'{$response.body}'",
Expand Down Expand Up @@ -351,21 +350,21 @@ private ApiCall<ProformaInvoice, ApiException> prepareVoidProformaInvoiceRequest
* you may make a preview call to determine whether any billing information for the
* subscription's upcoming renewal has changed.
* @param subscriptionId Required parameter: The Chargify id of the subscription
* @return Returns the ProformaInvoicePreview response from the API call
* @return Returns the ProformaInvoice response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
*/
public ProformaInvoicePreview previewProformaInvoice(
public ProformaInvoice previewProformaInvoice(
final int subscriptionId) throws ApiException, IOException {
return preparePreviewProformaInvoiceRequest(subscriptionId).execute();
}

/**
* Builds the ApiCall object for previewProformaInvoice.
*/
private ApiCall<ProformaInvoicePreview, ApiException> preparePreviewProformaInvoiceRequest(
private ApiCall<ProformaInvoice, ApiException> preparePreviewProformaInvoiceRequest(
final int subscriptionId) throws IOException {
return new ApiCall.Builder<ProformaInvoicePreview, ApiException>()
return new ApiCall.Builder<ProformaInvoice, ApiException>()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
.server(Server.ENUM_DEFAULT.value())
Expand All @@ -378,7 +377,7 @@ private ApiCall<ProformaInvoicePreview, ApiException> preparePreviewProformaInvo
.httpMethod(HttpMethod.POST))
.responseHandler(responseHandler -> responseHandler
.deserializer(
response -> ApiHelper.deserialize(response, ProformaInvoicePreview.class))
response -> ApiHelper.deserialize(response, ProformaInvoice.class))
.nullify404(false)
.localErrorCase("404",
ErrorCase.setTemplate("Not Found:'{$response.body}'",
Expand Down
Loading
Loading