@segment/public-api-sdk-typescript 33.0.4-b5485 → 33.0.4-b5506

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 (51) hide show
  1. package/api/deletionAndSuppressionApi.ts +3 -3
  2. package/api/destinationFiltersApi.ts +3 -3
  3. package/api/destinationsApi.ts +8 -8
  4. package/api/edgeFunctionsApi.ts +4 -4
  5. package/api/functionsApi.ts +6 -6
  6. package/api/iAMGroupsApi.ts +8 -8
  7. package/api/iAMUsersApi.ts +5 -5
  8. package/api/labelsApi.ts +2 -2
  9. package/api/selectiveSyncApi.ts +1 -1
  10. package/api/sourcesApi.ts +4 -4
  11. package/api/spacesApi.ts +3 -3
  12. package/api/trackingPlansApi.ts +12 -12
  13. package/api/transformationsApi.ts +5 -5
  14. package/api/warehousesApi.ts +5 -5
  15. package/dist/model/addLabelsToSourceV1Input.d.ts +1 -1
  16. package/dist/model/addPermissionsToUserGroupV1Input.d.ts +1 -1
  17. package/dist/model/addPermissionsToUserV1Input.d.ts +1 -1
  18. package/dist/model/addSourceToTrackingPlanV1Input.d.ts +1 -1
  19. package/dist/model/addUsersToUserGroupV1Input.d.ts +1 -1
  20. package/dist/model/createCloudSourceRegulationV1Input.d.ts +2 -2
  21. package/dist/model/createFilterForDestinationV1Input.d.ts +2 -2
  22. package/dist/model/createSourceRegulationV1Input.d.ts +2 -2
  23. package/dist/model/replaceAdvancedSyncScheduleForWarehouseV1Input.d.ts +1 -1
  24. package/dist/model/replaceLabelsInSourceV1Input.d.ts +1 -1
  25. package/dist/model/replacePermissionsForUserGroupV1Input.d.ts +1 -1
  26. package/dist/model/replacePermissionsForUserV1Input.d.ts +1 -1
  27. package/dist/model/replaceRulesInTrackingPlanV1Input.d.ts +1 -1
  28. package/dist/model/replaceUsersInUserGroupV1Input.d.ts +1 -1
  29. package/dist/model/updateRulesInTrackingPlanV1Input.d.ts +1 -1
  30. package/dist/model/updateSelectiveSyncForWarehouseV1Input.d.ts +1 -1
  31. package/dist/model/updateUserGroupV1Input.d.ts +1 -1
  32. package/dist/model/updateWarehouseV1Input.d.ts +1 -1
  33. package/model/addLabelsToSourceV1Input.ts +1 -1
  34. package/model/addPermissionsToUserGroupV1Input.ts +1 -1
  35. package/model/addPermissionsToUserV1Input.ts +1 -1
  36. package/model/addSourceToTrackingPlanV1Input.ts +1 -1
  37. package/model/addUsersToUserGroupV1Input.ts +1 -1
  38. package/model/createCloudSourceRegulationV1Input.ts +2 -2
  39. package/model/createFilterForDestinationV1Input.ts +2 -2
  40. package/model/createSourceRegulationV1Input.ts +2 -2
  41. package/model/replaceAdvancedSyncScheduleForWarehouseV1Input.ts +1 -1
  42. package/model/replaceLabelsInSourceV1Input.ts +1 -1
  43. package/model/replacePermissionsForUserGroupV1Input.ts +1 -1
  44. package/model/replacePermissionsForUserV1Input.ts +1 -1
  45. package/model/replaceRulesInTrackingPlanV1Input.ts +1 -1
  46. package/model/replaceUsersInUserGroupV1Input.ts +1 -1
  47. package/model/updateRulesInTrackingPlanV1Input.ts +1 -1
  48. package/model/updateSelectiveSyncForWarehouseV1Input.ts +1 -1
  49. package/model/updateUserGroupV1Input.ts +1 -1
  50. package/model/updateWarehouseV1Input.ts +1 -1
  51. package/package.json +1 -1
@@ -254,7 +254,7 @@ export class DeletionAndSuppressionApi {
254
254
  });
255
255
  }
256
256
  /**
257
- * Creates a Source-scoped regulation. When called, this endpoint may generate the `Source Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`
257
+ * Creates a Source-scoped regulation.When called, this endpoint may generate the `Source Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`
258
258
  * @summary Create Source Regulation
259
259
  * @param sourceId
260
260
  * @param CreateSourceRegulationV1Input
@@ -389,7 +389,7 @@ export class DeletionAndSuppressionApi {
389
389
  });
390
390
  }
391
391
  /**
392
- * Creates a Workspace-scoped regulation. When called, this endpoint may generate the `Workspace Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`
392
+ * Creates a Workspace-scoped regulation.When called, this endpoint may generate the `Workspace Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`
393
393
  * @summary Create Workspace Regulation
394
394
  * @param CreateWorkspaceRegulationV1Input
395
395
  */
@@ -510,7 +510,7 @@ export class DeletionAndSuppressionApi {
510
510
  });
511
511
  }
512
512
  /**
513
- * Deletes a regulation from the Workspace. The regulation must be in the initialized state to be deleted. When called, this endpoint may generate the `Regulation Deleted` event in the [audit trail](/tag/Audit-Trail).
513
+ * Deletes a regulation from the Workspace. The regulation must be in the initialized state to be deleted.When called, this endpoint may generate the `Regulation Deleted` event in the [audit trail](/tag/Audit-Trail).
514
514
  * @summary Delete Regulation
515
515
  * @param regulateId
516
516
  */
@@ -117,7 +117,7 @@ export class DestinationFiltersApi {
117
117
  }
118
118
 
