@salesforce/lds-adapters-cdp-data-clean-room 1.354.0-dev7 → 1.354.0-dev8

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 (18) hide show
  1. package/dist/es/es2018/cdp-data-clean-room.js +964 -457
  2. package/dist/es/es2018/types/src/generated/adapters/createDataCleanRoomSpecification.d.ts +1 -1
  3. package/dist/es/es2018/types/src/generated/adapters/executeDataCleanRoomQuery.d.ts +17 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getAllDataCleanRoomQueryPaginated.d.ts +27 -0
  5. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +2 -0
  6. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +4 -1
  7. package/dist/es/es2018/types/src/generated/resources/getSsotDataCleanRoomJobsByCollaborationIdOrApiName.d.ts +15 -0
  8. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomActionsRunByCollaborationIdOrApiName.d.ts +16 -0
  9. package/dist/es/es2018/types/src/generated/resources/postSsotDataCleanRoomSpecifications.d.ts +1 -1
  10. package/dist/es/es2018/types/src/generated/types/DataCleanRoomDataSpecificationInputRepresentation.d.ts +3 -3
  11. package/dist/es/es2018/types/src/generated/types/DataCleanRoomDataSpecificationRepresentation.d.ts +3 -3
  12. package/dist/es/es2018/types/src/generated/types/DataCleanRoomQueryJobHistoryCollectionRepresentation.d.ts +44 -0
  13. package/dist/es/es2018/types/src/generated/types/DataCleanRoomQueryJobInputRepresentation.d.ts +31 -0
  14. package/dist/es/es2018/types/src/generated/types/DataCleanRoomQueryJobRepresentation.d.ts +77 -0
  15. package/package.json +3 -3
  16. package/sfdc/index.js +847 -326
  17. package/src/raml/api.raml +129 -3
  18. package/src/raml/luvio.raml +14 -0
package/src/raml/api.raml CHANGED
@@ -310,10 +310,9 @@ types:
310
310
  description: label
311
311
  type: string
312
312
  required: true
313
- description:
313
+ description?:
314
314
  description: description
315
315
  type: string
316
- required: true
317
316
  dataspaceName:
318
317
  description: dataspaceName
319
318
  type: string
@@ -356,7 +355,7 @@ types:
356
355
  dataSpaceName:
357
356
  description: Data Clean Room Specification DataSpace
358
357
  type: string
359
- description:
358
+ description?:
360
359
  description: Data Clean Room Specification Description
361
360
  type: string
362
361
  memberType:
@@ -658,6 +657,100 @@ types:
658
657
  items:
659
658
  type: string
660
659
 
