add documentation (#2)

conekta · Dec 26, 2023 · 68938eb · 68938eb
1 parent 3d66f4b
commit 68938eb
Show file tree

Hide file tree

Showing 245 changed files with 37,565 additions and 202 deletions.
diff --git a/.gitignore b/.gitignore
@@ -39,4 +39,3 @@ pubspec.lock
 
 # Mac
 .DS_Store
-**/*.g.dart
diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore
@@ -22,3 +22,4 @@
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
 README.md
+.gitignore
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -1,4 +1,3 @@
-.gitignore
 AUTHORS.md
 CODE_OF_CONDUCT.md
 CONTRIBUTING.md

diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-7.1.0
+7.2.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,30 @@
+## 6.0.0 - 2023-12-22
+* [#1](https://github.com/conekta/conekta-dart/pull/1) Initial Release
+  * AntifraudApi
+  * ApiKeysApi
+  * BalancesApi
+  * ChargesApi
+  * CompaniesApi
+  * CustomersApi
+  * DiscountsApi
+  * EventsApi
+  * LogsApi
+  * OrdersApi
+  * PaymentLinkApi
+  * PaymentMethodsApi
+  * PlansApi
+  * ProductsApi
+  * ShippingContactsApi
+  * ShippingsApi
+  * SubscriptionsApi
+  * TaxesApi
+  * TransactionsApi
+  * TransfersApi
+  * WebhookKeysApi
+  * WebhooksApi
+## 6.0.1 - 2023-12-26
+* [#2](https://github.com/conekta/conekta-dart/pull/2) update documentation
+  * update documentation
+  * add generated models
+  * add changelog
+  * add example
diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ dart:
 	rm -rf ../conekta-dart/doc && \
 	rm -rf ../conekta-dart/lib/src/model && \
 	docker run --rm \
-    -v ${PWD}:/local openapitools/openapi-generator-cli:v7.1.0 generate \
+    -v ${PWD}:/local openapitools/openapi-generator-cli:v7.2.0 generate \
 	 -i https://raw.githubusercontent.com/conekta/openapi/main/_build/api.yaml \
 	 -g dart-dio \
 	 -o /local \

diff --git a/README.md b/README.md
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-6.0.0
+6.0.1
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -2,9 +2,7 @@ analyzer:
   language:
     strict-inference: true
     strict-raw-types: true
-  strong-mode:
-    implicit-dynamic: false
-    implicit-casts: false
+    strict-casts: false
   exclude:
     - test/*.dart
   errors:

diff --git a/config-dart.json b/config-dart.json
@@ -2,12 +2,12 @@
   "useEnumExtension": true,
   "pubAuthor": "conekta",
   "pubLibrary": "conekta",
-  "pubVersion": "6.0.0",
+  "pubVersion": "6.0.1",
   "pubName": "conekta",
   "pubRepository": "https://www.github.com/conekta/conekta-dart",
   "pubHomepage" : "https://www.github.com/conekta/conekta-dart",
   "pubAuthorEmail": "[email protected]",
-  "pubDescription": "Conekta dart Library",
+  "pubDescription": "Dart Library for the Conekta API.",
   "serializationLibrary" : "built_value",
   "templateDir": "/local/templates/dart",
   "files" : {

diff --git a/example/main.dart b/example/main.dart
@@ -0,0 +1,15 @@
+import 'package:conekta/conekta.dart';
+
+Future<void> main() async {
+  var instance = Conekta();
+  instance.setBearerAuth("bearerAuth", "key_xxxx");
+  final api = instance.getCustomersApi();
+
+  var customer = Customer((b) => b
+    ..name = 'John Constantine'
+    ..email = '[email protected]'
+    ..phone = '5555555555'
+  );
+  var response = await api.createCustomer(customer: customer);
+  print(response.data);
+}
diff --git a/lib/src/api/antifraud_api.dart b/lib/src/api/antifraud_api.dart
@@ -65,7 +65,7 @@ class AntifraudApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,
@@ -184,7 +184,7 @@ class AntifraudApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,
@@ -304,7 +304,7 @@ class AntifraudApi {
     final _options = Options(
       method: r'DELETE',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -405,7 +405,7 @@ class AntifraudApi {
     final _options = Options(
       method: r'DELETE',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -502,7 +502,7 @@ class AntifraudApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,
@@ -598,7 +598,7 @@ class AntifraudApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,

diff --git a/lib/src/api/api_keys_api.dart b/lib/src/api/api_keys_api.dart
@@ -67,7 +67,7 @@ class ApiKeysApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -186,7 +186,7 @@ class ApiKeysApi {
     final _options = Options(
       method: r'DELETE',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,
@@ -286,7 +286,7 @@ class ApiKeysApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -393,7 +393,7 @@ class ApiKeysApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -503,7 +503,7 @@ class ApiKeysApi {
     final _options = Options(
       method: r'PUT',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,

diff --git a/lib/src/api/balances_api.dart b/lib/src/api/balances_api.dart
@@ -56,7 +56,7 @@ class BalancesApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,

diff --git a/lib/src/api/charges_api.dart b/lib/src/api/charges_api.dart
@@ -71,7 +71,7 @@ class ChargesApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -183,7 +183,7 @@ class ChargesApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -307,7 +307,7 @@ class ChargesApi {
     final _options = Options(
       method: r'PUT',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,

diff --git a/lib/src/api/companies_api.dart b/lib/src/api/companies_api.dart
@@ -66,7 +66,7 @@ class CompaniesApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,
@@ -172,7 +172,7 @@ class CompaniesApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,

diff --git a/lib/src/api/customers_api.dart b/lib/src/api/customers_api.dart
@@ -69,7 +69,7 @@ class CustomersApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -193,7 +193,7 @@ class CustomersApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -314,7 +314,7 @@ class CustomersApi {
     final _options = Options(
       method: r'DELETE',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -415,7 +415,7 @@ class CustomersApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -522,7 +522,7 @@ class CustomersApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -634,7 +634,7 @@ class CustomersApi {
     final _options = Options(
       method: r'PUT',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -760,7 +760,7 @@ class CustomersApi {
     final _options = Options(
       method: r'PUT',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,

diff --git a/lib/src/api/discounts_api.dart b/lib/src/api/discounts_api.dart
@@ -67,7 +67,7 @@ class DiscountsApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -190,7 +190,7 @@ class DiscountsApi {
     final _options = Options(
       method: r'DELETE',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -293,7 +293,7 @@ class DiscountsApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -402,7 +402,7 @@ class DiscountsApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -516,7 +516,7 @@ class DiscountsApi {
     final _options = Options(
       method: r'PUT',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,

diff --git a/lib/src/api/events_api.dart b/lib/src/api/events_api.dart
@@ -63,7 +63,7 @@ class EventsApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -170,7 +170,7 @@ class EventsApi {
     final _options = Options(
       method: r'GET',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (xChildCompanyId != null) r'X-Child-Company-Id': xChildCompanyId,
         if (localVarAccept != null) r'Accept': localVarAccept,
@@ -279,7 +279,7 @@ class EventsApi {
     final _options = Options(
       method: r'POST',
       headers: <String, dynamic>{
-        r'User-Agent': r'Conekta/v2 DartBindings/6.0.0',
+        r'User-Agent': r'Conekta/v2 DartBindings/6.0.1',
         if (acceptLanguage != null) r'Accept-Language': acceptLanguage,
         if (localVarAccept != null) r'Accept': localVarAccept,
         if (localVarContentType != null) r'Content-Type': localVarContentType,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,4 +39,3 @@ pubspec.lock

		# Mac
		.DS_Store
		*/.g.dart