@teemill/integrations 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +64 -2
  2. package/api.ts +50 -13
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +32 -7
  7. package/dist/api.js +27 -13
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +32 -7
  15. package/dist/esm/api.js +27 -13
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/AdminIntegrationListing.md +48 -0
  27. package/docs/AdminIntegrationListingsResponse.md +20 -0
  28. package/docs/ApiError.md +22 -0
  29. package/docs/CreateAdminIntegrationListingRequest.md +42 -0
  30. package/docs/CreateAdminIntegrationListingRequestGradient.md +25 -0
  31. package/docs/Icon.md +24 -0
  32. package/docs/Integration.md +26 -0
  33. package/docs/IntegrationCategoriesResponse.md +20 -0
  34. package/docs/IntegrationCategory.md +24 -0
  35. package/docs/IntegrationListing.md +46 -0
  36. package/docs/IntegrationListingGradient.md +25 -0
  37. package/docs/IntegrationListingsResponse.md +20 -0
  38. package/docs/IntegrationProduct.md +30 -0
  39. package/docs/IntegrationProductsResponse.md +20 -0
  40. package/docs/IntegrationsApi.md +665 -0
  41. package/docs/IntegrationsResponse.md +20 -0
  42. package/docs/UpdateAdminIntegrationListingRequest.md +42 -0
  43. package/docs/UpdateAdminIntegrationListingRequestGradient.md +25 -0
  44. package/index.ts +1 -1
  45. package/package.json +1 -1
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Integrations API
3
3
  * Manage PodOS Integrations
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -705,10 +705,11 @@ export declare const IntegrationsApiAxiosParamCreator: (configuration?: Configur
705
705
  /**
706
706
  * List all integration listings
707
707
  * @summary List integration listings
708
+ * @param {string} project
708
709
  * @param {*} [options] Override http request option.
709
710
  * @throws {RequiredError}
710
711
  */
711
- getIntegrationListings: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
712
+ getIntegrationListings: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
712
713
  /**
713
714
  * Get a product available for an integration
714
715
  * @summary Get integration product
@@ -722,10 +723,11 @@ export declare const IntegrationsApiAxiosParamCreator: (configuration?: Configur
722
723
  * List all products available for an integration
723
724
  * @summary List integration products
724
725
  * @param {number} integration Integrations unique identifier
726
+ * @param {string} [project]
725
727
  * @param {*} [options] Override http request option.
726
728
  * @throws {RequiredError}
727
729
  */
728
- getIntegrationProducts: (integration: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
730
+ getIntegrationProducts: (integration: number, project?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
729
731
  /**
730
732
  * List all integrations
731
733
  * @summary List integrations
@@ -805,10 +807,11 @@ export declare const IntegrationsApiFp: (configuration?: Configuration) => {
805
807
  /**
806
808
  * List all integration listings
807
809
  * @summary List integration listings
810
+ * @param {string} project
808
811
  * @param {*} [options] Override http request option.
809
812
  * @throws {RequiredError}
810
813
  */
811
- getIntegrationListings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationListingsResponse>>;
814
+ getIntegrationListings(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationListingsResponse>>;
812
815
  /**
813
816
  * Get a product available for an integration
814
817
  * @summary Get integration product
@@ -822,10 +825,11 @@ export declare const IntegrationsApiFp: (configuration?: Configuration) => {
822
825
  * List all products available for an integration
823
826
  * @summary List integration products
824
827
  * @param {number} integration Integrations unique identifier
828
+ * @param {string} [project]
825
829
  * @param {*} [options] Override http request option.
826
830
  * @throws {RequiredError}
827
831
  */
828
- getIntegrationProducts(integration: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationProductsResponse>>;
832
+ getIntegrationProducts(integration: number, project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntegrationProductsResponse>>;
829
833
  /**
830
834
  * List all integrations
831
835
  * @summary List integrations
@@ -905,10 +909,11 @@ export declare const IntegrationsApiFactory: (configuration?: Configuration, bas
905
909
  /**
906
910
  * List all integration listings
907
911
  * @summary List integration listings
912
+ * @param {IntegrationsApiGetIntegrationListingsRequest} requestParameters Request parameters.
908
913
  * @param {*} [options] Override http request option.
909
914
  * @throws {RequiredError}
910
915
  */
911
- getIntegrationListings(options?: RawAxiosRequestConfig): AxiosPromise<IntegrationListingsResponse>;
916
+ getIntegrationListings(requestParameters: IntegrationsApiGetIntegrationListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<IntegrationListingsResponse>;
912
917
  /**
913
918
  * Get a product available for an integration
914
919
  * @summary Get integration product
@@ -1013,6 +1018,19 @@ export interface IntegrationsApiGetIntegrationListingRequest {
1013
1018
  */
1014
1019
  readonly listing: string;
1015
1020
  }
1021
+ /**
1022
+ * Request parameters for getIntegrationListings operation in IntegrationsApi.
1023
+ * @export
1024
+ * @interface IntegrationsApiGetIntegrationListingsRequest
1025
+ */
1026
+ export interface IntegrationsApiGetIntegrationListingsRequest {
1027
+ /**
1028
+ *
1029
+ * @type {string}
1030
+ * @memberof IntegrationsApiGetIntegrationListings
1031
+ */
1032
+ readonly project: string;
1033
+ }
1016
1034
  /**
1017
1035
  * Request parameters for getIntegrationProduct operation in IntegrationsApi.
1018
1036
  * @export
@@ -1044,6 +1062,12 @@ export interface IntegrationsApiGetIntegrationProductsRequest {
1044
1062
  * @memberof IntegrationsApiGetIntegrationProducts
1045
1063
  */
1046
1064
  readonly integration: number;
1065
+ /**
1066
+ *
1067
+ * @type {string}
1068
+ * @memberof IntegrationsApiGetIntegrationProducts
1069
+ */
1070
+ readonly project?: string;
1047
1071
  }
1048
1072
  /**
1049
1073
  * Request parameters for updateAdminIntegrationListing operation in IntegrationsApi.
@@ -1127,11 +1151,12 @@ export declare class IntegrationsApi extends BaseAPI {
1127
1151
  /**
1128
1152
  * List all integration listings
1129
1153
  * @summary List integration listings
1154
+ * @param {IntegrationsApiGetIntegrationListingsRequest} requestParameters Request parameters.
1130
1155
  * @param {*} [options] Override http request option.
1131
1156
  * @throws {RequiredError}
1132
1157
  * @memberof IntegrationsApi
1133
1158
  */
1134
- getIntegrationListings(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationListingsResponse, any>>;
1159
+ getIntegrationListings(requestParameters: IntegrationsApiGetIntegrationListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IntegrationListingsResponse, any>>;
1135
1160
  /**
1136
1161
  * Get a product available for an integration
1137
1162
  * @summary Get integration product
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Integrations API
5
5
  * Manage PodOS Integrations
6
6
  *
7
- * The version of the OpenAPI document: 0.15.0
7
+ * The version of the OpenAPI document: 0.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -241,10 +241,13 @@ export const IntegrationsApiAxiosParamCreator = function (configuration) {
241
241
  /**
242
242
  * List all integration listings
243
243
  * @summary List integration listings
244
+ * @param {string} project
244
245
  * @param {*} [options] Override http request option.
245
246
  * @throws {RequiredError}
246
247
  */
247
- getIntegrationListings: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
248
+ getIntegrationListings: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
249
+ // verify required parameter 'project' is not null or undefined
250
+ assertParamExists('getIntegrationListings', 'project', project);
248
251
  const localVarPath = `/v1/integrations/listings`;
249
252
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
250
253
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -260,6 +263,9 @@ export const IntegrationsApiAxiosParamCreator = function (configuration) {
260
263
  yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
261
264
  // authentication api-key required
262
265
  yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
266
+ if (project !== undefined) {
267
+ localVarQueryParameter['project'] = project;
268
+ }
263
269
  setSearchParams(localVarUrlObj, localVarQueryParameter);
264
270
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
265
271
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -310,10 +316,11 @@ export const IntegrationsApiAxiosParamCreator = function (configuration) {
310
316
  * List all products available for an integration
311
317
  * @summary List integration products
312
318
  * @param {number} integration Integrations unique identifier
319
+ * @param {string} [project]
313
320
  * @param {*} [options] Override http request option.
314
321
  * @throws {RequiredError}
315
322
  */
316
- getIntegrationProducts: (integration_1, ...args_1) => __awaiter(this, [integration_1, ...args_1], void 0, function* (integration, options = {}) {
323
+ getIntegrationProducts: (integration_1, project_1, ...args_1) => __awaiter(this, [integration_1, project_1, ...args_1], void 0, function* (integration, project, options = {}) {
317
324
  // verify required parameter 'integration' is not null or undefined
318
325
  assertParamExists('getIntegrationProducts', 'integration', integration);
319
326
  const localVarPath = `/v1/integrations/{integration}/products`
@@ -332,6 +339,9 @@ export const IntegrationsApiAxiosParamCreator = function (configuration) {
332
339
  yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
333
340
  // authentication api-key required
334
341
  yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
342
+ if (project !== undefined) {
343
+ localVarQueryParameter['project'] = project;
344
+ }
335
345
  setSearchParams(localVarUrlObj, localVarQueryParameter);
336
346
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
337
347
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -546,13 +556,14 @@ export const IntegrationsApiFp = function (configuration) {
546
556
  /**
547
557
  * List all integration listings
548
558
  * @summary List integration listings
559
+ * @param {string} project
549
560
  * @param {*} [options] Override http request option.
550
561
  * @throws {RequiredError}
551
562
  */
552
- getIntegrationListings(options) {
563
+ getIntegrationListings(project, options) {
553
564
  return __awaiter(this, void 0, void 0, function* () {
554
565
  var _a, _b, _c;
555
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getIntegrationListings(options);
566
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getIntegrationListings(project, options);
556
567
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
557
568
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['IntegrationsApi.getIntegrationListings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
558
569
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -579,13 +590,14 @@ export const IntegrationsApiFp = function (configuration) {
579
590
  * List all products available for an integration
580
591
  * @summary List integration products
581
592
  * @param {number} integration Integrations unique identifier
593
+ * @param {string} [project]
582
594
  * @param {*} [options] Override http request option.
583
595
  * @throws {RequiredError}
584
596
  */
585
- getIntegrationProducts(integration, options) {
597
+ getIntegrationProducts(integration, project, options) {
586
598
  return __awaiter(this, void 0, void 0, function* () {
587
599
  var _a, _b, _c;
588
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getIntegrationProducts(integration, options);
600
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getIntegrationProducts(integration, project, options);
589
601
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
590
602
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['IntegrationsApi.getIntegrationProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
591
603
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -709,11 +721,12 @@ export const IntegrationsApiFactory = function (configuration, basePath, axios)
709
721
  /**
710
722
  * List all integration listings
711
723
  * @summary List integration listings
724
+ * @param {IntegrationsApiGetIntegrationListingsRequest} requestParameters Request parameters.
712
725
  * @param {*} [options] Override http request option.
713
726
  * @throws {RequiredError}
714
727
  */
715
- getIntegrationListings(options) {
716
- return localVarFp.getIntegrationListings(options).then((request) => request(axios, basePath));
728
+ getIntegrationListings(requestParameters, options) {
729
+ return localVarFp.getIntegrationListings(requestParameters.project, options).then((request) => request(axios, basePath));
717
730
  },
718
731
  /**
719
732
  * Get a product available for an integration
@@ -733,7 +746,7 @@ export const IntegrationsApiFactory = function (configuration, basePath, axios)
733
746
  * @throws {RequiredError}
734
747
  */
735
748
  getIntegrationProducts(requestParameters, options) {
736
- return localVarFp.getIntegrationProducts(requestParameters.integration, options).then((request) => request(axios, basePath));
749
+ return localVarFp.getIntegrationProducts(requestParameters.integration, requestParameters.project, options).then((request) => request(axios, basePath));
737
750
  },
738
751
  /**
739
752
  * List all integrations
@@ -840,12 +853,13 @@ export class IntegrationsApi extends BaseAPI {
840
853
  /**
841
854
  * List all integration listings
842
855
  * @summary List integration listings
856
+ * @param {IntegrationsApiGetIntegrationListingsRequest} requestParameters Request parameters.
843
857
  * @param {*} [options] Override http request option.
844
858
  * @throws {RequiredError}
845
859
  * @memberof IntegrationsApi
846
860
  */
847
- getIntegrationListings(options) {
848
- return IntegrationsApiFp(this.configuration).getIntegrationListings(options).then((request) => request(this.axios, this.basePath));
861
+ getIntegrationListings(requestParameters, options) {
862
+ return IntegrationsApiFp(this.configuration).getIntegrationListings(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
849
863
  }
850
864
  /**
851
865
  * Get a product available for an integration
@@ -867,7 +881,7 @@ export class IntegrationsApi extends BaseAPI {
867
881
  * @memberof IntegrationsApi
868
882
  */
869
883
  getIntegrationProducts(requestParameters, options) {
870
- return IntegrationsApiFp(this.configuration).getIntegrationProducts(requestParameters.integration, options).then((request) => request(this.axios, this.basePath));
884
+ return IntegrationsApiFp(this.configuration).getIntegrationProducts(requestParameters.integration, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
871
885
  }
872
886
  /**
873
887
  * List all integrations
@@ -2,7 +2,7 @@
2
2
  * Integrations API
3
3
  * Manage PodOS Integrations
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Integrations API
5
5
  * Manage PodOS Integrations
6
6
  *
7
- * The version of the OpenAPI document: 0.15.0
7
+ * The version of the OpenAPI document: 0.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Integrations API
3
3
  * Manage PodOS Integrations
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Integrations API
5
5
  * Manage PodOS Integrations
6
6
  *
7
- * The version of the OpenAPI document: 0.15.0
7
+ * The version of the OpenAPI document: 0.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Integrations API
3
3
  * Manage PodOS Integrations
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Integrations API
5
5
  * Manage PodOS Integrations
6
6
  *
7
- * The version of the OpenAPI document: 0.15.0
7
+ * The version of the OpenAPI document: 0.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Integrations API
3
3
  * Manage PodOS Integrations
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Integrations API
5
5
  * Manage PodOS Integrations
6
6
  *
7
- * The version of the OpenAPI document: 0.15.0
7
+ * The version of the OpenAPI document: 0.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Integrations API
3
3
  * Manage PodOS Integrations
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Integrations API
6
6
  * Manage PodOS Integrations
7
7
  *
8
- * The version of the OpenAPI document: 0.15.0
8
+ * The version of the OpenAPI document: 0.17.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,48 @@
1
+ # AdminIntegrationListing
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [readonly] [default to undefined]
9
+ **slug** | **string** | The slug of the integration listing that is used in the URL | [default to undefined]
10
+ **code** | **string** | The code of the integration | [default to undefined]
11
+ **name** | **string** | The name of the integration listing | [default to undefined]
12
+ **description** | **string** | The description of the integration listing | [default to undefined]
13
+ **content** | **string** | The html content of the integration listing | [default to undefined]
14
+ **pricing** | **string** | The html content of the pricing information | [optional] [default to undefined]
15
+ **author** | **string** | The author of the integration listing | [default to undefined]
16
+ **icon** | [**Icon**](Icon.md) | | [default to undefined]
17
+ **gradient** | [**IntegrationListingGradient**](IntegrationListingGradient.md) | | [default to undefined]
18
+ **integration** | [**Integration**](Integration.md) | | [default to undefined]
19
+ **dependencies** | **Array&lt;string&gt;** | The dependencies that this integration listing requires | [default to undefined]
20
+ **categories** | [**Array&lt;IntegrationCategory&gt;**](IntegrationCategory.md) | The categories that this listing belongs to | [default to undefined]
21
+ **menuTitle** | **string** | The string identifier displayed in the UI menu | [optional] [default to undefined]
22
+ **menuSortOrder** | **number** | The order of the listing in the UI menu | [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { AdminIntegrationListing } from '@teemill/integrations';
28
+
29
+ const instance: AdminIntegrationListing = {
30
+ id,
31
+ slug,
32
+ code,
33
+ name,
34
+ description,
35
+ content,
36
+ pricing,
37
+ author,
38
+ icon,
39
+ gradient,
40
+ integration,
41
+ dependencies,
42
+ categories,
43
+ menuTitle,
44
+ menuSortOrder,
45
+ };
46
+ ```
47
+
48
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # AdminIntegrationListingsResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **listings** | [**Array&lt;AdminIntegrationListing&gt;**](AdminIntegrationListing.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { AdminIntegrationListingsResponse } from '@teemill/integrations';
14
+
15
+ const instance: AdminIntegrationListingsResponse = {
16
+ listings,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # ApiError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [optional] [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ApiError } from '@teemill/integrations';
15
+
16
+ const instance: ApiError = {
17
+ code,
18
+ message,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,42 @@
1
+ # CreateAdminIntegrationListingRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | The name of the integration listing | [default to undefined]
9
+ **description** | **string** | The description of the integration listing | [default to undefined]
10
+ **content** | **string** | The html content of the integration listing | [default to undefined]
11
+ **pricing** | **string** | The html content of the pricing information | [optional] [default to undefined]
12
+ **author** | **string** | The author of the integration listing | [default to undefined]
13
+ **integration** | **string** | The code of the integration | [default to undefined]
14
+ **slug** | **string** | The slug of the integration listing that is used in the URL | [default to undefined]
15
+ **gradient** | [**CreateAdminIntegrationListingRequestGradient**](CreateAdminIntegrationListingRequestGradient.md) | | [default to undefined]
16
+ **icon** | **string** | The icon of the integration listing | [default to undefined]
17
+ **categories** | **Array&lt;string&gt;** | The categories that this listing belongs to | [default to undefined]
18
+ **menuTitle** | **string** | The string identifier displayed in the UI menu | [optional] [default to undefined]
19
+ **menuSortOrder** | **number** | The order of the listing in the UI menu | [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { CreateAdminIntegrationListingRequest } from '@teemill/integrations';
25
+
26
+ const instance: CreateAdminIntegrationListingRequest = {
27
+ name,
28
+ description,
29
+ content,
30
+ pricing,
31
+ author,
32
+ integration,
33
+ slug,
34
+ gradient,
35
+ icon,
36
+ categories,
37
+ menuTitle,
38
+ menuSortOrder,
39
+ };
40
+ ```
41
+
42
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # CreateAdminIntegrationListingRequestGradient
2
+
3
+ The gradient that is used to display the listing
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **from** | **string** | | [default to undefined]
10
+ **to** | **string** | | [default to undefined]
11
+ **angle** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { CreateAdminIntegrationListingRequestGradient } from '@teemill/integrations';
17
+
18
+ const instance: CreateAdminIntegrationListingRequestGradient = {
19
+ from,
20
+ to,
21
+ angle,
22
+ };
23
+ ```
24
+
25
+ [[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 ADDED
@@ -0,0 +1,24 @@
1
+ # Icon
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **prefix** | **string** | | [default to undefined]
9
+ **iconName** | **string** | | [default to undefined]
10
+ **icon** | **Array&lt;any&gt;** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { Icon } from '@teemill/integrations';
16
+
17
+ const instance: Icon = {
18
+ prefix,
19
+ iconName,
20
+ icon,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # Integration
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [readonly] [default to undefined]
9
+ **code** | **string** | The code of the integration | [optional] [default to undefined]
10
+ **config** | **{ [key: string]: string; }** | The configuration of the integration | [optional] [default to undefined]
11
+ **icon** | **any** | The icon of the integration | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { Integration } from '@teemill/integrations';
17
+
18
+ const instance: Integration = {
19
+ id,
20
+ code,
21
+ config,
22
+ icon,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # IntegrationCategoriesResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **categories** | [**Array&lt;IntegrationCategory&gt;**](IntegrationCategory.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { IntegrationCategoriesResponse } from '@teemill/integrations';
14
+
15
+ const instance: IntegrationCategoriesResponse = {
16
+ categories,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # IntegrationCategory
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | The name of the category | [default to undefined]
9
+ **slug** | **string** | The slug of the category that is used in the URL | [default to undefined]
10
+ **type** | **string** | The type of category, used to determine how it is displayed | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { IntegrationCategory } from '@teemill/integrations';
16
+
17
+ const instance: IntegrationCategory = {
18
+ name,
19
+ slug,
20
+ type,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)