@salesforce/lds-adapters-cdp-data-clean-room 1.332.0-dev22 → 1.332.0-dev24

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 (26) hide show
  1. package/dist/es/es2018/cdp-data-clean-room.js +1406 -107
  2. package/dist/es/es2018/types/src/generated/adapters/createDataCleanRoomCollaboration.d.ts +21 -0
  3. package/dist/es/es2018/types/src/generated/adapters/createDataCleanRoomSpecification.d.ts +22 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getDataCleanRoomProvidersPaginated.d.ts +1 -1
  5. package/dist/es/es2018/types/src/generated/adapters/getDataCleanRoomSpecificationsPaginated.d.ts +30 -0
  6. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +3 -0
  7. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +5 -1
  8. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomProviders.d.ts +1 -1
  9. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomSpecifications.d.ts +18 -0
  10. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomCollaborations.d.ts +18 -0
  11. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomSpecifications.d.ts +19 -0
  12. package/dist/es/es2018/types/src/generated/types/DataCleanRoomCollaborationInputRepresentation.d.ts +46 -0
  13. package/dist/es/es2018/types/src/generated/types/DataCleanRoomCollaborationRepresentation.d.ts +78 -0
  14. package/dist/es/es2018/types/src/generated/types/DataCleanRoomDataSpecificationInputRepresentation.d.ts +49 -0
  15. package/dist/es/es2018/types/src/generated/types/DataCleanRoomDataSpecificationRepresentation.d.ts +84 -0
  16. package/dist/es/es2018/types/src/generated/types/DataCleanRoomMemberRepresentation.d.ts +49 -0
  17. package/dist/es/es2018/types/src/generated/types/DataCleanRoomSpecificationCollectionRepresentation.d.ts +53 -0
  18. package/dist/es/es2018/types/src/generated/types/DataCleanRoomTemplateRepresentation.d.ts +62 -0
  19. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingAttributeRepresentation.d.ts +69 -0
  20. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingPathAttributeRepresentation.d.ts +31 -0
  21. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingRepresentation.d.ts +60 -0
  22. package/dist/es/es2018/types/src/generated/types/UseCaseTemplateMappingSubjectAttributeRepresentation.d.ts +37 -0
  23. package/package.json +3 -3
  24. package/sfdc/index.js +1515 -199
  25. package/src/raml/api.raml +488 -36
  26. package/src/raml/luvio.raml +27 -7
package/src/raml/api.raml CHANGED
@@ -165,40 +165,492 @@ types:
165
165
  type: array
166
166
  items:
167
167
  type: string