119
119
  /**
120
- * Creates a filter in a Destination. When called, this endpoint may generate the `Destination Filter Created` event in the [audit trail](/tag/Audit-Trail).
120
+ * Creates a filter in a Destination.When called, this endpoint may generate the `Destination Filter Created` event in the [audit trail](/tag/Audit-Trail).
121
121
  * @summary Create Filter for Destination
122
122
  * @param destinationId
123
123
  * @param CreateFilterForDestinationV1Input
@@ -641,7 +641,7 @@ export class DestinationFiltersApi {
641
641
  });
642
642
  }
643
643
  /**
644
- * Deletes a Destination filter. When called, this endpoint may generate the `Destination Filter Deleted` event in the [audit trail](/tag/Audit-Trail).
644
+ * Deletes a Destination filter.When called, this endpoint may generate the `Destination Filter Deleted` event in the [audit trail](/tag/Audit-Trail).
645
645
  * @summary Remove Filter from Destination
646
646
  * @param destinationId
647
647
  * @param filterId
@@ -774,7 +774,7 @@ export class DestinationFiltersApi {
774
774
  });
775
775
  }
776
776
  /**
777
- * Updates a filter in a Destination. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Destination Filter Enabled * Destination Filter Disabled
777
+ * Updates a filter in a Destination. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Destination Filter Enabled * Destination Filter Disabled
778
778
  * @summary Update Filter for Destination
779
779
  * @param destinationId
780
780
  * @param filterId
@@ -122,7 +122,7 @@ export class DestinationsApi {
122
122
  }
123
123
 
124
124
  /**
125
- * Creates a new Destination. When called, this endpoint may generate the `Integration Created` event in the [audit trail](/tag/Audit-Trail).
125
+ * Creates a new Destination.When called, this endpoint may generate the `Integration Created` event in the [audit trail](/tag/Audit-Trail).
126
126
  * @summary Create Destination
127
127
  * @param CreateDestinationV1Input
128
128
  */
@@ -243,7 +243,7 @@ export class DestinationsApi {
243
243
  });
244
244
  }
245
245
  /**
246
- * Creates a new Destination subscription.
246
+ * Creates a new Destination subscription. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.
247
247
  * @summary Create Destination Subscription
248
248
  * @param destinationId
249
249
  * @param CreateDestinationSubscriptionAlphaInput
@@ -376,7 +376,7 @@ export class DestinationsApi {
376
376
  });
377
377
  }
378
378
  /**
379
- * Deletes an existing Destination. When called, this endpoint may generate the `Integration Deleted` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `catalogId`
379
+ * Deletes an existing Destination.When called, this endpoint may generate the `Integration Deleted` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `catalogId`
380
380
  * @summary Delete Destination
381
381
  * @param destinationId
382
382
  */
@@ -614,7 +614,7 @@ export class DestinationsApi {
614
614
  });
615
615
  }
616
616
  /**
617
- * Gets a Destination subscription by id.
617
+ * Gets a Destination subscription by id. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.
618
618
  * @summary Get Subscription from Destination
619
619
  * @param destinationId
620
620
  * @param id
@@ -1024,7 +1024,7 @@ export class DestinationsApi {
1024
1024
  });
1025
1025
  }
1026
1026
  /**
1027
- * Lists subscriptions for a Destination.
1027
+ * Lists subscriptions for a Destination. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.
1028
1028
  * @summary List Subscriptions from Destination
1029
1029
  * @param destinationId
1030
1030
  * @param pagination Pagination options. This parameter exists in alpha.
@@ -1157,7 +1157,7 @@ export class DestinationsApi {
1157
1157
  });
1158
1158
  }
1159
1159
  /**
1160
- * Deletes an existing Destination subscription.
1160
+ * Deletes an existing Destination subscription. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.
1161
1161
  * @summary Remove Subscription from Destination
1162
1162
  * @param destinationId
1163
1163
  * @param id
@@ -1285,7 +1285,7 @@ export class DestinationsApi {
1285
1285
  });
1286
1286
  }
1287
1287
  /**
1288
- * Updates an existing Destination. **Note**: if you attempt to update read-only settings for your destination you\'ll encounter the following behavior: * If only read-only properties are being updated, the endpoint will return an HTTP 400 error. * If there\'s a mix of writable and read-only properties in the payload, the request will be accepted, the writable properties will be updated and the read-only properties ignored. When called, this endpoint may generate the `Integration Disabled` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `updateMask`
1288
+ * Updates an existing Destination. **Note**: if you attempt to update read-only settings for your destination you\'ll encounter the following behavior: * If only read-only properties are being updated, the endpoint will return an HTTP 400 error. * If there\'s a mix of writable and read-only properties in the payload, the request will be accepted, the writable properties will be updated and the read-only properties ignored.When called, this endpoint may generate the `Integration Disabled` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `updateMask`
1289
1289
  * @summary Update Destination
1290
1290
  * @param destinationId
1291
1291
  * @param UpdateDestinationV1Input
@@ -1420,7 +1420,7 @@ export class DestinationsApi {
1420
1420
  });
1421
1421
  }
1422
1422
  /**
1423
- * Updates an existing Destination subscription.
1423
+ * Updates an existing Destination subscription. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.
1424
1424
  * @summary Update Subscription for Destination
1425
1425
  * @param destinationId
1426
1426
  * @param id
@@ -111,7 +111,7 @@ export class EdgeFunctionsApi {
111
111
  }
112
112
 
113
113
  /**
114
- * Create EdgeFunctions for your Source, given a valid upload URL for an Edge Functions bundle. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
114
+ * Create EdgeFunctions for your Source given a valid upload URL for an Edge Functions bundle. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
115
115
  * @summary Create Edge Functions
116
116
  * @param sourceId
117
117
  * @param CreateEdgeFunctionsAlphaInput
@@ -244,7 +244,7 @@ export class EdgeFunctionsApi {
244
244
  });
245
245
  }
246
246
  /**
247
- * Disable Edge Functions for your Source. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
247
+ * Disable Edge Functions for your Source. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
248
248
  * @summary Disable Edge Functions
249
249
  * @param sourceId
250
250
  */
@@ -361,7 +361,7 @@ export class EdgeFunctionsApi {
361
361
  });
362
362
  }
363
363
  /**
364
- * Generate a temporary upload URL, that can be used to upload an Edge Functions bundle. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
364
+ * Generate a temporary upload URL that can be used to upload an Edge Functions bundle. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
365
365
  * @summary Generate Upload URL for Edge Functions
366
366
  * @param sourceId
367
367
  */
