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

package/model/destinationMetadata.ts

@@ -1,222 +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 { Contact } from './contact';
-import { DestinationMetadataActionV1 } from './destinationMetadataActionV1';
-import { DestinationMetadataComponentV1 } from './destinationMetadataComponentV1';
-import { DestinationMetadataSubscriptionPresetV1 } from './destinationMetadataSubscriptionPresetV1';
-import { DestinationMetadataV1 } from './destinationMetadataV1';
-import { IntegrationOptionBeta } from './integrationOptionBeta';
-import { Logos } from './logos';
-import { SupportedFeatures } from './supportedFeatures';
-import { SupportedMethods } from './supportedMethods';
-import { SupportedPlatforms } from './supportedPlatforms';
-
-/**
- * The catalog item matched by id.
- */
-export class DestinationMetadata {
-    /**
-     * 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': DestinationMetadata.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;
-    /**
-     * A list of supported regions for this Destination.
-     */
-    'supportedRegions'?: Array<string>;
-    /**
-     * The list of regional endpoints for this Destination.
-     */
-    'regionEndpoints'?: Array<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: '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: 'DestinationMetadata.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',
-        },
-        {
-            name: 'supportedRegions',
-            baseName: 'supportedRegions',
-            type: 'Array<string>',
-        },
-        {
-            name: 'regionEndpoints',
-            baseName: 'regionEndpoints',
-            type: 'Array<string>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return DestinationMetadata.attributeTypeMap;
-    }
-}
-
-export namespace DestinationMetadata {
-    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/edgeFunctions.ts

@@ -1,87 +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 { EdgeFunctionsAlpha } from './edgeFunctionsAlpha';
-
-/**
- * The created Edge Function.
- */
-export class EdgeFunctions {
-    /**
-     * The Edge Function id.
-     */
-    'id': string;
-    /**
-     * The Source id.
-     */
-    'sourceId': string;
-    /**
-     * Creation date.
-     */
-    'createdAt': string;
-    /**
-     * Creating user\'s id.
-     */
-    'createdBy': string;
-    /**
-     * The CDN URL that can be used to fetch your latest EdgeFunctions bundle.
-     */
-    'downloadURL': string;
-    /**
-     * Revision number associated with the latest Edge Function.
-     */
-    'version': number;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'sourceId',
-            baseName: 'sourceId',
-            type: 'string',
-        },
-        {
-            name: 'createdAt',
-            baseName: 'createdAt',
-            type: 'string',
-        },
-        {
-            name: 'createdBy',
-            baseName: 'createdBy',
-            type: 'string',
-        },
-        {
-            name: 'downloadURL',
-            baseName: 'downloadURL',
-            type: 'string',
-        },
-        {
-            name: 'version',
-            baseName: 'version',
-            type: 'number',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return EdgeFunctions.attributeTypeMap;
-    }
-}

package/model/edgeFunctions1.ts

@@ -1,87 +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 { EdgeFunctionsAlpha } from './edgeFunctionsAlpha';
-
-/**
- * The latest version of Edge Function bundle.
- */
-export class EdgeFunctions1 {
-    /**
-     * The Edge Function id.
-     */
-    'id': string;
-    /**
-     * The Source id.
-     */
-    'sourceId': string;
-    /**
-     * Creation date.
-     */
-    'createdAt': string;
-    /**
-     * Creating user\'s id.
-     */
-    'createdBy': string;
-    /**
-     * The CDN URL that can be used to fetch your latest EdgeFunctions bundle.
-     */
-    'downloadURL': string;
-    /**
-     * Revision number associated with the latest Edge Function.
-     */
-    'version': number;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'sourceId',
-            baseName: 'sourceId',
-            type: 'string',
-        },
-        {
-            name: 'createdAt',
-            baseName: 'createdAt',
-            type: 'string',
-        },
-        {
-            name: 'createdBy',
-            baseName: 'createdBy',
-            type: 'string',
-        },
-        {
-            name: 'downloadURL',
-            baseName: 'downloadURL',
-            type: 'string',
-        },
-        {
-            name: 'version',
-            baseName: 'version',
-            type: 'number',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return EdgeFunctions1.attributeTypeMap;
-    }
-}

package/model/filter.ts