168
+ UseCaseTemplateMappingAttributeRepresentation:
169
+ description: Represents Cdp Data Clean Room Mapping details
170
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
171
+ # type: CdpAssetBaseRepresentation
172
+ properties:
173
+ createdBy?:
174
+ description: Created by
175
+ type: CdpUserRepresentation
176
+ createdDate?:
177
+ description: Created date
178
+ type: string
179
+ dataMapping?:
180
+ description: Data Clean Room Data Mapping
181
+ type: UseCaseTemplateMappingRepresentation
182
+ id?:
183
+ description: The 18 character ID of the asset
184
+ type: string
185
+ label?:
186
+ description: Label of the asset
187
+ type: string
188
+ lastModifiedBy?:
189
+ description: Last modified by
190
+ type: CdpUserRepresentation
191
+ lastModifiedDate?:
192
+ description: Last modified date
193
+ type: string
194
+ name?:
195
+ description: Name of the asset
196
+ type: string
197
+ namespace?:
198
+ description: Namespace of the asset
199
+ type: string
200
+ url?:
201
+ description: Url
202
+ type: string
203
+ alias:
204
+ description: Attribute Alias
205
+ type: string
206
+ attributeId:
207
+ description: Attribute Id
208
+ type: string
209
+ required: false
210
+ path:
211
+ description: Attribute Path
212
+ type: array
213
+ items:
214
+ type: UseCaseTemplateMappingPathAttributeRepresentation
215
+ subjectAttribute:
216
+ description: Subject Attribute
217
+ type: UseCaseTemplateMappingSubjectAttributeRepresentation
218
+ UseCaseTemplateMappingPathAttributeRepresentation:
219
+ description: Data Clean Room UseCase Template Mapping Path Attribute Config
220
+ type: object
221
+ properties:
222
+ sourceAttribute:
223
+ description: Source attribute details in path component
224
+ type: any
225
+ targetAttribute:
226
+ description: Target attribute details in path component
227
+ type: any
228
+ UseCaseTemplateMappingRepresentation:
229
+ description: Represents Cdp Data Clean Room Mapping details
230
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
231
+ # type: CdpAssetBaseRepresentation
232
+ properties:
233
+ createdBy?:
234
+ description: Created by
235
+ type: CdpUserRepresentation
236
+ createdDate?:
237
+ description: Created date
238
+ type: string
239
+ id?:
240
+ description: The 18 character ID of the asset
241
+ type: string
242
+ label?:
243
+ description: Label of the asset
244
+ type: string
245
+ lastModifiedBy?:
246
+ description: Last modified by
247
+ type: CdpUserRepresentation
248
+ lastModifiedDate?:
249
+ description: Last modified date
250
+ type: string
251
+ name?:
252
+ description: Name of the asset
253
+ type: string
254
+ namespace?:
255
+ description: Namespace of the asset
256
+ type: string
257
+ url?:
258
+ description: Url
259
+ type: string
260
+ attributes:
261
+ description: UseCase Template Mapping attributes
262
+ type: array
263
+ items:
264
+ type: UseCaseTemplateMappingAttributeRepresentation
265
+ collaborationEntity:
266
+ description: UseCase Template Collaboration Entity for Mapping
267
+ type: string
268
+ UseCaseTemplateMappingSubjectAttributeRepresentation:
269
+ description: Data Clean Room UseCase Template Mapping Subject Attribute Config
270
+ type: object
271
+ properties:
272
+ fieldLabel:
273
+ description: Label of mapping field
274
+ type: string
275
+ fieldName:
276
+ description: Name of mapping field
277
+ type: string
278
+ objectLabel:
279
+ description: Label of mapping object
280
+ type: string
281
+ objectName:
282
+ description: Name of mapping object
283
+ type: string
284
+ DataCleanRoomDataSpecificationInputRepresentation:
285
+ description: Represents Cdp Data clean room Specification input
286
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
287
+ # type: CdpObjectBaseInputRepresentation
288
+ type: object
289
+ properties:
290
+ dataMapping:
291
+ description: Data Mapping details for the data clean room member
292
+ type: array
293
+ items:
294
+ type: any
295
+ memberType:
296
+ description: Type of the data clean room member
297
+ type: string
298
+ ownerOrgId:
299
+ description: Data cloud orgId where the mapping is created
300
+ type: string
301
+ templateName:
302
+ description: Name of the use case template for which mapping is provided
303
+ type: string
304
+ name:
305
+ description: name
306
+ type: string
307
+ required: false
308
+ label:
309
+ description: label
310
+ type: string
311
+ required: true
312
+ description:
313
+ description: description
314
+ type: string
315
+ required: true
316
+ dataspaceName:
317
+ description: dataspaceName
318
+ type: string
319
+ required: false
320
+ DataCleanRoomDataSpecificationRepresentation:
321
+ description: Represents Cdp Data Clean Room Specification
322
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
323
+ # type: CdpAssetBaseRepresentation
324
+ properties:
325
+ createdBy?:
326
+ description: Created by
327
+ type: CdpUserRepresentation
328
+ createdDate?:
329
+ description: Created date
330
+ type: string
331
+ dataMapping:
332
+ description: Data Clean Room Data Mapping
333
+ type: UseCaseTemplateMappingRepresentation
334
+ id:
335
+ description: The 18 character ID of the asset
336
+ type: string
337
+ label?:
338
+ description: Label of the asset
339
+ type: string
340
+ lastModifiedBy?:
341
+ description: Last modified by
342
+ type: CdpUserRepresentation
343
+ lastModifiedDate?:
344
+ description: Last modified date
345
+ type: string
346
+ name?:
347
+ description: Name of the asset
348
+ type: string
349
+ namespace?:
350
+ description: Namespace of the asset
351
+ type: string
352
+ url?:
353
+ description: Url
354
+ type: string
355
+ dataSpaceName:
356
+ description: Data Clean Room Specification DataSpace
357
+ type: string
358
+ description:
359
+ description: Data Clean Room Specification Description
360
+ type: string
361
+ memberType:
362
+ description: Data Clean Room Member Type
363
+ type: string
364
+ enum:
365
+ - Consumer
366
+ - Provider
367
+ ownerOrgId?:
368
+ description: Data Clean Room Specification Owner Org ID
369
+ type: string
370
+ status:
371
+ description: Data Clean Room Data Specification Status
372
+ type: string
373
+ enum:
374
+ - Active
375
+ - Inactive
376
+ templateName:
377
+ description: Data Clean Room UseCase Template name
378
+ type: string
379
+ DataCleanRoomMemberRepresentation:
380
+ description: Represents Cdp Data Clean Room Members
381
+ type: object
382
+ properties:
383
+ invitationId:
384
+ description: Id of the invitation that enabled the member to be part of collaboration
385
+ type: string
386
+ invitationStatus:
387
+ description: Status of the invitation
388
+ type: string
389
+ enum:
390
+ - Accepted
391
+ - Pending
392
+ - Rejected
393
+ - Sent
394
+ - SentError
395
+ memberId:
396
+ description: Id of collaborating member
397
+ type: string
398
+ memberOrgId:
399
+ description: Id of the member org
400
+ type: string
401
+ memberStatus:
402
+ description: Status of the collaboration member
403
+ type: string
404
+ enum:
405
+ - Active
406
+ - Inactive
407
+ - Mapping_Incomplete
408
+ memberType:
409
+ description: Type of Member
410
+ type: string
411
+ enum:
412
+ - Consumer
413
+ - Provider
414
+ providerId:
415
+ description: Reference key to DataCleanRoomProvider record
416
+ type: string
417
+ specificationId?:
418
+ description: Reference key to DataCleanRoomDataSpecification
419
+ type: string
420
+ DataCleanRoomSpecificationCollectionRepresentation:
421
+ description: Represents Data Clean Room Specification Collection
422
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
423
+ # type: CdpPaginatedResponseBaseRepresentation
424
+ properties:
425
+ currentPageUrl:
426
+ description: Current page url
427
+ type: string
428
+ required: false
429
+ nextPageUrl:
430
+ description: Next page url if it exists
431
+ type: string | nil
432
+ required: false
433
+ totalSize:
434
+ description: Total size of collection
435
+ type: integer
436
+ required: false
437
+ cleanroomSpecifications:
438
+ description: List of data clean room specifications
439
+ type: array
440
+ items:
441
+ type: DataCleanRoomDataSpecificationRepresentation
442
+ limit:
443
+ description: Number of records present in this response
444
+ type: integer
445
+ offset:
446
+ description: Start offset of the next batch
447
+ type: integer
448
+ DataCleanRoomCollaborationInputRepresentation:
449
+ description: Represents Cdp Data clean room collaboration input
450
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
451
+ # type: CdpObjectBaseInputRepresentation
452
+ properties:
453
+ apiKey?:
454
+ description: Unique Identifier for collaboration provider
455
+ type: string
456
+ dataCloudOrgId:
457
+ description: Core org ID where Data cloud clean room is enabled
458
+ type: string
459
+ dataSpaceName?:
460
+ description: Name of data space where data clean is created
461
+ type: string
462
+ providerDevName:
463
+ description: Developer name of provider definition
464
+ type: string
465
+ specificationDevName:
466
+ description: Developer Name of DataCleanRoomSpecification
467
+ type: string
468
+ templateName:
469
+ description: Developer name of use case template that the collaboration will
470
+ support
471
+ type: string
472
+ label:
473
+ description: Label of the asset
474
+ type: string
475
+ DataCleanRoomCollaborationRepresentation:
476
+ description: Represents Cdp Data Clean Room Collaboration
477
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
478
+ # type: CdpAssetBaseRepresentation
479
+ properties:
480
+ createdBy?:
481
+ description: Created by
482
+ type: CdpUserRepresentation
483
+ createdDate?:
484
+ description: Created date
485
+ type: string
486
+ id:
487
+ description: The 18 character ID of the asset
488
+ type: string
489
+ label?:
490
+ description: Label of the asset
491
+ type: string
492
+ lastModifiedBy?:
493
+ description: Last modified by
494
+ type: CdpUserRepresentation
495
+ lastModifiedDate?:
496
+ description: Last modified date
497
+ type: string
498
+ name?:
499
+ description: Name of the asset
500
+ type: string
501
+ namespace?:
502
+ description: Namespace of the asset
503
+ type: string
504
+ url?:
505
+ description: Url
506
+ type: string
507
+ dataSpaceName?:
508
+ description: DataSpace dev name of data clean room
509
+ type: string
510
+ description?:
511
+ description: Description of data clean room
512
+ type: string
513
+ members:
514
+ description: List of all members
515
+ type: array
516
+ items:
517
+ type: DataCleanRoomMemberRepresentation
518
+ status:
519
+ description: Enum for status of data clean room
520
+ type: string
521
+ enum:
522
+ - Active
523
+ - Inactive
524
+ templateVersion:
525
+ description: Template Version Info for which data clean room is created
526
+ type: DataCleanRoomTemplateRepresentation
527
+ DataCleanRoomTemplateRepresentation:
528
+ description: Represents Cdp Data Clean Room Template
529
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
530
+ # type: CdpAssetBaseRepresentation
531
+ properties:
532
+ createdBy?:
533
+ description: Created by
534
+ type: CdpUserRepresentation
535
+ createdDate?:
536
+ description: Created date
537
+ type: string
538
+ id:
539
+ description: The 18 character ID of the asset
540
+ type: string
541
+ label?:
542
+ description: Label of the asset
543
+ type: string
544
+ lastModifiedBy?:
545
+ description: Last modified by
546
+ type: CdpUserRepresentation
547
+ lastModifiedDate?:
548
+ description: Last modified date
549
+ type: string
550
+ name?:
551
+ description: Name of the asset
552
+ type: string
553
+ namespace?:
554
+ description: Namespace of the asset
555
+ type: string
556
+ url?:
557
+ description: Url
558
+ type: string
559
+ configuration:
560
+ description: Configuration for use case template
561
+ type: any
562
+ description:
563
+ description: Description of use case template
564
+ type: string
565
+ queryTemplate:
566
+ description: Defined Query template for use case template
567
+ type: any
568
+
168
569
  /ssot:
