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

package/model/deleteTransformation200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { DeleteTransformationBetaOutput } from './deleteTransformationBetaOutput';
+
+export class DeleteTransformation200Response {
+    'data'?: DeleteTransformationBetaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'DeleteTransformationBetaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteTransformation200Response.attributeTypeMap;
+    }
+}

package/model/deleteTransformationBetaOutput.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 output of delete Transformation.
+ */
+export class DeleteTransformationBetaOutput {
+    /**
+     * The operation status.
+     */
+    'status': DeleteTransformationBetaOutput.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'DeleteTransformationBetaOutput.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteTransformationBetaOutput.attributeTypeMap;
+    }
+}
+
+export namespace DeleteTransformationBetaOutput {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/deleteUserGroup200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { DeleteUserGroupV1Output } from './deleteUserGroupV1Output';
+
+export class DeleteUserGroup200Response {
+    'data'?: DeleteUserGroupV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'DeleteUserGroupV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteUserGroup200Response.attributeTypeMap;
+    }
+}

package/model/deleteUserGroupV1Output.ts

@@ -0,0 +1,47 @@
+/**
+ * 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';
+
+/**
+ * Returns the status of the completed deletion operation.
+ */
+export class DeleteUserGroupV1Output {
+    /**
+     * A flag indicating the status of a successful deletion operation.
+     */
+    'status': DeleteUserGroupV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'DeleteUserGroupV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteUserGroupV1Output.attributeTypeMap;
+    }
+}
+
+export namespace DeleteUserGroupV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/deleteUsers200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { DeleteUsersV1Output } from './deleteUsersV1Output';
+
+export class DeleteUsers200Response {
+    'data'?: DeleteUsersV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'DeleteUsersV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteUsers200Response.attributeTypeMap;
+    }
+}

package/model/deleteUsersV1Output.ts

@@ -0,0 +1,47 @@
+/**
+ * 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';
+
+/**
+ * Returns the status of the removal operation.
+ */
+export class DeleteUsersV1Output {
+    /**
+     * A flag that indicates the status of a successful deletion operation.
+     */
+    'status': DeleteUsersV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'DeleteUsersV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteUsersV1Output.attributeTypeMap;
+    }
+}
+
+export namespace DeleteUsersV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/deleteWarehouse200Response.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { DeleteWarehouseV1Output } from './deleteWarehouseV1Output';
+
+export class DeleteWarehouse200Response {
+    'data'?: DeleteWarehouseV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'DeleteWarehouseV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteWarehouse200Response.attributeTypeMap;
+    }
+}

package/model/deleteWarehouseV1Output.ts

@@ -0,0 +1,47 @@
+/**
+ * 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';
+
+/**
+ * Returns the status of a Warehouse deletion.
+ */
+export class DeleteWarehouseV1Output {
+    /**
+     * The status of the Warehouse deletion operation.
+     */
+    'status': DeleteWarehouseV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'DeleteWarehouseV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeleteWarehouseV1Output.attributeTypeMap;
+    }
+}
+
+export namespace DeleteWarehouseV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/deliveryMetricsSummary.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 { MetricBeta } from './metricBeta';
+
+/**
+ * The delivery metrics summary returned.
+ */
+export class DeliveryMetricsSummary {
+    /**
+     * The Source id.  Config API note: analogous to `parent`.
+     */
+    'sourceId': string;
+    /**
+     * The Destination metadata id.
+     */
+    'destinationMetadataId': string;
+    /**
+     * The summary of event delivery metrics for the requested Destination.
+     */
+    'metrics': Array<MetricBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'destinationMetadataId',
+            baseName: 'destinationMetadataId',
+            type: 'string',
+        },
+        {
+            name: 'metrics',
+            baseName: 'metrics',
+            type: 'Array<MetricBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeliveryMetricsSummary.attributeTypeMap;
+    }
+}

package/model/deliveryMetricsSummaryBeta.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 { MetricBeta } from './metricBeta';
+
+/**
+ * Defines the summary of delivery metrics for a Destination.
+ */
+export class DeliveryMetricsSummaryBeta {
+    /**
+     * The Source id.  Config API note: analogous to `parent`.
+     */
+    'sourceId': string;
+    /**
+     * The Destination metadata id.
+     */
+    'destinationMetadataId': string;
+    /**
+     * The summary of event delivery metrics for the requested Destination.
+     */
+    'metrics': Array<MetricBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'destinationMetadataId',
+            baseName: 'destinationMetadataId',
+            type: 'string',
+        },
+        {
+            name: 'metrics',
+            baseName: 'metrics',
+            type: 'Array<MetricBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return DeliveryMetricsSummaryBeta.attributeTypeMap;
+    }
+}

package/model/destination.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { Metadata } from './metadata';
+
+/**
+ * The Destination looked up.
+ */
+export class Destination {
+    /**
+     * The unique identifier of this instance of a Destination.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The name of this instance of a Destination.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * Whether this instance of a Destination receives data.
+     */
+    'enabled': boolean;
+    'metadata': Metadata;
+    /**
+     * The id of a Source connected to this instance of a Destination.  Config API note: analogous to `parent`.
+     */
+    'sourceId': string;
+    /**
+     * The collection of settings associated with a Destination.  Config API note: equal to `config`.
+     */
+    'settings': { [key: string]: any };
+
+    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: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata',
+        },
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Destination.attributeTypeMap;
+    }
+}

package/model/destination1.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { Metadata } from './metadata';
+
+/**
+ * The updated Destination.
+ */
+export class Destination1 {
+    /**
+     * The unique identifier of this instance of a Destination.  Config API note: analogous to `name`.
+     */
+    'id': string;
+    /**
+     * The name of this instance of a Destination.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * Whether this instance of a Destination receives data.
+     */
+    'enabled': boolean;
+    'metadata': Metadata;
+    /**
+     * The id of a Source connected to this instance of a Destination.  Config API note: analogous to `parent`.
+     */
+    'sourceId': string;
+    /**
+     * The collection of settings associated with a Destination.  Config API note: equal to `config`.
+     */
+    'settings': { [key: string]: any };
+
+    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: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'metadata',
+            baseName: 'metadata',
+            type: 'Metadata',
+        },
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Destination1.attributeTypeMap;
+    }
+}