@segment/public-api-sdk-typescript 1.0.0 → 1.0.1

package/api/workspacesApi.ts

@@ -1,513 +0,0 @@
-/**
- * Segment Public API
- * 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.
- *
- * The version of the OpenAPI document: 32.0.1
- * Contact: friends@segment.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import localVarRequest from 'request';
-import http from 'http';
-
-/* tslint:disable:no-unused-locals */
-import { GetWorkspace200Response } from '../model/getWorkspace200Response';
-import { RequestErrorEnvelope } from '../model/requestErrorEnvelope';
-
-import {
-    ObjectSerializer,
-    Authentication,
-    VoidAuth,
-    Interceptor,
-} from '../model/models';
-import {
-    HttpBasicAuth,
-    HttpBearerAuth,
-    ApiKeyAuth,
-    OAuth,
-} from '../model/models';
-
-import { HttpError, RequestFile } from './apis';
-
-let defaultBasePath = 'https://api.segmentapis.com';
-
-// ===============================================
-// This file is autogenerated - Please do not edit
-// ===============================================
-
-export enum WorkspacesApiApiKeys {}
-
-export class WorkspacesApi {
-    protected _basePath = defaultBasePath;
-    protected _defaultHeaders: any = {};
-    protected _useQuerystring: boolean = false;
-
-    protected authentications = {
-        default: <Authentication>new VoidAuth(),
-        token: new HttpBearerAuth(),
-    };
-
-    protected interceptors: Interceptor[] = [];
-
-    constructor(basePath?: string);
-    constructor(
-        basePathOrUsername: string,
-        password?: string,
-        basePath?: string
-    ) {
-        if (password) {
-            if (basePath) {
-                this.basePath = basePath;
-            }
-        } else {
-            if (basePathOrUsername) {
-                this.basePath = basePathOrUsername;
-            }
-        }
-    }
-
-    set useQuerystring(value: boolean) {
-        this._useQuerystring = value;
-    }
-
-    set basePath(basePath: string) {
-        this._basePath = basePath;
-    }
-
-    set defaultHeaders(defaultHeaders: any) {
-        this._defaultHeaders = defaultHeaders;
-    }
-
-    get defaultHeaders() {
-        return this._defaultHeaders;
-    }
-
-    get basePath() {
-        return this._basePath;
-    }
-
-    public setDefaultAuthentication(auth: Authentication) {
-        this.authentications.default = auth;
-    }
-
-    public setApiKey(key: WorkspacesApiApiKeys, value: string) {
-        (this.authentications as any)[WorkspacesApiApiKeys[key]].apiKey = value;
-    }
-
-    set accessToken(accessToken: string | (() => string)) {
-        this.authentications.token.accessToken = accessToken;
-    }
-
-    public addInterceptor(interceptor: Interceptor) {
-        this.interceptors.push(interceptor);
-    }
-
-    /**
-     * Returns the Workspace associated with the token used to access this resource.
-     * @summary Get Workspace
-     */
-    public async getWorkspaceAlpha(
-        options: { headers: { [name: string]: string } } = { headers: {} }
-    ): Promise<{
-        response: http.IncomingMessage;
-        body: GetWorkspace200Response;
-    }> {
-        const localVarPath = this.basePath + '/';
-        let localVarQueryParameters: any = {};
-        let localVarHeaderParams: any = (<any>Object).assign(
-            {},
-            this._defaultHeaders
-        );
-        const produces = [
-            'application/vnd.segment.v1alpha+json',
-            'application/json',
-        ];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = produces[0];
-        } else {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        let localVarFormParams: any = {};
-
-        (<any>Object).assign(localVarHeaderParams, options.headers);
-
-        let localVarUseFormData = false;
-
-        let localVarRequestOptions: localVarRequest.Options = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-
-        let authenticationPromise = Promise.resolve();
-        if (this.authentications.token.accessToken) {
-            authenticationPromise = authenticationPromise.then(() =>
-                this.authentications.token.applyToRequest(
-                    localVarRequestOptions
-                )
-            );
-        }
-        authenticationPromise = authenticationPromise.then(() =>
-            this.authentications.default.applyToRequest(localVarRequestOptions)
-        );
-
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() =>
-                interceptor(localVarRequestOptions)
-            );
-        }
-
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    (<any>localVarRequestOptions).formData = localVarFormParams;
-                } else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise<{
-                response: http.IncomingMessage;
-                body: GetWorkspace200Response;
-            }>((resolve, reject) => {
-                localVarRequest(
-                    localVarRequestOptions,
-                    (error, response, body) => {
-                        if (error) {
-                            reject(error);
-                        } else {
-                            if (
-                                response.statusCode &&
-                                response.statusCode >= 200 &&
-                                response.statusCode <= 299
-                            ) {
-                                body = ObjectSerializer.deserialize(
-                                    body,
-                                    'GetWorkspace200Response'
-                                );
-                                resolve({ response: response, body: body });
-                            } else {
-                                reject(
-                                    new HttpError(
-                                        response,
-                                        body,
-                                        response.statusCode
-                                    )
-                                );
-                            }
-                        }
-                    }
-                );
-            });
-        });
-    }
-    /**
-     * Returns the Workspace associated with the token used to access this resource.
-     * @summary Get Workspace
-     */
-    public async getWorkspaceBeta(
-        options: { headers: { [name: string]: string } } = { headers: {} }
-    ): Promise<{
-        response: http.IncomingMessage;
-        body: GetWorkspace200Response;
-    }> {
-        const localVarPath = this.basePath + '/';
-        let localVarQueryParameters: any = {};
-        let localVarHeaderParams: any = (<any>Object).assign(
-            {},
-            this._defaultHeaders
-        );
-        const produces = [
-            'application/vnd.segment.v1beta+json',
-            'application/json',
-        ];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = produces[0];
-        } else {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        let localVarFormParams: any = {};
-
-        (<any>Object).assign(localVarHeaderParams, options.headers);
-
-        let localVarUseFormData = false;
-
-        let localVarRequestOptions: localVarRequest.Options = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-
-        let authenticationPromise = Promise.resolve();
-        if (this.authentications.token.accessToken) {
-            authenticationPromise = authenticationPromise.then(() =>
-                this.authentications.token.applyToRequest(
-                    localVarRequestOptions
-                )
-            );
-        }
-        authenticationPromise = authenticationPromise.then(() =>
-            this.authentications.default.applyToRequest(localVarRequestOptions)
-        );
-
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() =>
-                interceptor(localVarRequestOptions)
-            );
-        }
-
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    (<any>localVarRequestOptions).formData = localVarFormParams;
-                } else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise<{
-                response: http.IncomingMessage;
-                body: GetWorkspace200Response;
-            }>((resolve, reject) => {
-                localVarRequest(
-                    localVarRequestOptions,
-                    (error, response, body) => {
-                        if (error) {
-                            reject(error);
-                        } else {
-                            if (
-                                response.statusCode &&
-                                response.statusCode >= 200 &&
-                                response.statusCode <= 299
-                            ) {
-                                body = ObjectSerializer.deserialize(
-                                    body,
-                                    'GetWorkspace200Response'
-                                );
-                                resolve({ response: response, body: body });
-                            } else {
-                                reject(
-                                    new HttpError(
-                                        response,
-                                        body,
-                                        response.statusCode
-                                    )
-                                );
-                            }
-                        }
-                    }
-                );
-            });
-        });
-    }
-    /**
-     * Returns the Workspace associated with the token used to access this resource.
-     * @summary Get Workspace
-     */
-    public async getWorkspaceCurrent(
-        options: { headers: { [name: string]: string } } = { headers: {} }
-    ): Promise<{
-        response: http.IncomingMessage;
-        body: GetWorkspace200Response;
-    }> {
-        const localVarPath = this.basePath + '/';
-        let localVarQueryParameters: any = {};
-        let localVarHeaderParams: any = (<any>Object).assign(
-            {},
-            this._defaultHeaders
-        );
-        const produces = ['application/json'];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = produces[0];
-        } else {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        let localVarFormParams: any = {};
-
-        (<any>Object).assign(localVarHeaderParams, options.headers);
-
-        let localVarUseFormData = false;
-
-        let localVarRequestOptions: localVarRequest.Options = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-
-        let authenticationPromise = Promise.resolve();
-        if (this.authentications.token.accessToken) {
-            authenticationPromise = authenticationPromise.then(() =>
-                this.authentications.token.applyToRequest(
-                    localVarRequestOptions
-                )
-            );
-        }
-        authenticationPromise = authenticationPromise.then(() =>
-            this.authentications.default.applyToRequest(localVarRequestOptions)
-        );
-
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() =>
-                interceptor(localVarRequestOptions)
-            );
-        }
-
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    (<any>localVarRequestOptions).formData = localVarFormParams;
-                } else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise<{
-                response: http.IncomingMessage;
-                body: GetWorkspace200Response;
-            }>((resolve, reject) => {
-                localVarRequest(
-                    localVarRequestOptions,
-                    (error, response, body) => {
-                        if (error) {
-                            reject(error);
-                        } else {
-                            if (
-                                response.statusCode &&
-                                response.statusCode >= 200 &&
-                                response.statusCode <= 299
-                            ) {
-                                body = ObjectSerializer.deserialize(
-                                    body,
-                                    'GetWorkspace200Response'
-                                );
-                                resolve({ response: response, body: body });
-                            } else {
-                                reject(
-                                    new HttpError(
-                                        response,
-                                        body,
-                                        response.statusCode
-                                    )
-                                );
-                            }
-                        }
-                    }
-                );
-            });
-        });
-    }
-    /**
-     * Returns the Workspace associated with the token used to access this resource.
-     * @summary Get Workspace
-     */
-    public async getWorkspaceV1(
-        options: { headers: { [name: string]: string } } = { headers: {} }
-    ): Promise<{
-        response: http.IncomingMessage;
-        body: GetWorkspace200Response;
-    }> {
-        const localVarPath = this.basePath + '/';
-        let localVarQueryParameters: any = {};
-        let localVarHeaderParams: any = (<any>Object).assign(
-            {},
-            this._defaultHeaders
-        );
-        const produces = [
-            'application/vnd.segment.v1+json',
-            'application/json',
-        ];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = produces[0];
-        } else {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        let localVarFormParams: any = {};
-
-        (<any>Object).assign(localVarHeaderParams, options.headers);
-
-        let localVarUseFormData = false;
-
-        let localVarRequestOptions: localVarRequest.Options = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-
-        let authenticationPromise = Promise.resolve();
-        if (this.authentications.token.accessToken) {
-            authenticationPromise = authenticationPromise.then(() =>
-                this.authentications.token.applyToRequest(
-                    localVarRequestOptions
-                )
-            );
-        }
-        authenticationPromise = authenticationPromise.then(() =>
-            this.authentications.default.applyToRequest(localVarRequestOptions)
-        );
-
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() =>
-                interceptor(localVarRequestOptions)
-            );
-        }
-
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    (<any>localVarRequestOptions).formData = localVarFormParams;
-                } else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise<{
-                response: http.IncomingMessage;
-                body: GetWorkspace200Response;
-            }>((resolve, reject) => {
-                localVarRequest(
-                    localVarRequestOptions,
-                    (error, response, body) => {
-                        if (error) {
-                            reject(error);
-                        } else {
-                            if (
-                                response.statusCode &&
-                                response.statusCode >= 200 &&
-                                response.statusCode <= 299
-                            ) {
-                                body = ObjectSerializer.deserialize(
-                                    body,
-                                    'GetWorkspace200Response'
-                                );
-                                resolve({ response: response, body: body });
-                            } else {
-                                reject(
-                                    new HttpError(
-                                        response,
-                                        body,
-                                        response.statusCode
-                                    )
-                                );
-                            }
-                        }
-                    }
-                );
-            });
-        });
-    }
-}

