Skip to content

Latest commit

 

History

History
301 lines (203 loc) · 8.2 KB

StorageApi.md

File metadata and controls

301 lines (203 loc) · 8.2 KB

OpenAPI\Client\StorageApi

All URIs are relative to http://localhost:59999, except if the operation defines another base path.

Method HTTP request Description
deleteByKeyFromStorage() DELETE /storage/{key}
getByKeyFromStorage() GET /storage/{key}
incrementCounter() PUT /storage/counter/increment
searchRecord() GET /storage/search/{term}
upsertByKeyFromStorage() PUT /storage/{key}

deleteByKeyFromStorage()

deleteByKeyFromStorage($key, $x_monday_access_token)

Example

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



$apiInstance = new OpenAPI\Client\Api\StorageApi(
    // 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()
);
$key = 'key_example'; // string
$x_monday_access_token = 'x_monday_access_token_example'; // string

try {
    $apiInstance->deleteByKeyFromStorage($key, $x_monday_access_token);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->deleteByKeyFromStorage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string
x_monday_access_token string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getByKeyFromStorage()

getByKeyFromStorage($key, $shared, $x_monday_access_token): \OpenAPI\Client\Model\StorageDataContract

Example

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



$apiInstance = new OpenAPI\Client\Api\StorageApi(
    // 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()
);
$key = 'key_example'; // string
$shared = True; // bool
$x_monday_access_token = 'x_monday_access_token_example'; // string

try {
    $result = $apiInstance->getByKeyFromStorage($key, $shared, $x_monday_access_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->getByKeyFromStorage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string
shared bool
x_monday_access_token string

Return type

\OpenAPI\Client\Model\StorageDataContract

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]

incrementCounter()

incrementCounter($x_monday_access_token, $increment_counter_params): \OpenAPI\Client\Model\IncrementCounter200Response

Example

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



$apiInstance = new OpenAPI\Client\Api\StorageApi(
    // 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()
);
$x_monday_access_token = 'x_monday_access_token_example'; // string
$increment_counter_params = new \OpenAPI\Client\Model\IncrementCounterParams(); // \OpenAPI\Client\Model\IncrementCounterParams

try {
    $result = $apiInstance->incrementCounter($x_monday_access_token, $increment_counter_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->incrementCounter: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
x_monday_access_token string
increment_counter_params \OpenAPI\Client\Model\IncrementCounterParams

Return type

\OpenAPI\Client\Model\IncrementCounter200Response

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]

searchRecord()

searchRecord($term, $x_monday_access_token, $cursor): mixed

Example

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



$apiInstance = new OpenAPI\Client\Api\StorageApi(
    // 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()
);
$term = 'term_example'; // string
$x_monday_access_token = 'x_monday_access_token_example'; // string
$cursor = 'cursor_example'; // string

try {
    $result = $apiInstance->searchRecord($term, $x_monday_access_token, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->searchRecord: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
term string
x_monday_access_token string
cursor string [optional]

Return type

mixed

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]

upsertByKeyFromStorage()

upsertByKeyFromStorage($key, $x_monday_access_token, $json_data_contract, $shared, $previous_version): \OpenAPI\Client\Model\UpsertByKeyFromStorage200Response

Example

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



$apiInstance = new OpenAPI\Client\Api\StorageApi(
    // 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()
);
$key = 'key_example'; // string
$x_monday_access_token = 'x_monday_access_token_example'; // string
$json_data_contract = new \OpenAPI\Client\Model\JsonDataContract(); // \OpenAPI\Client\Model\JsonDataContract
$shared = True; // bool
$previous_version = 'previous_version_example'; // string

try {
    $result = $apiInstance->upsertByKeyFromStorage($key, $x_monday_access_token, $json_data_contract, $shared, $previous_version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorageApi->upsertByKeyFromStorage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string
x_monday_access_token string
json_data_contract \OpenAPI\Client\Model\JsonDataContract
shared bool [optional]
previous_version string [optional]

Return type

\OpenAPI\Client\Model\UpsertByKeyFromStorage200Response

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]