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

package/model/sourceAlpha.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 { LabelV1 } from './labelV1';
+import { Metadata1 } from './metadata1';
+
+/**
+ * Defines a data Source for Segment data.
+ */
+export class SourceAlpha {
+    /**
+     * The id of the Source.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The slug used to identify the Source in the Segment app.  Config API note: equal to `name`.
+     */
+    'slug': string;
+    /**
+     * The name of the Source.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    'metadata': Metadata1;
+    /**
+     * The id of the Workspace that owns the Source.  Config API note: equal to `parent`.
+     */
+    'workspaceId': string;
+    /**
+     * Enable to receive data from the Source.
+     */
+    'enabled': boolean;
+    /**
+     * The write keys used to send data from the Source. This field is left empty when the current token does not have the \'source admin\' permission.
+     */
+    'writeKeys': Array<string>;
+    /**
+     * The settings associated with the Source.
+     */
+    'settings'?: any;
+    /**
+     * A list of labels applied to the Source.
+     */
+    'labels': Array<LabelV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata1',
+        },
+        {
+            name: 'workspaceId',
+            baseName: 'workspaceId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'writeKeys',
+            baseName: 'writeKeys',
+            type: 'Array<string>',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<LabelV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SourceAlpha.attributeTypeMap;
+    }
+}

package/model/sourceEventVolumeDatapointV1.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';
+
+/**
+ * SourceEventVolumeDatapoint represents an individual timestamp/event count pair corresponding to a window of time designated by the granularity.
+ */
+export class SourceEventVolumeDatapointV1 {
+    /**
+     * The timestamp that corresponds to the beginning of the window given by the requested granularity.
+     */
+    'time': string;
+    /**
+     * The number of valid events Segment received in the given window, after the events completed the validation process.
+     */
+    'count': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'time',
+            baseName: 'time',
+            type: 'string',
+        },
+        {
+            name: 'count',
+            baseName: 'count',
+            type: 'number',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SourceEventVolumeDatapointV1.attributeTypeMap;
+    }
+}

package/model/sourceEventVolumeV1.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { Source } from './source';
+import { SourceEventVolumeDatapointV1 } from './sourceEventVolumeDatapointV1';
+
+/**
+ * SourceEventVolume represents a time series of event volume for a Workspace broken down by the dimensions which the customer specifies (optional parameters).
+ */
+export class SourceEventVolumeV1 {
+    'source': Source;
+    /**
+     * The name of the event, if applicable.
+     */
+    'eventName'?: string;
+    /**
+     * The event type, if applicable.
+     */
+    'eventType'?: string;
+    /**
+     * The total count for all events in the requested time frame.
+     */
+    'total': number;
+    /**
+     * A list of the event counts broken down by the requested granularity.
+     */
+    'series': Array<SourceEventVolumeDatapointV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'source',
+            baseName: 'source',
+            type: 'Source',
+        },
+        {
+            name: 'eventName',
+            baseName: 'eventName',
+            type: 'string',
+        },
+        {
+            name: 'eventType',
+            baseName: 'eventType',
+            type: 'string',
+        },
+        {
+            name: 'total',
+            baseName: 'total',
+            type: 'number',
+        },
+        {
+            name: 'series',
+            baseName: 'series',
+            type: 'Array<SourceEventVolumeDatapointV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SourceEventVolumeV1.attributeTypeMap;
+    }
+}

package/model/sourceMetadata.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 catalog item matched by id.
+ */
+export class SourceMetadata {
+    /**
+     * 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 SourceMetadata.attributeTypeMap;
+    }
+}

package/model/sourceMetadataV1.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';
+
+/**
+ * A website, server library, mobile SDK, or cloud application which can send data into Segment.
+ */
+export class SourceMetadataV1 {
+    /**
+     * 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 SourceMetadataV1.attributeTypeMap;
+    }
+}

package/model/sourceSettingsOutputV1.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { Group } from './group';
+import { Identify } from './identify';
+import { Track } from './track';
+
+/**
+ * The output of Source settings.
+ */
+export class SourceSettingsOutputV1 {
+    'track'?: Track;
+    'identify'?: Identify;
+    'group'?: Group;
+    /**
+     * SourceId to forward violations to.
+     */
+    'forwardingViolationsTo'?: string;
+    /**
+     * SourceId to forward blocked events to.
+     */
+    'forwardingBlockedEventsTo'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'track',
+            baseName: 'track',
+            type: 'Track',
+        },
+        {
+            name: 'identify',
+            baseName: 'identify',
+            type: 'Identify',
+        },
+        {
+            name: 'group',
+            baseName: 'group',
+            type: 'Group',
+        },
+        {
+            name: 'forwardingViolationsTo',
+            baseName: 'forwardingViolationsTo',
+            type: 'string',
+        },
+        {
+            name: 'forwardingBlockedEventsTo',
+            baseName: 'forwardingBlockedEventsTo',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SourceSettingsOutputV1.attributeTypeMap;
+    }
+}

package/model/sourceV1.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 { LabelV1 } from './labelV1';
+import { Metadata1 } from './metadata1';
+
+/**
+ * Defines a data Source for Segment data.
+ */
+export class SourceV1 {
+    /**
+     * The id of the Source.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The slug used to identify the Source in the Segment app.  Config API note: equal to `name`.
+     */
+    'slug': string;
+    /**
+     * The name of the Source.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    'metadata': Metadata1;
+    /**
+     * The id of the Workspace that owns the Source.  Config API note: equal to `parent`.
+     */
+    'workspaceId': string;
+    /**
+     * Enable to receive data from the Source.
+     */
+    'enabled': boolean;
+    /**
+     * The write keys used to send data from the Source. This field is left empty when the current token does not have the \'source admin\' permission.
+     */
+    'writeKeys': Array<string>;
+    /**
+     * The settings associated with the Source.
+     */
+    'settings'?: any;
+    /**
+     * A list of labels applied to the Source.
+     */
+    'labels': Array<LabelV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata1',
+        },
+        {
+            name: 'workspaceId',
+            baseName: 'workspaceId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'writeKeys',
+            baseName: 'writeKeys',
+            type: 'Array<string>',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<LabelV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return SourceV1.attributeTypeMap;
+    }
+}

package/model/space.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';
+
+/**
+ * Space matching the given id.
+ */
+export class Space {
+    'id': string;
+    'slug': string;
+    'name': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'slug',
+            baseName: 'slug',
+            type: 'string',
+        },
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Space.attributeTypeMap;
+    }
+}