@teemill/website 0.22.2 → 0.23.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 (53) hide show
  1. package/README.md +25 -2
  2. package/api.ts +874 -52
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +722 -17
  7. package/dist/api.js +175 -5
  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 +722 -17
  15. package/dist/esm/api.js +175 -5
  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/Banner.md +23 -0
  27. package/docs/BannerImage.md +22 -0
  28. package/docs/Collection.md +10 -6
  29. package/docs/CollectionProduct.md +24 -0
  30. package/docs/CollectionProductImage.md +22 -0
  31. package/docs/CollectionsApi.md +128 -0
  32. package/docs/CreateCollectionRequest.md +38 -0
  33. package/docs/CreateCollectionRequestBanner.md +22 -0
  34. package/docs/CreateCollectionRequestBannerImage.md +22 -0
  35. package/docs/CreateCollectionRequestBannerOverlay.md +26 -0
  36. package/docs/CreateCollectionRequestProductsInner.md +24 -0
  37. package/docs/CreateCollectionRequestSeoMetadata.md +24 -0
  38. package/docs/MetaImage.md +1 -1
  39. package/docs/NavigationTag.md +24 -0
  40. package/docs/NullableMetaImage.md +23 -0
  41. package/docs/Overlay.md +27 -0
  42. package/docs/UpdateCollectionRequest.md +7 -1
  43. package/docs/UpdateCollectionRequestBanner.md +22 -0
  44. package/docs/UpdateCollectionRequestBannerImage.md +22 -0
  45. package/docs/UpdateCollectionRequestProductsInner.md +24 -0
  46. package/docs/UpdateCollectionRequestSeoMetadata.md +24 -0
  47. package/docs/UpdateCollectionsRequestCollectionsInner.md +6 -0
  48. package/docs/UpdateCollectionsRequestCollectionsInnerBanner.md +22 -0
  49. package/docs/UpdateCollectionsRequestCollectionsInnerBannerImage.md +22 -0
  50. package/docs/UpdateCollectionsRequestCollectionsInnerBannerOverlay.md +26 -0
  51. package/docs/UpdateCollectionsRequestCollectionsInnerProductsInner.md +24 -0
  52. package/index.ts +1 -1
  53. package/package.json +1 -1
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website API
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.22.2
8
+ * The version of the OpenAPI document: 0.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -573,6 +573,97 @@ exports.BlogsApi = BlogsApi;
573
573
  */
