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

package/model/destinationStatusV1.ts

@@ -0,0 +1,74 @@
+/**
+ * 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';
+
+/**
+ * DestinationStatus represents status of each Destination in a stream.
+ */
+export class DestinationStatusV1 {
+    'name': string;
+    'id': string;
+    'status': DestinationStatusV1.StatusEnum;
+    'errString': string;
+    'finishedAt': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'DestinationStatusV1.StatusEnum',
+        },
+        {
+            name: 'errString',
+            baseName: 'errString',
+            type: 'string',
+        },
+        {
+            name: 'finishedAt',
+            baseName: 'finishedAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationStatusV1.attributeTypeMap;
+    }
+}
+
+export namespace DestinationStatusV1 {
+    export enum StatusEnum {
+        FAILED = <any>'FAILED',
+        FINISHED = <any>'FINISHED',
+        INITIALIZED = <any>'INITIALIZED',
+        INVALID = <any>'INVALID',
+        NOT_SUPPORTED = <any>'NOT_SUPPORTED',
+        PARTIAL_SUCCESS = <any>'PARTIAL_SUCCESS',
+        RUNNING = <any>'RUNNING',
+    }
+}

package/model/destinationSubscription.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 subscription.
+ */
+export class DestinationSubscription {
+    /**
+     * 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;
+    /**
+     * FQL string that describes what events should trigger a Destination action.
+     */
+    'trigger': 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',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationSubscription.attributeTypeMap;
+    }
+}

package/model/destinationSubscriptionUpdateInput.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';
+
+/**
+ * The input parameters for updating a Destination subscription.
+ */
+export class DestinationSubscriptionUpdateInput {
+    /**
+     * The user-defined name for the subscription.
+     */
+    'name'?: string;
+    /**
+     * The fql statement.
+     */
+    'trigger'?: string;
+    /**
+     * Is the subscription enabled.
+     */
+    'enabled'?: boolean;
+    /**
+     * The fields used for configuring this action.
+     */
+    'settings'?: any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'trigger',
+            baseName: 'trigger',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationSubscriptionUpdateInput.attributeTypeMap;
+    }
+}

package/model/destinationV1.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { Metadata } from './metadata';
+
+/**
+ * Business tools or apps that you can connect to the data flowing through Segment.  This is equal to the Destination object in Config API, with the following fields omitted: - catalogId - createTime - updateTime - connectionMode.
+ */
+export class DestinationV1 {
+    /**
+     * The unique identifier of this instance of a Destination.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The name of this instance of a Destination.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * Whether this instance of a Destination receives data.
+     */
+    'enabled': boolean;
+    'metadata': Metadata;
+    /**
+     * The id of a Source connected to this instance of a Destination.  Config API note: analogous to `parent`.
+     */
+    'sourceId': string;
+    /**
+     * The collection of settings associated with a Destination.  Config API note: equal to `config`.
+     */
+    'settings': { [key: string]: any };
+
+    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: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata',
+        },
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DestinationV1.attributeTypeMap;
+    }
+}

package/model/disableEdgeFunctions200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { DisableEdgeFunctionsAlphaOutput } from './disableEdgeFunctionsAlphaOutput';
+
+export class DisableEdgeFunctions200Response {
+    'data'?: DisableEdgeFunctionsAlphaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'DisableEdgeFunctionsAlphaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DisableEdgeFunctions200Response.attributeTypeMap;
+    }
+}

package/model/disableEdgeFunctionsAlphaOutput.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { EdgeFunctions1 } from './edgeFunctions1';
+
+/**
+ * Output for DisableEdgeFunctions.
+ */
+export class DisableEdgeFunctionsAlphaOutput {
+    'edgeFunctions': EdgeFunctions1;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'edgeFunctions',
+            baseName: 'edgeFunctions',
+            type: 'EdgeFunctions1',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DisableEdgeFunctionsAlphaOutput.attributeTypeMap;
+    }
+}

package/model/echo200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { EchoAlphaOutput } from './echoAlphaOutput';
+
+export class Echo200Response {
+    'data'?: EchoAlphaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'EchoAlphaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Echo200Response.attributeTypeMap;
+    }
+}

package/model/echo200Response1.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { EchoV1Output } from './echoV1Output';
+
+export class Echo200Response1 {
+    'data'?: EchoV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'EchoV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Echo200Response1.attributeTypeMap;
+    }
+}

package/model/echoAlphaOutput.ts

@@ -0,0 +1,66 @@
+/**
+ * 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';
+
+/**
+ * Echo response.
+ */
+export class EchoAlphaOutput {
+    /**
+     * The HTTP method used for this round-trip.  Currently, this endpoint supports only `get` and `post` methods.
+     */
+    'method': EchoAlphaOutput.MethodEnum;
+    /**
+     * The string passed in the `message` input field.
+     */
+    'message': string;
+    /**
+     * The request\'s HTTP headers.
+     */
+    'headers': { [key: string]: any };
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'method',
+            baseName: 'method',
+            type: 'EchoAlphaOutput.MethodEnum',
+        },
+        {
+            name: 'message',
+            baseName: 'message',
+            type: 'string',
+        },
+        {
+            name: 'headers',
+            baseName: 'headers',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return EchoAlphaOutput.attributeTypeMap;
+    }
+}
+
+export namespace EchoAlphaOutput {
+    export enum MethodEnum {
+        get = <any>'get',
+        post = <any>'post',
+    }
+}

package/model/echoV1Output.ts

@@ -0,0 +1,66 @@
+/**
+ * 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';
+
+/**
+ * Echo response.
+ */
+export class EchoV1Output {
+    /**
+     * The HTTP method used for this round-trip.  Currently, this endpoint supports only `get` and `post` methods.
+     */
+    'method': EchoV1Output.MethodEnum;
+    /**
+     * The string passed in the `message` input field.
+     */
+    'message': string;
+    /**
+     * The request\'s HTTP headers.
+     */
+    'headers': { [key: string]: any };
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'method',
+            baseName: 'method',
+            type: 'EchoV1Output.MethodEnum',
+        },
+        {
+            name: 'message',
+            baseName: 'message',
+            type: 'string',
+        },
+        {
+            name: 'headers',
+            baseName: 'headers',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return EchoV1Output.attributeTypeMap;
+    }
+}
+
+export namespace EchoV1Output {
+    export enum MethodEnum {
+        get = <any>'get',
+        post = <any>'post',
+    }
+}