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

package/model/addLabelsToSourceV1Output.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { LabelV1 } from './labelV1';
+
+/**
+ * Applies an existing label to an existing Source.
+ */
+export class AddLabelsToSourceV1Output {
+    /**
+     * All labels applied to the Source.
+     */
+    'labels': Array<LabelV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<LabelV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddLabelsToSourceV1Output.attributeTypeMap;
+    }
+}

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

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

package/model/addPermissionsToUserGroupV1Input.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { PermissionInputV1 } from './permissionInputV1';
+
+/**
+ * Adds a list of permissions to a user group.
+ */
+export class AddPermissionsToUserGroupV1Input {
+    /**
+     * The permissions to add.
+     */
+    'permissions'?: Array<PermissionInputV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'permissions',
+            baseName: 'permissions',
+            type: 'Array<PermissionInputV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddPermissionsToUserGroupV1Input.attributeTypeMap;
+    }
+}

package/model/addPermissionsToUserGroupV1Output.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { AccessPermissionV1 } from './accessPermissionV1';
+
+/**
+ * Returns the group\'s permissions, including the added permissions.
+ */
+export class AddPermissionsToUserGroupV1Output {
+    /**
+     * The updated set of permissions assigned to the user group.
+     */
+    'permissions': Array<AccessPermissionV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'permissions',
+            baseName: 'permissions',
+            type: 'Array<AccessPermissionV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddPermissionsToUserGroupV1Output.attributeTypeMap;
+    }
+}

package/model/addPermissionsToUserV1Input.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { PermissionInputV1 } from './permissionInputV1';
+
+/**
+ * Adds a list of permissions to a user.
+ */
+export class AddPermissionsToUserV1Input {
+    /**
+     * The permissions to add.
+     */
+    'permissions'?: Array<PermissionInputV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'permissions',
+            baseName: 'permissions',
+            type: 'Array<PermissionInputV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddPermissionsToUserV1Input.attributeTypeMap;
+    }
+}

package/model/addPermissionsToUserV1Output.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { AccessPermissionV1 } from './accessPermissionV1';
+
+/**
+ * Returns the user\'s permissions, including the added permissions.
+ */
+export class AddPermissionsToUserV1Output {
+    /**
+     * The new permissions.
+     */
+    'permissions': Array<AccessPermissionV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'permissions',
+            baseName: 'permissions',
+            type: 'Array<AccessPermissionV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddPermissionsToUserV1Output.attributeTypeMap;
+    }
+}

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

package/model/addSourceToTrackingPlanV1Input.ts

@@ -0,0 +1,41 @@
+/**
+ * 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';
+
+/**
+ * Connects a Source to a Tracking Plan.
+ */
+export class AddSourceToTrackingPlanV1Input {
+    /**
+     * The id of the Source associated with the Tracking Plan.  Config API note: analogous to `sourceName`.
+     */
+    'sourceId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddSourceToTrackingPlanV1Input.attributeTypeMap;
+    }
+}

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

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

package/model/addUsersToUserGroupV1Input.ts

@@ -0,0 +1,41 @@
+/**
+ * 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';
+
+/**
+ * Adds a list of users and invites to a user group.
+ */
+export class AddUsersToUserGroupV1Input {
+    /**
+     * The email addresses of the users and invites to add.
+     */
+    'emails'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'emails',
+            baseName: 'emails',
+            type: 'Array<string>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AddUsersToUserGroupV1Input.attributeTypeMap;
+    }
+}

package/model/addUsersToUserGroupV1Output.ts

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

package/model/advancedWarehouseSyncScheduleV1Input.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { WarehouseAdvancedSyncV1 } from './warehouseAdvancedSyncV1';
+
+/**
+ * Defines the advanced sync schedule for a Warehouse.
+ */
+export class AdvancedWarehouseSyncScheduleV1Input {
+    /**
+     * A list that contains the times when syncs should occur.
+     */
+    'times': Array<WarehouseAdvancedSyncV1>;
+    /**
+     * A TZ-database timezone for this sync schedule.
+     */
+    'timezone': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'times',
+            baseName: 'times',
+            type: 'Array<WarehouseAdvancedSyncV1>',
+        },
+        {
+            name: 'timezone',
+            baseName: 'timezone',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AdvancedWarehouseSyncScheduleV1Input.attributeTypeMap;
+    }
+}

package/model/advancedWarehouseSyncScheduleV1Output.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { WarehouseAdvancedSyncV1 } from './warehouseAdvancedSyncV1';
+
+/**
+ * Defines the advanced sync schedule for a Warehouse.
+ */
+export class AdvancedWarehouseSyncScheduleV1Output {
+    /**
+     * A list that contains the times when syncs should occur.
+     */
+    'times'?: Array<WarehouseAdvancedSyncV1>;
+    /**
+     * A TZ-database timezone for this sync schedule.
+     */
+    'timezone'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'times',
+            baseName: 'times',
+            type: 'Array<WarehouseAdvancedSyncV1>',
+        },
+        {
+            name: 'timezone',
+            baseName: 'timezone',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AdvancedWarehouseSyncScheduleV1Output.attributeTypeMap;
+    }
+}