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

package/model/getWarehousesCatalogV1Output.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 { WarehouseMetadataV1 } from './warehouseMetadataV1';
+
+/**
+ * Returns a list of all Warehouse catalog items contained within a given page.
+ */
+export class GetWarehousesCatalogV1Output {
+    /**
+     * All Warehouse catalog items contained within the requested page.
+     */
+    'warehousesCatalog': Array<WarehouseMetadataV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'warehousesCatalog',
+            baseName: 'warehousesCatalog',
+            type: 'Array<WarehouseMetadataV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GetWarehousesCatalogV1Output.attributeTypeMap;
+    }
+}

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

package/model/getWorkspaceV1Output.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 { Workspace } from './workspace';
+
+/**
+ * Represents the output of loading the Workspace.
+ */
+export class GetWorkspaceV1Output {
+    'workspace': Workspace;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'workspace',
+            baseName: 'workspace',
+            type: 'Workspace',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GetWorkspaceV1Output.attributeTypeMap;
+    }
+}

package/model/group.ts

@@ -0,0 +1,67 @@
+/**
+ * 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';
+
+/**
+ * Group settings.
+ */
+export class Group {
+    /**
+     * Enable to allow unplanned group traits.  Config API note: equal to `allowUnplannedGroupTraits`.
+     */
+    'allowUnplannedTraits'?: boolean;
+    /**
+     * Enable to allow group traits on violations.  Config API note: equal to `allowGroupTraitsOnViolations`.
+     */
+    'allowTraitsOnViolations'?: boolean;
+    /**
+     * The common group event on violations.  Config API note: equal to `commonGroupEventOnViolations`.
+     */
+    'commonEventOnViolations'?: Group.CommonEventOnViolationsEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'allowUnplannedTraits',
+            baseName: 'allowUnplannedTraits',
+            type: 'boolean',
+        },
+        {
+            name: 'allowTraitsOnViolations',
+            baseName: 'allowTraitsOnViolations',
+            type: 'boolean',
+        },
+        {
+            name: 'commonEventOnViolations',
+            baseName: 'commonEventOnViolations',
+            type: 'Group.CommonEventOnViolationsEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Group.attributeTypeMap;
+    }
+}
+
+export namespace Group {
+    export enum CommonEventOnViolationsEnum {
+        ALLOW = <any>'ALLOW',
+        BLOCK = <any>'BLOCK',
+        OMIT_TRAITS = <any>'OMIT_TRAITS',
+    }
+}

package/model/groupSourceSettingsV1.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 GroupSourceSettingsV1 {
+    /**
+     * Enable to allow unplanned group traits.  Config API note: equal to `allowUnplannedGroupTraits`.
+     */
+    'allowUnplannedTraits'?: boolean;
+    /**
+     * Enable to allow group traits on violations.  Config API note: equal to `allowGroupTraitsOnViolations`.
+     */
+    'allowTraitsOnViolations'?: boolean;
+    /**
+     * The common group event on violations.  Config API note: equal to `commonGroupEventOnViolations`.
+     */
+    'commonEventOnViolations'?: GroupSourceSettingsV1.CommonEventOnViolationsEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'allowUnplannedTraits',
+            baseName: 'allowUnplannedTraits',
+            type: 'boolean',
+        },
+        {
+            name: 'allowTraitsOnViolations',
+            baseName: 'allowTraitsOnViolations',
+            type: 'boolean',
+        },
+        {
+            name: 'commonEventOnViolations',
+            baseName: 'commonEventOnViolations',
+            type: 'GroupSourceSettingsV1.CommonEventOnViolationsEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GroupSourceSettingsV1.attributeTypeMap;
+    }
+}
+
+export namespace GroupSourceSettingsV1 {
+    export enum CommonEventOnViolationsEnum {
+        ALLOW = <any>'ALLOW',
+        BLOCK = <any>'BLOCK',
+        OMIT_TRAITS = <any>'OMIT_TRAITS',
+    }
+}

package/model/identify.ts

@@ -0,0 +1,67 @@
+/**
+ * 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';
+
+/**
+ * Identify settings.
+ */
+export class Identify {
+    /**
+     * Enable to allow unplanned identify traits.  Config API note: equal to `allowUnplannedIdentifyTraits`.
+     */
+    'allowUnplannedTraits'?: boolean;
+    /**
+     * Enable to allow identify traits on violations.  Config API note: equal to `allowIdentifyTraitsOnViolations`.
+     */
+    'allowTraitsOnViolations'?: boolean;
+    /**
+     * The common identify event on violations.  Config API note: equal to `commonIdentifyEventOnViolations`.
+     */
+    'commonEventOnViolations'?: Identify.CommonEventOnViolationsEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'allowUnplannedTraits',
+            baseName: 'allowUnplannedTraits',
+            type: 'boolean',
+        },
+        {
+            name: 'allowTraitsOnViolations',
+            baseName: 'allowTraitsOnViolations',
+            type: 'boolean',
+        },
+        {
+            name: 'commonEventOnViolations',
+            baseName: 'commonEventOnViolations',
+            type: 'Identify.CommonEventOnViolationsEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Identify.attributeTypeMap;
+    }
+}
+
+export namespace Identify {
+    export enum CommonEventOnViolationsEnum {
+        ALLOW = <any>'ALLOW',
+        BLOCK = <any>'BLOCK',
+        OMIT_TRAITS = <any>'OMIT_TRAITS',
+    }
+}

