yellowgrid-api-ts 3.2.161-dev.0 → 3.2.162-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 +2 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +2 -0
- package/api.ts +351 -253
- package/configuration.ts +2 -2
- package/dist/api.d.ts +80 -15
- package/dist/api.js +309 -238
- package/dist/configuration.js +2 -2
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +48 -0
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/CreditAccountEntity.md +0 -2
- package/docs/{CrmActivityDto.md → CrmActivityDTO.md} +1 -1
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CustomerListAccountDTO.md +27 -0
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/PortalAccountModel.md +0 -2
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProspectDTO.md +2 -2
- package/docs/RecordingBackupAzureModel.md +2 -0
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/docs/AccountPageDetailsDTO.md +0 -41
- package/docs/PatchSendWelcomeEmailRequest.md +0 -20
- package/docs/PatchSetTcxWizardCnameRequest.md +0 -20
- package/docs/PostAddAdminNoteRequest.md +0 -20
- package/docs/PostCreateCrmNoteRequest.md +0 -20
- package/docs/PostGetProductRequest.md +0 -24
- package/docs/TcxInstallationDetailsModel.md +0 -45
- /package/docs/{CrmActivitiesResponseDto.md → CrmActivitiesResponseDTO.md} +0 -0
package/dist/configuration.js
CHANGED
|
@@ -49,8 +49,8 @@ var Configuration = /** @class */ (function () {
|
|
|
49
49
|
* @return True if the given MIME is JSON, false otherwise.
|
|
50
50
|
*/
|
|
51
51
|
Configuration.prototype.isJsonMime = function (mime) {
|
|
52
|
-
var jsonMime =
|
|
53
|
-
return mime !== null &&
|
|
52
|
+
var jsonMime = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
|
|
53
|
+
return mime !== null && jsonMime.test(mime);
|
|
54
54
|
};
|
|
55
55
|
return Configuration;
|
|
56
56
|
}());
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
|
package/docs/AccountsApi.md
CHANGED
|
@@ -15,6 +15,7 @@ All URIs are relative to *https://localhost*
|
|
|
15
15
|
|[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
|
|
16
16
|
|[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
|
|
17
17
|
|[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
|
|
18
|
+
|[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
|
|
18
19
|
|[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
|
|
19
20
|
|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
|
|
20
21
|
|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
|
|
@@ -639,6 +640,53 @@ No authorization required
|
|
|
639
640
|
|
|
640
641
|
[[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)
|
|
641
642
|
|
|
643
|
+
# **getGetCustomerAccountsList**
|
|
644
|
+
> Array<CustomerListAccountDTO> getGetCustomerAccountsList()
|
|
645
|
+
|
|
646
|
+
Get Customer Accounts List
|
|
647
|
+
|
|
648
|
+
### Example
|
|
649
|
+
|
|
650
|
+
```typescript
|
|
651
|
+
import {
|
|
652
|
+
AccountsApi,
|
|
653
|
+
Configuration
|
|
654
|
+
} from 'yellowgrid-api-ts';
|
|
655
|
+
|
|
656
|
+
const configuration = new Configuration();
|
|
657
|
+
const apiInstance = new AccountsApi(configuration);
|
|
658
|
+
|
|
659
|
+
const { status, data } = await apiInstance.getGetCustomerAccountsList();
|
|
660
|
+
```
|
|
661
|
+
|
|
662
|
+
### Parameters
|
|
663
|
+
This endpoint does not have any parameters.
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
### Return type
|
|
667
|
+
|
|
668
|
+
**Array<CustomerListAccountDTO>**
|
|
669
|
+
|
|
670
|
+
### Authorization
|
|
671
|
+
|
|
672
|
+
No authorization required
|
|
673
|
+
|
|
674
|
+
### HTTP request headers
|
|
675
|
+
|
|
676
|
+
- **Content-Type**: Not defined
|
|
677
|
+
- **Accept**: application/json
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
### HTTP response details
|
|
681
|
+
| Status code | Description | Response headers |
|
|
682
|
+
|-------------|-------------|------------------|
|
|
683
|
+
|**200** | Account Addresses | - |
|
|
684
|
+
|**400** | Bad Request | - |
|
|
685
|
+
|**401** | Unauthorised | - |
|
|
686
|
+
|**403** | Access Denied | - |
|
|
687
|
+
|
|
688
|
+
[[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)
|
|
689
|
+
|
|
642
690
|
# **getGetCustomerKeys**
|
|
643
691
|
> Array<TcxKeySummaryDTO> getGetCustomerKeys()
|
|
644
692
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
@@ -6,7 +6,6 @@ Credit Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**domains** | **Array<string>** | Contact Email Domains | [optional] [default to undefined]
|
|
10
9
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
11
10
|
**name** | **string** | Contact Name | [optional] [default to undefined]
|
|
12
11
|
**email** | **string** | Email | [optional] [default to undefined]
|
|
@@ -37,7 +36,6 @@ Name | Type | Description | Notes
|
|
|
37
36
|
import { CreditAccountEntity } from 'yellowgrid-api-ts';
|
|
38
37
|
|
|
39
38
|
const instance: CreditAccountEntity = {
|
|
40
|
-
domains,
|
|
41
39
|
id,
|
|
42
40
|
name,
|
|
43
41
|
email,
|
|
@@ -7,7 +7,7 @@ CRM Activity
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**type** | **string** | Activity Type | [optional] [default to undefined]
|
|
10
|
-
**timestamp** | **string** |
|
|
10
|
+
**timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | Activity Title | [optional] [default to undefined]
|
|
12
12
|
**description** | **string** | Activity Description | [optional] [default to undefined]
|
|
13
13
|
**url** | **string** | Activity URL | [optional] [default to undefined]
|
|
@@ -6,7 +6,7 @@ CRM Date Activities
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**date** | **string** | Date
|
|
9
|
+
**date** | **string** | Date | [optional] [default to undefined]
|
|
10
10
|
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# CustomerListAccountDTO
|
|
2
|
+
|
|
3
|
+
Customer List Account
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Xero ID | [optional] [default to undefined]
|
|
11
|
+
**company** | **string** | Xero ID | [optional] [default to undefined]
|
|
12
|
+
**domains** | **Array<string>** | Xero ID | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { CustomerListAccountDTO } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: CustomerListAccountDTO = {
|
|
20
|
+
id,
|
|
21
|
+
xeroId,
|
|
22
|
+
company,
|
|
23
|
+
domains,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
11
|
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
14
|
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
15
|
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
16
|
|
|
@@ -6,7 +6,6 @@ Customer Account
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**domains** | **Array<string>** | Contact Email Domains | [optional] [default to undefined]
|
|
10
9
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
11
10
|
**name** | **string** | Contact Name | [optional] [default to undefined]
|
|
12
11
|
**email** | **string** | Email | [optional] [default to undefined]
|
|
@@ -39,7 +38,6 @@ Name | Type | Description | Notes
|
|
|
39
38
|
import { PortalAccountModel } from 'yellowgrid-api-ts';
|
|
40
39
|
|
|
41
40
|
const instance: PortalAccountModel = {
|
|
42
|
-
domains,
|
|
43
41
|
id,
|
|
44
42
|
name,
|
|
45
43
|
email,
|
|
@@ -10,11 +10,11 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
11
11
|
**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
|
|
12
12
|
**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
|
|
13
|
-
**dueDate** | **string** | Date
|
|
13
|
+
**dueDate** | **string** | Due Date | [optional] [default to undefined]
|
|
14
14
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
15
15
|
**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
|
|
16
16
|
**rrp** | **number** | RRP Price | [optional] [default to undefined]
|
|
17
|
-
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |
|
|
17
|
+
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
|
|
18
18
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
package/docs/ProspectDTO.md
CHANGED
|
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**companyName** | **string** | Company Name | [optional] [default to undefined]
|
|
10
10
|
**telephone** | **string** | Telephone | [optional] [default to undefined]
|
|
11
|
-
**lastOrderDate** | **string** | Date
|
|
12
|
-
**callbackDate** | **string** | Date
|
|
11
|
+
**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
|
|
12
|
+
**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
|
|
13
13
|
**xeroId** | **string** | Xero ID | [optional] [default to undefined]
|
|
14
14
|
**removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
|
|
15
15
|
**status** | **string** | Status | [optional] [default to undefined]
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**name** | **string** | Storage Account Name | [optional] [default to undefined]
|
|
10
10
|
**key** | **string** | Storage Account Key | [optional] [default to undefined]
|
|
11
11
|
**connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
|
|
12
|
+
**sasUrl** | **string** | SAS Url | [optional] [default to undefined]
|
|
12
13
|
**recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -20,6 +21,7 @@ const instance: RecordingBackupAzureModel = {
|
|
|
20
21
|
name,
|
|
21
22
|
key,
|
|
22
23
|
connection_string,
|
|
24
|
+
sasUrl,
|
|
23
25
|
recordings_path,
|
|
24
26
|
};
|
|
25
27
|
```
|
|
@@ -6,8 +6,8 @@ Recordings Backup Info
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |
|
|
10
|
-
**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |
|
|
9
|
+
**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
|
|
10
|
+
**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -7,10 +7,10 @@ Shipment Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**courier** | **string** | Courier | [optional] [default to undefined]
|
|
10
|
-
**address** | [**AddressModel**](AddressModel.md) |
|
|
10
|
+
**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
|
|
11
11
|
**scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
|
|
12
12
|
**service** | **string** | Service | [optional] [default to undefined]
|
|
13
|
-
**shipDate** | **string** | Date
|
|
13
|
+
**shipDate** | **string** | Ship Date | [optional] [default to undefined]
|
|
14
14
|
**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
package/docs/TcxKeySummaryDTO.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
11
11
|
**sc** | **number** | Simultaneous Calls | [optional] [default to undefined]
|
|
12
12
|
**edition** | **string** | Edition | [optional] [default to undefined]
|
|
13
|
-
**expiry** | **string** | Date
|
|
13
|
+
**expiry** | **string** | Expiry Date | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/openapitools.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "yellowgrid-api-ts",
|
|
3
|
-
"version": "3.2.
|
|
3
|
+
"version": "3.2.162-dev.0",
|
|
4
4
|
"description": "OpenAPI client for yellowgrid-api-ts",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"repository": {
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"prepare": "npm run build"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"axios": "^1.
|
|
25
|
+
"axios": "^1.15.2"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@types/node": "12.11.5 - 12.20.42",
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
# AccountPageDetailsDTO
|
|
2
|
-
|
|
3
|
-
Account Page Details
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**xeroId** | **string** | Xero ID | [optional] [default to undefined]
|
|
10
|
-
**companyName** | **string** | Company | [optional] [default to undefined]
|
|
11
|
-
**billingAddress** | [**AddressDTO**](AddressDTO.md) | | [optional] [default to undefined]
|
|
12
|
-
**shippingAddress** | [**AddressDTO**](AddressDTO.md) | | [optional] [default to undefined]
|
|
13
|
-
**previousShippingAddreses** | [**Array<AddressDTO>**](AddressDTO.md) | Addresses | [optional] [default to undefined]
|
|
14
|
-
**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
|
|
15
|
-
**phone** | **string** | Phone | [optional] [default to undefined]
|
|
16
|
-
**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
|
|
17
|
-
**companyNumber** | **string** | Company Number | [optional] [default to undefined]
|
|
18
|
-
**cname** | **string** | CNAME | [optional] [default to undefined]
|
|
19
|
-
**prizesEnabled** | **boolean** | Prizes Enabled | [optional] [default to undefined]
|
|
20
|
-
|
|
21
|
-
## Example
|
|
22
|
-
|
|
23
|
-
```typescript
|
|
24
|
-
import { AccountPageDetailsDTO } from 'yellowgrid-api-ts';
|
|
25
|
-
|
|
26
|
-
const instance: AccountPageDetailsDTO = {
|
|
27
|
-
xeroId,
|
|
28
|
-
companyName,
|
|
29
|
-
billingAddress,
|
|
30
|
-
shippingAddress,
|
|
31
|
-
previousShippingAddreses,
|
|
32
|
-
portalAccess,
|
|
33
|
-
phone,
|
|
34
|
-
vatNumber,
|
|
35
|
-
companyNumber,
|
|
36
|
-
cname,
|
|
37
|
-
prizesEnabled,
|
|
38
|
-
};
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PatchSendWelcomeEmailRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**email** | **string** | email | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PatchSendWelcomeEmailRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PatchSendWelcomeEmailRequest = {
|
|
16
|
-
email,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PatchSetTcxWizardCnameRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**cname** | **string** | CNAME | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PatchSetTcxWizardCnameRequest = {
|
|
16
|
-
cname,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PostAddAdminNoteRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**note** | **string** | Note | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PostAddAdminNoteRequest = {
|
|
16
|
-
note,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PostCreateCrmNoteRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**note** | **string** | Note | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PostCreateCrmNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PostCreateCrmNoteRequest = {
|
|
16
|
-
note,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# PostGetProductRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
9
|
-
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
10
|
-
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { PostGetProductRequest } from 'yellowgrid-api-ts';
|
|
16
|
-
|
|
17
|
-
const instance: PostGetProductRequest = {
|
|
18
|
-
quantity,
|
|
19
|
-
licenceKey,
|
|
20
|
-
hosting,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
# TcxInstallationDetailsModel
|
|
2
|
-
|
|
3
|
-
3CX Installation Details
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
|
|
10
|
-
**instanceId** | **string** | Instance ID | [optional] [default to undefined]
|
|
11
|
-
**project** | **string** | Project ID | [optional] [default to undefined]
|
|
12
|
-
**privateKey** | [**GenericFileModel**](GenericFileModel.md) | | [optional] [default to undefined]
|
|
13
|
-
**rootPassword** | **string** | Root Password | [optional] [default to undefined]
|
|
14
|
-
**ownerExtension** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [optional] [default to undefined]
|
|
15
|
-
**adminEmail** | **string** | Admin Email | [optional] [default to undefined]
|
|
16
|
-
**url** | **string** | Console URL | [optional] [default to undefined]
|
|
17
|
-
**adminUsername** | **string** | Admin Username | [optional] [default to undefined]
|
|
18
|
-
**adminPassword** | **string** | Admin Password | [optional] [default to undefined]
|
|
19
|
-
**ftpHost** | **string** | Config Backup FTP Host | [optional] [default to undefined]
|
|
20
|
-
**ftpUsername** | **string** | Config Backup FTP Username | [optional] [default to undefined]
|
|
21
|
-
**ftpPassword** | **string** | Config Backup FTP Password | [optional] [default to undefined]
|
|
22
|
-
|
|
23
|
-
## Example
|
|
24
|
-
|
|
25
|
-
```typescript
|
|
26
|
-
import { TcxInstallationDetailsModel } from 'yellowgrid-api-ts';
|
|
27
|
-
|
|
28
|
-
const instance: TcxInstallationDetailsModel = {
|
|
29
|
-
ipAddress,
|
|
30
|
-
instanceId,
|
|
31
|
-
project,
|
|
32
|
-
privateKey,
|
|
33
|
-
rootPassword,
|
|
34
|
-
ownerExtension,
|
|
35
|
-
adminEmail,
|
|
36
|
-
url,
|
|
37
|
-
adminUsername,
|
|
38
|
-
adminPassword,
|
|
39
|
-
ftpHost,
|
|
40
|
-
ftpUsername,
|
|
41
|
-
ftpPassword,
|
|
42
|
-
};
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
File without changes
|