@@ -1,52 +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 { DestinationFilterActionV1 } from './destinationFilterActionV1';
-import { PreviewDestinationFilterV1 } from './previewDestinationFilterV1';
-
-/**
- * The filter to preview.
- */
-export class Filter {
-    /**
-     * A FQL statement which determines if the provided filter\'s actions will apply to the provided JSON payload. The literal string \"all\" will result in this filter to all events. For guidance on using FQL, see the Segment documentation site.
-     */
-    'if': string;
-    /**
-     * The filtering action to take on events that match the \"if\" statement. Action types must be one of: \"drop\", \"allow_properties\", \"drop_properties\" or \"sample\".
-     */
-    'actions': Array<DestinationFilterActionV1>;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'if',
-            baseName: 'if',
-            type: 'string',
-        },
-        {
-            name: 'actions',
-            baseName: 'actions',
-            type: 'Array<DestinationFilterActionV1>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Filter.attributeTypeMap;
-    }
-}

package/model/filter1.ts

@@ -1,124 +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 { DestinationFilterActionV1 } from './destinationFilterActionV1';
-import { DestinationFilterV1 } from './destinationFilterV1';
-
-/**
- * The requested Destination filter.
- */
-export class Filter1 {
-    /**
-     * The unique id of this filter.
-     */
-    'id': string;
-    /**
-     * The id of the Source associated with this filter.
-     */
-    'sourceId': string;
-    /**
-     * The id of the Destination associated with this filter.
-     */
-    'destinationId': string;
-    /**
-     * A condition that defines whether to apply this filter to a payload.
-     */
-    'if': string;
-    /**
-     * A list of actions this filter performs.
-     */
-    'actions': Array<DestinationFilterActionV1>;
-    /**
-     * A title for this filter.
-     */
-    'title': string;
-    /**
-     * A description for this filter.
-     */
-    'description'?: string;
-    /**
-     * When set to true, this filter is active.
-     */
-    'enabled': boolean;
-    /**
-     * The timestamp of this filter\'s creation.
-     */
-    'createdAt': string;
-    /**
-     * The timestamp of this filter\'s last change.
-     */
-    'updatedAt': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'sourceId',
-            baseName: 'sourceId',
-            type: 'string',
-        },
-        {
-            name: 'destinationId',
-            baseName: 'destinationId',
-            type: 'string',
-        },
-        {
-            name: 'if',
-            baseName: 'if',
-            type: 'string',
-        },
-        {
-            name: 'actions',
-            baseName: 'actions',
-            type: 'Array<DestinationFilterActionV1>',
-        },
-        {
-            name: 'title',
-            baseName: 'title',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-        {
-            name: 'enabled',
-            baseName: 'enabled',
-            type: 'boolean',
-        },
-        {
-            name: 'createdAt',
-            baseName: 'createdAt',
-            type: 'string',
-        },
-        {
-            name: 'updatedAt',
-            baseName: 'updatedAt',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Filter1.attributeTypeMap;
-    }
-}

package/model/filter2.ts

@@ -1,124 +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 { DestinationFilterActionV1 } from './destinationFilterActionV1';
-import { DestinationFilterV1 } from './destinationFilterV1';
-
-/**
- * The newly created Destination filter.
- */
-export class Filter2 {
-    /**
-     * The unique id of this filter.
-     */
-    'id': string;
-    /**
-     * The id of the Source associated with this filter.
-     */
-    'sourceId': string;
-    /**
-     * The id of the Destination associated with this filter.
-     */
-    'destinationId': string;
-    /**
-     * A condition that defines whether to apply this filter to a payload.
-     */
-    'if': string;
-    /**
-     * A list of actions this filter performs.
-     */
-    'actions': Array<DestinationFilterActionV1>;
-    /**
-     * A title for this filter.
-     */
-    'title': string;
-    /**
-     * A description for this filter.
-     */
-    'description'?: string;
-    /**
-     * When set to true, this filter is active.
-     */
-    'enabled': boolean;
-    /**
-     * The timestamp of this filter\'s creation.
-     */
-    'createdAt': string;
-    /**
-     * The timestamp of this filter\'s last change.
-     */
-    'updatedAt': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'sourceId',
-            baseName: 'sourceId',
-            type: 'string',
-        },
-        {
-            name: 'destinationId',
-            baseName: 'destinationId',
-            type: 'string',
-        },
-        {
-            name: 'if',
-            baseName: 'if',
-            type: 'string',
-        },
-        {
-            name: 'actions',
-            baseName: 'actions',
-            type: 'Array<DestinationFilterActionV1>',
-        },
-        {
-            name: 'title',
-            baseName: 'title',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-        {
-            name: 'enabled',
-            baseName: 'enabled',
-            type: 'boolean',
-        },
-        {
-            name: 'createdAt',
-            baseName: 'createdAt',
-            type: 'string',
-        },
-        {
-            name: 'updatedAt',
-            baseName: 'updatedAt',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Filter2.attributeTypeMap;
-    }
-}