@barndoor-ai/sdk 1.2.0 → 2.0.0-dev.g37b8897

package/dist/esm/models/CreateRouteGroupRequest.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateRouteGroupRequest
+ */
+export interface CreateRouteGroupRequest {
+    /**
+     * Optional free-text note explaining why this group was created
+     * (BCP-3998). Distinct from `description`, which describes what the group
+     * *is* and persists; this describes one change and is replaced by the
+     * next edit's note.
+     */
+    changeNote?: string | null;
+    /**
+     *
+     */
+    description?: string;
+    /**
+     * Optional initial membership, so "create a group from the routes I have
+     * selected" is one request instead of two.
+     */
+    modelAliases?: Array<string>;
+    /**
+     *
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the CreateRouteGroupRequest interface.
+ */
+export declare function instanceOfCreateRouteGroupRequest(value: object): value is CreateRouteGroupRequest;
+export declare function CreateRouteGroupRequestFromJSON(json: any): CreateRouteGroupRequest;
+export declare function CreateRouteGroupRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRouteGroupRequest;
+export declare function CreateRouteGroupRequestToJSON(json: any): CreateRouteGroupRequest;
+export declare function CreateRouteGroupRequestToJSONTyped(value?: CreateRouteGroupRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateRouteGroupRequest.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CreateRouteGroupRequest interface.
+ */
+export function instanceOfCreateRouteGroupRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function CreateRouteGroupRequestFromJSON(json) {
+    return CreateRouteGroupRequestFromJSONTyped(json, false);
+}
+export function CreateRouteGroupRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'changeNote': json['change_note'] === undefined ? undefined : json['change_note'] === null ? null : json['change_note'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'modelAliases': json['model_aliases'] == null ? undefined : json['model_aliases'],
+        'name': json['name'],
+    };
+}
+export function CreateRouteGroupRequestToJSON(json) {
+    return CreateRouteGroupRequestToJSONTyped(json, false);
+}
+export function CreateRouteGroupRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'change_note': value['changeNote'],
+        'description': value['description'],
+        'model_aliases': value['modelAliases'],
+        'name': value['name'],
+    };
+}

package/dist/esm/models/CredentialsPayload.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Payload for providing credentials during connection setup.
+ * @export
+ * @interface CredentialsPayload
+ */
+export interface CredentialsPayload {
+    /**
+     *
+     */
+    apiKey?: string | null;
+    /**
+     *
+     */
+    token?: string | null;
+    /**
+     *
+     */
+    bearerToken?: string | null;
+    /**
+     *
+     */
+    username?: string | null;
+    /**
+     *
+     */
+    password?: string | null;
+    /**
+     *
+     */
+    additionalFields?: {
+        [key: string]: any;
+    } | null;
+}
+/**
+ * Check if a given object implements the CredentialsPayload interface.
+ */
+export declare function instanceOfCredentialsPayload(value: object): value is CredentialsPayload;
+export declare function CredentialsPayloadFromJSON(json: any): CredentialsPayload;
+export declare function CredentialsPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): CredentialsPayload;
+export declare function CredentialsPayloadToJSON(json: any): CredentialsPayload;
+export declare function CredentialsPayloadToJSONTyped(value?: CredentialsPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CredentialsPayload.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CredentialsPayload interface.
+ */
+export function instanceOfCredentialsPayload(value) {
+    return true;
+}
+export function CredentialsPayloadFromJSON(json) {
+    return CredentialsPayloadFromJSONTyped(json, false);
+}
+export function CredentialsPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'apiKey': json['api_key'] === undefined ? undefined : json['api_key'] === null ? null : json['api_key'],
+        'token': json['token'] === undefined ? undefined : json['token'] === null ? null : json['token'],
+        'bearerToken': json['bearer_token'] === undefined ? undefined : json['bearer_token'] === null ? null : json['bearer_token'],
+        'username': json['username'] === undefined ? undefined : json['username'] === null ? null : json['username'],
+        'password': json['password'] === undefined ? undefined : json['password'] === null ? null : json['password'],
+        'additionalFields': json['additional_fields'] === undefined ? undefined : json['additional_fields'] === null ? null : json['additional_fields'],
+    };
+}
+export function CredentialsPayloadToJSON(json) {
+    return CredentialsPayloadToJSONTyped(json, false);
+}
+export function CredentialsPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'api_key': value['apiKey'],
+        'token': value['token'],
+        'bearer_token': value['bearerToken'],
+        'username': value['username'],
+        'password': value['password'],
+        'additional_fields': value['additionalFields'],
+    };
+}