@@ -478,7 +478,7 @@ export class EdgeFunctionsApi {
478
478
  });
479
479
  }
480
480
  /**
481
- * Get the latest Edge Functions for your Source. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
481
+ * Get the latest Edge Functions for your Source. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Edge Functions feature enabled. Please reach out to your customer success manager for more information.
482
482
  * @summary Get Latest from Edge Functions
483
483
  * @param sourceId
484
484
  */
@@ -114,7 +114,7 @@ export class FunctionsApi {
114
114
  }
115
115
 
116
116
  /**
117
- * Creates a Function. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
117
+ * Creates a Function. In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
118
118
  * @summary Create Function
119
119
  * @param CreateFunctionV1Input
120
120
  */
@@ -235,7 +235,7 @@ export class FunctionsApi {
235
235
  });
236
236
  }
237
237
  /**
238
- * Deploys a Function. Only applicable to Source Function instances. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
238
+ * Deploys a Function. Only applicable to Source Function instances. In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
239
239
  * @summary Create Function Deployment
240
240
  * @param functionId
241
241
  */
@@ -354,7 +354,7 @@ export class FunctionsApi {
354
354
  });
355
355
  }
356
356
  /**
357
- * Deletes a Function. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
357
+ * Deletes a Function. In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
358
358
  * @summary Delete Function
359
359
  * @param functionId
360
360
  */
@@ -473,7 +473,7 @@ export class FunctionsApi {
473
473
  });
474
474
  }
475
475
  /**
476
- * Gets a Function. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
476
+ * Gets a Function. In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
477
477
  * @summary Get Function
478
478
  * @param functionId
479
479
  */
@@ -592,7 +592,7 @@ export class FunctionsApi {
592
592
  });
593
593
  }
594
594
  /**
595
- * Lists all Functions in a Workspace. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
595
+ * Lists all Functions in a Workspace. In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.
596
596
  * @summary List Functions
597
597
  * @param pagination Pagination parameters. This parameter exists in v1.
598
598
  * @param resourceType The Function type. Config API note: equal to `type`. This parameter exists in v1.
@@ -730,7 +730,7 @@ export class FunctionsApi {
730
730
  });
731
731
  }
732
732
  /**
733
- * Updates a Function. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information. Config API omitted fields: - `updateMask`
733
+ * Updates a Function. In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information. Config API omitted fields: - `updateMask`
734
734
  * @summary Update Function
735
735
  * @param functionId
736
736
  * @param UpdateFunctionV1Input
@@ -124,7 +124,7 @@ export class IAMGroupsApi {
124
124
  }
125
125
 
126
126
  /**
127
- * Adds a list of access permissions to a user group. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Policy Created * User Group Policy Updated The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
127
+ * Adds a list of access permissions to a user group. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Policy Created * User Group Policy Updated The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
128
128
  * @summary Add Permissions to User Group
129
129
  * @param userGroupId
130
130
  * @param AddPermissionsToUserGroupV1Input
@@ -259,7 +259,7 @@ export class IAMGroupsApi {
259
259
  });
260
260
  }
261
261
  /**
262
- * Adds a list of users or invites to a user group. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Subjects Added to Group * User Added To User Group The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
262
+ * Adds a list of users or invites to a user group. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Subjects Added to Group * User Added To User Group The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
263
263
  * @summary Add Users to User Group
264
264
  * @param userGroupId
265
265
  * @param AddUsersToUserGroupV1Input
@@ -394,7 +394,7 @@ export class IAMGroupsApi {
394
394
  });
395
395
  }
396
396
  /**
397
- * Creates a user group. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * User Group Created * Policy Created The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
397
+ * Creates a user group. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* User Group Created * Policy Created The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
398
398
  * @summary Create User Group
399
399
  * @param CreateUserGroupV1Input
400
400
  */
@@ -515,7 +515,7 @@ export class IAMGroupsApi {
515
515
  });
516
516
  }
517
517
  /**
518
- * Removes a user group from a Workspace. When called, this endpoint may generate the `User Group Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
518
+ * Removes a user group from a Workspace.When called, this endpoint may generate the `User Group Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
519
519
  * @summary Delete User Group
520
520
  * @param userGroupId
521
521
  */
@@ -1144,7 +1144,7 @@ export class IAMGroupsApi {
1144
1144
  });
1145
1145
  }
1146
1146
  /**
1147
- * Removes one or multiple users or invites from a user group by email. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Group Memberships Deleted * User Removed From User Group The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1147
+ * Removes one or multiple users or invites from a user group by email. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Group Memberships Deleted * User Removed From User Group The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1148
1148
  * @summary Remove Users from User Group
1149
1149
  * @param userGroupId
1150
1150
  * @param emails The list of emails to remove from the user group. This parameter exists in v1.
@@ -1279,7 +1279,7 @@ export class IAMGroupsApi {
1279
1279
  });
1280
1280
  }
1281
1281
  /**
1282
- * Updates the list of access permissions for a user group. When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1282
+ * Updates the list of access permissions for a user group.When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1283
1283
  * @summary Replace Permissions for User Group
1284
1284
  * @param userGroupId
1285
1285
  * @param ReplacePermissionsForUserGroupV1Input
@@ -1414,7 +1414,7 @@ export class IAMGroupsApi {
1414
1414
  });
1415
1415
  }
1416
1416
  /**
1417
- * Replaces the members of a user group by email. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Subjects Added to Group * User Added To User Group * Group Memberships Deleted The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1417
+ * Replaces the members of a user group by email. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Subjects Added to Group * User Added To User Group * Group Memberships Deleted The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1418
1418
  * @summary Replace Users in User Group
1419
1419
  * @param userGroupId
1420
1420
  * @param ReplaceUsersInUserGroupV1Input
@@ -1549,7 +1549,7 @@ export class IAMGroupsApi {
1549
1549
  });
1550
1550
  }
1551
1551
  /**
1552
- * Updates a user group for a Workspace. When called, this endpoint may generate the `User Group Updated` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1552
+ * Updates a user group for a Workspace.When called, this endpoint may generate the `User Group Updated` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1553
1553
  * @summary Update User Group
1554
1554
  * @param userGroupId
1555
1555
  * @param UpdateUserGroupV1Input
@@ -118,7 +118,7 @@ export class IAMUsersApi {
118
118
  }
119
119
 
120
120
  /**
121
- * Adds a list of access permissions to a user. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Policy Created * User Policy Updated The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
121
+ * Adds a list of access permissions to a user. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Policy Created * User Policy Updated The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
122
122
  * @summary Add Permissions to User
123
123
  * @param userId
124
124
  * @param AddPermissionsToUserV1Input
@@ -253,7 +253,7 @@ export class IAMUsersApi {
253
253
  });
254
254
  }
255
255
  /**
256
- * Invites a list of users to join a Workspace. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Non-Segment User Invited to Workspace * Policy Created * New Segment User Invited to Workspace Config API omitted fields: - `parent` The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
256
+ * Invites a list of users to join a Workspace. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Non-Segment User Invited to Workspace * Policy Created * New Segment User Invited to Workspace Config API omitted fields: - `parent` The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
257
257
  * @summary Create Invites
258
258
  * @param CreateInvitesV1Input
259
259
  */