package/model/identifySourceSettingsV1.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 IdentifySourceSettingsV1 {
+    /**
+     * Enable to allow unplanned identify traits.  Config API note: equal to `allowUnplannedIdentifyTraits`.
+     */
+    'allowUnplannedTraits'?: boolean;
+    /**
+     * Enable to allow identify traits on violations.  Config API note: equal to `allowIdentifyTraitsOnViolations`.
+     */
+    'allowTraitsOnViolations'?: boolean;
+    /**
+     * The common identify event on violations.  Config API note: equal to `commonIdentifyEventOnViolations`.
+     */
+    'commonEventOnViolations'?: IdentifySourceSettingsV1.CommonEventOnViolationsEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'allowUnplannedTraits',
+            baseName: 'allowUnplannedTraits',
+            type: 'boolean',
+        },
+        {
+            name: 'allowTraitsOnViolations',
+            baseName: 'allowTraitsOnViolations',
+            type: 'boolean',
+        },
+        {
+            name: 'commonEventOnViolations',
+            baseName: 'commonEventOnViolations',
+            type: 'IdentifySourceSettingsV1.CommonEventOnViolationsEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return IdentifySourceSettingsV1.attributeTypeMap;
+    }
+}
+
+export namespace IdentifySourceSettingsV1 {
+    export enum CommonEventOnViolationsEnum {
+        ALLOW = <any>'ALLOW',
+        BLOCK = <any>'BLOCK',
+        OMIT_TRAITS = <any>'OMIT_TRAITS',
+    }
+}

package/model/input.ts

@@ -0,0 +1,68 @@
+/**
+ * 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';
+
+/**
+ * A set of valid Destination input params required for updating.
+ */
+export class Input {
+    /**
+     * The user-defined name for the subscription.
+     */
+    'name'?: string;
+    /**
+     * The fql statement.
+     */
+    'trigger'?: string;
+    /**
+     * Is the subscription enabled.
+     */
+    'enabled'?: boolean;
+    /**
+     * The fields used for configuring this action.
+     */
+    'settings'?: any;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'trigger',
+            baseName: 'trigger',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Input.attributeTypeMap;
+    }
+}

package/model/integrationOptionBeta.ts

@@ -0,0 +1,86 @@
+/**
+ * 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';
+
+/**
+ * Describes an Integration option field required to set up a Segment Integration such as Sources, Destinations, or warehouses.
+ */
+export class IntegrationOptionBeta {
+    /**
+     * The name identifying this option in the context of a Segment Integration.
+     */
+    'name': string;
+    /**
+     * Defines the type for this option in the schema. Types are most commonly strings, but may also represent other primitive types, such as booleans, and numbers, as well as complex types, such as objects and arrays.
+     */
+    'type': string;
+    /**
+     * Whether this is a required option when setting up the Integration.
+     */
+    'required': boolean;
+    /**
+     * An optional short text description of the field.
+     */
+    'description'?: string;
+    /**
+     * An optional default value for the field.
+     */
+    'defaultValue'?: any | null;
+    /**
+     * An optional label for this field.
+     */
+    'label'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'string',
+        },
+        {
+            name: 'required',
+            baseName: 'required',
+            type: 'boolean',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'defaultValue',
+            baseName: 'defaultValue',
+            type: 'any',
+        },
+        {
+            name: 'label',
+            baseName: 'label',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return IntegrationOptionBeta.attributeTypeMap;
+    }
+}

package/model/invitePermissionV1.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';
+import { AllowedLabelBeta } from './allowedLabelBeta';
+import { ResourceV1 } from './resourceV1';
+
+/**
+ * Defines a permission to apply to the user in an invite.
+ */
+export class InvitePermissionV1 {
+    /**
+     * The id of the role.
+     */
+    'roleId': string;
+    /**
+     * The resources to grant the invited users access to.
+     */
+    'resources'?: Array<ResourceV1>;
+    /**
+     * The labels that determine which resources to grant users access to.
+     */
+    'labels'?: Array<AllowedLabelBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'roleId',
+            baseName: 'roleId',
+            type: 'string',
+        },
+        {
+            name: 'resources',
+            baseName: 'resources',
+            type: 'Array<ResourceV1>',
+        },
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<AllowedLabelBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return InvitePermissionV1.attributeTypeMap;
+    }
+}

package/model/inviteV1.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 { InvitePermissionV1 } from './invitePermissionV1';
+
+/**
+ * Defines an invitation to join a Workspace.
+ */
+export class InviteV1 {
+    /**
+     * The invited user\'s email to attach the permissions to.
+     */
+    'email': string;
+    /**
+     * The permissions to attach to the invited user.
+     */
+    'permissions'?: Array<InvitePermissionV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'email',
+            baseName: 'email',
+            type: 'string',
+        },
+        {
+            name: 'permissions',
+            baseName: 'permissions',
+            type: 'Array<InvitePermissionV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return InviteV1.attributeTypeMap;
+    }
+}