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

package/model/mtuSnapshotV1.ts

@@ -0,0 +1,95 @@
+/**
+ * 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 snapshot of MTU metrics within the given usage period.
+ */
+export class MtuSnapshotV1 {
+    /**
+     * The start of the usage period, in unix time (seconds since epoch).
+     */
+    'periodStart': number;
+    /**
+     * The end of the usage period, in unix time (seconds since epoch).
+     */
+    'periodEnd': number;
+    /**
+     * A bigint of the number of anonymous users in this snapshot.
+     */
+    'anonymous': string;
+    /**
+     * A bigint of the number of anonymous identified users in this snapshot.
+     */
+    'anonymousIdentified': string;
+    /**
+     * A bigint of the number of identified users in this snapshot.
+     */
+    'identified': string;
+    /**
+     * A bigint of the number of never identified users in this snapshot.
+     */
+    'neverIdentified': string;
+    /**
+     * The timestamp of this snapshot within the billing cycle, in the ISO-8601 format.
+     */
+    'timestamp': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'periodStart',
+            baseName: 'periodStart',
+            type: 'number',
+        },
+        {
+            name: 'periodEnd',
+            baseName: 'periodEnd',
+            type: 'number',
+        },
+        {
+            name: 'anonymous',
+            baseName: 'anonymous',
+            type: 'string',
+        },
+        {
+            name: 'anonymousIdentified',
+            baseName: 'anonymousIdentified',
+            type: 'string',
+        },
+        {
+            name: 'identified',
+            baseName: 'identified',
+            type: 'string',
+        },
+        {
+            name: 'neverIdentified',
+            baseName: 'neverIdentified',
+            type: 'string',
+        },
+        {
+            name: 'timestamp',
+            baseName: 'timestamp',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return MtuSnapshotV1.attributeTypeMap;
+    }
+}

package/model/pagination.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';
+
+/**
+ * Information about the pagination of this response.
+ */
+export class Pagination {
+    /**
+     * The current cursor within a collection.  Consumers of the API must treat this value as opaque.
+     */
+    'current': string;
+    /**
+     * A pointer to the next page.  This does not return when you retrieve the last page.  Consumers of the API must treat this value as opaque.
+     */
+    'next'?: string | null;
+    /**
+     * A pointer to the previous page.  This does not return when you retrieve the first page.  Consumers of the API must treat this value as opaque.
+     */
+    'previous'?: string | null;
+    /**
+     * The total number of entries available in the collection.  If calculating it impacts performance, the response may omit this field.
+     */
+    'totalEntries'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'current',
+            baseName: 'current',
+            type: 'string',
+        },
+        {
+            name: 'next',
+            baseName: 'next',
+            type: 'string',
+        },
+        {
+            name: 'previous',
+            baseName: 'previous',
+            type: 'string',
+        },
+        {
+            name: 'totalEntries',
+            baseName: 'totalEntries',
+            type: 'number',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Pagination.attributeTypeMap;
+    }
+}

package/model/paginationInput.ts

@@ -0,0 +1,50 @@
+/**
+ * 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';
+
+/**
+ * Pagination parameters.  Every resource that returns a list of items in its `Output` object may contain a `PaginationInput` in its `Input` object. Required, though some of its fields are optional.
+ */
+export class PaginationInput {
+    /**
+     * The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque.
+     */
+    'cursor'?: string;
+    /**
+     * The number of items to retrieve in a page, between 1 and 200.
+     */
+    'count': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'cursor',
+            baseName: 'cursor',
+            type: 'string',
+        },
+        {
+            name: 'count',
+            baseName: 'count',
+            type: 'number',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PaginationInput.attributeTypeMap;
+    }
+}

package/model/paginationOutput.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';
+
+/**
+ * Pagination metadata for a list response.  Responses return this object alongside a list of resources, which provides the necessary metadata for manipulating a paginated collection. In operations that return lists, it\'s always present, though some of its fields might not be.
+ */
+export class PaginationOutput {
+    /**
+     * The current cursor within a collection.  Consumers of the API must treat this value as opaque.
+     */
+    'current': string;
+    /**
+     * A pointer to the next page.  This does not return when you retrieve the last page.  Consumers of the API must treat this value as opaque.
+     */
+    'next'?: string | null;
+    /**
+     * A pointer to the previous page.  This does not return when you retrieve the first page.  Consumers of the API must treat this value as opaque.
+     */
+    'previous'?: string | null;
+    /**
+     * The total number of entries available in the collection.  If calculating it impacts performance, the response may omit this field.
+     */
+    'totalEntries'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'current',
+            baseName: 'current',
+            type: 'string',
+        },
+        {
+            name: 'next',
+            baseName: 'next',
+            type: 'string',
+        },
+        {
+            name: 'previous',
+            baseName: 'previous',
+            type: 'string',
+        },
+        {
+            name: 'totalEntries',
+            baseName: 'totalEntries',
+            type: 'number',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PaginationOutput.attributeTypeMap;
+    }
+}

