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

package/model/functionSettingV1.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 FunctionSettingV1 {
+    /**
+     * The name of this Function.
+     */
+    'name': string;
+    /**
+     * The label for this Function.
+     */
+    'label': string;
+    /**
+     * A description of this Function.
+     */
+    'description': string;
+    /**
+     * The Function type.
+     */
+    'type': FunctionSettingV1.TypeEnum;
+    /**
+     * Whether this Function is required.
+     */
+    'required': boolean;
+    /**
+     * Whether this Function contains sensitive information.
+     */
+    'sensitive': boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'label',
+            baseName: 'label',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'FunctionSettingV1.TypeEnum',
+        },
+        {
+            name: 'required',
+            baseName: 'required',
+            type: 'boolean',
+        },
+        {
+            name: 'sensitive',
+            baseName: 'sensitive',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return FunctionSettingV1.attributeTypeMap;
+    }
+}
+
+export namespace FunctionSettingV1 {
+    export enum TypeEnum {
+        ARRAY = <any>'ARRAY',
+        BOOLEAN = <any>'BOOLEAN',
+        STRING = <any>'STRING',
+        TEXT_MAP = <any>'TEXT_MAP',
+    }
+}

package/model/functionV1.ts

@@ -0,0 +1,166 @@
+/**
+ * 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 { FunctionSettingV1 } from './functionSettingV1';
+
+/**
+ * Represents a Function.
+ */
+export class FunctionV1 {
+    /**
+     * An identifier for this Function.
+     */
+    'id'?: string;
+    /**
+     * The Function type.  Config API note: equal to `type`.
+     */
+    'resourceType'?: FunctionV1.ResourceTypeEnum;
+    /**
+     * The time this Function was created.
+     */
+    'createdAt'?: string;
+    /**
+     * The id of the user who created this Function.
+     */
+    'createdBy'?: string;
+    /**
+     * The Function code.
+     */
+    'code'?: string;
+    /**
+     * The time of this Function\'s last deployment.
+     */
+    'deployedAt'?: string | null;
+    /**
+     * The list of settings for this Function.
+     */
+    'settings'?: Array<FunctionSettingV1>;
+    /**
+     * 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 preview webhook URL for this Function.
+     */
+    'previewWebhookUrl'?: string;
+    /**
+     * The max count of the batch for this Function.
+     */
+    'batchMaxCount'?: number;
+    /**
+     * The catalog id of this Function.
+     */
+    'catalogId'?: string;
+    /**
+     * Whether the deployment of this Function is the latest version.
+     */
+    'isLatestVersion'?: boolean;
+
+    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: 'FunctionV1.ResourceTypeEnum',
+        },
+        {
+            name: 'createdAt',
+            baseName: 'createdAt',
+            type: 'string',
+        },
+        {
+            name: 'createdBy',
+            baseName: 'createdBy',
+            type: 'string',
+        },
+        {
+            name: 'code',
+            baseName: 'code',
+            type: 'string',
+        },
+        {
+            name: 'deployedAt',
+            baseName: 'deployedAt',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'Array<FunctionSettingV1>',
+        },
+        {
+            name: 'displayName',
+            baseName: 'displayName',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'logoUrl',
+            baseName: 'logoUrl',
+            type: 'string',
+        },
+        {
+            name: 'previewWebhookUrl',
+            baseName: 'previewWebhookUrl',
+            type: 'string',
+        },
+        {
+            name: 'batchMaxCount',
+            baseName: 'batchMaxCount',
+            type: 'number',
+        },
+        {
+            name: 'catalogId',
+            baseName: 'catalogId',
+            type: 'string',
+        },
+        {
+            name: 'isLatestVersion',
+            baseName: 'isLatestVersion',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return FunctionV1.attributeTypeMap;
+    }
+}
+
+export namespace FunctionV1 {
+    export enum ResourceTypeEnum {
+        DESTINATION = <any>'DESTINATION',
+        SOURCE = <any>'SOURCE',
+    }
+}

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

package/model/generateUploadURLForEdgeFunctionsAlphaOutput.ts

@@ -0,0 +1,41 @@
+/**
+ * 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';
+
+/**
+ * Output for GenerateSignedUrl.
+ */
+export class GenerateUploadURLForEdgeFunctionsAlphaOutput {
+    /**
+     * A temporary URL that can be used to upload your Edge Functions bundle. Expires in 15 minutes.
+     */
+    'uploadURL': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'uploadURL',
+            baseName: 'uploadURL',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GenerateUploadURLForEdgeFunctionsAlphaOutput.attributeTypeMap;
+    }
+}

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

package/model/getAdvancedSyncScheduleFromWarehouseV1Output.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 { Schedule } from './schedule';
+
+/**
+ * Returns the advanced sync schedule for a Warehouse.
+ */
+export class GetAdvancedSyncScheduleFromWarehouseV1Output {
+    /**
+     * Indicates if an advanced sync schedule is enabled for this Warehouse.
+     */
+    'enabled': boolean;
+    'schedule'?: Schedule;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'schedule',
+            baseName: 'schedule',
+            type: 'Schedule',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GetAdvancedSyncScheduleFromWarehouseV1Output.attributeTypeMap;
+    }
+}

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

package/model/getConnectionStateFromWarehouseV1Output.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';
+
+/**
+ * Returns the status of a Warehouse connection settings after an attempt to connect to it.
+ */
+export class GetConnectionStateFromWarehouseV1Output {
+    /**
+     * Represents the status for the current connection settings.
+     */
+    'connectionState': GetConnectionStateFromWarehouseV1Output.ConnectionStateEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'connectionState',
+            baseName: 'connectionState',
+            type: 'GetConnectionStateFromWarehouseV1Output.ConnectionStateEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GetConnectionStateFromWarehouseV1Output.attributeTypeMap;
+    }
+}
+
+export namespace GetConnectionStateFromWarehouseV1Output {
+    export enum ConnectionStateEnum {
+        CONNECTED = <any>'CONNECTED',
+        FAILED = <any>'FAILED',
+    }
+}

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

package/model/getDailyPerSourceAPICallsUsageV1Output.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 { SourceAPICallSnapshotV1 } from './sourceAPICallSnapshotV1';
+
+/**
+ * Returns a list of daily aggregations of Source level API calls counts.
+ */
+export class GetDailyPerSourceAPICallsUsageV1Output {
+    /**
+     * The list of daily per Source API calls count aggregates.
+     */
+    'dailyPerSourceAPICallsUsage': Array<SourceAPICallSnapshotV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'dailyPerSourceAPICallsUsage',
+            baseName: 'dailyPerSourceAPICallsUsage',
+            type: 'Array<SourceAPICallSnapshotV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GetDailyPerSourceAPICallsUsageV1Output.attributeTypeMap;
+    }
+}

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

package/model/getDailyPerSourceMTUUsageV1Output.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 { UsersPerSourceSnapshotV1 } from './usersPerSourceSnapshotV1';
+
+/**
+ * Returns a list of daily aggregations of Source level MTU counts.
+ */
+export class GetDailyPerSourceMTUUsageV1Output {
+    /**
+     * The list of daily per Source MTU count aggregates.
+     */
+    'dailyPerSourceMTUUsage': Array<UsersPerSourceSnapshotV1>;
+    'pagination': Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'dailyPerSourceMTUUsage',
+            baseName: 'dailyPerSourceMTUUsage',
+            type: 'Array<UsersPerSourceSnapshotV1>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return GetDailyPerSourceMTUUsageV1Output.attributeTypeMap;
+    }
+}