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

package/model/allowedLabelBeta.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';
+
+/**
+ * Defines a label that you may apply to resources within a Workspace.
+ */
+export class AllowedLabelBeta {
+    /**
+     * The key identifier for this label.
+     */
+    'key': string;
+    /**
+     * The value of this label.
+     */
+    'value': string;
+    /**
+     * A description of what this label represents.
+     */
+    'description'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'key',
+            baseName: 'key',
+            type: 'string',
+        },
+        {
+            name: 'value',
+            baseName: 'value',
+            type: 'string',
+        },
+        {
+            name: 'description',
+            baseName: 'description',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AllowedLabelBeta.attributeTypeMap;
+    }
+}

package/model/auditEventV1.ts

@@ -0,0 +1,95 @@
+/**
+ * Segment Public API
+ * The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs.  All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace.  See the next sections for more information on how to use the Segment Public API.
+ *
+ * The version of the OpenAPI document: 32.0.2
+ * Contact: friends@segment.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+/**
+ * Represents an Audit Trail event.
+ */
+export class AuditEventV1 {
+    /**
+     * Unique identifier for this audit trail event.
+     */
+    'id': string;
+    /**
+     * The timestamp of this event in ISO-8601 format.
+     */
+    'timestamp': string;
+    /**
+     * The type of this event.
+     */
+    'type': string;
+    /**
+     * The user or API token that triggered this event.
+     */
+    'actor': string;
+    /**
+     * The identifier of the resource affected by this event.
+     */
+    'resourceId': string;
+    /**
+     * The kind of resource affected by this event.
+     */
+    'resourceType': string;
+    /**
+     * The name of the resource affected by this event.
+     */
+    'resourceName': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'id',
+            baseName: 'id',
+            type: 'string',
+        },
+        {
+            name: 'timestamp',
+            baseName: 'timestamp',
+            type: 'string',
+        },
+        {
+            name: 'type',
+            baseName: 'type',
+            type: 'string',
+        },
+        {
+            name: 'actor',
+            baseName: 'actor',
+            type: 'string',
+        },
+        {
+            name: 'resourceId',
+            baseName: 'resourceId',
+            type: 'string',
+        },
+        {
+            name: 'resourceType',
+            baseName: 'resourceType',
+            type: 'string',
+        },
+        {
+            name: 'resourceName',
+            baseName: 'resourceName',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return AuditEventV1.attributeTypeMap;
+    }
+}

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

package/model/batchQueryMessagingSubscriptionsForSpaceAlphaInput.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 { GetSubscriptionRequest } from './getSubscriptionRequest';
+
+/**
+ * Batch get request.
+ */
+export class BatchQueryMessagingSubscriptionsForSpaceAlphaInput {
+    /**
+     * A list of subscriptions to retrieve subscription status.
+     */
+    'subscriptions': Array<GetSubscriptionRequest>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'subscriptions',
+            baseName: 'subscriptions',
+            type: 'Array<GetSubscriptionRequest>',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return BatchQueryMessagingSubscriptionsForSpaceAlphaInput.attributeTypeMap;
+    }
+}

package/model/batchQueryMessagingSubscriptionsForSpaceAlphaOutput.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 { GetMessagingSubscriptionFailureResponse } from './getMessagingSubscriptionFailureResponse';
+import { GetMessagingSubscriptionSuccessResponse } from './getMessagingSubscriptionSuccessResponse';
+import { MessageSubscriptionResponseError } from './messageSubscriptionResponseError';
+import { Pagination } from './pagination';
+
+/**
+ * Batch get response.
+ */
+export class BatchQueryMessagingSubscriptionsForSpaceAlphaOutput {
+    /**
+     * Array of successful subscription status.
+     */
+    'successes': Array<GetMessagingSubscriptionSuccessResponse>;
+    /**
+     * Validation errors due to invalid types or email/phone numbers.
+     */
+    'failures': Array<GetMessagingSubscriptionFailureResponse>;
+    /**
+     * General errors when making the request such as invalid payload or wrong http method errors.
+     */
+    'errors': Array<MessageSubscriptionResponseError>;
+    'pagination'?: Pagination;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'successes',
+            baseName: 'successes',
+            type: 'Array<GetMessagingSubscriptionSuccessResponse>',
+        },
+        {
+            name: 'failures',
+            baseName: 'failures',
+            type: 'Array<GetMessagingSubscriptionFailureResponse>',
+        },
+        {
+            name: 'errors',
+            baseName: 'errors',
+            type: 'Array<MessageSubscriptionResponseError>',
+        },
+        {
+            name: 'pagination',
+            baseName: 'pagination',
+            type: 'Pagination',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return BatchQueryMessagingSubscriptionsForSpaceAlphaOutput.attributeTypeMap;
+    }
+}

