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

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

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

package/model/listConnectedWarehousesFromSourceAlphaOutput.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 { WarehouseV1 } from './warehouseV1';
+
+/**
+ * Returns a list of Warehouses connected to a Source.
+ */
+export class ListConnectedWarehousesFromSourceAlphaOutput {
+    /**
+     * A list that contains the Warehouses connected to the Source.
+     */
+    'warehouses': Array<WarehouseV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'warehouses',
+            baseName: 'warehouses',
+            type: 'Array<WarehouseV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListConnectedWarehousesFromSourceAlphaOutput.attributeTypeMap;
+    }
+}

package/model/listConnectedWarehousesFromSourceV1Output.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 { WarehouseV1 } from './warehouseV1';
+
+/**
+ * Returns a list of Warehouses connected to a Source.
+ */
+export class ListConnectedWarehousesFromSourceV1Output {
+    /**
+     * A list that contains the Warehouses connected to the Source.
+     */
+    'warehouses': Array<WarehouseV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'warehouses',
+            baseName: 'warehouses',
+            type: 'Array<WarehouseV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListConnectedWarehousesFromSourceV1Output.attributeTypeMap;
+    }
+}

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

package/model/listDeliveryMetricsSummaryFromDestinationBetaOutput.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 { DeliveryMetricsSummary } from './deliveryMetricsSummary';
+
+/**
+ * Output to retrieve event delivery metrics summary for a Destination.
+ */
+export class ListDeliveryMetricsSummaryFromDestinationBetaOutput {
+    'deliveryMetricsSummary': DeliveryMetricsSummary;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'deliveryMetricsSummary',
+            baseName: 'deliveryMetricsSummary',
+            type: 'DeliveryMetricsSummary',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListDeliveryMetricsSummaryFromDestinationBetaOutput.attributeTypeMap;
+    }
+}

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

package/model/listDestinationsV1Output.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 { DestinationV1 } from './destinationV1';
+import { Pagination } from './pagination';
+
+/**
+ * Returns all Destinations connected to the current Workspace.
+ */
+export class ListDestinationsV1Output {
+    /**
+     * The list that contains the Destinations connected to the Workspace.
+     */
+    'destinations': Array<DestinationV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'destinations',
+            baseName: 'destinations',
+            type: 'Array<DestinationV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListDestinationsV1Output.attributeTypeMap;
+    }
+}

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

package/model/listFiltersFromDestinationV1Output.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 { DestinationFilterV1 } from './destinationFilterV1';
+import { Pagination } from './pagination';
+
+/**
+ * Output for ListDestinationFiltersV1.
+ */
+export class ListFiltersFromDestinationV1Output {
+    /**
+     * A list of the filters that belong to the specified Destination instance.
+     */
+    'filters': Array<DestinationFilterV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'filters',
+            baseName: 'filters',
+            type: 'Array<DestinationFilterV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListFiltersFromDestinationV1Output.attributeTypeMap;
+    }
+}

package/model/listFunctionItemV1.ts

@@ -0,0 +1,111 @@
+/**
+ * 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';
+
+/**
+ * Represents a Function in a list.
+ */
+export class ListFunctionItemV1 {
+    /**
+     * An identifier for this Function.
+     */
+    'id'?: string;
+    /**
+     * The Function type.  Config API note: equal to `type`.
+     */
+    'resourceType'?: ListFunctionItemV1.ResourceTypeEnum;
+    /**
+     * The time this Function was created.
+     */
+    'createdAt'?: string;
+    /**
+     * The id of the user who created this Function.
+     */
+    'createdBy'?: string;
+    /**
+     * A display name for this Function.
+     */
+    'displayName'?: string;
+    /**
+     * A description for this Function.
+     */
+    'description'?: string;
+    /**
+     * The URL of the logo for this Function.
+     */
+    'logoUrl'?: string;
+    /**
+     * The catalog id of this Function.
+     */
+    'catalogId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'resourceType',
+            baseName: 'resourceType',
+            type: 'ListFunctionItemV1.ResourceTypeEnum',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+        {
+            name: 'createdBy',
+            baseName: 'createdBy',
+            type: 'string',
+        },
+        {
+            name: 'displayName',
+            baseName: 'displayName',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'logoUrl',
+            baseName: 'logoUrl',
+            type: 'string',
+        },
+        {
+            name: 'catalogId',
+            baseName: 'catalogId',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListFunctionItemV1.attributeTypeMap;
+    }
+}
+
+export namespace ListFunctionItemV1 {
+    export enum ResourceTypeEnum {
+        DESTINATION = <any>'DESTINATION',
+        SOURCE = <any>'SOURCE',
+    }
+}

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

package/model/listFunctionsV1Output.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 { ListFunctionItemV1 } from './listFunctionItemV1';
+import { Pagination } from './pagination';
+
+/**
+ * Lists Functions in a Workspace.
+ */
+export class ListFunctionsV1Output {
+    /**
+     * An array of Functions.
+     */
+    'functions': Array<ListFunctionItemV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'functions',
+            baseName: 'functions',
+            type: 'Array<ListFunctionItemV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return ListFunctionsV1Output.attributeTypeMap;
+    }
+}

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