package/dist/esm/models/CustomDetectionPatternRequest.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CustomDetectionPatternRequest
+ */
+export interface CustomDetectionPatternRequest {
+    /**
+     * Optional return URL for redirecting the user after connection completes.
+     */
+    pattern: string | null;
+    /**
+     * Optional return URL for redirecting the user after connection completes.
+     */
+    patternType: string | null;
+}
+/**
+ * Check if a given object implements the CustomDetectionPatternRequest interface.
+ */
+export declare function instanceOfCustomDetectionPatternRequest(value: object): value is CustomDetectionPatternRequest;
+export declare function CustomDetectionPatternRequestFromJSON(json: any): CustomDetectionPatternRequest;
+export declare function CustomDetectionPatternRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDetectionPatternRequest;
+export declare function CustomDetectionPatternRequestToJSON(json: any): CustomDetectionPatternRequest;
+export declare function CustomDetectionPatternRequestToJSONTyped(value?: CustomDetectionPatternRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomDetectionPatternRequest.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CustomDetectionPatternRequest interface.
+ */
+export function instanceOfCustomDetectionPatternRequest(value) {
+    if (!('pattern' in value) || value['pattern'] === undefined)
+        return false;
+    if ((!('patternType' in value) && !('pattern_type' in value)) || (value['patternType'] === undefined && value['pattern_type'] === undefined))
+        return false;
+    return true;
+}
+export function CustomDetectionPatternRequestFromJSON(json) {
+    return CustomDetectionPatternRequestFromJSONTyped(json, false);
+}
+export function CustomDetectionPatternRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'pattern': json['pattern'],
+        'patternType': json['pattern_type'],
+    };
+}
+export function CustomDetectionPatternRequestToJSON(json) {
+    return CustomDetectionPatternRequestToJSONTyped(json, false);
+}
+export function CustomDetectionPatternRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'pattern': value['pattern'],
+        'pattern_type': value['patternType'],
+    };
+}

package/dist/esm/models/CustomDetectionPatternResponse.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CustomDetectionPatternResponse
+ */
+export interface CustomDetectionPatternResponse {
+    /**
+     * Optional return URL for redirecting the user after connection completes.
+     */
+    pattern: string | null;
+    /**
+     * Optional return URL for redirecting the user after connection completes.
+     */
+    patternType: string | null;
+}
+/**
+ * Check if a given object implements the CustomDetectionPatternResponse interface.
+ */
+export declare function instanceOfCustomDetectionPatternResponse(value: object): value is CustomDetectionPatternResponse;
+export declare function CustomDetectionPatternResponseFromJSON(json: any): CustomDetectionPatternResponse;
+export declare function CustomDetectionPatternResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDetectionPatternResponse;
+export declare function CustomDetectionPatternResponseToJSON(json: any): CustomDetectionPatternResponse;
+export declare function CustomDetectionPatternResponseToJSONTyped(value?: CustomDetectionPatternResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomDetectionPatternResponse.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CustomDetectionPatternResponse interface.
+ */
+export function instanceOfCustomDetectionPatternResponse(value) {
+    if (!('pattern' in value) || value['pattern'] === undefined)
+        return false;
+    if ((!('patternType' in value) && !('pattern_type' in value)) || (value['patternType'] === undefined && value['pattern_type'] === undefined))
+        return false;
+    return true;
+}
+export function CustomDetectionPatternResponseFromJSON(json) {
+    return CustomDetectionPatternResponseFromJSONTyped(json, false);
+}
+export function CustomDetectionPatternResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'pattern': json['pattern'],
+        'patternType': json['pattern_type'],
+    };
+}
+export function CustomDetectionPatternResponseToJSON(json) {
+    return CustomDetectionPatternResponseToJSONTyped(json, false);
+}
+export function CustomDetectionPatternResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'pattern': value['pattern'],
+        'pattern_type': value['patternType'],
+    };
+}