package/api.ts

@@ -1,3 +0,0 @@
-// This is the entrypoint for the package
-export * from './api/apis';
-export * from './model/models';

package/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-    roots: ['<rootDir>/tests'],
-    testTimeout: 1000,
-    testRegex: 'tests/(.+)\\.test\\.(jsx?|tsx?)$',
-    transform: {
-        '^.+\\.tsx?$': 'ts-jest',
-    },
-    testEnvironment: 'node',
-    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-};

package/model/aPICallSnapshotV1.ts

@@ -1,50 +0,0 @@
-/**
- * Segment Public API
- * 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.
- *
- * The version of the OpenAPI document: 32.0.1
- * Contact: friends@segment.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { RequestFile } from './models';
-
-/**
- * A snapshot of the number of API calls for a given Workspace.
- */
-export class APICallSnapshotV1 {
-    /**
-     * A bigint of the number of API calls in this snapshot.
-     */
-    'apiCalls': string;
-    /**
-     * Timestamp of this snapshot within the billing cycle in the ISO-8601 format.
-     */
-    'timestamp': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'apiCalls',
-            baseName: 'apiCalls',
-            type: 'string',
-        },
-        {
-            name: 'timestamp',
-            baseName: 'timestamp',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return APICallSnapshotV1.attributeTypeMap;
-    }
-}

