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
335 changes: 253 additions & 82 deletions openapi.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions src/SumUp/Models/PublicPaymentV10.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public sealed partial class PublicPaymentV10
/// <summary>The amount of the payment including tips. The value of the amount in minor units of Sale.currency.</summary>
[JsonPropertyName("amount")]
public long Amount { get; set; }
/// <summary>Alternative payment method type when method is apm. Gift card is not an APM on this API. Input is case-insensitive; the canonical form is lowercase snake_case. VALUES: [qr_code_pix, sepa_dd, paypal, sumup_pay, twint, iris].</summary>
/// <summary>Alternative payment method type when method is apm. Gift card is not an APM on this API. Values use lowercase snake_case. Known values are qr_code_pix, sepa_dd, paypal, sumup_pay, twint, and iris. Additional values may be returned as new alternative payment methods become available.</summary>
[JsonPropertyName("apm_type")]
public string? ApmType { get; set; }
/// <summary>Card brand, credit/debit processing type, and last four digits.</summary>
Expand All @@ -19,7 +19,7 @@ public sealed partial class PublicPaymentV10
/// <summary>Gift card used for this payment. Present when method is gift_card and the gift card id is known. Gift card IDs use the format "GC" followed by 9 alphanumeric characters (e.g. GCZ3NTMB1V).</summary>
[JsonPropertyName("gift_card")]
public PublicGiftCardPayment? GiftCard { get; set; }
/// <summary>Payment method on public sales read API v1.0. Digital wallets are first-class methods. Gift card payments use gift_card, not apm. Input is case-insensitive; the canonical form is lowercase snake_case. VALUES: [card, cash, apm, external, apple_pay, google_pay, whatsapp_pay, gift_card].</summary>
/// <summary>Payment method on public sales read API v1.0. Digital wallets are first-class methods. Gift card payments use gift_card, not apm. Values use lowercase snake_case. Known values are card, cash, apm, external, apple_pay, google_pay, whatsapp_pay, and gift_card. Additional values may be returned as new payment methods become available.</summary>
[JsonPropertyName("method")]
public string Method { get; set; } = default!;
/// <summary>UTC date-time when SumUp recorded this payment’s exposed status (successful, failed, or canceled). Server processed time when available; otherwise the payment provider’s transaction time. Not the device clock.</summary>
Expand All @@ -31,7 +31,7 @@ public sealed partial class PublicPaymentV10
/// <summary>The status of the payment.</summary>
[JsonPropertyName("status")]
public PublicPaymentV10Status Status { get; set; }
/// <summary>Payment operation type. This is distinct from the payment instrument in method. Input is case-insensitive; the canonical form is lowercase snake_case. VALUES: [purchase, unreferenced_refund] Defaults to "purchase" if unspecified. Either a normal purchase or an unreferenced refund for negative sales like deposit returns.</summary>
/// <summary>Payment operation type. This is distinct from the payment instrument in method. Values use lowercase snake_case. Known values are purchase for a normal purchase and unreferenced_refund for negative sales such as deposit returns.</summary>
[JsonPropertyName("type")]
public string Type { get; set; } = default!;
}
4 changes: 2 additions & 2 deletions src/SumUp/Models/SalePage.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ namespace SumUp;

using System.Text.Json.Serialization;
using System.Collections.Generic;
/// <summary>Paginated list of Sale objects. Results are ordered newest first by the newest activity recorded for each sale. See ListSalesV10.</summary>
/// <summary>Paginated list of Sale objects. Results are ordered newest first by the newest activity recorded for each sale.</summary>
public sealed partial class SalePage
{
[JsonPropertyName("items")]
public IEnumerable<Sale> Items { get; set; } = default!;
/// <summary>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.</summary>
/// <summary>Opaque token for the next page. Pass it as the pagination_token query parameter on the next list request. Omitted when no further page is available.</summary>
[JsonPropertyName("pagination_token")]
public string? PaginationToken { get; set; }
}
2 changes: 1 addition & 1 deletion src/SumUp/Models/SaleSearchRequest.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public sealed partial class SaleSearchRequest
/// <summary>Maximum number of results per page.</summary>
[JsonPropertyName("pagination_limit")]
public int? PaginationLimit { get; set; }
/// <summary>Opaque pagination token from a previous search response. Not interchangeable with tokens from GET /sales.</summary>
/// <summary>Opaque token from the previous search response. To load the next page, send it with the same filters. Not interchangeable with tokens from GET /sales.</summary>
[JsonPropertyName("pagination_token")]
public string? PaginationToken { get; set; }
/// <summary>Filters rows by payment outcome. Multiple values match any of them (OR). The search row does not echo this value.</summary>
Expand Down
2 changes: 1 addition & 1 deletion src/SumUp/Models/SaleSearchResponse.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public sealed partial class SaleSearchResponse
{
[JsonPropertyName("items")]
public IEnumerable<SaleSearchItem> Items { get; set; } = default!;
/// <summary>Opaque token for the next page of search results.</summary>
/// <summary>Opaque token for the next page. Pass it as pagination_token in the next search request body with the same filters. Omitted when no further page is available.</summary>
[JsonPropertyName("pagination_token")]
public string? PaginationToken { get; set; }
}
15 changes: 15 additions & 0 deletions src/SumUp/Options/SalesListOptions.g.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// <auto-generated />
#nullable enable

namespace SumUp;

/// <summary>
/// Optional parameters for List sales.
/// </summary>
public sealed partial class SalesListOptions
{
/// <summary>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.</summary>
public string? PaginationToken { get; set; }
/// <summary>Maximum number of results per page.</summary>
public int? PaginationLimit { get; set; }
}
15 changes: 0 additions & 15 deletions src/SumUp/Options/SalesListSalesV10Options.g.cs

