@ogcio/building-blocks-sdk 0.2.15 → 0.2.17
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/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +14 -0
- package/dist/client/clients/journey/index.d.ts +4 -0
- package/dist/client/clients/journey/index.d.ts.map +1 -1
- package/dist/client/clients/journey/schema.d.ts +2 -0
- package/dist/client/clients/journey/schema.d.ts.map +1 -1
- package/dist/client/clients/profile/index.d.ts +8 -0
- package/dist/client/clients/profile/index.d.ts.map +1 -1
- package/dist/client/clients/profile/schema.d.ts +134 -127
- package/dist/client/clients/profile/schema.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/client/clients/journey/open-api-definition.json +36 -2
- package/src/client/clients/journey/schema.ts +2 -0
- package/src/client/clients/profile/open-api-definition.json +37 -2
- package/src/client/clients/profile/schema.ts +134 -127
|
@@ -171,7 +171,134 @@ export interface paths {
|
|
|
171
171
|
cookie?: never;
|
|
172
172
|
};
|
|
173
173
|
/** @description List profile imports with pagination */
|
|
174
|
-
get:
|
|
174
|
+
get: {
|
|
175
|
+
parameters: {
|
|
176
|
+
query?: {
|
|
177
|
+
organizationId?: string;
|
|
178
|
+
source?: "csv" | "json";
|
|
179
|
+
/** @description If set, the endpoint searches for profile imports with this value in the metadata.filename */
|
|
180
|
+
search?: string;
|
|
181
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
182
|
+
offset?: string;
|
|
183
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
184
|
+
limit?: string;
|
|
185
|
+
};
|
|
186
|
+
header?: never;
|
|
187
|
+
path?: never;
|
|
188
|
+
cookie?: never;
|
|
189
|
+
};
|
|
190
|
+
requestBody?: never;
|
|
191
|
+
responses: {
|
|
192
|
+
/** @description Default Response */
|
|
193
|
+
200: {
|
|
194
|
+
headers: {
|
|
195
|
+
[name: string]: unknown;
|
|
196
|
+
};
|
|
197
|
+
content: {
|
|
198
|
+
"application/json": {
|
|
199
|
+
data: {
|
|
200
|
+
/** Format: uuid */
|
|
201
|
+
id: string;
|
|
202
|
+
organisationId?: string;
|
|
203
|
+
status: string;
|
|
204
|
+
source: "csv" | "json";
|
|
205
|
+
metadata?: {
|
|
206
|
+
filename: string;
|
|
207
|
+
mimetype: string;
|
|
208
|
+
};
|
|
209
|
+
/** Format: date-time */
|
|
210
|
+
createdAt: string;
|
|
211
|
+
/** Format: date-time */
|
|
212
|
+
updatedAt: string;
|
|
213
|
+
}[];
|
|
214
|
+
metadata?: {
|
|
215
|
+
/** @description Object containing the links to the related endpoints */
|
|
216
|
+
links?: {
|
|
217
|
+
self: {
|
|
218
|
+
/** @description URL pointing to the request itself */
|
|
219
|
+
href?: string;
|
|
220
|
+
};
|
|
221
|
+
next?: {
|
|
222
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
223
|
+
href?: string;
|
|
224
|
+
};
|
|
225
|
+
prev?: {
|
|
226
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
227
|
+
href?: string;
|
|
228
|
+
};
|
|
229
|
+
first: {
|
|
230
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
231
|
+
href?: string;
|
|
232
|
+
};
|
|
233
|
+
last: {
|
|
234
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
235
|
+
href?: string;
|
|
236
|
+
};
|
|
237
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
238
|
+
pages: {
|
|
239
|
+
[key: string]: {
|
|
240
|
+
href?: string;
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
/** @description Number representing the total number of available items */
|
|
245
|
+
totalCount?: number;
|
|
246
|
+
};
|
|
247
|
+
};
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
/** @description Default Response */
|
|
251
|
+
"4XX": {
|
|
252
|
+
headers: {
|
|
253
|
+
[name: string]: unknown;
|
|
254
|
+
};
|
|
255
|
+
content: {
|
|
256
|
+
"application/json": {
|
|
257
|
+
/** @description Code used to categorize the error */
|
|
258
|
+
code: string;
|
|
259
|
+
/** @description Description of the error */
|
|
260
|
+
detail: string;
|
|
261
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
262
|
+
requestId: string;
|
|
263
|
+
/** @description Name of the error type */
|
|
264
|
+
name: string;
|
|
265
|
+
/** @description List of the validation errors */
|
|
266
|
+
validation?: {
|
|
267
|
+
fieldName: string;
|
|
268
|
+
message: string;
|
|
269
|
+
}[];
|
|
270
|
+
validationContext?: string;
|
|
271
|
+
statusCode: number;
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
/** @description Default Response */
|
|
276
|
+
"5XX": {
|
|
277
|
+
headers: {
|
|
278
|
+
[name: string]: unknown;
|
|
279
|
+
};
|
|
280
|
+
content: {
|
|
281
|
+
"application/json": {
|
|
282
|
+
/** @description Code used to categorize the error */
|
|
283
|
+
code: string;
|
|
284
|
+
/** @description Description of the error */
|
|
285
|
+
detail: string;
|
|
286
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
287
|
+
requestId: string;
|
|
288
|
+
/** @description Name of the error type */
|
|
289
|
+
name: string;
|
|
290
|
+
/** @description List of the validation errors */
|
|
291
|
+
validation?: {
|
|
292
|
+
fieldName: string;
|
|
293
|
+
message: string;
|
|
294
|
+
}[];
|
|
295
|
+
validationContext?: string;
|
|
296
|
+
statusCode: number;
|
|
297
|
+
};
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
};
|
|
175
302
|
put?: never;
|
|
176
303
|
post?: never;
|
|
177
304
|
delete?: never;
|
|
@@ -262,6 +389,12 @@ export interface operations {
|
|
|
262
389
|
query?: {
|
|
263
390
|
/** @description If set, the endpoint searches for users whom contain this value in either the public name or the email address */
|
|
264
391
|
search?: string;
|
|
392
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the imported first name */
|
|
393
|
+
firstName?: string;
|
|
394
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the imported last name */
|
|
395
|
+
lastName?: string;
|
|
396
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the imported email */
|
|
397
|
+
email?: string;
|
|
265
398
|
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
266
399
|
offset?: string;
|
|
267
400
|
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
@@ -806,132 +939,6 @@ export interface operations {
|
|
|
806
939
|
};
|
|
807
940
|
};
|
|
808
941
|
};
|
|
809
|
-
listProfileImports: {
|
|
810
|
-
parameters: {
|
|
811
|
-
query?: {
|
|
812
|
-
organizationId?: string;
|
|
813
|
-
source?: "csv" | "json";
|
|
814
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
815
|
-
offset?: string;
|
|
816
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
817
|
-
limit?: string;
|
|
818
|
-
};
|
|
819
|
-
header?: never;
|
|
820
|
-
path?: never;
|
|
821
|
-
cookie?: never;
|
|
822
|
-
};
|
|
823
|
-
requestBody?: never;
|
|
824
|
-
responses: {
|
|
825
|
-
/** @description Default Response */
|
|
826
|
-
200: {
|
|
827
|
-
headers: {
|
|
828
|
-
[name: string]: unknown;
|
|
829
|
-
};
|
|
830
|
-
content: {
|
|
831
|
-
"application/json": {
|
|
832
|
-
data: {
|
|
833
|
-
/** Format: uuid */
|
|
834
|
-
id: string;
|
|
835
|
-
organisationId?: string;
|
|
836
|
-
status: string;
|
|
837
|
-
source: "csv" | "json";
|
|
838
|
-
metadata?: {
|
|
839
|
-
filename: string;
|
|
840
|
-
mimetype: string;
|
|
841
|
-
};
|
|
842
|
-
/** Format: date-time */
|
|
843
|
-
createdAt: string;
|
|
844
|
-
/** Format: date-time */
|
|
845
|
-
updatedAt: string;
|
|
846
|
-
}[];
|
|
847
|
-
metadata?: {
|
|
848
|
-
/** @description Object containing the links to the related endpoints */
|
|
849
|
-
links?: {
|
|
850
|
-
self: {
|
|
851
|
-
/** @description URL pointing to the request itself */
|
|
852
|
-
href?: string;
|
|
853
|
-
};
|
|
854
|
-
next?: {
|
|
855
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
856
|
-
href?: string;
|
|
857
|
-
};
|
|
858
|
-
prev?: {
|
|
859
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
860
|
-
href?: string;
|
|
861
|
-
};
|
|
862
|
-
first: {
|
|
863
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
864
|
-
href?: string;
|
|
865
|
-
};
|
|
866
|
-
last: {
|
|
867
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
868
|
-
href?: string;
|
|
869
|
-
};
|
|
870
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
871
|
-
pages: {
|
|
872
|
-
[key: string]: {
|
|
873
|
-
href?: string;
|
|
874
|
-
};
|
|
875
|
-
};
|
|
876
|
-
};
|
|
877
|
-
/** @description Number representing the total number of available items */
|
|
878
|
-
totalCount?: number;
|
|
879
|
-
};
|
|
880
|
-
};
|
|
881
|
-
};
|
|
882
|
-
};
|
|
883
|
-
/** @description Default Response */
|
|
884
|
-
"4XX": {
|
|
885
|
-
headers: {
|
|
886
|
-
[name: string]: unknown;
|
|
887
|
-
};
|
|
888
|
-
content: {
|
|
889
|
-
"application/json": {
|
|
890
|
-
/** @description Code used to categorize the error */
|
|
891
|
-
code: string;
|
|
892
|
-
/** @description Description of the error */
|
|
893
|
-
detail: string;
|
|
894
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
895
|
-
requestId: string;
|
|
896
|
-
/** @description Name of the error type */
|
|
897
|
-
name: string;
|
|
898
|
-
/** @description List of the validation errors */
|
|
899
|
-
validation?: {
|
|
900
|
-
fieldName: string;
|
|
901
|
-
message: string;
|
|
902
|
-
}[];
|
|
903
|
-
validationContext?: string;
|
|
904
|
-
statusCode: number;
|
|
905
|
-
};
|
|
906
|
-
};
|
|
907
|
-
};
|
|
908
|
-
/** @description Default Response */
|
|
909
|
-
"5XX": {
|
|
910
|
-
headers: {
|
|
911
|
-
[name: string]: unknown;
|
|
912
|
-
};
|
|
913
|
-
content: {
|
|
914
|
-
"application/json": {
|
|
915
|
-
/** @description Code used to categorize the error */
|
|
916
|
-
code: string;
|
|
917
|
-
/** @description Description of the error */
|
|
918
|
-
detail: string;
|
|
919
|
-
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
920
|
-
requestId: string;
|
|
921
|
-
/** @description Name of the error type */
|
|
922
|
-
name: string;
|
|
923
|
-
/** @description List of the validation errors */
|
|
924
|
-
validation?: {
|
|
925
|
-
fieldName: string;
|
|
926
|
-
message: string;
|
|
927
|
-
}[];
|
|
928
|
-
validationContext?: string;
|
|
929
|
-
statusCode: number;
|
|
930
|
-
};
|
|
931
|
-
};
|
|
932
|
-
};
|
|
933
|
-
};
|
|
934
|
-
};
|
|
935
942
|
getProfileImportDetails: {
|
|
936
943
|
parameters: {
|
|
937
944
|
query?: never;
|