@ourskyai/sda-api 1.3.1734

package/dist/base.d.ts

@@ -0,0 +1,54 @@
+/**
+ * OurSky SDA
+ * Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section.  Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow.  After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it.  To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`.  The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
+ *
+ * The version of the OpenAPI document: 1.3.1734
+ *
+ *
+ * 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 { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}

package/dist/base.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OurSky SDA
+ * Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section.  Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow.  After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it.  To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`.  The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
+ *
+ * The version of the OpenAPI document: 1.3.1734
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
+const axios_1 = require("axios");
+exports.BASE_PATH = "https://api.dev.oursky.ai".replace(/\/+$/, "");
+/**
+ *
+ * @export
+ */
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+class BaseAPI {
+    constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
+        this.basePath = basePath;
+        this.axios = axios;
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        }
+    }
+}
+exports.BaseAPI = BaseAPI;
+;
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+exports.RequiredError = RequiredError;

package/dist/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * OurSky SDA
+ * Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section.  Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow.  After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it.  To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`.  The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
+ *
+ * The version of the OpenAPI document: 1.3.1734
+ *
+ *
+ * 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 { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/common.js

@@ -0,0 +1,160 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OurSky SDA
+ * Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section.  Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow.  After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it.  To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`.  The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
+ *
+ * The version of the OpenAPI document: 1.3.1734
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
+const base_1 = require("./base");
+/**
+ *
+ * @export
+ */
+exports.DUMMY_BASE_URL = 'https://example.com';
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+const assertParamExists = function (functionName, paramName, paramValue) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new base_1.RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+};
+exports.assertParamExists = assertParamExists;
+/**
+ *
+ * @export
+ */
+const setApiKeyToObject = function (object, keyParamName, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.apiKey) {
+            const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                ? yield configuration.apiKey(keyParamName)
+                : yield configuration.apiKey;
+            object[keyParamName] = localVarApiKeyValue;
+        }
+    });
+};
+exports.setApiKeyToObject = setApiKeyToObject;
+/**
+ *
+ * @export
+ */
+const setBasicAuthToObject = function (object, configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+};
+exports.setBasicAuthToObject = setBasicAuthToObject;
+/**
+ *
+ * @export
+ */
+const setBearerAuthToObject = function (object, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const accessToken = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken()
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + accessToken;
+        }
+    });
+};
+exports.setBearerAuthToObject = setBearerAuthToObject;
+/**
+ *
+ * @export
+ */
+const setOAuthToObject = function (object, name, scopes, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken(name, scopes)
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        }
+    });
+};
+exports.setOAuthToObject = setOAuthToObject;
+function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+/**
+ *
+ * @export
+ */
+const setSearchParams = function (url, ...objects) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+};
+exports.setSearchParams = setSearchParams;
+/**
+ *
+ * @export
+ */
+const serializeDataIfNeeded = function (value, requestOptions, configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+};
+exports.serializeDataIfNeeded = serializeDataIfNeeded;
+/**
+ *
+ * @export
+ */
+const toPathString = function (url) {
+    return url.pathname + url.search + url.hash;
+};
+exports.toPathString = toPathString;
+/**
+ *
+ * @export
+ */
+const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
+    return (axios = globalAxios, basePath = BASE_PATH) => {
+        const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: ((configuration === null || configuration === void 0 ? void 0 : configuration.basePath) || axios.defaults.baseURL || basePath) + axiosArgs.url });
+        return axios.request(axiosRequestArgs);
+    };
+};
+exports.createRequestFunction = createRequestFunction;

package/dist/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * OurSky SDA
+ * Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section.  Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow.  After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it.  To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`.  The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
+ *
+ * The version of the OpenAPI document: 1.3.1734
+ *
+ *
+ * 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 ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/configuration.js

@@ -0,0 +1,42 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OurSky SDA
+ * Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section.  Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow.  After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it.  To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`.  The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
+ *
+ * The version of the OpenAPI document: 1.3.1734
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+class Configuration {
+    constructor(param = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}
+exports.Configuration = Configuration;