Merge branch 'movement-api'

kronostechnologies · May 27, 2020 · aac5190 · aac5190
2 parents 0638e46 + 3fdf342
commit aac5190
Show file tree

Hide file tree

Showing 132 changed files with 22,426 additions and 115 deletions.
diff --git a/README.md b/README.md
@@ -98,11 +98,19 @@ Class | Method | HTTP request | Description
 *LegacyDocumentApi* | [**uploadDocumentFile**](docs/Api/LegacyDocumentApi.md#uploaddocumentfile) | **POST** /apps/api/kronos.document.uploadFile | Upload a new file in a document
 *LegacyProvisioningApi* | [**getOrganization**](docs/Api/LegacyProvisioningApi.md#getorganization) | **GET** /apps/provisioning/kronos.provisioning.getOrganization | Get all informations about an organization.
 *LegacyProvisioningApi* | [**getOrganizationList**](docs/Api/LegacyProvisioningApi.md#getorganizationlist) | **GET** /apps/provisioning/kronos.provisioning.getOrganizationList | List all organizations
+*MovementApi* | [**addMovement**](docs/Api/MovementApi.md#addmovement) | **POST** /crm/api/v1/movements | 
+*MovementApi* | [**cancelMovement**](docs/Api/MovementApi.md#cancelmovement) | **POST** /crm/api/v1/movements/{movementId}/cancel | 
+*MovementApi* | [**deleteMovement**](docs/Api/MovementApi.md#deletemovement) | **DELETE** /crm/api/v1/movements/{movementId} | 
+*MovementApi* | [**getMovementStatus**](docs/Api/MovementApi.md#getmovementstatus) | **GET** /crm/api/v1/movements/{movementId}/status | 
+*MovementApi* | [**listMovements**](docs/Api/MovementApi.md#listmovements) | **GET** /crm/api/v1/movements | 
 
 
 ## Documentation For Models
 
+ - [ErrorResponse](docs/Model/ErrorResponse.md)
+ - [LegacyAddUpdateItem](docs/Model/LegacyAddUpdateItem.md)
  - [LegacyAddUpdateResponse](docs/Model/LegacyAddUpdateResponse.md)
+ - [LegacyAddUpdateResponseAllOf](docs/Model/LegacyAddUpdateResponseAllOf.md)
  - [LegacyContactAddress](docs/Model/LegacyContactAddress.md)
  - [LegacyContactContact](docs/Model/LegacyContactContact.md)
  - [LegacyContactContactPayloadItem](docs/Model/LegacyContactContactPayloadItem.md)
@@ -135,6 +143,42 @@ Class | Method | HTTP request | Description
  - [LegacyProvisioningUserPayload](docs/Model/LegacyProvisioningUserPayload.md)
  - [LegacyResponse](docs/Model/LegacyResponse.md)
  - [LegacyUser](docs/Model/LegacyUser.md)
+ - [MovementAddMovementResponse](docs/Model/MovementAddMovementResponse.md)
+ - [MovementClientBaseUsingDistributionListMovement](docs/Model/MovementClientBaseUsingDistributionListMovement.md)
+ - [MovementClientBaseUsingDistributionListMovementAllOf](docs/Model/MovementClientBaseUsingDistributionListMovementAllOf.md)
+ - [MovementClientBaseUsingDistributionListMovementPayload](docs/Model/MovementClientBaseUsingDistributionListMovementPayload.md)
+ - [MovementClientBaseUsingDistributionListMovementPayloadAllOf](docs/Model/MovementClientBaseUsingDistributionListMovementPayloadAllOf.md)
+ - [MovementClientBaseUsingFileMovement](docs/Model/MovementClientBaseUsingFileMovement.md)
+ - [MovementClientBaseUsingFileMovementAllOf](docs/Model/MovementClientBaseUsingFileMovementAllOf.md)
+ - [MovementClientBaseUsingFileMovementPayload](docs/Model/MovementClientBaseUsingFileMovementPayload.md)
+ - [MovementClientBaseUsingFileMovementPayloadAllOf](docs/Model/MovementClientBaseUsingFileMovementPayloadAllOf.md)
+ - [MovementCopyMovement](docs/Model/MovementCopyMovement.md)
+ - [MovementCopyMovementAllOf](docs/Model/MovementCopyMovementAllOf.md)
+ - [MovementCopyMovementPayload](docs/Model/MovementCopyMovementPayload.md)
+ - [MovementCopyMovementPayloadAllOf](docs/Model/MovementCopyMovementPayloadAllOf.md)
+ - [MovementDatabase](docs/Model/MovementDatabase.md)
+ - [MovementDistributionList](docs/Model/MovementDistributionList.md)
+ - [MovementGatewayAccessCode](docs/Model/MovementGatewayAccessCode.md)
+ - [MovementGetStatusResponse](docs/Model/MovementGetStatusResponse.md)
+ - [MovementListMovementResponse](docs/Model/MovementListMovementResponse.md)
+ - [MovementMoveMovement](docs/Model/MovementMoveMovement.md)
+ - [MovementMoveMovementAllOf](docs/Model/MovementMoveMovementAllOf.md)
+ - [MovementMoveMovementPayload](docs/Model/MovementMoveMovementPayload.md)
+ - [MovementMoveMovementPayloadAllOf](docs/Model/MovementMoveMovementPayloadAllOf.md)
+ - [MovementMovement](docs/Model/MovementMovement.md)
+ - [MovementMovementPayload](docs/Model/MovementMovementPayload.md)
+ - [MovementMovementStatus](docs/Model/MovementMovementStatus.md)
+ - [MovementMovementType](docs/Model/MovementMovementType.md)
+ - [MovementReassignmentMovement](docs/Model/MovementReassignmentMovement.md)
+ - [MovementReassignmentMovementAllOf](docs/Model/MovementReassignmentMovementAllOf.md)
+ - [MovementReassignmentMovementPayload](docs/Model/MovementReassignmentMovementPayload.md)
+ - [MovementReassignmentMovementPayloadAllOf](docs/Model/MovementReassignmentMovementPayloadAllOf.md)
+ - [MovementTransferOption](docs/Model/MovementTransferOption.md)
+ - [MovementUser](docs/Model/MovementUser.md)
+ - [MovementUserTuple](docs/Model/MovementUserTuple.md)
+ - [MovementUserTuplePayload](docs/Model/MovementUserTuplePayload.md)
+ - [MovementValidationError](docs/Model/MovementValidationError.md)
+ - [MovementValidationErrorResponse](docs/Model/MovementValidationErrorResponse.md)
 
 
 ## Documentation For Authorization

diff --git a/docs/Api/LegacyApi.md → docs/Api/MovementApi.md b/docs/Api/LegacyApi.md → docs/Api/MovementApi.md
@@ -1,21 +1,22 @@
-# Equisoft\SDK\EquisoftConnect\LegacyApi
+# Equisoft\SDK\EquisoftConnect\MovementApi
 
 All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**addDocument**](LegacyApi.md#addDocument) | **POST** /apps/api/kronos.document.add | Create a new document.
-[**appsApiPost**](LegacyApi.md#appsApiPost) | **POST** /apps/api/ | Legacy API entrypoint
-[**getDocument**](LegacyApi.md#getDocument) | **GET** /apps/api/kronos.document.get | Get all data for a document record.
-[**getDocumentList**](LegacyApi.md#getDocumentList) | **GET** /apps/api/kronos.document.getList | Get a list of all documents. This will return basic information about the document.
+[**addMovement**](MovementApi.md#addMovement) | **POST** /crm/api/v1/movements | 
+[**cancelMovement**](MovementApi.md#cancelMovement) | **POST** /crm/api/v1/movements/{movementId}/cancel | 
+[**deleteMovement**](MovementApi.md#deleteMovement) | **DELETE** /crm/api/v1/movements/{movementId} | 
+[**getMovementStatus**](MovementApi.md#getMovementStatus) | **GET** /crm/api/v1/movements/{movementId}/status | 
+[**listMovements**](MovementApi.md#listMovements) | **GET** /crm/api/v1/movements | 
 
 
 
-## addDocument
+## addMovement
+
+> \Equisoft\SDK\EquisoftConnect\Model\MovementAddMovementResponse addMovement($movementMovementPayload)
 
-> \Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse addDocument($legacyDocumentDocumentPayloadRequest)
 
-Create a new document.
 
 ### Example
 
@@ -28,19 +29,19 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
 
 
-$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyApi(
+$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
     // 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
 );
-$legacyDocumentDocumentPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest | 
+$movementMovementPayload = new \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload(); // \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload | 
 
 try {
-    $result = $apiInstance->addDocument($legacyDocumentDocumentPayloadRequest);
+    $result = $apiInstance->addMovement($movementMovementPayload);
     print_r($result);
 } catch (Exception $e) {
-    echo 'Exception when calling LegacyApi->addDocument: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling MovementApi->addMovement: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
@@ -50,11 +51,11 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **legacyDocumentDocumentPayloadRequest** | [**\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest**](../Model/LegacyDocumentDocumentPayloadRequest.md)|  |
+ **movementMovementPayload** | [**\Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload**](../Model/MovementMovementPayload.md)|  |
 
 ### Return type
 
-[**\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse**](../Model/LegacyAddUpdateResponse.md)
+[**\Equisoft\SDK\EquisoftConnect\Model\MovementAddMovementResponse**](../Model/MovementAddMovementResponse.md)
 
 ### Authorization
 
@@ -70,11 +71,11 @@ Name | Type | Description  | Notes
 [[Back to README]](../../README.md)
 
 
-## appsApiPost
+## cancelMovement
+
+> object cancelMovement($movementId)
 
-> \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse appsApiPost($method, $json, $body)
 
-Legacy API entrypoint
 
 ### Example
 
@@ -87,21 +88,19 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
 
 
-$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyApi(
+$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
     // 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
 );
-$method = 'method_example'; // string | Legacy method name
-$json = True; // bool | 
-$body = new \Equisoft\SDK\EquisoftConnect\Model\AnyType(); // AnyType | 
+$movementId = 56; // int | 
 
 try {
-    $result = $apiInstance->appsApiPost($method, $json, $body);
+    $result = $apiInstance->cancelMovement($movementId);
     print_r($result);
 } catch (Exception $e) {
-    echo 'Exception when calling LegacyApi->appsApiPost: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling MovementApi->cancelMovement: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
@@ -111,33 +110,31 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **method** | **string**| Legacy method name |
- **json** | **bool**|  | [optional]
- **body** | **AnyType**|  | [optional]
+ **movementId** | **int**|  |
 
 ### Return type
 
-[**\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse**](../Model/LegacyResponse.md)
+**object**
 
 ### Authorization
 
 [OAuth2](../../README.md#OAuth2)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
 [[Back to Model list]](../../README.md#documentation-for-models)
 [[Back to README]](../../README.md)
 
 
-## getDocument
+## deleteMovement
+
+> object deleteMovement($movementId)
 
-> \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetResponse getDocument()
 
-Get all data for a document record.
 
 ### Example
 
@@ -150,29 +147,92 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
 
 
-$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyApi(
+$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
     // 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
 );
+$movementId = 56; // int | 
 
 try {
-    $result = $apiInstance->getDocument();
+    $result = $apiInstance->deleteMovement($movementId);
     print_r($result);
 } catch (Exception $e) {
-    echo 'Exception when calling LegacyApi->getDocument: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling MovementApi->deleteMovement: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **movementId** | **int**|  |
+
+### Return type
+
+**object**
+
+### Authorization
+
+[OAuth2](../../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../../README.md#documentation-for-models)
+[[Back to README]](../../README.md)
+
+
+## getMovementStatus
+
+> \Equisoft\SDK\EquisoftConnect\Model\MovementGetStatusResponse getMovementStatus($movementId)
+
+
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure OAuth2 access token for authorization: OAuth2
+$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
+    // 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
+);
+$movementId = 56; // int | 
+
+try {
+    $result = $apiInstance->getMovementStatus($movementId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling MovementApi->getMovementStatus: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **movementId** | **int**|  |
 
 ### Return type
 
-[**\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetResponse**](../Model/LegacyDocumentGetResponse.md)
+[**\Equisoft\SDK\EquisoftConnect\Model\MovementGetStatusResponse**](../Model/MovementGetStatusResponse.md)
 
 ### Authorization
 
@@ -188,13 +248,11 @@ This endpoint does not need any parameter.
 [[Back to README]](../../README.md)
 
 
-## getDocumentList
+## listMovements
 
-> \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetListResponse getDocumentList()
+> \Equisoft\SDK\EquisoftConnect\Model\MovementListMovementResponse listMovements()
 
-Get a list of all documents. This will return basic information about the document.
 
-Please note that a document is similar to a folder and may contain one or many files.
 
 ### Example
 
@@ -207,18 +265,18 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
 
 
-$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyApi(
+$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
     // 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
 );
 
 try {
-    $result = $apiInstance->getDocumentList();
+    $result = $apiInstance->listMovements();
     print_r($result);
 } catch (Exception $e) {
-    echo 'Exception when calling LegacyApi->getDocumentList: ', $e->getMessage(), PHP_EOL;
+    echo 'Exception when calling MovementApi->listMovements: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
@@ -229,7 +287,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetListResponse**](../Model/LegacyDocumentGetListResponse.md)
+[**\Equisoft\SDK\EquisoftConnect\Model\MovementListMovementResponse**](../Model/MovementListMovementResponse.md)
 
 ### Authorization
 

diff --git a/docs/Model/ErrorResponse.md b/docs/Model/ErrorResponse.md
@@ -0,0 +1,12 @@
+# # ErrorResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **string** |  | [optional] 
+**errorDescription** | **string** |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+
diff --git a/docs/Model/LegacyAddUpdateItem.md b/docs/Model/LegacyAddUpdateItem.md
@@ -0,0 +1,13 @@
+# # LegacyAddUpdateItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | id of the added item | [optional] 
+**externalKey** | **string** | External key assigned to the item | [optional] 
+**result** | **string** | Status of the Add or Update command (\&quot;inserted\&quot; | \&quot;updated\&quot;) | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+
diff --git a/docs/Model/LegacyAddUpdateResponse.md b/docs/Model/LegacyAddUpdateResponse.md
@@ -4,6 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**stat** | **string** | Status of the request that has been made. Can be &#39;ok&#39; or &#39;fail&#39; | [optional] 
+**errorCode** | **string** | If the request has failed, this element will contain the error code related to the problem encountered. | [optional] 
+**errorMsg** | **string** | If the request has failed, this element will contain the error message related to the problem encountered. | [optional] 
+**items** | [**\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateItem[]**](LegacyAddUpdateItem.md) | List all items status for the Add or Update operation | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)