package/dist/esm/models/CustomDetectionTypeResponse.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CustomDetectionPatternResponse } from './CustomDetectionPatternResponse.js';
+/**
+ *
+ * @export
+ * @interface CustomDetectionTypeResponse
+ */
+export interface CustomDetectionTypeResponse {
+    /**
+     *
+     */
+    createdAt: string;
+    /**
+     *
+     */
+    defaultConfidence: string;
+    /**
+     *
+     */
+    defaultSeverity: string;
+    /**
+     *
+     */
+    description: string;
+    /**
+     *
+     */
+    detectionType: string;
+    /**
+     *
+     */
+    group: string;
+    /**
+     *
+     */
+    id: string;
+    /**
+     *
+     */
+    name: string;
+    /**
+     *
+     */
+    orgId: string;
+    /**
+     *
+     */
+    patterns: Array<CustomDetectionPatternResponse>;
+    /**
+     *
+     */
+    updatedAt: string;
+}
+/**
+ * Check if a given object implements the CustomDetectionTypeResponse interface.
+ */
+export declare function instanceOfCustomDetectionTypeResponse(value: object): value is CustomDetectionTypeResponse;
+export declare function CustomDetectionTypeResponseFromJSON(json: any): CustomDetectionTypeResponse;
+export declare function CustomDetectionTypeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDetectionTypeResponse;
+export declare function CustomDetectionTypeResponseToJSON(json: any): CustomDetectionTypeResponse;
+export declare function CustomDetectionTypeResponseToJSONTyped(value?: CustomDetectionTypeResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomDetectionTypeResponse.js

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CustomDetectionPatternResponseFromJSON, CustomDetectionPatternResponseToJSON, } from './CustomDetectionPatternResponse.js';
+/**
+ * Check if a given object implements the CustomDetectionTypeResponse interface.
+ */
+export function instanceOfCustomDetectionTypeResponse(value) {
+    if ((!('createdAt' in value) && !('created_at' in value)) || (value['createdAt'] === undefined && value['created_at'] === undefined))
+        return false;
+    if ((!('defaultConfidence' in value) && !('default_confidence' in value)) || (value['defaultConfidence'] === undefined && value['default_confidence'] === undefined))
+        return false;
+    if ((!('defaultSeverity' in value) && !('default_severity' in value)) || (value['defaultSeverity'] === undefined && value['default_severity'] === undefined))
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if ((!('detectionType' in value) && !('detection_type' in value)) || (value['detectionType'] === undefined && value['detection_type'] === undefined))
+        return false;
+    if (!('group' in value) || value['group'] === undefined)
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if ((!('orgId' in value) && !('org_id' in value)) || (value['orgId'] === undefined && value['org_id'] === undefined))
+        return false;
+    if (!('patterns' in value) || value['patterns'] === undefined)
+        return false;
+    if ((!('updatedAt' in value) && !('updated_at' in value)) || (value['updatedAt'] === undefined && value['updated_at'] === undefined))
+        return false;
+    return true;
+}
+export function CustomDetectionTypeResponseFromJSON(json) {
+    return CustomDetectionTypeResponseFromJSONTyped(json, false);
+}
+export function CustomDetectionTypeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'createdAt': json['created_at'],
+        'defaultConfidence': json['default_confidence'],
+        'defaultSeverity': json['default_severity'],
+        'description': json['description'],
+        'detectionType': json['detection_type'],
+        'group': json['group'],
+        'id': json['id'],
+        'name': json['name'],
+        'orgId': json['org_id'],
+        'patterns': (json['patterns'].map(CustomDetectionPatternResponseFromJSON)),
+        'updatedAt': json['updated_at'],
+    };
+}
+export function CustomDetectionTypeResponseToJSON(json) {
+    return CustomDetectionTypeResponseToJSONTyped(json, false);
+}
+export function CustomDetectionTypeResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'created_at': value['createdAt'],
+        'default_confidence': value['defaultConfidence'],
+        'default_severity': value['defaultSeverity'],
+        'description': value['description'],
+        'detection_type': value['detectionType'],
+        'group': value['group'],
+        'id': value['id'],
+        'name': value['name'],
+        'org_id': value['orgId'],
+        'patterns': (value['patterns'].map(CustomDetectionPatternResponseToJSON)),
+        'updated_at': value['updatedAt'],
+    };
+}

