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

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

package/model/listTrackingPlansV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { TrackingPlanV1 } from './trackingPlanV1';
+
+/**
+ * Lists the Tracking Plans associated with the current Workspace.
+ */
+export class ListTrackingPlansV1Output {
+    /**
+     * A paginated list of Tracking Plans.
+     */
+    'trackingPlans': Array<TrackingPlanV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'trackingPlans',
+            baseName: 'trackingPlans',
+            type: 'Array<TrackingPlanV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListTrackingPlansV1Output.attributeTypeMap;
+    }
+}

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

package/model/listTransformationsBetaOutput.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { TransformationBeta } from './transformationBeta';
+
+/**
+ * Lists the Transformations associated with the current Workspace.
+ */
+export class ListTransformationsBetaOutput {
+    /**
+     * A paginated list of Transformations.
+     */
+    'transformations': Array<TransformationBeta>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'transformations',
+            baseName: 'transformations',
+            type: 'Array<TransformationBeta>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListTransformationsBetaOutput.attributeTypeMap;
+    }
+}

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

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

package/model/listUserGroupsFromUserV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { MinimalUserGroupV1 } from './minimalUserGroupV1';
+import { Pagination } from './pagination';
+
+/**
+ * Returns all user groups the user belongs to.
+ */
+export class ListUserGroupsFromUserV1Output {
+    /**
+     * The user groups that the user belongs to.
+     */
+    'groups': Array<MinimalUserGroupV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'groups',
+            baseName: 'groups',
+            type: 'Array<MinimalUserGroupV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListUserGroupsFromUserV1Output.attributeTypeMap;
+    }
+}

package/model/listUserGroupsV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { UserGroupV1 } from './userGroupV1';
+
+/**
+ * Returns a list of user groups with the given Workspace id.
+ */
+export class ListUserGroupsV1Output {
+    /**
+     * The user group returned from the query.
+     */
+    'userGroups': Array<UserGroupV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'userGroups',
+            baseName: 'userGroups',
+            type: 'Array<UserGroupV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListUserGroupsV1Output.attributeTypeMap;
+    }
+}

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

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

package/model/listUsersFromUserGroupV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { MinimalUserV1 } from './minimalUserV1';
+import { Pagination } from './pagination';
+
+/**
+ * Returns the members of a user group with the given group id.
+ */
+export class ListUsersFromUserGroupV1Output {
+    /**
+     * The users of the user group.
+     */
+    'users': Array<MinimalUserV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'users',
+            baseName: 'users',
+            type: 'Array<MinimalUserV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListUsersFromUserGroupV1Output.attributeTypeMap;
+    }
+}

package/model/listUsersV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { UserV1 } from './userV1';
+
+/**
+ * Returns the list of users.
+ */
+export class ListUsersV1Output {
+    /**
+     * The list of users.
+     */
+    'users': Array<UserV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'users',
+            baseName: 'users',
+            type: 'Array<UserV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListUsersV1Output.attributeTypeMap;
+    }
+}

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

package/model/listWarehousesV1Output.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { WarehouseV1 } from './warehouseV1';
+
+/**
+ * Returns a list of Warehouses that belong to a Workspace.
+ */
+export class ListWarehousesV1Output {
+    /**
+     * A list of Warehouses that belong to the Workspace.
+     */
+    'warehouses': Array<WarehouseV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'warehouses',
+            baseName: 'warehouses',
+            type: 'Array<WarehouseV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListWarehousesV1Output.attributeTypeMap;
+    }
+}

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