660
+ DataCleanRoomQueryJobInputRepresentation:
661
+ description: Represents Cdp Data clean room Query Job input
662
+ type: object
663
+ properties:
664
+ queryExecutionName:
665
+ description: Name of the Query that would be executed
666
+ type: string
667
+ segmentIds:
668
+ description: Segment IDs on which the query would be executed
669
+ type: array
670
+ items:
671
+ type: string
672
+
673
+ DataCleanRoomQueryJobRepresentation:
674
+ description: Represents Cdp Data Clean Room Query Job
675
+ # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
676
+ # type: CdpAssetBaseRepresentation
677
+ properties:
678
+ createdBy?:
679
+ description: Created by
680
+ type: CdpUserRepresentation
681
+ createdDate?:
682
+ description: Created date
683
+ type: string
684
+ id:
685
+ description: The 18 character ID of the asset
686
+ type: string
687
+ label?:
688
+ description: Label of the asset
689
+ type: string
690
+ lastModifiedBy?:
691
+ description: Last modified by
692
+ type: CdpUserRepresentation
693
+ lastModifiedDate?:
694
+ description: Last modified date
695
+ type: string
696
+ name?:
697
+ description: Name of the asset
698
+ type: string
699
+ completedDate?:
700
+ description: Date time at which query run was completed
701
+ type: string
702
+ errorCode?:
703
+ description: Error code due to query failure, if any
704
+ type: string
705
+ errorMessage?:
706
+ description: Error message specifying the query failure reason, if any
707
+ type: string
708
+ result?:
709
+ description: Number of records obtained as part of query run
710
+ type: integer
711
+ status:
712
+ description: Query Status of Query Job
713
+ type: string
714
+ enum:
715
+ - Completed
716
+ - Created
717
+ - Failed
718
+ - Running
719
+ triggeredDate?:
720
+ description: Date time at which query was triggered
721
+ type: string
722
+ segmentNames?:
723
+ description: List of segment names
724
+ type: array
725
+ items:
726
+ type: string
727
+
728
+ DataCleanRoomQueryJobHistoryCollectionRepresentation:
729
+ description: Represents Data Clean Room Job History Collection
730
+ # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
731
+ # type: CdpPaginatedResponseBaseRepresentation
732
+ properties:
733
+ currentPageUrl?:
734
+ description: Current page url
735
+ type: string
736
+ nextPageUrl?:
737
+ description: Next page url if it exists
738
+ type: string | nil
739
+ totalSize?:
740
+ description: Total size of collection
741
+ type: integer
742
+ limit:
743
+ description: Number of records present in this response
744
+ type: integer
745
+ offset:
746
+ description: Start offset of the next batch
747
+ type: integer
748
+ queryJobs:
749
+ description: List of query jobs
750
+ type: array
751
+ items:
752
+ type: DataCleanRoomQueryJobRepresentation
753
+
661
754
  /ssot:
662
755
  /data-clean-room:
663
756
  /providers:
@@ -823,3 +916,36 @@ types:
823
916
  uriParameters:
824
917
  collaborationIdOrApiName:
825
918
  type: string
919
+ /{collaborationIdOrApiName}/actions/run:
920
+ post:
921
+ displayName: postCdpDataCleanRoomQueryJob
922
+ description: Triggers the Data clean room query job
923
+ responses:
924
+ '200':
925
+ description: Success
926
+ body:
927
+ application/json:
928
+ type: DataCleanRoomQueryJobRepresentation
929
+ body:
930
+ application/json:
931
+ type: DataCleanRoomQueryJobInputRepresentation
932
+ (oas-body-name): input
933
+ uriParameters:
934
+ collaborationIdOrApiName:
935
+ type: string
936
+ required: true
937
+
938
+ /{collaborationIdOrApiName}/jobs:
939
+ get:
940
+ displayName: getCdpDataCleanRoomQueryJobCollection
941
+ description: Gets a list of query job history for a given data clean room
942
+ responses:
943
+ '200':
944
+ description: Success
945
+ body:
946
+ application/json:
947
+ type: DataCleanRoomQueryJobHistoryCollectionRepresentation
948
+ uriParameters:
949
+ collaborationIdOrApiName:
950
+ type: string
951
+ required: true
@@ -28,6 +28,12 @@ types:
28
28
  (luvio.opaque): true
29
29
  (luvio.key):
30
30
  invitationId: invitationId
31
+ DataCleanRoomQueryJobRepresentation:
32
+ (luvio.key):
33
+ id: id
34
+ (luvio.opaque): true
35
+ DataCleanRoomQueryJobHistoryCollectionRepresentation:
36
+ (luvio.opaque): true
31
37
 
32
38
  /ssot:
33
39
  /data-clean-room:
@@ -65,3 +71,11 @@ types:
65
71
  put:
66
72
  (luvio.adapter):
67
73
  name: rejectDataCleanRoomInvitation
74
+ /{collaborationIdOrApiName}/actions/run:
75
+ post:
76
+ (luvio.adapter):
77
+ name: executeDataCleanRoomQuery
78
+ /{collaborationIdOrApiName}/jobs:
79
+ get:
80
+ (luvio.adapter):
81
+ name: getAllDataCleanRoomQueryPaginated