@teemill/integrations 0.16.0 → 0.17.0

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/integrations';
+
+const instance: ApiError = {
+    code,
+    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/docs/CreateAdminIntegrationListingRequest.md

@@ -0,0 +1,42 @@
+# CreateAdminIntegrationListingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the integration listing | [default to undefined]
+**description** | **string** | The description of the integration listing | [default to undefined]
+**content** | **string** | The html content of the integration listing | [default to undefined]
+**pricing** | **string** | The html content of the pricing information | [optional] [default to undefined]
+**author** | **string** | The author of the integration listing | [default to undefined]
+**integration** | **string** | The code of the integration | [default to undefined]
+**slug** | **string** | The slug of the integration listing that is used in the URL | [default to undefined]
+**gradient** | [**CreateAdminIntegrationListingRequestGradient**](CreateAdminIntegrationListingRequestGradient.md) |  | [default to undefined]
+**icon** | **string** | The icon of the integration listing | [default to undefined]
+**categories** | **Array<string>** | The categories that this listing belongs to | [default to undefined]
+**menuTitle** | **string** | The string identifier displayed in the UI menu | [optional] [default to undefined]
+**menuSortOrder** | **number** | The order of the listing in the UI menu | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateAdminIntegrationListingRequest } from '@teemill/integrations';
+
+const instance: CreateAdminIntegrationListingRequest = {
+    name,
+    description,
+    content,
+    pricing,
+    author,
+    integration,
+    slug,
+    gradient,
+    icon,
+    categories,
+    menuTitle,
+    menuSortOrder,
+};
+```
+
+[[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/CreateAdminIntegrationListingRequestGradient.md

@@ -0,0 +1,25 @@
+# CreateAdminIntegrationListingRequestGradient
+
+The gradient that is used to display the listing
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **string** |  | [default to undefined]
+**to** | **string** |  | [default to undefined]
+**angle** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateAdminIntegrationListingRequestGradient } from '@teemill/integrations';
+
+const instance: CreateAdminIntegrationListingRequestGradient = {
+    from,
+    to,
+    angle,
+};
+```
+
+[[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/Icon.md

@@ -0,0 +1,24 @@
+# Icon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **string** |  | [default to undefined]
+**iconName** | **string** |  | [default to undefined]
+**icon** | **Array<any>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Icon } from '@teemill/integrations';
+
+const instance: Icon = {
+    prefix,
+    iconName,
+    icon,
+};
+```
+
+[[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/Integration.md

@@ -0,0 +1,26 @@
+# Integration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**code** | **string** | The code of the integration | [optional] [default to undefined]
+**config** | **{ [key: string]: string; }** | The configuration of the integration | [optional] [default to undefined]
+**icon** | **any** | The icon of the integration | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Integration } from '@teemill/integrations';
+
+const instance: Integration = {
+    id,
+    code,
+    config,
+    icon,
+};
+```
+
+[[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/IntegrationCategoriesResponse.md

@@ -0,0 +1,20 @@
+# IntegrationCategoriesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**categories** | [**Array<IntegrationCategory>**](IntegrationCategory.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationCategoriesResponse } from '@teemill/integrations';
+
+const instance: IntegrationCategoriesResponse = {
+    categories,
+};
+```
+
+[[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/IntegrationCategory.md

@@ -0,0 +1,24 @@
+# IntegrationCategory
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the category | [default to undefined]
+**slug** | **string** | The slug of the category that is used in the URL | [default to undefined]
+**type** | **string** | The type of category, used to determine how it is displayed | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationCategory } from '@teemill/integrations';
+
+const instance: IntegrationCategory = {
+    name,
+    slug,
+    type,
+};
+```
+
+[[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/IntegrationListing.md

@@ -0,0 +1,46 @@
+# IntegrationListing
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**slug** | **string** | The slug of the integration listing that is used in the URL | [default to undefined]
+**code** | **string** | The code of the integration | [default to undefined]
+**name** | **string** | The name of the integration listing | [default to undefined]
+**description** | **string** | The description of the integration listing | [default to undefined]
+**content** | **string** | The html content of the integration listing | [default to undefined]
+**pricing** | **string** | The html content of the pricing information | [optional] [default to undefined]
+**author** | **string** | The author of the integration listing | [default to undefined]
+**icon** | [**Icon**](Icon.md) |  | [default to undefined]
+**gradient** | [**IntegrationListingGradient**](IntegrationListingGradient.md) |  | [default to undefined]
+**dependencies** | **Array<string>** | The dependencies that this integration listing requires | [default to undefined]
+**categories** | [**Array<IntegrationCategory>**](IntegrationCategory.md) | The categories that this listing belongs to | [default to undefined]
+**menuTitle** | **string** | The string identifier displayed in the UI menu | [optional] [default to undefined]
+**menuSortOrder** | **number** | The order of the listing in the UI menu | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationListing } from '@teemill/integrations';
+
+const instance: IntegrationListing = {
+    id,
+    slug,
+    code,
+    name,
+    description,
+    content,
+    pricing,
+    author,
+    icon,
+    gradient,
+    dependencies,
+    categories,
+    menuTitle,
+    menuSortOrder,
+};
+```
+
+[[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/IntegrationListingGradient.md

@@ -0,0 +1,25 @@
+# IntegrationListingGradient
+
+The gradient that is used to display the listing
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **string** |  | [optional] [default to undefined]
+**to** | **string** |  | [optional] [default to undefined]
+**angle** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationListingGradient } from '@teemill/integrations';
+
+const instance: IntegrationListingGradient = {
+    from,
+    to,
+    angle,
+};
+```
+
+[[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/IntegrationListingsResponse.md

@@ -0,0 +1,20 @@
+# IntegrationListingsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**listings** | [**Array<IntegrationListing>**](IntegrationListing.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationListingsResponse } from '@teemill/integrations';
+
+const instance: IntegrationListingsResponse = {
+    listings,
+};
+```
+
+[[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/IntegrationProduct.md

@@ -0,0 +1,30 @@
+# IntegrationProduct
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | The ID of the product | [optional] [readonly] [default to undefined]
+**sku** | **string** | The SKU of the product | [default to undefined]
+**name** | **string** | The name of the product | [default to undefined]
+**slug** | **string** | The slug of the product that is used in the URL | [default to undefined]
+**description** | **string** | The user facing description of the product | [default to undefined]
+**price** | **number** | The price of the product in GBP | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationProduct } from '@teemill/integrations';
+
+const instance: IntegrationProduct = {
+    id,
+    sku,
+    name,
+    slug,
+    description,
+    price,
+};
+```
+
+[[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/IntegrationProductsResponse.md

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