@agravity/public 10.1.6 → 10.2.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 +2 -0
- package/README.md +3 -3
- package/api/publicAssetOperations.pub.agravity.ts +7 -0
- package/api/publicAuthenticationManagement.pub.agravity.ts +87 -0
- package/model/agravityUser.pub.agravity.ts +29 -0
- package/model/agravityUserOnlineStatus.pub.agravity.ts +14 -0
- package/model/models.ts +2 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -35,6 +35,8 @@ git_push.sh
|
|
|
35
35
|
index.ts
|
|
36
36
|
model/agravityErrorResponse.pub.agravity.ts
|
|
37
37
|
model/agravityInfoResponse.pub.agravity.ts
|
|
38
|
+
model/agravityUser.pub.agravity.ts
|
|
39
|
+
model/agravityUserOnlineStatus.pub.agravity.ts
|
|
38
40
|
model/agravityVersion.pub.agravity.ts
|
|
39
41
|
model/allWebAppData.pub.agravity.ts
|
|
40
42
|
model/asset.pub.agravity.ts
|
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# @agravity/public@10.
|
|
1
|
+
# @agravity/public@10.2.0
|
|
2
2
|
|
|
3
3
|
<h1>Agravity API Reference</h1>This is the public API description of Agravity GmbH.<br/><h2>Resources</h2><ul> <li>Collection type management</li> <li>Collections management</li> <li>Assets management</li> <li>Assets operations</li> <li>Assets publishing</li> <li>Collection Sharing (consume share)</li> <li>Secure Upload (validate + upload file)</li> <li>Download ZIP</li> <li>Search</li> <li>General management</li></ul><h2> Operations</h2>Agravity API performs the following operations:<ul> <li>List / get single collection types</li> <li>List / get single collections</li> <li>List / get single assets</li> <li>Operations on assets like: blobs, rotate, resize, similar, collections, customfields, download</li> <li>List / get single published asset</li> <li>Search for assets or collections</li> <li>Get version of deployment</li></ul><br/><b>API key is needed to access these endpoints.</b><br/><br/>Copyright © Agravity GmbH 2025. All Rights Reserved
|
|
4
4
|
|
|
5
|
-
The version of the OpenAPI document: 10.
|
|
5
|
+
The version of the OpenAPI document: 10.2.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@10.
|
|
27
|
+
npm install @agravity/public@10.2.0 --save
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
_without publishing (not recommended):_
|
|
@@ -130,6 +130,8 @@ export interface HttpImageDynamicEditRequestParams {
|
|
|
130
130
|
id: string;
|
|
131
131
|
/** Operations to be performed on the image directly mapped to c# imagemagick sdk */
|
|
132
132
|
dynamicImageOperation: Array<DynamicImageOperation>;
|
|
133
|
+
/** If the file should have a specific naming. */
|
|
134
|
+
targetFilename?: string;
|
|
133
135
|
}
|
|
134
136
|
|
|
135
137
|
export interface HttpImageDynamicGetFromDownloadIdRequestParams {
|
|
@@ -778,6 +780,10 @@ export class PublicAssetOperationsService extends BaseService {
|
|
|
778
780
|
if (dynamicImageOperation === null || dynamicImageOperation === undefined) {
|
|
779
781
|
throw new Error('Required parameter dynamicImageOperation was null or undefined when calling httpImageDynamicEdit.');
|
|
780
782
|
}
|
|
783
|
+
const targetFilename = requestParameters?.targetFilename;
|
|
784
|
+
|
|
785
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
786
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>targetFilename, 'target_filename');
|
|
781
787
|
|
|
782
788
|
let localVarHeaders = this.defaultHeaders;
|
|
783
789
|
|
|
@@ -805,6 +811,7 @@ export class PublicAssetOperationsService extends BaseService {
|
|
|
805
811
|
return this.httpClient.request('post', `${basePath}${localVarPath}`, {
|
|
806
812
|
context: localVarHttpContext,
|
|
807
813
|
body: dynamicImageOperation,
|
|
814
|
+
params: localVarQueryParameters,
|
|
808
815
|
responseType: 'blob',
|
|
809
816
|
...(withCredentials ? { withCredentials } : {}),
|
|
810
817
|
headers: localVarHeaders,
|
|
@@ -14,6 +14,8 @@ import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpParam
|
|
|
14
14
|
import { CustomHttpParameterCodec } from '../encoder';
|
|
15
15
|
import { Observable } from 'rxjs';
|
|
16
16
|
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import { AgravityUser } from '../model/agravityUser.pub.agravity';
|
|
17
19
|
// @ts-ignore
|
|
18
20
|
import { SasToken } from '../model/sasToken.pub.agravity';
|
|
19
21
|
|
|
@@ -22,6 +24,13 @@ import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
|
|
|
22
24
|
import { AgravityPublicConfiguration } from '../configuration';
|
|
23
25
|
import { BaseService } from '../api.base.service';
|
|
24
26
|
|
|
27
|
+
export interface HttpAuthGetAgravityUserByIdRequestParams {
|
|
28
|
+
/** The ID of the requested Agravity user. */
|
|
29
|
+
id: string;
|
|
30
|
+
/** (Optional): If the reponse should be limited to name and email. */
|
|
31
|
+
limit?: boolean;
|
|
32
|
+
}
|
|
33
|
+
|
|
25
34
|
export interface HttpAuthGetContainerWriteSasTokenRequestParams {
|
|
26
35
|
/** The name of the blob container */
|
|
27
36
|
containerName: string;
|
|
@@ -41,6 +50,84 @@ export class PublicAuthenticationManagementService extends BaseService {
|
|
|
41
50
|
super(basePath, configuration);
|
|
42
51
|
}
|
|
43
52
|
|
|
53
|
+
/**
|
|
54
|
+
* This gets the user information about an Agravity User (incl. Online Status). Only full information if requester and userId are the same or it has role Admin.
|
|
55
|
+
* @param requestParameters
|
|
56
|
+
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
57
|
+
* @param reportProgress flag to report request and response progress.
|
|
58
|
+
*/
|
|
59
|
+
public httpAuthGetAgravityUserById(
|
|
60
|
+
requestParameters: HttpAuthGetAgravityUserByIdRequestParams,
|
|
61
|
+
observe?: 'body',
|
|
62
|
+
reportProgress?: boolean,
|
|
63
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
64
|
+
): Observable<AgravityUser>;
|
|
65
|
+
public httpAuthGetAgravityUserById(
|
|
66
|
+
requestParameters: HttpAuthGetAgravityUserByIdRequestParams,
|
|
67
|
+
observe?: 'response',
|
|
68
|
+
reportProgress?: boolean,
|
|
69
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
70
|
+
): Observable<HttpResponse<AgravityUser>>;
|
|
71
|
+
public httpAuthGetAgravityUserById(
|
|
72
|
+
requestParameters: HttpAuthGetAgravityUserByIdRequestParams,
|
|
73
|
+
observe?: 'events',
|
|
74
|
+
reportProgress?: boolean,
|
|
75
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
76
|
+
): Observable<HttpEvent<AgravityUser>>;
|
|
77
|
+
public httpAuthGetAgravityUserById(
|
|
78
|
+
requestParameters: HttpAuthGetAgravityUserByIdRequestParams,
|
|
79
|
+
observe: any = 'body',
|
|
80
|
+
reportProgress: boolean = false,
|
|
81
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
82
|
+
): Observable<any> {
|
|
83
|
+
const id = requestParameters?.id;
|
|
84
|
+
if (id === null || id === undefined) {
|
|
85
|
+
throw new Error('Required parameter id was null or undefined when calling httpAuthGetAgravityUserById.');
|
|
86
|
+
}
|
|
87
|
+
const limit = requestParameters?.limit;
|
|
88
|
+
|
|
89
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
90
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>limit, 'limit');
|
|
91
|
+
|
|
92
|
+
let localVarHeaders = this.defaultHeaders;
|
|
93
|
+
|
|
94
|
+
// authentication (function_key) required
|
|
95
|
+
localVarHeaders = this.configuration.addCredentialToHeaders('function_key', 'x-functions-key', localVarHeaders);
|
|
96
|
+
|
|
97
|
+
const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
|
|
98
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
99
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();
|
|
103
|
+
|
|
104
|
+
const localVarTransferCache: boolean = options?.transferCache ?? true;
|
|
105
|
+
|
|
106
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
107
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
108
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
109
|
+
responseType_ = 'text';
|
|
110
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
111
|
+
responseType_ = 'json';
|
|
112
|
+
} else {
|
|
113
|
+
responseType_ = 'blob';
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
let localVarPath = `/auth/users/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
|
|
118
|
+
const { basePath, withCredentials } = this.configuration;
|
|
119
|
+
return this.httpClient.request<AgravityUser>('get', `${basePath}${localVarPath}`, {
|
|
120
|
+
context: localVarHttpContext,
|
|
121
|
+
params: localVarQueryParameters,
|
|
122
|
+
responseType: <any>responseType_,
|
|
123
|
+
...(withCredentials ? { withCredentials } : {}),
|
|
124
|
+
headers: localVarHeaders,
|
|
125
|
+
observe: observe,
|
|
126
|
+
transferCache: localVarTransferCache,
|
|
127
|
+
reportProgress: reportProgress
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
|
|
44
131
|
/**
|
|
45
132
|
* This endpoint creates and returns a SAS-Token with write access for the requested container
|
|
46
133
|
* @param requestParameters
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agravity OpenAPI Documentation - Public Functions
|
|
3
|
+
*
|
|
4
|
+
* Contact: office@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
|
+
import { AgravityUserOnlineStatus } from './agravityUserOnlineStatus.pub.agravity';
|
|
11
|
+
|
|
12
|
+
export interface AgravityUser {
|
|
13
|
+
id?: string | null;
|
|
14
|
+
entity_type?: string | null;
|
|
15
|
+
name?: string | null;
|
|
16
|
+
email?: string | null;
|
|
17
|
+
impersonation?: string | null;
|
|
18
|
+
apikey?: string | null;
|
|
19
|
+
online_status?: AgravityUserOnlineStatus | null;
|
|
20
|
+
roles?: Array<string> | null;
|
|
21
|
+
groups?: Array<string> | null;
|
|
22
|
+
status?: string | null;
|
|
23
|
+
created_date?: string | null;
|
|
24
|
+
created_by?: string | null;
|
|
25
|
+
modified_date?: string | null;
|
|
26
|
+
modified_by?: string | null;
|
|
27
|
+
pk?: string | null;
|
|
28
|
+
_etag?: string | null;
|
|
29
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agravity OpenAPI Documentation - Public Functions
|
|
3
|
+
*
|
|
4
|
+
* Contact: office@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 AgravityUserOnlineStatus {
|
|
12
|
+
status?: string | null;
|
|
13
|
+
last_connection?: string | null;
|
|
14
|
+
}
|
package/model/models.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
export * from './agravityErrorResponse.pub.agravity';
|
|
2
2
|
export * from './agravityInfoResponse.pub.agravity';
|
|
3
|
+
export * from './agravityUser.pub.agravity';
|
|
4
|
+
export * from './agravityUserOnlineStatus.pub.agravity';
|
|
3
5
|
export * from './agravityVersion.pub.agravity';
|
|
4
6
|
export * from './allWebAppData.pub.agravity';
|
|
5
7
|
export * from './asset.pub.agravity';
|
package/package.json
CHANGED