yellowgrid-api-ts 3.0.79

package/docs/ProvisioningApi.md

@@ -0,0 +1,402 @@
+# ProvisioningApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteAddFanvilMac**](#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group|
+|[**deleteDeleteFanvilGroup**](#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS|
+|[**getGetFanvilEncryptionKey**](#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key|
+|[**getGetFanvilGroupMacs**](#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS|
+|[**getGetGroups**](#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID|
+|[**postAddFanvilGroup**](#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS|
+|[**postAddFanvilMac**](#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group|
+
+# **deleteAddFanvilMac**
+> deleteAddFanvilMac()
+
+Remove MAC address from DB and FDPS group
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.deleteAddFanvilMac(
+    id,
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group ID | defaults to undefined|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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)
+
+# **deleteDeleteFanvilGroup**
+> deleteDeleteFanvilGroup()
+
+Delete a Fanvil provisioning group
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteFanvilGroup(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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)
+
+# **getGetFanvilEncryptionKey**
+> string getGetFanvilEncryptionKey()
+
+Get group Fanvil encryption key
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.getGetFanvilEncryptionKey(
+    id,
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group ID | defaults to undefined|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | string |  -  |
+|**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)
+
+# **getGetFanvilGroupMacs**
+> Array<string> getGetFanvilGroupMacs()
+
+Get MAC addresses on group at FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetFanvilGroupMacs(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group ID | defaults to undefined|
+
+
+### Return type
+
+**Array<string>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | [string] |  -  |
+|**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)
+
+# **getGetGroups**
+> Array<ProvisioningEntity> getGetGroups()
+
+Get provisioning groups
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let id: string; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetGroups(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<ProvisioningEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Provisioning Groups |  -  |
+|**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)
+
+# **postAddFanvilGroup**
+> ProvisioningEntity postAddFanvilGroup()
+
+Create a Fanvil provisioning group
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration,
+    ProvisioningRequestEntity
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let provisioningRequestEntity: ProvisioningRequestEntity; //Provisioning Group Request (optional)
+
+const { status, data } = await apiInstance.postAddFanvilGroup(
+    provisioningRequestEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **provisioningRequestEntity** | **ProvisioningRequestEntity**| Provisioning Group Request | |
+
+
+### Return type
+
+**ProvisioningEntity**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Provisioning Group |  -  |
+|**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)
+
+# **postAddFanvilMac**
+> postAddFanvilMac()
+
+Add MAC address to DB and FDPS group
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.postAddFanvilMac(
+    id,
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group ID | defaults to undefined|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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/ProvisioningEntity.md

@@ -0,0 +1,29 @@
+# ProvisioningEntity
+
+Provisioning Group
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
+**auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
+**id** | **number** | Provisioning Group ID | [optional] [default to undefined]
+**customerId** | **number** | Owner ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProvisioningEntity } from 'yellowgrid-api-ts';
+
+const instance: ProvisioningEntity = {
+    groupName,
+    provisioningUrl,
+    auth,
+    id,
+    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/ProvisioningRequestEntity.md

@@ -0,0 +1,25 @@
+# ProvisioningRequestEntity
+
+Provisioning Group Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
+**auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProvisioningRequestEntity } from 'yellowgrid-api-ts';
+
+const instance: ProvisioningRequestEntity = {
+    groupName,
+    provisioningUrl,
+    auth,
+};
+```
+
+[[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

@@ -0,0 +1,25 @@
+# ResourceNotReadyException
+
+Resource Not Ready
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { ResourceNotReadyException } from 'yellowgrid-api-ts';
+
+const instance: ResourceNotReadyException = {
+    message,
+    resourceId,
+    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/RootAccessModel.md

@@ -0,0 +1,25 @@
+# RootAccessModel
+
+Root Access Model
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { RootAccessModel } from 'yellowgrid-api-ts';
+
+const instance: RootAccessModel = {
+    username,
+    password,
+    expiryDate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)