ogx-client 0.7.2-rc1

package/resources/shared.d.ts

@@ -0,0 +1,447 @@
+import * as ProvidersAPI from "./providers.js";
+import * as RoutesAPI from "./routes.js";
+/**
+ * Health status information for the service.
+ */
+export interface HealthInfo {
+    /**
+     * The health status of the service
+     */
+    status: 'OK' | 'Error' | 'Not Implemented';
+}
+/**
+ * A image content item
+ */
+export type InterleavedContent = string | InterleavedContent.ImageContentItem | InterleavedContent.TextContentItem | Array<InterleavedContent.ImageContentItem | InterleavedContent.TextContentItem>;
+export declare namespace InterleavedContent {
+    /**
+     * A image content item
+     */
+    interface ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        image: ImageContentItem.Image;
+        type?: 'image';
+    }
+    namespace ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        interface Image {
+            data?: string | null;
+            /**
+             * A URL reference to external content.
+             */
+            url?: Image.URL | null;
+        }
+        namespace Image {
+            /**
+             * A URL reference to external content.
+             */
+            interface URL {
+                uri: string;
+            }
+        }
+    }
+    /**
+     * A text content item
+     */
+    interface TextContentItem {
+        text: string;
+        type?: 'text';
+    }
+    /**
+     * A image content item
+     */
+    interface ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        image: ImageContentItem.Image;
+        type?: 'image';
+    }
+    namespace ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        interface Image {
+            data?: string | null;
+            /**
+             * A URL reference to external content.
+             */
+            url?: Image.URL | null;
+        }
+        namespace Image {
+            /**
+             * A URL reference to external content.
+             */
+            interface URL {
+                uri: string;
+            }
+        }
+    }
+    /**
+     * A text content item
+     */
+    interface TextContentItem {
+        text: string;
+        type?: 'text';
+    }
+}
+/**
+ * A image content item
+ */
+export type InterleavedContentItem = InterleavedContentItem.ImageContentItem | InterleavedContentItem.TextContentItem;
+export declare namespace InterleavedContentItem {
+    /**
+     * A image content item
+     */
+    interface ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        image: ImageContentItem.Image;
+        type?: 'image';
+    }
+    namespace ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        interface Image {
+            data?: string | null;
+            /**
+             * A URL reference to external content.
+             */
+            url?: Image.URL | null;
+        }
+        namespace Image {
+            /**
+             * A URL reference to external content.
+             */
+            interface URL {
+                uri: string;
+            }
+        }
+    }
+    /**
+     * A text content item
+     */
+    interface TextContentItem {
+        text: string;
+        type?: 'text';
+    }
+}
+/**
+ * Response containing a list of all available providers.
+ */
+export interface ListProvidersResponse {
+    /**
+     * List of provider information objects
+     */
+    data: ProvidersAPI.ProviderListResponse;
+}
+/**
+ * Response containing a list of all available API routes.
+ */
+export interface ListRoutesResponse {
+    /**
+     * List of available API routes
+     */
+    data: RoutesAPI.RouteListResponse;
+}
+/**
+ * Parameter type for string values.
+ */
+export type ParamType = ParamType.StringType | ParamType.NumberType | ParamType.BooleanType | ParamType.ArrayType | ParamType.ObjectType | ParamType.JsonType | ParamType.UnionType | ParamType.ChatCompletionInputType | ParamType.CompletionInputType;
+export declare namespace ParamType {
+    /**
+     * Parameter type for string values.
+     */
+    interface StringType {
+        type?: 'string';
+    }
+    /**
+     * Parameter type for numeric values.
+     */
+    interface NumberType {
+        type?: 'number';
+    }
+    /**
+     * Parameter type for boolean values.
+     */
+    interface BooleanType {
+        type?: 'boolean';
+    }
+    /**
+     * Parameter type for array values.
+     */
+    interface ArrayType {
+        type?: 'array';
+    }
+    /**
+     * Parameter type for object values.
+     */
+    interface ObjectType {
+        type?: 'object';
+    }
+    /**
+     * Parameter type for JSON values.
+     */
+    interface JsonType {
+        type?: 'json';
+    }
+    /**
+     * Parameter type for union values.
+     */
+    interface UnionType {
+        type?: 'union';
+    }
+    /**
+     * Parameter type for chat completion input.
+     */
+    interface ChatCompletionInputType {
+        type?: 'chat_completion_input';
+    }
+    /**
+     * Parameter type for completion input.
+     */
+    interface CompletionInputType {
+        type?: 'completion_input';
+    }
+}
+/**
+ * Information about a registered provider including its configuration and health
+ * status.
+ */
+export interface ProviderInfo {
+    /**
+     * The API name this provider implements
+     */
+    api: string;
+    /**
+     * Configuration parameters for the provider
+     */
+    config: {
+        [key: string]: unknown;
+    };
+    /**
+     * Current health status of the provider
+     */
+    health: {
+        [key: string]: unknown;
+    };
+    /**
+     * Unique identifier for the provider
+     */
+    provider_id: string;
+    /**
+     * The type of provider implementation
+     */
+    provider_type: string;
+}
+/**
+ * Information about an API route including its path, method, and implementing
+ * providers.
+ */
+export interface RouteInfo {
+    /**
+     * The HTTP method for the route
+     */
+    method: string;
+    /**
+     * List of provider types implementing this route
+     */
+    provider_types: Array<string>;
+    /**
+     * The API route path
+     */
+    route: string;
+}
+/**
+ * Details of a safety violation detected by content moderation.
+ */
+export interface SafetyViolation {
+    /**
+     * Severity level of the violation
+     */
+    violation_level: 'info' | 'warn' | 'error';
+    /**
+     * Additional metadata including specific violation codes
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Message to convey to the user about the violation
+     */
+    user_message?: string | null;
+}
+/**
+ * Sampling parameters for text generation.
+ */
+export interface SamplingParams {
+    /**
+     * The maximum number of tokens that can be generated in the completion. The token
+     * count of your prompt plus max_tokens cannot exceed the model's context length.
+     */
+    max_tokens?: number | null;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+     * whether they appear in the text so far.
+     */
+    repetition_penalty?: number | null;
+    /**
+     * Up to 4 sequences where the API will stop generating further tokens. The
+     * returned text will not contain the stop sequence.
+     */
+    stop?: Array<string> | null;
+    /**
+     * The sampling strategy to use.
+     */
+    strategy?: SamplingParams.GreedySamplingStrategy | SamplingParams.TopPSamplingStrategy | SamplingParams.TopKSamplingStrategy;
+}
+export declare namespace SamplingParams {
+    /**
+     * Greedy sampling strategy that selects the highest probability token at each
+     * step.
+     */
+    interface GreedySamplingStrategy {
+        /**
+         * Must be 'greedy' to identify this sampling strategy.
+         */
+        type?: 'greedy';
+    }
+    /**
+     * Top-p (nucleus) sampling strategy that samples from the smallest set of tokens
+     * with cumulative probability >= p.
+     */
+    interface TopPSamplingStrategy {
+        /**
+         * Controls randomness in sampling. Higher values increase randomness.
+         */
+        temperature: number;
+        /**
+         * Cumulative probability threshold for nucleus sampling.
+         */
+        top_p?: number;
+        /**
+         * Must be 'top_p' to identify this sampling strategy.
+         */
+        type?: 'top_p';
+    }
+    /**
+     * Top-k sampling strategy that restricts sampling to the k most likely tokens.
+     */
+    interface TopKSamplingStrategy {
+        /**
+         * Number of top tokens to consider for sampling. Must be at least 1.
+         */
+        top_k: number;
+        /**
+         * Must be 'top_k' to identify this sampling strategy.
+         */
+        type?: 'top_k';
+    }
+}
+/**
+ * A system message providing instructions or context to the model.
+ */
+export interface SystemMessage {
+    /**
+     * The content of the 'system prompt'. If multiple system messages are provided,
+     * they are concatenated. The underlying OGX code may also add other system
+     * messages.
+     */
+    content: string | SystemMessage.ImageContentItem | SystemMessage.TextContentItem | Array<SystemMessage.ImageContentItem | SystemMessage.TextContentItem>;
+    /**
+     * Must be 'system' to identify this as a system message.
+     */
+    role?: 'system';
+}
+export declare namespace SystemMessage {
+    /**
+     * A image content item
+     */
+    interface ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        image: ImageContentItem.Image;
+        type?: 'image';
+    }
+    namespace ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        interface Image {
+            data?: string | null;
+            /**
+             * A URL reference to external content.
+             */
+            url?: Image.URL | null;
+        }
+        namespace Image {
+            /**
+             * A URL reference to external content.
+             */
+            interface URL {
+                uri: string;
+            }
+        }
+    }
+    /**
+     * A text content item
+     */
+    interface TextContentItem {
+        text: string;
+        type?: 'text';
+    }
+    /**
+     * A image content item
+     */
+    interface ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        image: ImageContentItem.Image;
+        type?: 'image';
+    }
+    namespace ImageContentItem {
+        /**
+         * A URL or a base64 encoded string
+         */
+        interface Image {
+            data?: string | null;
+            /**
+             * A URL reference to external content.
+             */
+            url?: Image.URL | null;
+        }
+        namespace Image {
+            /**
+             * A URL reference to external content.
+             */
+            interface URL {
+                uri: string;
+            }
+        }
+    }
+    /**
+     * A text content item
+     */
+    interface TextContentItem {
+        text: string;
+        type?: 'text';
+    }
+}
+/**
+ * Version information for the service.
+ */
+export interface VersionInfo {
+    /**
+     * The version string of the service
+     */
+    version: string;
+}
+//# sourceMappingURL=shared.d.ts.map

