@salesforce/lds-adapters-cdp-data-clean-room 0.1.0-dev1

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.
Files changed (57) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/cdp-data-clean-room.js +3350 -0
  3. package/dist/es/es2018/types/src/generated/adapters/acceptDataCleanRoomInvitation.d.ts +17 -0
  4. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  5. package/dist/es/es2018/types/src/generated/adapters/createDataCleanRoomCollaboration.d.ts +22 -0
  6. package/dist/es/es2018/types/src/generated/adapters/createDataCleanRoomSpecification.d.ts +22 -0
  7. package/dist/es/es2018/types/src/generated/adapters/createProvider.d.ts +23 -0
  8. package/dist/es/es2018/types/src/generated/adapters/executeDataCleanRoomQuery.d.ts +17 -0
  9. package/dist/es/es2018/types/src/generated/adapters/getAllDataCleanRoomQueryPaginated.d.ts +31 -0
  10. package/dist/es/es2018/types/src/generated/adapters/getAllDataCleanRoomsPaginated.d.ts +30 -0
  11. package/dist/es/es2018/types/src/generated/adapters/getDataCleanRoomProvidersPaginated.d.ts +30 -0
  12. package/dist/es/es2018/types/src/generated/adapters/getDataCleanRoomSpecificationsPaginated.d.ts +30 -0
  13. package/dist/es/es2018/types/src/generated/adapters/getDataCleanRoomTemplatePaginated.d.ts +29 -0
  14. package/dist/es/es2018/types/src/generated/adapters/rejectDataCleanRoomInvitation.d.ts +16 -0
  15. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +11 -0
  16. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +17 -0
  17. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomCollaborations.d.ts +18 -0
  18. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomCollaborationsJobsByCollaborationIdOrApiName.d.ts +21 -0
  19. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomProviders.d.ts +18 -0
  20. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomSpecifications.d.ts +18 -0
  21. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomTemplates.d.ts +17 -0
  22. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomCollaborations.d.ts +19 -0
  23. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomCollaborationsActionsRunByCollaborationIdOrApiName.d.ts +16 -0
  24. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomProviders.d.ts +20 -0
  25. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomSpecifications.d.ts +19 -0
  26. package/dist/es/es2018/types/src/generated/resources/putSsotDataCleanRoomCollaborationsActionsAcceptInvitationByCollaborationIdOrApiName.d.ts +16 -0
  27. package/dist/es/es2018/types/src/generated/resources/putSsotDataCleanRoomCollaborationsActionsRejectInvitationByCollaborationIdOrApiName.d.ts +15 -0
  28. package/dist/es/es2018/types/src/generated/types/CdpPaginatedResponseBaseRepresentation.d.ts +34 -0
  29. package/dist/es/es2018/types/src/generated/types/CdpUserRepresentation.d.ts +34 -0
  30. package/dist/es/es2018/types/src/generated/types/DataCleanRoomAcceptInvitationInputRepresentation.d.ts +31 -0
  31. package/dist/es/es2018/types/src/generated/types/DataCleanRoomCollaborationCollectionRepresentation.d.ts +44 -0
  32. package/dist/es/es2018/types/src/generated/types/DataCleanRoomCollaborationInputRepresentation.d.ts +49 -0
  33. package/dist/es/es2018/types/src/generated/types/DataCleanRoomCollaborationRepresentation.d.ts +81 -0
  34. package/dist/es/es2018/types/src/generated/types/DataCleanRoomDataSpecificationInputRepresentation.d.ts +49 -0
  35. package/dist/es/es2018/types/src/generated/types/DataCleanRoomDataSpecificationRepresentation.d.ts +84 -0
  36. package/dist/es/es2018/types/src/generated/types/DataCleanRoomMemberRepresentation.d.ts +58 -0
  37. package/dist/es/es2018/types/src/generated/types/DataCleanRoomProviderCollectionRepresentation.d.ts +53 -0
  38. package/dist/es/es2018/types/src/generated/types/DataCleanRoomProviderInputRepresentation.d.ts +52 -0
  39. package/dist/es/es2018/types/src/generated/types/DataCleanRoomProviderRepresentation.d.ts +80 -0
  40. package/dist/es/es2018/types/src/generated/types/DataCleanRoomQueryJobHistoryCollectionRepresentation.d.ts +44 -0
  41. package/dist/es/es2018/types/src/generated/types/DataCleanRoomQueryJobInputRepresentation.d.ts +31 -0
  42. package/dist/es/es2018/types/src/generated/types/DataCleanRoomQueryJobRepresentation.d.ts +77 -0
  43. package/dist/es/es2018/types/src/generated/types/DataCleanRoomRejectInvitationInputRepresentation.d.ts +28 -0
  44. package/dist/es/es2018/types/src/generated/types/DataCleanRoomSpecificationCollectionRepresentation.d.ts +53 -0
  45. package/dist/es/es2018/types/src/generated/types/DataCleanRoomTemplateCollectionRepresentation.d.ts +44 -0
  46. package/dist/es/es2018/types/src/generated/types/DataCleanRoomTemplateRepresentation.d.ts +62 -0
  47. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingAttributeFilterOptionRepresentation.d.ts +31 -0
  48. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingAttributeRepresentation.d.ts +72 -0
  49. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingPathAttributeRepresentation.d.ts +31 -0
  50. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingRepresentation.d.ts +60 -0
  51. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingSubjectAttributeRepresentation.d.ts +37 -0
  52. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  53. package/package.json +67 -0
  54. package/sfdc/index.d.ts +1 -0
  55. package/sfdc/index.js +3452 -0
  56. package/src/raml/api.raml +979 -0
  57. package/src/raml/luvio.raml +81 -0
