@remkoj/optimizely-graph-client 6.0.0-pre9 → 6.0.0-rc.1

package/README.md

@@ -1,4 +1,8 @@
 # Optimizely Graph Client <!-- omit in toc -->
+
+> [!WARNING]
+> There'll be an update of Optimizely SaaS CMS that is incompatible with all SDK versions prior to 5.1.6. If you don't upgrade, you will see empty pages (main website) and "Component not found" messages (preview).
+
 An extension of the [graphql-request](https://www.npmjs.com/package/graphql-request) package, providing the configuration and additional logic needed to connect with Optimizely Graph.
 
 ## Within this document <!-- omit in toc -->
@@ -298,4 +302,4 @@ const channel = ChannelRepository.createDefinition(
 )
 ```
 
-*1. The application definitions are not available through Graph for SaaS CMS, hence the repository can only instantiated for PaaS CMS 12* 
+*1. The application definitions are not available through Graph for SaaS CMS, hence the repository can only instantiated for PaaS CMS 12* 

package/dist/admin-api/client/OptimizelyGraphAdminApi.d.ts

@@ -5,8 +5,7 @@ import { DefinitionV2Service } from './services/DefinitionV2Service.js';
 import { DefinitionV3Service } from './services/DefinitionV3Service.js';
 import { LogsService } from './services/LogsService.js';
 import { OidcService } from './services/OidcService.js';
-import { PinnedCollectionsService } from './services/PinnedCollectionsService.js';
-import { PinnedItemsService } from './services/PinnedItemsService.js';
+import { PinnedResultsService } from './services/PinnedResultsService.js';
 import { QueryGraphQlService } from './services/QueryGraphQlService.js';
 import { ResourcesService } from './services/ResourcesService.js';
 import { WebhooksService } from './services/WebhooksService.js';
@@ -17,8 +16,7 @@ export declare class OptimizelyGraphAdminApi {
     readonly definitionV3: DefinitionV3Service;
     readonly logs: LogsService;
     readonly oidc: OidcService;
-    readonly pinnedCollections: PinnedCollectionsService;
-    readonly pinnedItems: PinnedItemsService;
+    readonly pinnedResults: PinnedResultsService;
     readonly queryGraphQl: QueryGraphQlService;
     readonly resources: ResourcesService;
     readonly webhooks: WebhooksService;

package/dist/admin-api/client/OptimizelyGraphAdminApi.js

@@ -4,8 +4,7 @@ import { DefinitionV2Service } from './services/DefinitionV2Service.js';
 import { DefinitionV3Service } from './services/DefinitionV3Service.js';
 import { LogsService } from './services/LogsService.js';
 import { OidcService } from './services/OidcService.js';
-import { PinnedCollectionsService } from './services/PinnedCollectionsService.js';
-import { PinnedItemsService } from './services/PinnedItemsService.js';
+import { PinnedResultsService } from './services/PinnedResultsService.js';
 import { QueryGraphQlService } from './services/QueryGraphQlService.js';
 import { ResourcesService } from './services/ResourcesService.js';
 import { WebhooksService } from './services/WebhooksService.js';
@@ -13,7 +12,7 @@ export class OptimizelyGraphAdminApi {
     constructor(config, HttpRequest = FetchHttpRequest) {
         this.request = new HttpRequest({
             BASE: config?.BASE ?? 'https://prod.cg.optimizely.com',
-            VERSION: config?.VERSION ?? '3.22.0',
+            VERSION: config?.VERSION ?? '3.25.0',
             WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
             CREDENTIALS: config?.CREDENTIALS ?? 'include',
             TOKEN: config?.TOKEN,
@@ -27,8 +26,7 @@ export class OptimizelyGraphAdminApi {
         this.definitionV3 = new DefinitionV3Service(this.request);
         this.logs = new LogsService(this.request);
         this.oidc = new OidcService(this.request);
-        this.pinnedCollections = new PinnedCollectionsService(this.request);
-        this.pinnedItems = new PinnedItemsService(this.request);
+        this.pinnedResults = new PinnedResultsService(this.request);
         this.queryGraphQl = new QueryGraphQlService(this.request);
         this.resources = new ResourcesService(this.request);
         this.webhooks = new WebhooksService(this.request);

package/dist/admin-api/client/OptimizelyGraphAdminApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"OptimizelyGraphAdminApi.js","sourceRoot":"","sources":["../../../src/admin-api/client/OptimizelyGraphAdminApi.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,MAAM,OAAO,uBAAuB;IAYhC,YAAY,MAA+B,EAAE,cAAsC,gBAAgB;QAC/F,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC;YAC3B,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,gCAAgC;YACtD,OAAO,EAAE,MAAM,EAAE,OAAO,IAAI,QAAQ;YACpC,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,IAAI,KAAK;YACnD,WAAW,EAAE,MAAM,EAAE,WAAW,IAAI,SAAS;YAC7C,KAAK,EAAE,MAAM,EAAE,KAAK;YACpB,QAAQ,EAAE,MAAM,EAAE,QAAQ;YAC1B,QAAQ,EAAE,MAAM,EAAE,QAAQ;YAC1B,OAAO,EAAE,MAAM,EAAE,OAAO;YACxB,WAAW,EAAE,MAAM,EAAE,WAAW;SACnC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CACJ"}
+{"version":3,"file":"OptimizelyGraphAdminApi.js","sourceRoot":"","sources":["../../../src/admin-api/client/OptimizelyGraphAdminApi.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,MAAM,OAAO,uBAAuB;IAWhC,YAAY,MAA+B,EAAE,cAAsC,gBAAgB;QAC/F,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC;YAC3B,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,gCAAgC;YACtD,OAAO,EAAE,MAAM,EAAE,OAAO,IAAI,QAAQ;YACpC,gBAAgB,EAAE,MAAM,EAAE,gBAAgB,IAAI,KAAK;YACnD,WAAW,EAAE,MAAM,EAAE,WAAW,IAAI,SAAS;YAC7C,KAAK,EAAE,MAAM,EAAE,KAAK;YACpB,QAAQ,EAAE,MAAM,EAAE,QAAQ;YAC1B,QAAQ,EAAE,MAAM,EAAE,QAAQ;YAC1B,OAAO,EAAE,MAAM,EAAE,OAAO;YACxB,WAAW,EAAE,MAAM,EAAE,WAAW;SACnC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CACJ"}

package/dist/admin-api/client/core/OpenAPI.js

@@ -1,6 +1,6 @@
 export const OpenAPI = {
     BASE: 'https://prod.cg.optimizely.com',
-    VERSION: '3.22.0',
+    VERSION: '3.25.0',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/admin-api/client/index.d.ts

@@ -21,14 +21,15 @@ export type { GraphQLRequest } from './models/GraphQLRequest.js';
 export type { GraphQLResponse } from './models/GraphQLResponse.js';
 export type { LinkConfig } from './models/LinkConfig.js';
 export type { LinkMap } from './models/LinkMap.js';
-export type { MatchingPinnedSelector } from './models/MatchingPinnedSelector.js';
 export type { OperationMap } from './models/OperationMap.js';
 export type { Optional_string_ } from './models/Optional_string_.js';
+export type { Partial_PinnedCollectionPayload_ } from './models/Partial_PinnedCollectionPayload_.js';
 export type { Partial_Record_string_OperationMap__ } from './models/Partial_Record_string_OperationMap__.js';
 export type { PinnedCollectionPayload } from './models/PinnedCollectionPayload.js';
 export type { PinnedCollectionResult } from './models/PinnedCollectionResult.js';
 export type { PinnedItemPayload } from './models/PinnedItemPayload.js';
 export type { PinnedItemResult } from './models/PinnedItemResult.js';
+export type { PinnedResultMatchParams } from './models/PinnedResultMatchParams.js';
 export { Preset } from './models/Preset.js';
 export type { Property_V2 } from './models/Property_V2.js';
 export type { Property_V3 } from './models/Property_V3.js';
@@ -39,6 +40,7 @@ export type { Record_string_any_ } from './models/Record_string_any_.js';
 export type { Record_string_string_ } from './models/Record_string_string_.js';
 export type { Request } from './models/Request.js';
 export type { RequestLog } from './models/RequestLog.js';
+export type { Response } from './models/Response.js';
 export { Slot } from './models/Slot.js';
 export type { SourceInfo } from './models/SourceInfo.js';
 export type { SourceInfoMap } from './models/SourceInfoMap.js';
@@ -53,8 +55,7 @@ export { DefinitionV2Service } from './services/DefinitionV2Service.js';
 export { DefinitionV3Service } from './services/DefinitionV3Service.js';
 export { LogsService } from './services/LogsService.js';
 export { OidcService } from './services/OidcService.js';
-export { PinnedCollectionsService } from './services/PinnedCollectionsService.js';
-export { PinnedItemsService } from './services/PinnedItemsService.js';
+export { PinnedResultsService } from './services/PinnedResultsService.js';
 export { QueryGraphQlService } from './services/QueryGraphQlService.js';
 export { ResourcesService } from './services/ResourcesService.js';
 export { WebhooksService } from './services/WebhooksService.js';

package/dist/admin-api/client/index.js

@@ -15,8 +15,7 @@ export { DefinitionV2Service } from './services/DefinitionV2Service.js';
 export { DefinitionV3Service } from './services/DefinitionV3Service.js';
 export { LogsService } from './services/LogsService.js';
 export { OidcService } from './services/OidcService.js';
-export { PinnedCollectionsService } from './services/PinnedCollectionsService.js';
-export { PinnedItemsService } from './services/PinnedItemsService.js';
+export { PinnedResultsService } from './services/PinnedResultsService.js';
 export { QueryGraphQlService } from './services/QueryGraphQlService.js';
 export { ResourcesService } from './services/ResourcesService.js';
 export { WebhooksService } from './services/WebhooksService.js';

package/dist/admin-api/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/admin-api/client/index.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAa5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAepD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAU5C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAUxC,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/admin-api/client/index.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAa5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAgBpD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAW5C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAUxC,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/admin-api/client/models/Partial_PinnedCollectionPayload_.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Make all properties in T optional
+ */
+export type Partial_PinnedCollectionPayload_ = {
+    title?: string;
+    key?: string;
+    isActive?: boolean;
+};

package/dist/admin-api/client/models/Partial_PinnedCollectionPayload_.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Partial_PinnedCollectionPayload_.js.map

package/dist/admin-api/client/models/Partial_PinnedCollectionPayload_.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Partial_PinnedCollectionPayload_.js","sourceRoot":"","sources":["../../../../src/admin-api/client/models/Partial_PinnedCollectionPayload_.ts"],"names":[],"mappings":""}

package/dist/admin-api/client/models/PinnedCollectionPayload.d.ts

@@ -1,4 +1,5 @@
 export type PinnedCollectionPayload = {
     title: string;
+    key: string;
     isActive?: boolean;
 };

package/dist/admin-api/client/models/PinnedCollectionResult.d.ts

@@ -1,7 +1,8 @@
 export type PinnedCollectionResult = {
     title: string;
+    key: string;
     isActive?: boolean;
     id: string;
-    createdAt: number;
-    updatedAt: number;
+    createdAt: string;
+    updatedAt: string;
 };

package/dist/admin-api/client/models/PinnedItemPayload.d.ts

@@ -1,7 +1,27 @@
 export type PinnedItemPayload = {
+    /**
+     * Phrase or keyword to match
+     */
     phrases: string;
+    /**
+     * Document id to pin
+     */
     targetKey: string;
+    /**
+     * Language code (e.g. `en`, `fr`, `de`, etc.)
+     *
+     * - `null` value means the pinned item is applicable to all languages
+     *
+     * - Empty string (`""`) value is for NEUTRAL locale
+     */
     language?: string | null;
+    /**
+     * Priority of the pinned item (lower number means lower priority)
+     *
+     * - Default value is `1000`
+     *
+     * - Example: `1`, `10`, `100`, etc.
+     */
     priority?: number;
     isActive?: boolean;
 };

package/dist/admin-api/client/models/PinnedItemResult.d.ts

@@ -1,11 +1,31 @@
 export type PinnedItemResult = {
+    /**
+     * Phrase or keyword to match
+     */
     phrases: string;
+    /**
+     * Document id to pin
+     */
     targetKey: string;
+    /**
+     * Language code (e.g. `en`, `fr`, `de`, etc.)
+     *
+     * - `null` value means the pinned item is applicable to all languages
+     *
+     * - Empty string (`""`) value is for NEUTRAL locale
+     */
     language?: string | null;
+    /**
+     * Priority of the pinned item (lower number means lower priority)
+     *
+     * - Default value is `1000`
+     *
+     * - Example: `1`, `10`, `100`, etc.
+     */
     priority?: number;
     isActive?: boolean;
     id: string;
     collectionId: string;
-    createdAt: number;
-    updatedAt: number;
+    createdAt: string;
+    updatedAt: string;
 };

package/dist/admin-api/client/models/PinnedResultMatchParams.d.ts

@@ -0,0 +1,8 @@
+export type PinnedResultMatchParams = {
+    phrase: string;
+    collectionIds?: Array<string>;
+    collectionKeys?: Array<string>;
+    languages?: Array<string | null> | null;
+    onlyActive?: boolean;
+    limit?: number;
+};

package/dist/admin-api/client/models/PinnedResultMatchParams.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PinnedResultMatchParams.js.map

package/dist/admin-api/client/models/PinnedResultMatchParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PinnedResultMatchParams.js","sourceRoot":"","sources":["../../../../src/admin-api/client/models/PinnedResultMatchParams.ts"],"names":[],"mappings":""}

package/dist/admin-api/client/models/Response.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This Fetch API interface represents the response to a request.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response)
+ */
+export type Response = {};

package/dist/admin-api/client/models/Response.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Response.js.map

package/dist/admin-api/client/models/Response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Response.js","sourceRoot":"","sources":["../../../../src/admin-api/client/models/Response.ts"],"names":[],"mappings":""}

package/dist/admin-api/client/services/{PinnedItemsService.d.ts → PinnedResultsService.d.ts}

@@ -1,39 +1,55 @@
-import type { MatchingPinnedSelector } from '../models/MatchingPinnedSelector.js';
+import type { Partial_PinnedCollectionPayload_ } from '../models/Partial_PinnedCollectionPayload_.js';
+import type { PinnedCollectionPayload } from '../models/PinnedCollectionPayload.js';
+import type { PinnedCollectionResult } from '../models/PinnedCollectionResult.js';
 import type { PinnedItemPayload } from '../models/PinnedItemPayload.js';
 import type { PinnedItemResult } from '../models/PinnedItemResult.js';
+import type { PinnedResultMatchParams } from '../models/PinnedResultMatchParams.js';
 import type { CancelablePromise } from '../core/CancelablePromise.js';
 import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
-export declare class PinnedItemsService {
+export declare class PinnedResultsService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
     /**
-     * Get pinned item by id
-     * Get single pinned item by id
-     * @param collectionId pinned collection id
-     * @param id pinned id (id)
-     * @returns PinnedItemResult PinnedItemResult
+     * Get pinned collection(s)
+     * Get pinned collections
+     * @param page
+     * @returns PinnedCollectionResult Ok
      * @throws ApiError
      */
-    getPinnedItemHandler(collectionId: string, id: string): CancelablePromise<PinnedItemResult>;
+    listPinnedCollectionHandler(page?: number): CancelablePromise<Array<PinnedCollectionResult>>;
     /**
-     * Remove pinned item
-     * Remove single pinned item
-     * @param collectionId pinned collection id
-     * @param id pinned id (id)
-     * @returns PinnedItemResult Ok
+     * Register a pinned collection
+     * Register a pinned collection
+     * @param requestBody
+     * @returns PinnedCollectionResult Ok
      * @throws ApiError
      */
-    deletePinnedItemHandler(collectionId: string, id: string): CancelablePromise<PinnedItemResult>;
+    createPinnedCollectionHandler(requestBody: PinnedCollectionPayload): CancelablePromise<PinnedCollectionResult>;
     /**
-     * Update a pinned item
-     * Update a single pinned item
-     * @param collectionId pinned collection id
-     * @param id pinned id (id)
+     * Get pinned collection by Id
+     * Get collection by Id
+     * @param collectionId Pinned collection id
+     * @returns PinnedCollectionResult Ok
+     * @throws ApiError
+     */
+    getPinnedCollectionHandler(collectionId: string): CancelablePromise<PinnedCollectionResult>;
+    /**
+     * Update a pinned collection
+     * Update pinned collection by Id
+     * @param collectionId
      * @param requestBody
-     * @returns PinnedItemResult Ok
+     * @returns PinnedCollectionResult Ok
      * @throws ApiError
      */
-    updatePinnedItemHandler(collectionId: string, id: string, requestBody: PinnedItemPayload): CancelablePromise<PinnedItemResult>;
+    updatePinnedCollectionHandler(collectionId: string, requestBody: Partial_PinnedCollectionPayload_): CancelablePromise<PinnedCollectionResult>;
+    /**
+     * Delete a pinned collection
+     * Delete pinned collection by Id
+     * @param collectionId
+     * @returns void
+     * @throws ApiError
+     */
+    deletePinnedCollectionHandler(collectionId: string): CancelablePromise<void>;
     /**
      * Get list of pinned items by collection id
      * Get list of pinned items by given pinned collection id
@@ -46,6 +62,15 @@ export declare class PinnedItemsService {
      * @throws ApiError
      */
     listPinnedItemHandler(collectionId: string, limit?: number, offset?: number, phrase?: string, sort?: string): CancelablePromise<Array<PinnedItemResult>>;
+    /**
+     * Create a new pinned item
+     * Create a new pinned item, collectionId must be created before creating pinned item
+     * @param collectionId pinned collection id
+     * @param requestBody
+     * @returns PinnedItemResult Ok
+     * @throws ApiError
+     */
+    createPinnedItemHandler(collectionId: string, requestBody: PinnedItemPayload): CancelablePromise<PinnedItemResult>;
     /**
      * Clear pinned items in collection
      * Clear pinned items in collection
@@ -55,20 +80,39 @@ export declare class PinnedItemsService {
      */
     clearPinnedItemHandler(collectionId: string): CancelablePromise<void>;
     /**
-     * Create a new pinned item
-     * Create a new pinned item, collectionId must be created before creating pinned item
+     * Get pinned item by id
+     * Get single pinned item by id
+     * @param collectionId pinned collection id
+     * @param id pinned id (id)
+     * @returns PinnedItemResult PinnedItemResult
+     * @throws ApiError
+     */
+    getPinnedItemHandler(collectionId: string, id: string): CancelablePromise<PinnedItemResult>;
+    /**
+     * Update a pinned item
+     * Update a single pinned item
      * @param collectionId pinned collection id
+     * @param id pinned id (id)
      * @param requestBody
      * @returns PinnedItemResult Ok
      * @throws ApiError
      */
-    createPinnedItemHandler(collectionId: string, requestBody: PinnedItemPayload): CancelablePromise<PinnedItemResult>;
+    updatePinnedItemHandler(collectionId: string, id: string, requestBody: PinnedItemPayload): CancelablePromise<PinnedItemResult>;
     /**
-     * Get matched pinned by phrases
-     * Get matched pinned by phrases
-     * @param requestBody MatchingPinnedSelector
+     * Remove pinned item
+     * Remove single pinned item
+     * @param collectionId pinned collection id
+     * @param id pinned id (id)
+     * @returns PinnedItemResult Ok
+     * @throws ApiError
+     */
+    deletePinnedItemHandler(collectionId: string, id: string): CancelablePromise<PinnedItemResult>;
+    /**
+     * Get pinned results
+     * Get pinned results by matching phrases
+     * @param requestBody
      * @returns PinnedItemResult Ok
      * @throws ApiError
      */
-    matchPinnedItemHandler(requestBody: MatchingPinnedSelector): CancelablePromise<Array<PinnedItemResult>>;
+    matchPinnedItemHandler(requestBody: PinnedResultMatchParams): CancelablePromise<Array<PinnedItemResult>>;
 }

package/dist/admin-api/client/services/{PinnedItemsService.js → PinnedResultsService.js}

@@ -1,64 +1,89 @@
-export class PinnedItemsService {
+export class PinnedResultsService {
     constructor(httpRequest) {
         this.httpRequest = httpRequest;
     }
     /**
-     * Get pinned item by id
-     * Get single pinned item by id
-     * @param collectionId pinned collection id
-     * @param id pinned id (id)
-     * @returns PinnedItemResult PinnedItemResult
+     * Get pinned collection(s)
+     * Get pinned collections
+     * @param page
+     * @returns PinnedCollectionResult Ok
      * @throws ApiError
      */
-    getPinnedItemHandler(collectionId, id) {
+    listPinnedCollectionHandler(page) {
         return this.httpRequest.request({
             method: 'GET',
-            url: '/api/pinned/collections/{collectionId}/items/{id}',
-            path: {
-                'collectionId': collectionId,
-                'id': id,
+            url: '/api/pinned/collections',
+            query: {
+                'page': page,
             },
         });
     }
     /**
-     * Remove pinned item
-     * Remove single pinned item
-     * @param collectionId pinned collection id
-     * @param id pinned id (id)
-     * @returns PinnedItemResult Ok
+     * Register a pinned collection
+     * Register a pinned collection
+     * @param requestBody
+     * @returns PinnedCollectionResult Ok
      * @throws ApiError
      */
-    deletePinnedItemHandler(collectionId, id) {
+    createPinnedCollectionHandler(requestBody) {
         return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/api/pinned/collections/{collectionId}/items/{id}',
+            method: 'POST',
+            url: '/api/pinned/collections',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get pinned collection by Id
+     * Get collection by Id
+     * @param collectionId Pinned collection id
+     * @returns PinnedCollectionResult Ok
+     * @throws ApiError
+     */
+    getPinnedCollectionHandler(collectionId) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/pinned/collections/{collectionId}',
             path: {
                 'collectionId': collectionId,
-                'id': id,
             },
         });
     }
     /**
-     * Update a pinned item
-     * Update a single pinned item
-     * @param collectionId pinned collection id
-     * @param id pinned id (id)
+     * Update a pinned collection
+     * Update pinned collection by Id
+     * @param collectionId
      * @param requestBody
-     * @returns PinnedItemResult Ok
+     * @returns PinnedCollectionResult Ok
      * @throws ApiError
      */
-    updatePinnedItemHandler(collectionId, id, requestBody) {
+    updatePinnedCollectionHandler(collectionId, requestBody) {
         return this.httpRequest.request({
             method: 'PUT',
-            url: '/api/pinned/collections/{collectionId}/items/{id}',
+            url: '/api/pinned/collections/{collectionId}',
             path: {
                 'collectionId': collectionId,
-                'id': id,
             },
             body: requestBody,
             mediaType: 'application/json',
         });
     }
+    /**
+     * Delete a pinned collection
+     * Delete pinned collection by Id
+     * @param collectionId
+     * @returns void
+     * @throws ApiError
+     */
+    deletePinnedCollectionHandler(collectionId) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/api/pinned/collections/{collectionId}',
+            path: {
+                'collectionId': collectionId,
+            },
+        });
+    }
     /**
      * Get list of pinned items by collection id
      * Get list of pinned items by given pinned collection id
@@ -85,6 +110,25 @@ export class PinnedItemsService {
             },
         });
     }
+    /**
+     * Create a new pinned item
+     * Create a new pinned item, collectionId must be created before creating pinned item
+     * @param collectionId pinned collection id
+     * @param requestBody
+     * @returns PinnedItemResult Ok
+     * @throws ApiError
+     */
+    createPinnedItemHandler(collectionId, requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/api/pinned/collections/{collectionId}/items',
+            path: {
+                'collectionId': collectionId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
     /**
      * Clear pinned items in collection
      * Clear pinned items in collection
@@ -102,38 +146,76 @@ export class PinnedItemsService {
         });
     }
     /**
-     * Create a new pinned item
-     * Create a new pinned item, collectionId must be created before creating pinned item
+     * Get pinned item by id
+     * Get single pinned item by id
      * @param collectionId pinned collection id
+     * @param id pinned id (id)
+     * @returns PinnedItemResult PinnedItemResult
+     * @throws ApiError
+     */
+    getPinnedItemHandler(collectionId, id) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/api/pinned/collections/{collectionId}/items/{id}',
+            path: {
+                'collectionId': collectionId,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * Update a pinned item
+     * Update a single pinned item
+     * @param collectionId pinned collection id
+     * @param id pinned id (id)
      * @param requestBody
      * @returns PinnedItemResult Ok
      * @throws ApiError
      */
-    createPinnedItemHandler(collectionId, requestBody) {
+    updatePinnedItemHandler(collectionId, id, requestBody) {
         return this.httpRequest.request({
-            method: 'POST',
-            url: '/api/pinned/collections/{collectionId}/items',
+            method: 'PUT',
+            url: '/api/pinned/collections/{collectionId}/items/{id}',
             path: {
                 'collectionId': collectionId,
+                'id': id,
             },
             body: requestBody,
             mediaType: 'application/json',
         });
     }
     /**
-     * Get matched pinned by phrases
-     * Get matched pinned by phrases
-     * @param requestBody MatchingPinnedSelector
+     * Remove pinned item
+     * Remove single pinned item
+     * @param collectionId pinned collection id
+     * @param id pinned id (id)
+     * @returns PinnedItemResult Ok
+     * @throws ApiError
+     */
+    deletePinnedItemHandler(collectionId, id) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/api/pinned/collections/{collectionId}/items/{id}',
+            path: {
+                'collectionId': collectionId,
+                'id': id,
+            },
+        });
+    }
+    /**
+     * Get pinned results
+     * Get pinned results by matching phrases
+     * @param requestBody
      * @returns PinnedItemResult Ok
      * @throws ApiError
      */
     matchPinnedItemHandler(requestBody) {
         return this.httpRequest.request({
             method: 'POST',
-            url: '/api/pinned/items/match',
+            url: '/api/pinned/results',
             body: requestBody,
             mediaType: 'application/json',
         });
     }
 }
-//# sourceMappingURL=PinnedItemsService.js.map
+//# sourceMappingURL=PinnedResultsService.js.map