@@ -374,7 +374,7 @@ export class IAMUsersApi {
374
374
  });
375
375
  }
376
376
  /**
377
- * Removes a list of invitations to join a Workspace. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Invite Deleted * Group Memberships Deleted The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
377
+ * Removes a list of invitations to join a Workspace. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Invite Deleted * Group Memberships Deleted The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
378
378
  * @summary Delete Invites
379
379
  * @param emails The list of emails to delete invites for. This parameter exists in v1.
380
380
  */
@@ -495,7 +495,7 @@ export class IAMUsersApi {
495
495
  });
496
496
  }
497
497
  /**
498
- * Removes one or multiple users. When called, this endpoint may generate the `Group Memberships Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
498
+ * Removes one or multiple users.When called, this endpoint may generate the `Group Memberships Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
499
499
  * @summary Delete Users
500
500
  * @param userIds The ids of the users to remove. This parameter exists in v1.
501
501
  */
@@ -1106,7 +1106,7 @@ export class IAMUsersApi {
1106
1106
  });
1107
1107
  }
1108
1108
  /**
1109
- * Updates the list of access permissions for a user. When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1109
+ * Updates the list of access permissions for a user.When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
1110
1110
  * @summary Replace Permissions for User
1111
1111
  * @param userId
1112
1112
  * @param ReplacePermissionsForUserV1Input
package/api/labelsApi.ts CHANGED
@@ -113,7 +113,7 @@ export class LabelsApi {
113
113
  }
114
114
 
115
115
  /**
116
- * Creates a new label. When called, this endpoint may generate the `Label Created` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
116
+ * Creates a new label.When called, this endpoint may generate the `Label Created` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
117
117
  * @summary Create Label
118
118
  * @param CreateLabelV1Input
119
119
  */
@@ -231,7 +231,7 @@ export class LabelsApi {
231
231
  });
232
232
  }
233
233
  /**
234
- * Deletes a label. When called, this endpoint may generate the `Label Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
234
+ * Deletes a label.When called, this endpoint may generate the `Label Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
235
235
  * @summary Delete Label
236
236
  * @param key
237
237
  * @param value
@@ -802,7 +802,7 @@ export class SelectiveSyncApi {
802
802
  });
803
803
  }
804
804
  /**
805
- * Configures the schema for a Warehouse, including Sources, Collections, and Properties. When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
805
+ * Configures the schema for a Warehouse, including Sources, Collections, and Properties.When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
806
806
  * @summary Update Selective Sync for Warehouse
807
807
  * @param warehouseId
808
808
  * @param UpdateSelectiveSyncForWarehouseV1Input
package/api/sourcesApi.ts CHANGED
@@ -135,7 +135,7 @@ export class SourcesApi {
135
135
  }
136
136
 
137
137
  /**
138
- * Adds an existing label to a Source. When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).
138
+ * Adds an existing label to a Source.When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).
139
139
  * @summary Add Labels to Source
140
140
  * @param sourceId
141
141
  * @param AddLabelsToSourceV1Input
@@ -270,7 +270,7 @@ export class SourcesApi {
270
270
  });
271
271
  }
272
272
  /**
273
- * Creates a new Source. When called, this endpoint may generate the `Source Created` event in the [audit trail](/tag/Audit-Trail).
273
+ * Creates a new Source.When called, this endpoint may generate the `Source Created` event in the [audit trail](/tag/Audit-Trail).
274
274
  * @summary Create Source
275
275
  * @param CreateSourceV1Input
276
276
  */
@@ -388,7 +388,7 @@ export class SourcesApi {
388
388
  });
389
389
  }
390
390
  /**
391
- * Deletes an existing Source. When called, this endpoint may generate the `Source Deleted` event in the [audit trail](/tag/Audit-Trail).
391
+ * Deletes an existing Source.When called, this endpoint may generate the `Source Deleted` event in the [audit trail](/tag/Audit-Trail).
392
392
  * @summary Delete Source
393
393
  * @param sourceId
394
394
  */
@@ -1403,7 +1403,7 @@ export class SourcesApi {
1403
1403
  });
1404
1404
  }
1405
1405
  /**
1406
- * Updates an existing Source. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Source Modified * Source Enabled * Source Settings Modified * Source Disabled Config API omitted fields: - `updateMask`
1406
+ * Updates an existing Source. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Source Modified * Source Enabled * Source Settings Modified * Source Disabled Config API omitted fields: - `updateMask`
1407
1407
  * @summary Update Source
1408
1408
  * @param sourceId
1409
1409
  * @param UpdateSourceV1Input
package/api/spacesApi.ts CHANGED
@@ -110,7 +110,7 @@ export class SpacesApi {
110
110
  }
111
111
 
112
112
  /**
113
- * Get Messaging Subscriptions for space.
113
+ * Get Messaging Subscriptions for space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.
114
114
  * @summary Batch Query Messaging Subscriptions for Space
115
115
  * @param spaceId
116
116
  * @param BatchQueryMessagingSubscriptionsForSpaceAlphaInput
@@ -243,7 +243,7 @@ export class SpacesApi {
243
243
  });
244
244
  }
245
245
  /**
246
- * Returns the Space by id.
246
+ * Returns the Space by id. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.
247
247
  * @summary Get Space
248
248
  * @param spaceId
249
249
  */
