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

package/model/trackSourceSettingsV1.ts

@@ -0,0 +1,82 @@
+/**
+ * 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';
+
+export class TrackSourceSettingsV1 {
+    /**
+     * Enable to allow unplanned track events.  Config API note: equal to `allowUnplannedTrackEvents`.
+     */
+    'allowUnplannedEvents'?: boolean;
+    /**
+     * Enable to allow unplanned track event properties.  Config API note: equal to `allowUnplannedTrackEventProperties`.
+     */
+    'allowUnplannedEventProperties'?: boolean;
+    /**
+     * Allow track event on violations.  Config API note: equal to `allowTrackEventOnViolations`.
+     */
+    'allowEventOnViolations'?: boolean;
+    /**
+     * Enable to allow track properties on violations.  Config API note: equal to `allowTrackEventPropertiesOnViolations`.
+     */
+    'allowPropertiesOnViolations'?: boolean;
+    /**
+     * The common track event on violations.  Config API note: equal to `commonTrackEventOnViolations`.
+     */
+    'commonEventOnViolations'?: TrackSourceSettingsV1.CommonEventOnViolationsEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'allowUnplannedEvents',
+            baseName: 'allowUnplannedEvents',
+            type: 'boolean',
+        },
+        {
+            name: 'allowUnplannedEventProperties',
+            baseName: 'allowUnplannedEventProperties',
+            type: 'boolean',
+        },
+        {
+            name: 'allowEventOnViolations',
+            baseName: 'allowEventOnViolations',
+            type: 'boolean',
+        },
+        {
+            name: 'allowPropertiesOnViolations',
+            baseName: 'allowPropertiesOnViolations',
+            type: 'boolean',
+        },
+        {
+            name: 'commonEventOnViolations',
+            baseName: 'commonEventOnViolations',
+            type: 'TrackSourceSettingsV1.CommonEventOnViolationsEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return TrackSourceSettingsV1.attributeTypeMap;
+    }
+}
+
+export namespace TrackSourceSettingsV1 {
+    export enum CommonEventOnViolationsEnum {
+        ALLOW = <any>'ALLOW',
+        BLOCK = <any>'BLOCK',
+        OMIT_PROPERTIES = <any>'OMIT_PROPERTIES',
+    }
+}

package/model/trackingPlan.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 requested Tracking Plan.
+ */
+export class TrackingPlan {
+    /**
+     * The Tracking Plan\'s identifier.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The Tracking Plan\'s name.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * URL-friendly slug of this Tracking Plan.  Config API note: equal to `name`.
+     */
+    'slug'?: string;
+    /**
+     * The Tracking Plan\'s description.
+     */
+    'description'?: string;
+    /**
+     * The Tracking Plan\'s type.
+     */
+    'type': TrackingPlan.TypeEnum;
+    /**
+     * The timestamp of the last change to the Tracking Plan.  Config API note: equal to `updateTime`.
+     */
+    'updatedAt'?: string;
+    /**
+     * The timestamp of this Tracking Plan\'s creation.  Config API note: equal to `createTime`.
+     */
+    'createdAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'TrackingPlan.TypeEnum',
+        },
+        {
+            name: 'updatedAt',
+            baseName: 'updatedAt',
+            type: 'string',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return TrackingPlan.attributeTypeMap;
+    }
+}
+
+export namespace TrackingPlan {
+    export enum TypeEnum {
+        LIVE = <any>'LIVE',
+        PROPERTY_LIBRARY = <any>'PROPERTY_LIBRARY',
+        RULE_LIBRARY = <any>'RULE_LIBRARY',
+        TEMPLATE = <any>'TEMPLATE',
+    }
+}