package/dist/esm/models/CustomDetectionTypesResponse.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CustomDetectionTypeResponse } from './CustomDetectionTypeResponse.js';
+/**
+ *
+ * @export
+ * @interface CustomDetectionTypesResponse
+ */
+export interface CustomDetectionTypesResponse {
+    /**
+     *
+     */
+    items: Array<CustomDetectionTypeResponse>;
+}
+/**
+ * Check if a given object implements the CustomDetectionTypesResponse interface.
+ */
+export declare function instanceOfCustomDetectionTypesResponse(value: object): value is CustomDetectionTypesResponse;
+export declare function CustomDetectionTypesResponseFromJSON(json: any): CustomDetectionTypesResponse;
+export declare function CustomDetectionTypesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDetectionTypesResponse;
+export declare function CustomDetectionTypesResponseToJSON(json: any): CustomDetectionTypesResponse;
+export declare function CustomDetectionTypesResponseToJSONTyped(value?: CustomDetectionTypesResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomDetectionTypesResponse.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CustomDetectionTypeResponseFromJSON, CustomDetectionTypeResponseToJSON, } from './CustomDetectionTypeResponse.js';
+/**
+ * Check if a given object implements the CustomDetectionTypesResponse interface.
+ */
+export function instanceOfCustomDetectionTypesResponse(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function CustomDetectionTypesResponseFromJSON(json) {
+    return CustomDetectionTypesResponseFromJSONTyped(json, false);
+}
+export function CustomDetectionTypesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(CustomDetectionTypeResponseFromJSON)),
+    };
+}
+export function CustomDetectionTypesResponseToJSON(json) {
+    return CustomDetectionTypesResponseToJSONTyped(json, false);
+}
+export function CustomDetectionTypesResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(CustomDetectionTypeResponseToJSON)),
+    };
+}

package/dist/esm/models/DefaultModelAccess.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Barndoor.ai Public API
+ * Unified public API specification for Barndoor.ai platform
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Org-wide posture for model access (BCP-3887).
+ *
+ * Answers "what happens to a route that no applicable policy mentions?" —
+ * distinct from the policies themselves, which answer "who may use what".
+ *
+ * [`Allow`](Self::Allow) is the historical behaviour and the `Default`. That
+ * default is not cosmetic: `governance_config` holds a row only for orgs that
+ * have already changed some governance setting, so [`GovernanceConfigDb::get`]
+ * returns `GovernanceConfig::default()` for most orgs and this enum decides
+ * their posture. It must agree with the column default in
+ * `V70__default_model_access.sql`; `default_matches_column_default` pins that.
+ * @export
+ */
+export declare const DefaultModelAccess: {
+    readonly Allow: "allow";
+    readonly Deny: "deny";
+};
+export type DefaultModelAccess = typeof DefaultModelAccess[keyof typeof DefaultModelAccess];
+export declare function instanceOfDefaultModelAccess(value: any): boolean;
+export declare function DefaultModelAccessFromJSON(json: any): DefaultModelAccess;
+export declare function DefaultModelAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): DefaultModelAccess;
+export declare function DefaultModelAccessToJSON(value?: DefaultModelAccess | null): any;
+export declare function DefaultModelAccessToJSONTyped(value: any, ignoreDiscriminator: boolean): DefaultModelAccess;