package/model/permissionInputV1.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 { PermissionResourceV1 } from './permissionResourceV1';
+
+/**
+ * The input for a permission, associated with a resource and/or labels.
+ */
+export class PermissionInputV1 {
+    /**
+     * The role id of this permission.
+     */
+    'roleId': string;
+    /**
+     * The resources to link the selected role to.
+     */
+    'resources': Array<PermissionResourceV1>;
+
+    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<PermissionResourceV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PermissionInputV1.attributeTypeMap;
+    }
+}

package/model/permissionResourceV1.ts

@@ -0,0 +1,70 @@
+/**
+ * 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';
+
+/**
+ * The most basic representation of a resource belonging to a set of permissions.
+ */
+export class PermissionResourceV1 {
+    /**
+     * The id of this resource.
+     */
+    'id': string;
+    /**
+     * The type for this resource.
+     */
+    'type': PermissionResourceV1.TypeEnum;
+    /**
+     * The labels that further refine access to this resource. Labels are exclusive to Workspace-level permissions.
+     */
+    'labels'?: Array<AllowedLabelBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'PermissionResourceV1.TypeEnum',
+        },
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<AllowedLabelBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PermissionResourceV1.attributeTypeMap;
+    }
+}
+
+export namespace PermissionResourceV1 {
+    export enum TypeEnum {
+        FUNCTION = <any>'FUNCTION',
+        SOURCE = <any>'SOURCE',
+        SPACE = <any>'SPACE',
+        WAREHOUSE = <any>'WAREHOUSE',
+        WORKSPACE = <any>'WORKSPACE',
+    }
+}

package/model/permissionV1.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 { PermissionResourceV1 } from './permissionResourceV1';
+
+/**
+ * A registered set of permissions for a subject, extending a role to a resource.
+ */
+export class PermissionV1 {
+    /**
+     * The name of the role associated with this permission.
+     */
+    'roleName': string;
+    /**
+     * The id of the role associated with this permission.
+     */
+    'roleId': string;
+    /**
+     * The resources associated with this permission.
+     */
+    'resources': Array<PermissionResourceV1>;
+    /**
+     * The labels to attach to this permission.
+     */
+    'labels'?: Array<AllowedLabelBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'roleName',
+            baseName: 'roleName',
+            type: 'string',
+        },
+        {
+            name: 'roleId',
+            baseName: 'roleId',
+            type: 'string',
+        },
+        {
+            name: 'resources',
+            baseName: 'resources',
+            type: 'Array<PermissionResourceV1>',
+        },
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<AllowedLabelBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PermissionV1.attributeTypeMap;
+    }
+}

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

package/model/previewDestinationFilterV1.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 { DestinationFilterActionV1 } from './destinationFilterActionV1';
+
+/**
+ * A simplified Destination filter that includes the if and actions for a DestinationFilterV1.
+ */
+export class PreviewDestinationFilterV1 {
+    /**
+     * A FQL statement which determines if the provided filter\'s actions will apply to the provided JSON payload. The literal string \"all\" will result in this filter to all events. For guidance on using FQL, see the Segment documentation site.
+     */
+    'if': string;
+    /**
+     * The filtering action to take on events that match the \"if\" statement. Action types must be one of: \"drop\", \"allow_properties\", \"drop_properties\" or \"sample\".
+     */
+    'actions': Array<DestinationFilterActionV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'if',
+            baseName: 'if',
+            type: 'string',
+        },
+        {
+            name: 'actions',
+            baseName: 'actions',
+            type: 'Array<DestinationFilterActionV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PreviewDestinationFilterV1.attributeTypeMap;
+    }
+}

package/model/previewDestinationFilterV1Input.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { Filter } from './filter';
+
+/**
+ * Input of the Destination filter to preview. For guidance on using FQL, see the Segment documentation site.
+ */
+export class PreviewDestinationFilterV1Input {
+    'filter': Filter;
+    /**
+     * The JSON payload to apply the filter to.
+     */
+    'payload': { [key: string]: any };
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'filter',
+            baseName: 'filter',
+            type: 'Filter',
+        },
+        {
+            name: 'payload',
+            baseName: 'payload',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PreviewDestinationFilterV1Input.attributeTypeMap;
+    }
+}

package/model/previewDestinationFilterV1Output.ts

@@ -0,0 +1,50 @@
+/**
+ * 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';
+
+/**
+ * Preview output from applying the Destination filter. Segment modifies or nullifies payloads depending on the provided filter actions.
+ */
+export class PreviewDestinationFilterV1Output {
+    /**
+     * The pre-filter JSON input.
+     */
+    'inputPayload': { [key: string]: any };
+    /**
+     * The filtered JSON output.
+     */
+    'result': any | null;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'inputPayload',
+            baseName: 'inputPayload',
+            type: '{ [key: string]: any; }',
+        },
+        {
+            name: 'result',
+            baseName: 'result',
+            type: 'any',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return PreviewDestinationFilterV1Output.attributeTypeMap;
+    }
+}