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

package/model/listWorkspaceRegulationsV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { RegulationListEntryV1 } from './regulationListEntryV1';
+
+/**
+ * Output of all Workspace-scoped regulations in a given Workspace.
+ */
+export class ListWorkspaceRegulationsV1Output {
+    /**
+     * List of Workspace-scoped regulations with statuses.
+     */
+    'regulations': Array<RegulationListEntryV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'regulations',
+            baseName: 'regulations',
+            type: 'Array<RegulationListEntryV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListWorkspaceRegulationsV1Output.attributeTypeMap;
+    }
+}

package/model/logos.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';
+
+/**
+ * The Destination\'s logos.
+ */
+export class Logos {
+    /**
+     * The default URL for this logo.
+     */
+    'default': string;
+    /**
+     * The logo mark.
+     */
+    'mark'?: string | null;
+    /**
+     * The alternative text for this logo.
+     */
+    'alt'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'default',
+            baseName: 'default',
+            type: 'string',
+        },
+        {
+            name: 'mark',
+            baseName: 'mark',
+            type: 'string',
+        },
+        {
+            name: 'alt',
+            baseName: 'alt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Logos.attributeTypeMap;
+    }
+}

package/model/logos1.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';
+
+/**
+ * The logos for this Source.
+ */
+export class Logos1 {
+    /**
+     * The default URL for this logo.
+     */
+    'default': string;
+    /**
+     * The logo mark.
+     */
+    'mark'?: string | null;
+    /**
+     * The alternative text for this logo.
+     */
+    'alt'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'default',
+            baseName: 'default',
+            type: 'string',
+        },
+        {
+            name: 'mark',
+            baseName: 'mark',
+            type: 'string',
+        },
+        {
+            name: 'alt',
+            baseName: 'alt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Logos1.attributeTypeMap;
+    }
+}

package/model/logos2.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';
+
+/**
+ * Logo information for this object.
+ */
+export class Logos2 {
+    /**
+     * The default URL for this logo.
+     */
+    'default': string;
+    /**
+     * The logo mark.
+     */
+    'mark'?: string | null;
+    /**
+     * The alternative text for this logo.
+     */
+    'alt'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'default',
+            baseName: 'default',
+            type: 'string',
+        },
+        {
+            name: 'mark',
+            baseName: 'mark',
+            type: 'string',
+        },
+        {
+            name: 'alt',
+            baseName: 'alt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Logos2.attributeTypeMap;
+    }
+}

package/model/logosBeta.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 logo.
+ */
+export class LogosBeta {
+    /**
+     * The default URL for this logo.
+     */
+    'default': string;
+    /**
+     * The logo mark.
+     */
+    'mark'?: string | null;
+    /**
+     * The alternative text for this logo.
+     */
+    'alt'?: string | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'default',
+            baseName: 'default',
+            type: 'string',
+        },
+        {
+            name: 'mark',
+            baseName: 'mark',
+            type: 'string',
+        },
+        {
+            name: 'alt',
+            baseName: 'alt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return LogosBeta.attributeTypeMap;
+    }
+}

package/model/messageSubscriptionResponse.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 { MessageSubscriptionResponseError } from './messageSubscriptionResponseError';
+
+export class MessageSubscriptionResponse {
+    /**
+     * Key is the phone number or email.
+     */
+    'key': string;
+    /**
+     * Type is communication medium used. Either EMAIL or SMS.
+     */
+    'type': MessageSubscriptionResponse.TypeEnum;
+    /**
+     * The user subscribed, unsubscribed, or on initial status.
+     */
+    'status': MessageSubscriptionResponse.StatusEnum;
+    /**
+     * Error messages.
+     */
+    'errors'?: Array<MessageSubscriptionResponseError>;
+
+    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: 'MessageSubscriptionResponse.TypeEnum',
+        },
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'MessageSubscriptionResponse.StatusEnum',
+        },
+        {
+            name: 'errors',
+            baseName: 'errors',
+            type: 'Array<MessageSubscriptionResponseError>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return MessageSubscriptionResponse.attributeTypeMap;
+    }
+}
+
+export namespace MessageSubscriptionResponse {
+    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/messageSubscriptionResponseError.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 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

@@ -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';
+
+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

@@ -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';
+
+/**
+ * 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>;
+    /**
+     * 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: '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>',
+        },
+        {
+            name: 'contacts',
+            baseName: 'contacts',
+            type: 'Array<Contact>',
+        },
+        {
+            name: 'partnerOwned',
+            baseName: 'partnerOwned',
+            type: 'boolean',
+        },
+    ];
+
+    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',
+    }
+}