@agravity/public 11.1.3 → 12.0.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/.openapi-generator/FILES +3 -0
- package/README.md +4 -4
- package/api/api.ts +3 -0
- package/api/publicAIOperations.pub.agravity.ts +5 -0
- package/api/publicAssetManagement.pub.agravity.ts +7 -1
- package/api/publicAssetVersioning.pub.agravity.ts +5 -0
- package/api/publicCollectionTypeItemManagement.pub.agravity.ts +328 -0
- package/api/publicCollectionTypeManagement.pub.agravity.ts +10 -0
- package/api/publicSearchManagement.pub.agravity.ts +15 -15
- package/api/publicTranslationManagement.pub.agravity.ts +4 -4
- package/model/asset.pub.agravity.ts +1 -0
- package/model/collTypeItem.pub.agravity.ts +4 -1
- package/model/collTypeItemRef.pub.agravity.ts +15 -0
- package/model/collection.pub.agravity.ts +1 -0
- package/model/collectionType.pub.agravity.ts +2 -0
- package/model/itemGroup.pub.agravity.ts +25 -0
- package/model/models.ts +2 -0
- package/model/searchAdminIndexerStatus.pub.agravity.ts +1 -0
- package/model/secureUploadEntity.pub.agravity.ts +9 -0
- package/model/versionEntity.pub.agravity.ts +1 -0
- package/model/versionedAsset.pub.agravity.ts +1 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -14,6 +14,7 @@ api/publicAssetVersioning.pub.agravity.ts
|
|
|
14
14
|
api/publicAuthenticationManagement.pub.agravity.ts
|
|
15
15
|
api/publicCollectionManagement.pub.agravity.ts
|
|
16
16
|
api/publicCollectionSecureUpload.pub.agravity.ts
|
|
17
|
+
api/publicCollectionTypeItemManagement.pub.agravity.ts
|
|
17
18
|
api/publicCollectionTypeManagement.pub.agravity.ts
|
|
18
19
|
api/publicConfigurationManagement.pub.agravity.ts
|
|
19
20
|
api/publicDownloadFormatManagement.pub.agravity.ts
|
|
@@ -52,6 +53,7 @@ model/assetRelation.pub.agravity.ts
|
|
|
52
53
|
model/assetRelationType.pub.agravity.ts
|
|
53
54
|
model/azSearchOptions.pub.agravity.ts
|
|
54
55
|
model/collTypeItem.pub.agravity.ts
|
|
56
|
+
model/collTypeItemRef.pub.agravity.ts
|
|
55
57
|
model/collection.pub.agravity.ts
|
|
56
58
|
model/collectionType.pub.agravity.ts
|
|
57
59
|
model/collectionUDL.pub.agravity.ts
|
|
@@ -78,6 +80,7 @@ model/entityListResult.pub.agravity.ts
|
|
|
78
80
|
model/entityNamesRequest.pub.agravity.ts
|
|
79
81
|
model/frontendAppConfig.pub.agravity.ts
|
|
80
82
|
model/groupAllAppData.pub.agravity.ts
|
|
83
|
+
model/itemGroup.pub.agravity.ts
|
|
81
84
|
model/models.ts
|
|
82
85
|
model/moveCollectionBody.pub.agravity.ts
|
|
83
86
|
model/permissionEntity.pub.agravity.ts
|
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# @agravity/public@
|
|
1
|
+
# @agravity/public@12.0.0
|
|
2
2
|
|
|
3
|
-
<p>The Agravity Public API provides comprehensive access to digital asset management functionality for technical integrations, portals, and third-party applications. These endpoints are designed for programmatic access with API key authentication.</p><br/><h2>Access & Security</h2><br/><b>API key is required to access these endpoints.</b><br/><ul><li>API Key Authentication - Each request requires a valid API key in headers or parameters</li><li>Portal-Aware - Many endpoints support portal context for multi-tenant scenarios</li><li>Service-to-Service Communication - Designed for backend-to-backend integrations</li><li>Stable & Versioned - Public API versioning ensures backward compatibility</li></ul><h2>Core Features & Operations</h2><ul><li><strong>Asset Management</strong> - Create, retrieve, update assets with full metadata support; manage versions and publish assets</li><li><strong>Collection Management</strong> - Create and organize collections hierarchically; retrieve collection type definitions and structures</li><li><strong>Asset Operations</strong> - Retrieve asset blobs (thumbnails, optimized, original); rotate and resize images; find similar assets using AI reverse search</li><li><strong>Image Editing</strong> - Apply transformations to images with advanced parameters (resize, crop, filter, color space, DPI, quality, depth)</li><li><strong>Asset Publishing</strong> - Publish assets to various targets (Vimeo, CDN); manage published asset information</li><li><strong>Asset Versioning</strong> - Create, restore, and manage asset versions; track version history with descriptions</li><li><strong>Asset Relations</strong> - Create and manage relationships between assets with hierarchical or standard relations; organize assets into logical groups</li><li><strong>Asset Relation Types</strong> - Retrieve relation type definitions including hierarchical, sequential, and unique-per-asset configurations</li><li><strong>Full-Text Search</strong> - Search assets and collections with advanced filtering, facets, and sorting capabilities</li><li><strong>Collection Sharing</strong> - Create shared collections with expiration dates, password protection, and download limits</li><li><strong>Quick Shares</strong> - Create quick share links for rapid asset sharing with expiration management</li><li><strong>Portals</strong> - Full portal management with authentication, custom theming, and asset filtering</li><li><strong>Secure Upload</strong> - Secure file upload endpoints with validation and SAS token generation</li><li><strong>Download Management</strong> - Create ZIP packages of assets with format specifications; track download progress</li><li><strong>Download Formats</strong> - Define and apply custom image transformations and optimizations for downloads</li><li><strong>Authentication</strong> - Generate SAS tokens for container write access; retrieve user information</li><li><strong>Configuration</strong> - Access frontend configuration values and system settings</li><li><strong>Helper Tools</strong> - Get searchable items, filterable items, user-defined lists, and static defined lists</li><li><strong>Translations</strong> - Retrieve translations for all entities in multiple languages</li><li><strong>Deleted Entities Tracking</strong> - Track deleted assets, collections, and other entities by date</li></ul><h2>Available Endpoints by Category</h2><ul><li><strong>Asset Management</strong> - /assets, /assets/{id}, /assetsupload</li><li><strong>Asset Relations</strong> - /assetrelations, /assetrelations/{id} (create, read, update, delete asset relationships)</li><li><strong>Asset Relation Types</strong> - /assetrelationtypes, /assetrelationtypes/{id} (retrieve relation type definitions and configurations)</li><li><strong>Asset Operations</strong> - /assets/{id}/blobs, /assets/{id}/collections, /assets/{id}/tocollection, /assets/{id}/download, /assets/{id}/resize, /assets/{id}/imageedit, /assets/{id}/availability</li><li><strong>Asset Publishing</strong> - /assets/{id}/publish, /assets/{id}/publish/{pid}</li><li><strong>Asset Versioning</strong> - /assets/{id}/versions, /assets/{id}/versionsupload, /assets/{id}/versions/{vNr}/restore</li><li><strong>AI Operations</strong> - /ai/reverseassetsearch (find similar assets using image)</li><li><strong>Collection Management</strong> - /collections, /collections/{id}, /collections/{id}/ancestors, /collections/{id}/descendants, /collections/{id}/previews, /collectionsbynames</li><li><strong>Collection Types</strong> - /collectiontypes, /collectiontypes/{id}, /collectiontypesitems</li><li><strong>Search</strong> - /search, /search/
|
|
3
|
+
<p>The Agravity Public API provides comprehensive access to digital asset management functionality for technical integrations, portals, and third-party applications. These endpoints are designed for programmatic access with API key authentication.</p><br/><h2>Access & Security</h2><br/><b>API key is required to access these endpoints.</b><br/><ul><li>API Key Authentication - Each request requires a valid API key in headers or parameters</li><li>Portal-Aware - Many endpoints support portal context for multi-tenant scenarios</li><li>Service-to-Service Communication - Designed for backend-to-backend integrations</li><li>Stable & Versioned - Public API versioning ensures backward compatibility</li></ul><h2>Core Features & Operations</h2><ul><li><strong>Asset Management</strong> - Create, retrieve, update assets with full metadata support; manage versions and publish assets</li><li><strong>Collection Management</strong> - Create and organize collections hierarchically; retrieve collection type definitions and structures</li><li><strong>Asset Operations</strong> - Retrieve asset blobs (thumbnails, optimized, original); rotate and resize images; find similar assets using AI reverse search</li><li><strong>Image Editing</strong> - Apply transformations to images with advanced parameters (resize, crop, filter, color space, DPI, quality, depth)</li><li><strong>Asset Publishing</strong> - Publish assets to various targets (Vimeo, CDN); manage published asset information</li><li><strong>Asset Versioning</strong> - Create, restore, and manage asset versions; track version history with descriptions</li><li><strong>Asset Relations</strong> - Create and manage relationships between assets with hierarchical or standard relations; organize assets into logical groups</li><li><strong>Asset Relation Types</strong> - Retrieve relation type definitions including hierarchical, sequential, and unique-per-asset configurations</li><li><strong>Full-Text Search</strong> - Search assets and collections with advanced filtering, facets, and sorting capabilities</li><li><strong>Collection Sharing</strong> - Create shared collections with expiration dates, password protection, and download limits</li><li><strong>Quick Shares</strong> - Create quick share links for rapid asset sharing with expiration management</li><li><strong>Portals</strong> - Full portal management with authentication, custom theming, and asset filtering</li><li><strong>Secure Upload</strong> - Secure file upload endpoints with validation and SAS token generation</li><li><strong>Download Management</strong> - Create ZIP packages of assets with format specifications; track download progress</li><li><strong>Download Formats</strong> - Define and apply custom image transformations and optimizations for downloads</li><li><strong>Authentication</strong> - Generate SAS tokens for container write access; retrieve user information</li><li><strong>Configuration</strong> - Access frontend configuration values and system settings</li><li><strong>Helper Tools</strong> - Get searchable items, filterable items, user-defined lists, and static defined lists</li><li><strong>Translations</strong> - Retrieve translations for all entities in multiple languages</li><li><strong>Deleted Entities Tracking</strong> - Track deleted assets, collections, and other entities by date</li></ul><h2>Available Endpoints by Category</h2><ul><li><strong>Asset Management</strong> - /assets, /assets/{id}, /assetsupload</li><li><strong>Asset Relations</strong> - /assetrelations, /assetrelations/{id} (create, read, update, delete asset relationships)</li><li><strong>Asset Relation Types</strong> - /assetrelationtypes, /assetrelationtypes/{id} (retrieve relation type definitions and configurations)</li><li><strong>Asset Operations</strong> - /assets/{id}/blobs, /assets/{id}/collections, /assets/{id}/tocollection, /assets/{id}/download, /assets/{id}/resize, /assets/{id}/imageedit, /assets/{id}/availability</li><li><strong>Asset Publishing</strong> - /assets/{id}/publish, /assets/{id}/publish/{pid}</li><li><strong>Asset Versioning</strong> - /assets/{id}/versions, /assets/{id}/versionsupload, /assets/{id}/versions/{vNr}/restore</li><li><strong>AI Operations</strong> - /ai/reverseassetsearch (find similar assets using image)</li><li><strong>Collection Management</strong> - /collections, /collections/{id}, /collections/{id}/ancestors, /collections/{id}/descendants, /collections/{id}/previews, /collectionsbynames</li><li><strong>Collection Types</strong> - /collectiontypes, /collectiontypes/{id}, /collectiontypesitems</li><li><strong>Search</strong> - /search, /search/facet, /searchadmin/status</li><li><strong>Saved Searches</strong> - /savedsearches</li><li><strong>Collection Sharing</strong> - /shared/{id}, /shared/{id}/zip, /quickshares/{id}</li><li><strong>Secure Upload</strong> - /secureupload/{id}, /secureupload/{id}/upload</li><li><strong>Portal Management</strong> - /portals/{id}, /portals/{id}/config, /portals/{id}/zip, /portals/{id}/assetids, /portalsenhancetoken, /portalssaveuserattributes</li><li><strong>Authentication</strong> - /auth/containerwrite/{containerName}, /auth/inbox, /auth/users/{id}</li><li><strong>Download Formats</strong> - /downloadformats, /downloadformats-shared</li><li><strong>Configuration</strong> - /config/frontend</li><li><strong>Static Defined Lists</strong> - /staticdefinedlists, /staticdefinedlists/{id}</li><li><strong>User-Defined Lists</strong> - /helper/userdefinedlists</li><li><strong>Helper Tools</strong> - /helper/searchableitemnames, /helper/searchableitems, /helper/filterableitems</li><li><strong>Translations</strong> - /translations/{id}, /translations/{id}/{property}, /translations/{id}/custom/{customField}</li><li><strong>Web App Data</strong> - /webappdata/{id}, /data/collectiontype/{id}</li><li><strong>Workspace Management</strong> - /workspaces, /workspaces/{id}</li><li><strong>General</strong> - /version, /deleted, /durable/{instanceId}, /public/view, /signalr/negotiate</li></ul><h2>Typical Use Cases</h2><ul><li>E-commerce platforms - Product image management and dynamic optimization</li><li>Marketing automation - Asset distribution across channels with version control</li><li>Portal systems - Multi-tenant asset galleries with custom theming and permissions</li><li>Headless CMS integration - Content delivery with dynamic transformations</li><li>Mobile applications - Asset retrieval with mobile-optimized formats</li><li>AI-powered workflows - Reverse image search and automatic metadata generation</li><li>Asset sharing platforms - Secure sharing with expiration and password protection</li><li>Digital distribution - ZIP creation and bulk download management</li><li>Multi-language content - Translation management across all assets and collections</li><li>Real-time monitoring - Deletion tracking and version history auditing</li></ul><h2>Key Capabilities</h2><ul><li>Full CRUD operations on assets, collections, and related entities</li><li>Asset relationship management with hierarchical and standard relations</li><li>Advanced image transformation with ImageMagick integration</li><li>AI-powered reverse image search for asset discovery</li><li>Multi-language support with translation dictionaries</li><li>Granular permission control and role-based access</li><li>Portal creation with custom authentication and theming</li><li>Hierarchical collection organization with dynamic filtering</li><li>Real-time search with faceted navigation and advanced filtering</li><li>Secure sharing with expiration and password protection</li><li>Blob storage integration with SAS token generation</li><li>Comprehensive asset versioning and restoration</li><li>SignalR support for real-time notifications</li></ul><h2>Authentication & Authorization</h2><p>All endpoints (except public share endpoints) require API key authentication. The API key can be provided:</p><ul><li>As query parameter: ?code=YOUR_API_KEY</li><li>As header: x-functions-key: YOUR_API_KEY</li></ul><p>Portal endpoints may have additional authentication methods (OAuth, Azure AD, Auth0, password) depending on portal configuration.</p><h2>Support</h2><p>For technical support or integration questions, contact <a href=\"mailto:support@agravity.io\">support@agravity.io</a> or visit <a href=\"https://agravity.io\">https://agravity.io</a>.</p><br/><p>Copyright © Agravity GmbH 2026. All Rights Reserved</p>
|
|
4
4
|
|
|
5
|
-
The version of the OpenAPI document:
|
|
5
|
+
The version of the OpenAPI document: 12.0.0
|
|
6
6
|
|
|
7
7
|
## Building
|
|
8
8
|
|
|
@@ -24,7 +24,7 @@ Navigate to the folder of your consuming project and run one of next commands.
|
|
|
24
24
|
_published:_
|
|
25
25
|
|
|
26
26
|
```console
|
|
27
|
-
npm install @agravity/public@
|
|
27
|
+
npm install @agravity/public@12.0.0 --save
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
_without publishing (not recommended):_
|
package/api/api.ts
CHANGED
|
@@ -18,6 +18,8 @@ export * from './publicCollectionManagement.pub.agravity';
|
|
|
18
18
|
import { PublicCollectionManagementService } from './publicCollectionManagement.pub.agravity';
|
|
19
19
|
export * from './publicCollectionSecureUpload.pub.agravity';
|
|
20
20
|
import { PublicCollectionSecureUploadService } from './publicCollectionSecureUpload.pub.agravity';
|
|
21
|
+
export * from './publicCollectionTypeItemManagement.pub.agravity';
|
|
22
|
+
import { PublicCollectionTypeItemManagementService } from './publicCollectionTypeItemManagement.pub.agravity';
|
|
21
23
|
export * from './publicCollectionTypeManagement.pub.agravity';
|
|
22
24
|
import { PublicCollectionTypeManagementService } from './publicCollectionTypeManagement.pub.agravity';
|
|
23
25
|
export * from './publicConfigurationManagement.pub.agravity';
|
|
@@ -61,6 +63,7 @@ export const APIS = [
|
|
|
61
63
|
PublicAuthenticationManagementService,
|
|
62
64
|
PublicCollectionManagementService,
|
|
63
65
|
PublicCollectionSecureUploadService,
|
|
66
|
+
PublicCollectionTypeItemManagementService,
|
|
64
67
|
PublicCollectionTypeManagementService,
|
|
65
68
|
PublicConfigurationManagementService,
|
|
66
69
|
PublicDownloadFormatManagementService,
|
|
@@ -32,6 +32,7 @@ export interface HttpReverseAssetSearchRequestParams {
|
|
|
32
32
|
file?: Blob;
|
|
33
33
|
filename?: string;
|
|
34
34
|
previewof?: string;
|
|
35
|
+
id?: string;
|
|
35
36
|
}
|
|
36
37
|
|
|
37
38
|
@Injectable({
|
|
@@ -84,6 +85,7 @@ export class PublicAIOperationsService extends BaseService {
|
|
|
84
85
|
const file = requestParameters?.file;
|
|
85
86
|
const filename = requestParameters?.filename;
|
|
86
87
|
const previewof = requestParameters?.previewof;
|
|
88
|
+
const id = requestParameters?.id;
|
|
87
89
|
|
|
88
90
|
let localVarHeaders = this.defaultHeaders;
|
|
89
91
|
if (acceptLanguage !== undefined && acceptLanguage !== null) {
|
|
@@ -134,6 +136,9 @@ export class PublicAIOperationsService extends BaseService {
|
|
|
134
136
|
if (previewof !== undefined) {
|
|
135
137
|
localVarFormParams = (localVarFormParams.append('previewof', <any>previewof) as any) || localVarFormParams;
|
|
136
138
|
}
|
|
139
|
+
if (id !== undefined) {
|
|
140
|
+
localVarFormParams = (localVarFormParams.append('id', <any>id) as any) || localVarFormParams;
|
|
141
|
+
}
|
|
137
142
|
|
|
138
143
|
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
139
144
|
if (localVarHttpHeaderAcceptSelected) {
|
|
@@ -38,6 +38,7 @@ export interface HttpAssetUploadFileRequestParams {
|
|
|
38
38
|
file?: Blob;
|
|
39
39
|
filename?: string;
|
|
40
40
|
previewof?: string;
|
|
41
|
+
id?: string;
|
|
41
42
|
}
|
|
42
43
|
|
|
43
44
|
export interface HttpAssetsBulkDeleteUpdateRequestParams {
|
|
@@ -62,7 +63,7 @@ export interface HttpAssetsBulkPutUpdateRequestParams {
|
|
|
62
63
|
export interface HttpAssetsCreateRequestParams {
|
|
63
64
|
/** The ID of the collection where this assets should be assigned. */
|
|
64
65
|
collectionid: string;
|
|
65
|
-
/** This endpoint creates an unique asset ID and adds the information to the database. */
|
|
66
|
+
/** This endpoint creates an unique asset ID and adds the information to the database. An optional \"id\" sets a custom asset id; the id of a deleted asset is reused: the deleted asset is purged and can no longer be restored. */
|
|
66
67
|
asset: Asset;
|
|
67
68
|
/** When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header) */
|
|
68
69
|
translations?: boolean;
|
|
@@ -137,6 +138,7 @@ export class PublicAssetManagementService extends BaseService {
|
|
|
137
138
|
}
|
|
138
139
|
|
|
139
140
|
/**
|
|
141
|
+
* This endpoint allows to upload one asset which is put onto the storage (INBOX). Collection ID is mandatory! The optional field \"id\" sets a custom asset id (\"a\" followed by 24 letters or digits); it must not belong to an existing asset and can not be combined with \"previewof\". The id of a deleted asset is reused: the deleted asset is purged and can no longer be restored.
|
|
140
142
|
* @endpoint post /assetsupload
|
|
141
143
|
* @param requestParameters
|
|
142
144
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
@@ -173,6 +175,7 @@ export class PublicAssetManagementService extends BaseService {
|
|
|
173
175
|
const file = requestParameters?.file;
|
|
174
176
|
const filename = requestParameters?.filename;
|
|
175
177
|
const previewof = requestParameters?.previewof;
|
|
178
|
+
const id = requestParameters?.id;
|
|
176
179
|
|
|
177
180
|
let localVarHeaders = this.defaultHeaders;
|
|
178
181
|
if (acceptLanguage !== undefined && acceptLanguage !== null) {
|
|
@@ -223,6 +226,9 @@ export class PublicAssetManagementService extends BaseService {
|
|
|
223
226
|
if (previewof !== undefined) {
|
|
224
227
|
localVarFormParams = (localVarFormParams.append('previewof', <any>previewof) as any) || localVarFormParams;
|
|
225
228
|
}
|
|
229
|
+
if (id !== undefined) {
|
|
230
|
+
localVarFormParams = (localVarFormParams.append('id', <any>id) as any) || localVarFormParams;
|
|
231
|
+
}
|
|
226
232
|
|
|
227
233
|
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
228
234
|
if (localVarHttpHeaderAcceptSelected) {
|
|
@@ -36,6 +36,7 @@ export interface HttpAssetCreateUploadVersionRequestParams {
|
|
|
36
36
|
file?: Blob;
|
|
37
37
|
filename?: string;
|
|
38
38
|
previewof?: string;
|
|
39
|
+
id2?: string;
|
|
39
40
|
}
|
|
40
41
|
|
|
41
42
|
export interface HttpAssetCreateVersionRequestParams {
|
|
@@ -135,6 +136,7 @@ export class PublicAssetVersioningService extends BaseService {
|
|
|
135
136
|
const file = requestParameters?.file;
|
|
136
137
|
const filename = requestParameters?.filename;
|
|
137
138
|
const previewof = requestParameters?.previewof;
|
|
139
|
+
const id2 = requestParameters?.id2;
|
|
138
140
|
|
|
139
141
|
let localVarHeaders = this.defaultHeaders;
|
|
140
142
|
|
|
@@ -182,6 +184,9 @@ export class PublicAssetVersioningService extends BaseService {
|
|
|
182
184
|
if (previewof !== undefined) {
|
|
183
185
|
localVarFormParams = (localVarFormParams.append('previewof', <any>previewof) as any) || localVarFormParams;
|
|
184
186
|
}
|
|
187
|
+
if (id2 !== undefined) {
|
|
188
|
+
localVarFormParams = (localVarFormParams.append('id', <any>id2) as any) || localVarFormParams;
|
|
189
|
+
}
|
|
185
190
|
|
|
186
191
|
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
187
192
|
if (localVarHttpHeaderAcceptSelected) {
|
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agravity OpenAPI Documentation - Public Functions
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@agravity.io
|
|
5
|
+
*
|
|
6
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
+
* https://openapi-generator.tech
|
|
8
|
+
* Do not edit the class manually.
|
|
9
|
+
*/
|
|
10
|
+
/* tslint:disable:no-unused-variable member-ordering */
|
|
11
|
+
|
|
12
|
+
import { Inject, Injectable, Optional } from '@angular/core';
|
|
13
|
+
import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
|
|
14
|
+
import { Observable } from 'rxjs';
|
|
15
|
+
import { OpenApiHttpParams, QueryParamStyle } from '../query.params';
|
|
16
|
+
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import { CollTypeItem } from '../model/collTypeItem.pub.agravity';
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { ItemGroup } from '../model/itemGroup.pub.agravity';
|
|
21
|
+
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
|
|
24
|
+
import { AgravityPublicConfiguration } from '../configuration';
|
|
25
|
+
import { BaseService } from '../api.base.service';
|
|
26
|
+
|
|
27
|
+
export interface HttpCollTypeItemsGetByIdRequestParams {
|
|
28
|
+
/** The ID of the collection type item. */
|
|
29
|
+
id: string;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export interface HttpItemGroupsGetByIdRequestParams {
|
|
33
|
+
/** The ID of the item group. */
|
|
34
|
+
id: string;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
@Injectable({
|
|
38
|
+
providedIn: 'root'
|
|
39
|
+
})
|
|
40
|
+
export class PublicCollectionTypeItemManagementService extends BaseService {
|
|
41
|
+
constructor(
|
|
42
|
+
protected httpClient: HttpClient,
|
|
43
|
+
@Optional() @Inject(BASE_PATH) basePath: string | string[],
|
|
44
|
+
@Optional() configuration?: AgravityPublicConfiguration
|
|
45
|
+
) {
|
|
46
|
+
super(basePath, configuration);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Lists all standalone collection type items.
|
|
51
|
+
* @endpoint get /colltypeitems
|
|
52
|
+
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
53
|
+
* @param reportProgress flag to report request and response progress.
|
|
54
|
+
* @param options additional options
|
|
55
|
+
*/
|
|
56
|
+
public httpCollTypeItemsGetAll(
|
|
57
|
+
observe?: 'body',
|
|
58
|
+
reportProgress?: boolean,
|
|
59
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
60
|
+
): Observable<Array<CollTypeItem>>;
|
|
61
|
+
public httpCollTypeItemsGetAll(
|
|
62
|
+
observe?: 'response',
|
|
63
|
+
reportProgress?: boolean,
|
|
64
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
65
|
+
): Observable<HttpResponse<Array<CollTypeItem>>>;
|
|
66
|
+
public httpCollTypeItemsGetAll(
|
|
67
|
+
observe?: 'events',
|
|
68
|
+
reportProgress?: boolean,
|
|
69
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
70
|
+
): Observable<HttpEvent<Array<CollTypeItem>>>;
|
|
71
|
+
public httpCollTypeItemsGetAll(
|
|
72
|
+
observe: any = 'body',
|
|
73
|
+
reportProgress: boolean = false,
|
|
74
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
75
|
+
): Observable<any> {
|
|
76
|
+
let localVarHeaders = this.defaultHeaders;
|
|
77
|
+
|
|
78
|
+
// authentication (function_key) required
|
|
79
|
+
localVarHeaders = this.configuration.addCredentialToHeaders('function_key', 'x-functions-key', localVarHeaders);
|
|
80
|
+
|
|
81
|
+
const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
|
|
82
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
83
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();
|
|
87
|
+
|
|
88
|
+
const localVarTransferCache: boolean = options?.transferCache ?? true;
|
|
89
|
+
|
|
90
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
91
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
92
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
93
|
+
responseType_ = 'text';
|
|
94
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
95
|
+
responseType_ = 'json';
|
|
96
|
+
} else {
|
|
97
|
+
responseType_ = 'blob';
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
let localVarPath = `/colltypeitems`;
|
|
102
|
+
const { basePath, withCredentials } = this.configuration;
|
|
103
|
+
return this.httpClient.request<Array<CollTypeItem>>('get', `${basePath}${localVarPath}`, {
|
|
104
|
+
context: localVarHttpContext,
|
|
105
|
+
responseType: <any>responseType_,
|
|
106
|
+
...(withCredentials ? { withCredentials } : {}),
|
|
107
|
+
headers: localVarHeaders,
|
|
108
|
+
observe: observe,
|
|
109
|
+
...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
|
|
110
|
+
reportProgress: reportProgress
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Gets a single standalone collection type item by ID.
|
|
116
|
+
* @endpoint get /colltypeitems/{id}
|
|
117
|
+
* @param requestParameters
|
|
118
|
+
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
119
|
+
* @param reportProgress flag to report request and response progress.
|
|
120
|
+
* @param options additional options
|
|
121
|
+
*/
|
|
122
|
+
public httpCollTypeItemsGetById(
|
|
123
|
+
requestParameters: HttpCollTypeItemsGetByIdRequestParams,
|
|
124
|
+
observe?: 'body',
|
|
125
|
+
reportProgress?: boolean,
|
|
126
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
127
|
+
): Observable<CollTypeItem>;
|
|
128
|
+
public httpCollTypeItemsGetById(
|
|
129
|
+
requestParameters: HttpCollTypeItemsGetByIdRequestParams,
|
|
130
|
+
observe?: 'response',
|
|
131
|
+
reportProgress?: boolean,
|
|
132
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
133
|
+
): Observable<HttpResponse<CollTypeItem>>;
|
|
134
|
+
public httpCollTypeItemsGetById(
|
|
135
|
+
requestParameters: HttpCollTypeItemsGetByIdRequestParams,
|
|
136
|
+
observe?: 'events',
|
|
137
|
+
reportProgress?: boolean,
|
|
138
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
139
|
+
): Observable<HttpEvent<CollTypeItem>>;
|
|
140
|
+
public httpCollTypeItemsGetById(
|
|
141
|
+
requestParameters: HttpCollTypeItemsGetByIdRequestParams,
|
|
142
|
+
observe: any = 'body',
|
|
143
|
+
reportProgress: boolean = false,
|
|
144
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
145
|
+
): Observable<any> {
|
|
146
|
+
const id = requestParameters?.id;
|
|
147
|
+
if (id === null || id === undefined) {
|
|
148
|
+
throw new Error('Required parameter id was null or undefined when calling httpCollTypeItemsGetById.');
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
let localVarHeaders = this.defaultHeaders;
|
|
152
|
+
|
|
153
|
+
// authentication (function_key) required
|
|
154
|
+
localVarHeaders = this.configuration.addCredentialToHeaders('function_key', 'x-functions-key', localVarHeaders);
|
|
155
|
+
|
|
156
|
+
const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
|
|
157
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
158
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();
|
|
162
|
+
|
|
163
|
+
const localVarTransferCache: boolean = options?.transferCache ?? true;
|
|
164
|
+
|
|
165
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
166
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
167
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
168
|
+
responseType_ = 'text';
|
|
169
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
170
|
+
responseType_ = 'json';
|
|
171
|
+
} else {
|
|
172
|
+
responseType_ = 'blob';
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
let localVarPath = `/colltypeitems/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
|
|
177
|
+
const { basePath, withCredentials } = this.configuration;
|
|
178
|
+
return this.httpClient.request<CollTypeItem>('get', `${basePath}${localVarPath}`, {
|
|
179
|
+
context: localVarHttpContext,
|
|
180
|
+
responseType: <any>responseType_,
|
|
181
|
+
...(withCredentials ? { withCredentials } : {}),
|
|
182
|
+
headers: localVarHeaders,
|
|
183
|
+
observe: observe,
|
|
184
|
+
...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
|
|
185
|
+
reportProgress: reportProgress
|
|
186
|
+
});
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Lists all item groups.
|
|
191
|
+
* @endpoint get /itemgroups
|
|
192
|
+
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
193
|
+
* @param reportProgress flag to report request and response progress.
|
|
194
|
+
* @param options additional options
|
|
195
|
+
*/
|
|
196
|
+
public httpItemGroupsGetAll(
|
|
197
|
+
observe?: 'body',
|
|
198
|
+
reportProgress?: boolean,
|
|
199
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
200
|
+
): Observable<Array<ItemGroup>>;
|
|
201
|
+
public httpItemGroupsGetAll(
|
|
202
|
+
observe?: 'response',
|
|
203
|
+
reportProgress?: boolean,
|
|
204
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
205
|
+
): Observable<HttpResponse<Array<ItemGroup>>>;
|
|
206
|
+
public httpItemGroupsGetAll(
|
|
207
|
+
observe?: 'events',
|
|
208
|
+
reportProgress?: boolean,
|
|
209
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
210
|
+
): Observable<HttpEvent<Array<ItemGroup>>>;
|
|
211
|
+
public httpItemGroupsGetAll(
|
|
212
|
+
observe: any = 'body',
|
|
213
|
+
reportProgress: boolean = false,
|
|
214
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
215
|
+
): Observable<any> {
|
|
216
|
+
let localVarHeaders = this.defaultHeaders;
|
|
217
|
+
|
|
218
|
+
// authentication (function_key) required
|
|
219
|
+
localVarHeaders = this.configuration.addCredentialToHeaders('function_key', 'x-functions-key', localVarHeaders);
|
|
220
|
+
|
|
221
|
+
const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
|
|
222
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
223
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();
|
|
227
|
+
|
|
228
|
+
const localVarTransferCache: boolean = options?.transferCache ?? true;
|
|
229
|
+
|
|
230
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
231
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
232
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
233
|
+
responseType_ = 'text';
|
|
234
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
235
|
+
responseType_ = 'json';
|
|
236
|
+
} else {
|
|
237
|
+
responseType_ = 'blob';
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
let localVarPath = `/itemgroups`;
|
|
242
|
+
const { basePath, withCredentials } = this.configuration;
|
|
243
|
+
return this.httpClient.request<Array<ItemGroup>>('get', `${basePath}${localVarPath}`, {
|
|
244
|
+
context: localVarHttpContext,
|
|
245
|
+
responseType: <any>responseType_,
|
|
246
|
+
...(withCredentials ? { withCredentials } : {}),
|
|
247
|
+
headers: localVarHeaders,
|
|
248
|
+
observe: observe,
|
|
249
|
+
...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
|
|
250
|
+
reportProgress: reportProgress
|
|
251
|
+
});
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* Gets a single item group by ID.
|
|
256
|
+
* @endpoint get /itemgroups/{id}
|
|
257
|
+
* @param requestParameters
|
|
258
|
+
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
259
|
+
* @param reportProgress flag to report request and response progress.
|
|
260
|
+
* @param options additional options
|
|
261
|
+
*/
|
|
262
|
+
public httpItemGroupsGetById(
|
|
263
|
+
requestParameters: HttpItemGroupsGetByIdRequestParams,
|
|
264
|
+
observe?: 'body',
|
|
265
|
+
reportProgress?: boolean,
|
|
266
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
267
|
+
): Observable<ItemGroup>;
|
|
268
|
+
public httpItemGroupsGetById(
|
|
269
|
+
requestParameters: HttpItemGroupsGetByIdRequestParams,
|
|
270
|
+
observe?: 'response',
|
|
271
|
+
reportProgress?: boolean,
|
|
272
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
273
|
+
): Observable<HttpResponse<ItemGroup>>;
|
|
274
|
+
public httpItemGroupsGetById(
|
|
275
|
+
requestParameters: HttpItemGroupsGetByIdRequestParams,
|
|
276
|
+
observe?: 'events',
|
|
277
|
+
reportProgress?: boolean,
|
|
278
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
279
|
+
): Observable<HttpEvent<ItemGroup>>;
|
|
280
|
+
public httpItemGroupsGetById(
|
|
281
|
+
requestParameters: HttpItemGroupsGetByIdRequestParams,
|
|
282
|
+
observe: any = 'body',
|
|
283
|
+
reportProgress: boolean = false,
|
|
284
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
285
|
+
): Observable<any> {
|
|
286
|
+
const id = requestParameters?.id;
|
|
287
|
+
if (id === null || id === undefined) {
|
|
288
|
+
throw new Error('Required parameter id was null or undefined when calling httpItemGroupsGetById.');
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
let localVarHeaders = this.defaultHeaders;
|
|
292
|
+
|
|
293
|
+
// authentication (function_key) required
|
|
294
|
+
localVarHeaders = this.configuration.addCredentialToHeaders('function_key', 'x-functions-key', localVarHeaders);
|
|
295
|
+
|
|
296
|
+
const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
|
|
297
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
298
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();
|
|
302
|
+
|
|
303
|
+
const localVarTransferCache: boolean = options?.transferCache ?? true;
|
|
304
|
+
|
|
305
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
306
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
307
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
308
|
+
responseType_ = 'text';
|
|
309
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
310
|
+
responseType_ = 'json';
|
|
311
|
+
} else {
|
|
312
|
+
responseType_ = 'blob';
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
let localVarPath = `/itemgroups/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
|
|
317
|
+
const { basePath, withCredentials } = this.configuration;
|
|
318
|
+
return this.httpClient.request<ItemGroup>('get', `${basePath}${localVarPath}`, {
|
|
319
|
+
context: localVarHttpContext,
|
|
320
|
+
responseType: <any>responseType_,
|
|
321
|
+
...(withCredentials ? { withCredentials } : {}),
|
|
322
|
+
headers: localVarHeaders,
|
|
323
|
+
observe: observe,
|
|
324
|
+
...(localVarTransferCache !== undefined ? { transferCache: localVarTransferCache } : {}),
|
|
325
|
+
reportProgress: reportProgress
|
|
326
|
+
});
|
|
327
|
+
}
|
|
328
|
+
}
|
|
@@ -27,6 +27,8 @@ import { AgravityPublicConfiguration } from '../configuration';
|
|
|
27
27
|
import { BaseService } from '../api.base.service';
|
|
28
28
|
|
|
29
29
|
export interface HttpCollectionTypesGetRequestParams {
|
|
30
|
+
/** When true, returns the resolved collection type items alongside the item refs. */
|
|
31
|
+
items?: boolean;
|
|
30
32
|
/** When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header) */
|
|
31
33
|
translations?: boolean;
|
|
32
34
|
/** The requested language of the response. If not matching it falls back to default language. */
|
|
@@ -36,6 +38,8 @@ export interface HttpCollectionTypesGetRequestParams {
|
|
|
36
38
|
export interface HttpCollectionTypesGetByIdRequestParams {
|
|
37
39
|
/** The ID of the collection type. */
|
|
38
40
|
id: string;
|
|
41
|
+
/** When true, returns the resolved collection type items alongside the item refs. */
|
|
42
|
+
items?: boolean;
|
|
39
43
|
/** When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header) */
|
|
40
44
|
translations?: boolean;
|
|
41
45
|
/** The requested language of the response. If not matching it falls back to default language. */
|
|
@@ -95,11 +99,14 @@ export class PublicCollectionTypeManagementService extends BaseService {
|
|
|
95
99
|
reportProgress: boolean = false,
|
|
96
100
|
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
97
101
|
): Observable<any> {
|
|
102
|
+
const items = requestParameters?.items;
|
|
98
103
|
const translations = requestParameters?.translations;
|
|
99
104
|
const acceptLanguage = requestParameters?.acceptLanguage;
|
|
100
105
|
|
|
101
106
|
let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
|
|
102
107
|
|
|
108
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'items', <any>items, QueryParamStyle.Form, true);
|
|
109
|
+
|
|
103
110
|
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
|
|
104
111
|
|
|
105
112
|
let localVarHeaders = this.defaultHeaders;
|
|
@@ -180,11 +187,14 @@ export class PublicCollectionTypeManagementService extends BaseService {
|
|
|
180
187
|
if (id === null || id === undefined) {
|
|
181
188
|
throw new Error('Required parameter id was null or undefined when calling httpCollectionTypesGetById.');
|
|
182
189
|
}
|
|
190
|
+
const items = requestParameters?.items;
|
|
183
191
|
const translations = requestParameters?.translations;
|
|
184
192
|
const acceptLanguage = requestParameters?.acceptLanguage;
|
|
185
193
|
|
|
186
194
|
let localVarQueryParameters = new OpenApiHttpParams(this.encoder);
|
|
187
195
|
|
|
196
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'items', <any>items, QueryParamStyle.Form, true);
|
|
197
|
+
|
|
188
198
|
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, 'translations', <any>translations, QueryParamStyle.Form, true);
|
|
189
199
|
|
|
190
200
|
let localVarHeaders = this.defaultHeaders;
|
|
@@ -30,8 +30,8 @@ import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
|
|
|
30
30
|
import { AgravityPublicConfiguration } from '../configuration';
|
|
31
31
|
import { BaseService } from '../api.base.service';
|
|
32
32
|
|
|
33
|
-
export interface
|
|
34
|
-
/** The name of the
|
|
33
|
+
export interface HttpGetSearchFacetByNameRequestParams {
|
|
34
|
+
/** The name of the facet. */
|
|
35
35
|
name: string;
|
|
36
36
|
/** The search string which should be found. */
|
|
37
37
|
s: string;
|
|
@@ -115,44 +115,44 @@ export class PublicSearchManagementService extends BaseService {
|
|
|
115
115
|
}
|
|
116
116
|
|
|
117
117
|
/**
|
|
118
|
-
* This endpoint returns one
|
|
119
|
-
* @endpoint get /search/
|
|
118
|
+
* This endpoint returns one facet based on the search parameters.
|
|
119
|
+
* @endpoint get /search/facet
|
|
120
120
|
* @param requestParameters
|
|
121
121
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
122
122
|
* @param reportProgress flag to report request and response progress.
|
|
123
123
|
* @param options additional options
|
|
124
124
|
*/
|
|
125
|
-
public
|
|
126
|
-
requestParameters:
|
|
125
|
+
public httpGetSearchFacetByName(
|
|
126
|
+
requestParameters: HttpGetSearchFacetByNameRequestParams,
|
|
127
127
|
observe?: 'body',
|
|
128
128
|
reportProgress?: boolean,
|
|
129
129
|
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
130
130
|
): Observable<SearchFacet>;
|
|
131
|
-
public
|
|
132
|
-
requestParameters:
|
|
131
|
+
public httpGetSearchFacetByName(
|
|
132
|
+
requestParameters: HttpGetSearchFacetByNameRequestParams,
|
|
133
133
|
observe?: 'response',
|
|
134
134
|
reportProgress?: boolean,
|
|
135
135
|
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
136
136
|
): Observable<HttpResponse<SearchFacet>>;
|
|
137
|
-
public
|
|
138
|
-
requestParameters:
|
|
137
|
+
public httpGetSearchFacetByName(
|
|
138
|
+
requestParameters: HttpGetSearchFacetByNameRequestParams,
|
|
139
139
|
observe?: 'events',
|
|
140
140
|
reportProgress?: boolean,
|
|
141
141
|
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
142
142
|
): Observable<HttpEvent<SearchFacet>>;
|
|
143
|
-
public
|
|
144
|
-
requestParameters:
|
|
143
|
+
public httpGetSearchFacetByName(
|
|
144
|
+
requestParameters: HttpGetSearchFacetByNameRequestParams,
|
|
145
145
|
observe: any = 'body',
|
|
146
146
|
reportProgress: boolean = false,
|
|
147
147
|
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
148
148
|
): Observable<any> {
|
|
149
149
|
const name = requestParameters?.name;
|
|
150
150
|
if (name === null || name === undefined) {
|
|
151
|
-
throw new Error('Required parameter name was null or undefined when calling
|
|
151
|
+
throw new Error('Required parameter name was null or undefined when calling httpGetSearchFacetByName.');
|
|
152
152
|
}
|
|
153
153
|
const s = requestParameters?.s;
|
|
154
154
|
if (s === null || s === undefined) {
|
|
155
|
-
throw new Error('Required parameter s was null or undefined when calling
|
|
155
|
+
throw new Error('Required parameter s was null or undefined when calling httpGetSearchFacetByName.');
|
|
156
156
|
}
|
|
157
157
|
const collectiontypeid = requestParameters?.collectiontypeid;
|
|
158
158
|
const collectionid = requestParameters?.collectionid;
|
|
@@ -207,7 +207,7 @@ export class PublicSearchManagementService extends BaseService {
|
|
|
207
207
|
}
|
|
208
208
|
}
|
|
209
209
|
|
|
210
|
-
let localVarPath = `/search/
|
|
210
|
+
let localVarPath = `/search/facet`;
|
|
211
211
|
const { basePath, withCredentials } = this.configuration;
|
|
212
212
|
return this.httpClient.request<SearchFacet>('get', `${basePath}${localVarPath}`, {
|
|
213
213
|
context: localVarHttpContext,
|
|
@@ -23,7 +23,7 @@ import { AgravityPublicConfiguration } from '../configuration';
|
|
|
23
23
|
import { BaseService } from '../api.base.service';
|
|
24
24
|
|
|
25
25
|
export interface HttpTranslationsByIdRequestParams {
|
|
26
|
-
/** The ID of any translateable entity (Asset, Collection, Collection Type, Download Format). */
|
|
26
|
+
/** The ID of any translateable entity (Asset, Collection, Collection Type, Download Format, Item Group). */
|
|
27
27
|
id: string;
|
|
28
28
|
/** If the items should be included (only for entity type Collection and Asset). */
|
|
29
29
|
items?: boolean;
|
|
@@ -37,7 +37,7 @@ export interface HttpTranslationsByIdFilterByCustomFieldRequestParams {
|
|
|
37
37
|
}
|
|
38
38
|
|
|
39
39
|
export interface HttpTranslationsByIdFilterByPropertyRequestParams {
|
|
40
|
-
/** The ID of any translateable entity (Asset, Collection, Collection Type, Download Format). */
|
|
40
|
+
/** The ID of any translateable entity (Asset, Collection, Collection Type, Download Format, Item Group). */
|
|
41
41
|
id: string;
|
|
42
42
|
/** Limit to one specific property (key) */
|
|
43
43
|
property: string;
|
|
@@ -58,7 +58,7 @@ export class PublicTranslationManagementService extends BaseService {
|
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* Get all the translations of a whole entity (Asset, Collection, Collection Type, Download Format)
|
|
61
|
+
* Get all the translations of a whole entity (Asset, Collection, Collection Type, Download Format, Item Group)
|
|
62
62
|
* @endpoint get /translations/{id}
|
|
63
63
|
* @param requestParameters
|
|
64
64
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
@@ -218,7 +218,7 @@ export class PublicTranslationManagementService extends BaseService {
|
|
|
218
218
|
}
|
|
219
219
|
|
|
220
220
|
/**
|
|
221
|
-
* Get the translations of a specific field on the entity (Asset, Collection, Collection Type, Download Format)
|
|
221
|
+
* Get the translations of a specific field on the entity (Asset, Collection, Collection Type, Download Format, Item Group)
|
|
222
222
|
* @endpoint get /translations/{id}/{property}
|
|
223
223
|
* @param requestParameters
|
|
224
224
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
@@ -30,6 +30,7 @@ export interface Asset {
|
|
|
30
30
|
checkout?: AssetCheckout | null;
|
|
31
31
|
fs_synced?: string | null;
|
|
32
32
|
custom?: any | null;
|
|
33
|
+
item_ids?: Array<string> | null;
|
|
33
34
|
items?: Array<CollTypeItem> | null;
|
|
34
35
|
translations?: { [key: string]: { [key: string]: any } } | null;
|
|
35
36
|
role?: Asset.RoleEnum;
|
|
@@ -14,16 +14,19 @@ export interface CollTypeItem {
|
|
|
14
14
|
name?: string | null;
|
|
15
15
|
item_type?: string | null;
|
|
16
16
|
format?: string | null;
|
|
17
|
-
label?: string | null;
|
|
18
17
|
default_value?: any | null;
|
|
18
|
+
ref_id?: string | null;
|
|
19
19
|
mandatory?: boolean | null;
|
|
20
20
|
searchable?: boolean | null;
|
|
21
21
|
onlyasset?: boolean | null;
|
|
22
22
|
multi?: boolean | null;
|
|
23
|
+
search_target_id?: string | null;
|
|
23
24
|
md5?: string | null;
|
|
24
25
|
group?: string | null;
|
|
25
26
|
order?: number | null;
|
|
26
27
|
translations?: { [key: string]: { [key: string]: any } } | null;
|
|
28
|
+
description?: string | null;
|
|
29
|
+
add_properties?: { [key: string]: any } | null;
|
|
27
30
|
status?: string | null;
|
|
28
31
|
created_date?: string | null;
|
|
29
32
|
created_by?: string | null;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agravity OpenAPI Documentation - Public Functions
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@agravity.io
|
|
5
|
+
*
|
|
6
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
+
* https://openapi-generator.tech
|
|
8
|
+
* Do not edit the class manually.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export interface CollTypeItemRef {
|
|
12
|
+
item_id?: string | null;
|
|
13
|
+
group_id?: string | null;
|
|
14
|
+
order?: number | null;
|
|
15
|
+
}
|
|
@@ -16,6 +16,7 @@ export interface Collection {
|
|
|
16
16
|
path?: string | null;
|
|
17
17
|
level?: number | null;
|
|
18
18
|
custom?: any | null;
|
|
19
|
+
item_ids?: Array<string> | null;
|
|
19
20
|
items?: Array<CollTypeItem> | null;
|
|
20
21
|
translations?: { [key: string]: { [key: string]: any } } | null;
|
|
21
22
|
role?: Collection.RoleEnum;
|
|
@@ -8,12 +8,14 @@
|
|
|
8
8
|
* Do not edit the class manually.
|
|
9
9
|
*/
|
|
10
10
|
import { CollTypeItem } from './collTypeItem.pub.agravity';
|
|
11
|
+
import { CollTypeItemRef } from './collTypeItemRef.pub.agravity';
|
|
11
12
|
import { PermissionEntity } from './permissionEntity.pub.agravity';
|
|
12
13
|
|
|
13
14
|
export interface CollectionType {
|
|
14
15
|
id?: string | null;
|
|
15
16
|
entity_type?: string | null;
|
|
16
17
|
name?: string | null;
|
|
18
|
+
item_refs?: Array<CollTypeItemRef> | null;
|
|
17
19
|
items?: Array<CollTypeItem> | null;
|
|
18
20
|
translations?: { [key: string]: { [key: string]: any } } | null;
|
|
19
21
|
order?: number | null;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agravity OpenAPI Documentation - Public Functions
|
|
3
|
+
*
|
|
4
|
+
* Contact: support@agravity.io
|
|
5
|
+
*
|
|
6
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7
|
+
* https://openapi-generator.tech
|
|
8
|
+
* Do not edit the class manually.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export interface ItemGroup {
|
|
12
|
+
id?: string | null;
|
|
13
|
+
name?: string | null;
|
|
14
|
+
entityType?: string;
|
|
15
|
+
translations?: { [key: string]: { [key: string]: any } } | null;
|
|
16
|
+
description?: string | null;
|
|
17
|
+
add_properties?: { [key: string]: any } | null;
|
|
18
|
+
status?: string | null;
|
|
19
|
+
created_date?: string | null;
|
|
20
|
+
created_by?: string | null;
|
|
21
|
+
modified_date?: string | null;
|
|
22
|
+
modified_by?: string | null;
|
|
23
|
+
pk?: string | null;
|
|
24
|
+
_etag?: string | null;
|
|
25
|
+
}
|
package/model/models.ts
CHANGED
|
@@ -16,6 +16,7 @@ export * from './assetRelation.pub.agravity';
|
|
|
16
16
|
export * from './assetRelationType.pub.agravity';
|
|
17
17
|
export * from './azSearchOptions.pub.agravity';
|
|
18
18
|
export * from './collTypeItem.pub.agravity';
|
|
19
|
+
export * from './collTypeItemRef.pub.agravity';
|
|
19
20
|
export * from './collection.pub.agravity';
|
|
20
21
|
export * from './collectionType.pub.agravity';
|
|
21
22
|
export * from './collectionUDL.pub.agravity';
|
|
@@ -42,6 +43,7 @@ export * from './entityListResult.pub.agravity';
|
|
|
42
43
|
export * from './entityNamesRequest.pub.agravity';
|
|
43
44
|
export * from './frontendAppConfig.pub.agravity';
|
|
44
45
|
export * from './groupAllAppData.pub.agravity';
|
|
46
|
+
export * from './itemGroup.pub.agravity';
|
|
45
47
|
export * from './moveCollectionBody.pub.agravity';
|
|
46
48
|
export * from './permissionEntity.pub.agravity';
|
|
47
49
|
export * from './portal.pub.agravity';
|
|
@@ -7,7 +7,10 @@
|
|
|
7
7
|
* https://openapi-generator.tech
|
|
8
8
|
* Do not edit the class manually.
|
|
9
9
|
*/
|
|
10
|
+
import { CollTypeItem } from './collTypeItem.pub.agravity';
|
|
11
|
+
import { CollectionUDL } from './collectionUDL.pub.agravity';
|
|
10
12
|
import { CreateSftpUserResult } from './createSftpUserResult.pub.agravity';
|
|
13
|
+
import { StaticDefinedList } from './staticDefinedList.pub.agravity';
|
|
11
14
|
|
|
12
15
|
export interface SecureUploadEntity {
|
|
13
16
|
id?: string | null;
|
|
@@ -20,6 +23,12 @@ export interface SecureUploadEntity {
|
|
|
20
23
|
message?: string | null;
|
|
21
24
|
sftp_connection?: CreateSftpUserResult | null;
|
|
22
25
|
check_name_for_version?: boolean | null;
|
|
26
|
+
check_extension_for_version?: boolean | null;
|
|
27
|
+
asset_metadata_items?: Array<string> | null;
|
|
28
|
+
asset_metadata_optional_items?: Array<string> | null;
|
|
29
|
+
asset_metadata_fields?: Array<CollTypeItem> | null;
|
|
30
|
+
asset_metadata_sdls?: Array<StaticDefinedList> | null;
|
|
31
|
+
asset_metadata_udls?: Array<CollectionUDL> | null;
|
|
23
32
|
status?: string | null;
|
|
24
33
|
created_date?: string | null;
|
|
25
34
|
created_by?: string | null;
|
|
@@ -14,6 +14,7 @@ export interface VersionEntity {
|
|
|
14
14
|
entity_type?: string | null;
|
|
15
15
|
versions?: Array<VersionedAsset> | null;
|
|
16
16
|
region_of_origin?: string | null;
|
|
17
|
+
translations?: { [key: string]: { [key: string]: any } } | null;
|
|
17
18
|
status?: string | null;
|
|
18
19
|
created_date?: string | null;
|
|
19
20
|
created_by?: string | null;
|
package/package.json
CHANGED