@segment/public-api-sdk-typescript 1.0.1 → 1.0.2-b1

package/model/createSourceAlphaInput.ts

@@ -0,0 +1,77 @@
+/**
+ * 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.2
+ * 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 Source based on a set of parameters.
+ */
+export class CreateSourceAlphaInput {
+    /**
+     * The slug by which to identify the Source in the Segment app.
+     */
+    'slug': string;
+    /**
+     * Enable to allow this Source to send data. Defaults to true.
+     */
+    'enabled': boolean;
+    /**
+     * An optional human-readable name for this Source.
+     */
+    'name'?: string;
+    /**
+     * The id of the Source metadata from which this instance of the Source derives.  All Source metadata is available under `/catalog/sources`.
+     */
+    'metadataId': string;
+    /**
+     * A key-value object that contains instance-specific settings for the Source.
+     */
+    'settings'?: any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'metadataId',
+            baseName: 'metadataId',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceAlphaInput.attributeTypeMap;
+    }
+}

package/model/createSourceAlphaOutput.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.2
+ * 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 { Source2 } from './source2';
+
+/**
+ * Returns the newly Source.
+ */
+export class CreateSourceAlphaOutput {
+    'source': Source2;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'source',
+            baseName: 'source',
+            type: 'Source2',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceAlphaOutput.attributeTypeMap;
+    }
+}

package/model/createSourceRegulation200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.2
+ * 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 { CreateSourceRegulationV1Output } from './createSourceRegulationV1Output';
+
+export class CreateSourceRegulation200Response {
+    'data'?: CreateSourceRegulationV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateSourceRegulationV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceRegulation200Response.attributeTypeMap;
+    }
+}

package/model/createSourceRegulationV1Input.ts

@@ -0,0 +1,73 @@
+/**
+ * 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.2
+ * 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 Source-scoped regulation.
+ */
+export class CreateSourceRegulationV1Input {
+    /**
+     * The regulation type to create.
+     */
+    'regulationType': CreateSourceRegulationV1Input.RegulationTypeEnum;
+    /**
+     * The subject type.
+     */
+    'subjectType'?: CreateSourceRegulationV1Input.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: 'CreateSourceRegulationV1Input.RegulationTypeEnum',
+        },
+        {
+            name: 'subjectType',
+            baseName: 'subjectType',
+            type: 'CreateSourceRegulationV1Input.SubjectTypeEnum',
+        },
+        {
+            name: 'subjectIds',
+            baseName: 'subjectIds',
+            type: 'Array<string>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceRegulationV1Input.attributeTypeMap;
+    }
+}
+
+export namespace CreateSourceRegulationV1Input {
+    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 {
+        USER_ID = <any>'USER_ID',
+    }
+}

package/model/createSourceRegulationV1Output.ts

@@ -0,0 +1,41 @@
+/**
+ * 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.2
+ * 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 output of a create Source regulation call.
+ */
+export class CreateSourceRegulationV1Output {
+    /**
+     * The id of the created regulation.
+     */
+    'regulateId': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'regulateId',
+            baseName: 'regulateId',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceRegulationV1Output.attributeTypeMap;
+    }
+}

package/model/createSourceV1Input.ts

@@ -0,0 +1,68 @@
+/**
+ * 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.2
+ * 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 Source based on a set of parameters.
+ */
+export class CreateSourceV1Input {
+    /**
+     * The slug by which to identify the Source in the Segment app.
+     */
+    'slug': string;
+    /**
+     * Enable to allow this Source to send data. Defaults to true.
+     */
+    'enabled': boolean;
+    /**
+     * The id of the Source metadata from which this instance of the Source derives.  All Source metadata is available under `/catalog/sources`.
+     */
+    'metadataId': string;
+    /**
+     * A key-value object that contains instance-specific settings for the Source.
+     */
+    'settings'?: any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'metadataId',
+            baseName: 'metadataId',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceV1Input.attributeTypeMap;
+    }
+}

package/model/createSourceV1Output.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.2
+ * 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 { Source5 } from './source5';
+
+/**
+ * Returns a newly created Source.
+ */
+export class CreateSourceV1Output {
+    'source': Source5;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'source',
+            baseName: 'source',
+            type: 'Source5',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateSourceV1Output.attributeTypeMap;
+    }
+}

package/model/createTrackingPlan200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.2
+ * 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 { CreateTrackingPlanV1Output } from './createTrackingPlanV1Output';
+
+export class CreateTrackingPlan200Response {
+    'data'?: CreateTrackingPlanV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateTrackingPlanV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateTrackingPlan200Response.attributeTypeMap;
+    }
+}

package/model/createTrackingPlanV1Input.ts

@@ -0,0 +1,68 @@
+/**
+ * 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.2
+ * 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 Tracking Plan in the Workspace.
+ */
+export class CreateTrackingPlanV1Input {
+    /**
+     * The Tracking Plan\'s name.  Config API note: equal to `displayName`.
+     */
+    'name': string;
+    /**
+     * The Tracking Plan\'s description.
+     */
+    'description'?: string;
+    /**
+     * The Tracking Plan\'s type.
+     */
+    'type': CreateTrackingPlanV1Input.TypeEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'CreateTrackingPlanV1Input.TypeEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateTrackingPlanV1Input.attributeTypeMap;
+    }
+}
+
+export namespace CreateTrackingPlanV1Input {
+    export enum TypeEnum {
+        LIVE = <any>'LIVE',
+        PROPERTY_LIBRARY = <any>'PROPERTY_LIBRARY',
+        RULE_LIBRARY = <any>'RULE_LIBRARY',
+        TEMPLATE = <any>'TEMPLATE',
+    }
+}

package/model/createTrackingPlanV1Output.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.2
+ * 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 { TrackingPlan1 } from './trackingPlan1';
+
+/**
+ * Result of a CreateTrackingPlan call.
+ */
+export class CreateTrackingPlanV1Output {
+    'trackingPlan': TrackingPlan1;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'trackingPlan',
+            baseName: 'trackingPlan',
+            type: 'TrackingPlan1',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateTrackingPlanV1Output.attributeTypeMap;
+    }
+}

package/model/createTransformation200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.2
+ * 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 { CreateTransformationBetaOutput } from './createTransformationBetaOutput';
+
+export class CreateTransformation200Response {
+    'data'?: CreateTransformationBetaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateTransformationBetaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateTransformation200Response.attributeTypeMap;
+    }
+}

package/model/createTransformationBetaInput.ts

@@ -0,0 +1,96 @@
+/**
+ * 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.2
+ * 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;
+    }
+}