这是indexloc提供的服务，不要输入任何密码
Skip to content

[API-BOT] Update OpenAPI spec and regenerate SDK #85

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[API-BOT] Update OpenAPI spec and regenerate SDK #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
119 changes: 119 additions & 0 deletions docs/Api/AddOnsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# [Upsun\Api\AddOnsApi](../src/Api/AddOnsApi.php)

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

| Method | HTTP request | Description | Upsun API Doc |
| ------------- | ------------- | ------------- | ------------- |
| [**getOrgAddons()**](AddOnsApi.md#getOrgAddons) | **GET** /organizations/{organization_id}/addons | Get add-ons | https://docs.upsun.com/api/#tag/Add-ons/operation/get-org-addons |
| [**updateOrgAddons()**](AddOnsApi.md#updateOrgAddons) | **PATCH** /organizations/{organization_id}/addons | Update organization add-ons | https://docs.upsun.com/api/#tag/Add-ons/operation/update-org-addons |


## `getOrgAddons()`

```php
getOrgAddons($organizationId): \Upsun\Model\OrganizationAddonsObject
```

Get add-ons

Retrieves information about the add-ons for an organization.

### Example

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

$apiInstance = new Upsun\Api\AddOnsApi(
// 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()
);
$organizationId = 'organizationId_example'; // string | The ID of the organization.<br> Prefix with name= to retrieve the organization by name instead.

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

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **organizationId** | **string**| The ID of the organization.&lt;br&gt; Prefix with name&#x3D; to retrieve the organization by name instead. | |

### Return type

[**\Upsun\Model\OrganizationAddonsObject**](../Model/OrganizationAddonsObject.md)

### Authorization

No authorization required

### HTTP request headers

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

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

## `updateOrgAddons()`

```php
updateOrgAddons($organizationId, $updateOrgAddonsRequest): \Upsun\Model\OrganizationAddonsObject
```

Update organization add-ons

Updates the add-ons configuration for an organization.

### Example

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

$apiInstance = new Upsun\Api\AddOnsApi(
// 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()
);
$organizationId = 'organizationId_example'; // string | The ID of the organization.<br> Prefix with name= to retrieve the organization by name instead.
$updateOrgAddonsRequest = new \Upsun\Model\UpdateOrgAddonsRequest(); // \Upsun\Model\UpdateOrgAddonsRequest

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

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **organizationId** | **string**| The ID of the organization.&lt;br&gt; Prefix with name&#x3D; to retrieve the organization by name instead. | |
| **updateOrgAddonsRequest** | [**\Upsun\Model\UpdateOrgAddonsRequest**](../Model/UpdateOrgAddonsRequest.md)| | |

### Return type

[**\Upsun\Model\OrganizationAddonsObject**](../Model/OrganizationAddonsObject.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
115 changes: 115 additions & 0 deletions docs/Api/AlertsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# [Upsun\Api\AlertsApi](../src/Api/AlertsApi.php)

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

| Method | HTTP request | Description | Upsun API Doc |
| ------------- | ------------- | ------------- | ------------- |
| [**getUsageAlerts()**](AlertsApi.md#getUsageAlerts) | **GET** /alerts/subscriptions/{subscriptionId}/usage | Get usage alerts for a subscription | https://docs.upsun.com/api/#tag/Alerts/operation/get-usage-alerts |
| [**updateUsageAlerts()**](AlertsApi.md#updateUsageAlerts) | **PATCH** /alerts/subscriptions/{subscriptionId}/usage | Update usage alerts. | https://docs.upsun.com/api/#tag/Alerts/operation/update-usage-alerts |


## `getUsageAlerts()`

```php
getUsageAlerts($subscriptionId): \Upsun\Model\GetUsageAlerts200Response
```

Get usage alerts for a subscription

### Example

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

$apiInstance = new Upsun\Api\AlertsApi(
// 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()
);
$subscriptionId = 'subscriptionId_example'; // string | The ID of the subscription

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

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **subscriptionId** | **string**| The ID of the subscription | |

### Return type

[**\Upsun\Model\GetUsageAlerts200Response**](../Model/GetUsageAlerts200Response.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)

## `updateUsageAlerts()`

```php
updateUsageAlerts($subscriptionId, $updateUsageAlertsRequest): \Upsun\Model\GetUsageAlerts200Response
```

Update usage alerts.

### Example

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

$apiInstance = new Upsun\Api\AlertsApi(
// 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()
);
$subscriptionId = 'subscriptionId_example'; // string | The ID of the subscription
$updateUsageAlertsRequest = new \Upsun\Model\UpdateUsageAlertsRequest(); // \Upsun\Model\UpdateUsageAlertsRequest

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

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **subscriptionId** | **string**| The ID of the subscription | |
| **updateUsageAlertsRequest** | [**\Upsun\Model\UpdateUsageAlertsRequest**](../Model/UpdateUsageAlertsRequest.md)| | [optional] |

### Return type

[**\Upsun\Model\GetUsageAlerts200Response**](../Model/GetUsageAlerts200Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **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