@@ -357,7 +357,7 @@ export class SpacesApi {
357
357
  });
358
358
  }
359
359
  /**
360
- * Replace Messaging Subscriptions in Spaces. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
360
+ * Replace Messaging Subscriptions in Spaces. • This endpoint is in **Alpha** testing. Please submit any feedback by sending email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
361
361
  * @summary Replace Messaging Subscriptions in Spaces
362
362
  * @param spaceId
363
363
  * @param ReplaceMessagingSubscriptionsInSpacesAlphaInput
@@ -125,7 +125,7 @@ export class TrackingPlansApi {
125
125
  }
126
126
 
127
127
  /**
128
- * Connects a Source to a Tracking Plan. When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
128
+ * Connects a Source to a Tracking Plan.When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
129
129
  * @summary Add Source to Tracking Plan
130
130
  * @param trackingPlanId
131
131
  * @param AddSourceToTrackingPlanV1Input
@@ -260,7 +260,7 @@ export class TrackingPlansApi {
260
260
  });
261
261
  }
262
262
  /**
263
- * Creates a Tracking Plan. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
263
+ * Creates a Tracking Plan. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
264
264
  * @summary Create Tracking Plan
265
265
  * @param CreateTrackingPlanV1Input
266
266
  */
@@ -381,7 +381,7 @@ export class TrackingPlansApi {
381
381
  });
382
382
  }
383
383
  /**
384
- * Deletes a Tracking Plan. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
384
+ * Deletes a Tracking Plan. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
385
385
  * @summary Delete Tracking Plan
386
386
  * @param trackingPlanId
387
387
  */
@@ -500,7 +500,7 @@ export class TrackingPlansApi {
500
500
  });
501
501
  }
502
502
  /**
503
- * Returns a Tracking Plan. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
503
+ * Returns a Tracking Plan. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
504
504
  * @summary Get Tracking Plan
505
505
  * @param trackingPlanId
506
506
  */
@@ -619,7 +619,7 @@ export class TrackingPlansApi {
619
619
  });
620
620
  }
621
621
  /**
622
- * Lists Tracking Plan rules. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
622
+ * Lists Tracking Plan rules. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
623
623
  * @summary List Rules from Tracking Plan
624
624
  * @param trackingPlanId
625
625
  * @param pagination Pagination options. This parameter exists in v1.
@@ -754,7 +754,7 @@ export class TrackingPlansApi {
754
754
  });
755
755
  }
756
756
  /**
757
- * Lists Sources connected to a Tracking Plan. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. This endpoint requires the user to have at least the following permission(s): * Source Read-only * Tracking Plan Read-only
757
+ * Lists Sources connected to a Tracking Plan. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. This endpoint requires the user to have at least the following permission(s): * Source Read-only * Tracking Plan Read-only
758
758
  * @summary List Sources from Tracking Plan
759
759
  * @param trackingPlanId
760
760
  * @param pagination Pagination options. This parameter exists in v1.
@@ -889,7 +889,7 @@ export class TrackingPlansApi {
889
889
  });
890
890
  }
891
891
  /**
892
- * Returns a list of Tracking Plans. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
892
+ * Returns a list of Tracking Plans. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
893
893
  * @summary List Tracking Plans
894
894
  * @param pagination Pagination options. This parameter exists in v1.
895
895
  * @param type Requests Tracking Plans of a certain type. If omitted, lists all types. This parameter exists in v1.
@@ -1019,7 +1019,7 @@ export class TrackingPlansApi {
1019
1019
  });
1020
1020
  }
1021
1021
  /**
1022
- * Deletes Tracking Plan rules. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1022
+ * Deletes Tracking Plan rules. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1023
1023
  * @summary Remove Rules from Tracking Plan
1024
1024
  * @param trackingPlanId
1025
1025
  * @param rules Rules to delete. This parameter exists in v1.
@@ -1154,7 +1154,7 @@ export class TrackingPlansApi {
1154
1154
  });
1155
1155
  }
1156
1156
  /**
1157
- * Disconnects a Source from a Tracking Plan. When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1157
+ * Disconnects a Source from a Tracking Plan.When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1158
1158
  * @summary Remove Source from Tracking Plan
1159
1159
  * @param trackingPlanId
1160
1160
  * @param sourceId The id of the Source associated with the Tracking Plan. Config API note: analogous to `sourceName`. This parameter exists in v1.
@@ -1289,7 +1289,7 @@ export class TrackingPlansApi {
1289
1289
  });
1290
1290
  }
1291
1291
  /**
1292
- * Replaces Tracking Plan rules. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1292
+ * Replaces Tracking Plan rules. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1293
1293
  * @summary Replace Rules in Tracking Plan
1294
1294
  * @param trackingPlanId
1295
1295
  * @param ReplaceRulesInTrackingPlanV1Input
@@ -1424,7 +1424,7 @@ export class TrackingPlansApi {
1424
1424
  });
1425
1425
  }
1426
1426
  /**
1427
- * Updates Tracking Plan rules. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1427
+ * Updates Tracking Plan rules. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
1428
1428
  * @summary Update Rules in Tracking Plan
1429
1429
  * @param trackingPlanId
1430
1430
  * @param UpdateRulesInTrackingPlanV1Input
@@ -1559,7 +1559,7 @@ export class TrackingPlansApi {
1559
1559
  });
1560
1560
  }
1561
1561
  /**
1562
- * Updates a Tracking Plan. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. Config API omitted fields: - `updateMask`
1562
+ * Updates a Tracking Plan. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. Config API omitted fields: - `updateMask`
1563
1563
  * @summary Update Tracking Plan
1564
1564
  * @param trackingPlanId
1565
1565
  * @param UpdateTrackingPlanV1Input
@@ -114,7 +114,7 @@ export class TransformationsApi {
114
114
  }
115
115
 
116
116
  /**
117
- * Creates a new Transformation. When called, this endpoint may generate the `Transformation Created` event in the [audit trail](/tag/Audit-Trail). **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
117
+ * Creates a new Transformation.When called, this endpoint may generate the `Transformation Created` event in the [audit trail](/tag/Audit-Trail). In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
118
118
  * @summary Create Transformation
119
119
  * @param CreateTransformationV1Input
120
120
  */
