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

package/model/updateWarehouseV1Input.ts

@@ -1,59 +0,0 @@
-/**
- * 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.1
- * 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';
-
-/**
- * Updates an existing Warehouse based on a set of parameters.
- */
-export class UpdateWarehouseV1Input {
-    /**
-     * An optional human-readable name to associate with this Warehouse.
-     */
-    'name'?: string | null;
-    /**
-     * Enable to allow this Warehouse to receive data.
-     */
-    'enabled'?: boolean;
-    /**
-     * A key-value object that contains instance-specific settings for a Warehouse.  Different kinds of Warehouses require different settings. The required and optional settings for a Warehouse are described in the `options` object of the associated Warehouse metadata.  You can find the full list of Warehouse metadata and related settings information in the `/catalog/warehouses` endpoint.
-     */
-    'settings'?: any;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-        {
-            name: 'enabled',
-            baseName: 'enabled',
-            type: 'boolean',
-        },
-        {
-            name: 'settings',
-            baseName: 'settings',
-            type: 'any',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UpdateWarehouseV1Input.attributeTypeMap;
-    }
-}

package/model/updateWarehouseV1Output.ts

@@ -1,39 +0,0 @@
-/**
- * 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.1
- * 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 { Warehouse2 } from './warehouse2';
-
-/**
- * Returns the updated Warehouse.
- */
-export class UpdateWarehouseV1Output {
-    'warehouse': Warehouse2;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'warehouse',
-            baseName: 'warehouse',
-            type: 'Warehouse2',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UpdateWarehouseV1Output.attributeTypeMap;
-    }
-}

package/model/upsertRuleV1.ts

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

package/model/user.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * The user object.
- */
-export class User {
-    /**
-     * The unique identifier of this user.  Config API note: analogous to `name`.
-     */
-    'id': string;
-    /**
-     * The human-readable name of this user.
-     */
-    'name': string;
-    /**
-     * The email address associated with this user.
-     */
-    'email': string;
-    /**
-     * The permissions associated with this user.
-     */
-    'permissions'?: Array<PermissionV1>;
-
-    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: 'email',
-            baseName: 'email',
-            type: 'string',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return User.attributeTypeMap;
-    }
-}

package/model/userGroup.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * The newly created user group.
- */
-export class UserGroup {
-    /**
-     * The number of members in the user group.
-     */
-    'memberCount': number;
-    /**
-     * The permissions associated with the user group.
-     */
-    'permissions'?: Array<PermissionV1>;
-    /**
-     * The id of the user group.
-     */
-    'id': string;
-    /**
-     * The name of the user group.
-     */
-    'name': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'memberCount',
-            baseName: 'memberCount',
-            type: 'number',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UserGroup.attributeTypeMap;
-    }
-}

package/model/userGroup1.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * The updated the user group.
- */
-export class UserGroup1 {
-    /**
-     * The number of members in the user group.
-     */
-    'memberCount': number;
-    /**
-     * The permissions associated with the user group.
-     */
-    'permissions'?: Array<PermissionV1>;
-    /**
-     * The id of the user group.
-     */
-    'id': string;
-    /**
-     * The name of the user group.
-     */
-    'name': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'memberCount',
-            baseName: 'memberCount',
-            type: 'number',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UserGroup1.attributeTypeMap;
-    }
-}

package/model/userGroup2.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * The user group returned from the query.
- */
-export class UserGroup2 {
-    /**
-     * The number of members in the user group.
-     */
-    'memberCount': number;
-    /**
-     * The permissions associated with the user group.
-     */
-    'permissions'?: Array<PermissionV1>;
-    /**
-     * The id of the user group.
-     */
-    'id': string;
-    /**
-     * The name of the user group.
-     */
-    'name': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'memberCount',
-            baseName: 'memberCount',
-            type: 'number',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UserGroup2.attributeTypeMap;
-    }
-}

package/model/userGroup3.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * The updated user group.
- */
-export class UserGroup3 {
-    /**
-     * The number of members in the user group.
-     */
-    'memberCount': number;
-    /**
-     * The permissions associated with the user group.
-     */
-    'permissions'?: Array<PermissionV1>;
-    /**
-     * The id of the user group.
-     */
-    'id': string;
-    /**
-     * The name of the user group.
-     */
-    'name': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'memberCount',
-            baseName: 'memberCount',
-            type: 'number',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UserGroup3.attributeTypeMap;
-    }
-}

package/model/userGroupV1.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * A set of users with a set of shared permissions.
- */
-export class UserGroupV1 {
-    /**
-     * The number of members in the user group.
-     */
-    'memberCount': number;
-    /**
-     * The permissions associated with the user group.
-     */
-    'permissions'?: Array<PermissionV1>;
-    /**
-     * The id of the user group.
-     */
-    'id': string;
-    /**
-     * The name of the user group.
-     */
-    'name': string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'memberCount',
-            baseName: 'memberCount',
-            type: 'number',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-        {
-            name: 'id',
-            baseName: 'id',
-            type: 'string',
-        },
-        {
-            name: 'name',
-            baseName: 'name',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UserGroupV1.attributeTypeMap;
-    }
-}

package/model/userV1.ts

@@ -1,69 +0,0 @@
-/**
- * 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.1
- * 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 { PermissionV1 } from './permissionV1';
-
-/**
- * A user belonging to a Segment Workspace.
- */
-export class UserV1 {
-    /**
-     * The unique identifier of this user.  Config API note: analogous to `name`.
-     */
-    'id': string;
-    /**
-     * The human-readable name of this user.
-     */
-    'name': string;
-    /**
-     * The email address associated with this user.
-     */
-    'email': string;
-    /**
-     * The permissions associated with this user.
-     */
-    'permissions'?: Array<PermissionV1>;
-
-    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: 'email',
-            baseName: 'email',
-            type: 'string',
-        },
-        {
-            name: 'permissions',
-            baseName: 'permissions',
-            type: 'Array<PermissionV1>',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return UserV1.attributeTypeMap;
-    }
-}