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

package/model/roleV1.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';
+
+/**
+ * Represents a role.
+ */
+export class RoleV1 {
+    /**
+     * The unique identifier of the role.
+     */
+    'id': string;
+    /**
+     * The human-readable name of the role.
+     */
+    'name': string;
+    /**
+     * The human-readable description of the role.
+     */
+    'description': 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: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RoleV1.attributeTypeMap;
+    }
+}

package/model/ruleV1.ts

@@ -0,0 +1,106 @@
+/**
+ * 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 a rule from a Tracking Plan.
+ */
+export class RuleV1 {
+    /**
+     * The type for this Tracking Plan rule.
+     */
+    'type': RuleV1.TypeEnum;
+    /**
+     * Key to this rule (free-form string like \'Button clicked\').
+     */
+    'key'?: string;
+    /**
+     * JSON Schema of this rule.
+     */
+    'jsonSchema': any | null;
+    /**
+     * Version of this rule.
+     */
+    'version': number;
+    /**
+     * The timestamp of this rule\'s creation.
+     */
+    'createdAt'?: string;
+    /**
+     * The timestamp of this rule\'s last change.
+     */
+    'updatedAt'?: string;
+    /**
+     * The timestamp of this rule\'s deprecation.
+     */
+    'deprecatedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'RuleV1.TypeEnum',
+        },
+        {
+            name: 'key',
+            baseName: 'key',
+            type: 'string',
+        },
+        {
+            name: 'jsonSchema',
+            baseName: 'jsonSchema',
+            type: 'any',
+        },
+        {
+            name: 'version',
+            baseName: 'version',
+            type: 'number',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+        {
+            name: 'updatedAt',
+            baseName: 'updatedAt',
+            type: 'string',
+        },
+        {
+            name: 'deprecatedAt',
+            baseName: 'deprecatedAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RuleV1.attributeTypeMap;
+    }
+}
+
+export namespace RuleV1 {
+    export enum TypeEnum {
+        COMMON = <any>'COMMON',
+        GROUP = <any>'GROUP',
+        IDENTIFY = <any>'IDENTIFY',
+        PAGE = <any>'PAGE',
+        SCREEN = <any>'SCREEN',
+        TRACK = <any>'TRACK',
+    }
+}

package/model/schedule.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 { WarehouseAdvancedSyncV1 } from './warehouseAdvancedSyncV1';
+
+/**
+ * The schedule that contains the schedule overrides for the specified Warehouse, if enabled.
+ */
+export class Schedule {
+    /**
+     * A list that contains the times when syncs should occur.
+     */
+    'times'?: Array<WarehouseAdvancedSyncV1>;
+    /**
+     * A TZ-database timezone for this sync schedule.
+     */
+    'timezone'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'times',
+            baseName: 'times',
+            type: 'Array<WarehouseAdvancedSyncV1>',
+        },
+        {
+            name: 'timezone',
+            baseName: 'timezone',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Schedule.attributeTypeMap;
+    }
+}

package/model/schedule1.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 { WarehouseAdvancedSyncV1 } from './warehouseAdvancedSyncV1';
+
+/**
+ * The full sync schedule for the Warehouse.
+ */
+export class Schedule1 {
+    /**
+     * A list that contains the times when syncs should occur.
+     */
+    'times': Array<WarehouseAdvancedSyncV1>;
+    /**
+     * A TZ-database timezone for this sync schedule.
+     */
+    'timezone': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'times',
+            baseName: 'times',
+            type: 'Array<WarehouseAdvancedSyncV1>',
+        },
+        {
+            name: 'timezone',
+            baseName: 'timezone',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Schedule1.attributeTypeMap;
+    }
+}

package/model/schedule2.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 { WarehouseAdvancedSyncV1 } from './warehouseAdvancedSyncV1';
+
+/**
+ * The schedule that contains the overrides for the Warehouse, if enabled.
+ */
+export class Schedule2 {
+    /**
+     * A list that contains the times when syncs should occur.
+     */
+    'times'?: Array<WarehouseAdvancedSyncV1>;
+    /**
+     * A TZ-database timezone for this sync schedule.
+     */
+    'timezone'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'times',
+            baseName: 'times',
+            type: 'Array<WarehouseAdvancedSyncV1>',
+        },
+        {
+            name: 'timezone',
+            baseName: 'timezone',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Schedule2.attributeTypeMap;
+    }
+}

package/model/settings.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 Source settings.
+ */
+export class Settings {
+    '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 Settings.attributeTypeMap;
+    }
+}

package/model/settings1.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 Settings1 {
+    '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 Settings1.attributeTypeMap;
+    }
+}

package/model/source.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';
+
+/**
+ * The Source where the events originated.
+ */
+export class Source {
+    /**
+     * 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 Source.attributeTypeMap;
+    }
+}

package/model/source1.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';
+
+/**
+ * The returned Source object.
+ */
+export class Source1 {
+    /**
+     * 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 Source1.attributeTypeMap;
+    }
+}