package/model/breakdownBeta.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';
+
+/**
+ * The breakdown of a metric.
+ */
+export class BreakdownBeta {
+    /**
+     * The name of the metric.
+     */
+    'metricName': string;
+    /**
+     * Number of occurrences of the metric.
+     */
+    'value': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'metricName',
+            baseName: 'metricName',
+            type: 'string',
+        },
+        {
+            name: 'value',
+            baseName: 'value',
+            type: 'number',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return BreakdownBeta.attributeTypeMap;
+    }
+}

package/model/commonSourceSettingsV1.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { Group } from './group';
+import { Identify } from './identify';
+import { Track } from './track';
+
+export class CommonSourceSettingsV1 {
+    'track'?: Track;
+    'identify'?: Identify;
+    'group'?: Group;
+    /**
+     * SourceId to forward violations to.
+     */
+    'forwardingViolationsTo'?: string;
+    /**
+     * SourceId to forward blocked events to.
+     */
+    'forwardingBlockedEventsTo'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'track',
+            baseName: 'track',
+            type: 'Track',
+        },
+        {
+            name: 'identify',
+            baseName: 'identify',
+            type: 'Identify',
+        },
+        {
+            name: 'group',
+            baseName: 'group',
+            type: 'Group',
+        },
+        {
+            name: 'forwardingViolationsTo',
+            baseName: 'forwardingViolationsTo',
+            type: 'string',
+        },
+        {
+            name: 'forwardingBlockedEventsTo',
+            baseName: 'forwardingBlockedEventsTo',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CommonSourceSettingsV1.attributeTypeMap;
+    }
+}

package/model/contact.ts

@@ -0,0 +1,68 @@
+/**
+ * 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';
+
+/**
+ * The contact info for Integration Owners.
+ */
+export class Contact {
+    /**
+     * Name of this contact.
+     */
+    'name': string;
+    /**
+     * Email of this contact.
+     */
+    'email': string;
+    /**
+     * Role of this contact.
+     */
+    'role': string;
+    /**
+     * Whether this is a primary contact.
+     */
+    'isPrimary': boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'name',
+            baseName: 'name',
+            type: 'string',
+        },
+        {
+            name: 'email',
+            baseName: 'email',
+            type: 'string',
+        },
+        {
+            name: 'role',
+            baseName: 'role',
+            type: 'string',
+        },
+        {
+            name: 'isPrimary',
+            baseName: 'isPrimary',
+            type: 'boolean',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return Contact.attributeTypeMap;
+    }
+}

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

package/model/createCloudSourceRegulationV1Input.ts

@@ -0,0 +1,82 @@
+/**
+ * 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';
+
+/**
+ * The input to create a Cloud Source-scoped regulation.
+ */
+export class CreateCloudSourceRegulationV1Input {
+    /**
+     * The regulation type to create.
+     */
+    'regulationType': CreateCloudSourceRegulationV1Input.RegulationTypeEnum;
+    /**
+     * The subject type. Must be `objectId` for Cloud Sources.
+     */
+    'subjectType'?: CreateCloudSourceRegulationV1Input.SubjectTypeEnum;
+    /**
+     * The user or object ids of the subjects to regulate.  Config API note: equal to `parent` but allows an array.
+     */
+    'subjectIds'?: Array<string>;
+    /**
+     * The Cloud Source collection to regulate.
+     */
+    'collection': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'regulationType',
+            baseName: 'regulationType',
+            type: 'CreateCloudSourceRegulationV1Input.RegulationTypeEnum',
+        },
+        {
+            name: 'subjectType',
+            baseName: 'subjectType',
+            type: 'CreateCloudSourceRegulationV1Input.SubjectTypeEnum',
+        },
+        {
+            name: 'subjectIds',
+            baseName: 'subjectIds',
+            type: 'Array<string>',
+        },
+        {
+            name: 'collection',
+            baseName: 'collection',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateCloudSourceRegulationV1Input.attributeTypeMap;
+    }
+}
+
+export namespace CreateCloudSourceRegulationV1Input {
+    export enum RegulationTypeEnum {
+        BULK_DELETE_ONLY = <any>'BULK_DELETE_ONLY',
+        DELETE_INTERNAL = <any>'DELETE_INTERNAL',
+        DELETE_ONLY = <any>'DELETE_ONLY',
+        SUPPRESS_ONLY = <any>'SUPPRESS_ONLY',
+        SUPPRESS_WITH_DELETE = <any>'SUPPRESS_WITH_DELETE',
+        UNSUPPRESS = <any>'UNSUPPRESS',
+    }
+    export enum SubjectTypeEnum {
+        OBJECT_ID = <any>'OBJECT_ID',
+    }
+}

package/model/createCloudSourceRegulationV1Output.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';
+
+/**
+ * The output of a create Cloud Source regulation call.
+ */
+export class CreateCloudSourceRegulationV1Output {
+    /**
+     * The id of the created regulation.
+     */
+    'regulateId': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }> = [
+        {
+            name: 'regulateId',
+            baseName: 'regulateId',
+            type: 'string',
+        },
+    ];
+
+    static getAttributeTypeMap() {
+        return CreateCloudSourceRegulationV1Output.attributeTypeMap;
+    }
+}