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

package/model/streamStatusV1.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { DestinationStatusV1 } from './destinationStatusV1';
+
+/**
+ * StreamStatus represents status of each stream including all the Destinations corresponding to the stream.
+ */
+export class StreamStatusV1 {
+    'id': string;
+    'destinationStatus': Array<DestinationStatusV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'destinationStatus',
+            baseName: 'destinationStatus',
+            type: 'Array<DestinationStatusV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return StreamStatusV1.attributeTypeMap;
+    }
+}

package/model/subscription.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 Destination subscription.
+ */
+export class Subscription {
+    /**
+     * The unique identifier for the subscription.
+     */
+    'id': string;
+    /**
+     * The name of the subscription.
+     */
+    'name': string;
+    /**
+     * The unique identifier for the Destination action to trigger.
+     */
+    'actionId': string;
+    /**
+     * The URL-friendly key for the associated Destination action.
+     */
+    'actionSlug': string;
+    /**
+     * The associated Destination instance id.
+     */
+    'destinationId': string;
+    /**
+     * Is the subscription enabled.
+     */
+    'enabled': boolean;
+    /**
+     * The customer settings for action fields.
+     */
+    'settings': any;
+    /**
+     * FQL string that describes what events should trigger a Destination action.
+     */
+    'trigger': 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: 'actionId',
+            baseName: 'actionId',
+            type: 'string',
+        },
+        {
+            name: 'actionSlug',
+            baseName: 'actionSlug',
+            type: 'string',
+        },
+        {
+            name: 'destinationId',
+            baseName: 'destinationId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+        {
+            name: 'trigger',
+            baseName: 'trigger',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Subscription.attributeTypeMap;
+    }
+}

package/model/supportedFeatures.ts

@@ -0,0 +1,93 @@
+/**
+ * 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';
+
+/**
+ * Features that this Destination supports.  Config API note: holds `browserUnbundling` fields.
+ */
+export class SupportedFeatures {
+    /**
+     * This Destination\'s support level for cloud mode instances. The values \'0\' and \'NONE\', and \'1\' and \'SINGLE\' are equivalent.
+     */
+    'cloudModeInstances'?: SupportedFeatures.CloudModeInstancesEnum;
+    /**
+     * This Destination\'s support level for device mode instances. Support for multiple device mode instances is currently not planned. The values \'0\' and \'NONE\', and \'1\' and \'SINGLE\' are equivalent.
+     */
+    'deviceModeInstances'?: SupportedFeatures.DeviceModeInstancesEnum;
+    /**
+     * Whether this Destination supports replays.
+     */
+    'replay'?: boolean;
+    /**
+     * Whether this Destination supports browser unbundling.
+     */
+    'browserUnbundling'?: boolean;
+    /**
+     * Whether this Destination supports public browser unbundling.
+     */
+    'browserUnbundlingPublic'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'cloudModeInstances',
+            baseName: 'cloudModeInstances',
+            type: 'SupportedFeatures.CloudModeInstancesEnum',
+        },
+        {
+            name: 'deviceModeInstances',
+            baseName: 'deviceModeInstances',
+            type: 'SupportedFeatures.DeviceModeInstancesEnum',
+        },
+        {
+            name: 'replay',
+            baseName: 'replay',
+            type: 'boolean',
+        },
+        {
+            name: 'browserUnbundling',
+            baseName: 'browserUnbundling',
+            type: 'boolean',
+        },
+        {
+            name: 'browserUnbundlingPublic',
+            baseName: 'browserUnbundlingPublic',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SupportedFeatures.attributeTypeMap;
+    }
+}
+
+export namespace SupportedFeatures {
+    export enum CloudModeInstancesEnum {
+        _0 = <any>'0',
+        _1 = <any>'1',
+        MULTIPLE = <any>'MULTIPLE',
+        NONE = <any>'NONE',
+        SINGLE = <any>'SINGLE',
+    }
+    export enum DeviceModeInstancesEnum {
+        _0 = <any>'0',
+        _1 = <any>'1',
+        NONE = <any>'NONE',
+        SINGLE = <any>'SINGLE',
+    }
+}

package/model/supportedMethods.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';
+
+/**
+ * Methods that this Destination supports.  Config API note: equal to `methods`.
+ */
+export class SupportedMethods {
+    /**
+     * Identifies if the Destination supports the `pageview` method.
+     */
+    'pageview'?: boolean;
+    /**
+     * Identifies if the Destination supports the `identify` method.
+     */
+    'identify'?: boolean;
+    /**
+     * Identifies if the Destination supports the `alias` method.
+     */
+    'alias'?: boolean;
+    /**
+     * Identifies if the Destination supports the `track` method.
+     */
+    'track'?: boolean;
+    /**
+     * Identifies if the Destination supports the `group` method.
+     */
+    'group'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'pageview',
+            baseName: 'pageview',
+            type: 'boolean',
+        },
+        {
+            name: 'identify',
+            baseName: 'identify',
+            type: 'boolean',
+        },
+        {
+            name: 'alias',
+            baseName: 'alias',
+            type: 'boolean',
+        },
+        {
+            name: 'track',
+            baseName: 'track',
+            type: 'boolean',
+        },
+        {
+            name: 'group',
+            baseName: 'group',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SupportedMethods.attributeTypeMap;
+    }
+}

