Skip to content

SecureVendorManagementApi.md

Latest commit

 

History

History
532 lines (385 loc) · 20.2 KB

SecureVendorManagementApi.md

File metadata and controls

532 lines (385 loc) · 20.2 KB

OpenAPI\Client\SecureVendorManagementApi

All URIs are relative to https://api.uat.anddone.com, except if the operation defines another base path.

Method HTTP request Description
vendorapiSecureMerchantsVendorsDeletePost() POST /vendorapi/secure/merchants/vendors/delete This API deletes vendor into system
vendorapiSecureMerchantsVendorsDetailsPost() POST /vendorapi/secure/merchants/vendors/details This API gets details of particular vendor
vendorapiSecureMerchantsVendorsEditPost() POST /vendorapi/secure/merchants/vendors/edit This API Updates the existing vendor
vendorapiSecureMerchantsVendorsPost() POST /vendorapi/secure/merchants/vendors This API creates vendor into system
vendorapiSecureMerchantsVendorsSearchPost() POST /vendorapi/secure/merchants/vendors/search This API returns list of all the Vendors of Merchant
vendorapiSecureMerchantsVendorsSuspendPost() POST /vendorapi/secure/merchants/vendors/suspend This API suspends vendor into system
vendorapiSecureMerchantsVendorsTimelinePost() POST /vendorapi/secure/merchants/vendors/timeline This API gets timeline of particular vendor
vendorapiSecureMerchantsVendorsUnsuspendPost() POST /vendorapi/secure/merchants/vendors/unsuspend This API unsuspends vendor into system

vendorapiSecureMerchantsVendorsDeletePost()

vendorapiSecureMerchantsVendorsDeletePost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorStatusRequestDTO)

This API deletes vendor into system

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureVendorStatusRequestDTO = new \OpenAPI\Client\Model\SecureVendorStatusRequestDTO(); // \OpenAPI\Client\Model\SecureVendorStatusRequestDTO | SecureVendorStatusRequestDTO

try {
    $apiInstance->vendorapiSecureMerchantsVendorsDeletePost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorStatusRequestDTO);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsDeletePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureVendorStatusRequestDTO \OpenAPI\Client\Model\SecureVendorStatusRequestDTO SecureVendorStatusRequestDTO

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsDetailsPost()

vendorapiSecureMerchantsVendorsDetailsPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorRequestDTO): \OpenAPI\Client\Model\VendorResponseDTO

This API gets details of particular vendor

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureVendorRequestDTO = new \OpenAPI\Client\Model\SecureVendorRequestDTO(); // \OpenAPI\Client\Model\SecureVendorRequestDTO | SecureVendorRequestDTO

try {
    $result = $apiInstance->vendorapiSecureMerchantsVendorsDetailsPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorRequestDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsDetailsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureVendorRequestDTO \OpenAPI\Client\Model\SecureVendorRequestDTO SecureVendorRequestDTO

Return type

\OpenAPI\Client\Model\VendorResponseDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsEditPost()

vendorapiSecureMerchantsVendorsEditPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorUpdateRequestDTO): \OpenAPI\Client\Model\SecureVendorResponseDTO

This API Updates the existing vendor

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureVendorUpdateRequestDTO = new \OpenAPI\Client\Model\SecureVendorUpdateRequestDTO(); // \OpenAPI\Client\Model\SecureVendorUpdateRequestDTO | SecureVendorUpdateRequestDTO

