Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
424 changes: 317 additions & 107 deletions openapi.json

Large diffs are not rendered by default.

48 changes: 25 additions & 23 deletions src/main/java/com/sumup/sdk/clients/SalesAsyncClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
/**
* Client for the "Sales" API group.
*
* <p>Operations related to reading sales data.
* <p>Read a merchant's fully-paid, closed sales, including item lines, taxes, discounts, and
* payments. List sales to retrieve full `Sale` objects, or search by date, payment status, and
* sales channel to retrieve summaries. Use a summary's `id` to get the full sale. Amounts are
* expressed in minor units according to each sale's `currency.scale`.
*/
public final class SalesAsyncClient {
private final ApiClient apiClient;
Expand All @@ -29,7 +32,7 @@ public SalesAsyncClient(ApiClient apiClient) {
}

/**
* Gets a sale
* Get a sale
*
* <p>Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
Expand All @@ -43,13 +46,13 @@ public SalesAsyncClient(ApiClient apiClient) {
* @return CompletableFuture resolved with com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.Sale> getSaleV10(String merchantCode, String saleId)
public CompletableFuture<com.sumup.sdk.models.Sale> get(String merchantCode, String saleId)
throws ApiException {
return getSaleV10(merchantCode, saleId, null);
return get(merchantCode, saleId, null);
}

/**
* Gets a sale
* Get a sale
*
* <p>Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
Expand All @@ -63,7 +66,7 @@ public CompletableFuture<com.sumup.sdk.models.Sale> getSaleV10(String merchantCo
* @return CompletableFuture resolved with com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.Sale> getSaleV10(
public CompletableFuture<com.sumup.sdk.models.Sale> get(
String merchantCode, String saleId, RequestOptions requestOptions) throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(saleId, "saleId");
Expand All @@ -84,7 +87,7 @@ public CompletableFuture<com.sumup.sdk.models.Sale> getSaleV10(
}

/**
* Lists sales
* List sales
*
* <p>Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
Expand All @@ -99,13 +102,13 @@ public CompletableFuture<com.sumup.sdk.models.Sale> getSaleV10(
* @return CompletableFuture resolved with com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(String merchantCode)
public CompletableFuture<com.sumup.sdk.models.SalePage> list(String merchantCode)
throws ApiException {
return listSalesV10(merchantCode, null);
return list(merchantCode, null);
}

/**
* Lists sales
* List sales
*
* <p>Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
Expand All @@ -121,13 +124,13 @@ public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(String merc
* @return CompletableFuture resolved with com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(
public CompletableFuture<com.sumup.sdk.models.SalePage> list(
String merchantCode, ListSalesV10QueryParams listSalesV10) throws ApiException {
return listSalesV10(merchantCode, listSalesV10, null);
return list(merchantCode, listSalesV10, null);
}

/**
* Lists sales
* List sales
*
* <p>Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
Expand All @@ -143,7 +146,7 @@ public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(
* @return CompletableFuture resolved with com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(
public CompletableFuture<com.sumup.sdk.models.SalePage> list(
String merchantCode, ListSalesV10QueryParams listSalesV10, RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Expand All @@ -167,7 +170,7 @@ public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(
}

/**
* Searches sales
* Search sales
*
* <p>Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
Expand All @@ -185,13 +188,13 @@ public CompletableFuture<com.sumup.sdk.models.SalePage> listSalesV10(
* response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.SaleSearchResponse> searchSalesV10(
public CompletableFuture<com.sumup.sdk.models.SaleSearchResponse> search(
String merchantCode, com.sumup.sdk.models.SaleSearchRequest request) throws ApiException {
return searchSalesV10(merchantCode, request, null);
return search(merchantCode, request, null);
}

/**
* Searches sales
* Search sales
*
* <p>Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
Expand All @@ -209,7 +212,7 @@ public CompletableFuture<com.sumup.sdk.models.SaleSearchResponse> searchSalesV10
* response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.SaleSearchResponse> searchSalesV10(
public CompletableFuture<com.sumup.sdk.models.SaleSearchResponse> search(
String merchantCode,
com.sumup.sdk.models.SaleSearchRequest request,
RequestOptions requestOptions)
Expand Down Expand Up @@ -249,10 +252,9 @@ public ListSalesV10QueryParams paginationLimit(Long value) {
/**
* Sets the pagination_token query parameter.
*
* @param value Pagination token for subsequent requests. Should only be set by clients if they
* have received a token in the previous response, and this request is an immediate
* follow-up request to that response to load the subsequent page. Clients should treat this
* as an opaque token and should not attempt to parse it in any way.
* @param value Opaque token from the previous list response. Omit it on the first request. To
* load the next page, pass the returned token unchanged. Not interchangeable with tokens
* from `POST /sales/search`.
* @return This ListSalesV10QueryParams instance.
*/
public ListSalesV10QueryParams paginationToken(String value) {
Expand Down
49 changes: 25 additions & 24 deletions src/main/java/com/sumup/sdk/clients/SalesClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
/**
* Client for the "Sales" API group.
*
* <p>Operations related to reading sales data.
* <p>Read a merchant's fully-paid, closed sales, including item lines, taxes, discounts, and
* payments. List sales to retrieve full `Sale` objects, or search by date, payment status, and
* sales channel to retrieve summaries. Use a summary's `id` to get the full sale. Amounts are
* expressed in minor units according to each sale's `currency.scale`.
*/
public final class SalesClient {
private final ApiClient apiClient;
Expand All @@ -28,7 +31,7 @@ public SalesClient(ApiClient apiClient) {
}

/**
* Gets a sale
* Get a sale
*
* <p>Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
Expand All @@ -42,13 +45,12 @@ public SalesClient(ApiClient apiClient) {
* @return com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.Sale getSaleV10(String merchantCode, String saleId)
throws ApiException {
return getSaleV10(merchantCode, saleId, null);
public com.sumup.sdk.models.Sale get(String merchantCode, String saleId) throws ApiException {
return get(merchantCode, saleId, null);
}

/**
* Gets a sale
* Get a sale
*
* <p>Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
Expand All @@ -62,7 +64,7 @@ public com.sumup.sdk.models.Sale getSaleV10(String merchantCode, String saleId)
* @return com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.Sale getSaleV10(
public com.sumup.sdk.models.Sale get(
String merchantCode, String saleId, RequestOptions requestOptions) throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(saleId, "saleId");
Expand All @@ -83,7 +85,7 @@ public com.sumup.sdk.models.Sale getSaleV10(
}

/**
* Lists sales
* List sales
*
* <p>Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
Expand All @@ -98,12 +100,12 @@ public com.sumup.sdk.models.Sale getSaleV10(
* @return com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.SalePage listSalesV10(String merchantCode) throws ApiException {
return listSalesV10(merchantCode, null);
public com.sumup.sdk.models.SalePage list(String merchantCode) throws ApiException {
return list(merchantCode, null);
}

/**
* Lists sales
* List sales
*
* <p>Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
Expand All @@ -119,13 +121,13 @@ public com.sumup.sdk.models.SalePage listSalesV10(String merchantCode) throws Ap
* @return com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.SalePage listSalesV10(
public com.sumup.sdk.models.SalePage list(
String merchantCode, ListSalesV10QueryParams listSalesV10) throws ApiException {
return listSalesV10(merchantCode, listSalesV10, null);
return list(merchantCode, listSalesV10, null);
}

/**
* Lists sales
* List sales
*
* <p>Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
Expand All @@ -141,7 +143,7 @@ public com.sumup.sdk.models.SalePage listSalesV10(
* @return com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.SalePage listSalesV10(
public com.sumup.sdk.models.SalePage list(
String merchantCode, ListSalesV10QueryParams listSalesV10, RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Expand All @@ -165,7 +167,7 @@ public com.sumup.sdk.models.SalePage listSalesV10(
}

/**
* Searches sales
* Search sales
*
* <p>Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
Expand All @@ -182,13 +184,13 @@ public com.sumup.sdk.models.SalePage listSalesV10(
* @return com.sumup.sdk.models.SaleSearchResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.SaleSearchResponse searchSalesV10(
public com.sumup.sdk.models.SaleSearchResponse search(
String merchantCode, com.sumup.sdk.models.SaleSearchRequest request) throws ApiException {
return searchSalesV10(merchantCode, request, null);
return search(merchantCode, request, null);
}

/**
* Searches sales
* Search sales
*
* <p>Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
Expand All @@ -205,7 +207,7 @@ public com.sumup.sdk.models.SaleSearchResponse searchSalesV10(
* @return com.sumup.sdk.models.SaleSearchResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.SaleSearchResponse searchSalesV10(
public com.sumup.sdk.models.SaleSearchResponse search(
String merchantCode,
com.sumup.sdk.models.SaleSearchRequest request,
RequestOptions requestOptions)
Expand Down Expand Up @@ -245,10 +247,9 @@ public ListSalesV10QueryParams paginationLimit(Long value) {
/**
* Sets the pagination_token query parameter.
*
* @param value Pagination token for subsequent requests. Should only be set by clients if they
* have received a token in the previous response, and this request is an immediate
* follow-up request to that response to load the subsequent page. Clients should treat this
* as an opaque token and should not attempt to parse it in any way.
* @param value Opaque token from the previous list response. Omit it on the first request. To
* load the next page, pass the returned token unchanged. Not interchangeable with tokens
* from `POST /sales/search`.
* @return This ListSalesV10QueryParams instance.
*/
public ListSalesV10QueryParams paginationToken(String value) {
Expand Down
76 changes: 76 additions & 0 deletions src/main/java/com/sumup/sdk/models/CheckoutEntryMode.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
// Code generated by sumup-java/codegen. DO NOT EDIT.
package com.sumup.sdk.models;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Objects;

/**
* How the payment details were captured for a checkout transaction, for example `CUSTOMER_ENTRY`
* for card details entered by the payer or `APPLE_PAY` for an Apple Pay payment. Checkout entry
* modes use uppercase values, unlike entry modes returned by the Transactions endpoints.
*/
public final class CheckoutEntryMode {
public static final CheckoutEntryMode CUSTOMER_ENTRY = new CheckoutEntryMode("CUSTOMER_ENTRY");
public static final CheckoutEntryMode MOTO = new CheckoutEntryMode("MOTO");
public static final CheckoutEntryMode CARD = new CheckoutEntryMode("CARD");
public static final CheckoutEntryMode BOLETO = new CheckoutEntryMode("BOLETO");
public static final CheckoutEntryMode DIRECT_DEBIT = new CheckoutEntryMode("DIRECT_DEBIT");
public static final CheckoutEntryMode IDEAL = new CheckoutEntryMode("IDEAL");
public static final CheckoutEntryMode BANCONTACT = new CheckoutEntryMode("BANCONTACT");
public static final CheckoutEntryMode EPS = new CheckoutEntryMode("EPS");
public static final CheckoutEntryMode MYBANK = new CheckoutEntryMode("MYBANK");
public static final CheckoutEntryMode SATISPAY = new CheckoutEntryMode("SATISPAY");
public static final CheckoutEntryMode BLIK = new CheckoutEntryMode("BLIK");
public static final CheckoutEntryMode P24 = new CheckoutEntryMode("P24");
public static final CheckoutEntryMode GIROPAY = new CheckoutEntryMode("GIROPAY");
public static final CheckoutEntryMode PIX = new CheckoutEntryMode("PIX");
public static final CheckoutEntryMode QR_CODE_PIX = new CheckoutEntryMode("QR_CODE_PIX");
public static final CheckoutEntryMode KLARNA = new CheckoutEntryMode("KLARNA");
public static final CheckoutEntryMode BANCOMATPAY = new CheckoutEntryMode("BANCOMATPAY");
public static final CheckoutEntryMode APPLE_PAY = new CheckoutEntryMode("APPLE_PAY");
public static final CheckoutEntryMode PAYPAL = new CheckoutEntryMode("PAYPAL");
public static final CheckoutEntryMode GOOGLE_PAY = new CheckoutEntryMode("GOOGLE_PAY");

private final String value;

private CheckoutEntryMode(String value) {
this.value = Objects.requireNonNull(value, "value");
}

/**
* Creates a CheckoutEntryMode for a value not yet known to this SDK version.
*
* @param value Wire value sent to or received from the API.
* @return Open enum value wrapping {@code value}.
*/
public static CheckoutEntryMode of(String value) {
return new CheckoutEntryMode(value);
}

@JsonValue
public String getValue() {
return value;
}

@Override
public String toString() {
return value;
}

@JsonCreator
public static CheckoutEntryMode fromValue(String value) {
return value == null ? null : new CheckoutEntryMode(value);
}

@Override
public boolean equals(Object other) {
return this == other
|| (other instanceof CheckoutEntryMode that && this.value.equals(that.value));
}

@Override
public int hashCode() {
return value.hashCode();
}
}
Loading
Loading