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

package/docs/ReasonRequestModel.md

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

@@ -6,10 +6,10 @@ Azure Recordings Backup
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Storage Account Name | [optional] [default to undefined]
-**key** | **string** | Storage Account Key | [optional] [default to undefined]
-**connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
-**sasUrl** | **string** | SAS Url | [optional] [default to undefined]
+**name** | **string** | Storage Account Name | [default to undefined]
+**key** | **string** | Storage Account Key | [default to undefined]
+**connection_string** | **string** | Storage Account Connection String | [default to undefined]
+**sasUrl** | **string** | SAS Url | [default to undefined]
 **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
 
 ## Example

package/docs/RecordingsBackupInfoDTO.md

@@ -6,8 +6,8 @@ Recordings Backup Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |  | [optional] [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |  | [optional] [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
 
 ## Example
 

package/docs/RemoteStorageDTO.md

@@ -6,10 +6,10 @@ Remote Storage
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | AWS ID | [optional] [default to undefined]
-**secret** | **string** | AWS Secret | [optional] [default to undefined]
-**name** | **string** | AWS Bucket Name | [optional] [default to undefined]
-**region** | **string** | AWS Region | [optional] [default to undefined]
+**id** | **string** | AWS ID | [default to undefined]
+**secret** | **string** | AWS Secret | [default to undefined]
+**name** | **string** | AWS Bucket Name | [default to undefined]
+**region** | **string** | AWS Region | [default to undefined]
 
 ## Example
 

package/docs/ReportRequestDTO.md

@@ -6,9 +6,9 @@ Report Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**report** | **string** | Report | [optional] [default to undefined]
-**start** | **string** | Date Time | [optional] [default to undefined]
-**end** | **string** | Date Time | [optional] [default to undefined]
+**report** | **string** | Report | [default to undefined]
+**start** | **string** | Start | [optional] [default to undefined]
+**end** | **string** | End | [optional] [default to undefined]
 **month** | **number** | Month | [optional] [default to undefined]
 **year** | **number** | Year | [optional] [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]

package/docs/ResolutionRequestModel.md

@@ -0,0 +1,21 @@
+# 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/ResourceNotReadyException.md

@@ -6,9 +6,9 @@ Resource Not Ready
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**message** | **string** | Message | [optional] [default to undefined]
-**resourceId** | **string** | Resource ID | [optional] [default to undefined]
-**status** | **string** | Status | [optional] [default to undefined]
+**message** | **string** | Message | [default to undefined]
+**resourceId** | **string** | Resource ID | [default to undefined]
+**status** | **string** | Status | [default to undefined]
 
 ## Example
 

package/docs/RmaCollectionDTO.md

@@ -0,0 +1,27 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,45 @@
+# 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

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,37 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,23 @@
+# RmaReplacementOrderItemDTO
+
+RMA Replacement Order Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,23 @@
+# 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/RootAccessModel.md

@@ -6,9 +6,9 @@ Root Access Model
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**username** | **string** | Username | [optional] [default to undefined]
-**password** | **string** | Password | [optional] [default to undefined]
-**expiryDate** | **string** | Expiry Date | [optional] [default to undefined]
+**username** | **string** | Username | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+**expiryDate** | **string** | Expiry Date | [default to undefined]
 
 ## Example
 

package/docs/S3BucketEntity.md

@@ -6,10 +6,10 @@ S3 Bucket
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | name | [optional] [default to undefined]
-**region** | **string** | region | [optional] [default to undefined]
-**accessKeyId** | **string** | accessKeyId | [optional] [default to undefined]
-**secretAccessKey** | **string** | secretAccessKey | [optional] [default to undefined]
+**name** | **string** | name | [default to undefined]
+**region** | **string** | region | [default to undefined]
+**accessKeyId** | **string** | accessKeyId | [default to undefined]
+**secretAccessKey** | **string** | secretAccessKey | [default to undefined]
 
 ## Example
 

package/docs/ScannedItemModel.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
 **tcxLabel** | **string** | 3CX Label | [optional] [default to undefined]
-**serialNumbers** | **Array<string>** | Serial Numbers | [optional] [default to undefined]
+**serialNumbers** | **Array<string>** | Serial Numbers | [default to undefined]
 **macAddress** | **string** | MAC Address | [optional] [default to undefined]
 
 ## Example

package/docs/ScopeModel.md

@@ -6,8 +6,8 @@ OAuth2 Scope
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | ID | [optional] [default to undefined]
-**description** | **string** | Description | [optional] [default to undefined]
+**id** | **string** | ID | [default to undefined]
+**description** | **string** | Description | [default to undefined]
 
 ## Example
 

package/docs/SerialNumberRequestModel.md

@@ -0,0 +1,21 @@
+# 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/docs/SeriesDTO.md

@@ -6,10 +6,10 @@ Graph Series Data
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Name | [optional] [default to undefined]
-**type** | **string** | Type | [optional] [default to undefined]
+**name** | **string** | Name | [default to undefined]
+**type** | **string** | Type | [default to undefined]
 **stack** | **string** | Stack | [optional] [default to undefined]
-**data** | **Array<string>** | Data | [optional] [default to undefined]
+**data** | **Array<string>** | Data | [default to undefined]
 
 ## Example
 

package/docs/ServiceHealthDTO.md

@@ -6,8 +6,8 @@ Service Health DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) |  | [optional] [default to undefined]
-**globalStatus** | **number** |  | [optional] [default to undefined]
+**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) |  | [default to undefined]
+**globalStatus** | **number** |  | [default to undefined]
 
 ## Example
 

package/docs/ServiceStatusDTO.md

@@ -6,10 +6,10 @@ Service Status DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**statusName** | **string** | Service Status Description | [optional] [default to undefined]
-**name** | **string** | Service Name | [optional] [default to undefined]
-**status** | **string** | Service Status | [optional] [default to undefined]
-**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [optional] [default to undefined]
+**statusName** | **string** | Service Status Description | [default to undefined]
+**name** | **string** | Service Name | [default to undefined]
+**status** | **string** | Service Status | [default to undefined]
+**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [default to undefined]
 
 ## Example