yellowgrid-api-ts 3.2.218-dev.0 → 3.2.219-dev.0

package/docs/PutConnectionSearchRequest.md

@@ -0,0 +1,20 @@
+# PutConnectionSearchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutConnectionSearchRequest } from 'yellowgrid-api-ts';
+
+const instance: PutConnectionSearchRequest = {
+    customerId,
+};
+```
+
+[[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/PutGetBaseServicesRequest.md

@@ -0,0 +1,28 @@
+# PutGetBaseServicesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**serviceCodeAdmin** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**dataType** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetBaseServicesRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetBaseServicesRequest = {
+    property,
+    value,
+    serviceCodeAdmin,
+    description,
+    dataType,
+};
+```
+
+[[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/PutGetCallTariffPlanRequest.md

@@ -0,0 +1,28 @@
+# PutGetCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateType** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetCallTariffPlanRequest = {
+    name,
+    unknownDestinationsRateType,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[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/PutGetPriceGroupsRequest.md

@@ -0,0 +1,28 @@
+# PutGetPriceGroupsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetPriceGroupsRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetPriceGroupsRequest = {
+    property,
+    value,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[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/RMAApi.md

@@ -10,6 +10,8 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetAdminRma**](#getgetadminrma) | **GET** /admin/rma/{id} | |
 |[**getGetAdminRmas**](#getgetadminrmas) | **GET** /admin/rma | |
 |[**getGetRma**](#getgetrma) | **GET** /rma/{id} | |
+|[**getGetRmaOrder**](#getgetrmaorder) | **GET** /rma/orders/{id} | |
+|[**getSearchRmaOrders**](#getsearchrmaorders) | **GET** /rma/orders | |
 |[**patchApproveRma**](#patchapproverma) | **PATCH** /admin/rma/{id}/approve | |
 |[**patchMarkRmaItemAsBinned**](#patchmarkrmaitemasbinned) | **PATCH** /admin/rma/{id}/items/{item_id}/bin | |
 |[**patchMarkRmaItemAsReceived**](#patchmarkrmaitemasreceived) | **PATCH** /admin/rma/{id}/items/{item_id}/received | |
@@ -309,7 +311,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Account Detailed Summary |  -  |
+|**200** | Admin RMAs |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
@@ -370,6 +372,114 @@ 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)
 
+# **getGetRmaOrder**
+> RmaOrderDTO getGetRmaOrder()
+
+Get Order by ID
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetRmaOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**RmaOrderDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | RMA |  -  |
+|**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)
+
+# **getSearchRmaOrders**
+> Array<RmaOrderSummaryDTO> getSearchRmaOrders()
+
+Search for Orders to create an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSearchRmaOrders(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<RmaOrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer RMAs |  -  |
+|**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)
+
 # **patchApproveRma**
 > patchApproveRma()
 

package/docs/RecurringCharge.md

@@ -0,0 +1,48 @@
+# RecurringCharge
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**customer** | [**Customer**](Customer.md) |  | [default to undefined]
+**phoneNumber** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**channelPartnerBuy** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**frequency** | **number** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**isActive** | **boolean** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RecurringCharge } from 'yellowgrid-api-ts';
+
+const instance: RecurringCharge = {
+    createdDate,
+    id,
+    customerId,
+    customer,
+    phoneNumber,
+    description,
+    channelPartnerBuy,
+    customerCharge,
+    frequency,
+    startDate,
+    endDate,
+    quantity,
+    accountCode,
+    filePeriod,
+    isActive,
+};
+```
+
+[[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/RmaDTO.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
 **resolution** | **number** | RMA Resolution | [optional] [default to undefined]
 **status** | **number** | RMA Status | [optional] [default to undefined]
+**statusText** | **string** | RMA Status Text | [optional] [default to undefined]
 **approved** | **boolean** | RMA Approval Status | [optional] [default to undefined]
 **address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
 **items** | [**Array<RmaItemDTO>**](RmaItemDTO.md) | RMA Items | [optional] [default to undefined]
@@ -34,6 +35,7 @@ const instance: RmaDTO = {
     ticketId,
     resolution,
     status,
+    statusText,
     approved,
     address,
     items,

package/docs/RmaItemDTO.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **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]
+**statusText** | **string** | RMA Item Status Text | [optional] [default to undefined]
 
 ## Example
 
@@ -27,6 +28,7 @@ const instance: RmaItemDTO = {
     serialNumber,
     received,
     status,
+    statusText,
 };
 ```
 

package/docs/RmaOrderDTO.md

@@ -0,0 +1,29 @@
+# RmaOrderDTO
+
+RMA Order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Order ID | [optional] [default to undefined]
+**reference** | **string** | Order Reference | [optional] [default to undefined]
+**orderDate** | **string** | Date Time | [optional] [default to undefined]
+**warrantyExpired** | **boolean** | Warranty Expired | [optional] [default to undefined]
+**items** | [**Array<RmaOrderItemDTO>**](RmaOrderItemDTO.md) | RMA Order Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaOrderDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaOrderDTO = {
+    id,
+    reference,
+    orderDate,
+    warrantyExpired,
+    items,
+};
+```
+
+[[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/RmaOrderItemDTO.md

@@ -0,0 +1,33 @@
+# RmaOrderItemDTO
+
+RMA Order Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemId** | **number** | Item ID | [optional] [default to undefined]
+**name** | **string** | Item Name | [optional] [default to undefined]
+**serialInfo** | [**ProductSerialInfoDTO**](ProductSerialInfoDTO.md) |  | [optional] [default to undefined]
+**alreadyReturnedQuantity** | **number** | Returned Quantity | [optional] [default to undefined]
+**availableReturnQuantity** | **number** | Available Return Quantity | [optional] [default to undefined]
+**endOfLife** | **boolean** | End of Life | [optional] [default to undefined]
+**unlikelyReturn** | **boolean** | Unlikely Return | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaOrderItemDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaOrderItemDTO = {
+    itemId,
+    name,
+    serialInfo,
+    alreadyReturnedQuantity,
+    availableReturnQuantity,
+    endOfLife,
+    unlikelyReturn,
+};
+```
+
+[[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/RmaOrderSummaryDTO.md

@@ -0,0 +1,25 @@
+# RmaOrderSummaryDTO
+
+RMA Order Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Order ID | [optional] [default to undefined]
+**reference** | **string** | Order Reference | [optional] [default to undefined]
+**orderDate** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaOrderSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaOrderSummaryDTO = {
+    id,
+    reference,
+    orderDate,
+};
+```
+
+[[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/RmaSummaryDTO.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **orderId** | **number** | Order ID | [optional] [default to undefined]
 **orderReference** | **string** | Order Reference | [optional] [default to undefined]
 **status** | **number** | RMA Status | [optional] [default to undefined]
+**statusText** | **string** | Status Text | [optional] [default to undefined]
 **items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [optional] [default to undefined]
 
 ## Example
@@ -22,6 +23,7 @@ const instance: RmaSummaryDTO = {
     orderId,
     orderReference,
     status,
+    statusText,
     items,
 };
 ```

package/docs/Sdr.md

@@ -0,0 +1,66 @@
+# Sdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**customerIdentifier** | **string** |  | [default to undefined]
+**fromDate** | **string** |  | [default to undefined]
+**fromTime** | **string** |  | [optional] [default to undefined]
+**toDate** | **string** |  | [optional] [default to undefined]
+**toTime** | **string** |  | [optional] [default to undefined]
+**refund** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**frequency** | **number** |  | [optional] [default to undefined]
+**unitCost** | **number** |  | [optional] [default to undefined]
+**totalCost** | **number** |  | [optional] [default to undefined]
+**chargeTypeClass** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [default to undefined]
+**serviceID** | **string** |  | [optional] [default to undefined]
+**accountRef** | **string** |  | [optional] [default to undefined]
+**carrier** | **string** |  | [optional] [default to undefined]
+**recordID** | **string** |  | [optional] [default to undefined]
+**currency** | **string** |  | [optional] [default to undefined]
+**discountReference** | **string** |  | [optional] [default to undefined]
+**effectiveDate** | **string** |  | [optional] [default to undefined]
+**partMonthCost** | **number** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**contentReference** | **string** |  | [default to undefined]
+**filePeriod** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Sdr } from 'yellowgrid-api-ts';
+
+const instance: Sdr = {
+    id,
+    customerIdentifier,
+    fromDate,
+    fromTime,
+    toDate,
+    toTime,
+    refund,
+    quantity,
+    frequency,
+    unitCost,
+    totalCost,
+    chargeTypeClass,
+    description,
+    serviceID,
+    accountRef,
+    carrier,
+    recordID,
+    currency,
+    discountReference,
+    effectiveDate,
+    partMonthCost,
+    filename,
+    contentReference,
+    filePeriod,
+};
+```
+
+[[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/SdrReferenceType.md

@@ -0,0 +1,24 @@
+# SdrReferenceType
+
+
+## Enum
+
+* `SipTrunk` (value: `'SIP_TRUNK'`)
+
+* `Broadband` (value: `'BROADBAND'`)
+
+* `Ethernet` (value: `'ETHERNET'`)
+
+* `Mobile` (value: `'MOBILE'`)
+
+* `Wlr` (value: `'WLR'`)
+
+* `Hzn` (value: `'HZN'`)
+
+* `Nts` (value: `'NTS'`)
+
+* `Hosting` (value: `'HOSTING'`)
+
+* `Crm` (value: `'CRM'`)
+
+[[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/Service.md

@@ -0,0 +1,42 @@
+# Service
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**servicePlanId** | **number** |  | [optional] [default to undefined]
+**servicePlan** | [**ServicePlan**](ServicePlan.md) |  | [optional] [default to undefined]
+**baseServiceId** | **number** |  | [optional] [default to undefined]
+**baseService** | [**BaseService**](BaseService.md) |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+**bureauRate** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**common** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Service } from 'yellowgrid-api-ts';
+
+const instance: Service = {
+    createdDate,
+    id,
+    servicePlanId,
+    servicePlan,
+    baseServiceId,
+    baseService,
+    customerRate,
+    description,
+    hideOnInvoice,
+    bureauRate,
+    filePeriod,
+    common,
+};
+```
+
+[[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/ServicePlan.md

@@ -0,0 +1,36 @@
+# ServicePlan
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**services** | [**Array<Service>**](Service.md) |  | [optional] [readonly] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+**connectionTypeId** | **number** |  | [optional] [default to undefined]
+**connectionType** | [**ConnectionType**](ConnectionType.md) |  | [optional] [default to undefined]
+**closed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServicePlan } from 'yellowgrid-api-ts';
+
+const instance: ServicePlan = {
+    createdDate,
+    id,
+    name,
+    services,
+    filePeriod,
+    planGroup,
+    connectionTypeId,
+    connectionType,
+    closed,
+};
+```
+
+[[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/SpecialService.md

@@ -0,0 +1,40 @@
+# SpecialService
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**outboundCliId** | **number** |  | [optional] [default to undefined]
+**outboundCli** | [**OutboundCli**](OutboundCli.md) |  | [default to undefined]
+**baseService** | [**BaseService**](BaseService.md) |  | [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+**startPeriod** | **string** |  | [default to undefined]
+**endPeriod** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SpecialService } from 'yellowgrid-api-ts';
+
+const instance: SpecialService = {
+    createdDate,
+    id,
+    outboundCliId,
+    outboundCli,
+    baseService,
+    customerRate,
+    description,
+    hideOnInvoice,
+    startPeriod,
+    endPeriod,
+    filePeriod,
+};
+```
+
+[[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/TariffRate.md

@@ -0,0 +1,30 @@
+# TariffRate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**markup** | [**CustomerRateType**](CustomerRateType.md) |  | [optional] [default to undefined]
+**day** | **number** |  | [optional] [default to undefined]
+**evening** | **number** |  | [optional] [default to undefined]
+**weekend** | **number** |  | [optional] [default to undefined]
+**minimum** | **number** |  | [optional] [default to undefined]
+**setup** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TariffRate } from 'yellowgrid-api-ts';
+
+const instance: TariffRate = {
+    markup,
+    day,
+    evening,
+    weekend,
+    minimum,
+    setup,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)