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

package/model/propertyRenameBeta.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';
+
+export class PropertyRenameBeta {
+    /**
+     * The old name of the property.
+     */
+    'oldName': string;
+    /**
+     * The new name to rename the property.
+     */
+    'newName': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'oldName',
+            baseName: 'oldName',
+            type: 'string',
+        },
+        {
+            name: 'newName',
+            baseName: 'newName',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PropertyRenameBeta.attributeTypeMap;
+    }
+}

package/model/regulation.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 { StreamStatusV1 } from './streamStatusV1';
+
+/**
+ * The regulate request.
+ */
+export class Regulation {
+    /**
+     * The id of the regulate request.
+     */
+    'id': string;
+    /**
+     * The id of the Workspace that the regulate request belongs to.
+     */
+    'workspaceId': string;
+    /**
+     * The current status of the regulate request.
+     */
+    'overallStatus': Regulation.OverallStatusEnum;
+    /**
+     * The timestamp of when the request finished.
+     */
+    'finishedAt': string;
+    /**
+     * The timestamp of the creation of the request.
+     */
+    'createdAt': string;
+    /**
+     * The status of each stream including all the Destinations that correspond to the stream.
+     */
+    'streamStatus': Array<StreamStatusV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'workspaceId',
+            baseName: 'workspaceId',
+            type: 'string',
+        },
+        {
+            name: 'overallStatus',
+            baseName: 'overallStatus',
+            type: 'Regulation.OverallStatusEnum',
+        },
+        {
+            name: 'finishedAt',
+            baseName: 'finishedAt',
+            type: 'string',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+        {
+            name: 'streamStatus',
+            baseName: 'streamStatus',
+            type: 'Array<StreamStatusV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Regulation.attributeTypeMap;
+    }
+}
+
+export namespace Regulation {
+    export enum OverallStatusEnum {
+        FAILED = <any>'FAILED',
+        FINISHED = <any>'FINISHED',
+        INITIALIZED = <any>'INITIALIZED',
+        INVALID = <any>'INVALID',
+        NOT_SUPPORTED = <any>'NOT_SUPPORTED',
+        PARTIAL_SUCCESS = <any>'PARTIAL_SUCCESS',
+        RUNNING = <any>'RUNNING',
+    }
+}

package/model/regulationListEntryV1.ts

@@ -0,0 +1,77 @@
+/**
+ * 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';
+
+export class RegulationListEntryV1 {
+    'id': string;
+    'subjectType': string;
+    'subjects': Array<string>;
+    'status': RegulationListEntryV1.StatusEnum;
+    'createdAt': string;
+    'finishedAt'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'subjectType',
+            baseName: 'subjectType',
+            type: 'string',
+        },
+        {
+            name: 'subjects',
+            baseName: 'subjects',
+            type: 'Array<string>',
+        },
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'RegulationListEntryV1.StatusEnum',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+        {
+            name: 'finishedAt',
+            baseName: 'finishedAt',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RegulationListEntryV1.attributeTypeMap;
+    }
+}
+
+export namespace RegulationListEntryV1 {
+    export enum StatusEnum {
+        FAILED = <any>'FAILED',
+        FINISHED = <any>'FINISHED',
+        INITIALIZED = <any>'INITIALIZED',
+        INVALID = <any>'INVALID',
+        NOT_SUPPORTED = <any>'NOT_SUPPORTED',
+        PARTIAL_SUCCESS = <any>'PARTIAL_SUCCESS',
+        RUNNING = <any>'RUNNING',
+    }
+}

package/model/removeFilterFromDestination200Response.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 { RemoveFilterFromDestinationV1Output } from './removeFilterFromDestinationV1Output';
+
+export class RemoveFilterFromDestination200Response {
+    'data'?: RemoveFilterFromDestinationV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'RemoveFilterFromDestinationV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveFilterFromDestination200Response.attributeTypeMap;
+    }
+}

package/model/removeFilterFromDestinationV1Output.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';
+
+/**
+ * Output for DeleteDestinationFilterV1.
+ */
+export class RemoveFilterFromDestinationV1Output {
+    /**
+     * The status of delete operation.
+     */
+    'status': RemoveFilterFromDestinationV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'RemoveFilterFromDestinationV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveFilterFromDestinationV1Output.attributeTypeMap;
+    }
+}
+
+export namespace RemoveFilterFromDestinationV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/removeRuleV1.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 parameters needed to identify a rule on the backend-side.
+ */
+export class RemoveRuleV1 {
+    'type': RemoveRuleV1.TypeEnum;
+    'key'?: string;
+    'version': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'RemoveRuleV1.TypeEnum',
+        },
+        {
+            name: 'key',
+            baseName: 'key',
+            type: 'string',
+        },
+        {
+            name: 'version',
+            baseName: 'version',
+            type: 'number',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveRuleV1.attributeTypeMap;
+    }
+}
+
+export namespace RemoveRuleV1 {
+    export enum TypeEnum {
+        COMMON = <any>'COMMON',
+        GROUP = <any>'GROUP',
+        IDENTIFY = <any>'IDENTIFY',
+        PAGE = <any>'PAGE',
+        SCREEN = <any>'SCREEN',
+        TRACK = <any>'TRACK',
+    }
+}

