feat: Create charges (#115)

- Added a new summary field for the "Create charges" operation in the API documentation - Removed the "agreement" and "product_type" properties from the ChargeResponse and ChargesDataResponse models - Updated the package version to 6.0.13
conekta · Oct 25, 2024 · 999db29 · 999db29
1 parent da26907
commit 999db29
Show file tree

Hide file tree

Showing 19 changed files with 69 additions and 117 deletions.
diff --git a/Conekta.net.sln b/Conekta.net.sln
@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 14
 VisualStudioVersion = 14.0.25420.1
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Conekta.net", "src\Conekta.net\Conekta.net.csproj", "{604EDD2F-2B46-4DDC-8212-DC4E6595C4E6}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Conekta.net", "src\Conekta.net\Conekta.net.csproj", "{BC7C545E-C9C4-4F7B-8BA2-1F5C0C7C8B5F}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Conekta.net.Test", "src\Conekta.net.Test\Conekta.net.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
 EndProject
@@ -12,10 +12,10 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{604EDD2F-2B46-4DDC-8212-DC4E6595C4E6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{604EDD2F-2B46-4DDC-8212-DC4E6595C4E6}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{604EDD2F-2B46-4DDC-8212-DC4E6595C4E6}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{604EDD2F-2B46-4DDC-8212-DC4E6595C4E6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{BC7C545E-C9C4-4F7B-8BA2-1F5C0C7C8B5F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{BC7C545E-C9C4-4F7B-8BA2-1F5C0C7C8B5F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{BC7C545E-C9C4-4F7B-8BA2-1F5C0C7C8B5F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{BC7C545E-C9C4-4F7B-8BA2-1F5C0C7C8B5F}.Release|Any CPU.Build.0 = Release|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-6.0.12
+6.0.13
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -1704,6 +1704,7 @@ paths:
           description: internal server error
       security:
       - bearerAuth: []
+      summary: Create charges
       tags:
       - Charges
   /companies:
@@ -13412,10 +13413,6 @@ components:
       type: object
     charge_response:
       properties:
-        agreement:
-          description: Agreement ID
-          example: agreement_2tN73UdUSNrYRPD9r
-          type: string
         amount:
           example: 4321
           type: integer
@@ -13466,11 +13463,6 @@ components:
           type: integer
         payment_method:
           $ref: '#/components/schemas/charge_response_payment_method'
-        product_type:
-          description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\
-            \ etc."
-          example: bbva_cash_in
-          type: string
         reference_id:
           description: Reference ID of the charge
           example: ref_2tN73UdUSNrYRPD9r
@@ -15781,6 +15773,10 @@ components:
       - $ref: '#/components/schemas/payment_method'
       - description: use for cash responses
         properties:
+          agreement:
+            description: Agreement ID
+            example: agreement_2tN73UdUSNrYRPD9r
+            type: string
           auth_code:
             example: 542563
             nullable: true
@@ -15799,6 +15795,11 @@ components:
             example: 0
             format: int64
             type: integer
+          product_type:
+            description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\
+              \ etc."
+            example: bbva_cash_in
+            type: string
           service_name:
             example: OxxoPay
             type: string

diff --git a/config-netcore.json b/config-netcore.json
@@ -33,5 +33,5 @@
   "packageCopyright" : "Conekta",
   "PackageReleaseNotes" : "add support for payout orders",
   "releaseNote" : "update entity webhook, nuget config",
-  "packageVersion" : "6.0.12"
+  "packageVersion" : "6.0.13"
 }
diff --git a/docs/ChargeOrderResponsePaymentMethod.md b/docs/ChargeOrderResponsePaymentMethod.md
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Type** | **string** |  | [optional] 
 **Object** | **string** |  | 
+**Agreement** | **string** | Agreement ID | [optional] 
 **AuthCode** | **string** |  | [optional] 
 **CashierId** | **string** |  | [optional] 
 **Reference** | **string** |  | [optional] 
 **BarcodeUrl** | **string** |  | [optional] 
 **ExpiresAt** | **long** |  | [optional] 
+**ProductType** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 
 **ServiceName** | **string** |  | [optional] 
 **Store** | **string** |  | [optional] 
 **StoreName** | **string** |  | [optional] 

diff --git a/docs/ChargeResponse.md b/docs/ChargeResponse.md
@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Agreement** | **string** | Agreement ID | [optional] 
 **Amount** | **int** |  | [optional] 
 **Channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] 
 **CreatedAt** | **long** |  | [optional] 
@@ -20,7 +19,6 @@ Name | Type | Description | Notes
 **OrderId** | **string** | Order ID | [optional] 
 **PaidAt** | **long?** | Payment date | [optional] 
 **PaymentMethod** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) |  | [optional] 
-**ProductType** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 
 **ReferenceId** | **string** | Reference ID of the charge | [optional] 
 **Refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) |  | [optional] 
 **Status** | **string** |  | [optional] 

diff --git a/docs/ChargeResponsePaymentMethod.md b/docs/ChargeResponsePaymentMethod.md
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Type** | **string** |  | [optional] 
 **Object** | **string** |  | 
+**Agreement** | **string** | Agreement ID | [optional] 
 **AuthCode** | **string** |  | [optional] 
 **CashierId** | **string** |  | [optional] 
 **Reference** | **string** |  | [optional] 
 **BarcodeUrl** | **string** |  | [optional] 
 **ExpiresAt** | **long** |  | [optional] 
+**ProductType** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 
 **ServiceName** | **string** |  | [optional] 
 **Store** | **string** |  | [optional] 
 **StoreName** | **string** |  | [optional] 

diff --git a/docs/ChargesApi.md b/docs/ChargesApi.md
@@ -6,7 +6,7 @@ All URIs are relative to *https://api.conekta.io*
 |--------|--------------|-------------|
 | [**GetCharges**](ChargesApi.md#getcharges) | **GET** /charges | Get A List of Charges |
 | [**OrdersCreateCharge**](ChargesApi.md#orderscreatecharge) | **POST** /orders/{id}/charges | Create charge |
-| [**OrdersCreateCharges**](ChargesApi.md#orderscreatecharges) | **POST** /orders/{id}/add_charges |  |
+| [**OrdersCreateCharges**](ChargesApi.md#orderscreatecharges) | **POST** /orders/{id}/add_charges | Create charges |
 | [**UpdateCharge**](ChargesApi.md#updatecharge) | **PUT** /charges/{id} | Update a charge |
 
 <a id="getcharges"></a>
@@ -221,7 +221,7 @@ catch (ApiException e)
 # **OrdersCreateCharges**
 > ChargesOrderResponse OrdersCreateCharges (string id, ChargeRequest chargeRequest, string acceptLanguage = null, string xChildCompanyId = null)
 
-
+Create charges
 
 Create charges for an existing orden
 
@@ -252,6 +252,7 @@ namespace Example
 
             try
             {
+                // Create charges
                 ChargesOrderResponse result = apiInstance.OrdersCreateCharges(id, chargeRequest, acceptLanguage, xChildCompanyId);
                 Debug.WriteLine(result);
             }
@@ -272,6 +273,7 @@ This returns an ApiResponse object which contains the response data, status code
 ```csharp
 try
 {
+    // Create charges
     ApiResponse<ChargesOrderResponse> response = apiInstance.OrdersCreateChargesWithHttpInfo(id, chargeRequest, acceptLanguage, xChildCompanyId);
     Debug.Write("Status Code: " + response.StatusCode);
     Debug.Write("Response Headers: " + response.Headers);

diff --git a/docs/ChargesDataResponse.md b/docs/ChargesDataResponse.md
@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Agreement** | **string** | Agreement ID | [optional] 
 **Amount** | **int** |  | [optional] 
 **Channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] 
 **CreatedAt** | **long** |  | [optional] 
@@ -20,7 +19,6 @@ Name | Type | Description | Notes
 **OrderId** | **string** | Order ID | [optional] 
 **PaidAt** | **long?** | Payment date | [optional] 
 **PaymentMethod** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) |  | [optional] 
-**ProductType** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 
 **ReferenceId** | **string** | Reference ID of the charge | [optional] 
 **Refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) |  | [optional] 
 **Status** | **string** |  | [optional] 

diff --git a/docs/ChargesOrderResponseAllOfData.md b/docs/ChargesOrderResponseAllOfData.md
@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Agreement** | **string** | Agreement ID | [optional] 
 **Amount** | **int** |  | [optional] 
 **Channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] 
 **CreatedAt** | **long** |  | [optional] 
@@ -20,7 +19,6 @@ Name | Type | Description | Notes
 **OrderId** | **string** | Order ID | [optional] 
 **PaidAt** | **long?** | Payment date | [optional] 
 **PaymentMethod** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) |  | [optional] 
-**ProductType** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 
 **ReferenceId** | **string** | Reference ID of the charge | [optional] 
 **Refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) |  | [optional] 
 **Status** | **string** |  | [optional] 

diff --git a/docs/PaymentMethodCash.md b/docs/PaymentMethodCash.md
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Type** | **string** |  | [optional] 
 **Object** | **string** |  | 
+**Agreement** | **string** | Agreement ID | [optional] 
 **AuthCode** | **int?** |  | [optional] 
 **CashierId** | **string** |  | [optional] 
 **Reference** | **string** |  | [optional] 
 **BarcodeUrl** | **string** |  | [optional] 
 **ExpiresAt** | **long** |  | [optional] 
+**ProductType** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 
 **ServiceName** | **string** |  | [optional] 
 **Store** | **string** |  | [optional] 
 **StoreName** | **string** |  | [optional] 

diff --git a/src/Conekta.net.Test/Api/ChargesApiTests.cs b/src/Conekta.net.Test/Api/ChargesApiTests.cs
@@ -122,6 +122,7 @@ public void OrdersCreateChargesCashTest()
 
             Assert.IsType<ChargesOrderResponse>(response);
             Assert.Equal(2, response.Data.Count);
+            Assert.Equal("2409992", response.Data[0].PaymentMethod.GetPaymentMethodCash().Agreement);
         }
 
         /// <summary>

diff --git a/src/Conekta.net/Api/ChargesApi.cs b/src/Conekta.net/Api/ChargesApi.cs
@@ -87,7 +87,7 @@ public interface IChargesApiSync : IApiAccessor
         /// <returns>ApiResponse of ChargeOrderResponse</returns>
         ApiResponse<ChargeOrderResponse> OrdersCreateChargeWithHttpInfo(string id, ChargeRequest chargeRequest, string acceptLanguage = default(string), string xChildCompanyId = default(string), int operationIndex = 0);
         /// <summary>
-        /// 
+        /// Create charges
         /// </summary>
         /// <remarks>
         /// Create charges for an existing orden
@@ -102,7 +102,7 @@ public interface IChargesApiSync : IApiAccessor
         ChargesOrderResponse OrdersCreateCharges(string id, ChargeRequest chargeRequest, string acceptLanguage = default(string), string xChildCompanyId = default(string), int operationIndex = 0);
 
         /// <summary>
-        /// 
+        /// Create charges
         /// </summary>
         /// <remarks>
         /// Create charges for an existing orden
@@ -217,7 +217,7 @@ public interface IChargesApiAsync : IApiAccessor
         /// <returns>Task of ApiResponse (ChargeOrderResponse)</returns>
         System.Threading.Tasks.Task<ApiResponse<ChargeOrderResponse>> OrdersCreateChargeWithHttpInfoAsync(string id, ChargeRequest chargeRequest, string acceptLanguage = default(string), string xChildCompanyId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
         /// <summary>
-        /// 
+        /// Create charges
         /// </summary>
         /// <remarks>
         /// Create charges for an existing orden
@@ -233,7 +233,7 @@ public interface IChargesApiAsync : IApiAccessor
         System.Threading.Tasks.Task<ChargesOrderResponse> OrdersCreateChargesAsync(string id, ChargeRequest chargeRequest, string acceptLanguage = default(string), string xChildCompanyId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
 
         /// <summary>
-        /// 
+        /// Create charges
         /// </summary>
         /// <remarks>
         /// Create charges for an existing orden
@@ -809,7 +809,7 @@ public Conekta.net.Client.ExceptionFactory ExceptionFactory
         }
 
         /// <summary>
-        ///  Create charges for an existing orden
+        /// Create charges Create charges for an existing orden
         /// </summary>
         /// <exception cref="Conekta.net.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="id">Identifier of the resource</param>
@@ -825,7 +825,7 @@ public Conekta.net.Client.ExceptionFactory ExceptionFactory
         }
 
         /// <summary>
-        ///  Create charges for an existing orden
+        /// Create charges Create charges for an existing orden
         /// </summary>
         /// <exception cref="Conekta.net.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="id">Identifier of the resource</param>
@@ -907,7 +907,7 @@ public Conekta.net.Client.ExceptionFactory ExceptionFactory
         }
 
         /// <summary>
-        ///  Create charges for an existing orden
+        /// Create charges Create charges for an existing orden
         /// </summary>
         /// <exception cref="Conekta.net.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="id">Identifier of the resource</param>
@@ -924,7 +924,7 @@ public Conekta.net.Client.ExceptionFactory ExceptionFactory
         }
 
         /// <summary>
-        ///  Create charges for an existing orden
+        /// Create charges Create charges for an existing orden
         /// </summary>
         /// <exception cref="Conekta.net.Client.ApiException">Thrown when fails to make API call</exception>
         /// <param name="id">Identifier of the resource</param>

diff --git a/src/Conekta.net/Client/Configuration.cs b/src/Conekta.net/Client/Configuration.cs
@@ -34,7 +34,7 @@ public class Configuration : IReadableConfiguration
         /// Version of the package.
         /// </summary>
         /// <value>Version of the package.</value>
-        public const string Version = "6.0.12";
+        public const string Version = "6.0.13";
 
         /// <summary>
         /// Identifier for ISO 8601 DateTime Format
@@ -536,7 +536,7 @@ public static string ToDebugReport()
             report += "    OS: " + System.Environment.OSVersion + "\n";
             report += "    .NET Framework Version: " + System.Environment.Version  + "\n";
             report += "    Version of the API: 2.1.0\n";
-            report += "    SDK Package Version: 6.0.12\n";
+            report += "    SDK Package Version: 6.0.13\n";
 
             return report;
         }

diff --git a/src/Conekta.net/Conekta.net.csproj b/src/Conekta.net/Conekta.net.csproj
@@ -12,7 +12,7 @@
     <Description>This is a .net library that allows interaction with https://api.conekta.io API.</Description>
     <Copyright>Conekta</Copyright>
     <RootNamespace>Conekta.net</RootNamespace>
-    <Version>6.0.12</Version>
+    <Version>6.0.13</Version>
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Conekta.net.xml</DocumentationFile>
     <RepositoryUrl>https://github.com/conekta/conekta-.net.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>