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

package/model/messageSubscriptionResponseError.ts

@@ -1,47 +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: 32.0.1
- * 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 MessageSubscriptionResponseError {
-    /**
-     * Error code.
-     */
-    'code': string;
-    /**
-     * Error message.
-     */
-    'message': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'code',
-            baseName: 'code',
-            type: 'string',
-        },
-        {
-            name: 'message',
-            baseName: 'message',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return MessageSubscriptionResponseError.attributeTypeMap;
-    }
-}

package/model/messagesSubscriptionRequest.ts

@@ -1,68 +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: 32.0.1
- * 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 MessagesSubscriptionRequest {
-    /**
-     * Key is the phone number or email.
-     */
-    'key': string;
-    /**
-     * Type is communication medium used. Either EMAIL or SMS.
-     */
-    'type': MessagesSubscriptionRequest.TypeEnum;
-    /**
-     * The user subscribed, unsubscribed, or on initial status.
-     */
-    'status': MessagesSubscriptionRequest.StatusEnum;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'key',
-            baseName: 'key',
-            type: 'string',
-        },
-        {
-            name: 'type',
-            baseName: 'type',
-            type: 'MessagesSubscriptionRequest.TypeEnum',
-        },
-        {
-            name: 'status',
-            baseName: 'status',
-            type: 'MessagesSubscriptionRequest.StatusEnum',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return MessagesSubscriptionRequest.attributeTypeMap;
-    }
-}
-
-export namespace MessagesSubscriptionRequest {
-    export enum TypeEnum {
-        EMAIL = <any>'EMAIL',
-        SMS = <any>'SMS',
-    }
-    export enum StatusEnum {
-        DID_NOT_SUBSCRIBE = <any>'DID_NOT_SUBSCRIBE',
-        SUBSCRIBED = <any>'SUBSCRIBED',
-        UNSUBSCRIBED = <any>'UNSUBSCRIBED',
-    }
-}

package/model/metadata.ts

@@ -1,184 +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: 32.0.1
- * 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 { 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';
-
-/**
- * The metadata of the Destination of which this Destination is an instance of. For example, Google Analytics or Amplitude.
- */
-export class Metadata {
-    /**
-     * 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': Metadata.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>;
-
-    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: 'Metadata.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>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Metadata.attributeTypeMap;
-    }
-}
-
-export namespace Metadata {
-    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',
-    }
-}

package/model/metadata1.ts

@@ -1,103 +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: 32.0.1
- * 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 { IntegrationOptionBeta } from './integrationOptionBeta';
-import { Logos1 } from './logos1';
-
-/**
- * The metadata for the Source.  Config API note: includes `catalogName` and `catalogId`.
- */
-export class Metadata1 {
-    /**
-     * The id for this Source metadata in the Segment catalog.  Config API note: analogous to `name`.
-     */
-    'id': string;
-    /**
-     * The user-friendly name of this Source.  Config API note: equal to `displayName`.
-     */
-    'name': string;
-    /**
-     * The slug that identifies this Source in the Segment app.  Config API note: equal to `name`.
-     */
-    'slug': string;
-    /**
-     * The description of this Source.
-     */
-    'description': string;
-    'logos': Logos1;
-    /**
-     * Options for this Source.
-     */
-    'options': Array<IntegrationOptionBeta>;
-    /**
-     * A list of categories this Source belongs to.
-     */
-    'categories': Array<string>;
-    /**
-     * True if this is a Cloud Event Source.
-     */
-    'isCloudEventSource': 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: 'slug',
-            baseName: 'slug',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-        {
-            name: 'logos',
-            baseName: 'logos',
-            type: 'Logos1',
-        },
-        {
-            name: 'options',
-            baseName: 'options',
-            type: 'Array<IntegrationOptionBeta>',
-        },
-        {
-            name: 'categories',
-            baseName: 'categories',
-            type: 'Array<string>',
-        },
-        {
-            name: 'isCloudEventSource',
-            baseName: 'isCloudEventSource',
-            type: 'boolean',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Metadata1.attributeTypeMap;
-    }
-}

package/model/metadata2.ts

@@ -1,85 +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: 32.0.1
- * 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 { IntegrationOptionBeta } from './integrationOptionBeta';
-import { Logos2 } from './logos2';
-
-/**
- * The metadata for the Warehouse.
- */
-export class Metadata2 {
-    /**
-     * The id of this object.
-     */
-    'id': string;
-    /**
-     * The name of this object.
-     */
-    'name': string;
-    /**
-     * A human-readable, unique identifier for object.
-     */
-    'slug': string;
-    /**
-     * A description, in English, of this object.
-     */
-    'description': string;
-    'logos': Logos2;
-    /**
-     * The Integration options for this object.
-     */
-    'options': Array<IntegrationOptionBeta>;
-
-    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: 'logos',
-            baseName: 'logos',
-            type: 'Logos2',
-        },
-        {
-            name: 'options',
-            baseName: 'options',
-            type: 'Array<IntegrationOptionBeta>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Metadata2.attributeTypeMap;
-    }
-}

package/model/metricBeta.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: 32.0.1
- * 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 { BreakdownBeta } from './breakdownBeta';
-
-/**
- * The event delivery metric.
- */
-export class MetricBeta {
-    /**
-     * The name of the metric.
-     */
-    'metricName': string;
-    /**
-     * Number of occurrences of the metric.
-     */
-    'total': number;
-    /**
-     * Breakdown of metrics within a metric.
-     */
-    'breakdown'?: Array<BreakdownBeta>;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'metricName',
-            baseName: 'metricName',
-            type: 'string',
-        },
-        {
-            name: 'total',
-            baseName: 'total',
-            type: 'number',
-        },
-        {
-            name: 'breakdown',
-            baseName: 'breakdown',
-            type: 'Array<BreakdownBeta>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return MetricBeta.attributeTypeMap;
-    }
-}

package/model/minimalUserGroupV1.ts

@@ -1,50 +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: 32.0.1
- * 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 least amount of information needed to identify a user group.
- */
-export class MinimalUserGroupV1 {
-    /**
-     * The id of the user group.
-     */
-    'id': string;
-    /**
-     * The name of the user group.
-     */
-    'name': 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',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return MinimalUserGroupV1.attributeTypeMap;
-    }
-}

package/model/minimalUserV1.ts

@@ -1,59 +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: 32.0.1
- * 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';
-
-/**
- * A user belonging to a Segment Workspace.
- */
-export class MinimalUserV1 {
-    /**
-     * The unique identifier of this user.  Config API note: analogous to `name`.
-     */
-    'id': string;
-    /**
-     * The human-readable name of this user.
-     */
-    'name': string;
-    /**
-     * The email address associated with this user.
-     */
-    'email': 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: 'email',
-            baseName: 'email',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return MinimalUserV1.attributeTypeMap;
-    }
-}