Holzleitner-Lieferservice-App/packages/holzleitner_api/doc/PaymentMethodsApi.md

holzleitner_api.api.PaymentMethodsApi

Load the API package

import 'package:holzleitner_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
createPaymentMethod	POST /payment-methods	Legt eine neue Zahlungsmethode an.
deletePaymentMethod	DELETE /payment-methods/{id}	Hartes Löschen. `409 Conflict`, wenn die Methode von einer Lieferung referenziert wird — der Admin soll dann den `active = false`-Pfad nutzen.
listPaymentMethods	GET /payment-methods	Listet die Zahlungsmethoden.
updatePaymentMethod	PATCH /payment-methods/{id}	Patcht Anzeige-Name und/oder Aktiv-Flag.

createPaymentMethod

PaymentMethodResponse createPaymentMethod(createPaymentMethodRequest)

Legt eine neue Zahlungsmethode an.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getPaymentMethodsApi();
final CreatePaymentMethodRequest createPaymentMethodRequest = ; // CreatePaymentMethodRequest | 

try {
    final response = api.createPaymentMethod(createPaymentMethodRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PaymentMethodsApi->createPaymentMethod: $e\n');
}

Parameters

Name	Type	Description	Notes
createPaymentMethodRequest	CreatePaymentMethodRequest

Return type

PaymentMethodResponse

Authorization

bearer_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePaymentMethod

deletePaymentMethod(id)

Hartes Löschen. 409 Conflict, wenn die Methode von einer Lieferung referenziert wird — der Admin soll dann den active = false-Pfad nutzen.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getPaymentMethodsApi();
final String id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Zahlungsmethoden-Id

try {
    api.deletePaymentMethod(id);
} catch on DioException (e) {
    print('Exception when calling PaymentMethodsApi->deletePaymentMethod: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	Zahlungsmethoden-Id

Return type

void (empty response body)

Authorization

bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listPaymentMethods

PaymentMethodsList listPaymentMethods(includeInactive)

Listet die Zahlungsmethoden.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getPaymentMethodsApi();
final bool includeInactive = true; // bool | Wenn true, werden inaktive Methoden mitgeliefert (default: false)

try {
    final response = api.listPaymentMethods(includeInactive);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PaymentMethodsApi->listPaymentMethods: $e\n');
}

Parameters

Name	Type	Description	Notes
includeInactive	bool	Wenn true, werden inaktive Methoden mitgeliefert (default: false)	[optional]

Return type

PaymentMethodsList

Authorization

bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePaymentMethod

PaymentMethodResponse updatePaymentMethod(id, updatePaymentMethodRequest)

Patcht Anzeige-Name und/oder Aktiv-Flag.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getPaymentMethodsApi();
final String id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Zahlungsmethoden-Id
final UpdatePaymentMethodRequest updatePaymentMethodRequest = ; // UpdatePaymentMethodRequest | 

try {
    final response = api.updatePaymentMethod(id, updatePaymentMethodRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PaymentMethodsApi->updatePaymentMethod: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	Zahlungsmethoden-Id
updatePaymentMethodRequest	UpdatePaymentMethodRequest

Return type

PaymentMethodResponse

Authorization

bearer_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]