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

package/model/usersPerSourceSnapshotV1.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 snapshot of MTU metrics for a given Source within the given usage period.
+ */
+export class UsersPerSourceSnapshotV1 {
+    /**
+     * The Source id.
+     */
+    'sourceId': string;
+    /**
+     * The start of the usage period, in unix time (seconds since epoch).
+     */
+    'periodStart': number;
+    /**
+     * The end of the usage period, in unix time (seconds since epoch).
+     */
+    'periodEnd': number;
+    /**
+     * A bigint of the number of anonymous users in this snapshot.
+     */
+    'anonymous': string;
+    /**
+     * A bigint of the number of anonymous identified users in this snapshot.
+     */
+    'anonymousIdentified': string;
+    /**
+     * A bigint of the number of identified users in this snapshot.
+     */
+    'identified': string;
+    /**
+     * A bigint of the number of never identified users in this snapshot.
+     */
+    'neverIdentified': string;
+    /**
+     * The timestamp of this snapshot within the billing cycle, in the ISO-8601 format.
+     */
+    'timestamp': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'periodStart',
+            baseName: 'periodStart',
+            type: 'number',
+        },
+        {
+            name: 'periodEnd',
+            baseName: 'periodEnd',
+            type: 'number',
+        },
+        {
+            name: 'anonymous',
+            baseName: 'anonymous',
+            type: 'string',
+        },
+        {
+            name: 'anonymousIdentified',
+            baseName: 'anonymousIdentified',
+            type: 'string',
+        },
+        {
+            name: 'identified',
+            baseName: 'identified',
+            type: 'string',
+        },
+        {
+            name: 'neverIdentified',
+            baseName: 'neverIdentified',
+            type: 'string',
+        },
+        {
+            name: 'timestamp',
+            baseName: 'timestamp',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UsersPerSourceSnapshotV1.attributeTypeMap;
+    }
+}

package/model/warehouse.ts

@@ -0,0 +1,75 @@
+/**
+ * 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 { Metadata2 } from './metadata2';
+
+/**
+ * The returned Warehouse object.
+ */
+export class Warehouse {
+    /**
+     * The id of the Warehouse.
+     */
+    'id': string;
+    'metadata': Metadata2;
+    /**
+     * The id of the Workspace that owns this Warehouse.
+     */
+    'workspaceId': string;
+    /**
+     * When set to true, this Warehouse receives data.
+     */
+    'enabled': boolean;
+    /**
+     * The settings associated with this Warehouse.  Common settings are connection-related configuration used to connect to it, for example host, username, and port.
+     */
+    'settings': any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata2',
+        },
+        {
+            name: 'workspaceId',
+            baseName: 'workspaceId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Warehouse.attributeTypeMap;
+    }
+}

package/model/warehouse1.ts

@@ -0,0 +1,75 @@
+/**
+ * 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 { Metadata2 } from './metadata2';
+
+/**
+ * The newly created Warehouse.
+ */
+export class Warehouse1 {
+    /**
+     * The id of the Warehouse.
+     */
+    'id': string;
+    'metadata': Metadata2;
+    /**
+     * The id of the Workspace that owns this Warehouse.
+     */
+    'workspaceId': string;
+    /**
+     * When set to true, this Warehouse receives data.
+     */
+    'enabled': boolean;
+    /**
+     * The settings associated with this Warehouse.  Common settings are connection-related configuration used to connect to it, for example host, username, and port.
+     */
+    'settings': any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata2',
+        },
+        {
+            name: 'workspaceId',
+            baseName: 'workspaceId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Warehouse1.attributeTypeMap;
+    }
+}

package/model/warehouse2.ts

@@ -0,0 +1,75 @@
+/**
+ * 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 { Metadata2 } from './metadata2';
+
+/**
+ * The updated Warehouse.
+ */
+export class Warehouse2 {
+    /**
+     * The id of the Warehouse.
+     */
+    'id': string;
+    'metadata': Metadata2;
+    /**
+     * The id of the Workspace that owns this Warehouse.
+     */
+    'workspaceId': string;
+    /**
+     * When set to true, this Warehouse receives data.
+     */
+    'enabled': boolean;
+    /**
+     * The settings associated with this Warehouse.  Common settings are connection-related configuration used to connect to it, for example host, username, and port.
+     */
+    'settings': any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata2',
+        },
+        {
+            name: 'workspaceId',
+            baseName: 'workspaceId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Warehouse2.attributeTypeMap;
+    }
+}

package/model/warehouseAdvancedSyncV1.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';
+
+/**
+ * Determines the time of day at which a Warehouse should sync.
+ */
+export class WarehouseAdvancedSyncV1 {
+    /**
+     * The hour of day for which to enable/disable a sync, between 0 and 23.
+     */
+    'hourOfDay': number;
+    /**
+     * Enable to the sync at the specified hour.
+     */
+    'enabled': boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'hourOfDay',
+            baseName: 'hourOfDay',
+            type: 'number',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return WarehouseAdvancedSyncV1.attributeTypeMap;
+    }
+}

package/model/warehouseMetadata.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 Warehouse catalog item.
+ */
+export class WarehouseMetadata {
+    /**
+     * 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 WarehouseMetadata.attributeTypeMap;
+    }
+}

package/model/warehouseMetadataV1.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 an instance of Segment’s data Warehouse product.
+ */
+export class WarehouseMetadataV1 {
+    /**
+     * 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 WarehouseMetadataV1.attributeTypeMap;
+    }
+}

package/model/warehouseSelectiveSyncItemV1.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 entry in the Warehouse Selective Sync schema for a Warehouse and Source pair.
+ */
+export class WarehouseSelectiveSyncItemV1 {
+    /**
+     * The Source id attached to this Warehouse.
+     */
+    'sourceId': string;
+    /**
+     * The collection within the Source.
+     */
+    'collection': string;
+    /**
+     * The id of the Warehouse this sync belongs to.
+     */
+    'warehouseId': string;
+    /**
+     * A map that contains the properties within the collection to which the Warehouse should sync.
+     */
+    'properties': { [key: string]: any };
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'collection',
+            baseName: 'collection',
+            type: 'string',
+        },
+        {
+            name: 'warehouseId',
+            baseName: 'warehouseId',
+            type: 'string',
+        },
+        {
+            name: 'properties',
+            baseName: 'properties',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return WarehouseSelectiveSyncItemV1.attributeTypeMap;
+    }
+}

package/model/warehouseSyncOverrideV1.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 the override for a Source/collection/property? path to apply to a Warehouse.
+ */
+export class WarehouseSyncOverrideV1 {
+    /**
+     * The id of the Source this schema item applies to.
+     */
+    'sourceId': string;
+    /**
+     * The collection the schema item override applies to.
+     */
+    'collection'?: string;
+    /**
+     * Enable to apply the override.
+     */
+    'enabled': boolean;
+    /**
+     * A property within the collection to which the override applies.
+     */
+    'property'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'collection',
+            baseName: 'collection',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'property',
+            baseName: 'property',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return WarehouseSyncOverrideV1.attributeTypeMap;
+    }
+}