@@ -235,7 +235,7 @@ export class TransformationsApi {
235
235
  });
236
236
  }
237
237
  /**
238
- * Deletes a Transformation. When called, this endpoint may generate the `Transformation Deleted` event in the [audit trail](/tag/Audit-Trail). **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
238
+ * Deletes a Transformation.When called, this endpoint may generate the `Transformation Deleted` event in the [audit trail](/tag/Audit-Trail). In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
239
239
  * @summary Delete Transformation
240
240
  * @param transformationId
241
241
  */
@@ -354,7 +354,7 @@ export class TransformationsApi {
354
354
  });
355
355
  }
356
356
  /**
357
- * Gets a Transformation. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
357
+ * Gets a Transformation. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
358
358
  * @summary Get Transformation
359
359
  * @param transformationId
360
360
  */
@@ -473,7 +473,7 @@ export class TransformationsApi {
473
473
  });
474
474
  }
475
475
  /**
476
- * Lists all Transformations in the Workspace. **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
476
+ * Lists all Transformations in the Workspace. In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
477
477
  * @summary List Transformations
478
478
  * @param pagination Pagination options. This parameter exists in v1.
479
479
  */
@@ -594,7 +594,7 @@ export class TransformationsApi {
594
594
  });
595
595
  }
596
596
  /**
597
- * Updates an existing Transformation. When called, this endpoint may generate the `Transformation Updated` event in the [audit trail](/tag/Audit-Trail). **Note**: In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
597
+ * Updates an existing Transformation.When called, this endpoint may generate the `Transformation Updated` event in the [audit trail](/tag/Audit-Trail). In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.
598
598
  * @summary Update Transformation
599
599
  * @param transformationId
600
600
  * @param UpdateTransformationV1Input
@@ -119,7 +119,7 @@ export class WarehousesApi {
119
119
  }
120
120
 
121
121
  /**
122
- * Connects a Source to a Warehouse. When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail).
122
+ * Connects a Source to a Warehouse.When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail).
123
123
  * @summary Add Connection from Source to Warehouse
124
124
  * @param warehouseId
125
125
  * @param sourceId
@@ -252,7 +252,7 @@ export class WarehousesApi {
252
252
  });
253
253
  }
254
254
  /**
255
- * Validates input settings against a Warehouse. When called, this endpoint may generate the `Storage Destination Settings Validation` event in the [audit trail](/tag/Audit-Trail).
255
+ * Validates input settings against a Warehouse.When called, this endpoint may generate the `Storage Destination Settings Validation` event in the [audit trail](/tag/Audit-Trail).
256
256
  * @summary Create Validation in Warehouse
257
257
  * @param CreateValidationInWarehouseV1Input
258
258
  */
@@ -373,7 +373,7 @@ export class WarehousesApi {
373
373
  });
374
374
  }
375
375
  /**
376
- * Creates a new Warehouse. When called, this endpoint may generate the `Storage Destination Created` event in the [audit trail](/tag/Audit-Trail).
376
+ * Creates a new Warehouse.When called, this endpoint may generate the `Storage Destination Created` event in the [audit trail](/tag/Audit-Trail).
377
377
  * @summary Create Warehouse
378
378
  * @param CreateWarehouseV1Input
379
379
  */
@@ -494,7 +494,7 @@ export class WarehousesApi {
494
494
  });
495
495
  }
496
496
  /**
497
- * Deletes an existing Warehouse. When called, this endpoint may generate the `Storage Destination Deleted` event in the [audit trail](/tag/Audit-Trail).
497
+ * Deletes an existing Warehouse.When called, this endpoint may generate the `Storage Destination Deleted` event in the [audit trail](/tag/Audit-Trail).
498
498
  * @summary Delete Warehouse
499
499
  * @param warehouseId
500
500
  */
@@ -1240,7 +1240,7 @@ export class WarehousesApi {
1240
1240
  });
1241
1241
  }
