@handsondigital/idplugger-admin 2.0.2 → 2.1.0

package/docs/ApiLogsApi.md

@@ -0,0 +1,113 @@
+# ApiLogsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminLogsGet**](#adminlogsget) | **GET** /admin/logs | List API logs|
+|[**adminLogsIdGet**](#adminlogsidget) | **GET** /admin/logs/{id} | Get specific API log|
+
+# **adminLogsGet**
+> ApiLogPaginated adminLogsGet()
+
+
+### Example
+
+```typescript
+import {
+    ApiLogsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ApiLogsApi(configuration);
+
+let q: string; //Search text (optional) (default to undefined)
+let date: string; //Filter by date (YYYY-MM-DD) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminLogsGet(
+    q,
+    date
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **q** | [**string**] | Search text | (optional) defaults to undefined|
+| **date** | [**string**] | Filter by date (YYYY-MM-DD) | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiLogPaginated**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+
+[[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)
+
+# **adminLogsIdGet**
+> ApiLog adminLogsIdGet()
+
+
+### Example
+
+```typescript
+import {
+    ApiLogsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ApiLogsApi(configuration);
+
+let id: number; // (default to undefined)
+
+const { status, data } = await apiInstance.adminLogsIdGet(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**ApiLog**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**404** | Not found |  -  |
+
+[[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/ErrorReport.md

@@ -0,0 +1,34 @@
+# ErrorReport
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**trace** | **string** |  | [optional] [default to undefined]
+**exception_class** | **string** |  | [optional] [default to undefined]
+**file** | **string** |  | [optional] [default to undefined]
+**line** | **number** |  | [optional] [default to undefined]
+**context** | **object** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorReport } from '@handsondigital/idplugger-admin';
+
+const instance: ErrorReport = {
+    id,
+    message,
+    trace,
+    exception_class,
+    file,
+    line,
+    context,
+    created_at,
+};
+```
+
+[[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/ErrorReportPaginated.md

@@ -0,0 +1,22 @@
+# ErrorReportPaginated
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**result** | [**ErrorReportPaginatedResult**](ErrorReportPaginatedResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorReportPaginated } from '@handsondigital/idplugger-admin';
+
+const instance: ErrorReportPaginated = {
+    message,
+    result,
+};
+```
+
+[[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/ErrorReportPaginatedResult.md

@@ -0,0 +1,28 @@
+# ErrorReportPaginatedResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ErrorReport>**](ErrorReport.md) |  | [optional] [default to undefined]
+**current_page** | **number** |  | [optional] [default to undefined]
+**last_page** | **number** |  | [optional] [default to undefined]
+**per_page** | **number** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorReportPaginatedResult } from '@handsondigital/idplugger-admin';
+
+const instance: ErrorReportPaginatedResult = {
+    data,
+    current_page,
+    last_page,
+    per_page,
+    total,
+};
+```
+
+[[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/ErrorReportsApi.md

@@ -0,0 +1,168 @@
+# ErrorReportsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminErrorsGet**](#adminerrorsget) | **GET** /admin/errors | List error reports|
+|[**adminErrorsIdDelete**](#adminerrorsiddelete) | **DELETE** /admin/errors/{id} | Delete error report|
+|[**adminErrorsIdGet**](#adminerrorsidget) | **GET** /admin/errors/{id} | Get specific error report|
+
+# **adminErrorsGet**
+> ErrorReportPaginated adminErrorsGet()
+
+
+### Example
+
+```typescript
+import {
+    ErrorReportsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ErrorReportsApi(configuration);
+
+let q: string; //Search through id, message, exception class, file (optional) (default to undefined)
+let _class: string; //Filter by exception class (optional) (default to undefined)
+let date: string; //Filter by date (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminErrorsGet(
+    q,
+    _class,
+    date
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **q** | [**string**] | Search through id, message, exception class, file | (optional) defaults to undefined|
+| **_class** | [**string**] | Filter by exception class | (optional) defaults to undefined|
+| **date** | [**string**] | Filter by date | (optional) defaults to undefined|
+
+
+### Return type
+
+**ErrorReportPaginated**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+
+[[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)
+
+# **adminErrorsIdDelete**
+> SuccessResponse adminErrorsIdDelete()
+
+
+### Example
+
+```typescript
+import {
+    ErrorReportsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ErrorReportsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminErrorsIdDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Deleted |  -  |
+|**404** | Not found |  -  |
+
+[[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)
+
+# **adminErrorsIdGet**
+> ErrorReport adminErrorsIdGet()
+
+
+### Example
+
+```typescript
+import {
+    ErrorReportsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ErrorReportsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminErrorsIdGet(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ErrorReport**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**404** | Not found |  -  |
+
+[[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/ErrorResponse.md

@@ -0,0 +1,22 @@
+# ErrorResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**errors** | **{ [key: string]: Array<string>; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorResponse } from '@handsondigital/idplugger-admin';
+
+const instance: ErrorResponse = {
+    message,
+    errors,
+};
+```
+
+[[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/PromotionApi.md

@@ -47,7 +47,7 @@ const { status, data } = await apiInstance.adminPromotionCacheClear(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/docs/SuccessResponse.md

@@ -0,0 +1,20 @@
+# SuccessResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SuccessResponse } from '@handsondigital/idplugger-admin';
+
+const instance: SuccessResponse = {
+    message,
+};
+```
+
+[[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/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.14.0"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handsondigital/idplugger-admin",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "OpenAPI client for @handsondigital/idplugger-admin",
   "author": "OpenAPI-Generator Contributors",
   "repository": {