169
- /data-clean-room/providers:
170
- get:
171
- displayName: getCdpDataCleanRoomProviderCollection
172
- description: Gets the paginated list of all providers
173
- responses:
174
- '200':
175
- description: Success
176
- body:
177
- application/json:
178
- type: DataCleanRoomProviderCollectionRepresentation
179
- queryParameters:
180
- batchSize:
181
- type: integer
182
- required: false
183
- filters:
184
- type: string
185
- required: false
186
- offset:
187
- type: integer
188
- required: false
189
- orderBy:
190
- type: string
191
- required: false
192
- post:
193
- displayName: postCdpDataCleanRoomProviderCollection
194
- description: Creates a new Data Clean Room Provider
195
- responses:
196
- '200':
197
- description: Success
198
- body:
199
- application/json:
200
- type: DataCleanRoomProviderRepresentation
201
- body:
202
- application/json:
203
- type: DataCleanRoomProviderInputRepresentation
204
- (oas-body-name): input
570
+ /data-clean-room:
571
+ /providers:
572
+ get:
573
+ displayName: getCdpDataCleanRoomProviderCollection
574
+ description: Gets the paginated list of all providers
575
+ responses:
576
+ '200':
577
+ description: Success
578
+ body:
579
+ application/json:
580
+ type: DataCleanRoomProviderCollectionRepresentation
581
+ queryParameters:
582
+ filters:
583
+ type: string
584
+ required: false
585
+ limit:
586
+ type: integer
587
+ required: false
588
+ offset:
589
+ type: integer
590
+ required: false
591
+ orderBy:
592
+ type: string
593
+ required: false
594
+ post:
595
+ displayName: postCdpDataCleanRoomProviderCollection
596
+ description: Creates a new Data Clean Room Provider
597
+ responses:
598
+ '200':
599
+ description: Success
600
+ body:
601
+ application/json:
602
+ type: DataCleanRoomProviderRepresentation
603
+ body:
604
+ application/json:
605
+ type: DataCleanRoomProviderInputRepresentation
606
+ (oas-body-name): input
607
+ /specifications:
608
+ get:
609
+ displayName: getCdpDataCleanRoomDataSpecificationCollection
610
+ description: Gets the paginated list of all Data Clean Room Specifications
611
+ responses:
612
+ '200':
613
+ description: Success
614
+ body:
615
+ application/json:
616
+ type: DataCleanRoomSpecificationCollectionRepresentation
617
+ queryParameters:
618
+ filters:
619
+ type: string
620
+ required: false
621
+ limit:
622
+ type: integer
623
+ required: false
624
+ offset:
625
+ type: integer
626
+ required: false
627
+ orderBy:
628
+ type: string
629
+ required: false
630
+ post:
631
+ displayName: postCdpDataCleanRoomDataSpecificationCollection
632
+ description: Creates a new Data Clean Room Specification.
633
+ responses:
634
+ '200':
635
+ description: Success
636
+ body:
637
+ application/json:
638
+ type: DataCleanRoomDataSpecificationRepresentation
639
+ body:
640
+ application/json:
641
+ type: DataCleanRoomDataSpecificationInputRepresentation
642
+ (oas-body-name): input
643
+ /collaborations:
644
+ post:
645
+ displayName: postCdpDataCleanRoomCollaborationCollection
646
+ description: Creates a new data clean room collaboration
647
+ responses:
648
+ '200':
649
+ description: Success
650
+ body:
651
+ application/json:
652
+ type: DataCleanRoomCollaborationRepresentation
653
+ body:
654
+ application/json:
655
+ type: DataCleanRoomCollaborationInputRepresentation
656
+ (oas-body-name): input
@@ -12,12 +12,32 @@ types:
12
12
  (luvio.key):
13
13
  id: id
14
14
  (luvio.opaque): true
15
+ DataCleanRoomDataSpecificationRepresentation:
16
+ (luvio.key):
17
+ id: id
18
+ (luvio.opaque): true
19
+ DataCleanRoomCollaborationRepresentation:
20
+ (luvio.key):
21
+ id: id
22
+ (luvio.opaque): true
15
23
 
16
24
  /ssot:
17
- /data-clean-room/providers:
18
- post:
19
- (luvio.adapter):
20
- name: createProvider
21
- get:
22
- (luvio.adapter):
23
- name: getDataCleanRoomProvidersPaginated
25
+ /data-clean-room:
26
+ /providers:
27
+ post:
28
+ (luvio.adapter):
29
+ name: createProvider
30
+ get:
31
+ (luvio.adapter):
32
+ name: getDataCleanRoomProvidersPaginated
33
+ /specifications:
34
+ get:
35
+ (luvio.adapter):
36
+ name: getDataCleanRoomSpecificationsPaginated
37
+ post:
38
+ (luvio.adapter):
39
+ name: createDataCleanRoomSpecification
40
+ /collaborations:
41
+ post:
42
+ (luvio.adapter):
43
+ name: createDataCleanRoomCollaboration