@teemill/website 0.30.4 → 0.31.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.
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.30.4
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -563,12 +563,13 @@ export class BlogsApi extends BaseAPI {
563
563
  export const CollectionsApiAxiosParamCreator = function (configuration) {
564
564
  return {
565
565
  /**
566
- *
566
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
567
567
  * @summary Update product collections
568
568
  * @param {string} project What project it is
569
569
  * @param {string} productId Product\'s unique identifier
570
570
  * @param {UpdateProductCollectionsRequest} [updateProductCollectionsRequest]
571
571
  * @param {*} [options] Override http request option.
572
+ * @deprecated
572
573
  * @throws {RequiredError}
573
574
  */
574
575
  updateProductCollections: (project_1, productId_1, updateProductCollectionsRequest_1, ...args_1) => __awaiter(this, [project_1, productId_1, updateProductCollectionsRequest_1, ...args_1], void 0, function* (project, productId, updateProductCollectionsRequest, options = {}) {
@@ -615,12 +616,13 @@ export const CollectionsApiFp = function (configuration) {
615
616
  const localVarAxiosParamCreator = CollectionsApiAxiosParamCreator(configuration);
616
617
  return {
617
618
  /**
618
- *
619
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
619
620
  * @summary Update product collections
620
621
  * @param {string} project What project it is
621
622
  * @param {string} productId Product\'s unique identifier
622
623
  * @param {UpdateProductCollectionsRequest} [updateProductCollectionsRequest]
623
624
  * @param {*} [options] Override http request option.
625
+ * @deprecated
624
626
  * @throws {RequiredError}
625
627
  */
626
628
  updateProductCollections(project, productId, updateProductCollectionsRequest, options) {
@@ -641,10 +643,11 @@ export const CollectionsApiFactory = function (configuration, basePath, axios) {
641
643
  const localVarFp = CollectionsApiFp(configuration);
642
644
  return {
643
645
  /**
644
- *
646
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
645
647
  * @summary Update product collections
646
648
  * @param {CollectionsApiUpdateProductCollectionsRequest} requestParameters Request parameters.
647
649
  * @param {*} [options] Override http request option.
650
+ * @deprecated
648
651
  * @throws {RequiredError}
649
652
  */
650
653
  updateProductCollections(requestParameters, options) {
@@ -657,10 +660,11 @@ export const CollectionsApiFactory = function (configuration, basePath, axios) {
657
660
  */
658
661
  export class CollectionsApi extends BaseAPI {
659
662
  /**
660
- *
663
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
661
664
  * @summary Update product collections
662
665
  * @param {CollectionsApiUpdateProductCollectionsRequest} requestParameters Request parameters.
663
666
  * @param {*} [options] Override http request option.
667
+ * @deprecated
664
668
  * @throws {RequiredError}
665
669
  */
666
670
  updateProductCollections(requestParameters, options) {
@@ -673,12 +677,13 @@ export class CollectionsApi extends BaseAPI {
673
677
  export const CrossSellApiAxiosParamCreator = function (configuration) {
674
678
  return {
675
679
  /**
676
- * Attaches a list of products to the given product as cross-sell products.
680
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead. Attaches a list of products to the given product as cross-sell products.
677
681
  * @summary Attach cross-sell products
678
682
  * @param {string} project What project it is
679
683
  * @param {string} productId Product\'s unique identifier
680
684
  * @param {AttachCrossSellProductsRequest} [attachCrossSellProductsRequest]
681
685
  * @param {*} [options] Override http request option.
686
+ * @deprecated
682
687
  * @throws {RequiredError}
683
688
  */
684
689
  attachCrossSellProducts: (project_1, productId_1, attachCrossSellProductsRequest_1, ...args_1) => __awaiter(this, [project_1, productId_1, attachCrossSellProductsRequest_1, ...args_1], void 0, function* (project, productId, attachCrossSellProductsRequest, options = {}) {
@@ -717,11 +722,12 @@ export const CrossSellApiAxiosParamCreator = function (configuration) {
717
722
  };
718
723
  }),
719
724
  /**
720
- *
725
+ * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
721
726
  * @summary Get cross-sell products linked to a product
722
727
  * @param {string} project What project it is
723
728
  * @param {string} productId Product\'s unique identifier
724
729
  * @param {*} [options] Override http request option.
730
+ * @deprecated
725
731
  * @throws {RequiredError}
726
732
  */
727
733
  getCrossSellProducts: (project_1, productId_1, ...args_1) => __awaiter(this, [project_1, productId_1, ...args_1], void 0, function* (project, productId, options = {}) {
@@ -766,12 +772,13 @@ export const CrossSellApiFp = function (configuration) {
766
772
  const localVarAxiosParamCreator = CrossSellApiAxiosParamCreator(configuration);
767
773
  return {
768
774
  /**
769
- * Attaches a list of products to the given product as cross-sell products.
775
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead. Attaches a list of products to the given product as cross-sell products.
770
776
  * @summary Attach cross-sell products
771
777
  * @param {string} project What project it is
772
778
  * @param {string} productId Product\'s unique identifier
773
779
  * @param {AttachCrossSellProductsRequest} [attachCrossSellProductsRequest]
774
780
  * @param {*} [options] Override http request option.
781
+ * @deprecated
775
782
  * @throws {RequiredError}
776
783
  */
777
784
  attachCrossSellProducts(project, productId, attachCrossSellProductsRequest, options) {
@@ -784,11 +791,12 @@ export const CrossSellApiFp = function (configuration) {
784
791
  });
785
792
  },
786
793
  /**
787
- *
794
+ * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
788
795
  * @summary Get cross-sell products linked to a product
789
796
  * @param {string} project What project it is
790
797
  * @param {string} productId Product\'s unique identifier
791
798
  * @param {*} [options] Override http request option.
799
+ * @deprecated
792
800
  * @throws {RequiredError}
793
801
  */
794
802
  getCrossSellProducts(project, productId, options) {
@@ -809,20 +817,22 @@ export const CrossSellApiFactory = function (configuration, basePath, axios) {
809
817
  const localVarFp = CrossSellApiFp(configuration);
810
818
  return {
811
819
  /**
812
- * Attaches a list of products to the given product as cross-sell products.
820
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead. Attaches a list of products to the given product as cross-sell products.
813
821
  * @summary Attach cross-sell products
814
822
  * @param {CrossSellApiAttachCrossSellProductsRequest} requestParameters Request parameters.
815
823
  * @param {*} [options] Override http request option.
824
+ * @deprecated
816
825
  * @throws {RequiredError}
817
826
  */
818
827
  attachCrossSellProducts(requestParameters, options) {
819
828
  return localVarFp.attachCrossSellProducts(requestParameters.project, requestParameters.productId, requestParameters.attachCrossSellProductsRequest, options).then((request) => request(axios, basePath));
820
829
  },
821
830
  /**
822
- *
831
+ * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
823
832
  * @summary Get cross-sell products linked to a product
824
833
  * @param {CrossSellApiGetCrossSellProductsRequest} requestParameters Request parameters.
825
834
  * @param {*} [options] Override http request option.
835
+ * @deprecated
826
836
  * @throws {RequiredError}
827
837
  */
828
838
  getCrossSellProducts(requestParameters, options) {
@@ -835,20 +845,22 @@ export const CrossSellApiFactory = function (configuration, basePath, axios) {
835
845
  */
836
846
  export class CrossSellApi extends BaseAPI {
837
847
  /**
838
- * Attaches a list of products to the given product as cross-sell products.
848
+ * Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead. Attaches a list of products to the given product as cross-sell products.
839
849
  * @summary Attach cross-sell products
840
850
  * @param {CrossSellApiAttachCrossSellProductsRequest} requestParameters Request parameters.
841
851
  * @param {*} [options] Override http request option.
852
+ * @deprecated
842
853
  * @throws {RequiredError}
843
854
  */
844
855
  attachCrossSellProducts(requestParameters, options) {
845
856
  return CrossSellApiFp(this.configuration).attachCrossSellProducts(requestParameters.project, requestParameters.productId, requestParameters.attachCrossSellProductsRequest, options).then((request) => request(this.axios, this.basePath));
846
857
  }
847
858
  /**
848
- *
859
+ * Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
849
860
  * @summary Get cross-sell products linked to a product
850
861
  * @param {CrossSellApiGetCrossSellProductsRequest} requestParameters Request parameters.
851
862
  * @param {*} [options] Override http request option.
863
+ * @deprecated
852
864
  * @throws {RequiredError}
853
865
  */
854
866
  getCrossSellProducts(requestParameters, options) {
@@ -2373,6 +2385,194 @@ export class PaymentApi extends BaseAPI {
2373
2385
  return PaymentApiFp(this.configuration).getStripePaymentAccount(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
2374
2386
  }
2375
2387
  }
2388
+ /**
2389
+ * ProductsApi - axios parameter creator
2390
+ */
2391
+ export const ProductsApiAxiosParamCreator = function (configuration) {
2392
+ return {
2393
+ /**
2394
+ * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership. The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2395
+ * @summary Get website product
2396
+ * @param {string} project What project it is
2397
+ * @param {string} productId Product\'s unique identifier
2398
+ * @param {*} [options] Override http request option.
2399
+ * @throws {RequiredError}
2400
+ */
2401
+ getWebsiteProduct: (project_1, productId_1, ...args_1) => __awaiter(this, [project_1, productId_1, ...args_1], void 0, function* (project, productId, options = {}) {
2402
+ // verify required parameter 'project' is not null or undefined
2403
+ assertParamExists('getWebsiteProduct', 'project', project);
2404
+ // verify required parameter 'productId' is not null or undefined
2405
+ assertParamExists('getWebsiteProduct', 'productId', productId);
2406
+ const localVarPath = `/v1/website/products/{productId}`
2407
+ .replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
2408
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2409
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2410
+ let baseOptions;
2411
+ if (configuration) {
2412
+ baseOptions = configuration.baseOptions;
2413
+ }
2414
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2415
+ const localVarHeaderParameter = {};
2416
+ const localVarQueryParameter = {};
2417
+ // authentication session-oauth required
2418
+ // oauth required
2419
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
2420
+ // authentication api-key required
2421
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
2422
+ if (project !== undefined) {
2423
+ localVarQueryParameter['project'] = project;
2424
+ }
2425
+ localVarHeaderParameter['Accept'] = 'application/json';
2426
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2427
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2428
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2429
+ return {
2430
+ url: toPathString(localVarUrlObj),
2431
+ options: localVarRequestOptions,
2432
+ };
2433
+ }),
2434
+ /**
2435
+ * Updates website-specific settings for a product. Include only fields you want to change. `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route). The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2436
+ * @summary Update website product
2437
+ * @param {string} project What project it is
2438
+ * @param {string} productId Product\'s unique identifier
2439
+ * @param {UpdateWebsiteProductRequest} [updateWebsiteProductRequest] Update website product settings
2440
+ * @param {*} [options] Override http request option.
2441
+ * @throws {RequiredError}
2442
+ */
2443
+ updateWebsiteProduct: (project_1, productId_1, updateWebsiteProductRequest_1, ...args_1) => __awaiter(this, [project_1, productId_1, updateWebsiteProductRequest_1, ...args_1], void 0, function* (project, productId, updateWebsiteProductRequest, options = {}) {
2444
+ // verify required parameter 'project' is not null or undefined
2445
+ assertParamExists('updateWebsiteProduct', 'project', project);
2446
+ // verify required parameter 'productId' is not null or undefined
2447
+ assertParamExists('updateWebsiteProduct', 'productId', productId);
2448
+ const localVarPath = `/v1/website/products/{productId}`
2449
+ .replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
2450
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2451
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2452
+ let baseOptions;
2453
+ if (configuration) {
2454
+ baseOptions = configuration.baseOptions;
2455
+ }
2456
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
2457
+ const localVarHeaderParameter = {};
2458
+ const localVarQueryParameter = {};
2459
+ // authentication session-oauth required
2460
+ // oauth required
2461
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
2462
+ // authentication api-key required
2463
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
2464
+ if (project !== undefined) {
2465
+ localVarQueryParameter['project'] = project;
2466
+ }
2467
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2468
+ localVarHeaderParameter['Accept'] = 'application/json';
2469
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2470
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2471
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2472
+ localVarRequestOptions.data = serializeDataIfNeeded(updateWebsiteProductRequest, localVarRequestOptions, configuration);
2473
+ return {
2474
+ url: toPathString(localVarUrlObj),
2475
+ options: localVarRequestOptions,
2476
+ };
2477
+ }),
2478
+ };
2479
+ };
2480
+ /**
2481
+ * ProductsApi - functional programming interface
2482
+ */
2483
+ export const ProductsApiFp = function (configuration) {
2484
+ const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration);
2485
+ return {
2486
+ /**
2487
+ * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership. The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2488
+ * @summary Get website product
2489
+ * @param {string} project What project it is
2490
+ * @param {string} productId Product\'s unique identifier
2491
+ * @param {*} [options] Override http request option.
2492
+ * @throws {RequiredError}
2493
+ */
2494
+ getWebsiteProduct(project, productId, options) {
2495
+ return __awaiter(this, void 0, void 0, function* () {
2496
+ var _a, _b, _c;
2497
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getWebsiteProduct(project, productId, options);
2498
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2499
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.getWebsiteProduct']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2500
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2501
+ });
2502
+ },
2503
+ /**
2504
+ * Updates website-specific settings for a product. Include only fields you want to change. `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route). The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2505
+ * @summary Update website product
2506
+ * @param {string} project What project it is
2507
+ * @param {string} productId Product\'s unique identifier
2508
+ * @param {UpdateWebsiteProductRequest} [updateWebsiteProductRequest] Update website product settings
2509
+ * @param {*} [options] Override http request option.
2510
+ * @throws {RequiredError}
2511
+ */
2512
+ updateWebsiteProduct(project, productId, updateWebsiteProductRequest, options) {
2513
+ return __awaiter(this, void 0, void 0, function* () {
2514
+ var _a, _b, _c;
2515
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateWebsiteProduct(project, productId, updateWebsiteProductRequest, options);
2516
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2517
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.updateWebsiteProduct']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2518
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2519
+ });
2520
+ },
2521
+ };
2522
+ };
2523
+ /**
2524
+ * ProductsApi - factory interface
2525
+ */
2526
+ export const ProductsApiFactory = function (configuration, basePath, axios) {
2527
+ const localVarFp = ProductsApiFp(configuration);
2528
+ return {
2529
+ /**
2530
+ * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership. The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2531
+ * @summary Get website product
2532
+ * @param {ProductsApiGetWebsiteProductRequest} requestParameters Request parameters.
2533
+ * @param {*} [options] Override http request option.
2534
+ * @throws {RequiredError}
2535
+ */
2536
+ getWebsiteProduct(requestParameters, options) {
2537
+ return localVarFp.getWebsiteProduct(requestParameters.project, requestParameters.productId, options).then((request) => request(axios, basePath));
2538
+ },
2539
+ /**
2540
+ * Updates website-specific settings for a product. Include only fields you want to change. `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route). The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2541
+ * @summary Update website product
2542
+ * @param {ProductsApiUpdateWebsiteProductRequest} requestParameters Request parameters.
2543
+ * @param {*} [options] Override http request option.
2544
+ * @throws {RequiredError}
2545
+ */
2546
+ updateWebsiteProduct(requestParameters, options) {
2547
+ return localVarFp.updateWebsiteProduct(requestParameters.project, requestParameters.productId, requestParameters.updateWebsiteProductRequest, options).then((request) => request(axios, basePath));
2548
+ },
2549
+ };
2550
+ };
2551
+ /**
2552
+ * ProductsApi - object-oriented interface
2553
+ */
2554
+ export class ProductsApi extends BaseAPI {
2555
+ /**
2556
+ * Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership. The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2557
+ * @summary Get website product
2558
+ * @param {ProductsApiGetWebsiteProductRequest} requestParameters Request parameters.
2559
+ * @param {*} [options] Override http request option.
2560
+ * @throws {RequiredError}
2561
+ */
2562
+ getWebsiteProduct(requestParameters, options) {
2563
+ return ProductsApiFp(this.configuration).getWebsiteProduct(requestParameters.project, requestParameters.productId, options).then((request) => request(this.axios, this.basePath));
2564
+ }
2565
+ /**
2566
+ * Updates website-specific settings for a product. Include only fields you want to change. `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route). The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
2567
+ * @summary Update website product
2568
+ * @param {ProductsApiUpdateWebsiteProductRequest} requestParameters Request parameters.
2569
+ * @param {*} [options] Override http request option.
2570
+ * @throws {RequiredError}
2571
+ */
2572
+ updateWebsiteProduct(requestParameters, options) {
2573
+ return ProductsApiFp(this.configuration).updateWebsiteProduct(requestParameters.project, requestParameters.productId, requestParameters.updateWebsiteProductRequest, options).then((request) => request(this.axios, this.basePath));
2574
+ }
2575
+ }
2376
2576
  /**
2377
2577
  * ReviewsApi - axios parameter creator
2378
2578
  */
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.30.4
5
+ * The version of the OpenAPI document: 0.31.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
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.30.4
7
+ * The version of the OpenAPI document: 0.31.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
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.30.4
5
+ * The version of the OpenAPI document: 0.31.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
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.30.4
7
+ * The version of the OpenAPI document: 0.31.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
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.30.4
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Website
4
4
  * Manage your PodOS Website
5
5
  *
6
- * The version of the OpenAPI document: 0.30.4
6
+ * The version of the OpenAPI document: 0.31.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.30.4
5
+ * The version of the OpenAPI document: 0.31.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
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.30.4
7
+ * The version of the OpenAPI document: 0.31.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
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.30.4
5
+ * The version of the OpenAPI document: 0.31.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
  * Website
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.30.4
8
+ * The version of the OpenAPI document: 0.31.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.localhost:8080*
9
9
  # **updateProductCollections**
10
10
  > updateProductCollections()
11
11
 
12
+ Deprecated. Please use `PATCH /v1/website/products/{productId}` with `collectionIds` instead.
12
13
 
13
14
  ### Example
14
15
 
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.localhost:8080*
10
10
  # **attachCrossSellProducts**
11
11
  > Array<Product> attachCrossSellProducts()
12
12
 
13
- Attaches a list of products to the given product as cross-sell products.
13
+ Deprecated. Please use `PATCH /v1/website/products/{productId}` with `crossSellProductIds` instead. Attaches a list of products to the given product as cross-sell products.
14
14
 
15
15
  ### Example
16
16
 
@@ -72,6 +72,7 @@ const { status, data } = await apiInstance.attachCrossSellProducts(
72
72
  # **getCrossSellProducts**
73
73
  > Array<Product> getCrossSellProducts()
74
74
 
75
+ Deprecated. Please use `GET /v1/website/products/{productId}` with `crossSellProducts` instead.
75
76
 
76
77
  ### Example
77
78
 
@@ -0,0 +1,131 @@
1
+ # ProductsApi
2
+
3
+ All URIs are relative to *https://api.localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getWebsiteProduct**](#getwebsiteproduct) | **GET** /v1/website/products/{productId} | Get website product|
8
+ |[**updateWebsiteProduct**](#updatewebsiteproduct) | **PATCH** /v1/website/products/{productId} | Update website product|
9
+
10
+ # **getWebsiteProduct**
11
+ > WebsiteProduct getWebsiteProduct()
12
+
13
+ Returns website-specific settings for a product, including storefront search visibility, cross-sell products, and collection membership. The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ ProductsApi,
20
+ Configuration
21
+ } from '@teemill/website';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new ProductsApi(configuration);
25
+
26
+ let project: string; //What project it is (default to undefined)
27
+ let productId: string; //Product\'s unique identifier (default to undefined)
28
+
29
+ const { status, data } = await apiInstance.getWebsiteProduct(
30
+ project,
31
+ productId
32
+ );
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ |Name | Type | Description | Notes|
38
+ |------------- | ------------- | ------------- | -------------|
39
+ | **project** | [**string**] | What project it is | defaults to undefined|
40
+ | **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
41
+
42
+
43
+ ### Return type
44
+
45
+ **WebsiteProduct**
46
+
47
+ ### Authorization
48
+
49
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: Not defined
54
+ - **Accept**: application/json
55
+
56
+
57
+ ### HTTP response details
58
+ | Status code | Description | Response headers |
59
+ |-------------|-------------|------------------|
60
+ |**200** | Website-specific settings for a product. | - |
61
+ |**401** | Not authorised to access this resource | - |
62
+ |**403** | Refuse to authorize | - |
63
+ |**404** | Resource not found | - |
64
+ |**422** | Failed validation | - |
65
+ |**500** | Unknown server error | - |
66
+
67
+ [[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)
68
+
69
+ # **updateWebsiteProduct**
70
+ > WebsiteProduct updateWebsiteProduct()
71
+
72
+ Updates website-specific settings for a product. Include only fields you want to change. `excludeFromSearch` toggles storefront search visibility. When `collectionIds` is present, it replaces collection membership for this product with that exclusive list of collection IDs (same behaviour as the deprecated collections route). When `crossSellProductIds` is present, it replaces cross-sell links in the given order (same behaviour as the deprecated cross-sell route). The dedicated cross-sell and collections routes are deprecated; use this endpoint instead.
73
+
74
+ ### Example
75
+
76
+ ```typescript
77
+ import {
78
+ ProductsApi,
79
+ Configuration,
80
+ UpdateWebsiteProductRequest
81
+ } from '@teemill/website';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new ProductsApi(configuration);
85
+
86
+ let project: string; //What project it is (default to undefined)
87
+ let productId: string; //Product\'s unique identifier (default to undefined)
88
+ let updateWebsiteProductRequest: UpdateWebsiteProductRequest; //Update website product settings (optional)
89
+
90
+ const { status, data } = await apiInstance.updateWebsiteProduct(
91
+ project,
92
+ productId,
93
+ updateWebsiteProductRequest
94
+ );
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ |Name | Type | Description | Notes|
100
+ |------------- | ------------- | ------------- | -------------|
101
+ | **updateWebsiteProductRequest** | **UpdateWebsiteProductRequest**| Update website product settings | |
102
+ | **project** | [**string**] | What project it is | defaults to undefined|
103
+ | **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
104
+
105
+
106
+ ### Return type
107
+
108
+ **WebsiteProduct**
109
+
110
+ ### Authorization
111
+
112
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: application/json
117
+ - **Accept**: application/json
118
+
119
+
120
+ ### HTTP response details
121
+ | Status code | Description | Response headers |
122
+ |-------------|-------------|------------------|
123
+ |**200** | Website-specific settings for a product. | - |
124
+ |**401** | Not authorised to access this resource | - |
125
+ |**403** | Refuse to authorize | - |
126
+ |**404** | Resource not found | - |
127
+ |**422** | Failed validation | - |
128
+ |**500** | Unknown server error | - |
129
+
130
+ [[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)
131
+
@@ -0,0 +1,24 @@
1
+ # UpdateWebsiteProductRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **excludeFromSearch** | **boolean** | When true, the product is excluded from storefront search results. | [optional] [default to undefined]
9
+ **collectionIds** | **Array&lt;string&gt;** | When provided, replaces collection membership for this product with this exclusive list of collection IDs. Any existing membership not in this list is removed. | [optional] [default to undefined]
10
+ **crossSellProductIds** | **Array&lt;string&gt;** | When provided, replaces cross-sell links with these product IDs. Order is preserved. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UpdateWebsiteProductRequest } from '@teemill/website';
16
+
17
+ const instance: UpdateWebsiteProductRequest = {
18
+ excludeFromSearch,
19
+ collectionIds,
20
+ crossSellProductIds,
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)