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

package/model/createTransformationBetaInput.ts

@@ -1,96 +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 { PropertyRenameBeta } from './propertyRenameBeta';
-
-/**
- * The input to create a Transformation.
- */
-export class CreateTransformationBetaInput {
-    /**
-     * The name of the Transformation.
-     */
-    'name': string;
-    /**
-     * The Source to be associated with the Transformation.
-     */
-    'sourceId': string;
-    /**
-     * The optional Destination metadata id to be associated with the Transformation.
-     */
-    'destinationMetadataId'?: string;
-    /**
-     * If the Transformation should be enabled.
-     */
-    'enabled': boolean;
-    /**
-     * If statement ([FQL](https://segment.com/docs/config-api/fql/)) to match events.  For standard event matchers, use the following:   Track -\\> \"event=\'\\<eventName\\>\'\"   Identify -\\> \"type=\'identify\'\"   Group -\\> \"type=\'group\'\"
-     */
-    'if': string;
-    /**
-     * Optional new event name for renaming events. Works only for \'track\' event type.
-     */
-    'newEventName'?: string;
-    /**
-     * Optional array for renaming properties collected by your events.
-     */
-    'propertyRenames'?: Array<PropertyRenameBeta>;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-        {
-            name: 'sourceId',
-            baseName: 'sourceId',
-            type: 'string',
-        },
-        {
-            name: 'destinationMetadataId',
-            baseName: 'destinationMetadataId',
-            type: 'string',
-        },
-        {
-            name: 'enabled',
-            baseName: 'enabled',
-            type: 'boolean',
-        },
-        {
-            name: 'if',
-            baseName: 'if',
-            type: 'string',
-        },
-        {
-            name: 'newEventName',
-            baseName: 'newEventName',
-            type: 'string',
-        },
-        {
-            name: 'propertyRenames',
-            baseName: 'propertyRenames',
-            type: 'Array<PropertyRenameBeta>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateTransformationBetaInput.attributeTypeMap;
-    }
-}

package/model/createTransformationBetaOutput.ts

@@ -1,39 +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 { Transformation2 } from './transformation2';
-
-/**
- * The output of a created Transformation.
- */
-export class CreateTransformationBetaOutput {
-    'transformation': Transformation2;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'transformation',
-            baseName: 'transformation',
-            type: 'Transformation2',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateTransformationBetaOutput.attributeTypeMap;
-    }
-}

package/model/createUserGroup200Response.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 { CreateUserGroupV1Output } from './createUserGroupV1Output';
-
-export class CreateUserGroup200Response {
-    'data'?: CreateUserGroupV1Output;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'data',
-            baseName: 'data',
-            type: 'CreateUserGroupV1Output',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateUserGroup200Response.attributeTypeMap;
-    }
-}

package/model/createUserGroupV1Input.ts

@@ -1,41 +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';
-
-/**
- * Creates a user group, used to bundle permissions for its members, within a Workspace.
- */
-export class CreateUserGroupV1Input {
-    /**
-     * The name of the user group to create.
-     */
-    'name': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateUserGroupV1Input.attributeTypeMap;
-    }
-}

package/model/createUserGroupV1Output.ts

@@ -1,39 +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 { UserGroup } from './userGroup';
-
-/**
- * Returns the newly created user group.
- */
-export class CreateUserGroupV1Output {
-    'userGroup': UserGroup;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'userGroup',
-            baseName: 'userGroup',
-            type: 'UserGroup',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateUserGroupV1Output.attributeTypeMap;
-    }
-}

package/model/createValidationInWarehouse200Response.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 { CreateValidationInWarehouseV1Output } from './createValidationInWarehouseV1Output';
-
-export class CreateValidationInWarehouse200Response {
-    'data'?: CreateValidationInWarehouseV1Output;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'data',
-            baseName: 'data',
-            type: 'CreateValidationInWarehouseV1Output',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateValidationInWarehouse200Response.attributeTypeMap;
-    }
-}

package/model/createValidationInWarehouseV1Input.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';
-
-/**
- * Verifies a set of Warehouse credentials by attempting to connect to it.
- */
-export class CreateValidationInWarehouseV1Input {
-    /**
-     * The id of the Warehouse metadata type.
-     */
-    'metadataId': string;
-    /**
-     * The settings to check.
-     */
-    'settings': any;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'metadataId',
-            baseName: 'metadataId',
-            type: 'string',
-        },
-        {
-            name: 'settings',
-            baseName: 'settings',
-            type: 'any',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateValidationInWarehouseV1Input.attributeTypeMap;
-    }
-}

package/model/createValidationInWarehouseV1Output.ts

