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

package/model/metadata1.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 { IntegrationOptionBeta } from './integrationOptionBeta';
+import { Logos1 } from './logos1';
+
+/**
+ * The metadata for the Source.  Config API note: includes `catalogName` and `catalogId`.
+ */
+export class Metadata1 {
+    /**
+     * The id for this Source metadata in the Segment catalog.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The user-friendly name of this Source.  Config API note: equal to `displayName`.
+     */
+    'name': string;
+    /**
+     * The slug that identifies this Source in the Segment app.  Config API note: equal to `name`.
+     */
+    'slug': string;
+    /**
+     * The description of this Source.
+     */
+    'description': string;
+    'logos': Logos1;
+    /**
+     * Options for this Source.
+     */
+    'options': Array<IntegrationOptionBeta>;
+    /**
+     * A list of categories this Source belongs to.
+     */
+    'categories': Array<string>;
+    /**
+     * True if this is a Cloud Event Source.
+     */
+    'isCloudEventSource': 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: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'logos',
+            baseName: 'logos',
+            type: 'Logos1',
+        },
+        {
+            name: 'options',
+            baseName: 'options',
+            type: 'Array<IntegrationOptionBeta>',
+        },
+        {
+            name: 'categories',
+            baseName: 'categories',
+            type: 'Array<string>',
+        },
+        {
+            name: 'isCloudEventSource',
+            baseName: 'isCloudEventSource',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Metadata1.attributeTypeMap;
+    }
+}

package/model/metadata2.ts

@@ -0,0 +1,85 @@
+/**
+ * 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 { IntegrationOptionBeta } from './integrationOptionBeta';
+import { Logos2 } from './logos2';
+
+/**
+ * The metadata for the Warehouse.
+ */
+export class Metadata2 {
+    /**
+     * The id of this object.
+     */
+    'id': string;
+    /**
+     * The name of this object.
+     */
+    'name': string;
+    /**
+     * A human-readable, unique identifier for object.
+     */
+    'slug': string;
+    /**
+     * A description, in English, of this object.
+     */
+    'description': string;
+    'logos': Logos2;
+    /**
+     * The Integration options for this object.
+     */
+    'options': Array<IntegrationOptionBeta>;
+
+    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',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'logos',
+            baseName: 'logos',
+            type: 'Logos2',
+        },
+        {
+            name: 'options',
+            baseName: 'options',
+            type: 'Array<IntegrationOptionBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Metadata2.attributeTypeMap;
+    }
+}

package/model/metricBeta.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { BreakdownBeta } from './breakdownBeta';
+
+/**
+ * The event delivery metric.
+ */
+export class MetricBeta {
+    /**
+     * The name of the metric.
+     */
+    'metricName': string;
+    /**
+     * Number of occurrences of the metric.
+     */
+    'total': number;
+    /**
+     * Breakdown of metrics within a metric.
+     */
+    'breakdown'?: Array<BreakdownBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'metricName',
+            baseName: 'metricName',
+            type: 'string',
+        },
+        {
+            name: 'total',
+            baseName: 'total',
+            type: 'number',
+        },
+        {
+            name: 'breakdown',
+            baseName: 'breakdown',
+            type: 'Array<BreakdownBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return MetricBeta.attributeTypeMap;
+    }
+}

package/model/minimalUserGroupV1.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 least amount of information needed to identify a user group.
+ */
+export class MinimalUserGroupV1 {
+    /**
+     * The id of the user group.
+     */
+    'id': string;
+    /**
+     * The name of the user group.
+     */
+    'name': 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',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return MinimalUserGroupV1.attributeTypeMap;
+    }
+}

package/model/minimalUserV1.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';
+
+/**
+ * A user belonging to a Segment Workspace.
+ */
+export class MinimalUserV1 {
+    /**
+     * The unique identifier of this user.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The human-readable name of this user.
+     */
+    'name': string;
+    /**
+     * The email address associated with this user.
+     */
+    'email': 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: 'email',
+            baseName: 'email',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return MinimalUserV1.attributeTypeMap;
+    }
+}