Skip to content

Commit c3a3b18

Browse files
author
APIs and Common Services team
committed
Automated SDK update
This updates the SDK from internal repo commit segmentio/public-api@32694df2.
1 parent c7ed2dd commit c3a3b18

File tree

702 files changed

+1191
-714
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

702 files changed

+1191
-714
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ All endpoints in the API follow REST conventions and use standard HTTP methods.
1010

1111
See the next sections for more information on how to use the Segment Public API TypeScript SDK.
1212

13-
Latest API and SDK version: 59.6.1
13+
Latest API and SDK version: 59.7.0
1414

1515
## Installation
1616

‎api/aPICallsApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎api/activationsApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎api/apis.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ export function configureApis(
171171

172172
for (const k of Object.keys(apis)) {
173173
const key = k as keyof typeof apis;
174-
headers['User-Agent'] = 'Public API SDK 59.6.1 (TypeScript)';
174+
headers['User-Agent'] = 'Public API SDK 59.7.0 (TypeScript)';
175175
apis[key].accessToken = token;
176176
apis[key].defaultHeaders = headers;
177177
}
@@ -218,7 +218,7 @@ export function configureEuApis(
218218

219219
for (const k of Object.keys(apis)) {
220220
const key = k as keyof typeof apis;
221-
headers['User-Agent'] = 'Public API SDK 59.6.1 (TypeScript)';
221+
headers['User-Agent'] = 'Public API SDK 59.7.0 (TypeScript)';
222222
apis[key].accessToken = token;
223223
apis[key].defaultHeaders = headers;
224224
}

‎api/audiencesApi.ts‎

Lines changed: 133 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,6 +24,7 @@ import { CreateAudiencePreview200Response } from '../model/createAudiencePreview
2424
import { CreateAudiencePreview200Response1 } from '../model/createAudiencePreview200Response1';
2525
import { CreateAudiencePreviewAlphaInput } from '../model/createAudiencePreviewAlphaInput';
2626
import { CreateAudiencePreviewBetaInput } from '../model/createAudiencePreviewBetaInput';
27+
import { ForceExecuteAudienceRun200Response } from '../model/forceExecuteAudienceRun200Response';
2728
import { GetAudience200Response } from '../model/getAudience200Response';
2829
import { GetAudience200Response1 } from '../model/getAudience200Response1';
2930
import { GetAudiencePreview200Response } from '../model/getAudiencePreview200Response';
@@ -547,6 +548,137 @@ export class AudiencesApi {
547548
});
548549
});
549550
}
551+
/**
552+
* The ability to force execute a run for an Audience is limited to Linked Audiences (audienceType = `LINKED`). • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Audience Run Forced` event in the [audit trail](/tag/Audit-Trail).
553+
* @summary Force Execute Audience Run
554+
* @param spaceId
555+
* @param audienceId
556+
*/
557+
public async forceExecuteAudienceRun(
558+
spaceId: string,
559+
audienceId: string,
560+
options: { headers: { [name: string]: string } } = { headers: {} }
561+
): Promise<{
562+
response: http.IncomingMessage;
563+
body: ForceExecuteAudienceRun200Response;
564+
}> {
565+
const localVarPath =
566+
this.basePath +
567+
'/spaces/{spaceId}/audiences/{audienceId}/runs'
568+
.replace(
569+
'{' + 'spaceId' + '}',
570+
encodeURIComponent(String(spaceId))
571+
)
572+
.replace(
573+
'{' + 'audienceId' + '}',
574+
encodeURIComponent(String(audienceId))
575+
);
576+
let localVarQueryParameters: any = {};
577+
let localVarHeaderParams: any = (<any>Object).assign(
578+
{},
579+
this._defaultHeaders
580+
);
581+
const produces = [
582+
'application/vnd.segment.v1alpha+json',
583+
'application/json',
584+
];
585+
// give precedence to 'application/json'
586+
if (produces.indexOf('application/json') >= 0) {
587+
localVarHeaderParams.Accept = 'application/json';
588+
} else {
589+
localVarHeaderParams.Accept = produces.join(',');
590+
}
591+
let localVarFormParams: any = {};
592+
593+
// verify required parameter 'spaceId' is not null or undefined
594+
if (spaceId === null || spaceId === undefined) {
595+
throw new Error(
596+
'Required parameter spaceId was null or undefined when calling forceExecuteAudienceRun.'
597+
);
598+
}
599+
600+
// verify required parameter 'audienceId' is not null or undefined
601+
if (audienceId === null || audienceId === undefined) {
602+
throw new Error(
603+
'Required parameter audienceId was null or undefined when calling forceExecuteAudienceRun.'
604+
);
605+
}
606+
607+
(<any>Object).assign(localVarHeaderParams, options.headers);
608+
609+
let localVarUseFormData = false;
610+
611+
let localVarRequestOptions: localVarRequest.Options = {
612+
method: 'POST',
613+
qs: localVarQueryParameters,
614+
headers: localVarHeaderParams,
615+
uri: localVarPath,
616+
useQuerystring: this._useQuerystring,
617+
json: true,
618+
};
619+
620+
let authenticationPromise = Promise.resolve();
621+
if (this.authentications.token.accessToken) {
622+
authenticationPromise = authenticationPromise.then(() =>
623+
this.authentications.token.applyToRequest(
624+
localVarRequestOptions
625+
)
626+
);
627+
}
628+
authenticationPromise = authenticationPromise.then(() =>
629+
this.authentications.default.applyToRequest(localVarRequestOptions)
630+
);
631+
632+
let interceptorPromise = authenticationPromise;
633+
for (const interceptor of this.interceptors) {
634+
interceptorPromise = interceptorPromise.then(() =>
635+
interceptor(localVarRequestOptions)
636+
);
637+
}
638+
639+
return interceptorPromise.then(() => {
640+
if (Object.keys(localVarFormParams).length) {
641+
if (localVarUseFormData) {
642+
(<any>localVarRequestOptions).formData = localVarFormParams;
643+
} else {
644+
localVarRequestOptions.form = localVarFormParams;
645+
}
646+
}
647+
return new Promise<{
648+
response: http.IncomingMessage;
649+
body: ForceExecuteAudienceRun200Response;
650+
}>((resolve, reject) => {
651+
localVarRequest(
652+
localVarRequestOptions,
653+
(error, response, body) => {
654+
if (error) {
655+
reject(error);
656+
} else {
657+
if (
658+
response.statusCode &&
659+
response.statusCode >= 200 &&
660+
response.statusCode <= 299
661+
) {
662+
body = ObjectSerializer.deserialize(
663+
body,
664+
'ForceExecuteAudienceRun200Response'
665+
);
666+
resolve({ response: response, body: body });
667+
} else {
668+
reject(
669+
new HttpError(
670+
response,
671+
body,
672+
response.statusCode
673+
)
674+
);
675+
}
676+
}
677+
}
678+
);
679+
});
680+
});
681+
}
550682
/**
551683
* Returns the Audience by id and spaceId. Supports including audience schedules using `?include=schedules`. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to [email protected]. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 100 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.
552684
* @summary Get Audience

‎api/auditTrailApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎api/catalogApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎api/computedTraitsApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎api/customerInsightsApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎api/dbtApi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Segment Public API
33
* The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
44
*
5-
* The version of the OpenAPI document: 59.6.1
5+
* The version of the OpenAPI document: 59.7.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

0 commit comments

Comments
 (0)