yellowgrid-api-ts 3.0.79

package/docs/SMSApi.md

@@ -0,0 +1,66 @@
+# SMSApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**postSendSms**](#postsendsms) | **POST** /messaging/sms/send | |
+
+# **postSendSms**
+> SmsDataModel postSendSms()
+
+Send SMS
+
+### Example
+
+```typescript
+import {
+    SMSApi,
+    Configuration,
+    SmsMessageModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SMSApi(configuration);
+
+let authorization: string; //Bearer Token (default to undefined)
+let smsMessageModel: SmsMessageModel; //SMS Message (optional)
+
+const { status, data } = await apiInstance.postSendSms(
+    authorization,
+    smsMessageModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **smsMessageModel** | **SmsMessageModel**| SMS Message | |
+| **authorization** | [**string**] | Bearer Token | defaults to undefined|
+
+
+### Return type
+
+**SmsDataModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sms Data Model |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ScannedItemModel.md

@@ -0,0 +1,29 @@
+# ScannedItemModel
+
+Item MAC & Serial Details
+
+## Properties
+
+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]
+**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ScannedItemModel } from 'yellowgrid-api-ts';
+
+const instance: ScannedItemModel = {
+    title,
+    sku,
+    tcxLabel,
+    serialNumbers,
+    macAddress,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ScopeModel.md

@@ -0,0 +1,23 @@
+# ScopeModel
+
+OAuth2 Scope
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID | [optional] [default to undefined]
+**description** | **string** | Description | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ScopeModel } from 'yellowgrid-api-ts';
+
+const instance: ScopeModel = {
+    id,
+    description,
+};
+```
+
+[[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/ShipmentAddressEntity.md

@@ -0,0 +1,41 @@
+# ShipmentAddressEntity
+
+ShipmentAddressEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**shipmentId** | **number** | shipmentId | [optional] [default to undefined]
+**shipName** | **string** | shipName | [optional] [default to undefined]
+**shipCompany** | **string** | shipCompany | [optional] [default to undefined]
+**shipAddress1** | **string** | shipAddress1 | [optional] [default to undefined]
+**shipAddress2** | **string** | shipAddress2 | [optional] [default to undefined]
+**shipCity** | **string** | shipCity | [optional] [default to undefined]
+**shipStateRegion** | **string** | shipStateRegion | [optional] [default to undefined]
+**shipPostalCode** | **string** | shipPostalCode | [optional] [default to undefined]
+**shipCountry** | **string** | shipCountry | [optional] [default to undefined]
+**shipPhoneNumber** | **string** | shipPhoneNumber | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShipmentAddressEntity } from 'yellowgrid-api-ts';
+
+const instance: ShipmentAddressEntity = {
+    id,
+    shipmentId,
+    shipName,
+    shipCompany,
+    shipAddress1,
+    shipAddress2,
+    shipCity,
+    shipStateRegion,
+    shipPostalCode,
+    shipCountry,
+    shipPhoneNumber,
+};
+```
+
+[[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/ShipmentEntity.md

@@ -0,0 +1,43 @@
+# ShipmentEntity
+
+ShipmentsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**batchId** | **number** | batchId | [optional] [default to undefined]
+**courier** | **string** | courier | [optional] [default to undefined]
+**courierService** | **string** | courierService | [optional] [default to undefined]
+**courierServiceDesc** | **string** | courierServiceDesc | [optional] [default to undefined]
+**courierReference** | **string** | courierReference | [optional] [default to undefined]
+**courierTracking** | **string** | courierTracking | [optional] [default to undefined]
+**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
+**scannedData** | **string** | mac | [optional] [default to undefined]
+**date** | **string** | date | [optional] [default to undefined]
+**requestDate** | **string** | requestDate | [optional] [default to undefined]
+**provId** | **number** | provId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShipmentEntity } from 'yellowgrid-api-ts';
+
+const instance: ShipmentEntity = {
+    id,
+    batchId,
+    courier,
+    courierService,
+    courierServiceDesc,
+    courierReference,
+    courierTracking,
+    courierBoxes,
+    scannedData,
+    date,
+    requestDate,
+    provId,
+};
+```
+
+[[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/ShipmentItemEntity.md

@@ -0,0 +1,29 @@
+# ShipmentItemEntity
+
+ShipmentItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**shipmentId** | **number** | shipmentId | [optional] [default to undefined]
+**batchId** | **number** | batchId | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
+**itemId** | **string** | item | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShipmentItemEntity } from 'yellowgrid-api-ts';
+
+const instance: ShipmentItemEntity = {
+    id,
+    shipmentId,
+    batchId,
+    quantity,
+    itemId,
+};
+```
+
+[[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/SipTrunkChangeResponseModel.md

@@ -0,0 +1,29 @@
+# SipTrunkChangeResponseModel
+
+Change Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**changeId** | **string** | ID | [optional] [default to undefined]
+**trunk** | [**SipTrunkEntity**](SipTrunkEntity.md) |  | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**progress** | **number** | Progress | [optional] [default to undefined]
+**provider** | **number** | Service Provider | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SipTrunkChangeResponseModel } from 'yellowgrid-api-ts';
+
+const instance: SipTrunkChangeResponseModel = {
+    changeId,
+    trunk,
+    type,
+    progress,
+    provider,
+};
+```
+
+[[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/SipTrunkCreationRequestModel.md

@@ -0,0 +1,31 @@
+# SipTrunkCreationRequestModel
+
+SIP Trunk Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer** | [**CustomerInformationModel**](CustomerInformationModel.md) |  | [optional] [default to undefined]
+**pbxIpAddress** | **string** | PBX IP Address | [optional] [default to '0.0.0.0']
+**channelCount** | **number** | Number of SIP channels | [optional] [default to 2]
+**callBarring** | [**CallBarringModel**](CallBarringModel.md) |  | [optional] [default to undefined]
+**fraudManagement** | [**FraudManagementModel**](FraudManagementModel.md) |  | [optional] [default to undefined]
+**ddiRanges** | [**DdiRangesRequestModel**](DdiRangesRequestModel.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SipTrunkCreationRequestModel } from 'yellowgrid-api-ts';
+
+const instance: SipTrunkCreationRequestModel = {
+    customer,
+    pbxIpAddress,
+    channelCount,
+    callBarring,
+    fraudManagement,
+    ddiRanges,
+};
+```
+
+[[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/SipTrunkEntity.md

@@ -0,0 +1,43 @@
+# SipTrunkEntity
+
+SIP Trunk
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | SIP Trunk ID | [optional] [default to undefined]
+**ownerId** | **number** | Owner ID | [optional] [default to undefined]
+**serviceId** | **number** | Service ID | [optional] [default to undefined]
+**companyName** | **string** | Company Name | [optional] [default to undefined]
+**endpointId** | **string** | Provider Endpoint ID | [optional] [default to undefined]
+**channelCount** | **number** | Number of SIP channels | [optional] [default to undefined]
+**pbxIpAddress** | **string** | PBX IP Address | [optional] [default to undefined]
+**sbcName** | **string** | SBC Name | [optional] [default to undefined]
+**registrarIpAddress** | **string** | SIP Server IP Address | [optional] [default to undefined]
+**mainTrunkNumber** | **string** | Main Trunk Number | [optional] [default to undefined]
+**complete** | **boolean** | Setup Complete | [optional] [default to undefined]
+**owner** | **string** | Owner | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SipTrunkEntity } from 'yellowgrid-api-ts';
+
+const instance: SipTrunkEntity = {
+    id,
+    ownerId,
+    serviceId,
+    companyName,
+    endpointId,
+    channelCount,
+    pbxIpAddress,
+    sbcName,
+    registrarIpAddress,
+    mainTrunkNumber,
+    complete,
+    owner,
+};
+```
+
+[[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/SipTrunksResponseModel.md

@@ -0,0 +1,27 @@
+# SipTrunksResponseModel
+
+SIP Trunks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SipTrunkEntity>**](SipTrunkEntity.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SipTrunksResponseModel } from 'yellowgrid-api-ts';
+
+const instance: SipTrunksResponseModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SmsAccountEntity.md

@@ -0,0 +1,33 @@
+# SmsAccountEntity
+
+SmsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | id | [optional] [default to undefined]
+**provider** | **string** | provider | [optional] [default to undefined]
+**creation** | **string** | creation | [optional] [default to undefined]
+**customerId** | **number** | customerId | [optional] [default to undefined]
+**webhookUrl** | **string** | webhookUrl | [optional] [default to undefined]
+**trunkId** | **number** | trunkId | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsAccountEntity } from 'yellowgrid-api-ts';
+
+const instance: SmsAccountEntity = {
+    id,
+    provider,
+    creation,
+    customerId,
+    webhookUrl,
+    trunkId,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SmsDataModel.md

@@ -0,0 +1,21 @@
+# SmsDataModel
+
+SMS Data Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**SmsResponseModel**](SmsResponseModel.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsDataModel } from 'yellowgrid-api-ts';
+
+const instance: SmsDataModel = {
+    data,
+};
+```
+
+[[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/SmsMessageModel.md

@@ -0,0 +1,25 @@
+# SmsMessageModel
+
+SMS Message
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **string** | From Phone Number | [optional] [default to undefined]
+**to** | **string** | To Phone Number | [optional] [default to undefined]
+**text** | **string** | SMS Message | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsMessageModel } from 'yellowgrid-api-ts';
+
+const instance: SmsMessageModel = {
+    from,
+    to,
+    text,
+};
+```
+
+[[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/SmsNumbersEntity.md

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

@@ -0,0 +1,25 @@
+# SmsPayloadModel
+
+SMS Payload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) |  | [optional] [default to undefined]
+**from** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) |  | [optional] [default to undefined]
+**id** | **string** | Message ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsPayloadModel } from 'yellowgrid-api-ts';
+
+const instance: SmsPayloadModel = {
+    to,
+    from,
+    id,
+};
+```
+
+[[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/SmsPhoneNumberModel.md

@@ -0,0 +1,23 @@
+# SmsPhoneNumberModel
+
+SMS Phone Number
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **string** | Phone Number | [optional] [default to undefined]
+**status** | **string** | status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsPhoneNumberModel } from 'yellowgrid-api-ts';
+
+const instance: SmsPhoneNumberModel = {
+    phone_number,
+    status,
+};
+```
+
+[[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/SmsResponseModel.md

@@ -0,0 +1,29 @@
+# SmsResponseModel
+
+SMS Response Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) |  | [optional] [default to undefined]
+**from** | [**SmsPhoneNumberModel**](SmsPhoneNumberModel.md) |  | [optional] [default to undefined]
+**id** | **string** | Message Id | [optional] [default to undefined]
+**event_type** | **string** | Event Type | [optional] [default to undefined]
+**payload** | [**SmsPayloadModel**](SmsPayloadModel.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsResponseModel } from 'yellowgrid-api-ts';
+
+const instance: SmsResponseModel = {
+    to,
+    from,
+    id,
+    event_type,
+    payload,
+};
+```
+
+[[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/SmsWhitelistEntity.md

@@ -0,0 +1,23 @@
+# SmsWhitelistEntity
+
+SmsWhitelistEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**smsId** | **string** | smsId | [optional] [default to undefined]
+**fqdn** | **string** | fqdn | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsWhitelistEntity } from 'yellowgrid-api-ts';
+
+const instance: SmsWhitelistEntity = {
+    smsId,
+    fqdn,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)