@salesforce/lds-adapters-analytics-wave 1.458.0 → 1.460.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.
Files changed (22) hide show
  1. package/dist/es/es2018/analytics-wave.js +4899 -3726
  2. package/dist/es/es2018/types/src/generated/adapters/getAsset.d.ts +28 -0
  3. package/dist/es/es2018/types/src/generated/adapters/getRecycleBin.d.ts +26 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getRecycleBinAsset.d.ts +28 -0
  5. package/dist/es/es2018/types/src/generated/adapters/permanentlyDeleteAsset.d.ts +14 -0
  6. package/dist/es/es2018/types/src/generated/adapters/restoreAsset.d.ts +15 -0
  7. package/dist/es/es2018/types/src/generated/adapters/softDeleteAsset.d.ts +14 -0
  8. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +6 -0
  9. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +12 -1
  10. package/dist/es/es2018/types/src/generated/resources/deleteWaveAssetsByAssetId.d.ts +12 -0
  11. package/dist/es/es2018/types/src/generated/resources/deleteWaveRecyclebinByAssetId.d.ts +12 -0
  12. package/dist/es/es2018/types/src/generated/resources/getWaveAssetsByAssetId.d.ts +16 -0
  13. package/dist/es/es2018/types/src/generated/resources/getWaveRecyclebin.d.ts +12 -0
  14. package/dist/es/es2018/types/src/generated/resources/getWaveRecyclebinByAssetId.d.ts +16 -0
  15. package/dist/es/es2018/types/src/generated/resources/postWaveRecyclebinRestoreByAssetId.d.ts +12 -0
  16. package/dist/es/es2018/types/src/generated/types/RecipeRepresentation.d.ts +4 -1
  17. package/dist/es/es2018/types/src/generated/types/RecycleBinAssetRepresentation.d.ts +54 -0
  18. package/dist/es/es2018/types/src/generated/types/RecycleBinCollectionRepresentation.d.ts +39 -0
  19. package/package.json +3 -3
  20. package/sfdc/index.js +5266 -3972
  21. package/src/raml/api.raml +109 -0
  22. package/src/raml/luvio.raml +42 -0
package/src/raml/api.raml CHANGED
@@ -3167,6 +3167,10 @@ types:
3167
3167
  description: Recipe definition for 3.0 format
3168
3168
  type: RecipeDefinitionRepresentation
3169
3169
  required: false # TODO Hand-rolled W-8253396
3170
+ recipePermsFolderId:
3171
+ description: The ID of the folder used for recipe permissions.
3172
+ type: string
3173
+ required: false
3170
3174
  rowLevelSecurityPredicate:
3171
3175
  description: The security predicate of the target dataset
3172
3176
  type: string
@@ -3247,6 +3251,54 @@ types:
3247
3251
  description: Validation code
3248
3252
  type: integer
3249
3253
  required: false # TODO Hand-rolled W-8253396
3254
+ RecycleBinAssetRepresentation: # TODO Hand-rolled W-24090908. New CRM Analytics Data Platform Recycle Bin endpoint; regenerate from Connect api.raml once shipped.
3255
+ description: A soft-deleted CRM Analytics Data Platform asset in the Recycle Bin.
3256
+ type: object
3257
+ properties:
3258
+ daysRemaining:
3259
+ description: The number of days remaining before the asset is permanently deleted.
3260
+ type: integer | nil
3261
+ required: false
3262
+ deletedBy:
3263
+ description: The user who soft-deleted the asset.
3264
+ type: WaveUserRepresentation | nil
3265
+ required: false
3266
+ deletedOn:
3267
+ description: The time the asset was soft-deleted.
3268
+ type: string | nil
3269
+ required: false
3270
+ id:
3271
+ description: The 18 character asset ID.
3272
+ type: string
3273
+ name:
3274
+ description: The name of the asset.
3275
+ type: string
3276
+ type:
3277
+ description: The type of the soft-deleted asset.
3278
+ type: string
3279
+ enum:
3280
+ - dataflow
3281
+ - recipe
3282
+ RecycleBinCollectionRepresentation: # TODO Hand-rolled W-24090908. New CRM Analytics Data Platform Recycle Bin endpoint; regenerate from Connect api.raml once shipped.
3283
+ description: A collection of soft-deleted CRM Analytics Data Platform assets.
3284
+ type: object
3285
+ properties:
3286
+ assets:
3287
+ description: The soft-deleted assets in the Recycle Bin.
3288
+ type: array
3289
+ items:
3290
+ type: RecycleBinAssetRepresentation
3291
+ nextPageUrl:
3292
+ description: URL to get the next page of contents in the collection.
3293
+ type: string | nil
3294
+ totalSize:
3295
+ description: Gets the total count of the elements in the collection irrespective
3296
+ of the page.
3297
+ type: integer | nil
3298
+ required: false
3299
+ url:
3300
+ description: URL to get the collection.
3301
+ type: string | nil
3250
3302
  ReplicatedDatasetConnectorRepresentation:
3251
3303
  # This representation is hand-rolled from DataConnectorRepresentation as it is meant to be the same,
3252
3304
  # but due to API response inconsistencies between data connectors and replicated dataset, the two
@@ -7597,6 +7649,63 @@ types:
7597
7649
  id:
7598
7650
  type: string
7599
7651
  required: true
7652
+ # TODO Hand-rolled W-24090908. New admin-only, feature-gated CRM Analytics Data Platform
7653
+ # Recycle Bin endpoints (soft-delete + restore + permanent-delete for recipes and dataflows).
7654
+ # Regenerate from the Connect api.raml build output once these ship server-side.
7655
+ /recyclebin:
7656
+ get:
7657
+ description: Get a listing of the soft-deleted assets in the Recycle Bin.
7658
+ responses:
7659
+ '200':
7660
+ description: Success
7661
+ body:
7662
+ application/json:
7663
+ type: RecycleBinCollectionRepresentation
7664
+ /recyclebin/{assetId}:
7665
+ get:
7666
+ description: Get a single soft-deleted asset from the Recycle Bin.
7667
+ responses:
7668
+ '200':
7669
+ description: Success
7670
+ body:
7671
+ application/json:
7672
+ type: RecycleBinAssetRepresentation
7673
+ delete:
7674
+ description: Permanently delete a soft-deleted asset from the Recycle Bin.
7675
+ responses:
7676
+ '200':
7677
+ description: Success
7678
+ uriParameters:
7679
+ assetId:
7680
+ type: string
7681
+ required: true
7682
+ /restore:
7683
+ post:
7684
+ description: Restore a soft-deleted asset from the Recycle Bin.
7685
+ responses:
7686
+ '200':
7687
+ description: Success
7688
+ body:
7689
+ application/json:
7690
+ type: RecycleBinAssetRepresentation
7691
+ /assets/{assetId}:
7692
+ get:
7693
+ description: Get an asset by ID.
7694
+ responses:
7695
+ '200':
7696
+ description: Success
7697
+ body:
7698
+ application/json:
7699
+ type: BaseWaveAssetRepresentation
7700
+ delete:
7701
+ description: Soft-delete an asset, moving it to the Recycle Bin.
7702
+ responses:
7703
+ '200':
7704
+ description: Success
7705
+ uriParameters:
7706
+ assetId:
7707
+ type: string
7708
+ required: true
7600
7709
  /replicatedDatasets:
7601
7710
  get:
7602
7711
  description: Get a list of all Replicated Datasets.
@@ -54,6 +54,13 @@ types:
54
54
  (luvio.ttl): 5000
55
55
  (luvio.key):
56
56
  id: recipe.id
57
+ RecycleBinAssetRepresentation:
58
+ (luvio.ttl): 5000
59
+ (luvio.key):
60
+ id: id
61
+ RecycleBinCollectionRepresentation:
62
+ (luvio.opaque): true
63
+ (luvio.ttl): 300
57
64
  ReplicatedDatasetCollectionRepresentation:
58
65
  (luvio.ttl): 300
59
66
  ReplicatedDatasetRepresentation:
@@ -360,6 +367,41 @@ types:
360
367
  put:
361
368
  (luvio.adapter):
362
369
  name: updateRecipeNotification
370
+ # CRM Analytics Data Platform Recycle Bin (W-24090908).
371
+ /recyclebin:
372
+ get:
373
+ (luvio.adapter):
374
+ name: getRecycleBin
375
+ # getRecycleBinAsset / getAsset are the GET-by-id siblings luvio requires so the
376
+ # cache-aware void DELETE adapters (permanentlyDeleteAsset / softDeleteAsset) can evict
377
+ # the cached record by key. restoreAsset is an imperative POST returning the restored
378
+ # asset. See W-24090908.
379
+ /recyclebin/{assetId}:
380
+ get:
381
+ (luvio.adapter):
382
+ name: getRecycleBinAsset
383
+ (luvio.key):
384
+ id: urlParams.assetId
385
+ delete:
386
+ (luvio.adapter):
387
+ name: permanentlyDeleteAsset
388
+ (luvio.key):
389
+ id: urlParams.assetId
390
+ /restore:
391
+ post:
392
+ (luvio.adapter):
393
+ name: restoreAsset
394
+ /assets/{assetId}:
395
+ get:
396
+ (luvio.adapter):
397
+ name: getAsset
398
+ (luvio.key):
399
+ id: urlParams.assetId
400
+ delete:
401
+ (luvio.adapter):
402
+ name: softDeleteAsset
403
+ (luvio.key):
404
+ id: urlParams.assetId
363
405
  /replicatedDatasets:
364
406
  get:
365
407
  (luvio.adapter):