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

package/model/input.ts

@@ -1,68 +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';
-
-/**
- * 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

@@ -1,86 +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';
-
-/**
- * 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

@@ -1,61 +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 { 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

@@ -1,51 +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 { 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;
-    }
-}

package/model/label.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';
-
-/**
- * The new label to create in the Workspace.
- */
-export class Label {
-    /**
-     * The key that represents the name of this label.
-     */
-    'key': string;
-    /**
-     * The value associated with the key of this label.
-     */
-    'value': string;
-    /**
-     * An optional description of the purpose of this label.
-     */
-    'description'?: string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'key',
-            baseName: 'key',
-            type: 'string',
-        },
-        {
-            name: 'value',
-            baseName: 'value',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Label.attributeTypeMap;
-    }
-}

package/model/label1.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';
-
-/**
- * The new label to create in the Workspace.
- */
-export class Label1 {
-    /**
-     * The key that represents the name of this label.
-     */
-    'key': string;
-    /**
-     * The value associated with the key of this label.
-     */
-    'value': string;
-    /**
-     * An optional description of the purpose of this label.
-     */
-    'description'?: string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'key',
-            baseName: 'key',
-            type: 'string',
-        },
-        {
-            name: 'value',
-            baseName: 'value',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Label1.attributeTypeMap;
-    }
-}

package/model/label2.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';
-
-/**
- * The newly created label.
- */
-export class Label2 {
-    /**
-     * The key that represents the name of this label.
-     */
-    'key': string;
-    /**
-     * The value associated with the key of this label.
-     */
-    'value': string;
-    /**
-     * An optional description of the purpose of this label.
-     */
-    'description'?: string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'key',
-            baseName: 'key',
-            type: 'string',
-        },
-        {
-            name: 'value',
-            baseName: 'value',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return Label2.attributeTypeMap;
-    }
-}

package/model/labelAlpha.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';
-
-/**
- * A label lets Workspace owners assign permissions to users, and grant these users access to groups.  A Workspace owner may use labels to grant users access to groups of resources.  When you add a label to a Source or Personas Spaces, any users granted access to that label gain access to those resources.  All Workspaces include labels for Dev (development) and Prod (production) environments. On top of those, Free and Team plan customers may create up to five labels.  Customers with the Enterprise pricing package may create an unlimited number of labels.
- */
-export class LabelAlpha {
-    /**
-     * The key that represents the name of this label.
-     */
-    'key': string;
-    /**
-     * The value associated with the key of this label.
-     */
-    'value': string;
-    /**
-     * An optional description of the purpose of this label.
-     */
-    'description'?: string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'key',
-            baseName: 'key',
-            type: 'string',
-        },
-        {
-            name: 'value',
-            baseName: 'value',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return LabelAlpha.attributeTypeMap;
-    }
-}

package/model/labelV1.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';
-
-/**
- * A label lets Workspace owners assign permissions to users, and grant these users access to groups.  A Workspace owner may use labels to grant users access to groups of resources.  When you add a label to a Source or Personas Spaces, any users granted access to that label gain access to those resources.  All Workspaces include labels for Dev (development) and Prod (production) environments. On top of those, Free and Team plan customers may create up to five labels.  Customers with the Enterprise pricing package may create an unlimited number of labels.
- */
-export class LabelV1 {
-    /**
-     * The key that represents the name of this label.
-     */
-    'key': string;
-    /**
-     * The value associated with the key of this label.
-     */
-    'value': string;
-    /**
-     * An optional description of the purpose of this label.
-     */
-    'description'?: string;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'key',
-            baseName: 'key',
-            type: 'string',
-        },
-        {
-            name: 'value',
-            baseName: 'value',
-            type: 'string',
-        },
-        {
-            name: 'description',
-            baseName: 'description',
-            type: 'string',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return LabelV1.attributeTypeMap;
-    }
-}

package/model/listAuditEvents200Response.ts

@@ -1,36 +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 { ListAuditEventsV1Output } from './listAuditEventsV1Output';
-
-export class ListAuditEvents200Response {
-    'data'?: ListAuditEventsV1Output;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'data',
-            baseName: 'data',
-            type: 'ListAuditEventsV1Output',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return ListAuditEvents200Response.attributeTypeMap;
-    }
-}

package/model/listAuditEventsV1Output.ts

@@ -1,49 +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 { AuditEventV1 } from './auditEventV1';
-import { Pagination } from './pagination';
-
-/**
- * Returns a list of Audit Trail events for the current Workspace.
- */
-export class ListAuditEventsV1Output {
-    /**
-     * Audit trail events for the current Workspace.
-     */
-    'events': Array<AuditEventV1>;
-    'pagination'?: Pagination;
-
-    static discriminator: string | undefined = undefined;
-
-    static attributeTypeMap: Array<{
-        name: string;
-        baseName: string;
-        type: string;
-    }> = [
-        {
-            name: 'events',
-            baseName: 'events',
-            type: 'Array<AuditEventV1>',
-        },
-        {
-            name: 'pagination',
-            baseName: 'pagination',
-            type: 'Pagination',
-        },
-    ];
-
-    static getAttributeTypeMap() {
-        return ListAuditEventsV1Output.attributeTypeMap;
-    }
-}