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

package/model/createDestination200Response.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 { CreateDestinationV1Output } from './createDestinationV1Output';
+
+export class CreateDestination200Response {
+    'data'?: CreateDestinationV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateDestinationV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateDestination200Response.attributeTypeMap;
+    }
+}

package/model/createDestinationSubscription200Response.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 { CreateDestinationSubscriptionAlphaOutput } from './createDestinationSubscriptionAlphaOutput';
+
+export class CreateDestinationSubscription200Response {
+    'data'?: CreateDestinationSubscriptionAlphaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateDestinationSubscriptionAlphaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateDestinationSubscription200Response.attributeTypeMap;
+    }
+}

package/model/createDestinationSubscriptionAlphaInput.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';
+
+/**
+ * The basic input parameters for creating a Destination subscription.
+ */
+export class CreateDestinationSubscriptionAlphaInput {
+    /**
+     * A user-defined name for the subscription.
+     */
+    'name': string;
+    /**
+     * The associated action id the subscription should trigger.
+     */
+    'actionId': 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: 'actionId',
+            baseName: 'actionId',
+            type: 'string',
+        },
+        {
+            name: 'trigger',
+            baseName: 'trigger',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateDestinationSubscriptionAlphaInput.attributeTypeMap;
+    }
+}

package/model/createDestinationSubscriptionAlphaOutput.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 { DestinationSubscription } from './destinationSubscription';
+
+/**
+ * Returns a newly created Destination subscription.
+ */
+export class CreateDestinationSubscriptionAlphaOutput {
+    'destinationSubscription': DestinationSubscription;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'destinationSubscription',
+            baseName: 'destinationSubscription',
+            type: 'DestinationSubscription',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateDestinationSubscriptionAlphaOutput.attributeTypeMap;
+    }
+}

package/model/createDestinationV1Input.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';
+
+/**
+ * Creates a new Destination.
+ */
+export class CreateDestinationV1Input {
+    /**
+     * The id of the Source to connect to this Destination instance.  Config API note: analogous to `parent`.
+     */
+    'sourceId': string;
+    /**
+     * The id of the metadata to link to the new Destination.
+     */
+    'metadataId': string;
+    /**
+     * Whether this Destination should receive data.
+     */
+    'enabled'?: boolean;
+    /**
+     * Defines the display name of the Destination.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * An object that contains settings for the Destination based on the \"required\" and \"advanced\" settings present in the Destination metadata.  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: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'metadataId',
+            baseName: 'metadataId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateDestinationV1Input.attributeTypeMap;
+    }
+}

package/model/createDestinationV1Output.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 { Destination2 } from './destination2';
+
+/**
+ * Creates a new Destination.
+ */
+export class CreateDestinationV1Output {
+    'destination': Destination2;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'destination',
+            baseName: 'destination',
+            type: 'Destination2',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateDestinationV1Output.attributeTypeMap;
+    }
+}

package/model/createEdgeFunctions200Response.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 { CreateEdgeFunctionsAlphaOutput } from './createEdgeFunctionsAlphaOutput';
+
+export class CreateEdgeFunctions200Response {
+    'data'?: CreateEdgeFunctionsAlphaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateEdgeFunctionsAlphaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateEdgeFunctions200Response.attributeTypeMap;
+    }
+}

package/model/createEdgeFunctionsAlphaInput.ts

@@ -0,0 +1,41 @@
+/**
+ * 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';
+
+/**
+ * Input for CreateEdgeFunctions.
+ */
+export class CreateEdgeFunctionsAlphaInput {
+    /**
+     * The id of the Source associated with this Edge Function.
+     */
+    'uploadURL': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'uploadURL',
+            baseName: 'uploadURL',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateEdgeFunctionsAlphaInput.attributeTypeMap;
+    }
+}

package/model/createEdgeFunctionsAlphaOutput.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 { EdgeFunctions } from './edgeFunctions';
+
+/**
+ * Output for CreateEdgeFunctions.
+ */
+export class CreateEdgeFunctionsAlphaOutput {
+    'edgeFunctions': EdgeFunctions;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'edgeFunctions',
+            baseName: 'edgeFunctions',
+            type: 'EdgeFunctions',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateEdgeFunctionsAlphaOutput.attributeTypeMap;
+    }
+}

package/model/createFilterForDestination200Response.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 { CreateFilterForDestinationV1Output } from './createFilterForDestinationV1Output';
+
+export class CreateFilterForDestination200Response {
+    'data'?: CreateFilterForDestinationV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateFilterForDestinationV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFilterForDestination200Response.attributeTypeMap;
+    }
+}

package/model/createFilterForDestinationV1Input.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 { DestinationFilterActionV1 } from './destinationFilterActionV1';
+
+/**
+ * Input for CreateDestinationFilterV1.
+ */
+export class CreateFilterForDestinationV1Input {
+    /**
+     * The id of the Source associated with this filter.
+     */
+    'sourceId'?: string;
+    /**
+     * The filter\'s condition.
+     */
+    'if': string;
+    /**
+     * Actions for the Destination filter.
+     */
+    'actions': Array<DestinationFilterActionV1>;
+    /**
+     * The title of the filter.
+     */
+    'title'?: string;
+    /**
+     * The description of the filter.
+     */
+    'description'?: string;
+    /**
+     * When set to true, the Destination filter is active.
+     */
+    'enabled': boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            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',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFilterForDestinationV1Input.attributeTypeMap;
+    }
+}

package/model/createFilterForDestinationV1Output.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 { Filter2 } from './filter2';
+
+/**
+ * Output for CreateDestinationFiltersV1.
+ */
+export class CreateFilterForDestinationV1Output {
+    'filter': Filter2;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'filter',
+            baseName: 'filter',
+            type: 'Filter2',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFilterForDestinationV1Output.attributeTypeMap;
+    }
+}

package/model/createFunction200Response.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 { CreateFunctionV1Output } from './createFunctionV1Output';
+
+export class CreateFunction200Response {
+    'data'?: CreateFunctionV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateFunctionV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFunction200Response.attributeTypeMap;
+    }
+}

package/model/createFunctionDeployment200Response.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 { CreateFunctionDeploymentV1Output } from './createFunctionDeploymentV1Output';
+
+export class CreateFunctionDeployment200Response {
+    'data'?: CreateFunctionDeploymentV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'CreateFunctionDeploymentV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFunctionDeployment200Response.attributeTypeMap;
+    }
+}