brop_foundation_base_client_dart 0.1.0-SNAPSHOT brop_foundation_base_client_dart: ^0.1.0-SNAPSHOT copied to clipboard
OpenAPI API client
brop_foundation_base_client_dart #
[[${description}]]
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: [[${version}]]
- Build package: org.openapitools.codegen.languages.DartClientCodegen
Requirements #
Dart 2.12 or later
Installation & Usage #
Github #
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
brop_foundation_base_client_dart:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
brop_foundation_base_client_dart:
path: /path/to/brop_foundation_base_client_dart
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:brop_foundation_base_client_dart/api.dart';
final api_instance = AccountApi();
final account = [List<Account>()]; // List<Account> | Create Account sRequest Message.
try {
final result = api_instance.createAccounts(account);
print(result);
} catch (e) {
print('Exception when calling AccountApi->createAccounts: $e\n');
}
Documentation for API Endpoints #
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
AccountApi | createAccounts | POST /api/v1/accounts | Create Account |
AccountApi | retrieveAccount | GET /api/v1/accounts/{accountId} | Retrieve Account |
AccountApi | retrieveAccounts | GET /api/v1/accounts | Retrieve Account |
AccountApi | updateOneAccount | PUT /api/v1/accounts/{accountId} | Update Account |
AgreementApi | createAgreements | POST /api/v1/agreements | Create Agreement |
AgreementApi | retrieveAgreement | GET /api/v1/agreements/{agreementId} | Retrieve Agreement |
AgreementApi | retrieveAgreements | GET /api/v1/agreements | Retrieve Agreement |
AgreementApi | updateOneAgreement | PUT /api/v1/agreements/{agreementId} | Update Agreement |
AttributeGroupApi | allAttributeGroups | PUT /api/v1/attribute-groups | Create Attribute Group |
AttributeGroupApi | deleteOneAttributeGroup | DELETE /api/v1/attribute-groups/{attributeGroupId} | Delete Attribute Group |
AttributeGroupApi | retrieveAttributeGroup | GET /api/v1/attribute-groups/{attributeGroupId} | Retrieve Attribute Group |
AttributeGroupApi | retrieveAttributeGroups | GET /api/v1/attribute-groups | Retrieve Attribute Group |
AttributeGroupApi | updateOneAttributeGroup | PUT /api/v1/attribute-groups/{attributeGroupId} | Update Attribute Group |
AttributeKeyApi | createAttributeKeys | POST /api/v1/attribute-keys | Create Attribute Key |
AttributeKeyApi | deleteOneAttributeKey | DELETE /api/v1/attribute-keys/{attributeKeyId} | Delete Attribute Key |
AttributeKeyApi | retrieveAttributeKey | GET /api/v1/attribute-keys/{attributeKeyId} | Retrieve Attribute Key |
AttributeKeyApi | retrieveAttributeKeys | GET /api/v1/attribute-keys | Retrieve Attribute Key |
AttributeKeyApi | updateOneAttributeKey | PUT /api/v1/attribute-keys/{attributeKeyId} | Update Attribute Key |
AttributeValueApi | createAttributeValues | POST /api/v1/attribute-values | Create Attribute Value |
AttributeValueApi | deleteOneAttributeValue | DELETE /api/v1/attribute-values/{attributeValueId} | Delete Attribute Value |
AttributeValueApi | retrieveAttributeValue | GET /api/v1/attribute-values/{attributeValueId} | Retrieve Attribute Value |
AttributeValueApi | retrieveAttributeValues | GET /api/v1/attribute-values | Retrieve Attribute Value |
AttributeValueApi | updateOneAttributeValue | PUT /api/v1/attribute-values/{attributeValueId} | Update Attribute Value |
BankingProductApi | createBankingProducts | POST /api/v1/banking-products | Create Banking Product |
BankingProductApi | retrieveBankingProduct | GET /api/v1/banking-products/{bankingProductId} | Retrieve Banking Product |
BankingProductApi | retrieveBankingProducts | GET /api/v1/banking-products | Retrieve Banking Product |
BankingProductApi | updateOneBankingProduct | PUT /api/v1/banking-products/{bankingProductId} | Update Banking Product |
FeatureApi | createFeatures | POST /api/v1/features | Create Feature |
FeatureApi | retrieveFeature | GET /api/v1/features/{featureId} | Retrieve Feature |
FeatureApi | retrieveFeatures | GET /api/v1/features | Retrieve Feature |
FeatureApi | updateOneFeature | PUT /api/v1/features/{featureId} | Update Feature |
PartyApi | createParties | POST /api/v1/parties | Create Party |
PartyApi | retrieveParties | GET /api/v1/parties | Retrieve Party |
PartyApi | retrieveParty | GET /api/v1/parties/{partyId} | Retrieve Party |
PartyApi | updateOneParty | PUT /api/v1/parties/{partyId} | Update Party |
Documentation For Models #
- Account
- AccountIdentification
- Agreement
- AgreementPartyInvolvement
- Arrangement
- ArrangementAccountInvolvement
- ArrangementModality
- ArrangementPartyInvolvement
- AttributeGroup
- AttributeKey
- AttributeValue
- BankingProduct
- BankingProductIdentification
- Disclosure
- Error
- ErrorMessage
- Feature
- FeatureModality
- FeeArrangement
- FeeArrangementModality
- FeeFeature
- FeeFeatureModality
- FeeProductFeature
- FeeProductFeatureModality
- Party
- PartyIdentification
- PaymentAgreement
- PaymentArrangement
- PaymentArrangementModality
- PaymentBankingProduct
- PaymentFeature
- PaymentFeatureModality
- PaymentProductFeature
- PaymentProductFeatureModality
- ProductFeature
- ProductFeatureModality
- RetrieveAccounts200Response
- RetrieveAgreements200Response
- RetrieveAttributeGroups200Response
- RetrieveAttributeKeys200Response
- RetrieveAttributeValues200Response
- RetrieveBankingProducts200Response
- RetrieveFeatures200Response
- RetrieveParties200Response
- SettlementArrangementModality
- SettlementArrengement
- SettlementFeature
- SettlementFeatureModality
- SettlementProductFeature
- SettlementProductFeatureModality
Documentation For Authorization #
All endpoints do not require authorization.