audienceSummary.ts

/**
 * 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: 58.2.0
 * 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 { AudienceDefinition } from './audienceDefinition';
import { AudienceOptions } from './audienceOptions';

/**
 * Defines an Audience.
 */
export class AudienceSummary {
    /**
     * Audience id.
     */
    'id': string;
    /**
     * Space id for the audience.
     */
    'spaceId': string;
    /**
     * Name of the audience.
     */
    'name': string;
    /**
     * Description of the audience.
     */
    'description'?: string;
    /**
     * Key for the audience.
     */
    'key': string;
    /**
     * Enabled/disabled status for the audience.
     */
    'enabled': boolean;
    'definition': AudienceDefinition | null;
    /**
     * Status for the audience.  Possible values: Backfilling, Computing, Failed, Live, Awaiting Destinations, Disabled.
     */
    'status'?: string;
    /**
     * User id who created the audience.
     */
    'createdBy': string;
    /**
     * User id who last updated the audience.
     */
    'updatedBy': string;
    /**
     * Date the audience was created.
     */
    'createdAt': string;
    /**
     * Date the audience was last updated.
     */
    'updatedAt': string;
    'options'?: AudienceOptions;

    static discriminator: string | undefined = undefined;

    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }> = [
        {
            name: 'id',
            baseName: 'id',
            type: 'string',
        },
        {
            name: 'spaceId',
            baseName: 'spaceId',
            type: 'string',
        },
        {
            name: 'name',
            baseName: 'name',
            type: 'string',
        },
        {
            name: 'description',
            baseName: 'description',
            type: 'string',
        },
        {
            name: 'key',
            baseName: 'key',
            type: 'string',
        },
        {
            name: 'enabled',
            baseName: 'enabled',
            type: 'boolean',
        },
        {
            name: 'definition',
            baseName: 'definition',
            type: 'AudienceDefinition',
        },
        {
            name: 'status',
            baseName: 'status',
            type: 'string',
        },
        {
            name: 'createdBy',
            baseName: 'createdBy',
            type: 'string',
        },
        {
            name: 'updatedBy',
            baseName: 'updatedBy',
            type: 'string',
        },
        {
            name: 'createdAt',
            baseName: 'createdAt',
            type: 'string',
        },
        {
            name: 'updatedAt',
            baseName: 'updatedAt',
            type: 'string',
        },
        {
            name: 'options',
            baseName: 'options',
            type: 'AudienceOptions',
        },
    ];

    static getAttributeTypeMap() {
        return AudienceSummary.attributeTypeMap;
    }
}