@@ -0,0 +1,979 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '63.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v66.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ CdpUserRepresentation:
29
+ description: Represents a user
30
+ type: object
31
+ properties:
32
+ id?:
33
+ description: The 18 character user ID
34
+ type: string
35
+ name?:
36
+ description: The name of the user
37
+ type: string
38
+ profilePhotoUrl?:
39
+ description: The Chatter profile photo of the user
40
+ type: string
41
+ CdpPaginatedResponseBaseRepresentation:
42
+ description: Base paginated response representation
43
+ type: object
44
+ properties:
45
+ currentPageUrl:
46
+ description: Current page url
47
+ type: string
48
+ nextPageUrl:
49
+ description: Next page url if it exists
50
+ type: string | nil
51
+ totalSize:
52
+ description: Total size of collection
53
+ type: integer
54
+ DataCleanRoomProviderCollectionRepresentation:
55
+ description: Represents Data Clean Room Provider Collection
56
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
57
+ # type: CdpPaginatedResponseBaseRepresentation
58
+ type: object
59
+ properties:
60
+ currentPageUrl:
61
+ description: Current page url
62
+ type: string
63
+ required: false
64
+ nextPageUrl:
65
+ description: Next page url if it exists
66
+ type: string | nil
67
+ required: false
68
+ totalSize:
69
+ description: Total size of collection
70
+ type: integer
71
+ required: false
72
+ limit:
73
+ description: Number of records present in this response
74
+ type: integer
75
+ required: false
76
+ offset:
77
+ description: Start offset of the next batch
78
+ type: integer
79
+ required: false
80
+ providers:
81
+ description: List of provider definitions
82
+ type: array
83
+ items:
84
+ type: DataCleanRoomProviderRepresentation
85
+ DataCleanRoomProviderInputRepresentation:
86
+ description: Represents Cdp Data clean room Provider input
87
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
88
+ # type: CdpObjectBaseInputRepresentation
89
+ type: object
90
+ properties:
91
+ label:
92
+ description: label
93
+ type: string
94
+ required: true
95
+ description:
96
+ description: description
97
+ type: string
98
+ required: true
99
+ templateNames:
100
+ description: List of usecase templates that the provider supports
101
+ type: array
102
+ items:
103
+ type: string
104
+ required: true
105
+ dataCloudOrgId:
106
+ description: Unique ID representing Data Cloud org
107
+ type: string
108
+ required: true
109
+ domainUrl:
110
+ description: Domain URL of the provider
111
+ type: string
112
+ required: true
113
+ dataspaceName:
114
+ description: dataspaceName
115
+ type: string
116
+ required: false
117
+ name:
118
+ description: name
119
+ type: string
120
+ required: false
121
+ logoUrl:
122
+ description: Path to logo for discoverability
123
+ type: string
124
+ required: false
125
+ offCoreTenantId:
126
+ description: Off Core Tenant Id of the provider
127
+ type: string
128
+ required: true
129
+ DataCleanRoomProviderRepresentation:
130
+ description: Represents Cdp Data Clean Room Provider
131
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
132
+ # type: CdpAssetBaseRepresentation
133
+ properties:
134
+ createdBy?:
135
+ description: Created by
136
+ type: CdpUserRepresentation
137
+ createdDate?:
138
+ description: Created date
139
+ type: string
140
+ id:
141
+ description: The 18 character ID of the asset
142
+ type: string
143
+ label?:
144
+ description: Label of the asset
145
+ type: string
146
+ lastModifiedBy?:
147
+ description: Last modified by
148
+ type: CdpUserRepresentation
149
+ lastModifiedDate?:
150
+ description: Last modified date
151
+ type: string
152
+ name?:
153
+ description: Name of the asset
154
+ type: string
155
+ namespace?:
156
+ description: Namespace of the asset
157
+ type: string
158
+ url?:
159
+ description: Url
160
+ type: string
161
+ dataCloudOrgId:
162
+ description: Data Cloud Provider Org Id
163
+ type: string
164
+ description:
165
+ description: Data Clean Room Provider Description
166
+ type: string
167
+ domainUrl:
168
+ description: Data Clean Room Provider Domain Url
169
+ type: string
170
+ logoUrl:
171
+ description: Data Clean Room Provider Logo Url
172
+ type: string
173
+ required: false
174
+ offCoreTenantId:
175
+ description: Data Clean Room Provider Off Core Tenant Id
176
+ type: string
177
+ templateNames:
178
+ description: Data Clean Room Provider Template Names
179
+ type: array
180
+ items:
181
+ type: string
182
+ UseCaseTemplateMappingAttributeRepresentation:
183
+ description: Represents Cdp Data Clean Room Mapping details
184
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
185
+ # type: CdpAssetBaseRepresentation
186
+ properties:
187
+ createdBy?:
188
+ description: Created by
189
+ type: CdpUserRepresentation
190
+ createdDate?:
191
+ description: Created date
192
+ type: string
193
+ dataMapping?:
194
+ description: Data Clean Room Data Mapping
195
+ type: UseCaseTemplateMappingRepresentation
196
+ id?:
197
+ description: The 18 character ID of the asset
198
+ type: string
199
+ label?:
200
+ description: Label of the asset
201
+ type: string
202
+ lastModifiedBy?:
203
+ description: Last modified by
204
+ type: CdpUserRepresentation
205
+ lastModifiedDate?:
206
+ description: Last modified date
207
+ type: string
208
+ name?:
209
+ description: Name of the asset
210
+ type: string
211
+ namespace?:
212
+ description: Namespace of the asset
213
+ type: string
214
+ url?:
215
+ description: Url
216
+ type: string
217
+ alias:
218
+ description: Attribute Alias
219
+ type: string
220
+ attributeId:
221
+ description: Attribute Id
222
+ type: string
223
+ required: false
224
+ path:
225
+ description: Attribute Path
226
+ type: array
227
+ items:
228
+ type: UseCaseTemplateMappingPathAttributeRepresentation
229
+ subjectAttribute:
230
+ description: Subject Attribute
231
+ type: UseCaseTemplateMappingSubjectAttributeRepresentation
232
+ filterOptions?:
233
+ description: Attribute Filter Option
234
+ type: UseCaseTemplateMappingAttributeFilterOptionRepresentation
235
+ UseCaseTemplateMappingPathAttributeRepresentation:
236
+ description: Data Clean Room UseCase Template Mapping Path Attribute Config
237
+ type: object
238
+ properties:
239
+ sourceAttribute:
240
+ description: Source attribute details in path component
241
+ type: any
242
+ targetAttribute:
243
+ description: Target attribute details in path component
244
+ type: any
245
+ UseCaseTemplateMappingRepresentation:
246
+ description: Represents Cdp Data Clean Room Mapping details
247
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
248
+ # type: CdpAssetBaseRepresentation
249
+ properties:
250
+ createdBy?:
251
+ description: Created by
252
+ type: CdpUserRepresentation
253
+ createdDate?:
254
+ description: Created date
255
+ type: string
256
+ id?:
257
+ description: The 18 character ID of the asset
258
+ type: string
259
+ label?:
260
+ description: Label of the asset
261
+ type: string
262
+ lastModifiedBy?:
263
+ description: Last modified by
264
+ type: CdpUserRepresentation
265
+ lastModifiedDate?:
266
+ description: Last modified date
267
+ type: string
268
+ name?:
269
+ description: Name of the asset
270
+ type: string
271
+ namespace?:
272
+ description: Namespace of the asset
273
+ type: string
274
+ url?:
275
+ description: Url
276
+ type: string
277
+ attributes:
278
+ description: UseCase Template Mapping attributes
279
+ type: array
280
+ items:
281
+ type: UseCaseTemplateMappingAttributeRepresentation
282
+ collaborationEntity:
283
+ description: UseCase Template Collaboration Entity for Mapping
284
+ type: string
285
+ UseCaseTemplateMappingSubjectAttributeRepresentation:
286
+ description: Data Clean Room UseCase Template Mapping Subject Attribute Config
287
+ type: object
288
+ properties:
289
+ fieldLabel:
290
+ description: Label of mapping field
291
+ type: string
292
+ fieldName:
293
+ description: Name of mapping field
294
+ type: string
295
+ objectLabel:
296
+ description: Label of mapping object
297
+ type: string
298
+ objectName:
299
+ description: Name of mapping object
300
+ type: string
301
+ DataCleanRoomDataSpecificationInputRepresentation:
302
+ description: Represents Cdp Data clean room Specification input
303
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
304
+ # type: CdpObjectBaseInputRepresentation
305
+ type: object
306
+ properties:
307
+ dataMapping:
308
+ description: Data Mapping details for the data clean room member
309
+ type: any
310
+ memberType:
311
+ description: Type of the data clean room member
312
+ type: string
313
+ ownerOrgId:
314
+ description: Data cloud orgId where the mapping is created
315
+ type: string
316
+ templateName:
317
+ description: Name of the use case template for which mapping is provided
318
+ type: string
319
+ name:
320
+ description: name
321
+ type: string
322
+ required: false
323
+ label:
324
+ description: label
325
+ type: string
326
+ required: true
327
+ description?:
328
+ description: description
329
+ type: string
330
+ dataspaceName:
331
+ description: dataspaceName
332
+ type: string
333
+ required: false
334
+ DataCleanRoomDataSpecificationRepresentation:
335
+ description: Represents Cdp Data Clean Room Specification
336
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
337
+ # type: CdpAssetBaseRepresentation
338
+ properties:
339
+ createdBy?:
340
+ description: Created by
341
+ type: CdpUserRepresentation
342
+ createdDate?:
343
+ description: Created date
344
+ type: string
345
+ dataMapping:
346
+ description: Data Clean Room Data Mapping
347
+ type: UseCaseTemplateMappingRepresentation
348
+ id:
349
+ description: The 18 character ID of the asset
350
+ type: string
351
+ label?:
352
+ description: Label of the asset
353
+ type: string
354
+ lastModifiedBy?:
355
+ description: Last modified by
356
+ type: CdpUserRepresentation
357
+ lastModifiedDate?:
358
+ description: Last modified date
359
+ type: string
360
+ name?:
361
+ description: Name of the asset
362
+ type: string
363
+ namespace?:
364
+ description: Namespace of the asset
365
+ type: string
366
+ url?:
367
+ description: Url
368
+ type: string
369
+ dataSpaceName:
370
+ description: Data Clean Room Specification DataSpace
371
+ type: string
372
+ description?:
373
+ description: Data Clean Room Specification Description
374
+ type: string
375
+ memberType:
376
+ description: Data Clean Room Member Type
377
+ type: string
378
+ enum:
379
+ - Consumer
380
+ - Provider
381
+ ownerOrgId?:
382
+ description: Data Clean Room Specification Owner Org ID
383
+ type: string
384
+ status:
385
+ description: Data Clean Room Data Specification Status
386
+ type: string
387
+ enum:
388
+ - Active
389
+ - Inactive
390
+ templateVersion?:
391
+ description: Template Version Info for which data clean room is created
392
+ type: DataCleanRoomTemplateRepresentation
393
+ DataCleanRoomMemberRepresentation:
394
+ description: Represents Cdp Data Clean Room Members
395
+ type: object
396
+ properties:
397
+ invitationId:
398
+ description: Id of the invitation that enabled the member to be part of collaboration
399
+ type: string
400
+ invitationStatus:
401
+ description: Status of the invitation
402
+ type: string
403
+ enum:
404
+ - Accepted
405
+ - Pending
406
+ - Rejected
407
+ - Sent
408
+ - SentError
409
+ memberId:
410
+ description: Id of collaborating member
411
+ type: string
412
+ memberOrgId:
413
+ description: Id of the member org
414
+ type: string
415
+ memberStatus:
416
+ description: Status of the collaboration member
417
+ type: string
418
+ enum:
419
+ - Active
420
+ - Inactive
421
+ - Mapping_Incomplete
422
+ memberType:
423
+ description: Type of Member
424
+ type: string
425
+ enum:
426
+ - Consumer
427
+ - Provider
428
+ providerId:
429
+ description: Reference key to DataCleanRoomProvider record
430
+ type: string
431
+ specificationId?:
432
+ description: Reference key to DataCleanRoomDataSpecification
433
+ type: string
434
+ DataCleanRoomSpecificationCollectionRepresentation:
435
+ description: Represents Data Clean Room Specification Collection
436
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
437
+ # type: CdpPaginatedResponseBaseRepresentation
438
+ properties:
439
+ currentPageUrl:
440
+ description: Current page url
441
+ type: string
442
+ required: false
443
+ nextPageUrl:
444
+ description: Next page url if it exists
445
+ type: string | nil
446
+ required: false
447
+ totalSize:
448
+ description: Total size of collection
449
+ type: integer
450
+ required: false
451
+ cleanroomSpecifications:
452
+ description: List of data clean room specifications
453
+ type: array
454
+ items:
455
+ type: DataCleanRoomDataSpecificationRepresentation
456
+ limit:
457
+ description: Number of records present in this response
458
+ type: integer
459
+ offset:
460
+ description: Start offset of the next batch
461
+ type: integer
462
+ DataCleanRoomCollaborationInputRepresentation:
463
+ description: Represents Cdp Data clean room collaboration input
464
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
465
+ # type: CdpObjectBaseInputRepresentation
466
+ properties:
467
+ apiKey?:
468
+ description: Api key for collaboration
469
+ type: string
470
+ dataCloudOrgId:
471
+ description: Core org ID where Data cloud clean room is enabled
472
+ type: string
473
+ dataSpaceName?:
474
+ description: Name of data space where data clean is created
475
+ type: string
476
+ providerDevName:
477
+ description: Developer name of provider definition
478
+ type: string
479
+ specificationDevName:
480
+ description: Developer Name of DataCleanRoomSpecification
481
+ type: string
482
+ templateName:
483
+ description: Developer name of use case template that the collaboration will
484
+ support
485
+ type: string
486
+ label:
487
+ description: Label of the asset
488
+ type: string
489
+ description?:
490
+ description: Description of data clean room
491
+ type: string
492
+ DataCleanRoomCollaborationRepresentation:
493
+ description: Represents Cdp Data Clean Room Collaboration
494
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
495
+ # type: CdpAssetBaseRepresentation
496
+ properties:
497
+ createdBy?:
498
+ description: Created by
499
+ type: CdpUserRepresentation
500
+ createdDate?:
501
+ description: Created date
502
+ type: string
503
+ id:
504
+ description: The 18 character ID of the asset
505
+ type: string
506
+ label?:
507
+ description: Label of the asset
508
+ type: string
509
+ lastModifiedBy?:
510
+ description: Last modified by
511
+ type: CdpUserRepresentation
512
+ lastModifiedDate?:
513
+ description: Last modified date
514
+ type: string
515
+ name?:
516
+ description: Name of the asset
517
+ type: string
518
+ namespace?:
519
+ description: Namespace of the asset
520
+ type: string
521
+ url?:
522
+ description: Url
523
+ type: string
524
+ dataSpaceName?:
525
+ description: DataSpace dev name of data clean room
526
+ type: string
527
+ description?:
528
+ description: Description of data clean room
529
+ type: string
530
+ members:
531
+ description: List of all members
532
+ type: array
533
+ items:
534
+ type: DataCleanRoomMemberRepresentation
535
+ status:
536
+ description: Enum for status of data clean room
537
+ type: string
538
+ enum:
539
+ - Active
540
+ - Inactive
541
+ templateVersion:
542
+ description: Template Version Info for which data clean room is created
543
+ type: DataCleanRoomTemplateRepresentation
544
+ apiKey?:
545
+ description: Api key for collaboration
546
+ type: string
547
+ DataCleanRoomTemplateRepresentation:
548
+ description: Represents Cdp Data Clean Room Template
549
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
550
+ # type: CdpAssetBaseRepresentation
551
+ properties:
552
+ createdBy?:
553
+ description: Created by
554
+ type: CdpUserRepresentation
555
+ createdDate?:
556
+ description: Created date
557
+ type: string
558
+ id?:
559
+ description: The 18 character ID of the asset
560
+ type: string
561
+ label?:
562
+ description: Label of the asset
563
+ type: string
564
+ lastModifiedBy?:
565
+ description: Last modified by
566
+ type: CdpUserRepresentation
567
+ lastModifiedDate?:
568
+ description: Last modified date
569
+ type: string
570
+ name?:
571
+ description: Name of the asset
572
+ type: string
573
+ namespace?:
574
+ description: Namespace of the asset
575
+ type: string
576
+ url?:
577
+ description: Url
578
+ type: string
579
+ configuration:
580
+ description: Configuration for use case template
581
+ type: any
582
+ description:
583
+ description: Description of use case template
584
+ type: string
585
+ queryTemplate:
586
+ description: Defined Query template for use case template
587
+ type: any
588
+ DataCleanRoomCollaborationCollectionRepresentation:
589
+ description: Represents Data Clean Room Collaboration Collection
590
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
591
+ # type: CdpPaginatedResponseBaseRepresentation
592
+ properties:
593
+ currentPageUrl?:
594
+ description: Current page url
595
+ type: string
596
+ nextPageUrl?:
597
+ description: Next page url if it exists
598
+ type: string | nil
599
+ totalSize?:
600
+ description: Total size of collection
601
+ type: integer
602
+ collaborations:
603
+ description: List of Data Clean Rooms Collaborations
604
+ type: array
605
+ items:
606
+ type: DataCleanRoomCollaborationRepresentation
607
+ limit:
608
+ description: Number of records present in this response
609
+ type: integer
610
+ offset:
611
+ description: Number of records to skip for the next request
612
+ type: integer
613
+ DataCleanRoomTemplateCollectionRepresentation:
614
+ description: Represents Cdp Data Clean Room Template Collection
615
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
616
+ # type: CdpPaginatedResponseBaseRepresentation
617
+ properties:
618
+ currentPageUrl:
619
+ description: Current page url
620
+ type: string
621
+ required: false
622
+ nextPageUrl:
623
+ description: Next page url if it exists
624
+ type: string | nil
625
+ required: false
626
+ totalSize:
627
+ description: Total size of collection
628
+ type: integer
629
+ required: false
630
+ limit:
631
+ description: Number of records present in this response
632
+ type: integer
633
+ offset:
634
+ description: Number of records to skip for the next request
635
+ type: integer
636
+ templates:
637
+ description: List of Templates
638
+ type: array
639
+ items:
640
+ type: DataCleanRoomTemplateRepresentation
641
+
642
+ DataCleanRoomAcceptInvitationInputRepresentation:
643
+ description: Represents Cdp Data clean room Accept invitation input
644
+ type: object
645
+ properties:
646
+ invitationId:
647
+ description: Record Id of DataCleanRoomInvitation
648
+ type: string
649
+ specificationId:
650
+ description: Record Id of DataCleanRoomSpecification
651
+ type: string
652
+
653
+ DataCleanRoomRejectInvitationInputRepresentation:
654
+ description: Represents Cdp Data clean room Reject invitation input
655
+ type: object
656
+ properties:
657
+ invitationId:
658
+ description: Record Id of DataCleanRoomInvitation
659
+ type: string
660
+
661
+ UseCaseTemplateMappingAttributeFilterOptionRepresentation:
662
+ description: Data Clean Room UseCase Template Mapping Attribute Filter Config
663
+ type: object
664
+ properties:
665
+ operator:
666
+ description: Attribute Filter Operator
667
+ type: string
668
+ values:
669
+ description: Attribute Filter Values
670
+ type: array
671
+ items:
672
+ type: string
673
+
674
+ DataCleanRoomQueryJobInputRepresentation:
675
+ description: Represents Cdp Data clean room Query Job input
676
+ type: object
677
+ properties:
678
+ queryExecutionName:
679
+ description: Name of the Query that would be executed
680
+ type: string
681
+ segmentIds:
682
+ description: Segment IDs on which the query would be executed
683
+ type: array
684
+ items:
685
+ type: string
686
+
687
+ DataCleanRoomQueryJobRepresentation:
688
+ description: Represents Cdp Data Clean Room Query Job
689
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
690
+ # type: CdpAssetBaseRepresentation
691
+ properties:
692
+ createdBy?:
693
+ description: Created by
694
+ type: CdpUserRepresentation
695
+ createdDate?:
696
+ description: Created date
697
+ type: string
698
+ id:
699
+ description: The 18 character ID of the asset
700
+ type: string
701
+ label?:
702
+ description: Label of the asset
703
+ type: string
704
+ lastModifiedBy?:
705
+ description: Last modified by
706
+ type: CdpUserRepresentation
707
+ lastModifiedDate?:
708
+ description: Last modified date
709
+ type: string
710
+ name?:
711
+ description: Name of the asset
712
+ type: string
713
+ completedDate?:
714
+ description: Date time at which query run was completed
715
+ type: string
716
+ errorCode?:
717
+ description: Error code due to query failure, if any
718
+ type: string
719
+ errorMessage?:
720
+ description: Error message specifying the query failure reason, if any
721
+ type: string
722
+ result?:
723
+ description: Number of records obtained as part of query run
724
+ type: integer
725
+ status:
726
+ description: Query Status of Query Job
727
+ type: string
728
+ enum:
729
+ - Completed
730
+ - Created
731
+ - Failed
732
+ - Running
733
+ triggeredDate?:
734
+ description: Date time at which query was triggered
735
+ type: string
736
+ segmentNames?:
737
+ description: List of segment names
738
+ type: array
739
+ items:
740
+ type: string
741
+
742
+ DataCleanRoomQueryJobHistoryCollectionRepresentation:
743
+ description: Represents Data Clean Room Job History Collection
744
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
745
+ # type: CdpPaginatedResponseBaseRepresentation
746
+ properties:
747
+ currentPageUrl?:
748
+ description: Current page url
749
+ type: string
750
+ nextPageUrl?:
751
+ description: Next page url if it exists
752
+ type: string | nil
753
+ totalSize?:
754
+ description: Total size of collection
755
+ type: integer
756
+ limit:
757
+ description: Number of records present in this response
758
+ type: integer
759
+ offset:
760
+ description: Start offset of the next batch
761
+ type: integer
762
+ queryJobs:
763
+ description: List of query jobs
764
+ type: array
765
+ items:
766
+ type: DataCleanRoomQueryJobRepresentation
767
+
768
+ /ssot:
769
+ /data-clean-room:
770
+ /providers:
771
+ get:
772
+ displayName: getCdpDataCleanRoomProviderCollection
773
+ description: Gets the paginated list of all providers
774
+ responses:
775
+ '200':
776
+ description: Success
777
+ body:
778
+ application/json:
779
+ type: DataCleanRoomProviderCollectionRepresentation
780
+ queryParameters:
781
+ filters:
782
+ type: string
783
+ required: false
784
+ limit:
785
+ type: integer
786
+ required: false
787
+ offset:
788
+ type: integer
789
+ required: false
790
+ orderBy:
791
+ type: string
792
+ required: false
793
+ post:
794
+ displayName: postCdpDataCleanRoomProviderCollection
795
+ description: Creates a new Data Clean Room Provider
796
+ responses:
797
+ '200':
798
+ description: Success
799
+ body:
800
+ application/json:
801
+ type: DataCleanRoomProviderRepresentation
802
+ body:
803
+ application/json:
804
+ type: DataCleanRoomProviderInputRepresentation
805
+ (oas-body-name): input
806
+ /specifications:
807
+ get:
808
+ displayName: getCdpDataCleanRoomDataSpecificationCollection
809
+ description: Gets the paginated list of all Data Clean Room Specifications
810
+ responses:
811
+ '200':
812
+ description: Success
813
+ body:
814
+ application/json:
815
+ type: DataCleanRoomSpecificationCollectionRepresentation
816
+ queryParameters:
817
+ filters:
818
+ type: string
819
+ required: false
820
+ limit:
821
+ type: integer
822
+ required: false
823
+ offset:
824
+ type: integer
825
+ required: false
826
+ orderBy:
827
+ type: string
828
+ required: false
829
+ post:
830
+ displayName: postCdpDataCleanRoomDataSpecificationCollection
831
+ description: Creates a new Data Clean Room Specification.
832
+ responses:
833
+ '200':
834
+ description: Success
835
+ body:
836
+ application/json:
837
+ type: DataCleanRoomDataSpecificationRepresentation
838
+ body:
839
+ application/json:
840
+ type: DataCleanRoomDataSpecificationInputRepresentation
841
+ (oas-body-name): input
842
+ /collaborations:
843
+ get:
844
+ displayName: getCdpDataCleanRoomCollaborationCollection
845
+ description: Gets a list of data clean rooms
846
+ responses:
847
+ '200':
848
+ description: Success
849
+ body:
850
+ application/json:
851
+ type: DataCleanRoomCollaborationCollectionRepresentation
852
+ queryParameters:
853
+ filters:
854
+ type: string
855
+ required: false
856
+ limit:
857
+ type: integer
858
+ required: false
859
+ offset:
860
+ type: integer
861
+ required: false
862
+ orderBy:
863
+ type: string
864
+ required: false
865
+ post:
866
+ displayName: postCdpDataCleanRoomCollaborationCollection
867
+ description: Creates a new data clean room collaboration
868
+ responses:
869
+ '200':
870
+ description: Success
871
+ body:
872
+ application/json:
873
+ type: DataCleanRoomCollaborationRepresentation
874
+ body:
875
+ application/json:
876
+ type: DataCleanRoomCollaborationInputRepresentation
877
+ (oas-body-name): input
878
+ /templates:
879
+ get:
880
+ displayName: getCdpDataCleanRoomTemplateCollection
881
+ description: Gets the paginated list of all template
882
+ responses:
883
+ '200':
884
+ description: Success
885
+ body:
886
+ application/json:
887
+ type: DataCleanRoomTemplateCollectionRepresentation
888
+ queryParameters:
889
+ limit:
890
+ type: integer
891
+ required: false
892
+ offset:
893
+ type: integer
894
+ required: false
895
+ orderBy:
896
+ type: string
897
+ required: false
898
+ /collaborations/{collaborationIdOrApiName}/actions:
899
+ /accept-invitation:
900
+ put:
901
+ displayName: putCdpDataCleanRoomCollaboration
902
+ description: Handles invitation acceptance for a given Data Clean Room
903
+ responses:
904
+ '200':
905
+ description: Success
906
+ body:
907
+ application/json:
908
+ type: DataCleanRoomMemberRepresentation
909
+ body:
910
+ application/json:
911
+ type: DataCleanRoomAcceptInvitationInputRepresentation
912
+ (oas-body-name): input
913
+ uriParameters:
914
+ collaborationIdOrApiName:
915
+ type: string
916
+ /reject-invitation:
917
+ put:
918
+ displayName: putCdpDataCleanRoomRejectInvitation
919
+ description: Handles invitation rejection for a given Data Clean Room
920
+ responses:
921
+ '200':
922
+ description: Success
923
+ body:
924
+ application/json:
925
+ type: DataCleanRoomMemberRepresentation
926
+ body:
927
+ application/json:
928
+ type: DataCleanRoomRejectInvitationInputRepresentation
929
+ (oas-body-name): input
930
+ uriParameters:
931
+ collaborationIdOrApiName:
932
+ type: string
933
+
934
+ /collaborations/{collaborationIdOrApiName}/actions/run:
935
+ post:
936
+ displayName: postCdpDataCleanRoomQueryJob
937
+ description: Triggers the Data clean room query job
938
+ responses:
939
+ '200':
940
+ description: Success
941
+ body:
942
+ application/json:
943
+ type: DataCleanRoomQueryJobRepresentation
944
+ body:
945
+ application/json:
946
+ type: DataCleanRoomQueryJobInputRepresentation
947
+ (oas-body-name): input
948
+ uriParameters:
949
+ collaborationIdOrApiName:
950
+ type: string
951
+ required: true
952
+
953
+ /collaborations/{collaborationIdOrApiName}/jobs:
954
+ get:
955
+ displayName: getCdpDataCleanRoomQueryJobCollection
956
+ description: Gets a list of query job history for a given data clean room
957
+ responses:
958
+ '200':
959
+ description: Success
960
+ body:
961
+ application/json:
962
+ type: DataCleanRoomQueryJobHistoryCollectionRepresentation
963
+ queryParameters:
964
+ limit:
965
+ type: integer
966
+ required: false
967
+ filters:
968
+ type: string
969
+ required: false
970
+ offset:
971
+ type: integer
972
+ required: false
973
+ orderBy:
974
+ type: string
975
+ required: false
976
+ uriParameters:
977
+ collaborationIdOrApiName:
978
+ type: string
979
+ required: true