payout orders (#275)

.openapi-generator/FILES

@@ -20,6 +20,7 @@ docs/Api/LogsApi.md
 docs/Api/OrdersApi.md
 docs/Api/PaymentLinkApi.md
 docs/Api/PaymentMethodsApi.md
+docs/Api/PayoutOrdersApi.md
 docs/Api/PlansApi.md
 docs/Api/ProductsApi.md
 docs/Api/ShippingContactsApi.md
@@ -153,6 +154,13 @@ docs/Model/PaymentMethodCashResponse.md
 docs/Model/PaymentMethodResponse.md
 docs/Model/PaymentMethodSpeiRecurrent.md
 docs/Model/PaymentMethodSpeiRequest.md
+docs/Model/Payout.md
+docs/Model/PayoutMethod.md
+docs/Model/PayoutOrder.md
+docs/Model/PayoutOrderPayoutsItem.md
+docs/Model/PayoutOrderResponse.md
+docs/Model/PayoutOrderResponseCustomerInfo.md
+docs/Model/PayoutOrdersResponse.md
 docs/Model/PlanRequest.md
 docs/Model/PlanResponse.md
 docs/Model/PlanUpdateRequest.md
@@ -209,6 +217,7 @@ lib/Api/LogsApi.php
 lib/Api/OrdersApi.php
 lib/Api/PaymentLinkApi.php
 lib/Api/PaymentMethodsApi.php
+lib/Api/PayoutOrdersApi.php
 lib/Api/PlansApi.php
 lib/Api/ProductsApi.php
 lib/Api/ShippingContactsApi.php
@@ -346,6 +355,13 @@ lib/Model/PaymentMethodCashResponse.php
 lib/Model/PaymentMethodResponse.php
 lib/Model/PaymentMethodSpeiRecurrent.php
 lib/Model/PaymentMethodSpeiRequest.php
+lib/Model/Payout.php
+lib/Model/PayoutMethod.php
+lib/Model/PayoutOrder.php
+lib/Model/PayoutOrderPayoutsItem.php
+lib/Model/PayoutOrderResponse.php
+lib/Model/PayoutOrderResponseCustomerInfo.php
+lib/Model/PayoutOrdersResponse.php
 lib/Model/PlanRequest.php
 lib/Model/PlanResponse.php
 lib/Model/PlanUpdateRequest.php
@@ -393,3 +409,4 @@ lib/Model/WhitelistlistRuleResponse.php
 lib/ObjectSerializer.php
 lib/ssl_data/ca_bundle.crt
 phpunit.xml.dist
+test/Api/PayoutOrdersApiTest.php

README.md

@@ -130,6 +130,9 @@ Class | Method | HTTP request | Description
 *PaymentMethodsApi* | [**deleteCustomerPaymentMethods**](docs/Api/PaymentMethodsApi.md#deletecustomerpaymentmethods) | **DELETE** /customers/{id}/payment_sources/{payment_method_id} | Delete Payment Method
 *PaymentMethodsApi* | [**getCustomerPaymentMethods**](docs/Api/PaymentMethodsApi.md#getcustomerpaymentmethods) | **GET** /customers/{id}/payment_sources | Get Payment Methods
 *PaymentMethodsApi* | [**updateCustomerPaymentMethods**](docs/Api/PaymentMethodsApi.md#updatecustomerpaymentmethods) | **PUT** /customers/{id}/payment_sources/{payment_method_id} | Update Payment Method
+*PayoutOrdersApi* | [**createPayoutOrder**](docs/Api/PayoutOrdersApi.md#createpayoutorder) | **POST** /payout_orders | Create payout order
+*PayoutOrdersApi* | [**getPayoutOrderById**](docs/Api/PayoutOrdersApi.md#getpayoutorderbyid) | **GET** /payout_orders/{id} | Get Payout Order
+*PayoutOrdersApi* | [**getPayoutOrders**](docs/Api/PayoutOrdersApi.md#getpayoutorders) | **GET** /payout_orders | Get a list of Payout Orders
 *PlansApi* | [**createPlan**](docs/Api/PlansApi.md#createplan) | **POST** /plans | Create Plan
 *PlansApi* | [**deletePlan**](docs/Api/PlansApi.md#deleteplan) | **DELETE** /plans/{id} | Delete Plan
 *PlansApi* | [**getPlan**](docs/Api/PlansApi.md#getplan) | **GET** /plans/{id} | Get Plan
@@ -295,6 +298,13 @@ Class | Method | HTTP request | Description
 - [PaymentMethodResponse](docs/Model/PaymentMethodResponse.md)
 - [PaymentMethodSpeiRecurrent](docs/Model/PaymentMethodSpeiRecurrent.md)
 - [PaymentMethodSpeiRequest](docs/Model/PaymentMethodSpeiRequest.md)
+- [Payout](docs/Model/Payout.md)
+- [PayoutMethod](docs/Model/PayoutMethod.md)
+- [PayoutOrder](docs/Model/PayoutOrder.md)
+- [PayoutOrderPayoutsItem](docs/Model/PayoutOrderPayoutsItem.md)
+- [PayoutOrderResponse](docs/Model/PayoutOrderResponse.md)
+- [PayoutOrderResponseCustomerInfo](docs/Model/PayoutOrderResponseCustomerInfo.md)
+- [PayoutOrdersResponse](docs/Model/PayoutOrdersResponse.md)
 - [PlanRequest](docs/Model/PlanRequest.md)
 - [PlanResponse](docs/Model/PlanResponse.md)
 - [PlanUpdateRequest](docs/Model/PlanUpdateRequest.md)
@@ -365,5 +375,5 @@ [email protected]
 This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `2.1.0`
-    - Package version: `6.0.6`
+    - Package version: `6.0.7`
 - Build package: `org.openapitools.codegen.languages.PhpClientCodegen`

VERSION

@@ -1 +1 @@
-6.0.6
+6.0.7

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "conekta/conekta-php",
-    "version": "6.0.6",
+    "version": "6.0.7",
     "description": "Conekta PHP Library",
     "type": "library",
     "keywords": [

config-php.json

@@ -1,13 +1,13 @@
 {
   "packageName": "conekta",
   "generateSourceCodeOnly": "false",
-  "artifactVersion": "6.0.6",
+  "artifactVersion": "6.0.7",
   "packageUrl": "https://developers.conekta.com/",
   "projectName": "conekta-php",
   "appDescriptionV2" : "Conekta PHP Library",
   "useOneOfDiscriminatorLookup" : true,
   "nonCompliantUseDiscriminatorIfCompositionFails" : false,
-  "httpUserAgent": "Conekta/v2 PhpBindings/6.0.6",
+  "httpUserAgent": "Conekta/v2 PhpBindings/6.0.7",
   "packageAuthors" : "[email protected]",
   "files": {
     "/local/CODE_OF_CONDUCT.md" : {},

docs/Api/PayoutOrdersApi.md

@@ -0,0 +1,202 @@
+# Conekta\PayoutOrdersApi
+
+All URIs are relative to https://api.conekta.io, except if the operation defines another base path.
+
+| Method | HTTP request | Description |
+| ------------- | ------------- | ------------- |
+| [**createPayoutOrder()**](PayoutOrdersApi.md#createPayoutOrder) | **POST** /payout_orders | Create payout order |
+| [**getPayoutOrderById()**](PayoutOrdersApi.md#getPayoutOrderById) | **GET** /payout_orders/{id} | Get Payout Order |
+| [**getPayoutOrders()**](PayoutOrdersApi.md#getPayoutOrders) | **GET** /payout_orders | Get a list of Payout Orders |
+
+
+## `createPayoutOrder()`
+
+```php
+createPayoutOrder($payout_order, $accept_language): \Conekta\Model\PayoutOrderResponse
+```
+
+Create payout order
+
+Create a new payout order.
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure Bearer authorization: bearerAuth
+$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Conekta\Api\PayoutOrdersApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$payout_order = new \Conekta\Model\PayoutOrder(); // \Conekta\Model\PayoutOrder | requested field for payout order
+$accept_language = es; // string | Use for knowing which language to use
+
+try {
+    $result = $apiInstance->createPayoutOrder($payout_order, $accept_language);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PayoutOrdersApi->createPayoutOrder: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **payout_order** | [**\Conekta\Model\PayoutOrder**](../Model/PayoutOrder.md)| requested field for payout order | |
+| **accept_language** | **string**| Use for knowing which language to use | [optional] [default to &#39;es&#39;] |
+
+### Return type
+
+[**\Conekta\Model\PayoutOrderResponse**](../Model/PayoutOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/vnd.conekta-v2.1.0+json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
+## `getPayoutOrderById()`
+
+```php
+getPayoutOrderById($id, $accept_language): \Conekta\Model\PayoutOrderResponse
+```
+
+Get Payout Order
+
+Gets a payout Order resource that corresponds to a payout order ID.
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure Bearer authorization: bearerAuth
+$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Conekta\Api\PayoutOrdersApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$id = 6307a60c41de27127515a575; // string | Identifier of the resource
+$accept_language = es; // string | Use for knowing which language to use
+
+try {
+    $result = $apiInstance->getPayoutOrderById($id, $accept_language);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PayoutOrdersApi->getPayoutOrderById: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **id** | **string**| Identifier of the resource | |
+| **accept_language** | **string**| Use for knowing which language to use | [optional] [default to &#39;es&#39;] |
+
+### Return type
+
+[**\Conekta\Model\PayoutOrderResponse**](../Model/PayoutOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/vnd.conekta-v2.1.0+json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
+## `getPayoutOrders()`
+
+```php
+getPayoutOrders($accept_language, $limit, $search, $next, $previous): \Conekta\Model\PayoutOrdersResponse
+```
+
+Get a list of Payout Orders
+
+Get Payout order details in the form of a list
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure Bearer authorization: bearerAuth
+$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Conekta\Api\PayoutOrdersApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$accept_language = es; // string | Use for knowing which language to use
+$limit = 20; // int | The numbers of items to return, the maximum value is 250
+$search = 'search_example'; // string | General order search, e.g. by mail, reference etc.
+$next = 'next_example'; // string | next page
+$previous = 'previous_example'; // string | previous page
+
+try {
+    $result = $apiInstance->getPayoutOrders($accept_language, $limit, $search, $next, $previous);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PayoutOrdersApi->getPayoutOrders: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **accept_language** | **string**| Use for knowing which language to use | [optional] [default to &#39;es&#39;] |
+| **limit** | **int**| The numbers of items to return, the maximum value is 250 | [optional] [default to 20] |
+| **search** | **string**| General order search, e.g. by mail, reference etc. | [optional] |
+| **next** | **string**| next page | [optional] |
+| **previous** | **string**| previous page | [optional] |
+
+### Return type
+
+[**\Conekta\Model\PayoutOrdersResponse**](../Model/PayoutOrdersResponse.md)
+
+### Authorization
+
+[bearerAuth](../../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/vnd.conekta-v2.1.0+json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)

docs/Api/WebhooksApi.md

@@ -199,7 +199,7 @@ try {
 ## `getWebhooks()`
 
 ```php
-getWebhooks($accept_language, $x_child_company_id, $limit, $search, $next, $previous): \Conekta\Model\GetWebhooksResponse
+getWebhooks($accept_language, $x_child_company_id, $limit, $search, $url, $next, $previous): \Conekta\Model\GetWebhooksResponse
 ```
 
 Get List of Webhooks
@@ -227,11 +227,12 @@ $accept_language = es; // string | Use for knowing which language to use
 $x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.
 $limit = 20; // int | The numbers of items to return, the maximum value is 250
 $search = 'search_example'; // string | General order search, e.g. by mail, reference etc.
+$url = 'url_example'; // string | url for webhook filter
 $next = 'next_example'; // string | next page
 $previous = 'previous_example'; // string | previous page
 
 try {
-    $result = $apiInstance->getWebhooks($accept_language, $x_child_company_id, $limit, $search, $next, $previous);
+    $result = $apiInstance->getWebhooks($accept_language, $x_child_company_id, $limit, $search, $url, $next, $previous);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling WebhooksApi->getWebhooks: ', $e->getMessage(), PHP_EOL;
@@ -246,6 +247,7 @@ try {
 | **x_child_company_id** | **string**| In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
 | **limit** | **int**| The numbers of items to return, the maximum value is 250 | [optional] [default to 20] |
 | **search** | **string**| General order search, e.g. by mail, reference etc. | [optional] |
+| **url** | **string**| url for webhook filter | [optional] |
 | **next** | **string**| next page | [optional] |
 | **previous** | **string**| previous page | [optional] |
 

docs/Model/OrderResponseCheckout.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **on_demand_enabled** | **bool** |  | [optional]
 **paid_payments_count** | **int** |  | [optional]
 **recurrent** | **bool** |  | [optional]
+**redirection_time** | **int** | number of seconds to wait before redirecting to the success_url | [optional]
 **slug** | **string** |  | [optional]
 **sms_sent** | **int** |  | [optional]
 **success_url** | **string** |  | [optional]

docs/Model/Payout.md

@@ -0,0 +1,9 @@
+# # Payout
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_method** | [**\Conekta\Model\PayoutMethod**](PayoutMethod.md) |  |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/PayoutMethod.md

@@ -0,0 +1,9 @@
+# # PayoutMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of the payout method. |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/PayoutOrder.md

@@ -0,0 +1,15 @@
+# # PayoutOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allowed_payout_methods** | **string[]** | The payout methods that are allowed for the payout order. |
+**amount** | **int** | The amount of the payout order. |
+**currency** | **string** | The currency in which the payout order is made. | [default to 'MXN']
+**customer_info** | [**\Conekta\Model\CustomerInfoJustCustomerId**](CustomerInfoJustCustomerId.md) |  |
+**metadata** | **array<string,mixed>** | The metadata of the payout order. | [optional]
+**payout** | [**\Conekta\Model\Payout**](Payout.md) |  |
+**reason** | **string** | The reason for the payout order. |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)