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

package/model/transformation2.ts

@@ -0,0 +1,105 @@
+/**
+ * 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 created Transformation.
+ */
+export class Transformation2 {
+    /**
+     * The id of the Transformation.
+     */
+    'id': string;
+    /**
+     * The name of the Transformation.
+     */
+    'name': string;
+    /**
+     * The Source associated with the Transformation.
+     */
+    'sourceId': string;
+    /**
+     * The optional Destination metadata associated with the Transformation.
+     */
+    'destinationMetadataId'?: string;
+    /**
+     * If the Transformation is 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: 'id',
+            baseName: 'id',
+            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 Transformation2.attributeTypeMap;
+    }
+}

package/model/transformationBeta.ts

@@ -0,0 +1,105 @@
+/**
+ * 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';
+
+/**
+ * Represents a Transformation.
+ */
+export class TransformationBeta {
+    /**
+     * The id of the Transformation.
+     */
+    'id': string;
+    /**
+     * The name of the Transformation.
+     */
+    'name': string;
+    /**
+     * The Source associated with the Transformation.
+     */
+    'sourceId': string;
+    /**
+     * The optional Destination metadata associated with the Transformation.
+     */
+    'destinationMetadataId'?: string;
+    /**
+     * If the Transformation is 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: 'id',
+            baseName: 'id',
+            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 TransformationBeta.attributeTypeMap;
+    }
+}

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

package/model/updateDestinationV1Input.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 single Destination by its id.
+ */
+export class UpdateDestinationV1Input {
+    /**
+     * Defines the display name of the Destination.  Config API note: equal to `displayName`.
+     */
+    'name'?: string | null;
+    /**
+     * Whether this Destination should receive data.
+     */
+    'enabled'?: boolean;
+    /**
+     * An optional object that contains settings for the Destination based on the \"required\" and \"advanced\" settings present in the Destination metadata.  Config API note: equal to `config`.
+     */
+    'settings'?: { [key: string]: any };
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+        {
+            name: 'settings',
+            baseName: 'settings',
+            type: '{ [key: string]: any; }',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateDestinationV1Input.attributeTypeMap;
+    }
+}

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

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

package/model/updateFilterForDestinationV1Input.ts

@@ -0,0 +1,78 @@
+/**
+ * Segment Public API
+ * The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs.  All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace.  See the next sections for more information on how to use the Segment Public API.
+ *
+ * The version of the OpenAPI document: 32.0.2
+ * Contact: friends@segment.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { DestinationFilterActionV1 } from './destinationFilterActionV1';
+
+/**
+ * Input for UpdateDestinationFilterV1.
+ */
+export class UpdateFilterForDestinationV1Input {
+    /**
+     * The FQL if condition to update.
+     */
+    'if'?: string;
+    /**
+     * Actions for this Destination filter.
+     */
+    'actions'?: Array<DestinationFilterActionV1>;
+    /**
+     * The title to update.
+     */
+    'title'?: string;
+    /**
+     * The description of this filter.
+     */
+    'description'?: string | null;
+    /**
+     * When set to true, this Destination filter is active.
+     */
+    'enabled'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'if',
+            baseName: 'if',
+            type: 'string',
+        },
+        {
+            name: 'actions',
+            baseName: 'actions',
+            type: 'Array<DestinationFilterActionV1>',
+        },
+        {
+            name: 'title',
+            baseName: 'title',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+        {
+            name: 'enabled',
+            baseName: 'enabled',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateFilterForDestinationV1Input.attributeTypeMap;
+    }
+}

package/model/updateFilterForDestinationV1Output.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 { Filter3 } from './filter3';
+
+/**
+ * Output for UpdateDestinationFilterV1.
+ */
+export class UpdateFilterForDestinationV1Output {
+    'filter': Filter3;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'filter',
+            baseName: 'filter',
+            type: 'Filter3',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateFilterForDestinationV1Output.attributeTypeMap;
+    }
+}

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

package/model/updateFunctionV1Input.ts

@@ -0,0 +1,78 @@
+/**
+ * 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';
+
+/**
+ * Update a Function.
+ */
+export class UpdateFunctionV1Input {
+    /**
+     * The Function code.
+     */
+    'code'?: string;
+    /**
+     * The list of settings for this Function.
+     */
+    'settings'?: Array<FunctionSettingV1>;
+    /**
+     * A display name for this Function.
+     */
+    'displayName'?: string;
+    /**
+     * A logo for this Function.
+     */
+    'logoUrl'?: string;
+    /**
+     * 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: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return UpdateFunctionV1Input.attributeTypeMap;
+    }
+}

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