Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generated version #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
# ref: https://github.com/github/gitignore/blob/master/Composer.gitignore

composer.phar
Expand Down
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
"repositories": [
{
"type": "vcs",
"url": "https://github.com/mondaycom/monday-code-php-sdk.git"
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"mondaycom/monday-code-php-sdk": "*@dev"
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
```
Expand All @@ -50,18 +50,18 @@ require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\QueueApi(
$apiInstance = new OpenAPI\Client\Api\EnvironmentVariablesApi(
// 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()
);
$publish_message_params = new \OpenAPI\Client\Model\PublishMessageParams(); // \OpenAPI\Client\Model\PublishMessageParams
$name = 'name_example'; // string

try {
$result = $apiInstance->publishMessage($publish_message_params);
$result = $apiInstance->getEnvironmentVariable($name);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling QueueApi->publishMessage: ', $e->getMessage(), PHP_EOL;
echo 'Exception when calling EnvironmentVariablesApi->getEnvironmentVariable: ', $e->getMessage(), PHP_EOL;
}

```
Expand All @@ -72,27 +72,37 @@ All URIs are relative to *http://localhost:59999*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EnvironmentVariablesApi* | [**getEnvironmentVariable**](docs/Api/EnvironmentVariablesApi.md#getenvironmentvariable) | **GET** /environment-variables/{name} |
*EnvironmentVariablesApi* | [**getEnvironmentVariableKeys**](docs/Api/EnvironmentVariablesApi.md#getenvironmentvariablekeys) | **GET** /environment-variables |
*LogsApi* | [**writeLog**](docs/Api/LogsApi.md#writelog) | **POST** /logs |
*QueueApi* | [**publishMessage**](docs/Api/QueueApi.md#publishmessage) | **POST** /queue |
*QueueApi* | [**validateSecret**](docs/Api/QueueApi.md#validatesecret) | **POST** /queue/validate-secret |
*SecretApi* | [**getSecret**](docs/Api/SecretApi.md#getsecret) | **GET** /secrets/{name} |
*SecretsApi* | [**getSecret**](docs/Api/SecretsApi.md#getsecret) | **GET** /secrets/{name} |
*SecretsApi* | [**getSecretKeys**](docs/Api/SecretsApi.md#getsecretkeys) | **GET** /secrets |
*SecureStorageApi* | [**deleteSecureStorage**](docs/Api/SecureStorageApi.md#deletesecurestorage) | **DELETE** /secure-storage/{key} |
*SecureStorageApi* | [**getSecureStorage**](docs/Api/SecureStorageApi.md#getsecurestorage) | **GET** /secure-storage/{key} |
*SecureStorageApi* | [**putSecureStorage**](docs/Api/SecureStorageApi.md#putsecurestorage) | **PUT** /secure-storage/{key} |
*StorageApi* | [**deleteStorage**](docs/Api/StorageApi.md#deletestorage) | **DELETE** /storage/{key} |
*StorageApi* | [**getStorage**](docs/Api/StorageApi.md#getstorage) | **GET** /storage/{key} |
*StorageApi* | [**putStorage**](docs/Api/StorageApi.md#putstorage) | **PUT** /storage/{key} |
*StorageApi* | [**storageIncrementCounter**](docs/Api/StorageApi.md#storageincrementcounter) | **PUT** /storage/{key}/counter/increment |
*StorageApi* | [**deleteByKeyFromStorage**](docs/Api/StorageApi.md#deletebykeyfromstorage) | **DELETE** /storage/{key} |
*StorageApi* | [**getByKeyFromStorage**](docs/Api/StorageApi.md#getbykeyfromstorage) | **GET** /storage/{key} |
*StorageApi* | [**incrementCounter**](docs/Api/StorageApi.md#incrementcounter) | **PUT** /storage/counter/increment |
*StorageApi* | [**upsertByKeyFromStorage**](docs/Api/StorageApi.md#upsertbykeyfromstorage) | **PUT** /storage/{key} |

## Models

- [GetStorage404Response](docs/Model/GetStorage404Response.md)
- [GetByKeyFromStorage404Response](docs/Model/GetByKeyFromStorage404Response.md)
- [GetByKeyFromStorage500Response](docs/Model/GetByKeyFromStorage500Response.md)
- [IncrementCounterParams](docs/Model/IncrementCounterParams.md)
- [JsonValue](docs/Model/JsonValue.md)
- [LogMethods](docs/Model/LogMethods.md)
- [Period](docs/Model/Period.md)
- [PublishMessageParams](docs/Model/PublishMessageParams.md)
- [PublishMessageResponse](docs/Model/PublishMessageResponse.md)
- [SecureStorageDataContract](docs/Model/SecureStorageDataContract.md)
- [StorageDataContract](docs/Model/StorageDataContract.md)
- [ValidateSecretParams](docs/Model/ValidateSecretParams.md)
- [ValidateSecretResponse](docs/Model/ValidateSecretResponse.md)
- [WriteLogRequestBody](docs/Model/WriteLogRequestBody.md)
- [WriteLogRequestBodyError](docs/Model/WriteLogRequestBodyError.md)

## Authorization
Endpoints do not require authorization.
Expand All @@ -115,4 +125,5 @@ vendor/bin/phpunit
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `0.0.1`
- Generator version: `7.7.0-SNAPSHOT`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
1 change: 0 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"name": "mondaycom/monday-code",
"description": "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)",
"keywords": [
"openapitools",
Expand Down
114 changes: 114 additions & 0 deletions docs/Api/EnvironmentVariablesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# OpenAPI\Client\EnvironmentVariablesApi

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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getEnvironmentVariable()**](EnvironmentVariablesApi.md#getEnvironmentVariable) | **GET** /environment-variables/{name} | |
| [**getEnvironmentVariableKeys()**](EnvironmentVariablesApi.md#getEnvironmentVariableKeys) | **GET** /environment-variables | |


## `getEnvironmentVariable()`

```php
getEnvironmentVariable($name): \OpenAPI\Client\Model\JsonValue
```



### Example

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



$apiInstance = new OpenAPI\Client\Api\EnvironmentVariablesApi(
// 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()
);
$name = 'name_example'; // string

try {
$result = $apiInstance->getEnvironmentVariable($name);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EnvironmentVariablesApi->getEnvironmentVariable: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **name** | **string**| | |

### Return type

[**\OpenAPI\Client\Model\JsonValue**](../Model/JsonValue.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getEnvironmentVariableKeys()`

```php
getEnvironmentVariableKeys(): string[]
```



### Example

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



$apiInstance = new OpenAPI\Client\Api\EnvironmentVariablesApi(
// 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()
);

try {
$result = $apiInstance->getEnvironmentVariableKeys();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EnvironmentVariablesApi->getEnvironmentVariableKeys: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

**string[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
25 changes: 12 additions & 13 deletions docs/Api/SecretApi.md → docs/Api/LogsApi.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# OpenAPI\Client\SecretApi
# OpenAPI\Client\LogsApi

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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getSecret()**](SecretApi.md#getSecret) | **GET** /secrets/{name} | |
| [**writeLog()**](LogsApi.md#writeLog) | **POST** /logs | |


## `getSecret()`
## `writeLog()`

```php
getSecret($name): string
writeLog($write_log_request_body)
```


Expand All @@ -23,39 +23,38 @@ require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\SecretApi(
$apiInstance = new OpenAPI\Client\Api\LogsApi(
// 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()
);
$name = 'name_example'; // string
$write_log_request_body = new \OpenAPI\Client\Model\WriteLogRequestBody(); // \OpenAPI\Client\Model\WriteLogRequestBody

try {
$result = $apiInstance->getSecret($name);
print_r($result);
$apiInstance->writeLog($write_log_request_body);
} catch (Exception $e) {
echo 'Exception when calling SecretApi->getSecret: ', $e->getMessage(), PHP_EOL;
echo 'Exception when calling LogsApi->writeLog: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **name** | **string**| | |
| **write_log_request_body** | [**\OpenAPI\Client\Model\WriteLogRequestBody**](../Model/WriteLogRequestBody.md)| | |

### Return type

**string**
void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`
- **Content-Type**: `application/json`
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
Expand Down
114 changes: 114 additions & 0 deletions docs/Api/SecretsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# OpenAPI\Client\SecretsApi

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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getSecret()**](SecretsApi.md#getSecret) | **GET** /secrets/{name} | |
| [**getSecretKeys()**](SecretsApi.md#getSecretKeys) | **GET** /secrets | |


## `getSecret()`

```php
getSecret($name): string
```



### Example

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



$apiInstance = new OpenAPI\Client\Api\SecretsApi(
// 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()
);
$name = 'name_example'; // string

try {
$result = $apiInstance->getSecret($name);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecretsApi->getSecret: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **name** | **string**| | |

### Return type

**string**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getSecretKeys()`

```php
getSecretKeys(): string[]
```



### Example

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



$apiInstance = new OpenAPI\Client\Api\SecretsApi(
// 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()
);

try {
$result = $apiInstance->getSecretKeys();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecretsApi->getSecretKeys: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

**string[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
Loading