@wix/auto_sdk_stores_ribbons-v-3 1.0.24 → 1.0.25

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { Ribbon, GetRibbonOptions, UpdateRibbon, UpdateRibbonOptions, QueryRibbonsOptions, RibbonsQueryBuilder, BulkCreateRibbonsOptions, BulkCreateRibbonsResponse, MaskedRibbon, BulkUpdateRibbonsOptions, BulkUpdateRibbonsResponse, GetOrCreateRibbonOptions, GetOrCreateRibbonResponse, BulkGetOrCreateRibbonsOptions, BulkGetOrCreateRibbonsResponse, BulkDeleteRibbonsResponse, RibbonCreatedEnvelope, RibbonDeletedEnvelope, RibbonUpdatedEnvelope } from './index.typings.js';
-export { ActionEvent, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateRibbonsRequest, BulkDeleteRibbonsRequest, BulkGetOrCreateRibbonsRequest, BulkRibbonResult, BulkUpdateRibbonsRequest, CreateRibbonRequest, CreateRibbonResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, DeleteRibbonRequest, DeleteRibbonResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, GetOrCreateRibbonRequest, GetRibbonRequest, GetRibbonResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, MessageEnvelope, Page, QueryRibbonsRequest, QueryRibbonsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RibbonsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, URI, UpdateRibbonRequest, UpdateRibbonResponse, V3BulkRibbonResult, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+import { Ribbon, GetRibbonOptions, UpdateRibbon, UpdateRibbonOptions, BulkCreateRibbonsOptions, BulkCreateRibbonsResponse, MaskedRibbon, BulkUpdateRibbonsOptions, BulkUpdateRibbonsResponse, GetOrCreateRibbonOptions, GetOrCreateRibbonResponse, BulkGetOrCreateRibbonsOptions, BulkGetOrCreateRibbonsResponse, BulkDeleteRibbonsResponse, RibbonCreatedEnvelope, RibbonDeletedEnvelope, RibbonUpdatedEnvelope, CursorQuery, typedQueryRibbons, QueryRibbonsOptions, RibbonsQueryBuilder } from './index.typings.js';
+export { ActionEvent, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateRibbonsRequest, BulkDeleteRibbonsRequest, BulkGetOrCreateRibbonsRequest, BulkRibbonResult, BulkUpdateRibbonsRequest, CreateRibbonRequest, CreateRibbonResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, CustomTag, DeleteRibbonRequest, DeleteRibbonResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, GetOrCreateRibbonRequest, GetRibbonRequest, GetRibbonResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, MessageEnvelope, Page, QueryRibbonsRequest, QueryRibbonsResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RibbonsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, URI, UpdateRibbonRequest, UpdateRibbonResponse, V3BulkRibbonResult, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
 declare function createRibbon$1(httpClient: HttpClient): CreateRibbonSignature;
 interface CreateRibbonSignature {
@@ -47,27 +47,6 @@ interface DeleteRibbonSignature {
      */
     (ribbonId: string): Promise<void>;
 }
-declare function queryRibbons$1(httpClient: HttpClient): QueryRibbonsSignature;
-interface QueryRibbonsSignature {
-    /**
-     * Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging.
-     * Pass supported values to the `fields` array in the request to include those fields in the response.
-     *
-     *
-     * Query Brands runs with these defaults, which you can override:
-     *
-     * - `createdDate` is sorted in `DESC` order
-     * - `cursorPaging.limit` is `100`
-     *
-     * For field support for filters and sorting,
-     * see [Ribbons: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/supported-filters-and-sorting).
-     *
-     * To learn about working with _Query_ endpoints, see
-     * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
-     * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
-     */
-    (options?: QueryRibbonsOptions): RibbonsQueryBuilder;
-}
 declare function bulkCreateRibbons$1(httpClient: HttpClient): BulkCreateRibbonsSignature;
 interface BulkCreateRibbonsSignature {
     /**
@@ -116,16 +95,22 @@ declare const onRibbonCreated$1: EventDefinition<RibbonCreatedEnvelope, "wix.sto
 declare const onRibbonDeleted$1: EventDefinition<RibbonDeletedEnvelope, "wix.stores.catalog.v3.ribbon_deleted">;
 declare const onRibbonUpdated$1: EventDefinition<RibbonUpdatedEnvelope, "wix.stores.catalog.v3.ribbon_updated">;
 
+declare function customQueryRibbons(httpClient: HttpClient): {
+    (query: CursorQuery): ReturnType<typeof typedQueryRibbons>;
+    (query: CursorQuery, options: QueryRibbonsOptions): ReturnType<typeof typedQueryRibbons>;
+    (): RibbonsQueryBuilder;
+    (options: QueryRibbonsOptions): RibbonsQueryBuilder;
+};
 declare const createRibbon: MaybeContext<BuildRESTFunction<typeof createRibbon$1> & typeof createRibbon$1>;
 declare const getRibbon: MaybeContext<BuildRESTFunction<typeof getRibbon$1> & typeof getRibbon$1>;
 declare const updateRibbon: MaybeContext<BuildRESTFunction<typeof updateRibbon$1> & typeof updateRibbon$1>;
 declare const deleteRibbon: MaybeContext<BuildRESTFunction<typeof deleteRibbon$1> & typeof deleteRibbon$1>;
-declare const queryRibbons: MaybeContext<BuildRESTFunction<typeof queryRibbons$1> & typeof queryRibbons$1>;
 declare const bulkCreateRibbons: MaybeContext<BuildRESTFunction<typeof bulkCreateRibbons$1> & typeof bulkCreateRibbons$1>;
 declare const bulkUpdateRibbons: MaybeContext<BuildRESTFunction<typeof bulkUpdateRibbons$1> & typeof bulkUpdateRibbons$1>;
 declare const getOrCreateRibbon: MaybeContext<BuildRESTFunction<typeof getOrCreateRibbon$1> & typeof getOrCreateRibbon$1>;
 declare const bulkGetOrCreateRibbons: MaybeContext<BuildRESTFunction<typeof bulkGetOrCreateRibbons$1> & typeof bulkGetOrCreateRibbons$1>;
 declare const bulkDeleteRibbons: MaybeContext<BuildRESTFunction<typeof bulkDeleteRibbons$1> & typeof bulkDeleteRibbons$1>;
+declare const queryRibbons: MaybeContext<BuildRESTFunction<typeof customQueryRibbons> & typeof customQueryRibbons>;
 /** */
 declare const onRibbonCreated: BuildEventDefinition<typeof onRibbonCreated$1> & typeof onRibbonCreated$1;
 /** */
@@ -133,4 +118,4 @@ declare const onRibbonDeleted: BuildEventDefinition<typeof onRibbonDeleted$1> &
 /** */
 declare const onRibbonUpdated: BuildEventDefinition<typeof onRibbonUpdated$1> & typeof onRibbonUpdated$1;
 
-export { BulkCreateRibbonsOptions, BulkCreateRibbonsResponse, BulkDeleteRibbonsResponse, BulkGetOrCreateRibbonsOptions, BulkGetOrCreateRibbonsResponse, BulkUpdateRibbonsOptions, BulkUpdateRibbonsResponse, GetOrCreateRibbonOptions, GetOrCreateRibbonResponse, GetRibbonOptions, MaskedRibbon, QueryRibbonsOptions, Ribbon, RibbonCreatedEnvelope, RibbonDeletedEnvelope, RibbonUpdatedEnvelope, RibbonsQueryBuilder, UpdateRibbon, UpdateRibbonOptions, bulkCreateRibbons, bulkDeleteRibbons, bulkGetOrCreateRibbons, bulkUpdateRibbons, createRibbon, deleteRibbon, getOrCreateRibbon, getRibbon, onRibbonCreated, onRibbonDeleted, onRibbonUpdated, queryRibbons, updateRibbon };
+export { BulkCreateRibbonsOptions, BulkCreateRibbonsResponse, BulkDeleteRibbonsResponse, BulkGetOrCreateRibbonsOptions, BulkGetOrCreateRibbonsResponse, BulkUpdateRibbonsOptions, BulkUpdateRibbonsResponse, CursorQuery, GetOrCreateRibbonOptions, GetOrCreateRibbonResponse, GetRibbonOptions, MaskedRibbon, QueryRibbonsOptions, Ribbon, RibbonCreatedEnvelope, RibbonDeletedEnvelope, RibbonUpdatedEnvelope, RibbonsQueryBuilder, UpdateRibbon, UpdateRibbonOptions, bulkCreateRibbons, bulkDeleteRibbons, bulkGetOrCreateRibbons, bulkUpdateRibbons, createRibbon, deleteRibbon, getOrCreateRibbon, getRibbon, onRibbonCreated, onRibbonDeleted, onRibbonUpdated, queryRibbons, updateRibbon };

package/build/cjs/index.js

@@ -596,6 +596,32 @@ function queryRibbons2(options) {
     transformationPaths: {}
   });
 }
+async function typedQueryRibbons(query, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    query,
+    ...options
+  });
+  const reqOpts = queryRibbons(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["query", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function bulkCreateRibbons2(ribbons, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -776,6 +802,14 @@ function queryRibbons3(httpClient) {
     { httpClient }
   );
 }
+function typedQueryRibbons2(httpClient) {
+  return (query, options) => typedQueryRibbons(
+    query,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 function bulkCreateRibbons3(httpClient) {
   return (ribbons, options) => bulkCreateRibbons2(
     ribbons,
@@ -867,16 +901,28 @@ var onRibbonUpdated = (0, import_sdk_types.EventDefinition)(
 // src/stores-catalog-v3-ribbon-ribbons-v-3.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
 var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
+var import_query_method_router = require("@wix/sdk-runtime/query-method-router");
+function customQueryRibbons(httpClient) {
+  const router = (0, import_query_method_router.createQueryOverloadRouter)({
+    builderQueryFunction: (options) => queryRibbons3(httpClient)(options),
+    typedQueryFunction: (query, options) => typedQueryRibbons2(httpClient)(query, options),
+    hasOptionsParameter: true
+  });
+  function overloadedQuery(queryOrOptions, options) {
+    return router(...arguments);
+  }
+  return overloadedQuery;
+}
 var createRibbon4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(createRibbon3);
 var getRibbon4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getRibbon3);
 var updateRibbon4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateRibbon3);
 var deleteRibbon4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteRibbon3);
-var queryRibbons4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(queryRibbons3);
 var bulkCreateRibbons4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkCreateRibbons3);
 var bulkUpdateRibbons4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkUpdateRibbons3);
 var getOrCreateRibbon4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getOrCreateRibbon3);
 var bulkGetOrCreateRibbons4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkGetOrCreateRibbons3);
 var bulkDeleteRibbons4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkDeleteRibbons3);
+var queryRibbons4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQueryRibbons);
 var onRibbonCreated2 = (0, import_event_definition_modules.createEventModule)(onRibbonCreated);
 var onRibbonDeleted2 = (0, import_event_definition_modules.createEventModule)(onRibbonDeleted);
 var onRibbonUpdated2 = (0, import_event_definition_modules.createEventModule)(onRibbonUpdated);