package/model/trackingPlan1.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 created Tracking Plan.
+ */
+export class TrackingPlan1 {
+    /**
+     * The Tracking Plan\'s identifier.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The Tracking Plan\'s name.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * URL-friendly slug of this Tracking Plan.  Config API note: equal to `name`.
+     */
+    'slug'?: string;
+    /**
+     * The Tracking Plan\'s description.
+     */
+    'description'?: string;
+    /**
+     * The Tracking Plan\'s type.
+     */
+    'type': TrackingPlan1.TypeEnum;
+    /**
+     * The timestamp of the last change to the Tracking Plan.  Config API note: equal to `updateTime`.
+     */
+    'updatedAt'?: string;
+    /**
+     * The timestamp of this Tracking Plan\'s creation.  Config API note: equal to `createTime`.
+     */
+    'createdAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'TrackingPlan1.TypeEnum',
+        },
+        {
+            name: 'updatedAt',
+            baseName: 'updatedAt',
+            type: 'string',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return TrackingPlan1.attributeTypeMap;
+    }
+}
+
+export namespace TrackingPlan1 {
+    export enum TypeEnum {
+        LIVE = <any>'LIVE',
+        PROPERTY_LIBRARY = <any>'PROPERTY_LIBRARY',
+        RULE_LIBRARY = <any>'RULE_LIBRARY',
+        TEMPLATE = <any>'TEMPLATE',
+    }
+}

package/model/trackingPlanV1.ts

@@ -0,0 +1,104 @@
+/**
+ * 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';
+
+/**
+ * Represents a Tracking Plan.
+ */
+export class TrackingPlanV1 {
+    /**
+     * The Tracking Plan\'s identifier.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The Tracking Plan\'s name.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * URL-friendly slug of this Tracking Plan.  Config API note: equal to `name`.
+     */
+    'slug'?: string;
+    /**
+     * The Tracking Plan\'s description.
+     */
+    'description'?: string;
+    /**
+     * The Tracking Plan\'s type.
+     */
+    'type': TrackingPlanV1.TypeEnum;
+    /**
+     * The timestamp of the last change to the Tracking Plan.  Config API note: equal to `updateTime`.
+     */
+    'updatedAt'?: string;
+    /**
+     * The timestamp of this Tracking Plan\'s creation.  Config API note: equal to `createTime`.
+     */
+    'createdAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'TrackingPlanV1.TypeEnum',
+        },
+        {
+            name: 'updatedAt',
+            baseName: 'updatedAt',
+            type: 'string',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return TrackingPlanV1.attributeTypeMap;
+    }
+}
+
+export namespace TrackingPlanV1 {
+    export enum TypeEnum {
+        LIVE = <any>'LIVE',
+        PROPERTY_LIBRARY = <any>'PROPERTY_LIBRARY',
+        RULE_LIBRARY = <any>'RULE_LIBRARY',
+        TEMPLATE = <any>'TEMPLATE',
+    }
+}

package/model/transformation.ts

@@ -0,0 +1,105 @@
+/**
+ * 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 retrieved Transformation.
+ */
+export class Transformation {
+    /**
+     * The id of the Transformation.
+     */
+    'id': string;
+    /**
+     * The name of the Transformation.
+     */
+    'name': string;
+    /**
+     * The Source associated with the Transformation.
+     */
+    'sourceId': string;
+    /**
+     * The optional Destination metadata associated with the Transformation.
+     */
+    'destinationMetadataId'?: string;
+    /**
+     * If the Transformation is 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: 'id',
+            baseName: 'id',
+            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 Transformation.attributeTypeMap;
+    }
+}

package/model/transformation1.ts

@@ -0,0 +1,105 @@
+/**
+ * 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 updated Transformation.
+ */
+export class Transformation1 {
+    /**
+     * The id of the Transformation.
+     */
+    'id': string;
+    /**
+     * The name of the Transformation.
+     */
+    'name': string;
+    /**
+     * The Source associated with the Transformation.
+     */
+    'sourceId': string;
+    /**
+     * The optional Destination metadata associated with the Transformation.
+     */
+    'destinationMetadataId'?: string;
+    /**
+     * If the Transformation is 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: 'id',
+            baseName: 'id',
+            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 Transformation1.attributeTypeMap;
+    }
+}