@segment/public-api-sdk-typescript 36.3.0-b7762 → 37.0.0-b7805

package/model/subscription.ts

@@ -1,114 +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: 36.3.0
- * 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 { DestinationSubscription } from './destinationSubscription';
-
-/**
- * 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 | null;
-    /**
-     * FQL string that describes what events should trigger a Destination action.
-     */
-    'trigger': string;
-    /**
-     * The unique identifier for the linked ReverseETLModel, if this part of a Reverse ETL connection.
-     */
-    'modelId'?: 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',
-        },
-        {
-            name: 'modelId',
-            baseName: 'modelId',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Subscription.attributeTypeMap;
-    }
-}

package/model/supportedFeatures.ts

@@ -1,94 +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: 36.3.0
- * 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 { DestinationMetadataFeaturesV1 } from './destinationMetadataFeaturesV1';
-
-/**
- * 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

@@ -1,78 +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: 36.3.0
- * 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 { DestinationMetadataMethodsV1 } from './destinationMetadataMethodsV1';
-
-/**
- * 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

@@ -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: 36.3.0
- * 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 { DestinationMetadataPlatformsV1 } from './destinationMetadataPlatformsV1';
-
-/**
- * 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/track.ts

@@ -1,86 +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: 36.3.0
- * 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 { TrackSourceSettingsV1 } from './trackSourceSettingsV1';
-
-/**
- * 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',
-    }
-}

package/model/trackingPlan.ts

@@ -1,106 +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: 36.3.0
- * 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 { TrackingPlanV1 } from './trackingPlanV1';
-
-/**
- * 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 {
-        ENGAGE = <any>'ENGAGE',
-        LIVE = <any>'LIVE',
-        PROPERTY_LIBRARY = <any>'PROPERTY_LIBRARY',
-        RULE_LIBRARY = <any>'RULE_LIBRARY',
-        TEMPLATE = <any>'TEMPLATE',
-    }
-}

package/model/trackingPlan1.ts

@@ -1,106 +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: 36.3.0
- * 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 { TrackingPlanV1 } from './trackingPlanV1';
-
-/**
- * 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 {
-        ENGAGE = <any>'ENGAGE',
-        LIVE = <any>'LIVE',
-        PROPERTY_LIBRARY = <any>'PROPERTY_LIBRARY',
-        RULE_LIBRARY = <any>'RULE_LIBRARY',
-        TEMPLATE = <any>'TEMPLATE',
-    }
-}