yellowgrid-api-ts 3.2.131-dev.0 → 3.2.131
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 +271 -266
- package/.openapi-generator/VERSION +1 -1
- package/README.md +9 -3
- package/api.ts +854 -5030
- 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 +305 -4454
- package/dist/api.js +686 -672
- 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/PaymentMethodEnum.d.ts +13 -0
- package/dist/models/PaymentMethodEnum.js +15 -0
- package/dist/models/ServiceEnum.d.ts +5 -0
- package/dist/models/ServiceEnum.js +5 -0
- package/dist/models/UserGroupEnum.d.ts +28 -0
- package/dist/models/UserGroupEnum.js +30 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminOrderRequestDTO.md +3 -1
- package/docs/AdminUserModel.md +4 -0
- package/docs/BillingApi.md +55 -0
- 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/CustomerItemRequestDTO.md +2 -0
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedItemRequestDTO.md +2 -0
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/ItemDTO.md +2 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +49 -1
- package/docs/OrderDTO.md +25 -0
- package/docs/OrderItemDTO.md +2 -0
- package/docs/OrderResponseDTO.md +25 -0
- package/docs/OrdersApi.md +57 -1
- package/docs/PostGetProductForCustomerRequest.md +2 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProductsApi.md +6 -6
- package/docs/ProspectDTO.md +2 -2
- package/docs/ProspectsApi.md +5 -5
- package/docs/ProvisioningApi.md +1 -1
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/SbcDTO.md +35 -0
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingAddressDTO.md +35 -0
- 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/PaymentMethodEnum.ts +14 -0
- package/models/ServiceEnum.ts +5 -0
- package/models/UserGroupEnum.ts +29 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/docs/NumberPortModel.md +0 -51
- package/docs/PostGetProductRequest.md +0 -24
- 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/docs/AdminUserModel.md
CHANGED
|
@@ -13,6 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**email** | **string** | Email | [optional] [default to undefined]
|
|
14
14
|
**primaryHex** | **string** | Primary Colour | [optional] [default to undefined]
|
|
15
15
|
**secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
|
|
16
|
+
**scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
|
|
17
|
+
**permissions** | **Array<string>** | Groups | [optional] [default to undefined]
|
|
16
18
|
|
|
17
19
|
## Example
|
|
18
20
|
|
|
@@ -27,6 +29,8 @@ const instance: AdminUserModel = {
|
|
|
27
29
|
email,
|
|
28
30
|
primaryHex,
|
|
29
31
|
secondaryHex,
|
|
32
|
+
scopes,
|
|
33
|
+
permissions,
|
|
30
34
|
};
|
|
31
35
|
```
|
|
32
36
|
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# BillingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
|
|
8
|
+
|
|
9
|
+
# **getGetAllCustomer**
|
|
10
|
+
> { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
|
|
11
|
+
|
|
12
|
+
Get Billing Customers
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
BillingApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new BillingApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.getGetAllCustomer();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
**{ [key: string]: { [key: string]: string; }; }**
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
No authorization required
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: application/json
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | Billing Customer List | - |
|
|
50
|
+
|**400** | Bad Request | - |
|
|
51
|
+
|**401** | Unauthorised | - |
|
|
52
|
+
|**403** | Access Denied | - |
|
|
53
|
+
|
|
54
|
+
[[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
|
+
|
package/docs/CRMApi.md
CHANGED
package/docs/Class3CXApi.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
12
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
14
|
+
**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
|
|
14
15
|
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
15
16
|
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
16
17
|
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
|
|
@@ -27,6 +28,7 @@ const instance: CustomerItemRequestDTO = {
|
|
|
27
28
|
id,
|
|
28
29
|
licenceKey,
|
|
29
30
|
hosting,
|
|
31
|
+
renewalYears,
|
|
30
32
|
processDate,
|
|
31
33
|
tcxSalesCode,
|
|
32
34
|
sbcs,
|
|
@@ -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
|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
12
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
14
|
+
**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
|
|
14
15
|
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
15
16
|
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
16
17
|
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
|
|
@@ -30,6 +31,7 @@ const instance: DetailedItemRequestDTO = {
|
|
|
30
31
|
id,
|
|
31
32
|
licenceKey,
|
|
32
33
|
hosting,
|
|
34
|
+
renewalYears,
|
|
33
35
|
processDate,
|
|
34
36
|
tcxSalesCode,
|
|
35
37
|
sbcs,
|
|
@@ -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/ItemDTO.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
|
|
17
17
|
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
18
18
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
19
|
+
**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
|
|
19
20
|
**promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
|
|
20
21
|
**refunded** | **number** | Refunded | [optional] [default to undefined]
|
|
21
22
|
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
|
|
@@ -38,6 +39,7 @@ const instance: ItemDTO = {
|
|
|
38
39
|
licenceExpiry,
|
|
39
40
|
processDate,
|
|
40
41
|
hosting,
|
|
42
|
+
renewalYears,
|
|
41
43
|
promoItem,
|
|
42
44
|
refunded,
|
|
43
45
|
sbcs,
|
package/docs/MyPBXToolsApi.md
CHANGED
package/docs/NumberPortingApi.md
CHANGED
package/docs/OAuth20Api.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OAuth20Api
|
|
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
|
|------------- | ------------- | -------------|
|
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
9
9
|
|[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
|
|
10
10
|
|[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
|
|
11
11
|
|[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
|
|
12
|
+
|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
|
|
12
13
|
|[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
|
|
13
14
|
|
|
14
15
|
# **getGetMfaQrCode**
|
|
@@ -311,6 +312,53 @@ No authorization required
|
|
|
311
312
|
|
|
312
313
|
[[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)
|
|
313
314
|
|
|
315
|
+
# **postLogout**
|
|
316
|
+
> postLogout()
|
|
317
|
+
|
|
318
|
+
Remove Oauth 2.0 Cookies
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
import {
|
|
324
|
+
OAuth20Api,
|
|
325
|
+
Configuration
|
|
326
|
+
} from 'yellowgrid-api-ts';
|
|
327
|
+
|
|
328
|
+
const configuration = new Configuration();
|
|
329
|
+
const apiInstance = new OAuth20Api(configuration);
|
|
330
|
+
|
|
331
|
+
const { status, data } = await apiInstance.postLogout();
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
### Parameters
|
|
335
|
+
This endpoint does not have any parameters.
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
### Return type
|
|
339
|
+
|
|
340
|
+
void (empty response body)
|
|
341
|
+
|
|
342
|
+
### Authorization
|
|
343
|
+
|
|
344
|
+
No authorization required
|
|
345
|
+
|
|
346
|
+
### HTTP request headers
|
|
347
|
+
|
|
348
|
+
- **Content-Type**: Not defined
|
|
349
|
+
- **Accept**: Not defined
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
### HTTP response details
|
|
353
|
+
| Status code | Description | Response headers |
|
|
354
|
+
|-------------|-------------|------------------|
|
|
355
|
+
|**200** | No Response | - |
|
|
356
|
+
|**400** | Bad Request | - |
|
|
357
|
+
|**401** | Unauthorised | - |
|
|
358
|
+
|**403** | Access Denied | - |
|
|
359
|
+
|
|
360
|
+
[[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)
|
|
361
|
+
|
|
314
362
|
# **postPortalLogin**
|
|
315
363
|
> AuthCodeResponseModel postPortalLogin()
|
|
316
364
|
|
package/docs/OrderDTO.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrderDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal Order
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [optional] [default to undefined]
|
|
10
|
+
**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) | | [optional] [default to undefined]
|
|
11
|
+
**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OrderDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: OrderDTO = {
|
|
19
|
+
basket,
|
|
20
|
+
shippingAddress,
|
|
21
|
+
orderDetails,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OrderItemDTO.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
|
|
17
17
|
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
18
18
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
19
|
+
**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
|
|
19
20
|
**promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
|
|
20
21
|
**refunded** | **number** | Refunded | [optional] [default to undefined]
|
|
21
22
|
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
|
|
@@ -41,6 +42,7 @@ const instance: OrderItemDTO = {
|
|
|
41
42
|
licenceExpiry,
|
|
42
43
|
processDate,
|
|
43
44
|
hosting,
|
|
45
|
+
renewalYears,
|
|
44
46
|
promoItem,
|
|
45
47
|
refunded,
|
|
46
48
|
sbcs,
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrderResponseDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
10
|
+
**orderID** | **string** | Order ID | [optional] [default to undefined]
|
|
11
|
+
**uniqueID** | **string** | Unique ID | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OrderResponseDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: OrderResponseDTO = {
|
|
19
|
+
url,
|
|
20
|
+
orderID,
|
|
21
|
+
uniqueID,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OrdersApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OrdersApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
@@ -19,6 +19,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
19
19
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
20
20
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
21
21
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
22
|
+
|[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
|
|
22
23
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
23
24
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
24
25
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
@@ -896,6 +897,61 @@ No authorization required
|
|
|
896
897
|
|
|
897
898
|
[[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)
|
|
898
899
|
|
|
900
|
+
# **postCreatePortalOrderLegacy**
|
|
901
|
+
> OrderResponseDTO postCreatePortalOrderLegacy()
|
|
902
|
+
|
|
903
|
+
Create an order via the legacy portal
|
|
904
|
+
|
|
905
|
+
### Example
|
|
906
|
+
|
|
907
|
+
```typescript
|
|
908
|
+
import {
|
|
909
|
+
OrdersApi,
|
|
910
|
+
Configuration,
|
|
911
|
+
OrderDTO
|
|
912
|
+
} from 'yellowgrid-api-ts';
|
|
913
|
+
|
|
914
|
+
const configuration = new Configuration();
|
|
915
|
+
const apiInstance = new OrdersApi(configuration);
|
|
916
|
+
|
|
917
|
+
let orderDTO: OrderDTO; //Legacy Portal Order (optional)
|
|
918
|
+
|
|
919
|
+
const { status, data } = await apiInstance.postCreatePortalOrderLegacy(
|
|
920
|
+
orderDTO
|
|
921
|
+
);
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### Parameters
|
|
925
|
+
|
|
926
|
+
|Name | Type | Description | Notes|
|
|
927
|
+
|------------- | ------------- | ------------- | -------------|
|
|
928
|
+
| **orderDTO** | **OrderDTO**| Legacy Portal Order | |
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
### Return type
|
|
932
|
+
|
|
933
|
+
**OrderResponseDTO**
|
|
934
|
+
|
|
935
|
+
### Authorization
|
|
936
|
+
|
|
937
|
+
No authorization required
|
|
938
|
+
|
|
939
|
+
### HTTP request headers
|
|
940
|
+
|
|
941
|
+
- **Content-Type**: application/json
|
|
942
|
+
- **Accept**: application/json
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
### HTTP response details
|
|
946
|
+
| Status code | Description | Response headers |
|
|
947
|
+
|-------------|-------------|------------------|
|
|
948
|
+
|**200** | Legacy Portal Order Response | - |
|
|
949
|
+
|**400** | Bad Request | - |
|
|
950
|
+
|**401** | Unauthorised | - |
|
|
951
|
+
|**403** | Access Denied | - |
|
|
952
|
+
|
|
953
|
+
[[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)
|
|
954
|
+
|
|
899
955
|
# **postCreateShipment**
|
|
900
956
|
> ShipmentDTO postCreateShipment()
|
|
901
957
|
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
10
10
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
11
11
|
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
12
|
+
**renewalYears** | **number** | 3CX Renewal Years (Upgrade Only) | [optional] [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,6 +21,7 @@ const instance: PostGetProductForCustomerRequest = {
|
|
|
20
21
|
licenceKey,
|
|
21
22
|
hosting,
|
|
22
23
|
tcxSalesCode,
|
|
24
|
+
renewalYears,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
25
27
|
|
package/docs/PricingApi.md
CHANGED
|
@@ -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/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
|
|
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
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# ProspectsApi
|
|
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
|
|[**getGetProspect**](#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect|
|
|
8
8
|
|[**getGetProspects**](#getgetprospects) | **GET** /accounts/prospects | Get Prospects|
|
|
9
9
|
|[**getRemoveFromProspects**](#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects|
|
|
10
|
-
|[**getSetCallback**](#getsetcallback) | **GET** /accounts/prospects/{xero_id}/
|
|
10
|
+
|[**getSetCallback**](#getsetcallback) | **GET** /accounts/prospects/{xero_id}/date | Set Call Back Date|
|
|
11
11
|
|
|
12
12
|
# **getGetProspect**
|
|
13
13
|
> ProspectDTO getGetProspect()
|
|
@@ -184,11 +184,11 @@ const configuration = new Configuration();
|
|
|
184
184
|
const apiInstance = new ProspectsApi(configuration);
|
|
185
185
|
|
|
186
186
|
let xeroId: string; //Xero ID (default to undefined)
|
|
187
|
-
let
|
|
187
|
+
let date: string; //Callback Date (default to undefined)
|
|
188
188
|
|
|
189
189
|
const { status, data } = await apiInstance.getSetCallback(
|
|
190
190
|
xeroId,
|
|
191
|
-
|
|
191
|
+
date
|
|
192
192
|
);
|
|
193
193
|
```
|
|
194
194
|
|
|
@@ -197,7 +197,7 @@ const { status, data } = await apiInstance.getSetCallback(
|
|
|
197
197
|
|Name | Type | Description | Notes|
|
|
198
198
|
|------------- | ------------- | ------------- | -------------|
|
|
199
199
|
| **xeroId** | [**string**] | Xero ID | defaults to undefined|
|
|
200
|
-
| **
|
|
200
|
+
| **date** | [**string**] | Callback Date | defaults to undefined|
|
|
201
201
|
|
|
202
202
|
|
|
203
203
|
### Return type
|
package/docs/ProvisioningApi.md
CHANGED
|
@@ -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/SbcDTO.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# SbcDTO
|
|
2
|
+
|
|
3
|
+
Legacy Portal SBC
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**noConfig** | **boolean** | No Config | [optional] [default to undefined]
|
|
10
|
+
**dhcp** | **boolean** | DHCP | [optional] [default to undefined]
|
|
11
|
+
**url** | **boolean** | 3CX URL | [optional] [default to undefined]
|
|
12
|
+
**authKey** | **boolean** | 3CX SBC Auth Key | [optional] [default to undefined]
|
|
13
|
+
**ipAddress** | **boolean** | LAN IP Address | [optional] [default to undefined]
|
|
14
|
+
**subnetMask** | **boolean** | LAN Subnet Mask | [optional] [default to undefined]
|
|
15
|
+
**defaultGateway** | **boolean** | LAN Default Gateway | [optional] [default to undefined]
|
|
16
|
+
**dns** | **boolean** | DNS | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { SbcDTO } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: SbcDTO = {
|
|
24
|
+
noConfig,
|
|
25
|
+
dhcp,
|
|
26
|
+
url,
|
|
27
|
+
authKey,
|
|
28
|
+
ipAddress,
|
|
29
|
+
subnetMask,
|
|
30
|
+
defaultGateway,
|
|
31
|
+
dns,
|
|
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)
|