1242
1242
  /**
1243
- * Updates an existing Warehouse. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events: * Storage Destination Modified * Storage Destination Enabled
1243
+ * Updates an existing Warehouse. When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Storage Destination Modified * Storage Destination Enabled
1244
1244
  * @summary Update Warehouse
1245
1245
  * @param warehouseId
1246
1246
  * @param UpdateWarehouseV1Input
@@ -1,6 +1,6 @@
1
1
  import { LabelV1 } from './labelV1';
2
2
  export declare class AddLabelsToSourceV1Input {
3
- 'labels'?: Array<LabelV1>;
3
+ 'labels': Array<LabelV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { PermissionInputV1 } from './permissionInputV1';
2
2
  export declare class AddPermissionsToUserGroupV1Input {
3
- 'permissions'?: Array<PermissionInputV1>;
3
+ 'permissions': Array<PermissionInputV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { PermissionInputV1 } from './permissionInputV1';
2
2
  export declare class AddPermissionsToUserV1Input {
3
- 'permissions'?: Array<PermissionInputV1>;
3
+ 'permissions': Array<PermissionInputV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,5 +1,5 @@
1
1
  export declare class AddSourceToTrackingPlanV1Input {
2
- 'sourceId'?: string;
2
+ 'sourceId': string;
3
3
  static discriminator: string | undefined;
4
4
  static attributeTypeMap: Array<{
5
5
  name: string;
@@ -1,5 +1,5 @@
1
1
  export declare class AddUsersToUserGroupV1Input {
2
- 'emails'?: Array<string>;
2
+ 'emails': Array<string>;
3
3
  static discriminator: string | undefined;
4
4
  static attributeTypeMap: Array<{
5
5
  name: string;
@@ -1,7 +1,7 @@
1
1
  export declare class CreateCloudSourceRegulationV1Input {
2
2
  'regulationType': CreateCloudSourceRegulationV1Input.RegulationTypeEnum;
3
- 'subjectType'?: CreateCloudSourceRegulationV1Input.SubjectTypeEnum;
4
- 'subjectIds'?: Array<string>;
3
+ 'subjectType': CreateCloudSourceRegulationV1Input.SubjectTypeEnum;
4
+ 'subjectIds': Array<string>;
5
5
  'collection': string;
6
6
  static discriminator: string | undefined;
7
7
  static attributeTypeMap: Array<{
@@ -1,9 +1,9 @@
1
1
  import { DestinationFilterActionV1 } from './destinationFilterActionV1';
2
2
  export declare class CreateFilterForDestinationV1Input {
3
- 'sourceId'?: string;
3
+ 'sourceId': string;
4
4
  'if': string;
5
5
  'actions': Array<DestinationFilterActionV1>;
6
- 'title'?: string;
6
+ 'title': string;
7
7
  'description'?: string;
8
8
  'enabled': boolean;
9
9
  static discriminator: string | undefined;
@@ -1,7 +1,7 @@
1
1
  export declare class CreateSourceRegulationV1Input {
2
2
  'regulationType': CreateSourceRegulationV1Input.RegulationTypeEnum;
3
- 'subjectType'?: CreateSourceRegulationV1Input.SubjectTypeEnum;
4
- 'subjectIds'?: Array<string>;
3
+ 'subjectType': CreateSourceRegulationV1Input.SubjectTypeEnum;
4
+ 'subjectIds': Array<string>;
5
5
  static discriminator: string | undefined;
6
6
  static attributeTypeMap: Array<{
7
7
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { Schedule1 } from './schedule1';
2
2
  export declare class ReplaceAdvancedSyncScheduleForWarehouseV1Input {
3
- 'enabled'?: boolean;
3
+ 'enabled': boolean;
4
4
  'schedule'?: Schedule1;
5
5
  static discriminator: string | undefined;
6
6
  static attributeTypeMap: Array<{
@@ -1,6 +1,6 @@
1
1
  import { LabelV1 } from './labelV1';
2
2
  export declare class ReplaceLabelsInSourceV1Input {
3
- 'labels'?: Array<LabelV1>;
3
+ 'labels': Array<LabelV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { PermissionInputV1 } from './permissionInputV1';
2
2
  export declare class ReplacePermissionsForUserGroupV1Input {
3
- 'permissions'?: Array<PermissionInputV1>;
3
+ 'permissions': Array<PermissionInputV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { PermissionInputV1 } from './permissionInputV1';
2
2
  export declare class ReplacePermissionsForUserV1Input {
3
- 'permissions'?: Array<PermissionInputV1>;
3
+ 'permissions': Array<PermissionInputV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { RuleV1 } from './ruleV1';
2
2
  export declare class ReplaceRulesInTrackingPlanV1Input {
3
- 'rules'?: Array<RuleV1>;
3
+ 'rules': Array<RuleV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,5 +1,5 @@
1
1
  export declare class ReplaceUsersInUserGroupV1Input {
2
- 'emails'?: Array<string>;
2
+ 'emails': Array<string>;
3
3
  static discriminator: string | undefined;
4
4
  static attributeTypeMap: Array<{
5
5
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { UpsertRuleV1 } from './upsertRuleV1';
2
2
  export declare class UpdateRulesInTrackingPlanV1Input {
3
- 'rules'?: Array<UpsertRuleV1>;
3
+ 'rules': Array<UpsertRuleV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { WarehouseSyncOverrideV1 } from './warehouseSyncOverrideV1';
2
2
  export declare class UpdateSelectiveSyncForWarehouseV1Input {
3
- 'syncOverrides'?: Array<WarehouseSyncOverrideV1>;
3
+ 'syncOverrides': Array<WarehouseSyncOverrideV1>;
4
4
  static discriminator: string | undefined;
5
5
  static attributeTypeMap: Array<{
6
6
  name: string;
@@ -1,5 +1,5 @@
1
1
  export declare class UpdateUserGroupV1Input {
2
- 'name'?: string;
2
+ 'name': string;
3
3
  static discriminator: string | undefined;
4
4
  static attributeTypeMap: Array<{
5
5
  name: string;
@@ -1,7 +1,7 @@
1
1
  export declare class UpdateWarehouseV1Input {
2
2
  'name'?: string | null;
3
3
  'enabled'?: boolean;
4
- 'settings'?: any | null;
4
+ 'settings': any | null;
5
5
  static discriminator: string | undefined;
6
6
  static attributeTypeMap: Array<{
7
7
  name: string;
@@ -20,7 +20,7 @@ export class AddLabelsToSourceV1Input {
20
20
  /**
21
21
  * The labels to associate with a Source.
22
22
  */