package/model/removeRulesFromTrackingPlan200Response.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 { RemoveRulesFromTrackingPlanV1Output } from './removeRulesFromTrackingPlanV1Output';
+
+export class RemoveRulesFromTrackingPlan200Response {
+    'data'?: RemoveRulesFromTrackingPlanV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'RemoveRulesFromTrackingPlanV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveRulesFromTrackingPlan200Response.attributeTypeMap;
+    }
+}

package/model/removeRulesFromTrackingPlanV1Output.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';
+
+/**
+ * Remove specified rules from a Tracking Plan.
+ */
+export class RemoveRulesFromTrackingPlanV1Output {
+    /**
+     * The status of the operation.
+     */
+    'status': RemoveRulesFromTrackingPlanV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'RemoveRulesFromTrackingPlanV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveRulesFromTrackingPlanV1Output.attributeTypeMap;
+    }
+}
+
+export namespace RemoveRulesFromTrackingPlanV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/removeSourceConnectionFromWarehouse200Response.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 { RemoveSourceConnectionFromWarehouseV1Output } from './removeSourceConnectionFromWarehouseV1Output';
+
+export class RemoveSourceConnectionFromWarehouse200Response {
+    'data'?: RemoveSourceConnectionFromWarehouseV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'RemoveSourceConnectionFromWarehouseV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveSourceConnectionFromWarehouse200Response.attributeTypeMap;
+    }
+}

package/model/removeSourceConnectionFromWarehouseV1Output.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';
+
+/**
+ * Response indicating whether the disconnection was successful.
+ */
+export class RemoveSourceConnectionFromWarehouseV1Output {
+    /**
+     * The status of the request to disconnect the Source and Warehouse.
+     */
+    'status': RemoveSourceConnectionFromWarehouseV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'RemoveSourceConnectionFromWarehouseV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveSourceConnectionFromWarehouseV1Output.attributeTypeMap;
+    }
+}
+
+export namespace RemoveSourceConnectionFromWarehouseV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/removeSourceFromTrackingPlan200Response.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 { RemoveSourceFromTrackingPlanV1Output } from './removeSourceFromTrackingPlanV1Output';
+
+export class RemoveSourceFromTrackingPlan200Response {
+    'data'?: RemoveSourceFromTrackingPlanV1Output;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'RemoveSourceFromTrackingPlanV1Output',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveSourceFromTrackingPlan200Response.attributeTypeMap;
+    }
+}

package/model/removeSourceFromTrackingPlanV1Output.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';
+
+/**
+ * Disconnects a Source from a Tracking Plan.
+ */
+export class RemoveSourceFromTrackingPlanV1Output {
+    /**
+     * The operation status.
+     */
+    'status': RemoveSourceFromTrackingPlanV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'RemoveSourceFromTrackingPlanV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveSourceFromTrackingPlanV1Output.attributeTypeMap;
+    }
+}
+
+export namespace RemoveSourceFromTrackingPlanV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

package/model/removeSubscriptionFromDestination200Response.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 { RemoveSubscriptionFromDestinationAlphaOutput } from './removeSubscriptionFromDestinationAlphaOutput';
+
+export class RemoveSubscriptionFromDestination200Response {
+    'data'?: RemoveSubscriptionFromDestinationAlphaOutput;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'data',
+            baseName: 'data',
+            type: 'RemoveSubscriptionFromDestinationAlphaOutput',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return RemoveSubscriptionFromDestination200Response.attributeTypeMap;
+    }
+}