try {
    $result = $apiInstance->vendorapiSecureMerchantsVendorsEditPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorUpdateRequestDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsEditPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureVendorUpdateRequestDTO \OpenAPI\Client\Model\SecureVendorUpdateRequestDTO SecureVendorUpdateRequestDTO

Return type

\OpenAPI\Client\Model\SecureVendorResponseDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsPost()

vendorapiSecureMerchantsVendorsPost($xApiKey, $xAppKey, $xVersion, $origin, $vendorRequestDTO): \OpenAPI\Client\Model\SecureVendorResponseDTO

This API creates vendor into system

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$vendorRequestDTO = new \OpenAPI\Client\Model\VendorRequestDTO(); // \OpenAPI\Client\Model\VendorRequestDTO | VendorRequestDTO

try {
    $result = $apiInstance->vendorapiSecureMerchantsVendorsPost($xApiKey, $xAppKey, $xVersion, $origin, $vendorRequestDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
vendorRequestDTO \OpenAPI\Client\Model\VendorRequestDTO VendorRequestDTO

Return type

\OpenAPI\Client\Model\SecureVendorResponseDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsSearchPost()

vendorapiSecureMerchantsVendorsSearchPost($xApiKey, $xAppKey, $xVersion, $origin, $paymentMethodType, $attention, $vendorId, $vendorName, $vendorStatus, $createdBy, $startDate, $endDate, $pageSize, $searchText, $sortField, $startRow, $asc): \OpenAPI\Client\Model\PageVendorResponseDTO

This API returns list of all the Vendors of Merchant

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$paymentMethodType = 'paymentMethodType_example'; // string | Set paymentMethodType
$attention = 'attention_example'; // string | Set attention
$vendorId = 'vendorId_example'; // string | Set vendorId
$vendorName = 'vendorName_example'; // string | Set vendorName
$vendorStatus = 'vendorStatus_example'; // string | Set vendorStatus
$createdBy = 'createdBy_example'; // string | Set createdBy
$startDate = 'startDate_example'; // string | set start Date
$endDate = 'endDate_example'; // string | set end Date
$pageSize = 56; // int | Set PageSize
$searchText = 'searchText_example'; // string | search Text
$sortField = 'sortField_example'; // string | Set SortField
$startRow = 56; // int | Set StartRow
$asc = True; // bool | Set Asc

try {
    $result = $apiInstance->vendorapiSecureMerchantsVendorsSearchPost($xApiKey, $xAppKey, $xVersion, $origin, $paymentMethodType, $attention, $vendorId, $vendorName, $vendorStatus, $createdBy, $startDate, $endDate, $pageSize, $searchText, $sortField, $startRow, $asc);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsSearchPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
paymentMethodType string Set paymentMethodType [optional]
attention string Set attention [optional]
vendorId string Set vendorId [optional]
vendorName string Set vendorName [optional]
vendorStatus string Set vendorStatus [optional]
createdBy string Set createdBy [optional]
startDate string set start Date [optional]
endDate string set end Date [optional]
pageSize int Set PageSize [optional]
searchText string search Text [optional]
sortField string Set SortField [optional]
startRow int Set StartRow [optional]
asc bool Set Asc [optional]

Return type

\OpenAPI\Client\Model\PageVendorResponseDTO

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsSuspendPost()

vendorapiSecureMerchantsVendorsSuspendPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorStatusRequestDTO)

This API suspends vendor into system

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureVendorStatusRequestDTO = new \OpenAPI\Client\Model\SecureVendorStatusRequestDTO(); // \OpenAPI\Client\Model\SecureVendorStatusRequestDTO | SecureVendorStatusRequestDTO

try {
    $apiInstance->vendorapiSecureMerchantsVendorsSuspendPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorStatusRequestDTO);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsSuspendPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureVendorStatusRequestDTO \OpenAPI\Client\Model\SecureVendorStatusRequestDTO SecureVendorStatusRequestDTO

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsTimelinePost()

vendorapiSecureMerchantsVendorsTimelinePost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorTimelineRequestDTO): \OpenAPI\Client\Model\VendorTimelineResponseListInner[]

This API gets timeline of particular vendor

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureVendorTimelineRequestDTO = new \OpenAPI\Client\Model\SecureVendorTimelineRequestDTO(); // \OpenAPI\Client\Model\SecureVendorTimelineRequestDTO | SecureVendorTimelineRequestDTO

try {
    $result = $apiInstance->vendorapiSecureMerchantsVendorsTimelinePost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorTimelineRequestDTO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsTimelinePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureVendorTimelineRequestDTO \OpenAPI\Client\Model\SecureVendorTimelineRequestDTO SecureVendorTimelineRequestDTO

Return type

\OpenAPI\Client\Model\VendorTimelineResponseListInner[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

vendorapiSecureMerchantsVendorsUnsuspendPost()

vendorapiSecureMerchantsVendorsUnsuspendPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorStatusRequestDTO)

This API unsuspends vendor into system

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecureVendorManagementApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureVendorStatusRequestDTO = new \OpenAPI\Client\Model\SecureVendorStatusRequestDTO(); // \OpenAPI\Client\Model\SecureVendorStatusRequestDTO | SecureVendorStatusRequestDTO

try {
    $apiInstance->vendorapiSecureMerchantsVendorsUnsuspendPost($xApiKey, $xAppKey, $xVersion, $origin, $secureVendorStatusRequestDTO);
} catch (Exception $e) {
    echo 'Exception when calling SecureVendorManagementApi->vendorapiSecureMerchantsVendorsUnsuspendPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureVendorStatusRequestDTO \OpenAPI\Client\Model\SecureVendorStatusRequestDTO SecureVendorStatusRequestDTO

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]