package/model/accessPermissionV1.ts

@@ -1,60 +0,0 @@
-/**
- * Segment Public API
- * 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.
- *
- * The version of the OpenAPI document: 32.0.1
- * Contact: friends@segment.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { RequestFile } from './models';
-import { PermissionResourceV1 } from './permissionResourceV1';
-
-/**
- * A permission governing access to a resource.
- */
-export class AccessPermissionV1 {
-    /**
-     * The id of the role that applies to this permission.
-     */
-    'roleId': string;
-    /**
-     * The name of the role that applies to this permission.
-     */
-    'roleName': string;
-    /**
-     * The resources included with this permission.
-     */
-    'resources': Array<PermissionResourceV1>;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'roleId',
-            baseName: 'roleId',
-            type: 'string',
-        },
-        {
-            name: 'roleName',
-            baseName: 'roleName',
-            type: 'string',
-        },
-        {
-            name: 'resources',
-            baseName: 'resources',
-            type: 'Array<PermissionResourceV1>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return AccessPermissionV1.attributeTypeMap;
-    }
-}

package/model/addConnectionFromSourceToWarehouse200Response.ts

@@ -1,36 +0,0 @@
-/**
- * Segment Public API
- * 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.
- *
- * The version of the OpenAPI document: 32.0.1
- * Contact: friends@segment.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import { RequestFile } from './models';
-import { AddConnectionFromSourceToWarehouseV1Output } from './addConnectionFromSourceToWarehouseV1Output';
-
-export class AddConnectionFromSourceToWarehouse200Response {
-    'data'?: AddConnectionFromSourceToWarehouseV1Output;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'data',
-            baseName: 'data',
-            type: 'AddConnectionFromSourceToWarehouseV1Output',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return AddConnectionFromSourceToWarehouse200Response.attributeTypeMap;
-    }
-}