yellowgrid-api-ts 3.2.159-dev.0 → 3.2.161-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +4 -0
- package/api.ts +239 -2
- package/dist/api.d.ts +137 -2
- package/dist/api.js +234 -0
- package/dist/models/HostingPriceListEnum.d.ts +5 -5
- package/dist/models/HostingPriceListEnum.js +5 -5
- package/dist/models/PaymentMethodEnum.d.ts +13 -0
- package/dist/models/PaymentMethodEnum.js +15 -0
- package/dist/models/UserGroupEnum.d.ts +28 -0
- package/dist/models/UserGroupEnum.js +30 -0
- package/docs/AccountsApi.md +48 -0
- package/docs/CRMApi.md +2 -2
- package/docs/Class3CXApi.md +48 -0
- package/docs/Class3CXInstallationsApi.md +55 -0
- package/docs/CreditAccountEntity.md +2 -0
- package/docs/PortalAccountModel.md +2 -0
- package/docs/TableHistoryEntity.md +35 -0
- package/models/HostingPriceListEnum.ts +5 -5
- package/models/PaymentMethodEnum.ts +14 -0
- package/models/UserGroupEnum.ts +29 -0
- package/package.json +1 -1
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
|
|
8
8
|
|[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
|
|
9
|
+
|[**getGetRecordingBackupStorage**](#getgetrecordingbackupstorage) | **GET** /tcx/installations/{instance_id}/recordings/backup | Get Recording Backup Storage|
|
|
9
10
|
|[**patchChangeInstanceOwner**](#patchchangeinstanceowner) | **PATCH** /tcx/installations/{instance_id}/owner | Change instance owner|
|
|
10
11
|
|[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
|
|
11
12
|
|[**postAddDisk**](#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance|
|
|
@@ -150,6 +151,60 @@ No authorization required
|
|
|
150
151
|
|
|
151
152
|
[[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)
|
|
152
153
|
|
|
154
|
+
# **getGetRecordingBackupStorage**
|
|
155
|
+
> RecordingBackupAzureModel getGetRecordingBackupStorage()
|
|
156
|
+
|
|
157
|
+
Get Recording Backup Storage
|
|
158
|
+
|
|
159
|
+
### Example
|
|
160
|
+
|
|
161
|
+
```typescript
|
|
162
|
+
import {
|
|
163
|
+
Class3CXInstallationsApi,
|
|
164
|
+
Configuration
|
|
165
|
+
} from 'yellowgrid-api-ts';
|
|
166
|
+
|
|
167
|
+
const configuration = new Configuration();
|
|
168
|
+
const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
169
|
+
|
|
170
|
+
let instanceId: string; //Instance ID (default to undefined)
|
|
171
|
+
|
|
172
|
+
const { status, data } = await apiInstance.getGetRecordingBackupStorage(
|
|
173
|
+
instanceId
|
|
174
|
+
);
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
|Name | Type | Description | Notes|
|
|
180
|
+
|------------- | ------------- | ------------- | -------------|
|
|
181
|
+
| **instanceId** | [**string**] | Instance ID | defaults to undefined|
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### Return type
|
|
185
|
+
|
|
186
|
+
**RecordingBackupAzureModel**
|
|
187
|
+
|
|
188
|
+
### Authorization
|
|
189
|
+
|
|
190
|
+
No authorization required
|
|
191
|
+
|
|
192
|
+
### HTTP request headers
|
|
193
|
+
|
|
194
|
+
- **Content-Type**: Not defined
|
|
195
|
+
- **Accept**: application/json
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
### HTTP response details
|
|
199
|
+
| Status code | Description | Response headers |
|
|
200
|
+
|-------------|-------------|------------------|
|
|
201
|
+
|**200** | Recordings Backup Storage | - |
|
|
202
|
+
|**400** | Bad Request | - |
|
|
203
|
+
|**401** | Unauthorised | - |
|
|
204
|
+
|**403** | Access Denied | - |
|
|
205
|
+
|
|
206
|
+
[[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)
|
|
207
|
+
|
|
153
208
|
# **patchChangeInstanceOwner**
|
|
154
209
|
> patchChangeInstanceOwner()
|
|
155
210
|
|
|
@@ -6,6 +6,7 @@ Credit Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**domains** | **Array<string>** | Contact Email Domains | [optional] [default to undefined]
|
|
9
10
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
11
|
**name** | **string** | Contact Name | [optional] [default to undefined]
|
|
11
12
|
**email** | **string** | Email | [optional] [default to undefined]
|
|
@@ -36,6 +37,7 @@ Name | Type | Description | Notes
|
|
|
36
37
|
import { CreditAccountEntity } from 'yellowgrid-api-ts';
|
|
37
38
|
|
|
38
39
|
const instance: CreditAccountEntity = {
|
|
40
|
+
domains,
|
|
39
41
|
id,
|
|
40
42
|
name,
|
|
41
43
|
email,
|
|
@@ -6,6 +6,7 @@ Customer Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**domains** | **Array<string>** | Contact Email Domains | [optional] [default to undefined]
|
|
9
10
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
11
|
**name** | **string** | Contact Name | [optional] [default to undefined]
|
|
11
12
|
**email** | **string** | Email | [optional] [default to undefined]
|
|
@@ -38,6 +39,7 @@ Name | Type | Description | Notes
|
|
|
38
39
|
import { PortalAccountModel } from 'yellowgrid-api-ts';
|
|
39
40
|
|
|
40
41
|
const instance: PortalAccountModel = {
|
|
42
|
+
domains,
|
|
41
43
|
id,
|
|
42
44
|
name,
|
|
43
45
|
email,
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# TableHistoryEntity
|
|
2
|
+
|
|
3
|
+
TableAttribsEntity
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**ownerId** | **string** | ownerId | [optional] [default to undefined]
|
|
10
|
+
**dbTable** | **string** | table | [optional] [default to undefined]
|
|
11
|
+
**orderingField** | **string** | orderingField | [optional] [default to undefined]
|
|
12
|
+
**asc** | **number** | asc | [optional] [default to undefined]
|
|
13
|
+
**perPage** | **number** | perPage | [optional] [default to undefined]
|
|
14
|
+
**currPage** | **number** | currPage | [optional] [default to undefined]
|
|
15
|
+
**filter** | **string** | filter | [optional] [default to undefined]
|
|
16
|
+
**page** | **number** | page | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { TableHistoryEntity } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: TableHistoryEntity = {
|
|
24
|
+
ownerId,
|
|
25
|
+
dbTable,
|
|
26
|
+
orderingField,
|
|
27
|
+
asc,
|
|
28
|
+
perPage,
|
|
29
|
+
currPage,
|
|
30
|
+
filter,
|
|
31
|
+
page,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -2,27 +2,27 @@ export const HostingPriceListEnum = {
|
|
|
2
2
|
"HOSTING_ONLY": {
|
|
3
3
|
"name": "HOSTING_ONLY",
|
|
4
4
|
"value": 1,
|
|
5
|
-
"publicValue": "
|
|
5
|
+
"publicValue": "Hosting Only"
|
|
6
6
|
},
|
|
7
7
|
"HOSTING_ONLY_BESPOKE": {
|
|
8
8
|
"name": "HOSTING_ONLY_BESPOKE",
|
|
9
9
|
"value": 2,
|
|
10
|
-
"publicValue": "
|
|
10
|
+
"publicValue": "Hosting Only (Bespoke)"
|
|
11
11
|
},
|
|
12
12
|
"HOSTING_AND_SUPPORT": {
|
|
13
13
|
"name": "HOSTING_AND_SUPPORT",
|
|
14
14
|
"value": 3,
|
|
15
|
-
"publicValue": "
|
|
15
|
+
"publicValue": "Hosting & Support"
|
|
16
16
|
},
|
|
17
17
|
"HOSTING_AND_SUPPORT_BESPOKE": {
|
|
18
18
|
"name": "HOSTING_AND_SUPPORT_BESPOKE",
|
|
19
19
|
"value": 4,
|
|
20
|
-
"publicValue": "
|
|
20
|
+
"publicValue": "Hosting & Support (Bespoke)"
|
|
21
21
|
},
|
|
22
22
|
"END_USER": {
|
|
23
23
|
"name": "END_USER",
|
|
24
24
|
"value": 5,
|
|
25
|
-
"publicValue": "
|
|
25
|
+
"publicValue": "End User"
|
|
26
26
|
}
|
|
27
27
|
} as const;
|
|
28
28
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export const PaymentMethodEnum = {
|
|
2
|
+
"CARD": {
|
|
3
|
+
"name": "CARD",
|
|
4
|
+
"value": "card",
|
|
5
|
+
"publicValue": "card"
|
|
6
|
+
},
|
|
7
|
+
"BACS": {
|
|
8
|
+
"name": "BACS",
|
|
9
|
+
"value": "bacs",
|
|
10
|
+
"publicValue": "bacs"
|
|
11
|
+
}
|
|
12
|
+
} as const;
|
|
13
|
+
|
|
14
|
+
export type PaymentMethodEnum = typeof PaymentMethodEnum;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export const UserGroupEnum = {
|
|
2
|
+
"ALL": {
|
|
3
|
+
"name": "ALL",
|
|
4
|
+
"value": "All",
|
|
5
|
+
"publicValue": "All"
|
|
6
|
+
},
|
|
7
|
+
"STANDARD": {
|
|
8
|
+
"name": "STANDARD",
|
|
9
|
+
"value": "Standard",
|
|
10
|
+
"publicValue": "Standard"
|
|
11
|
+
},
|
|
12
|
+
"TECHNICAL": {
|
|
13
|
+
"name": "TECHNICAL",
|
|
14
|
+
"value": "Technical",
|
|
15
|
+
"publicValue": "Technical"
|
|
16
|
+
},
|
|
17
|
+
"PRIVILEGED": {
|
|
18
|
+
"name": "PRIVILEGED",
|
|
19
|
+
"value": "Privileged",
|
|
20
|
+
"publicValue": "Privileged"
|
|
21
|
+
},
|
|
22
|
+
"DEVELOPMENT": {
|
|
23
|
+
"name": "DEVELOPMENT",
|
|
24
|
+
"value": "Development",
|
|
25
|
+
"publicValue": "Development"
|
|
26
|
+
}
|
|
27
|
+
} as const;
|
|
28
|
+
|
|
29
|
+
export type UserGroupEnum = typeof UserGroupEnum;
|