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

package/model/destinationMetadataActionV1.ts

@@ -0,0 +1,113 @@
+/**
+ * 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 { DestinationMetadataActionFieldV1 } from './destinationMetadataActionFieldV1';
+
+/**
+ * Represents an Action, a building block of behavior that can be performed by the Destination.
+ */
+export class DestinationMetadataActionV1 {
+    /**
+     * The primary key of the action.
+     */
+    'id': string;
+    /**
+     * A machine-readable key unique to the action definition.
+     */
+    'slug': string;
+    /**
+     * A human-readable name for the action.
+     */
+    'name': string;
+    /**
+     * A human-readable description of the action. May include Markdown.
+     */
+    'description': string;
+    /**
+     * The platform on which this action runs.
+     */
+    'platform': DestinationMetadataActionV1.PlatformEnum;
+    /**
+     * Whether the action should be hidden.
+     */
+    'hidden': boolean;
+    /**
+     * The default value used as the trigger when connecting this action.
+     */
+    'defaultTrigger': string | null;
+    /**
+     * The fields expected in order to perform the action.
+     */
+    'fields': Array<DestinationMetadataActionFieldV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'platform',
+            baseName: 'platform',
+            type: 'DestinationMetadataActionV1.PlatformEnum',
+        },
+        {
+            name: 'hidden',
+            baseName: 'hidden',
+            type: 'boolean',
+        },
+        {
+            name: 'defaultTrigger',
+            baseName: 'defaultTrigger',
+            type: 'string',
+        },
+        {
+            name: 'fields',
+            baseName: 'fields',
+            type: 'Array<DestinationMetadataActionFieldV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationMetadataActionV1.attributeTypeMap;
+    }
+}
+
+export namespace DestinationMetadataActionV1 {
+    export enum PlatformEnum {
+        CLOUD = <any>'CLOUD',
+        MOBILE = <any>'MOBILE',
+        WEB = <any>'WEB',
+    }
+}

package/model/destinationMetadataComponentV1.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 component this Destination provides.
+ */
+export class DestinationMetadataComponentV1 {
+    /**
+     * The component type.
+     */
+    'type': DestinationMetadataComponentV1.TypeEnum;
+    /**
+     * Link to the repository hosting the code for this component.
+     */
+    'code': string;
+    /**
+     * The owner of this component. Either \'SEGMENT\' or \'PARTNER\'.
+     */
+    'owner'?: DestinationMetadataComponentV1.OwnerEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'DestinationMetadataComponentV1.TypeEnum',
+        },
+        {
+            name: 'code',
+            baseName: 'code',
+            type: 'string',
+        },
+        {
+            name: 'owner',
+            baseName: 'owner',
+            type: 'DestinationMetadataComponentV1.OwnerEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationMetadataComponentV1.attributeTypeMap;
+    }
+}
+
+export namespace DestinationMetadataComponentV1 {
+    export enum TypeEnum {
+        ANDROID = <any>'ANDROID',
+        BROWSER = <any>'BROWSER',
+        IOS = <any>'IOS',
+        SERVER = <any>'SERVER',
+    }
+    export enum OwnerEnum {
+        PARTNER = <any>'PARTNER',
+        SEGMENT = <any>'SEGMENT',
+    }
+}