package/resources/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,MAAM,EAAE,IAAI,GAAG,OAAO,GAAG,iBAAiB,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN,kBAAkB,CAAC,gBAAgB,GACnC,kBAAkB,CAAC,eAAe,GAClC,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;AAEpF,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,gBAAgB,GACvC,sBAAsB,CAAC,eAAe,CAAC;AAE3C,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC,oBAAoB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC,iBAAiB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,WAAW,GACrB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,UAAU,GACpB,SAAS,CAAC,QAAQ,GAClB,SAAS,CAAC,SAAS,GACnB,SAAS,CAAC,uBAAuB,GACjC,SAAS,CAAC,mBAAmB,CAAC;AAElC,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC,IAAI,CAAC,EAAE,uBAAuB,CAAC;KAChC;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,IAAI,CAAC,EAAE,kBAAkB,CAAC;KAC3B;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EACL,cAAc,CAAC,sBAAsB,GACrC,cAAc,CAAC,oBAAoB,GACnC,cAAc,CAAC,oBAAoB,CAAC;CACzC;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;OAGG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED;;;OAGG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EACH,MAAM,GACN,aAAa,CAAC,gBAAgB,GAC9B,aAAa,CAAC,eAAe,GAC7B,KAAK,CAAC,aAAa,CAAC,gBAAgB,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;IAE1E;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAE9B,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC;;WAEG;QACH,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;SACxB;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,GAAG;gBAClB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;KACF;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/resources/shared.js

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/resources/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":";AAAA,sCAAsC;AACtC,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF"}

