yellowgrid-api-ts 3.2.215 → 3.2.217-dev.0

package/docs/AddressDTO.md

@@ -6,12 +6,15 @@ Address
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**company** | **string** | Company | [optional] [default to undefined]
 **addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
 **addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
 **city** | **string** | City | [optional] [default to undefined]
 **region** | **string** | Region | [optional] [default to undefined]
 **postalCode** | **string** | Postal Code | [optional] [default to undefined]
 **iso** | **string** | Country | [optional] [default to undefined]
+**phone** | **string** | Telephone | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
 
 ## Example
 
@@ -19,12 +22,15 @@ Name | Type | Description | Notes
 import { AddressDTO } from 'yellowgrid-api-ts';
 
 const instance: AddressDTO = {
+    company,
     addressLine1,
     addressLine2,
     city,
     region,
     postalCode,
     iso,
+    phone,
+    name,
 };
 ```
 

package/docs/AdminCustomerRmasModel.md

@@ -0,0 +1,27 @@
+# AdminCustomerRmasModel
+
+Admin Customer RMA List Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<AdminRmaSummaryDTO>**](AdminRmaSummaryDTO.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminCustomerRmasModel } from 'yellowgrid-api-ts';
+
+const instance: AdminCustomerRmasModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[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/AdminRmaDTO.md

@@ -0,0 +1,59 @@
+# AdminRmaDTO
+
+Admin RMA
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA ID | [optional] [default to undefined]
+**contactName** | **string** | Contact Name | [optional] [default to undefined]
+**contactEmail** | **string** | Contact Email | [optional] [default to undefined]
+**orderId** | **number** | Associated Order ID | [optional] [default to undefined]
+**reason** | **number** | RMA Reason | [optional] [default to undefined]
+**faultReport** | **string** | Fault Report | [optional] [default to undefined]
+**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
+**resolution** | **number** | RMA Resolution | [optional] [default to undefined]
+**status** | **number** | RMA Status | [optional] [default to undefined]
+**approved** | **boolean** | RMA Approval Status | [optional] [default to undefined]
+**address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+**customerName** | **string** | Customer Name | [optional] [default to undefined]
+**createdAt** | **string** | Date Time | [optional] [default to undefined]
+**items** | [**Array<AdminRmaItemDTO>**](AdminRmaItemDTO.md) | RMA Items | [optional] [default to undefined]
+**notes** | [**Array<AdminRmaNoteDTO>**](AdminRmaNoteDTO.md) | RMA Notes | [optional] [default to undefined]
+**replacementOrders** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Replacement Order | [optional] [default to undefined]
+**creditNotes** | [**Array<CreditNoteDTO>**](CreditNoteDTO.md) | Credit Notes | [optional] [default to undefined]
+**collectionTrackingUrl** | **string** | Collection Tracking URL | [optional] [default to undefined]
+**returnTrackingUrl** | **string** | Return Tracking URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminRmaDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminRmaDTO = {
+    id,
+    contactName,
+    contactEmail,
+    orderId,
+    reason,
+    faultReport,
+    ticketId,
+    resolution,
+    status,
+    approved,
+    address,
+    customerId,
+    customerName,
+    createdAt,
+    items,
+    notes,
+    replacementOrders,
+    creditNotes,
+    collectionTrackingUrl,
+    returnTrackingUrl,
+};
+```
+
+[[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/AdminRmaItemDTO.md

@@ -0,0 +1,39 @@
+# AdminRmaItemDTO
+
+Admin RMA Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA Item ID | [optional] [default to undefined]
+**itemId** | **number** | RMA Order Item ID | [optional] [default to undefined]
+**itemName** | **string** | RMA Item Name | [optional] [default to undefined]
+**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
+**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
+**received** | **boolean** | RMA Item Received Status | [optional] [default to undefined]
+**status** | **number** | RMA Item Status | [optional] [default to undefined]
+**note** | **string** | RMA Item Note | [optional] [default to undefined]
+**resolution** | **number** | RMA Item Resolution | [optional] [default to undefined]
+**replacementSku** | **string** | RMA Item Replacement SKU | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminRmaItemDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminRmaItemDTO = {
+    id,
+    itemId,
+    itemName,
+    macAddress,
+    serialNumber,
+    received,
+    status,
+    note,
+    resolution,
+    replacementSku,
+};
+```
+
+[[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/AdminRmaNoteDTO.md

@@ -0,0 +1,27 @@
+# AdminRmaNoteDTO
+
+Admin RMA Note
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA Note ID | [optional] [default to undefined]
+**note** | **string** | Note Content | [optional] [default to undefined]
+**createdBy** | **string** | Note Creator | [optional] [default to undefined]
+**createdAt** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminRmaNoteDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminRmaNoteDTO = {
+    id,
+    note,
+    createdBy,
+    createdAt,
+};
+```
+
+[[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/AdminRmaSummaryDTO.md

@@ -0,0 +1,37 @@
+# AdminRmaSummaryDTO
+
+Admin RMA Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA ID | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
+**status** | **number** | RMA Status | [optional] [default to undefined]
+**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [optional] [default to undefined]
+**customerId** | **number** | RMA Customer ID | [optional] [default to undefined]
+**customerName** | **string** | RMA Customer Name | [optional] [default to undefined]
+**ticketId** | **number** | RMA Ticket ID | [optional] [default to undefined]
+**createdAt** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminRmaSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminRmaSummaryDTO = {
+    id,
+    orderId,
+    orderReference,
+    status,
+    items,
+    customerId,
+    customerName,
+    ticketId,
+    createdAt,
+};
+```
+
+[[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/AxisDataDTO.md

@@ -0,0 +1,25 @@
+# AxisDataDTO
+
+Graph Axis Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | Type | [optional] [default to undefined]
+**data** | **Array<string>** | Data | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AxisDataDTO } from 'yellowgrid-api-ts';
+
+const instance: AxisDataDTO = {
+    type,
+    data,
+    name,
+};
+```
+
+[[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/BillingApi.md

@@ -1,6 +1,6 @@
 # BillingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/CRMApi.md

@@ -1,6 +1,6 @@
 # CRMApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXApi.md

@@ -1,6 +1,6 @@
 # Class3CXApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationWizardApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationWizardApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXIntegrationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXMultiTenantApi.md

@@ -1,6 +1,6 @@
 # Class3CXMultiTenantApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/CreditNoteItemEntity.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **orderId** | **number** | orderId | [optional] [default to undefined]
 **itemId** | **number** | itemId | [optional] [default to undefined]
 **amount** | **number** | amount | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
 
 ## Example
 
@@ -23,6 +24,7 @@ const instance: CreditNoteItemEntity = {
     orderId,
     itemId,
     amount,
+    quantity,
 };
 ```
 

package/docs/CreditNoteItemModel.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **orderId** | **number** | orderId | [optional] [default to undefined]
 **itemId** | **number** | itemId | [optional] [default to undefined]
 **amount** | **number** | amount | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
 
 ## Example
 
@@ -23,6 +24,7 @@ const instance: CreditNoteItemModel = {
     orderId,
     itemId,
     amount,
+    quantity,
 };
 ```
 

package/docs/CrmActivityDTO.md

@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 **timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
 **title** | **string** | Activity Title | [optional] [default to undefined]
 **description** | **string** | Activity Description | [optional] [default to undefined]
-**url** | **string** | Activity URL | [optional] [default to undefined]
 **user** | **string** | Activity User Name | [optional] [default to undefined]
 **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
+**orderId** | **number** | Activity Order ID | [optional] [default to undefined]
 
 ## Example
 
@@ -24,9 +24,9 @@ const instance: CrmActivityDTO = {
     timestamp,
     title,
     description,
-    url,
     user,
     contact,
+    orderId,
 };
 ```
 

package/docs/CustomerCoordinatesDTO.md

@@ -0,0 +1,31 @@
+# CustomerCoordinatesDTO
+
+Customer Coordinates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID | [optional] [default to undefined]
+**company** | **string** | Company | [optional] [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**latitude** | **string** | Latitude | [optional] [default to undefined]
+**longitude** | **string** | Longitude | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerCoordinatesDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerCoordinatesDTO = {
+    id,
+    company,
+    resellerId,
+    postCode,
+    latitude,
+    longitude,
+};
+```
+
+[[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/CustomerRmasModel.md

@@ -0,0 +1,27 @@
+# CustomerRmasModel
+
+Customer RMAs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<RmaSummaryDTO>**](RmaSummaryDTO.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerRmasModel } from 'yellowgrid-api-ts';
+
+const instance: CustomerRmasModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[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/EmailRequestModel.md

@@ -0,0 +1,21 @@
+# EmailRequestModel
+
+Email Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email Address | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EmailRequestModel } from 'yellowgrid-api-ts';
+
+const instance: EmailRequestModel = {
+    email,
+};
+```
+
+[[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/GraphDTO.md

@@ -0,0 +1,33 @@
+# GraphDTO
+
+Graph
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
+**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
+**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
+**legend** | **Array<string>** | Legend | [optional] [default to undefined]
+**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
+**currency** | **string** | Currency | [optional] [default to undefined]
+**locale** | **string** | Locale | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GraphDTO } from 'yellowgrid-api-ts';
+
+const instance: GraphDTO = {
+    title,
+    xAxis,
+    yAxis,
+    legend,
+    series,
+    currency,
+    locale,
+};
+```
+
+[[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/ItemResolutionRequestModel.md

@@ -0,0 +1,21 @@
+# ItemResolutionRequestModel
+
+RMA Item Status Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resolution** | **number** | RMA Item Resolution | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ItemResolutionRequestModel } from 'yellowgrid-api-ts';
+
+const instance: ItemResolutionRequestModel = {
+    resolution,
+};
+```
+
+[[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/MacAddressRequestModel.md

@@ -0,0 +1,21 @@
+# MacAddressRequestModel
+
+RMA Item MAC Address Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MacAddressRequestModel } from 'yellowgrid-api-ts';
+
+const instance: MacAddressRequestModel = {
+    macAddress,
+};
+```
+
+[[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/MiscApi.md

@@ -0,0 +1,63 @@
+# MiscApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**postSendPassword**](#postsendpassword) | **POST** /admin/password/send | |
+
+# **postSendPassword**
+> PasswordSenderDTO postSendPassword()
+
+Share Credentials
+
+### Example
+
+```typescript
+import {
+    MiscApi,
+    Configuration,
+    PasswordSenderDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MiscApi(configuration);
+
+let passwordSenderDTO: PasswordSenderDTO; //Password Sender Request (optional)
+
+const { status, data } = await apiInstance.postSendPassword(
+    passwordSenderDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passwordSenderDTO** | **PasswordSenderDTO**| Password Sender Request | |
+
+
+### Return type
+
+**PasswordSenderDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Password Sender 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)
+

package/docs/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/NameRequestModel.md

@@ -0,0 +1,21 @@
+# NameRequestModel
+
+Name Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NameRequestModel } from 'yellowgrid-api-ts';
+
+const instance: NameRequestModel = {
+    name,
+};
+```
+
+[[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/NoteRequestModel.md

@@ -0,0 +1,21 @@
+# NoteRequestModel
+
+Note Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**note** | **string** | Note | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NoteRequestModel } from 'yellowgrid-api-ts';
+
+const instance: NoteRequestModel = {
+    note,
+};
+```
+
+[[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/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|