This file was deleted.

30 changes: 15 additions & 15 deletions src/SumUp/SalesClient.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ public sealed partial class SalesClient
/// <summary>
/// Client for the Sales API endpoints.
/// </summary>
/// <remarks>Operations related to reading sales data.</remarks>
/// <remarks>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.</remarks>
internal SalesClient(ApiClient client)
{
_client = client;
}

/// <summary>
/// Gets a sale
/// Get a sale
/// </summary>
/// <remarks>Returns Sale for sale_id, including item lines and payments[]. Non-finalised sales are never returned; only fully-paid sales.</remarks>
/// <param name="merchantCode">The merchant code.</param>
/// <param name="saleId">The sale ID.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public ApiResponse<Sale> GetSaleV10(string merchantCode, string saleId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
public ApiResponse<Sale> Get(string merchantCode, string saleId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
{
var request = _client.CreateRequest(HttpMethod.Get, "/v1.0/merchants/{merchant_code}/sales/{sale_id}", builder =>
{
Expand Down Expand Up @@ -90,14 +90,14 @@ public ApiResponse<Sale> GetSaleV10(string merchantCode, string saleId, RequestO
}

/// <summary>
/// Gets a sale
/// Get a sale
/// </summary>
/// <remarks>Returns Sale for sale_id, including item lines and payments[]. Non-finalised sales are never returned; only fully-paid sales.</remarks>
/// <param name="merchantCode">The merchant code.</param>
/// <param name="saleId">The sale ID.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public async Task<ApiResponse<Sale>> GetSaleV10Async(string merchantCode, string saleId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
public async Task<ApiResponse<Sale>> GetAsync(string merchantCode, string saleId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
{
var request = _client.CreateRequest(HttpMethod.Get, "/v1.0/merchants/{merchant_code}/sales/{sale_id}", builder =>
{
Expand Down Expand Up @@ -156,16 +156,16 @@ public async Task<ApiResponse<Sale>> GetSaleV10Async(string merchantCode, string
}

/// <summary>
/// Lists sales
/// List sales
/// </summary>
/// <remarks>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 merchant’s last two years of sales. Non-finalised sales are never returned; only fully-paid sales. Use POST /sales/search for filtered queries.</remarks>
/// <param name="merchantCode">The merchant code.</param>
/// <param name="options">Query and header parameters for the request.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public ApiResponse<SalePage> ListSalesV10(string merchantCode, SalesListSalesV10Options? options = null, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
public ApiResponse<SalePage> List(string merchantCode, SalesListOptions? options = null, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
{
var operationOptions = options ?? new SalesListSalesV10Options();
var operationOptions = options ?? new SalesListOptions();
var request = _client.CreateRequest(HttpMethod.Get, "/v1.0/merchants/{merchant_code}/sales", builder =>
{
builder.AddPath("merchant_code", merchantCode);
Expand Down Expand Up @@ -224,16 +224,16 @@ public ApiResponse<SalePage> ListSalesV10(string merchantCode, SalesListSalesV10
}

/// <summary>
/// Lists sales
/// List sales
/// </summary>
/// <remarks>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 merchant’s last two years of sales. Non-finalised sales are never returned; only fully-paid sales. Use POST /sales/search for filtered queries.</remarks>
/// <param name="merchantCode">The merchant code.</param>
/// <param name="options">Query and header parameters for the request.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public async Task<ApiResponse<SalePage>> ListSalesV10Async(string merchantCode, SalesListSalesV10Options? options = null, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
public async Task<ApiResponse<SalePage>> ListAsync(string merchantCode, SalesListOptions? options = null, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
{
var operationOptions = options ?? new SalesListSalesV10Options();
var operationOptions = options ?? new SalesListOptions();
var request = _client.CreateRequest(HttpMethod.Get, "/v1.0/merchants/{merchant_code}/sales", builder =>
{
builder.AddPath("merchant_code", merchantCode);
Expand Down Expand Up @@ -292,14 +292,14 @@ public async Task<ApiResponse<SalePage>> ListSalesV10Async(string merchantCode,
}

/// <summary>
/// Searches sales
/// Search sales
/// </summary>
/// <remarks>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 logical AND; multiple values in one array field stack with logical OR. Results cover the merchant’s last two years of sales (narrow further with start_date / end_date). Pagination tokens are not interchangeable with GET /sales.</remarks>
/// <param name="merchantCode">The merchant code.</param>
/// <param name="body">Request body payload.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public ApiResponse<SaleSearchResponse> SearchSalesV10(string merchantCode, SaleSearchRequest body, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
public ApiResponse<SaleSearchResponse> Search(string merchantCode, SaleSearchRequest body, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
{
var request = _client.CreateRequest(HttpMethod.Post, "/v1.0/merchants/{merchant_code}/sales/search", builder =>
{
Expand Down Expand Up @@ -361,14 +361,14 @@ public ApiResponse<SaleSearchResponse> SearchSalesV10(string merchantCode, SaleS
}

/// <summary>
/// Searches sales
/// Search sales
/// </summary>
/// <remarks>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 logical AND; multiple values in one array field stack with logical OR. Results cover the merchant’s last two years of sales (narrow further with start_date / end_date). Pagination tokens are not interchangeable with GET /sales.</remarks>
/// <param name="merchantCode">The merchant code.</param>
/// <param name="body">Request body payload.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public async Task<ApiResponse<SaleSearchResponse>> SearchSalesV10Async(string merchantCode, SaleSearchRequest body, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
public async Task<ApiResponse<SaleSearchResponse>> SearchAsync(string merchantCode, SaleSearchRequest body, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
{
var request = _client.CreateRequest(HttpMethod.Post, "/v1.0/merchants/{merchant_code}/sales/search", builder =>
{
Expand Down
Loading