@segment/public-api-sdk-typescript 50.2.0-b8883 → 50.2.0-b8889
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.
- package/api/reverseETLApi.ts +2 -2
- package/package.json +1 -1
package/api/reverseETLApi.ts
CHANGED
|
@@ -116,7 +116,7 @@ export class ReverseETLApi {
|
|
|
116
116
|
}
|
|
117
117
|
|
|
118
118
|
/**
|
|
119
|
-
* Triggers a manual sync for a Reverse ETL Connection. 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.
|
|
119
|
+
* Triggers a manual sync for a Reverse ETL Connection. In the request body, the `subscriptionId` is the id that follows after `/mappings/` portion in the URL of the sync. For example, the `subscriptionId` would be `2` for this sync: https://app.Segment.com/example-workspace/reverse-etl/destinations/example-destination/sources/example-source/instances/1/mappings/2/source-id/3/model-id/4/sync-details 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.
|
|
120
120
|
* @summary Create Reverse ETL Manual Sync
|
|
121
121
|
* @param CreateReverseETLManualSyncInput
|
|
122
122
|
*/
|
|
@@ -471,7 +471,7 @@ export class ReverseETLApi {
|
|
|
471
471
|
});
|
|
472
472
|
}
|
|
473
473
|
/**
|
|
474
|
-
* Get the sync status for a Reverse ETL sync.
|
|
474
|
+
* Get the sync status for a Reverse ETL sync. The sync status includes all detailed information about the sync - sync status, duration, details about the extract and load phase if applicable, etc. The rate limit for this endpoint is 250 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.
|
|
475
475
|
* @summary Get Reverse ETL Sync Status
|
|
476
476
|
* @param modelId
|
|
477
477
|
* @param syncId
|