yellowgrid-api-ts 3.2.237-dev.0 → 3.2.238-dev.0

package/docs/ResolutionRequestModel.md

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

@@ -1,27 +0,0 @@
-# RmaCollectionDTO
-
-RMA Collection Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address** | [**AddressDTO**](AddressDTO.md) |  | [default to undefined]
-**boxes** | **number** | Number of boxes | [default to undefined]
-**collectionTimeFrom** | **string** | Date Time | [default to undefined]
-**collectionTimeTo** | **string** | Date Time | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaCollectionDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaCollectionDTO = {
-    address,
-    boxes,
-    collectionTimeFrom,
-    collectionTimeTo,
-};
-```
-
-[[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/RmaCreditItemRequestDTO.md

@@ -1,25 +0,0 @@
-# RmaCreditItemRequestDTO
-
-RMA Credit Request Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rmaItemId** | **number** | RMA Item ID | [default to undefined]
-**refundPercentage** | **number** | Refund Percentage | [default to undefined]
-**returnStock** | **boolean** | Return Item to Stock | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaCreditItemRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaCreditItemRequestDTO = {
-    rmaItemId,
-    refundPercentage,
-    returnStock,
-};
-```
-
-[[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

@@ -1,45 +0,0 @@
-# RmaDTO
-
-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]
-**items** | [**Array<RmaItemDTO>**](RmaItemDTO.md) | RMA Items | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaDTO = {
-    id,
-    contactName,
-    contactEmail,
-    orderId,
-    reason,
-    faultReport,
-    ticketId,
-    resolution,
-    status,
-    statusText,
-    approved,
-    address,
-    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/RmaItemDTO.md

@@ -1,35 +0,0 @@
-# RmaItemDTO
-
-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]
-
-## Example
-
-```typescript
-import { RmaItemDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaItemDTO = {
-    id,
-    itemId,
-    itemName,
-    macAddress,
-    serialNumber,
-    received,
-    status,
-    statusText,
-};
-```
-
-[[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/RmaItemRequestDTO.md

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

@@ -1,29 +0,0 @@
-# RmaOrderDTO
-
-RMA Order
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Order ID | [default to undefined]
-**reference** | **string** | Order Reference | [default to undefined]
-**orderDate** | **string** | Date Time | [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

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

@@ -1,25 +0,0 @@
-# RmaOrderSummaryDTO
-
-RMA Order Summary
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Order ID | [default to undefined]
-**reference** | **string** | Order Reference | [default to undefined]
-**orderDate** | **string** | Date Time | [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/RmaReplacementOrderItemDTO.md

@@ -1,23 +0,0 @@
-# RmaReplacementOrderItemDTO
-
-RMA Replacement Order Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Replaced RMA Item ID | [default to undefined]
-**sku** | **string** | Replacement RMA Item SKU | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaReplacementOrderItemDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaReplacementOrderItemDTO = {
-    id,
-    sku,
-};
-```
-
-[[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/RmaReplacementOrderRequestDTO.md

@@ -1,21 +0,0 @@
-# RmaReplacementOrderRequestDTO
-
-RMA Replacement Order Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**Array<RmaReplacementOrderItemDTO>**](RmaReplacementOrderItemDTO.md) | RMA Replacement Order Items | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaReplacementOrderRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaReplacementOrderRequestDTO = {
-    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/RmaRequestDTO.md

@@ -1,34 +0,0 @@
-# RmaRequestDTO
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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]
-**requestedResolution** | **number** | RMA Resolution | [default to undefined]
-**items** | [**Array<RmaItemRequestDTO>**](RmaItemRequestDTO.md) | RMA Items | [default to undefined]
-**address** | [**AddressDTO**](AddressDTO.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaRequestDTO = {
-    contactName,
-    contactEmail,
-    orderId,
-    reason,
-    faultReport,
-    requestedResolution,
-    items,
-    address,
-};
-```
-
-[[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/RmaReturnDTO.md

@@ -1,31 +0,0 @@
-# RmaReturnDTO
-
-RMA Return Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address** | [**AddressDTO**](AddressDTO.md) |  | [default to undefined]
-**items** | **Array<number>** | RMA Item IDs | [default to undefined]
-**service** | **string** | Shipping Service Code | [default to undefined]
-**boxes** | **number** | Number of boxes to ship | [default to undefined]
-**contactEmail** | **string** | Contact Email | [default to undefined]
-**contactTelephone** | **string** | Contact Telephone | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaReturnDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaReturnDTO = {
-    address,
-    items,
-    service,
-    boxes,
-    contactEmail,
-    contactTelephone,
-};
-```
-
-[[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

@@ -1,31 +0,0 @@
-# RmaSummaryDTO
-
-RMA Summary DTO
-
-## 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]
-
-## Example
-
-```typescript
-import { RmaSummaryDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaSummaryDTO = {
-    id,
-    orderId,
-    orderReference,
-    status,
-    statusText,
-    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/RmaSummaryItemDTO.md

@@ -1,23 +0,0 @@
-# RmaSummaryItemDTO
-
-RMA Item Summary
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**itemName** | **string** | RMA Item Name | [default to undefined]
-**quantity** | **number** | RMA Item Quantity | [default to undefined]
-
-## Example
-
-```typescript
-import { RmaSummaryItemDTO } from 'yellowgrid-api-ts';
-
-const instance: RmaSummaryItemDTO = {
-    itemName,
-    quantity,
-};
-```
-
-[[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/SerialNumberRequestModel.md

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

@@ -1,24 +0,0 @@
-export const ReasonEnum = {
-    "DOA": {
-        "name": "DOA",
-        "value": 1,
-        "publicValue": "Dead On Arrival"
-    },
-    "FAULTY": {
-        "name": "FAULTY",
-        "value": 2,
-        "publicValue": "Faulty"
-    },
-    "WORKING_GOOD_CONDITION": {
-        "name": "WORKING_GOOD_CONDITION",
-        "value": 3,
-        "publicValue": "Working (Good Condition)"
-    },
-    "WORKING_BAD_CONDITION": {
-        "name": "WORKING_BAD_CONDITION",
-        "value": 4,
-        "publicValue": "Working (Bad Condition)"
-    }
-} as const;
-
- export type ReasonEnum = typeof ReasonEnum;

package/models/ResolutionEnum.ts

@@ -1,19 +0,0 @@
-export const ResolutionEnum = {
-    "REPLACEMENT": {
-        "name": "REPLACEMENT",
-        "value": 1,
-        "publicValue": "Replacement"
-    },
-    "CREDIT": {
-        "name": "CREDIT",
-        "value": 2,
-        "publicValue": "Credit"
-    },
-    "ADVANCE_REPLACEMENT": {
-        "name": "ADVANCE_REPLACEMENT",
-        "value": 3,
-        "publicValue": "Advance Replacement"
-    }
-} as const;
-
- export type ResolutionEnum = typeof ResolutionEnum;

package/models/RmaItemCreditTypeEnum.ts

@@ -1,14 +0,0 @@
-export const RmaItemCreditTypeEnum = {
-    "FULL": {
-        "name": "FULL",
-        "value": 100,
-        "publicValue": "Full"
-    },
-    "RESTOCKING_FEE": {
-        "name": "RESTOCKING_FEE",
-        "value": 85,
-        "publicValue": "Restocking Fee"
-    }
-} as const;
-
- export type RmaItemCreditTypeEnum = typeof RmaItemCreditTypeEnum;

package/models/RmaItemResolutionEnum.ts

@@ -1,29 +0,0 @@
-export const RmaItemResolutionEnum = {
-    "UNRESOLVED": {
-        "name": "UNRESOLVED",
-        "value": 1,
-        "publicValue": "Unresolved"
-    },
-    "REPLACED": {
-        "name": "REPLACED",
-        "value": 2,
-        "publicValue": "Replaced"
-    },
-    "CREDITED": {
-        "name": "CREDITED",
-        "value": 3,
-        "publicValue": "Credited"
-    },
-    "RETURNED": {
-        "name": "RETURNED",
-        "value": 4,
-        "publicValue": "Returned"
-    },
-    "BINNED": {
-        "name": "BINNED",
-        "value": 5,
-        "publicValue": "Binned"
-    }
-} as const;
-
- export type RmaItemResolutionEnum = typeof RmaItemResolutionEnum;

package/models/RmaItemStatusEnum.ts

@@ -1,19 +0,0 @@
-export const RmaItemStatusEnum = {
-    "NOT_RECEIVED": {
-        "name": "NOT_RECEIVED",
-        "value": 1,
-        "publicValue": "Not Received"
-    },
-    "IN_PROGRESS": {
-        "name": "IN_PROGRESS",
-        "value": 2,
-        "publicValue": "In Progress"
-    },
-    "RESOLVED": {
-        "name": "RESOLVED",
-        "value": 3,
-        "publicValue": "Resolved"
-    }
-} as const;
-
- export type RmaItemStatusEnum = typeof RmaItemStatusEnum;

package/models/RmaStatusEnum.ts

@@ -1,29 +0,0 @@
-export const RmaStatusEnum = {
-    "OPEN": {
-        "name": "OPEN",
-        "value": 1,
-        "publicValue": "Open"
-    },
-    "AWAITING_ITEMS": {
-        "name": "AWAITING_ITEMS",
-        "value": 2,
-        "publicValue": "Awaiting Items"
-    },
-    "IN_PROGRESS": {
-        "name": "IN_PROGRESS",
-        "value": 3,
-        "publicValue": "In Progress"
-    },
-    "RESOLVED": {
-        "name": "RESOLVED",
-        "value": 4,
-        "publicValue": "Resolved"
-    },
-    "REJECTED": {
-        "name": "REJECTED",
-        "value": 5,
-        "publicValue": "Rejected"
-    }
-} as const;
-
- export type RmaStatusEnum = typeof RmaStatusEnum;