yellowgrid-api-ts 3.2.172-dev.0 → 3.2.172
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 +293 -292
- package/.openapi-generator/VERSION +1 -1
- package/README.md +6 -3
- package/api.ts +827 -5555
- package/base.ts +2 -26
- package/common.ts +16 -39
- package/config.json +3 -3
- package/configuration.ts +27 -21
- package/dist/api.d.ts +203 -4899
- package/dist/api.js +744 -749
- package/dist/base.d.ts +1 -25
- package/dist/base.js +2 -21
- package/dist/common.d.ts +5 -36
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +4 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/CourierEnum.d.ts +5 -0
- package/dist/models/CourierEnum.js +5 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountFinanceDTO.md +2 -0
- package/docs/AccountsApi.md +117 -1
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/BillingApi.md +66 -1
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CrmActivityDTO.md +1 -1
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedItemRequestDTO.md +0 -2
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +1 -1
- package/docs/PartnerDTO.md +2 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductSummaryDTO.md +2 -4
- package/docs/ProductsApi.md +11 -11
- package/docs/ProspectDTO.md +2 -2
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/{PatchSetTcxWizardCnameRequest.md → PutTransferConnectionRequest.md} +5 -5
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/models/CourierEnum.ts +5 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/dist/models/GroupEnum.d.ts +0 -43
- package/dist/models/GroupEnum.js +0 -45
- package/docs/AbstractItemDiscountModel.md +0 -21
- package/docs/NumberPortModel.md +0 -51
- package/docs/PostAddAdminNoteRequest.md +0 -20
- package/docs/PostGetProductRequest.md +0 -24
- package/docs/ProductSearchDTO.md +0 -37
- package/docs/TcxInstallationDetailsModel.md +0 -45
- package/docs/TelephonySupportTicketModel.md +0 -41
- package/hs_err_pid16044.log +0 -249
- package/hs_err_pid44560.log +0 -249
- package/hs_err_pid53988.log +0 -249
- package/hs_err_pid58728.log +0 -40
- package/models/GroupEnum.ts +0 -44
package/docs/AccountsApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AccountsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -21,6 +21,8 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
21
21
|
|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
|
|
22
22
|
|[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
|
|
23
23
|
|[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
|
|
24
|
+
|[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
|
|
25
|
+
|[**patchSetOnHold**](#patchsetonhold) | **PATCH** /admin/accounts/{id}/onHold/{state} | |
|
|
24
26
|
|[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
|
|
25
27
|
|[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
|
|
26
28
|
|[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
|
|
@@ -943,6 +945,120 @@ No authorization required
|
|
|
943
945
|
|
|
944
946
|
[[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)
|
|
945
947
|
|
|
948
|
+
# **patchSetAccountStatus**
|
|
949
|
+
> patchSetAccountStatus()
|
|
950
|
+
|
|
951
|
+
Set Account Statuss
|
|
952
|
+
|
|
953
|
+
### Example
|
|
954
|
+
|
|
955
|
+
```typescript
|
|
956
|
+
import {
|
|
957
|
+
AccountsApi,
|
|
958
|
+
Configuration
|
|
959
|
+
} from 'yellowgrid-api-ts';
|
|
960
|
+
|
|
961
|
+
const configuration = new Configuration();
|
|
962
|
+
const apiInstance = new AccountsApi(configuration);
|
|
963
|
+
|
|
964
|
+
let id: string; //Xero ID (default to undefined)
|
|
965
|
+
let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
|
|
966
|
+
|
|
967
|
+
const { status, data } = await apiInstance.patchSetAccountStatus(
|
|
968
|
+
id,
|
|
969
|
+
state
|
|
970
|
+
);
|
|
971
|
+
```
|
|
972
|
+
|
|
973
|
+
### Parameters
|
|
974
|
+
|
|
975
|
+
|Name | Type | Description | Notes|
|
|
976
|
+
|------------- | ------------- | ------------- | -------------|
|
|
977
|
+
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
978
|
+
| **state** | [**'enable' | 'disable'**]**Array<'enable' | 'disable'>** | Portal Access State | defaults to undefined|
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
### Return type
|
|
982
|
+
|
|
983
|
+
void (empty response body)
|
|
984
|
+
|
|
985
|
+
### Authorization
|
|
986
|
+
|
|
987
|
+
No authorization required
|
|
988
|
+
|
|
989
|
+
### HTTP request headers
|
|
990
|
+
|
|
991
|
+
- **Content-Type**: Not defined
|
|
992
|
+
- **Accept**: Not defined
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
### HTTP response details
|
|
996
|
+
| Status code | Description | Response headers |
|
|
997
|
+
|-------------|-------------|------------------|
|
|
998
|
+
|**204** | No Response | - |
|
|
999
|
+
|**400** | Bad Request | - |
|
|
1000
|
+
|**401** | Unauthorised | - |
|
|
1001
|
+
|**403** | Access Denied | - |
|
|
1002
|
+
|
|
1003
|
+
[[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)
|
|
1004
|
+
|
|
1005
|
+
# **patchSetOnHold**
|
|
1006
|
+
> AccountFinanceDTO patchSetOnHold()
|
|
1007
|
+
|
|
1008
|
+
Set Account On Hold
|
|
1009
|
+
|
|
1010
|
+
### Example
|
|
1011
|
+
|
|
1012
|
+
```typescript
|
|
1013
|
+
import {
|
|
1014
|
+
AccountsApi,
|
|
1015
|
+
Configuration
|
|
1016
|
+
} from 'yellowgrid-api-ts';
|
|
1017
|
+
|
|
1018
|
+
const configuration = new Configuration();
|
|
1019
|
+
const apiInstance = new AccountsApi(configuration);
|
|
1020
|
+
|
|
1021
|
+
let id: string; //Xero ID (default to undefined)
|
|
1022
|
+
let state: 'enable' | 'disable'; //On Hold State (default to undefined)
|
|
1023
|
+
|
|
1024
|
+
const { status, data } = await apiInstance.patchSetOnHold(
|
|
1025
|
+
id,
|
|
1026
|
+
state
|
|
1027
|
+
);
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
### Parameters
|
|
1031
|
+
|
|
1032
|
+
|Name | Type | Description | Notes|
|
|
1033
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1034
|
+
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1035
|
+
| **state** | [**'enable' | 'disable'**]**Array<'enable' | 'disable'>** | On Hold State | defaults to undefined|
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
### Return type
|
|
1039
|
+
|
|
1040
|
+
**AccountFinanceDTO**
|
|
1041
|
+
|
|
1042
|
+
### Authorization
|
|
1043
|
+
|
|
1044
|
+
No authorization required
|
|
1045
|
+
|
|
1046
|
+
### HTTP request headers
|
|
1047
|
+
|
|
1048
|
+
- **Content-Type**: Not defined
|
|
1049
|
+
- **Accept**: application/json
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
### HTTP response details
|
|
1053
|
+
| Status code | Description | Response headers |
|
|
1054
|
+
|-------------|-------------|------------------|
|
|
1055
|
+
|**200** | Accounts Finance Details | - |
|
|
1056
|
+
|**400** | Bad Request | - |
|
|
1057
|
+
|**401** | Unauthorised | - |
|
|
1058
|
+
|**403** | Access Denied | - |
|
|
1059
|
+
|
|
1060
|
+
[[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)
|
|
1061
|
+
|
|
946
1062
|
# **patchSetPortalAccess**
|
|
947
1063
|
> patchSetPortalAccess()
|
|
948
1064
|
|
|
@@ -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]
|
package/docs/BillingApi.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# BillingApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
|
|
8
|
+
|[**putTransferConnection**](#puttransferconnection) | **PUT** /billing/admin/connections | |
|
|
8
9
|
|
|
9
10
|
# **getGetAllCustomer**
|
|
10
11
|
> { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
|
|
@@ -53,3 +54,67 @@ No authorization required
|
|
|
53
54
|
|
|
54
55
|
[[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)
|
|
55
56
|
|
|
57
|
+
# **putTransferConnection**
|
|
58
|
+
> object putTransferConnection(putTransferConnectionRequest)
|
|
59
|
+
|
|
60
|
+
Transfer Billing Connection
|
|
61
|
+
|
|
62
|
+
### Example
|
|
63
|
+
|
|
64
|
+
```typescript
|
|
65
|
+
import {
|
|
66
|
+
BillingApi,
|
|
67
|
+
Configuration,
|
|
68
|
+
PutTransferConnectionRequest
|
|
69
|
+
} from 'yellowgrid-api-ts';
|
|
70
|
+
|
|
71
|
+
const configuration = new Configuration();
|
|
72
|
+
const apiInstance = new BillingApi(configuration);
|
|
73
|
+
|
|
74
|
+
let putTransferConnectionRequest: PutTransferConnectionRequest; //Transfer Request
|
|
75
|
+
let id: number; //Connection ID (optional) (default to undefined)
|
|
76
|
+
let cli: string; //CLI (optional) (default to undefined)
|
|
77
|
+
let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
|
|
78
|
+
|
|
79
|
+
const { status, data } = await apiInstance.putTransferConnection(
|
|
80
|
+
putTransferConnectionRequest,
|
|
81
|
+
id,
|
|
82
|
+
cli,
|
|
83
|
+
skipDDis
|
|
84
|
+
);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
|Name | Type | Description | Notes|
|
|
90
|
+
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **putTransferConnectionRequest** | **PutTransferConnectionRequest**| Transfer Request | |
|
|
92
|
+
| **id** | [**number**] | Connection ID | (optional) defaults to undefined|
|
|
93
|
+
| **cli** | [**string**] | CLI | (optional) defaults to undefined|
|
|
94
|
+
| **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
**object**
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
No authorization required
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: application/json
|
|
108
|
+
- **Accept**: application/json
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### HTTP response details
|
|
112
|
+
| Status code | Description | Response headers |
|
|
113
|
+
|-------------|-------------|------------------|
|
|
114
|
+
|**200** | Billing Connection | - |
|
|
115
|
+
|**400** | Bad Request | - |
|
|
116
|
+
|**401** | Unauthorised | - |
|
|
117
|
+
|**403** | Access Denied | - |
|
|
118
|
+
|
|
119
|
+
[[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)
|
|
120
|
+
|
package/docs/CRMApi.md
CHANGED
package/docs/Class3CXApi.md
CHANGED
package/docs/CrmActivityDTO.md
CHANGED
|
@@ -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
|
|
@@ -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
|
|
|
@@ -18,7 +18,6 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
|
|
19
19
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
20
20
|
**itemPrice** | **number** | Price (£) | [optional] [default to undefined]
|
|
21
|
-
**customPrice** | **number** | Custom Price (£) | [optional] [default to undefined]
|
|
22
21
|
**additionalDiscount** | **number** | Additional Discount | [optional] [default to undefined]
|
|
23
22
|
|
|
24
23
|
## Example
|
|
@@ -39,7 +38,6 @@ const instance: DetailedItemRequestDTO = {
|
|
|
39
38
|
readOnly,
|
|
40
39
|
title,
|
|
41
40
|
itemPrice,
|
|
42
|
-
customPrice,
|
|
43
41
|
additionalDiscount,
|
|
44
42
|
};
|
|
45
43
|
```
|
|
@@ -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
|
|
package/docs/MyPBXToolsApi.md
CHANGED
package/docs/NumberPortingApi.md
CHANGED
package/docs/OAuth20Api.md
CHANGED
package/docs/OrdersApi.md
CHANGED
package/docs/PartnerDTO.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
|
|
17
17
|
**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
|
|
18
18
|
**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
|
|
19
|
+
**aligned** | **boolean** | Aligned | [optional] [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -33,6 +34,7 @@ const instance: PartnerDTO = {
|
|
|
33
34
|
hostingDisountPercent,
|
|
34
35
|
hostingPriceListId,
|
|
35
36
|
installationUrl,
|
|
37
|
+
aligned,
|
|
36
38
|
};
|
|
37
39
|
```
|
|
38
40
|
|
package/docs/PricingApi.md
CHANGED
|
@@ -10,13 +10,12 @@ 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
|
-
**discounts** | [**Array<AbstractItemDiscountModel>**](AbstractItemDiscountModel.md) | Applied Discounts | [optional] [default to undefined]
|
|
20
19
|
|
|
21
20
|
## Example
|
|
22
21
|
|
|
@@ -34,7 +33,6 @@ const instance: ProductSummaryDTO = {
|
|
|
34
33
|
rrp,
|
|
35
34
|
licenceDetails,
|
|
36
35
|
hosting,
|
|
37
|
-
discounts,
|
|
38
36
|
};
|
|
39
37
|
```
|
|
40
38
|
|
package/docs/ProductsApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ProductsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -422,7 +422,7 @@ No authorization required
|
|
|
422
422
|
[[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)
|
|
423
423
|
|
|
424
424
|
# **postGetProduct**
|
|
425
|
-
> ProductSummaryDTO postGetProduct()
|
|
425
|
+
> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
|
|
426
426
|
|
|
427
427
|
Get Product
|
|
428
428
|
|
|
@@ -432,18 +432,18 @@ Get Product
|
|
|
432
432
|
import {
|
|
433
433
|
ProductsApi,
|
|
434
434
|
Configuration,
|
|
435
|
-
|
|
435
|
+
PostGetProductForCustomerRequest
|
|
436
436
|
} from 'yellowgrid-api-ts';
|
|
437
437
|
|
|
438
438
|
const configuration = new Configuration();
|
|
439
439
|
const apiInstance = new ProductsApi(configuration);
|
|
440
440
|
|
|
441
441
|
let sku: string; //Product SKU (default to undefined)
|
|
442
|
-
let
|
|
442
|
+
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
443
443
|
|
|
444
444
|
const { status, data } = await apiInstance.postGetProduct(
|
|
445
445
|
sku,
|
|
446
|
-
|
|
446
|
+
postGetProductForCustomerRequest
|
|
447
447
|
);
|
|
448
448
|
```
|
|
449
449
|
|
|
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.postGetProduct(
|
|
|
451
451
|
|
|
452
452
|
|Name | Type | Description | Notes|
|
|
453
453
|
|------------- | ------------- | ------------- | -------------|
|
|
454
|
-
| **
|
|
454
|
+
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
455
455
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
456
456
|
|
|
457
457
|
|
|
@@ -480,7 +480,7 @@ No authorization required
|
|
|
480
480
|
[[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)
|
|
481
481
|
|
|
482
482
|
# **postGetProductForCustomer**
|
|
483
|
-
> ProductSummaryDTO postGetProductForCustomer()
|
|
483
|
+
> ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
|
|
484
484
|
|
|
485
485
|
Get Product For Customer
|
|
486
486
|
|
|
@@ -490,7 +490,7 @@ Get Product For Customer
|
|
|
490
490
|
import {
|
|
491
491
|
ProductsApi,
|
|
492
492
|
Configuration,
|
|
493
|
-
|
|
493
|
+
PostGetProductForCustomerRequest
|
|
494
494
|
} from 'yellowgrid-api-ts';
|
|
495
495
|
|
|
496
496
|
const configuration = new Configuration();
|
|
@@ -498,12 +498,12 @@ const apiInstance = new ProductsApi(configuration);
|
|
|
498
498
|
|
|
499
499
|
let customerId: number; //Customer ID (default to undefined)
|
|
500
500
|
let sku: string; //Product SKU (default to undefined)
|
|
501
|
-
let
|
|
501
|
+
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
502
502
|
|
|
503
503
|
const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
504
504
|
customerId,
|
|
505
505
|
sku,
|
|
506
|
-
|
|
506
|
+
postGetProductForCustomerRequest
|
|
507
507
|
);
|
|
508
508
|
```
|
|
509
509
|
|
|
@@ -511,7 +511,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
|
511
511
|
|
|
512
512
|
|Name | Type | Description | Notes|
|
|
513
513
|
|------------- | ------------- | ------------- | -------------|
|
|
514
|
-
| **
|
|
514
|
+
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
515
515
|
| **customerId** | [**number**] | Customer ID | defaults to undefined|
|
|
516
516
|
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
517
517
|
|
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]
|
package/docs/ProspectsApi.md
CHANGED
package/docs/ProvisioningApi.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PutTransferConnectionRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { PutTransferConnectionRequest } from 'yellowgrid-api-ts';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
15
|
+
const instance: PutTransferConnectionRequest = {
|
|
16
|
+
customerId,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -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
|
|
package/docs/SIPTrunksApi.md
CHANGED
package/docs/SMSApi.md
CHANGED
package/docs/ServicesApi.md
CHANGED
|
@@ -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/ShippingApi.md
CHANGED