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

package/model/edgeFunctions.ts

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

@@ -0,0 +1,86 @@
+/**
+ * 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 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/edgeFunctionsAlpha.ts

@@ -0,0 +1,86 @@
+/**
+ * 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 an Edge Function bundle.
+ */
+export class EdgeFunctionsAlpha {
+    /**
+     * 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 EdgeFunctionsAlpha.attributeTypeMap;
+    }
+}

package/model/eventSourceV1.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';
+
+/**
+ * Source represents a Segment Source.
+ */
+export class EventSourceV1 {
+    /**
+     * The id of the Source where the events came from.
+     */
+    'id': string;
+    /**
+     * The name of the Source, if applicable.
+     */
+    'name'?: string;
+    /**
+     * The slug of the Source, if applicable.
+     */
+    'slug'?: 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: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return EventSourceV1.attributeTypeMap;
+    }
+}

package/model/filter.ts

@@ -0,0 +1,51 @@
+/**
+ * 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';
+
+/**
+ * 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

@@ -0,0 +1,123 @@
+/**
+ * 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';
+
+/**
+ * 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

@@ -0,0 +1,123 @@
+/**
+ * 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';
+
+/**
+ * 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;
+    }
+}