574
574
  const CollectionsApiAxiosParamCreator = function (configuration) {
575
575
  return {
576
+ /**
577
+ * Create a new website collection.
578
+ * @summary Create website collection
579
+ * @param {string} project What project it is
580
+ * @param {number} [pageToken] Page reference token
581
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
582
+ * @param {string} [search] Search term to filter results
583
+ * @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
584
+ * @param {*} [options] Override http request option.
585
+ * @throws {RequiredError}
586
+ */
587
+ createCollection: (project_1, pageToken_1, pageSize_1, search_1, createCollectionRequest_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, createCollectionRequest_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, createCollectionRequest, options = {}) {
588
+ // verify required parameter 'project' is not null or undefined
589
+ (0, common_1.assertParamExists)('createCollection', 'project', project);
590
+ const localVarPath = `/v1/website/collections`;
591
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
592
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
593
+ let baseOptions;
594
+ if (configuration) {
595
+ baseOptions = configuration.baseOptions;
596
+ }
597
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
598
+ const localVarHeaderParameter = {};
599
+ const localVarQueryParameter = {};
600
+ // authentication session-oauth required
601
+ // oauth required
602
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
603
+ // authentication api-key required
604
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
605
+ if (project !== undefined) {
606
+ localVarQueryParameter['project'] = project;
607
+ }
608
+ if (pageToken !== undefined) {
609
+ localVarQueryParameter['pageToken'] = pageToken;
610
+ }
611
+ if (pageSize !== undefined) {
612
+ localVarQueryParameter['pageSize'] = pageSize;
613
+ }
614
+ if (search !== undefined) {
615
+ localVarQueryParameter['search'] = search;
616
+ }
617
+ localVarHeaderParameter['Content-Type'] = 'application/json';
618
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
619
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
620
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
621
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createCollectionRequest, localVarRequestOptions, configuration);
622
+ return {
623
+ url: (0, common_1.toPathString)(localVarUrlObj),
624
+ options: localVarRequestOptions,
625
+ };
626
+ }),
627
+ /**
628
+ *
629
+ * @summary Delete website collection
630
+ * @param {string} project What project it is
631
+ * @param {string} collectionId Collection\'s unique identifier
632
+ * @param {*} [options] Override http request option.
633
+ * @throws {RequiredError}
634
+ */
635
+ deleteCollection: (project_1, collectionId_1, ...args_1) => __awaiter(this, [project_1, collectionId_1, ...args_1], void 0, function* (project, collectionId, options = {}) {
636
+ // verify required parameter 'project' is not null or undefined
637
+ (0, common_1.assertParamExists)('deleteCollection', 'project', project);
638
+ // verify required parameter 'collectionId' is not null or undefined
639
+ (0, common_1.assertParamExists)('deleteCollection', 'collectionId', collectionId);
640
+ const localVarPath = `/v1/website/collections/{collectionId}`
641
+ .replace(`{${"collectionId"}}`, encodeURIComponent(String(collectionId)));
642
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
643
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
644
+ let baseOptions;
645
+ if (configuration) {
646
+ baseOptions = configuration.baseOptions;
647
+ }
648
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
649
+ const localVarHeaderParameter = {};
650
+ const localVarQueryParameter = {};
651
+ // authentication session-oauth required
652
+ // oauth required
653
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
654
+ // authentication api-key required
655
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
656
+ if (project !== undefined) {
657
+ localVarQueryParameter['project'] = project;
658
+ }
659
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
660
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
661
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
662
+ return {
663
+ url: (0, common_1.toPathString)(localVarUrlObj),
664
+ options: localVarRequestOptions,
665
+ };
666
+ }),
576
667
  /**
577
668
  * Export collections as a CSV file.
578
669
  * @summary Export collections
@@ -780,7 +871,7 @@ const CollectionsApiAxiosParamCreator = function (configuration) {
780
871
  };
781
872
  }),
782
873
  /**
783
- *
874
+ * Update a website collection.
784
875
  * @summary Update website collections
785
876
  * @param {string} project What project it is
786
877
  * @param {number} [pageToken] Page reference token
@@ -840,6 +931,43 @@ exports.CollectionsApiAxiosParamCreator = CollectionsApiAxiosParamCreator;
840
931
  const CollectionsApiFp = function (configuration) {
841
932
  const localVarAxiosParamCreator = (0, exports.CollectionsApiAxiosParamCreator)(configuration);
842
933
  return {
934
+ /**
935
+ * Create a new website collection.
936
+ * @summary Create website collection
937
+ * @param {string} project What project it is
938
+ * @param {number} [pageToken] Page reference token
939
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
940
+ * @param {string} [search] Search term to filter results
941
+ * @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
942
+ * @param {*} [options] Override http request option.
943
+ * @throws {RequiredError}
944
+ */
945
+ createCollection(project, pageToken, pageSize, search, createCollectionRequest, options) {
946
+ return __awaiter(this, void 0, void 0, function* () {
947
+ var _a, _b, _c;
948
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createCollection(project, pageToken, pageSize, search, createCollectionRequest, options);
949
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
950
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CollectionsApi.createCollection']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
951
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
952
+ });
953
+ },
954
+ /**
955
+ *
956
+ * @summary Delete website collection
957
+ * @param {string} project What project it is
958
+ * @param {string} collectionId Collection\'s unique identifier
959
+ * @param {*} [options] Override http request option.
960
+ * @throws {RequiredError}
961
+ */
962
+ deleteCollection(project, collectionId, options) {
963
+ return __awaiter(this, void 0, void 0, function* () {
964
+ var _a, _b, _c;
965
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteCollection(project, collectionId, options);
966
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
967
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CollectionsApi.deleteCollection']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
968
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
969
+ });
970
+ },
843
971
  /**
844
972
  * Export collections as a CSV file.
845
973
  * @summary Export collections
@@ -928,7 +1056,7 @@ const CollectionsApiFp = function (configuration) {
928
1056
  });
929
1057
  },
930
1058
  /**
931
- *
1059
+ * Update a website collection.
932
1060
  * @summary Update website collections
933
1061
  * @param {string} project What project it is
934
1062
  * @param {number} [pageToken] Page reference token
@@ -957,6 +1085,26 @@ exports.CollectionsApiFp = CollectionsApiFp;
957
1085
  const CollectionsApiFactory = function (configuration, basePath, axios) {
958
1086
  const localVarFp = (0, exports.CollectionsApiFp)(configuration);
959
1087
  return {
1088
+ /**
1089
+ * Create a new website collection.
1090
+ * @summary Create website collection
1091
+ * @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
1092
+ * @param {*} [options] Override http request option.
1093
+ * @throws {RequiredError}
1094
+ */
1095
+ createCollection(requestParameters, options) {
1096
+ return localVarFp.createCollection(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createCollectionRequest, options).then((request) => request(axios, basePath));
1097
+ },
1098
+ /**
1099
+ *
1100
+ * @summary Delete website collection
1101
+ * @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
1102
+ * @param {*} [options] Override http request option.
1103
+ * @throws {RequiredError}
1104
+ */
1105
+ deleteCollection(requestParameters, options) {
1106
+ return localVarFp.deleteCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(axios, basePath));
1107
+ },
960
1108
  /**
961
1109
  * Export collections as a CSV file.
962
1110
  * @summary Export collections
@@ -1008,7 +1156,7 @@ const CollectionsApiFactory = function (configuration, basePath, axios) {
1008
1156
  return localVarFp.updateCollection(requestParameters.project, requestParameters.collectionId, requestParameters.updateCollectionRequest, options).then((request) => request(axios, basePath));
1009
1157
  },
1010
1158
  /**
1011
- *
1159
+ * Update a website collection.
1012
1160
  * @summary Update website collections
1013
1161
  * @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
1014
1162
  * @param {*} [options] Override http request option.
@@ -1027,6 +1175,28 @@ exports.CollectionsApiFactory = CollectionsApiFactory;
1027
1175
  * @extends {BaseAPI}
1028
1176
  */
