@segment/public-api-sdk-typescript 50.2.0-b8883 → 50.2.0-b8890

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.
@@ -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. The sync status includes all detailed information about the sync, like 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.
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
@@ -1,5 +1,5 @@
1
1
  import { AudienceOptions } from './audienceOptions';
2
- import { Definition1 } from './definition1';
2
+ import { Definition } from './definition';
3
3
  export declare class AudienceSummary {
4
4
  'id': string;
5
5
  'spaceId': string;
@@ -7,7 +7,7 @@ export declare class AudienceSummary {
7
7
  'description'?: string;
8
8
  'key': string;
9
9
  'enabled': boolean;
10
- 'definition': Definition1 | null;
10
+ 'definition': Definition | null;
11
11
  'status'?: string;
12
12
  'createdBy': string;
13
13
  'updatedBy': string;
@@ -42,7 +42,7 @@ var AudienceSummary = (function () {
42
42
  {
43
43
  name: 'definition',
44
44
  baseName: 'definition',
45
- type: 'Definition1',
45
+ type: 'Definition',
46
46
  },
47
47
  {
48
48
  name: 'status',
@@ -1 +1 @@
1
- {"version":3,"file":"audienceSummary.js","sourceRoot":"","sources":["../../model/audienceSummary.ts"],"names":[],"mappings":";;;AAmBA;IAAA;IA6HA,CAAC;IAHU,mCAAmB,GAA1B;QACI,OAAO,eAAe,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IA5EM,6BAAa,GAAuB,SAAS,CAAC;IAE9C,gCAAgB,GAIlB;QACD;YACI,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,SAAS;SAClB;QACD;YACI,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,aAAa;SACtB;QACD;YACI,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,iBAAiB;SAC1B;KACJ,CAAC;IAKN,sBAAC;CAAA,AA7HD,IA6HC;AA7HY,0CAAe"}
1
+ {"version":3,"file":"audienceSummary.js","sourceRoot":"","sources":["../../model/audienceSummary.ts"],"names":[],"mappings":";;;AAmBA;IAAA;IA6HA,CAAC;IAHU,mCAAmB,GAA1B;QACI,OAAO,eAAe,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IA5EM,6BAAa,GAAuB,SAAS,CAAC;IAE9C,gCAAgB,GAIlB;QACD;YACI,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,SAAS;SAClB;QACD;YACI,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,YAAY;SACrB;QACD;YACI,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,iBAAiB;SAC1B;KACJ,CAAC;IAKN,sBAAC;CAAA,AA7HD,IA6HC;AA7HY,0CAAe"}
@@ -1,4 +1,4 @@
1
- import { Definition } from './definition';
1
+ import { Definition1 } from './definition1';
2
2
  import { TraitOptions } from './traitOptions';
3
3
  export declare class ComputedTraitSummary {
4
4
  'id': string;
@@ -7,7 +7,7 @@ export declare class ComputedTraitSummary {
7
7
  'description'?: string;
8
8
  'key': string;
9
9
  'enabled': boolean;
10
- 'definition': Definition | null;
10
+ 'definition': Definition1 | null;
11
11
  'status'?: string;
12
12
  'createdBy': string;
13
13
  'updatedBy': string;
@@ -42,7 +42,7 @@ var ComputedTraitSummary = (function () {
42
42
  {
43
43
  name: 'definition',
44
44
  baseName: 'definition',
45
- type: 'Definition',
45
+ type: 'Definition1',
46
46
  },
47
47
  {
48
48
  name: 'status',
@@ -1 +1 @@
1
- {"version":3,"file":"computedTraitSummary.js","sourceRoot":"","sources":["../../model/computedTraitSummary.ts"],"names":[],"mappings":";;;AAmBA;IAAA;IA6HA,CAAC;IAHU,wCAAmB,GAA1B;QACI,OAAO,oBAAoB,CAAC,gBAAgB,CAAC;IACjD,CAAC;IA5EM,kCAAa,GAAuB,SAAS,CAAC;IAE9C,qCAAgB,GAIlB;QACD;YACI,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,SAAS;SAClB;QACD;YACI,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,YAAY;SACrB;QACD;YACI,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,cAAc;SACvB;KACJ,CAAC;IAKN,2BAAC;CAAA,AA7HD,IA6HC;AA7HY,oDAAoB"}
1
+ {"version":3,"file":"computedTraitSummary.js","sourceRoot":"","sources":["../../model/computedTraitSummary.ts"],"names":[],"mappings":";;;AAmBA;IAAA;IA6HA,CAAC;IAHU,wCAAmB,GAA1B;QACI,OAAO,oBAAoB,CAAC,gBAAgB,CAAC;IACjD,CAAC;IA5EM,kCAAa,GAAuB,SAAS,CAAC;IAE9C,qCAAgB,GAIlB;QACD;YACI,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,SAAS;SAClB;QACD;YACI,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,aAAa;SACtB;QACD;YACI,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,WAAW;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD;YACI,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,cAAc;SACvB;KACJ,CAAC;IAKN,2BAAC;CAAA,AA7HD,IA6HC;AA7HY,oDAAoB"}
@@ -12,7 +12,7 @@
12
12
 
13
13
  import { RequestFile } from './models';
14
14
  import { AudienceOptions } from './audienceOptions';
15
- import { Definition1 } from './definition1';
15
+ import { Definition } from './definition';
16
16
 
17
17
  /**
18
18
  * Defines an Audience.
@@ -42,7 +42,7 @@ export class AudienceSummary {
42
42
  * Enabled/disabled status for the audience.
43
43
  */
44
44
  'enabled': boolean;
45
- 'definition': Definition1 | null;
45
+ 'definition': Definition | null;
46
46
  /**
47
47
  * Status for the audience. Possible values: Backfilling, Computing, Failed, Live, Awaiting Destinations, Disabled.
48
48
  */
@@ -105,7 +105,7 @@ export class AudienceSummary {
105
105
  {
106
106
  name: 'definition',
107
107
  baseName: 'definition',
108
- type: 'Definition1',
108
+ type: 'Definition',
109
109
  },
110
110
  {
111
111
  name: 'status',
@@ -11,7 +11,7 @@
11
11
  */
12
12
 
13
13
  import { RequestFile } from './models';
14
- import { Definition } from './definition';
14
+ import { Definition1 } from './definition1';
15
15
  import { TraitOptions } from './traitOptions';
16
16
 
17
17
  /**
@@ -42,7 +42,7 @@ export class ComputedTraitSummary {
42
42
  * Enabled/disabled status for the computed trait.
43
43
  */
44
44
  'enabled': boolean;
45
- 'definition': Definition | null;
45
+ 'definition': Definition1 | null;
46
46
  /**
47
47
  * Status for the computed trait. Possible values: Backfilling, Computing, Failed, Live, Awaiting Destinations, Disabled.
48
48
  */
@@ -105,7 +105,7 @@ export class ComputedTraitSummary {
105
105
  {
106
106
  name: 'definition',
107
107
  baseName: 'definition',
108
- type: 'Definition',
108
+ type: 'Definition1',
109
109
  },
110
110
  {
111
111
  name: 'status',
@@ -17,11 +17,11 @@ import { RequestFile } from './models';
17
17
  */
18
18
  export class Definition {
19
19
  /**
20
- * The query language string defining the computed trait aggregation criteria. For guidance on using the query language, see the [Segment documentation site](https://segment.com/docs/api/public-api/query-language).
20
+ * The query language string defining the audience segmentation criteria.
21
21
  */
22
22
  'query': string;
23
23
  /**
24
- * The underlying data type being aggregated for this computed trait. Possible values: users, accounts.
24
+ * The underlying data type being segmented for this audience. Possible values: users, accounts.
25
25
  */
26
26
  'type': Definition.TypeEnum;
27
27
 
@@ -17,11 +17,11 @@ import { RequestFile } from './models';
17
17
  */
18
18
  export class Definition1 {
19
19
  /**
20
- * The query language string defining the audience segmentation criteria.
20
+ * The query language string defining the computed trait aggregation criteria. For guidance on using the query language, see the [Segment documentation site](https://segment.com/docs/api/public-api/query-language).
21
21
  */
22
22
  'query': string;
23
23
  /**
24
- * The underlying data type being segmented for this audience. Possible values: users, accounts.
24
+ * The underlying data type being aggregated for this computed trait. Possible values: users, accounts.
25
25
  */
26
26
  'type': Definition1.TypeEnum;
27
27
 
package/package.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "uuid": "^8.3.2",
19
19
  "request": "^2.88.2"
20
20
  },
21
- "version": "50.2.0-b8883",
21
+ "version": "50.2.0-b8890",
22
22
  "devDependencies": {
23
23
  "@types/bluebird": "^3.5.33",
24
24
  "@types/jest": "^29",