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

package/model/updateSourceV1Output.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 { Source6 } from './source6';
+
+/**
+ * Returns the updated Source.
+ */
+export class UpdateSourceV1Output {
+    'source': Source6;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'source',
+            baseName: 'source',
+            type: 'Source6',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateSourceV1Output.attributeTypeMap;
+    }
+}

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

package/model/updateSubscriptionForDestinationAlphaInput.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 { Input } from './input';
+
+/**
+ * The basic input parameters for updating a Destination subscription.
+ */
+export class UpdateSubscriptionForDestinationAlphaInput {
+    'input': Input;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'input',
+            baseName: 'input',
+            type: 'Input',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateSubscriptionForDestinationAlphaInput.attributeTypeMap;
+    }
+}

package/model/updateSubscriptionForDestinationAlphaOutput.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 { Subscription } from './subscription';
+
+/**
+ * Returns the updated Destination subscription.
+ */
+export class UpdateSubscriptionForDestinationAlphaOutput {
+    'subscription': Subscription;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'subscription',
+            baseName: 'subscription',
+            type: 'Subscription',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateSubscriptionForDestinationAlphaOutput.attributeTypeMap;
+    }
+}

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

package/model/updateTrackingPlanV1Input.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';
+
+/**
+ * Updates the Workspace\'s Tracking Plan.
+ */
+export class UpdateTrackingPlanV1Input {
+    /**
+     * The Tracking Plan\'s name.  Config API note: equal to `displayName`.
+     */
+    'name'?: string;
+    /**
+     * The Tracking Plan\'s description.
+     */
+    'description'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateTrackingPlanV1Input.attributeTypeMap;
+    }
+}

package/model/updateTrackingPlanV1Output.ts

@@ -0,0 +1,47 @@
+/**
+ * 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';
+
+/**
+ * Result of an UpdateTrackingPlan call.
+ */
+export class UpdateTrackingPlanV1Output {
+    /**
+     * The operation status.
+     */
+    'status': UpdateTrackingPlanV1Output.StatusEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'status',
+            baseName: 'status',
+            type: 'UpdateTrackingPlanV1Output.StatusEnum',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateTrackingPlanV1Output.attributeTypeMap;
+    }
+}
+
+export namespace UpdateTrackingPlanV1Output {
+    export enum StatusEnum {
+        SUCCESS = <any>'SUCCESS',
+    }
+}

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

package/model/updateTransformationBetaInput.ts

@@ -0,0 +1,96 @@
+/**
+ * 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 { PropertyRenameBeta } from './propertyRenameBeta';
+
+/**
+ * The input to update a Transformation.
+ */
+export class UpdateTransformationBetaInput {
+    /**
+     * The name of the Transformation.
+     */
+    'name'?: string;
+    /**
+     * The optional Source to be associated with the Transformation.
+     */
+    'sourceId'?: string;
+    /**
+     * The optional Destination metadata to be associated with the Transformation.
+     */
+    'destinationMetadataId'?: string;
+    /**
+     * If the Transformation should be enabled.
+     */
+    'enabled'?: boolean;
+    /**
+     * If statement ([FQL](https://segment.com/docs/config-api/fql/)) to match events.  For standard event matchers, use the following:   Track -\\> \"event=\'\\<eventName\\>\'\"   Identify -\\> \"type=\'identify\'\"   Group -\\> \"type=\'group\'\"
+     */
+    'if'?: string;
+    /**
+     * Optional new event name for renaming events. Works only for \'track\' event type.
+     */
+    'newEventName'?: string;
+    /**
+     * Optional array for renaming properties collected by your events.
+     */
+    'propertyRenames'?: Array<PropertyRenameBeta>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'sourceId',
+            baseName: 'sourceId',
+            type: 'string',
+        },
+        {
+            name: 'destinationMetadataId',
+            baseName: 'destinationMetadataId',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'if',
+            baseName: 'if',
+            type: 'string',
+        },
+        {
+            name: 'newEventName',
+            baseName: 'newEventName',
+            type: 'string',
+        },
+        {
+            name: 'propertyRenames',
+            baseName: 'propertyRenames',
+            type: 'Array<PropertyRenameBeta>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateTransformationBetaInput.attributeTypeMap;
+    }
+}

package/model/updateTransformationBetaOutput.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 { Transformation1 } from './transformation1';
+
+/**
+ * The output of an updated Transformation.
+ */
+export class UpdateTransformationBetaOutput {
+    'transformation': Transformation1;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'transformation',
+            baseName: 'transformation',
+            type: 'Transformation1',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateTransformationBetaOutput.attributeTypeMap;
+    }
+}

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

package/model/updateUserGroupV1Input.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';
+
+/**
+ * Updates a user group with a given id.
+ */
+export class UpdateUserGroupV1Input {
+    /**
+     * The intended value to rename the user group to.
+     */
+    'name'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateUserGroupV1Input.attributeTypeMap;
+    }
+}

package/model/updateUserGroupV1Output.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 { UserGroup3 } from './userGroup3';
+
+/**
+ * Returns the updated user group.
+ */
+export class UpdateUserGroupV1Output {
+    'userGroup': UserGroup3;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'userGroup',
+            baseName: 'userGroup',
+            type: 'UserGroup3',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateUserGroupV1Output.attributeTypeMap;
+    }
+}

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