@@ -1,48 +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';
-
-/**
- * Returns the status of a Warehouse connection settings after an attempt to connect to it.
- */
-export class CreateValidationInWarehouseV1Output {
-    /**
-     * Represents the status for the current connection settings.
-     */
-    'status': CreateValidationInWarehouseV1Output.StatusEnum;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'status',
-            baseName: 'status',
-            type: 'CreateValidationInWarehouseV1Output.StatusEnum',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateValidationInWarehouseV1Output.attributeTypeMap;
-    }
-}
-
-export namespace CreateValidationInWarehouseV1Output {
-    export enum StatusEnum {
-        CONNECTED = <any>'CONNECTED',
-        FAILED = <any>'FAILED',
-    }
-}

package/model/createWarehouse200Response.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 { CreateWarehouseV1Output } from './createWarehouseV1Output';
-
-export class CreateWarehouse200Response {
-    'data'?: CreateWarehouseV1Output;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'data',
-            baseName: 'data',
-            type: 'CreateWarehouseV1Output',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateWarehouse200Response.attributeTypeMap;
-    }
-}

package/model/createWarehouseV1Input.ts

@@ -1,68 +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';
-
-/**
- * Create a new Warehouse based on a set of parameters.
- */
-export class CreateWarehouseV1Input {
-    /**
-     * The Warehouse metadata to use.
-     */
-    'metadataId': string;
-    /**
-     * An optional human-readable name for this Warehouse.
-     */
-    'name'?: string;
-    /**
-     * Enable to allow this Warehouse to receive data. Defaults to true.
-     */
-    'enabled'?: boolean;
-    /**
-     * 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.
-     */
-    'settings': any;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'metadataId',
-            baseName: 'metadataId',
-            type: 'string',
-        },
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-        {
-            name: 'enabled',
-            baseName: 'enabled',
-            type: 'boolean',
-        },
-        {
-            name: 'settings',
-            baseName: 'settings',
-            type: 'any',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateWarehouseV1Input.attributeTypeMap;
-    }
-}

package/model/createWarehouseV1Output.ts

@@ -1,39 +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 { Warehouse1 } from './warehouse1';
-
-/**
- * Returns the newly created Warehouse.
- */
-export class CreateWarehouseV1Output {
-    'warehouse': Warehouse1;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'warehouse',
-            baseName: 'warehouse',
-            type: 'Warehouse1',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateWarehouseV1Output.attributeTypeMap;
-    }
-}

package/model/createWorkspaceRegulation200Response.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 { CreateWorkspaceRegulationV1Output } from './createWorkspaceRegulationV1Output';
-
-export class CreateWorkspaceRegulation200Response {
-    'data'?: CreateWorkspaceRegulationV1Output;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'data',
-            baseName: 'data',
-            type: 'CreateWorkspaceRegulationV1Output',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateWorkspaceRegulation200Response.attributeTypeMap;
-    }
-}

package/model/createWorkspaceRegulationV1Input.ts

@@ -1,74 +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';
-
-/**
- * The input to create a Workspace regulation.
- */
-export class CreateWorkspaceRegulationV1Input {
-    /**
-     * The regulation type to create.
-     */
-    'regulationType': CreateWorkspaceRegulationV1Input.RegulationTypeEnum;
-    /**
-     * The subject type. Use `objectId` for Cloud Source regulations.
-     */
-    'subjectType': CreateWorkspaceRegulationV1Input.SubjectTypeEnum;
-    /**
-     * The user or object ids of the subjects to regulate.  Config API note: equal to `parent` but allows an array.
-     */
-    'subjectIds': Array<string>;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'regulationType',
-            baseName: 'regulationType',
-            type: 'CreateWorkspaceRegulationV1Input.RegulationTypeEnum',
-        },
-        {
-            name: 'subjectType',
-            baseName: 'subjectType',
-            type: 'CreateWorkspaceRegulationV1Input.SubjectTypeEnum',
-        },
-        {
-            name: 'subjectIds',
-            baseName: 'subjectIds',
-            type: 'Array<string>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return CreateWorkspaceRegulationV1Input.attributeTypeMap;
-    }
-}
-
-export namespace CreateWorkspaceRegulationV1Input {
-    export enum RegulationTypeEnum {
-        BULK_DELETE_ONLY = <any>'BULK_DELETE_ONLY',
-        DELETE_INTERNAL = <any>'DELETE_INTERNAL',
-        DELETE_ONLY = <any>'DELETE_ONLY',
-        SUPPRESS_ONLY = <any>'SUPPRESS_ONLY',
-        SUPPRESS_WITH_DELETE = <any>'SUPPRESS_WITH_DELETE',
-        UNSUPPRESS = <any>'UNSUPPRESS',
-    }
-    export enum SubjectTypeEnum {
-        OBJECT_ID = <any>'OBJECT_ID',
-        USER_ID = <any>'USER_ID',
-    }
-}