1029
1177
  class CollectionsApi extends base_1.BaseAPI {
1178
+ /**
1179
+ * Create a new website collection.
1180
+ * @summary Create website collection
1181
+ * @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
1182
+ * @param {*} [options] Override http request option.
1183
+ * @throws {RequiredError}
1184
+ * @memberof CollectionsApi
1185
+ */
1186
+ createCollection(requestParameters, options) {
1187
+ return (0, exports.CollectionsApiFp)(this.configuration).createCollection(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createCollectionRequest, options).then((request) => request(this.axios, this.basePath));
1188
+ }
1189
+ /**
1190
+ *
1191
+ * @summary Delete website collection
1192
+ * @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
1193
+ * @param {*} [options] Override http request option.
1194
+ * @throws {RequiredError}
1195
+ * @memberof CollectionsApi
1196
+ */
1197
+ deleteCollection(requestParameters, options) {
1198
+ return (0, exports.CollectionsApiFp)(this.configuration).deleteCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(this.axios, this.basePath));
1199
+ }
1030
1200
  /**
1031
1201
  * Export collections as a CSV file.
1032
1202
  * @summary Export collections
@@ -1083,7 +1253,7 @@ class CollectionsApi extends base_1.BaseAPI {
1083
1253
  return (0, exports.CollectionsApiFp)(this.configuration).updateCollection(requestParameters.project, requestParameters.collectionId, requestParameters.updateCollectionRequest, options).then((request) => request(this.axios, this.basePath));
1084
1254
  }
1085
1255
  /**
1086
- *
1256
+ * Update a website collection.
1087
1257
  * @summary Update website collections
1088
1258
  * @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
1089
1259
  * @param {*} [options] Override http request option.
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website API
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.22.2
5
+ * The version of the OpenAPI document: 0.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website API
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.22.2
8
+ * The version of the OpenAPI document: 0.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website API
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.22.2
5
+ * The version of the OpenAPI document: 0.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website API
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.22.2
8
+ * The version of the OpenAPI document: 0.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website API
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.22.2
5
+ * The version of the OpenAPI document: 0.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Website API
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.22.2
8
+ * The version of the OpenAPI document: 0.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).