yellowgrid-api-ts 3.2.260 → 3.2.262-dev.0

package/docs/AdminRmaDTO.md

@@ -0,0 +1,67 @@
+# AdminRmaDTO
+
+Admin RMA
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA ID | [default to undefined]
+**contactName** | **string** | Contact Name | [default to undefined]
+**contactEmail** | **string** | Contact Email | [default to undefined]
+**orderId** | **number** | Associated Order ID | [default to undefined]
+**reason** | **number** | RMA Reason | [default to undefined]
+**faultReport** | **string** | Fault Report | [default to undefined]
+**ticketId** | **number** | Ticket ID | [default to undefined]
+**resolution** | **number** | RMA Resolution | [default to undefined]
+**status** | **number** | RMA Status | [default to undefined]
+**statusText** | **string** | RMA Status Text | [default to undefined]
+**approved** | **boolean** | RMA Approval Status | [default to undefined]
+**address** | [**AddressDTO**](AddressDTO.md) |  | [default to undefined]
+**advanceReplacementOrderId** | **number** | Advance Replacement Order ID | [default to undefined]
+**customerId** | **number** | Customer ID | [default to undefined]
+**xeroId** | **string** | Customer Xero ID | [default to undefined]
+**customerName** | **string** | Customer Name | [default to undefined]
+**createdAt** | **string** | Date Time | [default to undefined]
+**items** | [**Array<AdminRmaItemDTO>**](AdminRmaItemDTO.md) | RMA Items | [default to undefined]
+**notes** | [**Array<AdminRmaNoteDTO>**](AdminRmaNoteDTO.md) | RMA Notes | [default to undefined]
+**replacementOrders** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Replacement Order | [default to undefined]
+**creditNotes** | [**Array<CreditNoteDTO>**](CreditNoteDTO.md) | Credit Notes | [default to undefined]
+**collectionTrackingUrl** | **string** | Collection Tracking URL | [optional] [default to undefined]
+**returnTrackingUrl** | **string** | Return Tracking URL | [optional] [default to undefined]
+**ticketUrl** | **string** | Ticket Url | [default to undefined]
+
+## Example
+
+```typescript
+import { AdminRmaDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminRmaDTO = {
+    id,
+    contactName,
+    contactEmail,
+    orderId,
+    reason,
+    faultReport,
+    ticketId,
+    resolution,
+    status,
+    statusText,
+    approved,
+    address,
+    advanceReplacementOrderId,
+    customerId,
+    xeroId,
+    customerName,
+    createdAt,
+    items,
+    notes,
+    replacementOrders,
+    creditNotes,
+    collectionTrackingUrl,
+    returnTrackingUrl,
+    ticketUrl,
+};
+```
+
+[[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,51 @@
+# AdminRmaItemDTO
+
+Admin RMA Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA Item ID | [default to undefined]
+**itemId** | **number** | RMA Order Item ID | [default to undefined]
+**itemName** | **string** | RMA Item Name | [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 | [default to undefined]
+**status** | **number** | RMA Item Status | [default to undefined]
+**statusText** | **string** | RMA Item Status Text | [default to undefined]
+**note** | **string** | RMA Item Note | [optional] [default to undefined]
+**resolution** | **number** | RMA Item Resolution | [optional] [default to undefined]
+**sku** | **string** | RMA Item SKU | [optional] [default to undefined]
+**replacementSku** | **string** | RMA Item Replacement SKU | [optional] [default to undefined]
+**productSerialInfo** | [**ProductSerialInfoDTO**](ProductSerialInfoDTO.md) |  | [optional] [default to undefined]
+**endOfLife** | **boolean** | Is End of Life | [optional] [default to undefined]
+**macFoundOnOrder** | **boolean** | MAC address found on associated order | [optional] [default to undefined]
+**serialFoundOnOrder** | **boolean** | Serial Number found on associated order | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminRmaItemDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminRmaItemDTO = {
+    id,
+    itemId,
+    itemName,
+    macAddress,
+    serialNumber,
+    received,
+    status,
+    statusText,
+    note,
+    resolution,
+    sku,
+    replacementSku,
+    productSerialInfo,
+    endOfLife,
+    macFoundOnOrder,
+    serialFoundOnOrder,
+};
+```
+
+[[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 | [default to undefined]
+**note** | **string** | Note Content | [default to undefined]
+**createdBy** | **string** | Note Creator | [default to undefined]
+**createdAt** | **string** | Date Time | [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,39 @@
+# AdminRmaSummaryDTO
+
+Admin RMA Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA ID | [default to undefined]
+**orderId** | **number** | Order ID | [default to undefined]
+**orderReference** | **string** | Order Reference | [default to undefined]
+**status** | **number** | RMA Status | [default to undefined]
+**statusText** | **string** | Status Text | [default to undefined]
+**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [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,
+    statusText,
+    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/AdminUserModel.md

@@ -6,16 +6,16 @@ Admin User
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
-**firstName** | **string** | First Name | [optional] [default to undefined]
-**lastName** | **string** | Last Name | [optional] [default to undefined]
+**id** | **number** | ID | [default to undefined]
+**firstName** | **string** | First Name | [default to undefined]
+**lastName** | **string** | Last Name | [default to undefined]
 **avatar** | **string** | Avatar | [optional] [default to undefined]
-**role** | **number** | Role | [optional] [default to undefined]
+**role** | **number** | Role | [default to undefined]
 **email** | **string** | Email | [optional] [default to undefined]
 **primaryHex** | **string** | Primary Colour | [optional] [default to undefined]
 **secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
 **scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
-**permissions** | **Array<string>** | Groups | [optional] [default to undefined]
+**permissions** | **Array<string>** | Groups | [default to undefined]
 
 ## Example
 

package/docs/AgentHoursGraphModel.md

@@ -6,10 +6,10 @@ Agent Hours Graph
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**agentName** | **string** | Agent Name | [optional] [default to undefined]
-**months** | [**Array<AgentHoursGraphMonthModel>**](AgentHoursGraphMonthModel.md) | Agent Hours By Month | [optional] [default to undefined]
-**agentColour** | **string** | Agent Colour | [optional] [default to undefined]
-**annualHours** | **number** | Annual Hours | [optional] [default to undefined]
+**agentName** | **string** | Agent Name | [default to undefined]
+**months** | [**Array<AgentHoursGraphMonthModel>**](AgentHoursGraphMonthModel.md) | Agent Hours By Month | [default to undefined]
+**agentColour** | **string** | Agent Colour | [default to undefined]
+**annualHours** | **number** | Annual Hours | [default to undefined]
 
 ## Example
 

package/docs/AgentHoursGraphMonthModel.md

@@ -6,8 +6,8 @@ Agent Hours Graph Month
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ticketHours** | **number** | Month Ticket Hours | [optional] [default to undefined]
-**timeEntryHours** | **number** | Month Time Entry Hours | [optional] [default to undefined]
+**ticketHours** | **number** | Month Ticket Hours | [default to undefined]
+**timeEntryHours** | **number** | Month Time Entry Hours | [default to undefined]
 
 ## Example
 

package/docs/ApiLogEntity.md

@@ -6,18 +6,18 @@ API Log
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | ID | [optional] [default to undefined]
-**timestamp** | **string** | Timestamp | [optional] [default to undefined]
-**method** | **string** | HTTP Method | [optional] [default to undefined]
-**uri** | **string** | URI | [optional] [default to undefined]
-**client_ip** | **string** | Client IP | [optional] [default to undefined]
-**request_headers** | **Array<string>** | Request Headers | [optional] [default to undefined]
-**request_body** | **object** | Request Body | [optional] [default to undefined]
-**client_id** | **string** | Client ID | [optional] [default to undefined]
-**response_code** | **number** | HTTP Response Code | [optional] [default to undefined]
-**response_headers** | **Array<string>** | Response Headers | [optional] [default to undefined]
-**response_body** | **object** | Response Body | [optional] [default to undefined]
-**http_origin** | **string** | HTTP Origin | [optional] [default to undefined]
+**id** | **string** | ID | [default to undefined]
+**timestamp** | **string** | Timestamp | [default to undefined]
+**method** | **string** | HTTP Method | [default to undefined]
+**uri** | **string** | URI | [default to undefined]
+**client_ip** | **string** | Client IP | [default to undefined]
+**request_headers** | **Array<string>** | Request Headers | [default to undefined]
+**request_body** | **object** | Request Body | [default to undefined]
+**client_id** | **string** | Client ID | [default to undefined]
+**response_code** | **number** | HTTP Response Code | [default to undefined]
+**response_headers** | **Array<string>** | Response Headers | [default to undefined]
+**response_body** | **object** | Response Body | [default to undefined]
+**http_origin** | **string** | HTTP Origin | [default to undefined]
 
 ## Example
 

package/docs/AreaCodeModel.md

@@ -6,8 +6,8 @@ UK Area Code
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **string** | Area Code | [optional] [default to undefined]
-**name** | **string** | Location | [optional] [default to undefined]
+**code** | **string** | Area Code | [default to undefined]
+**name** | **string** | Location | [default to undefined]
 
 ## Example
 

package/docs/AttachmentModel.md

@@ -6,11 +6,11 @@ Ticket Attachment
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Attachment ID | [optional] [default to undefined]
-**contentType** | **string** | Content Type | [optional] [default to undefined]
-**size** | **string** | Size | [optional] [default to undefined]
-**fileName** | **string** | File Name | [optional] [default to undefined]
-**attachmentUrl** | **string** | Attachment URL | [optional] [default to undefined]
+**id** | **number** | Attachment ID | [default to undefined]
+**contentType** | **string** | Content Type | [default to undefined]
+**size** | **string** | Size | [default to undefined]
+**fileName** | **string** | File Name | [default to undefined]
+**attachmentUrl** | **string** | Attachment URL | [default to undefined]
 
 ## Example
 

package/docs/AttributeSetEnum.md

@@ -6,8 +6,8 @@ Attribute Set
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | Attribute Set ID | [optional] [default to undefined]
-**name** | **string** | Attribute Set Name | [optional] [default to undefined]
+**id** | **number** | Attribute Set ID | [default to undefined]
+**name** | **string** | Attribute Set Name | [default to undefined]
 
 ## Example
 

package/docs/AuditLogEntity.md

@@ -6,15 +6,15 @@ AuditLogEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**action** | **string** | action | [optional] [default to undefined]
-**type** | **string** | type | [optional] [default to undefined]
-**identifier** | **string** | identifier | [optional] [default to undefined]
-**user** | **string** | user | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
-**beforeData** | **string** | beforeData | [optional] [default to undefined]
-**afterData** | **string** | afterData | [optional] [default to undefined]
-**description** | **string** | description | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**action** | **string** | action | [default to undefined]
+**type** | **string** | type | [default to undefined]
+**identifier** | **string** | identifier | [default to undefined]
+**user** | **string** | user | [default to undefined]
+**timestamp** | **string** | timestamp | [default to undefined]
+**beforeData** | **string** | beforeData | [default to undefined]
+**afterData** | **string** | afterData | [default to undefined]
+**description** | **string** | description | [default to undefined]
 
 ## Example
 

package/docs/AuthCodeResponseModel.md

@@ -6,7 +6,7 @@ OAuth Auth Code Response
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **string** | Auth Code | [optional] [default to undefined]
+**code** | **string** | Auth Code | [default to undefined]
 **state** | **string** | State | [optional] [default to undefined]
 **redirect_uri** | **string** | Redirect URI | [optional] [default to undefined]
 

package/docs/AxisDataDTO.md

@@ -6,7 +6,7 @@ Graph Axis Data
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **string** | Type | [optional] [default to undefined]
+**type** | **string** | Type | [default to undefined]
 **data** | **Array<string>** | Data | [optional] [default to undefined]
 **name** | **string** | Name | [optional] [default to undefined]
 

package/docs/BasicItemDTO.md

@@ -6,8 +6,8 @@ Basic Order Item
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**quantity** | **number** | Quantity | [default to undefined]
 
 ## Example
 

package/docs/BasicProductDTO.md

@@ -6,8 +6,8 @@ Basic Product
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Title | [default to undefined]
 
 ## Example
 

package/docs/BatchDTO.md

@@ -6,23 +6,23 @@ Batch DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**supplierId** | **number** | supplierId | [optional] [default to undefined]
-**poNumber** | **string** | poNumber | [optional] [default to undefined]
-**carriage** | **number** | carriage | [optional] [default to undefined]
-**courier** | **string** | courier | [optional] [default to undefined]
-**courierService** | **string** | courierService | [optional] [default to undefined]
-**courierReference** | **string** | courierReference | [optional] [default to undefined]
-**courierUnique** | **string** | courierUnique | [optional] [default to undefined]
-**notes** | **string** | notes | [optional] [default to undefined]
-**ordered** | **number** | ordered | [optional] [default to undefined]
-**carriagePaid** | **number** | carriagePaid | [optional] [default to undefined]
-**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
-**carriageRefundedDue** | **number** | carriageRefundedDue | [optional] [default to undefined]
-**netdespatchLabel** | **string** | netdespatchLabel | [optional] [default to undefined]
-**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
-**mac** | **string** | mac | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**orderId** | **number** | orderId | [default to undefined]
+**supplierId** | **number** | supplierId | [default to undefined]
+**poNumber** | **string** | poNumber | [default to undefined]
+**carriage** | **number** | carriage | [default to undefined]
+**courier** | **string** | courier | [default to undefined]
+**courierService** | **string** | courierService | [default to undefined]
+**courierReference** | **string** | courierReference | [default to undefined]
+**courierUnique** | **string** | courierUnique | [default to undefined]
+**notes** | **string** | notes | [default to undefined]
+**ordered** | **number** | ordered | [default to undefined]
+**carriagePaid** | **number** | carriagePaid | [default to undefined]
+**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
+**carriageRefundedDue** | **number** | carriageRefundedDue | [default to undefined]
+**netdespatchLabel** | **string** | netdespatchLabel | [default to undefined]
+**courierBoxes** | **number** | courierBoxes | [default to undefined]
+**mac** | **string** | mac | [default to undefined]
 **shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
 **items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
 **supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]

package/docs/BatchEntity.md

@@ -6,23 +6,23 @@ BatchesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**supplierId** | **number** | supplierId | [optional] [default to undefined]
-**poNumber** | **string** | poNumber | [optional] [default to undefined]
-**carriage** | **number** | carriage | [optional] [default to undefined]
-**courier** | **string** | courier | [optional] [default to undefined]
-**courierService** | **string** | courierService | [optional] [default to undefined]
-**courierReference** | **string** | courierReference | [optional] [default to undefined]
-**courierUnique** | **string** | courierUnique | [optional] [default to undefined]
-**notes** | **string** | notes | [optional] [default to undefined]
-**ordered** | **number** | ordered | [optional] [default to undefined]
-**carriagePaid** | **number** | carriagePaid | [optional] [default to undefined]
-**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
-**carriageRefundedDue** | **number** | carriageRefundedDue | [optional] [default to undefined]
-**netdespatchLabel** | **string** | netdespatchLabel | [optional] [default to undefined]
-**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
-**mac** | **string** | mac | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**orderId** | **number** | orderId | [default to undefined]
+**supplierId** | **number** | supplierId | [default to undefined]
+**poNumber** | **string** | poNumber | [default to undefined]
+**carriage** | **number** | carriage | [default to undefined]
+**courier** | **string** | courier | [default to undefined]
+**courierService** | **string** | courierService | [default to undefined]
+**courierReference** | **string** | courierReference | [default to undefined]
+**courierUnique** | **string** | courierUnique | [default to undefined]
+**notes** | **string** | notes | [default to undefined]
+**ordered** | **number** | ordered | [default to undefined]
+**carriagePaid** | **number** | carriagePaid | [default to undefined]
+**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
+**carriageRefundedDue** | **number** | carriageRefundedDue | [default to undefined]
+**netdespatchLabel** | **string** | netdespatchLabel | [default to undefined]
+**courierBoxes** | **number** | courierBoxes | [default to undefined]
+**mac** | **string** | mac | [default to undefined]
 
 ## Example
 

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|
 |------------- | ------------- | -------------|
@@ -8,6 +8,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**deleteAddRecurringCharge**](#deleteaddrecurringcharge) | **DELETE** /billing/customer/recurringCharges | |
 |[**deleteAddServiceToServicePlan**](#deleteaddservicetoserviceplan) | **DELETE** /billing/admin/servicePlan/service | |
 |[**deleteCloseAccount**](#deletecloseaccount) | **DELETE** /billing/customer/customer | |
+|[**deleteDeleteCallTariffId**](#deletedeletecalltariffid) | **DELETE** /billing/admin/callTariffPlan/callTariff/{id} | |
 |[**deleteGetBaseServices**](#deletegetbaseservices) | **DELETE** /billing/admin/baseServices | |
 |[**deleteGetCallTariffPlan**](#deletegetcalltariffplan) | **DELETE** /billing/admin/callTariffPlan | |
 |[**deleteGetPriceGroups**](#deletegetpricegroups) | **DELETE** /billing/admin/priceGroups | |
@@ -293,6 +294,60 @@ 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)
 
+# **deleteDeleteCallTariffId**
+> boolean deleteDeleteCallTariffId()
+
+Delete Call Tariff By ID
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let id: number; //Call Tariff ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteCallTariffId(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Call Tariff ID | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful |  -  |
+|**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)
+
 # **deleteGetBaseServices**
 > boolean deleteGetBaseServices()
 
@@ -946,7 +1001,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let billCustomerId: number; //Customer ID (optional) (default to undefined)
+let billCustomerId: string; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetBillingCustomerDetails(
     billCustomerId
@@ -957,7 +1012,7 @@ const { status, data } = await apiInstance.getGetBillingCustomerDetails(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+| **billCustomerId** | [**string**] | Customer ID | (optional) defaults to undefined|
 
 
 ### Return type
@@ -1306,7 +1361,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
+let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
 let billCustomerId: number; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetConnections(
@@ -1319,7 +1374,7 @@ const { status, data } = await apiInstance.getGetConnections(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
+| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
 | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
 
 
@@ -1665,7 +1720,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
+let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetServicesPlanDetails(
     type
@@ -1676,7 +1731,7 @@ const { status, data } = await apiInstance.getGetServicesPlanDetails(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
+| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/BrandedVideoSummaryDTO.md

@@ -0,0 +1,47 @@
+# BrandedVideoSummaryDTO
+
+Branded Video Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [default to undefined]
+**customerId** | **number** | Customer ID | [default to undefined]
+**company** | **string** | Company | [default to undefined]
+**type** | **string** | Type | [default to undefined]
+**video** | **string** | Video | [default to undefined]
+**email** | **string** | Email | [default to undefined]
+**website** | **string** | Website | [default to undefined]
+**telephone** | **string** | Telephone | [default to undefined]
+**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**requestDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**oneDriveId** | **string** | OneDrive ID | [optional] [default to undefined]
+**status** | **string** | Status | [default to undefined]
+**notes** | **string** | Notes | [default to undefined]
+
+## Example
+
+```typescript
+import { BrandedVideoSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: BrandedVideoSummaryDTO = {
+    id,
+    customerId,
+    company,
+    type,
+    video,
+    email,
+    website,
+    telephone,
+    invoiceNumber,
+    requestDate,
+    dueDate,
+    oneDriveId,
+    status,
+    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)