yellowgrid-api-ts 3.2.132-dev.0 → 3.2.132

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://localhost*
 |[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
 |[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
 |[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
+|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
 |[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
 
 # **getGetMfaQrCode**
@@ -311,6 +312,53 @@ No authorization required
 
 [[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)
 
+# **postLogout**
+> postLogout()
+
+Remove Oauth 2.0 Cookies
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.postLogout();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **postPortalLogin**
 > AuthCodeResponseModel postPortalLogin()
 

package/docs/OrderDTO.md

@@ -0,0 +1,25 @@
+# OrderDTO
+
+Legacy Portal Order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [optional] [default to undefined]
+**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) |  | [optional] [default to undefined]
+**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderDTO = {
+    basket,
+    shippingAddress,
+    orderDetails,
+};
+```
+
+[[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

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
 **processDate** | **string** | Date Time | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
 **promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
 **refunded** | **number** | Refunded | [optional] [default to undefined]
 **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
@@ -41,6 +42,7 @@ const instance: OrderItemDTO = {
     licenceExpiry,
     processDate,
     hosting,
+    renewalYears,
     promoItem,
     refunded,
     sbcs,

package/docs/OrderResponseDTO.md

@@ -0,0 +1,25 @@
+# OrderResponseDTO
+
+Legacy Portal Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | URL | [optional] [default to undefined]
+**orderID** | **string** | Order ID | [optional] [default to undefined]
+**uniqueID** | **string** | Unique ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderResponseDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderResponseDTO = {
+    url,
+    orderID,
+    uniqueID,
+};
+```
+
+[[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

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -19,6 +19,7 @@ All URIs are relative to *https://localhost*
 |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
 |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
+|[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
 |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
 |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
@@ -896,6 +897,61 @@ No authorization required
 
 [[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)
 
+# **postCreatePortalOrderLegacy**
+> OrderResponseDTO postCreatePortalOrderLegacy()
+
+Create an order via the legacy portal
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrderDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let orderDTO: OrderDTO; //Legacy Portal Order (optional)
+
+const { status, data } = await apiInstance.postCreatePortalOrderLegacy(
+    orderDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderDTO** | **OrderDTO**| Legacy Portal Order | |
+
+
+### Return type
+
+**OrderResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Legacy Portal Order Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **postCreateShipment**
 > ShipmentDTO postCreateShipment()
 

package/docs/PostGetProductForCustomerRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade Only) | [optional] [default to undefined]
 
 ## Example
 
@@ -20,6 +21,7 @@ const instance: PostGetProductForCustomerRequest = {
     licenceKey,
     hosting,
     tcxSalesCode,
+    renewalYears,
 };
 ```
 

package/docs/PricingApi.md

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProductSummaryDTO.md

@@ -10,11 +10,11 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
-**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Due Date | [optional] [default to undefined]
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -422,7 +422,7 @@ No authorization required
 [[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)
 
 # **postGetProduct**
-> ProductSummaryDTO postGetProduct(postGetProductRequest)
+> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
 Get Product
 
@@ -432,18 +432,18 @@ Get Product
 import {
     ProductsApi,
     Configuration,
-    PostGetProductRequest
+    PostGetProductForCustomerRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
 let sku: string; //Product SKU (default to undefined)
-let postGetProductRequest: PostGetProductRequest; //Product search criteria
+let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
 
 const { status, data } = await apiInstance.postGetProduct(
     sku,
-    postGetProductRequest
+    postGetProductForCustomerRequest
 );
 ```
 
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.postGetProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postGetProductRequest** | **PostGetProductRequest**| Product search criteria | |
+| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **sku** | [**string**] | Product SKU | defaults to undefined|
 
 

package/docs/ProspectDTO.md

@@ -0,0 +1,33 @@
+# ProspectDTO
+
+Prospect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyName** | **string** | Company Name | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
+**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProspectDTO } from 'yellowgrid-api-ts';
+
+const instance: ProspectDTO = {
+    companyName,
+    telephone,
+    lastOrderDate,
+    callbackDate,
+    xeroId,
+    removed,
+    status,
+};
+```
+
+[[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/ProspectEntity.md

@@ -0,0 +1,41 @@
+# ProspectEntity
+
+ProspectEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**status** | **number** | status | [optional] [default to undefined]
+**customerId** | **number** | customerId | [optional] [default to undefined]
+**companyName** | **string** | companyName | [optional] [default to undefined]
+**contactName** | **string** | contactName | [optional] [default to undefined]
+**telephone** | **string** | telephone | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**reason** | **string** | reason | [optional] [default to undefined]
+**lastOrderDate** | **string** | lastOrderDate | [optional] [default to undefined]
+**followUpDate** | **string** | followUpDate | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProspectEntity } from 'yellowgrid-api-ts';
+
+const instance: ProspectEntity = {
+    id,
+    status,
+    customerId,
+    companyName,
+    contactName,
+    telephone,
+    email,
+    reason,
+    lastOrderDate,
+    followUpDate,
+    notes,
+};
+```
+
+[[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/ProspectsApi.md

@@ -0,0 +1,226 @@
+# ProspectsApi
+
+All URIs are relative to *https://bitbucket.org*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetProspect**](#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect|
+|[**getGetProspects**](#getgetprospects) | **GET** /accounts/prospects | Get Prospects|
+|[**getRemoveFromProspects**](#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects|
+|[**getSetCallback**](#getsetcallback) | **GET** /accounts/prospects/{xero_id}/date | Set Call Back Date|
+
+# **getGetProspect**
+> ProspectDTO getGetProspect()
+
+Get Prospect
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+let xeroId: string; //Xero ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetProspect(
+    xeroId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **xeroId** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**ProspectDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospect |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **getGetProspects**
+> Array<ProspectDTO> getGetProspects()
+
+Get Prospects
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+const { status, data } = await apiInstance.getGetProspects();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ProspectDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospects |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **getRemoveFromProspects**
+> ProspectDTO getRemoveFromProspects()
+
+Remove From Prospect
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+let xeroId: string; //Xero ID (default to undefined)
+let status: boolean; //Status (default to undefined)
+
+const { status, data } = await apiInstance.getRemoveFromProspects(
+    xeroId,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **xeroId** | [**string**] | Xero ID | defaults to undefined|
+| **status** | [**boolean**] | Status | defaults to undefined|
+
+
+### Return type
+
+**ProspectDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospect |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **getSetCallback**
+> ProspectDTO getSetCallback()
+
+Set Call Back Date
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+let xeroId: string; //Xero ID (default to undefined)
+let date: string; //Callback Date (default to undefined)
+
+const { status, data } = await apiInstance.getSetCallback(
+    xeroId,
+    date
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **xeroId** | [**string**] | Xero ID | defaults to undefined|
+| **date** | [**string**] | Callback Date | defaults to undefined|
+
+
+### Return type
+
+**ProspectDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospect |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+

package/docs/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|