package/resources/shared.mjs

@@ -0,0 +1,9 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export {};
+//# sourceMappingURL=shared.mjs.map

package/resources/shared.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.mjs","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF"}

package/resources/shields.d.ts

@@ -0,0 +1,82 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+export declare class Shields extends APIResource {
+    /**
+     * Get a shield by its identifier.
+     */
+    retrieve(identifier: string, options?: Core.RequestOptions): Core.APIPromise<Shield>;
+    /**
+     * List all shields.
+     */
+    list(options?: Core.RequestOptions): Core.APIPromise<ShieldListResponse>;
+    /**
+     * Unregister a shield.
+     *
+     * @deprecated
+     */
+    delete(identifier: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Register a shield.
+     *
+     * @deprecated
+     */
+    register(body: ShieldRegisterParams, options?: Core.RequestOptions): Core.APIPromise<Shield>;
+}
+/**
+ * Response containing a list of all shields.
+ */
+export interface ListShieldsResponse {
+    /**
+     * List of shield objects
+     */
+    data: ShieldListResponse;
+}
+/**
+ * A safety shield resource that can be used to check content.
+ */
+export interface Shield {
+    /**
+     * Unique identifier for this resource in ogx
+     */
+    identifier: string;
+    /**
+     * ID of the provider that owns this resource
+     */
+    provider_id: string;
+    params?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Unique identifier for this resource in the provider
+     */
+    provider_resource_id?: string | null;
+    type?: 'shield';
+}
+/**
+ * List of shield objects
+ */
+export type ShieldListResponse = Array<Shield>;
+export interface ShieldRegisterParams {
+    /**
+     * The identifier of the shield to register.
+     */
+    shield_id: string;
+    /**
+     * The parameters of the shield.
+     */
+    params?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The identifier of the provider.
+     */
+    provider_id?: string | null;
+    /**
+     * The identifier of the shield in the provider.
+     */
+    provider_shield_id?: string | null;
+}
+export declare namespace Shields {
+    export { type ListShieldsResponse as ListShieldsResponse, type Shield as Shield, type ShieldListResponse as ShieldListResponse, type ShieldRegisterParams as ShieldRegisterParams, };
+}
+//# sourceMappingURL=shields.d.ts.map

package/resources/shields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shields.d.ts","sourceRoot":"","sources":["../src/resources/shields.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIpF;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAMxE;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOhF;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAE/C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/shields.js

@@ -0,0 +1,46 @@
+"use strict";
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Shields = void 0;
+const resource_1 = require("../resource.js");
+class Shields extends resource_1.APIResource {
+    /**
+     * Get a shield by its identifier.
+     */
+    retrieve(identifier, options) {
+        return this._client.get(`/v1/shields/${identifier}`, options);
+    }
+    /**
+     * List all shields.
+     */
+    list(options) {
+        return this._client.get('/v1/shields', options)._thenUnwrap((obj) => obj.data);
+    }
+    /**
+     * Unregister a shield.
+     *
+     * @deprecated
+     */
+    delete(identifier, options) {
+        return this._client.delete(`/v1/shields/${identifier}`, {
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+    /**
+     * Register a shield.
+     *
+     * @deprecated
+     */
+    register(body, options) {
+        return this._client.post('/v1/shields', { body, ...options });
+    }
+}
+exports.Shields = Shields;
+//# sourceMappingURL=shields.js.map

package/resources/shields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shields.js","sourceRoot":"","sources":["../src/resources/shields.ts"],"names":[],"mappings":";AAAA,sCAAsC;AACtC,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CACxC,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,UAAU,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAA0B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AArCD,0BAqCC"}

package/resources/shields.mjs

@@ -0,0 +1,42 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+export class Shields extends APIResource {
+    /**
+     * Get a shield by its identifier.
+     */
+    retrieve(identifier, options) {
+        return this._client.get(`/v1/shields/${identifier}`, options);
+    }
+    /**
+     * List all shields.
+     */
+    list(options) {
+        return this._client.get('/v1/shields', options)._thenUnwrap((obj) => obj.data);
+    }
+    /**
+     * Unregister a shield.
+     *
+     * @deprecated
+     */
+    delete(identifier, options) {
+        return this._client.delete(`/v1/shields/${identifier}`, {
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+    /**
+     * Register a shield.
+     *
+     * @deprecated
+     */
+    register(body, options) {
+        return this._client.post('/v1/shields', { body, ...options });
+    }
+}
+//# sourceMappingURL=shields.mjs.map

package/resources/shields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"shields.mjs","sourceRoot":"","sources":["../src/resources/shields.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CACxC,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,UAAU,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAA0B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}