@teemill/integrations 0.15.0 → 0.17.0

package/docs/IntegrationsApi.md

@@ -0,0 +1,665 @@
+# IntegrationsApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createAdminIntegrationListing**](#createadminintegrationlisting) | **POST** /v1/integrations/admin/listings | Create integration listing|
+|[**deleteAdminIntegrationListing**](#deleteadminintegrationlisting) | **DELETE** /v1/integrations/admin/listings/{listing} | Delete integration listing|
+|[**getAdminIntegrationListing**](#getadminintegrationlisting) | **GET** /v1/integrations/admin/listings/{listing} | Retrieve integration listing|
+|[**getIntegrationCategories**](#getintegrationcategories) | **GET** /v1/integrations/categories | List integration categories|
+|[**getIntegrationCategory**](#getintegrationcategory) | **GET** /v1/integrations/categories/{category} | Get integration category|
+|[**getIntegrationListing**](#getintegrationlisting) | **GET** /v1/integrations/listings/{listing} | Get integration listing|
+|[**getIntegrationListings**](#getintegrationlistings) | **GET** /v1/integrations/listings | List integration listings|
+|[**getIntegrationProduct**](#getintegrationproduct) | **GET** /v1/integrations/{integration}/products/{product} | Get integration product|
+|[**getIntegrationProducts**](#getintegrationproducts) | **GET** /v1/integrations/{integration}/products | List integration products|
+|[**getIntegrations**](#getintegrations) | **GET** /v1/integrations | List integrations|
+|[**listAdminIntegrationListings**](#listadminintegrationlistings) | **GET** /v1/integrations/admin/listings | List integration listings|
+|[**updateAdminIntegrationListing**](#updateadminintegrationlisting) | **PATCH** /v1/integrations/admin/listings/{listing} | Update integration listing|
+
+# **createAdminIntegrationListing**
+> AdminIntegrationListing createAdminIntegrationListing(createAdminIntegrationListingRequest)
+
+Create a new integration listing
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration,
+    CreateAdminIntegrationListingRequest
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let createAdminIntegrationListingRequest: CreateAdminIntegrationListingRequest; //Create a new integration listing
+
+const { status, data } = await apiInstance.createAdminIntegrationListing(
+    createAdminIntegrationListingRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createAdminIntegrationListingRequest** | **CreateAdminIntegrationListingRequest**| Create a new integration listing | |
+
+
+### Return type
+
+**AdminIntegrationListing**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successfully retrieved a integration listing |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **deleteAdminIntegrationListing**
+> deleteAdminIntegrationListing()
+
+Delete an integration listing
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let listing: string; //Integration listing unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAdminIntegrationListing(
+    listing
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listing** | [**string**] | Integration listing unique identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Listing deleted |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource does not exist |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getAdminIntegrationListing**
+> AdminIntegrationListing getAdminIntegrationListing()
+
+Retrieves a specific integration listing by its slug.
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let listing: string; //Integration listing unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAdminIntegrationListing(
+    listing
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listing** | [**string**] | Integration listing unique identifier | defaults to undefined|
+
+
+### Return type
+
+**AdminIntegrationListing**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a integration listing |  -  |
+|**404** | Resource does not exist |  -  |
+|**401** | Not authorised to access this resource |  -  |
+
+[[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)
+
+# **getIntegrationCategories**
+> IntegrationCategoriesResponse getIntegrationCategories()
+
+List all integration categories
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+const { status, data } = await apiInstance.getIntegrationCategories();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**IntegrationCategoriesResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all categories |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getIntegrationCategory**
+> IntegrationListingsResponse getIntegrationCategory()
+
+Get an integration category
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let category: string; //Categories unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getIntegrationCategory(
+    category
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **category** | [**string**] | Categories unique identifier | defaults to undefined|
+
+
+### Return type
+
+**IntegrationListingsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all integrations |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource does not exist |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getIntegrationListing**
+> IntegrationListing getIntegrationListing()
+
+Get an integration listing
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let listing: string; //Integration listing unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getIntegrationListing(
+    listing
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listing** | [**string**] | Integration listing unique identifier | defaults to undefined|
+
+
+### Return type
+
+**IntegrationListing**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a integration listing |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource does not exist |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getIntegrationListings**
+> IntegrationListingsResponse getIntegrationListings()
+
+List all integration listings
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let project: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getIntegrationListings(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**IntegrationListingsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all integrations |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getIntegrationProduct**
+> IntegrationProduct getIntegrationProduct()
+
+Get a product available for an integration
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let integration: number; //Integrations unique identifier (default to undefined)
+let product: string; //Products unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getIntegrationProduct(
+    integration,
+    product
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **integration** | [**number**] | Integrations unique identifier | defaults to undefined|
+| **product** | [**string**] | Products unique identifier | defaults to undefined|
+
+
+### Return type
+
+**IntegrationProduct**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a product for an integration |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**404** | Resource does not exist |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getIntegrationProducts**
+> IntegrationProductsResponse getIntegrationProducts()
+
+List all products available for an integration
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let integration: number; //Integrations unique identifier (default to undefined)
+let project: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getIntegrationProducts(
+    integration,
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **integration** | [**number**] | Integrations unique identifier | defaults to undefined|
+| **project** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**IntegrationProductsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all products for an integration |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **getIntegrations**
+> IntegrationsResponse getIntegrations()
+
+List all integrations
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+const { status, data } = await apiInstance.getIntegrations();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**IntegrationsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all integrations |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **listAdminIntegrationListings**
+> AdminIntegrationListingsResponse listAdminIntegrationListings()
+
+List all integration listings
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+const { status, data } = await apiInstance.listAdminIntegrationListings();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AdminIntegrationListingsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all integrations |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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)
+
+# **updateAdminIntegrationListing**
+> AdminIntegrationListing updateAdminIntegrationListing(updateAdminIntegrationListingRequest)
+
+Update an integration listing
+
+### Example
+
+```typescript
+import {
+    IntegrationsApi,
+    Configuration,
+    UpdateAdminIntegrationListingRequest
+} from '@teemill/integrations';
+
+const configuration = new Configuration();
+const apiInstance = new IntegrationsApi(configuration);
+
+let listing: string; //Integration listing unique identifier (default to undefined)
+let updateAdminIntegrationListingRequest: UpdateAdminIntegrationListingRequest; //Update an integration listing
+
+const { status, data } = await apiInstance.updateAdminIntegrationListing(
+    listing,
+    updateAdminIntegrationListingRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateAdminIntegrationListingRequest** | **UpdateAdminIntegrationListingRequest**| Update an integration listing | |
+| **listing** | [**string**] | Integration listing unique identifier | defaults to undefined|
+
+
+### Return type
+
+**AdminIntegrationListing**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a integration listing |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource does not exist |  -  |
+|**5XX** | Unknown server error |  -  |
+
+[[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/IntegrationsResponse.md

@@ -0,0 +1,20 @@
+# IntegrationsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrations** | [**Array<Integration>**](Integration.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationsResponse } from '@teemill/integrations';
+
+const instance: IntegrationsResponse = {
+    integrations,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)