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

package/model/createFunctionDeploymentV1Output.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 { FunctionDeployment } from './functionDeployment';
+
+/**
+ * Updates the deployment for a Source Function instance.
+ */
+export class CreateFunctionDeploymentV1Output {
+    'functionDeployment': FunctionDeployment;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'functionDeployment',
+            baseName: 'functionDeployment',
+            type: 'FunctionDeployment',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFunctionDeploymentV1Output.attributeTypeMap;
+    }
+}

package/model/createFunctionV1Input.ts

@@ -0,0 +1,94 @@
+/**
+ * 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';
+
+/**
+ * Creates a Function.
+ */
+export class CreateFunctionV1Input {
+    /**
+     * The Function code.
+     */
+    'code': string;
+    /**
+     * The list of settings for this Function.
+     */
+    'settings'?: Array<FunctionSettingV1>;
+    /**
+     * A display name for this Function.  Note that Destination Functions append the Workspace to the display name.
+     */
+    'displayName': string;
+    /**
+     * The URL of the logo for this Function.
+     */
+    'logoUrl'?: string;
+    /**
+     * The Function type.  Config API note: equal to `type`.
+     */
+    'resourceType': CreateFunctionV1Input.ResourceTypeEnum;
+    /**
+     * A description for this Function.
+     */
+    'description'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'code',
+            baseName: 'code',
+            type: 'string',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: 'Array<FunctionSettingV1>',
+        },
+        {
+            name: 'displayName',
+            baseName: 'displayName',
+            type: 'string',
+        },
+        {
+            name: 'logoUrl',
+            baseName: 'logoUrl',
+            type: 'string',
+        },
+        {
+            name: 'resourceType',
+            baseName: 'resourceType',
+            type: 'CreateFunctionV1Input.ResourceTypeEnum',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFunctionV1Input.attributeTypeMap;
+    }
+}
+
+export namespace CreateFunctionV1Input {
+    export enum ResourceTypeEnum {
+        DESTINATION = <any>'DESTINATION',
+        SOURCE = <any>'SOURCE',
+    }
+}

package/model/createFunctionV1Output.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 { Function1 } from './function1';
+
+/**
+ * Create a Function.
+ */
+export class CreateFunctionV1Output {
+    'function': Function1;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'function',
+            baseName: 'function',
+            type: 'Function1',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateFunctionV1Output.attributeTypeMap;
+    }
+}

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

package/model/createInvitesV1Input.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { InviteV1 } from './inviteV1';
+
+/**
+ * Invites a user to a Workspace with specified permissions.
+ */
+export class CreateInvitesV1Input {
+    /**
+     * The list of invites.
+     */
+    'invites': Array<InviteV1>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'invites',
+            baseName: 'invites',
+            type: 'Array<InviteV1>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateInvitesV1Input.attributeTypeMap;
+    }
+}

package/model/createInvitesV1Output.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';
+
+/**
+ * Returns the emails of the invited users.
+ */
+export class CreateInvitesV1Output {
+    /**
+     * The list of emails invited to the Workspace.
+     */
+    'emails': Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'emails',
+            baseName: 'emails',
+            type: 'Array<string>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateInvitesV1Output.attributeTypeMap;
+    }
+}

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

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

package/model/createLabelAlphaInput.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 { Label } from './label';
+
+/**
+ * Creates a new label in the current Workspace.
+ */
+export class CreateLabelAlphaInput {
+    'label': Label;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'label',
+            baseName: 'label',
+            type: 'Label',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateLabelAlphaInput.attributeTypeMap;
+    }
+}

package/model/createLabelAlphaOutput.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { LabelAlpha } from './labelAlpha';
+
+/**
+ * Result of creating a new label in the current Workspace.
+ */
+export class CreateLabelAlphaOutput {
+    /**
+     * All labels associated with the current Workspace.
+     */
+    'labels': Array<LabelAlpha>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'labels',
+            baseName: 'labels',
+            type: 'Array<LabelAlpha>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateLabelAlphaOutput.attributeTypeMap;
+    }
+}

package/model/createLabelV1Input.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 { Label1 } from './label1';
+
+/**
+ * Creates a new label in the current Workspace.
+ */
+export class CreateLabelV1Input {
+    'label': Label1;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'label',
+            baseName: 'label',
+            type: 'Label1',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateLabelV1Input.attributeTypeMap;
+    }
+}

package/model/createLabelV1Output.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 { Label2 } from './label2';
+
+/**
+ * Result of creating a new label in the current Workspace.
+ */
+export class CreateLabelV1Output {
+    'label': Label2;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'label',
+            baseName: 'label',
+            type: 'Label2',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateLabelV1Output.attributeTypeMap;
+    }
+}

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

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