package/model/supportedPlatforms.ts

@@ -0,0 +1,59 @@
+/**
+ * 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';
+
+/**
+ * Platforms from which the Destination receives events.  Config API note: equal to `platforms`.
+ */
+export class SupportedPlatforms {
+    /**
+     * Whether this Destination supports browser events.
+     */
+    'browser'?: boolean;
+    /**
+     * Whether this Destination supports server events.
+     */
+    'server'?: boolean;
+    /**
+     * Whether this Destination supports mobile events.
+     */
+    'mobile'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'browser',
+            baseName: 'browser',
+            type: 'boolean',
+        },
+        {
+            name: 'server',
+            baseName: 'server',
+            type: 'boolean',
+        },
+        {
+            name: 'mobile',
+            baseName: 'mobile',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SupportedPlatforms.attributeTypeMap;
+    }
+}

package/model/suppressedInner.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';
+
+export class SuppressedInner {
+    'subjectType': string;
+    'subjectIds': Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'subjectType',
+            baseName: 'subjectType',
+            type: 'string',
+        },
+        {
+            name: 'subjectIds',
+            baseName: 'subjectIds',
+            type: 'Array<string>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SuppressedInner.attributeTypeMap;
+    }
+}

package/model/syncNoticeV1.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 notice within a sync for a Source and Warehouse pair.
+ */
+export class SyncNoticeV1 {
+    /**
+     * The severity of the notice.
+     */
+    'level': string;
+    /**
+     * The human-readable message that describes the notice.
+     */
+    'message': string;
+    /**
+     * The timestamp of this sync notice\'s creation.
+     */
+    'createdAt': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'level',
+            baseName: 'level',
+            type: 'string',
+        },
+        {
+            name: 'message',
+            baseName: 'message',
+            type: 'string',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SyncNoticeV1.attributeTypeMap;
+    }
+}

package/model/syncV1.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 { SyncNoticeV1 } from './syncNoticeV1';
+
+/**
+ * Represents a sync between a Source and Warehouse.  A sync occurs when data from a Source is loaded into a Warehouse.
+ */
+export class SyncV1 {
+    /**
+     * The id of the Source loaded in the sync.
+     */
+    'sourceId': string;
+    /**
+     * The start time of the sync.
+     */
+    'start': string;
+    /**
+     * The time the sync completed. Returns null if unfinished.
+     */
+    'end': string | null;
+    /**
+     * The status of the sync.
+     */
+    'status': string;
+    /**
+     * The duration of the sync in seconds. Returns the partial duration if the sync has not finished yet.
+     */
+    'duration': number;
+    /**
+     * The human-readable counterpart of `duration`.
+     */
+    'humanDuration': string;
+    /**
+     * The number of rows synced into the Warehouse.
+     */
+    'count': number;
+    /**
+     * Notices that contain the events that occurred during the sync.
+     */
+    'notices': Array<SyncNoticeV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'start',
+            baseName: 'start',
+            type: 'string',
+        },
+        {
+            name: 'end',
+            baseName: 'end',
+            type: 'string',
+        },
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'string',
+        },
+        {
+            name: 'duration',
+            baseName: 'duration',
+            type: 'number',
+        },
+        {
+            name: 'humanDuration',
+            baseName: 'humanDuration',
+            type: 'string',
+        },
+        {
+            name: 'count',
+            baseName: 'count',
+            type: 'number',
+        },
+        {
+            name: 'notices',
+            baseName: 'notices',
+            type: 'Array<SyncNoticeV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SyncV1.attributeTypeMap;
+    }
+}

package/model/track.ts

@@ -0,0 +1,85 @@
+/**
+ * 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';
+
+/**
+ * Track settings.
+ */
+export class Track {
+    /**
+     * 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'?: Track.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: 'Track.CommonEventOnViolationsEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Track.attributeTypeMap;
+    }
+}
+
+export namespace Track {
+    export enum CommonEventOnViolationsEnum {
+        ALLOW = <any>'ALLOW',
+        BLOCK = <any>'BLOCK',
+        OMIT_PROPERTIES = <any>'OMIT_PROPERTIES',
+    }
+}