@spscommerce/asst-api 4.6.0 → 4.7.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.
@@ -603,6 +603,20 @@ function createCompaniesApi(client) {
603
603
  return { getCompanyBriefInfoByOrg };
604
604
  }
605
605
 
606
+ // lib/rulesManagement/index.ts
607
+ var BASE_URL18 = "rules";
608
+ function createRulesManagementApi(client) {
609
+ async function activateRule(ruleId, request, signal) {
610
+ await client.post(`${BASE_URL18}/${ruleId}/activate`, {
611
+ json: request,
612
+ signal
613
+ });
614
+ }
615
+ return {
616
+ activateRule
617
+ };
618
+ }
619
+
606
620
  export {
607
621
  BASE_URL,
608
622
  createImportsApi,
@@ -640,5 +654,7 @@ export {
640
654
  BASE_URL16,
641
655
  createUniqueCriteriaApi,
642
656
  BASE_URL17,
643
- createCompaniesApi
657
+ createCompaniesApi,
658
+ BASE_URL18,
659
+ createRulesManagementApi
644
660
  };
package/dist/index.cjs CHANGED
@@ -46,6 +46,7 @@ __export(lib_exports, {
46
46
  createItemsApiV2: () => createItemsApiV2,
47
47
  createLocaleApi: () => createLocaleApi,
48
48
  createProductTypesApi: () => createProductTypesApi,
49
+ createRulesManagementApi: () => createRulesManagementApi,
49
50
  createSpreadsheetTemplateApi: () => createSpreadsheetTemplateApi,
50
51
  createTradingPartnerAccessApi: () => createTradingPartnerAccessApi,
51
52
  createTradingPartnerSettingsApi: () => createTradingPartnerSettingsApi,
@@ -5546,6 +5547,20 @@ function createCompaniesApi(client) {
5546
5547
  }
5547
5548
  return { getCompanyBriefInfoByOrg };
5548
5549
  }
5550
+
5551
+ // lib/rulesManagement/index.ts
5552
+ var BASE_URL18 = "rules";
5553
+ function createRulesManagementApi(client) {
5554
+ async function activateRule(ruleId, request, signal) {
5555
+ await client.post(`${BASE_URL18}/${ruleId}/activate`, {
5556
+ json: request,
5557
+ signal
5558
+ });
5559
+ }
5560
+ return {
5561
+ activateRule
5562
+ };
5563
+ }
5549
5564
  // Annotate the CommonJS export names for ESM import in node:
5550
5565
  0 && (module.exports = {
5551
5566
  AsstClient,
@@ -5564,6 +5579,7 @@ function createCompaniesApi(client) {
5564
5579
  createItemsApiV2,
5565
5580
  createLocaleApi,
5566
5581
  createProductTypesApi,
5582
+ createRulesManagementApi,
5567
5583
  createSpreadsheetTemplateApi,
5568
5584
  createTradingPartnerAccessApi,
5569
5585
  createTradingPartnerSettingsApi,
package/dist/index.d.cts CHANGED
@@ -853,4 +853,25 @@ declare function createCompaniesApi(client: AsstClient): {
853
853
  }, signal?: AbortSignal) => Promise<CompanyBriefByOrg>;
854
854
  };
855
855
 
856
- export { type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, CompanyBriefByOrg, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
856
+ declare const activateRuleRequestDtoSchema: z.ZodObject<{
857
+ instanceId: z.ZodNullable<z.ZodString>;
858
+ description: z.ZodString;
859
+ }, "strip", z.ZodTypeAny, {
860
+ description: string;
861
+ instanceId: string | null;
862
+ }, {
863
+ description: string;
864
+ instanceId: string | null;
865
+ }>;
866
+ type ActivateRuleRequestDto = z.infer<typeof activateRuleRequestDtoSchema>;
867
+
868
+ /**
869
+ * Initialize Rules Management Api functions
870
+ * @param client Assortment Client instance
871
+ * @returns An object containing Rules Management API functions
872
+ */
873
+ declare function createRulesManagementApi(client: AsstClient): {
874
+ activateRule: (ruleId: string, request: ActivateRuleRequestDto, signal?: AbortSignal) => Promise<void>;
875
+ };
876
+
877
+ export { type ActivateRuleRequestDto, type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, CompanyBriefByOrg, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createRulesManagementApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
package/dist/index.d.ts CHANGED
@@ -853,4 +853,25 @@ declare function createCompaniesApi(client: AsstClient): {
853
853
  }, signal?: AbortSignal) => Promise<CompanyBriefByOrg>;
854
854
  };
855
855
 
856
- export { type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, CompanyBriefByOrg, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
856
+ declare const activateRuleRequestDtoSchema: z.ZodObject<{
857
+ instanceId: z.ZodNullable<z.ZodString>;
858
+ description: z.ZodString;
859
+ }, "strip", z.ZodTypeAny, {
860
+ description: string;
861
+ instanceId: string | null;
862
+ }, {
863
+ description: string;
864
+ instanceId: string | null;
865
+ }>;
866
+ type ActivateRuleRequestDto = z.infer<typeof activateRuleRequestDtoSchema>;
867
+
868
+ /**
869
+ * Initialize Rules Management Api functions
870
+ * @param client Assortment Client instance
871
+ * @returns An object containing Rules Management API functions
872
+ */
873
+ declare function createRulesManagementApi(client: AsstClient): {
874
+ activateRule: (ruleId: string, request: ActivateRuleRequestDto, signal?: AbortSignal) => Promise<void>;
875
+ };
876
+
877
+ export { type ActivateRuleRequestDto, type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, CompanyBriefByOrg, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createRulesManagementApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
package/dist/index.js CHANGED
@@ -11,12 +11,13 @@ import {
11
11
  createItemsApiV2,
12
12
  createLocaleApi,
13
13
  createProductTypesApi,
14
+ createRulesManagementApi,
14
15
  createSpreadsheetTemplateApi,
15
16
  createTradingPartnerAccessApi,
16
17
  createTradingPartnerSettingsApi,
17
18
  createUniqueCriteriaApi,
18
19
  createWhoAmIApi
19
- } from "./chunk-U7UJOT4D.js";
20
+ } from "./chunk-IZLZKWK7.js";
20
21
  import {
21
22
  AsstClient,
22
23
  BASE_URLS,
@@ -43,6 +44,7 @@ export {
43
44
  createItemsApiV2,
44
45
  createLocaleApi,
45
46
  createProductTypesApi,
47
+ createRulesManagementApi,
46
48
  createSpreadsheetTemplateApi,
47
49
  createTradingPartnerAccessApi,
48
50
  createTradingPartnerSettingsApi,
package/dist/msw.cjs CHANGED
@@ -32,6 +32,7 @@ __export(msw_exports, {
32
32
  createItemsApiV2Handlers: () => createItemsApiV2Handlers,
33
33
  createLocaleApiHandlers: () => createLocaleApiHandlers,
34
34
  createProductTypesApiHandlers: () => createProductTypesApiHandlers,
35
+ createRulesManagementApiHandlers: () => createRulesManagementApiHandlers,
35
36
  createSpreadsheetTemplateApiHandlers: () => createSpreadsheetTemplateApiHandlers,
36
37
  createTradingPartnerAccessApiHandlers: () => createTradingPartnerAccessApiHandlers,
37
38
  createTradingPartnerSettingsApiHandlers: () => createTradingPartnerSettingsApiHandlers,
@@ -5548,6 +5549,27 @@ function createItemsApiV2Handlers(client) {
5548
5549
  getItemStatus
5549
5550
  };
5550
5551
  }
5552
+
5553
+ // lib/rulesManagement/mockHandlers.ts
5554
+ var import_msw18 = require("msw");
5555
+
5556
+ // lib/rulesManagement/index.ts
5557
+ var BASE_URL18 = "rules";
5558
+
5559
+ // lib/rulesManagement/mockHandlers.ts
5560
+ function createRulesManagementApiHandlers(client) {
5561
+ function activateRule(resolver = () => {
5562
+ return import_msw18.HttpResponse.json({}, { status: 200 });
5563
+ }) {
5564
+ return import_msw18.http.post(
5565
+ `${client.getBaseUrl()}${BASE_URL18}/:ruleId/activate`,
5566
+ resolver
5567
+ );
5568
+ }
5569
+ return {
5570
+ activateRule
5571
+ };
5572
+ }
5551
5573
  // Annotate the CommonJS export names for ESM import in node:
5552
5574
  0 && (module.exports = {
5553
5575
  createCategoriesApiHandlers,
@@ -5562,6 +5584,7 @@ function createItemsApiV2Handlers(client) {
5562
5584
  createItemsApiV2Handlers,
5563
5585
  createLocaleApiHandlers,
5564
5586
  createProductTypesApiHandlers,
5587
+ createRulesManagementApiHandlers,
5565
5588
  createSpreadsheetTemplateApiHandlers,
5566
5589
  createTradingPartnerAccessApiHandlers,
5567
5590
  createTradingPartnerSettingsApiHandlers,
package/dist/msw.d.cts CHANGED
@@ -723,4 +723,15 @@ declare function createItemsApiV2Handlers(client: AsstClient): {
723
723
  };
724
724
  };
725
725
 
726
- export { createCategoriesApiHandlers, createCompaniesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createItemsApiV2Handlers, createLocaleApiHandlers, createProductTypesApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };
726
+ /**
727
+ * Generate collection of MSW request handlers for `RulesManagementApi`
728
+ * @param client Assortment Client instance
729
+ * @returns An object containing functions to generate MSW request handlers
730
+ */
731
+ declare function createRulesManagementApiHandlers(client: AsstClient): {
732
+ activateRule: (resolver?: HttpResponseResolver<{
733
+ ruleId: string;
734
+ }, never, Record<string, never>>) => msw.HttpHandler;
735
+ };
736
+
737
+ export { createCategoriesApiHandlers, createCompaniesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createItemsApiV2Handlers, createLocaleApiHandlers, createProductTypesApiHandlers, createRulesManagementApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };
package/dist/msw.d.ts CHANGED
@@ -723,4 +723,15 @@ declare function createItemsApiV2Handlers(client: AsstClient): {
723
723
  };
724
724
  };
725
725
 
726
- export { createCategoriesApiHandlers, createCompaniesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createItemsApiV2Handlers, createLocaleApiHandlers, createProductTypesApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };
726
+ /**
727
+ * Generate collection of MSW request handlers for `RulesManagementApi`
728
+ * @param client Assortment Client instance
729
+ * @returns An object containing functions to generate MSW request handlers
730
+ */
731
+ declare function createRulesManagementApiHandlers(client: AsstClient): {
732
+ activateRule: (resolver?: HttpResponseResolver<{
733
+ ruleId: string;
734
+ }, never, Record<string, never>>) => msw.HttpHandler;
735
+ };
736
+
737
+ export { createCategoriesApiHandlers, createCompaniesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createItemsApiV2Handlers, createLocaleApiHandlers, createProductTypesApiHandlers, createRulesManagementApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };
package/dist/msw.js CHANGED
@@ -8,6 +8,7 @@ import {
8
8
  BASE_URL15,
9
9
  BASE_URL16,
10
10
  BASE_URL17,
11
+ BASE_URL18,
11
12
  BASE_URL2,
12
13
  BASE_URL3,
13
14
  BASE_URL4,
@@ -19,7 +20,7 @@ import {
19
20
  BASE_URL_V2,
20
21
  FlattenedItemIdentifierKeysSchema,
21
22
  retailerTradingPartnerStages
22
- } from "./chunk-U7UJOT4D.js";
23
+ } from "./chunk-IZLZKWK7.js";
23
24
  import {
24
25
  attrProdTypeSchema,
25
26
  catalogBriefResponseSchema,
@@ -577,6 +578,22 @@ function createItemsApiV2Handlers(client) {
577
578
  getItemStatus
578
579
  };
579
580
  }
581
+
582
+ // lib/rulesManagement/mockHandlers.ts
583
+ import { http as http18, HttpResponse as HttpResponse18 } from "msw";
584
+ function createRulesManagementApiHandlers(client) {
585
+ function activateRule(resolver = () => {
586
+ return HttpResponse18.json({}, { status: 200 });
587
+ }) {
588
+ return http18.post(
589
+ `${client.getBaseUrl()}${BASE_URL18}/:ruleId/activate`,
590
+ resolver
591
+ );
592
+ }
593
+ return {
594
+ activateRule
595
+ };
596
+ }
580
597
  export {
581
598
  createCategoriesApiHandlers,
582
599
  createCompaniesApiHandlers,
@@ -590,6 +607,7 @@ export {
590
607
  createItemsApiV2Handlers,
591
608
  createLocaleApiHandlers,
592
609
  createProductTypesApiHandlers,
610
+ createRulesManagementApiHandlers,
593
611
  createSpreadsheetTemplateApiHandlers,
594
612
  createTradingPartnerAccessApiHandlers,
595
613
  createTradingPartnerSettingsApiHandlers,
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "description": "Assortment Api is a collection of HTTP functions to use Assortment endpoints",
4
4
  "author": "Assortment",
5
5
  "repository": "https://github.com/SPSCommerce/assortment-main/tree/main/ui/packages/asst-api",
6
- "version": "4.6.0",
6
+ "version": "4.7.0",
7
7
  "files": [
8
8
  "dist"
9
9
  ],