23
- 'labels'?: Array<LabelV1>;
23
+ 'labels': Array<LabelV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -20,7 +20,7 @@ export class AddPermissionsToUserGroupV1Input {
20
20
  /**
21
21
  * The permissions to add.
22
22
  */
23
- 'permissions'?: Array<PermissionInputV1>;
23
+ 'permissions': Array<PermissionInputV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -20,7 +20,7 @@ export class AddPermissionsToUserV1Input {
20
20
  /**
21
21
  * The permissions to add.
22
22
  */
23
- 'permissions'?: Array<PermissionInputV1>;
23
+ 'permissions': Array<PermissionInputV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -19,7 +19,7 @@ export class AddSourceToTrackingPlanV1Input {
19
19
  /**
20
20
  * The id of the Source associated with the Tracking Plan. Config API note: analogous to `sourceName`.
21
21
  */
22
- 'sourceId'?: string;
22
+ 'sourceId': string;
23
23
 
24
24
  static discriminator: string | undefined = undefined;
25
25
 
@@ -19,7 +19,7 @@ export class AddUsersToUserGroupV1Input {
19
19
  /**
20
20
  * The email addresses of the users and invites to add.
21
21
  */
22
- 'emails'?: Array<string>;
22
+ 'emails': Array<string>;
23
23
 
24
24
  static discriminator: string | undefined = undefined;
25
25
 
@@ -23,11 +23,11 @@ export class CreateCloudSourceRegulationV1Input {
23
23
  /**
24
24
  * The subject type. Must be `objectId` for Cloud Sources.
25
25
  */
26
- 'subjectType'?: CreateCloudSourceRegulationV1Input.SubjectTypeEnum;
26
+ 'subjectType': CreateCloudSourceRegulationV1Input.SubjectTypeEnum;
27
27
  /**
28
28
  * The user or object ids of the subjects to regulate. Config API note: equal to `parent` but allows an array.
29
29
  */
30
- 'subjectIds'?: Array<string>;
30
+ 'subjectIds': Array<string>;
31
31
  /**
32
32
  * The Cloud Source collection to regulate.
33
33
  */
@@ -20,7 +20,7 @@ export class CreateFilterForDestinationV1Input {
20
20
  /**
21
21
  * The id of the Source associated with this filter.
22
22
  */
23
- 'sourceId'?: string;
23
+ 'sourceId': string;
24
24
  /**
25
25
  * The filter\'s condition.
26
26
  */
@@ -32,7 +32,7 @@ export class CreateFilterForDestinationV1Input {
32
32
  /**
33
33
  * The title of the filter.
34
34
  */
35
- 'title'?: string;
35
+ 'title': string;
36
36
  /**
37
37
  * The description of the filter.
38
38
  */
@@ -23,11 +23,11 @@ export class CreateSourceRegulationV1Input {
23
23
  /**
24
24
  * The subject type.
25
25
  */
26
- 'subjectType'?: CreateSourceRegulationV1Input.SubjectTypeEnum;
26
+ 'subjectType': CreateSourceRegulationV1Input.SubjectTypeEnum;
27
27
  /**
28
28
  * The user or object ids of the subjects to regulate. Config API note: equal to `parent` but allows an array.
29
29
  */
30
- 'subjectIds'?: Array<string>;
30
+ 'subjectIds': Array<string>;
31
31
 
32
32
  static discriminator: string | undefined = undefined;
33
33
 
@@ -20,7 +20,7 @@ export class ReplaceAdvancedSyncScheduleForWarehouseV1Input {
20
20
  /**
21
21
  * Enable to turn on an advanced sync schedule for the Warehouse.
22
22
  */
23
- 'enabled'?: boolean;
23
+ 'enabled': boolean;
24
24
  'schedule'?: Schedule1;
25
25
 
26
26
  static discriminator: string | undefined = undefined;
@@ -20,7 +20,7 @@ export class ReplaceLabelsInSourceV1Input {
20
20
  /**
21
21
  * The list of labels to replace in the Source.
22
22
  */
23
- 'labels'?: Array<LabelV1>;
23
+ 'labels': Array<LabelV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -20,7 +20,7 @@ export class ReplacePermissionsForUserGroupV1Input {
20
20
  /**
21
21
  * The permissions to replace with.
22
22
  */
23
- 'permissions'?: Array<PermissionInputV1>;
23
+ 'permissions': Array<PermissionInputV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -20,7 +20,7 @@ export class ReplacePermissionsForUserV1Input {
20
20
  /**
21
21
  * The permissions to add.
22
22
  */
23
- 'permissions'?: Array<PermissionInputV1>;
23
+ 'permissions': Array<PermissionInputV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -20,7 +20,7 @@ export class ReplaceRulesInTrackingPlanV1Input {
20
20
  /**
21
21
  * Rules to replace.
22
22
  */
23
- 'rules'?: Array<RuleV1>;
23
+ 'rules': Array<RuleV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -19,7 +19,7 @@ export class ReplaceUsersInUserGroupV1Input {
19
19
  /**
20
20
  * The email addresses of the users and invites to replace.
21
21
  */
22
- 'emails'?: Array<string>;
22
+ 'emails': Array<string>;
23
23
 
24
24
  static discriminator: string | undefined = undefined;
25
25
 
@@ -20,7 +20,7 @@ export class UpdateRulesInTrackingPlanV1Input {
20
20
  /**
21
21
  * Rules to update or insert.
22
22
  */
23
- 'rules'?: Array<UpsertRuleV1>;
23
+ 'rules': Array<UpsertRuleV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -20,7 +20,7 @@ export class UpdateSelectiveSyncForWarehouseV1Input {
20
20
  /**
21
21
  * A list of sync schema overrides to apply to this Warehouse.
22
22
  */
23
- 'syncOverrides'?: Array<WarehouseSyncOverrideV1>;
23
+ 'syncOverrides': Array<WarehouseSyncOverrideV1>;
24
24
 
25
25
  static discriminator: string | undefined = undefined;
26
26
 
@@ -19,7 +19,7 @@ export class UpdateUserGroupV1Input {
19
19
  /**
20
20
  * The intended value to rename the user group to.
21
21
  */
22
- 'name'?: string;
22
+ 'name': string;
23
23
 
24
24
  static discriminator: string | undefined = undefined;
25
25
 
@@ -27,7 +27,7 @@ export class UpdateWarehouseV1Input {
27
27
  /**
28
28
  * A key-value object that contains instance-specific settings for a Warehouse. Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata. You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint.
29
29
  */
30
- 'settings'?: any | null;
30
+ 'settings': any | null;
31
31
 
32
32
  static discriminator: string | undefined = undefined;
33
33
 
package/package.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "uuid": "^8.3.2",
19
19
  "request": "^2.88.2"
20
20
  },
21
- "version": "33.0.4-b5485",
21
+ "version": "33.0.4-b5506",
22
22
  "devDependencies": {
23
23
  "@types/bluebird": "^3.5.33",
24
24
  "@types/jest": "^29",