package/model/destinationMetadataFeaturesV1.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';
+
+/**
+ * Represents features that a given Destination supports.
+ */
+export class DestinationMetadataFeaturesV1 {
+    /**
+     * This Destination\'s support level for cloud mode instances. The values \'0\' and \'NONE\', and \'1\' and \'SINGLE\' are equivalent.
+     */
+    'cloudModeInstances'?: DestinationMetadataFeaturesV1.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'?: DestinationMetadataFeaturesV1.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: 'DestinationMetadataFeaturesV1.CloudModeInstancesEnum',
+        },
+        {
+            name: 'deviceModeInstances',
+            baseName: 'deviceModeInstances',
+            type: 'DestinationMetadataFeaturesV1.DeviceModeInstancesEnum',
+        },
+        {
+            name: 'replay',
+            baseName: 'replay',
+            type: 'boolean',
+        },
+        {
+            name: 'browserUnbundling',
+            baseName: 'browserUnbundling',
+            type: 'boolean',
+        },
+        {
+            name: 'browserUnbundlingPublic',
+            baseName: 'browserUnbundlingPublic',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationMetadataFeaturesV1.attributeTypeMap;
+    }
+}
+
+export namespace DestinationMetadataFeaturesV1 {
+    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/destinationMetadataMethodsV1.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';
+
+/**
+ * Represents methods that a given Destination supports.
+ */
+export class DestinationMetadataMethodsV1 {
+    /**
+     * 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 DestinationMetadataMethodsV1.attributeTypeMap;
+    }
+}

package/model/destinationMetadataPlatformsV1.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 platforms that a given Destination supports.
+ */
+export class DestinationMetadataPlatformsV1 {
+    /**
+     * 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 DestinationMetadataPlatformsV1.attributeTypeMap;
+    }
+}

package/model/destinationMetadataSubscriptionPresetV1.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';
+
+/**
+ * Represents a set of defaults for a Destination subscription.
+ */
+export class DestinationMetadataSubscriptionPresetV1 {
+    /**
+     * The unique identifier for the Destination Action to trigger.
+     */
+    'actionId': string;
+    /**
+     * The name of the subscription.
+     */
+    'name': string;
+    /**
+     * The default settings for action fields.
+     */
+    'fields': { [key: string]: any };
+    /**
+     * FQL string that describes what events should trigger an action. See https://segment.com/docs/config-api/fql/ for more information regarding Segment\'s Filter Query Language (FQL).
+     */
+    'trigger': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'actionId',
+            baseName: 'actionId',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'fields',
+            baseName: 'fields',
+            type: '{ [key: string]: any; }',
+        },
+        {
+            name: 'trigger',
+            baseName: 'trigger',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationMetadataSubscriptionPresetV1.attributeTypeMap;
+    }
+}

package/model/destinationMetadataV1.ts

@@ -0,0 +1,203 @@
+/**
+ * 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 { Contact } from './contact';
+import { DestinationMetadataActionV1 } from './destinationMetadataActionV1';
+import { DestinationMetadataComponentV1 } from './destinationMetadataComponentV1';
+import { DestinationMetadataSubscriptionPresetV1 } from './destinationMetadataSubscriptionPresetV1';
+import { IntegrationOptionBeta } from './integrationOptionBeta';
+import { Logos } from './logos';
+import { SupportedFeatures } from './supportedFeatures';
+import { SupportedMethods } from './supportedMethods';
+import { SupportedPlatforms } from './supportedPlatforms';
+
+/**
+ * Represents a Destination within Segment.  A Destination is a target for Segment to forward data to, and represents a tool or storage Destination.
+ */
+export class DestinationMetadataV1 {
+    /**
+     * The id of the Destination metadata.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The user-friendly name of the Destination.  Config API note: equal to `displayName`.
+     */
+    'name': string;
+    /**
+     * The description of the Destination.
+     */
+    'description': string;
+    /**
+     * The slug used to identify the Destination in the Segment app.
+     */
+    'slug': string;
+    'logos': Logos;
+    /**
+     * Options configured for the Destination.
+     */
+    'options': Array<IntegrationOptionBeta>;
+    /**
+     * Support status of the Destination.
+     */
+    'status': DestinationMetadataV1.StatusEnum;
+    /**
+     * A list of names previously used by the Destination.
+     */
+    'previousNames': Array<string>;
+    /**
+     * A list of categories with which the Destination is associated.
+     */
+    'categories': Array<string>;
+    /**
+     * A website URL for this Destination.
+     */
+    'website': string;
+    /**
+     * A list of components this Destination provides.
+     */
+    'components': Array<DestinationMetadataComponentV1>;
+    'supportedFeatures': SupportedFeatures;
+    'supportedMethods': SupportedMethods;
+    'supportedPlatforms': SupportedPlatforms;
+    /**
+     * Actions available for the Destination.
+     */
+    'actions': Array<DestinationMetadataActionV1>;
+    /**
+     * Predefined Destination subscriptions that can optionally be applied when connecting a new instance of the Destination.
+     */
+    'presets': Array<DestinationMetadataSubscriptionPresetV1>;
+    /**
+     * Contact info for Integration Owners.
+     */
+    'contacts'?: Array<Contact>;
+    /**
+     * Partner Owned flag.
+     */
+    'partnerOwned'?: boolean;
+
+    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: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'logos',
+            baseName: 'logos',
+            type: 'Logos',
+        },
+        {
+            name: 'options',
+            baseName: 'options',
+            type: 'Array<IntegrationOptionBeta>',
+        },
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'DestinationMetadataV1.StatusEnum',
+        },
+        {
+            name: 'previousNames',
+            baseName: 'previousNames',
+            type: 'Array<string>',
+        },
+        {
+            name: 'categories',
+            baseName: 'categories',
+            type: 'Array<string>',
+        },
+        {
+            name: 'website',
+            baseName: 'website',
+            type: 'string',
+        },
+        {
+            name: 'components',
+            baseName: 'components',
+            type: 'Array<DestinationMetadataComponentV1>',
+        },
+        {
+            name: 'supportedFeatures',
+            baseName: 'supportedFeatures',
+            type: 'SupportedFeatures',
+        },
+        {
+            name: 'supportedMethods',
+            baseName: 'supportedMethods',
+            type: 'SupportedMethods',
+        },
+        {
+            name: 'supportedPlatforms',
+            baseName: 'supportedPlatforms',
+            type: 'SupportedPlatforms',
+        },
+        {
+            name: 'actions',
+            baseName: 'actions',
+            type: 'Array<DestinationMetadataActionV1>',
+        },
+        {
+            name: 'presets',
+            baseName: 'presets',
+            type: 'Array<DestinationMetadataSubscriptionPresetV1>',
+        },
+        {
+            name: 'contacts',
+            baseName: 'contacts',
+            type: 'Array<Contact>',
+        },
+        {
+            name: 'partnerOwned',
+            baseName: 'partnerOwned',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationMetadataV1.attributeTypeMap;
+    }
+}
+
+export namespace DestinationMetadataV1 {
+    export enum StatusEnum {
+        DEPRECATED = <any>'DEPRECATED',
+        PRIVATE_BETA = <any>'PRIVATE_BETA',
+        PRIVATE_BUILDING = <any>'PRIVATE_BUILDING',
+        PRIVATE_SUBMITTED = <any>'PRIVATE_SUBMITTED',
+        PUBLIC = <any>'PUBLIC',
+        PUBLIC_BETA = <any>'PUBLIC_BETA',
+        UNAVAILABLE = <any>'UNAVAILABLE',
+    }
+}