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

package/docs/SupplierItemModel.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **itemPrice** | **number** | itemPrice | [optional] [default to undefined]
 **itemType** | **number** | itemType | [optional] [default to undefined]
 **supplierSku** | **string** | supplierSku | [optional] [default to undefined]
+**supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -29,6 +30,7 @@ const instance: SupplierItemModel = {
     itemPrice,
     itemType,
     supplierSku,
+    supplier,
 };
 ```
 

package/docs/SupplierItemsResultsDTO.md

@@ -0,0 +1,21 @@
+# SupplierItemsResultsDTO
+
+Supplier Item Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierItemsResultsDTO } from 'yellowgrid-api-ts';
+
+const instance: SupplierItemsResultsDTO = {
+    results,
+};
+```
+
+[[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/SupplierProductModel.md

@@ -0,0 +1,25 @@
+# SupplierProductModel
+
+Supplier Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**description** | **string** | Description | [optional] [default to undefined]
+**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierProductModel } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductModel = {
+    sku,
+    description,
+    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/SupplierProductResultsModel.md

@@ -0,0 +1,27 @@
+# SupplierProductResultsModel
+
+Supplier Product Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SupplierProductModel>**](SupplierProductModel.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 { SupplierProductResultsModel } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductResultsModel = {
+    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/SuppliersApi.md

@@ -0,0 +1,230 @@
+# SuppliersApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetSupplierItem**](#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item|
+|[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
+|[**getGetSuppliers**](#getgetsuppliers) | **GET** /suppliers | Get Suppliers|
+|[**putGetSupplierItem**](#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product|
+
+# **getGetSupplierItem**
+> SupplierProductModel getGetSupplierItem()
+
+Get Supplier Item
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+let id: string; //ID (SKU) (default to undefined)
+
+const { status, data } = await apiInstance.getGetSupplierItem(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID (SKU) | defaults to undefined|
+
+
+### Return type
+
+**SupplierProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Item |  -  |
+|**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)
+
+# **getGetSupplierItems**
+> SupplierProductResultsModel getGetSupplierItems()
+
+Get Supplier Items
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetSupplierItems(
+    pageSize,
+    page,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**SupplierProductResultsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Items |  -  |
+|**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)
+
+# **getGetSuppliers**
+> Array<SupplierModel> getGetSuppliers()
+
+Get Suppliers
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+const { status, data } = await apiInstance.getGetSuppliers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SupplierModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Suppliers |  -  |
+|**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)
+
+# **putGetSupplierItem**
+> SupplierProductModel putGetSupplierItem()
+
+Update Supplier Product
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration,
+    SupplierProductModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+let id: string; //ID (SKU) (default to undefined)
+let supplierProductModel: SupplierProductModel; //Supplier Product (optional)
+
+const { status, data } = await apiInstance.putGetSupplierItem(
+    id,
+    supplierProductModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supplierProductModel** | **SupplierProductModel**| Supplier Product | |
+| **id** | [**string**] | ID (SKU) | defaults to undefined|
+
+
+### Return type
+
+**SupplierProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Product 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/SystemApi.md

@@ -1,6 +1,6 @@
 # SystemApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/TableDTO.md

@@ -0,0 +1,25 @@
+# TableDTO
+
+Table
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
+**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [optional] [default to undefined]
+**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableDTO } from 'yellowgrid-api-ts';
+
+const instance: TableDTO = {
+    title,
+    headers,
+    rows,
+};
+```
+
+[[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/TableDataDTO.md

@@ -0,0 +1,21 @@
+# TableDataDTO
+
+Table Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **string** | Value | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableDataDTO } from 'yellowgrid-api-ts';
+
+const instance: TableDataDTO = {
+    value,
+};
+```
+
+[[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/TableRowDTO.md

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

@@ -7,6 +7,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **wizardId** | **string** | Wizard ID | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
 **instanceId** | **string** | Instance ID | [optional] [default to undefined]
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **endUser** | **string** | End User | [optional] [default to undefined]
@@ -45,6 +46,7 @@ import { TcxInstallationModel } from 'yellowgrid-api-ts';
 
 const instance: TcxInstallationModel = {
     wizardId,
+    customerId,
     instanceId,
     licenceKey,
     endUser,

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/WebhooksApi.md

@@ -1,6 +1,6 @@
 # WebhooksApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/getEnums.php

@@ -1,31 +1,31 @@
-<?php
-
-use App\Contracts\Enums\PublicEnumInterface;
-
-require_once __DIR__."/../../../../vendor/autoload.php";
-
-$dir = __DIR__."/models";
-if (!is_dir($dir)) {
-    mkdir($dir);
-}
-foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
-    $ref = new ReflectionEnum($publicEnum->value);
-    $cases = [];
-    foreach ($ref->getCases() as $c) {
-        /** @var BackedEnum $enum */
-        $enum = $c->getEnum()->getName();
-        $value = $c->getBackingValue();
-        /** @var PublicEnumInterface $case */
-        $case = $enum::from($value);
-        $cases[$c->getName()] = [
-            "name" => $case->name,
-            "value" => $case->value,
-            "publicValue" => $case->getPublicValue()
-        ];
-    }
-    $enumName = $ref->getShortName();
-    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
-    $content = "export const $enumName = $enumString as const;".
-        "\n\n export type $enumName = typeof $enumName;";
-    file_put_contents("$dir/$enumName.ts", $content);
-}
+<?php
+
+use App\Contracts\Enums\PublicEnumInterface;
+
+require_once __DIR__."/../../../../vendor/autoload.php";
+
+$dir = __DIR__."/models";
+if (!is_dir($dir)) {
+    mkdir($dir);
+}
+foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
+    $ref = new ReflectionEnum($publicEnum->value);
+    $cases = [];
+    foreach ($ref->getCases() as $c) {
+        /** @var BackedEnum $enum */
+        $enum = $c->getEnum()->getName();
+        $value = $c->getBackingValue();
+        /** @var PublicEnumInterface $case */
+        $case = $enum::from($value);
+        $cases[$c->getName()] = [
+            "name" => $case->name,
+            "value" => $case->value,
+            "publicValue" => $case->getPublicValue()
+        ];
+    }
+    $enumName = $ref->getShortName();
+    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
+    $content = "export const $enumName = $enumString as const;".
+        "\n\n export type $enumName = typeof $enumName;";
+    file_put_contents("$dir/$enumName.ts", $content);
+}

package/index.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Yellowgrid
- * Welcome to the Yellowgrid API documentation.    This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.    ## Key Features:   - **Accounts**: View and manage account details, contacts, client credentials, and verification.   - **Provisioning**: Automate setup and configuration of devices and groups.   - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.   - **Messaging**: Send SMS messages securely via the messaging gateway.   - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.    ## Authentication:   The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.          ## Base URL:   `https://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/models/GraphTypeEnum.ts

@@ -0,0 +1,14 @@
+export const GraphTypeEnum = {
+    "STACKED": {
+        "name": "STACKED",
+        "value": "stacked-area",
+        "publicValue": "Stacked Area"
+    },
+    "TABLE": {
+        "name": "TABLE",
+        "value": "table",
+        "publicValue": "Table"
+    }
+} as const;
+
+ export type GraphTypeEnum = typeof GraphTypeEnum;

package/models/HostingPriceListEnum.ts

@@ -28,6 +28,11 @@ export const HostingPriceListEnum = {
         "name": "HOSTING_WHOLESALE",
         "value": 6,
         "publicValue": "Hosting Only (Wholesale)"
+    },
+    "HOSTING_ITSP": {
+        "name": "HOSTING_ITSP",
+        "value": 7,
+        "publicValue": "Hosting Only (ITSP)"
     }
 } as const;
 

package/models/ReportEnum.ts

@@ -0,0 +1,54 @@
+export const ReportEnum = {
+    "STOCK": {
+        "name": "STOCK",
+        "value": 1,
+        "publicValue": "Stock"
+    },
+    "POS": {
+        "name": "POS",
+        "value": 2,
+        "publicValue": "POS"
+    },
+    "CUSTOMER_SPEND": {
+        "name": "CUSTOMER_SPEND",
+        "value": 3,
+        "publicValue": "Customer Spend"
+    },
+    "MONTHLY_SALES": {
+        "name": "MONTHLY_SALES",
+        "value": 4,
+        "publicValue": "Monthly Sales"
+    },
+    "CUSTOMER_ANNUAL_COMPARISON": {
+        "name": "CUSTOMER_ANNUAL_COMPARISON",
+        "value": 5,
+        "publicValue": "Customer Annual Comparison"
+    },
+    "LOW_STOCK": {
+        "name": "LOW_STOCK",
+        "value": 6,
+        "publicValue": "Low Stock"
+    },
+    "LEAGUE_TABLE": {
+        "name": "LEAGUE_TABLE",
+        "value": 7,
+        "publicValue": "League Table"
+    },
+    "REVENUE": {
+        "name": "REVENUE",
+        "value": 8,
+        "publicValue": "Revenue"
+    },
+    "EXPENDITURE": {
+        "name": "EXPENDITURE",
+        "value": 9,
+        "publicValue": "Expenditure"
+    },
+    "TECH_SUPPORT_CUSTOMERS": {
+        "name": "TECH_SUPPORT_CUSTOMERS",
+        "value": 10,
+        "publicValue": "Tech Support Customers"
+    }
+} as const;
+
+ export type ReportEnum = typeof ReportEnum;

package/models/RmaStatusEnum.ts

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

package/openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "7.23.0"
+    "version": "7.24.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.217",
+  "version": "3.2.218-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -22,7 +22,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "axios": "^1.16.0"
+    "axios": "1.18.1"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",