@ourskyai/sda-api 1.3.1734
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +13 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +45 -0
- package/api.ts +2277 -0
- package/base.ts +72 -0
- package/common.ts +150 -0
- package/configuration.ts +101 -0
- package/dist/api.d.ts +1496 -0
- package/dist/api.js +1215 -0
- package/dist/base.d.ts +54 -0
- package/dist/base.js +59 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +160 -0
- package/dist/configuration.d.ts +83 -0
- package/dist/configuration.js +42 -0
- package/dist/esm/api.d.ts +1496 -0
- package/dist/esm/api.js +1208 -0
- package/dist/esm/base.d.ts +54 -0
- package/dist/esm/base.js +54 -0
- package/dist/esm/common.d.ts +65 -0
- package/dist/esm/common.js +148 -0
- package/dist/esm/configuration.d.ts +83 -0
- package/dist/esm/configuration.js +38 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
package/dist/api.js
ADDED
|
@@ -0,0 +1,1215 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* OurSky SDA
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.3.1734
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.TrackingType = exports.OrbitType = exports.FilterType = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// Some imports not used depending on template conditions
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const common_1 = require("./common");
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
const base_1 = require("./base");
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @export
|
|
35
|
+
* @enum {string}
|
|
36
|
+
*/
|
|
37
|
+
exports.FilterType = {
|
|
38
|
+
NONE: 'NONE',
|
|
39
|
+
RED: 'RED',
|
|
40
|
+
BLUE: 'BLUE',
|
|
41
|
+
GREEN: 'GREEN',
|
|
42
|
+
UV: 'UV',
|
|
43
|
+
IR: 'IR',
|
|
44
|
+
LUMINANCE: 'LUMINANCE',
|
|
45
|
+
ENHANCED_LUMINANCE: 'ENHANCED_LUMINANCE',
|
|
46
|
+
H_ALPHA: 'H_ALPHA',
|
|
47
|
+
H_BETA: 'H_BETA',
|
|
48
|
+
S_II: 'S_II',
|
|
49
|
+
O_III: 'O_III',
|
|
50
|
+
DUAL_BAND: 'DUAL_BAND',
|
|
51
|
+
PHOTO_JOHNSON_U: 'PHOTO_JOHNSON_U',
|
|
52
|
+
PHOTO_JOHNSON_B: 'PHOTO_JOHNSON_B',
|
|
53
|
+
PHOTO_JOHNSON_V: 'PHOTO_JOHNSON_V',
|
|
54
|
+
PHOTO_COUSINS_R: 'PHOTO_COUSINS_R',
|
|
55
|
+
PHOTO_COUSINS_I: 'PHOTO_COUSINS_I'
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* orbit type
|
|
59
|
+
* @export
|
|
60
|
+
* @enum {string}
|
|
61
|
+
*/
|
|
62
|
+
exports.OrbitType = {
|
|
63
|
+
GEOSTATIONARY: 'GEOSTATIONARY',
|
|
64
|
+
GEOSYNCHRONOUS: 'GEOSYNCHRONOUS',
|
|
65
|
+
MEO: 'MEO',
|
|
66
|
+
LEO: 'LEO',
|
|
67
|
+
GTO: 'GTO',
|
|
68
|
+
SSO: 'SSO',
|
|
69
|
+
TUNDRA: 'TUNDRA',
|
|
70
|
+
MOLNIYA: 'MOLNIYA'
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* target tracking type
|
|
74
|
+
* @export
|
|
75
|
+
* @enum {string}
|
|
76
|
+
*/
|
|
77
|
+
exports.TrackingType = {
|
|
78
|
+
SIDEREAL: 'SIDEREAL',
|
|
79
|
+
TARGET_RATE: 'TARGET_RATE'
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* webhook event types
|
|
83
|
+
* @export
|
|
84
|
+
* @enum {string}
|
|
85
|
+
*/
|
|
86
|
+
exports.WebhookEvent = {
|
|
87
|
+
TDM_CREATED: 'V1_TDM_CREATED',
|
|
88
|
+
OBSERVATION_SEQUENCE_RESULT_CREATED: 'V1_OBSERVATION_SEQUENCE_RESULT_CREATED',
|
|
89
|
+
OBSERVATION_CREATED: 'V1_OBSERVATION_CREATED',
|
|
90
|
+
IMAGE_CREATED: 'V1_IMAGE_CREATED'
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
* DefaultApi - axios parameter creator
|
|
94
|
+
* @export
|
|
95
|
+
*/
|
|
96
|
+
const DefaultApiAxiosParamCreator = function (configuration) {
|
|
97
|
+
return {
|
|
98
|
+
/**
|
|
99
|
+
* create an image set
|
|
100
|
+
* @param {V1CreateImageSet} v1CreateImageSet request to create the Image Set
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
v1CreateImageSet: (v1CreateImageSet, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
105
|
+
// verify required parameter 'v1CreateImageSet' is not null or undefined
|
|
106
|
+
(0, common_1.assertParamExists)('v1CreateImageSet', 'v1CreateImageSet', v1CreateImageSet);
|
|
107
|
+
const localVarPath = `/v1/image-set`;
|
|
108
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
109
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
110
|
+
let baseOptions;
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
}
|
|
114
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
115
|
+
const localVarHeaderParameter = {};
|
|
116
|
+
const localVarQueryParameter = {};
|
|
117
|
+
// authentication Roles required
|
|
118
|
+
// authentication BearerToken required
|
|
119
|
+
// http bearer authentication required
|
|
120
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
121
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
122
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
123
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
124
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
125
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateImageSet, localVarRequestOptions, configuration);
|
|
126
|
+
return {
|
|
127
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
128
|
+
options: localVarRequestOptions,
|
|
129
|
+
};
|
|
130
|
+
}),
|
|
131
|
+
/**
|
|
132
|
+
* create an image set image
|
|
133
|
+
* @param {V1CreateImageSetImage} v1CreateImageSetImage request to create an image set image
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
v1CreateImageSetImage: (v1CreateImageSetImage, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
// verify required parameter 'v1CreateImageSetImage' is not null or undefined
|
|
139
|
+
(0, common_1.assertParamExists)('v1CreateImageSetImage', 'v1CreateImageSetImage', v1CreateImageSetImage);
|
|
140
|
+
const localVarPath = `/v1/image-set-image`;
|
|
141
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
142
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
143
|
+
let baseOptions;
|
|
144
|
+
if (configuration) {
|
|
145
|
+
baseOptions = configuration.baseOptions;
|
|
146
|
+
}
|
|
147
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
148
|
+
const localVarHeaderParameter = {};
|
|
149
|
+
const localVarQueryParameter = {};
|
|
150
|
+
// authentication Roles required
|
|
151
|
+
// authentication BearerToken required
|
|
152
|
+
// http bearer authentication required
|
|
153
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
154
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
155
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
156
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
157
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
158
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateImageSetImage, localVarRequestOptions, configuration);
|
|
159
|
+
return {
|
|
160
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
161
|
+
options: localVarRequestOptions,
|
|
162
|
+
};
|
|
163
|
+
}),
|
|
164
|
+
/**
|
|
165
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
166
|
+
* @param {V1OrganizationTarget} v1OrganizationTarget create organization target
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
v1CreateOrganizationTarget: (v1OrganizationTarget, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
171
|
+
// verify required parameter 'v1OrganizationTarget' is not null or undefined
|
|
172
|
+
(0, common_1.assertParamExists)('v1CreateOrganizationTarget', 'v1OrganizationTarget', v1OrganizationTarget);
|
|
173
|
+
const localVarPath = `/v1/organization-target`;
|
|
174
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
175
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
176
|
+
let baseOptions;
|
|
177
|
+
if (configuration) {
|
|
178
|
+
baseOptions = configuration.baseOptions;
|
|
179
|
+
}
|
|
180
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
181
|
+
const localVarHeaderParameter = {};
|
|
182
|
+
const localVarQueryParameter = {};
|
|
183
|
+
// authentication Roles required
|
|
184
|
+
// authentication BearerToken required
|
|
185
|
+
// http bearer authentication required
|
|
186
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
187
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
188
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
189
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
190
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
191
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1OrganizationTarget, localVarRequestOptions, configuration);
|
|
192
|
+
return {
|
|
193
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
194
|
+
options: localVarRequestOptions,
|
|
195
|
+
};
|
|
196
|
+
}),
|
|
197
|
+
/**
|
|
198
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
199
|
+
* @param {V1UpdateWebhookConfiguration} v1UpdateWebhookConfiguration request to create an organization webhook
|
|
200
|
+
* @param {*} [options] Override http request option.
|
|
201
|
+
* @throws {RequiredError}
|
|
202
|
+
*/
|
|
203
|
+
v1CreateWebhookConfiguration: (v1UpdateWebhookConfiguration, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
204
|
+
// verify required parameter 'v1UpdateWebhookConfiguration' is not null or undefined
|
|
205
|
+
(0, common_1.assertParamExists)('v1CreateWebhookConfiguration', 'v1UpdateWebhookConfiguration', v1UpdateWebhookConfiguration);
|
|
206
|
+
const localVarPath = `/v1/communications/webhook`;
|
|
207
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
208
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
209
|
+
let baseOptions;
|
|
210
|
+
if (configuration) {
|
|
211
|
+
baseOptions = configuration.baseOptions;
|
|
212
|
+
}
|
|
213
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
214
|
+
const localVarHeaderParameter = {};
|
|
215
|
+
const localVarQueryParameter = {};
|
|
216
|
+
// authentication Roles required
|
|
217
|
+
// authentication BearerToken required
|
|
218
|
+
// http bearer authentication required
|
|
219
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
220
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
221
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
222
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
223
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
224
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1UpdateWebhookConfiguration, localVarRequestOptions, configuration);
|
|
225
|
+
return {
|
|
226
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
227
|
+
options: localVarRequestOptions,
|
|
228
|
+
};
|
|
229
|
+
}),
|
|
230
|
+
/**
|
|
231
|
+
* delete an organization target
|
|
232
|
+
* @param {string} satelliteTargetId
|
|
233
|
+
* @param {*} [options] Override http request option.
|
|
234
|
+
* @throws {RequiredError}
|
|
235
|
+
*/
|
|
236
|
+
v1DeleteOrganizationTarget: (satelliteTargetId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
237
|
+
// verify required parameter 'satelliteTargetId' is not null or undefined
|
|
238
|
+
(0, common_1.assertParamExists)('v1DeleteOrganizationTarget', 'satelliteTargetId', satelliteTargetId);
|
|
239
|
+
const localVarPath = `/v1/organization-target`;
|
|
240
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
241
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
242
|
+
let baseOptions;
|
|
243
|
+
if (configuration) {
|
|
244
|
+
baseOptions = configuration.baseOptions;
|
|
245
|
+
}
|
|
246
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
247
|
+
const localVarHeaderParameter = {};
|
|
248
|
+
const localVarQueryParameter = {};
|
|
249
|
+
// authentication Roles required
|
|
250
|
+
// authentication BearerToken required
|
|
251
|
+
// http bearer authentication required
|
|
252
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
253
|
+
if (satelliteTargetId !== undefined) {
|
|
254
|
+
localVarQueryParameter['satelliteTargetId'] = satelliteTargetId;
|
|
255
|
+
}
|
|
256
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
257
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
258
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
259
|
+
return {
|
|
260
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
261
|
+
options: localVarRequestOptions,
|
|
262
|
+
};
|
|
263
|
+
}),
|
|
264
|
+
/**
|
|
265
|
+
* Delete an existing webhook configuration
|
|
266
|
+
* @param {string} id webhook id
|
|
267
|
+
* @param {*} [options] Override http request option.
|
|
268
|
+
* @throws {RequiredError}
|
|
269
|
+
*/
|
|
270
|
+
v1DeleteWebhookConfiguration: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
271
|
+
// verify required parameter 'id' is not null or undefined
|
|
272
|
+
(0, common_1.assertParamExists)('v1DeleteWebhookConfiguration', 'id', id);
|
|
273
|
+
const localVarPath = `/v1/communications/webhook`;
|
|
274
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
275
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
276
|
+
let baseOptions;
|
|
277
|
+
if (configuration) {
|
|
278
|
+
baseOptions = configuration.baseOptions;
|
|
279
|
+
}
|
|
280
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
281
|
+
const localVarHeaderParameter = {};
|
|
282
|
+
const localVarQueryParameter = {};
|
|
283
|
+
// authentication Roles required
|
|
284
|
+
// authentication BearerToken required
|
|
285
|
+
// http bearer authentication required
|
|
286
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
287
|
+
if (id !== undefined) {
|
|
288
|
+
localVarQueryParameter['id'] = id;
|
|
289
|
+
}
|
|
290
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
291
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
292
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
293
|
+
return {
|
|
294
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
295
|
+
options: localVarRequestOptions,
|
|
296
|
+
};
|
|
297
|
+
}),
|
|
298
|
+
/**
|
|
299
|
+
* get an image set
|
|
300
|
+
* @param {string} id
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
v1GetImageSet: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
305
|
+
// verify required parameter 'id' is not null or undefined
|
|
306
|
+
(0, common_1.assertParamExists)('v1GetImageSet', 'id', id);
|
|
307
|
+
const localVarPath = `/v1/image-set`;
|
|
308
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
309
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
310
|
+
let baseOptions;
|
|
311
|
+
if (configuration) {
|
|
312
|
+
baseOptions = configuration.baseOptions;
|
|
313
|
+
}
|
|
314
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
315
|
+
const localVarHeaderParameter = {};
|
|
316
|
+
const localVarQueryParameter = {};
|
|
317
|
+
// authentication Roles required
|
|
318
|
+
// authentication BearerToken required
|
|
319
|
+
// http bearer authentication required
|
|
320
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
321
|
+
if (id !== undefined) {
|
|
322
|
+
localVarQueryParameter['id'] = id;
|
|
323
|
+
}
|
|
324
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
325
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
326
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
327
|
+
return {
|
|
328
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
329
|
+
options: localVarRequestOptions,
|
|
330
|
+
};
|
|
331
|
+
}),
|
|
332
|
+
/**
|
|
333
|
+
* get an image
|
|
334
|
+
* @param {string} imageId
|
|
335
|
+
* @param {*} [options] Override http request option.
|
|
336
|
+
* @throws {RequiredError}
|
|
337
|
+
*/
|
|
338
|
+
v1GetImageSetImage: (imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
339
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
340
|
+
(0, common_1.assertParamExists)('v1GetImageSetImage', 'imageId', imageId);
|
|
341
|
+
const localVarPath = `/v1/image-set-image`;
|
|
342
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
343
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
344
|
+
let baseOptions;
|
|
345
|
+
if (configuration) {
|
|
346
|
+
baseOptions = configuration.baseOptions;
|
|
347
|
+
}
|
|
348
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
349
|
+
const localVarHeaderParameter = {};
|
|
350
|
+
const localVarQueryParameter = {};
|
|
351
|
+
// authentication Roles required
|
|
352
|
+
// authentication BearerToken required
|
|
353
|
+
// http bearer authentication required
|
|
354
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
355
|
+
if (imageId !== undefined) {
|
|
356
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
357
|
+
}
|
|
358
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
359
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
360
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
361
|
+
return {
|
|
362
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
363
|
+
options: localVarRequestOptions,
|
|
364
|
+
};
|
|
365
|
+
}),
|
|
366
|
+
/**
|
|
367
|
+
* get image set images
|
|
368
|
+
* @param {Array<string>} imageSets
|
|
369
|
+
* @param {*} [options] Override http request option.
|
|
370
|
+
* @throws {RequiredError}
|
|
371
|
+
*/
|
|
372
|
+
v1GetImageSetImages: (imageSets, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
373
|
+
// verify required parameter 'imageSets' is not null or undefined
|
|
374
|
+
(0, common_1.assertParamExists)('v1GetImageSetImages', 'imageSets', imageSets);
|
|
375
|
+
const localVarPath = `/v1/image-set-images`;
|
|
376
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
377
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
378
|
+
let baseOptions;
|
|
379
|
+
if (configuration) {
|
|
380
|
+
baseOptions = configuration.baseOptions;
|
|
381
|
+
}
|
|
382
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
383
|
+
const localVarHeaderParameter = {};
|
|
384
|
+
const localVarQueryParameter = {};
|
|
385
|
+
// authentication Roles required
|
|
386
|
+
// authentication BearerToken required
|
|
387
|
+
// http bearer authentication required
|
|
388
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
389
|
+
if (imageSets) {
|
|
390
|
+
localVarQueryParameter['imageSets'] = imageSets.join(base_1.COLLECTION_FORMATS.csv);
|
|
391
|
+
}
|
|
392
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
393
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
394
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
395
|
+
return {
|
|
396
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
397
|
+
options: localVarRequestOptions,
|
|
398
|
+
};
|
|
399
|
+
}),
|
|
400
|
+
/**
|
|
401
|
+
* get image sets for targets observed for your organization
|
|
402
|
+
* @param {*} [options] Override http request option.
|
|
403
|
+
* @throws {RequiredError}
|
|
404
|
+
*/
|
|
405
|
+
v1GetImageSets: (options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
406
|
+
const localVarPath = `/v1/image-sets`;
|
|
407
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
408
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
409
|
+
let baseOptions;
|
|
410
|
+
if (configuration) {
|
|
411
|
+
baseOptions = configuration.baseOptions;
|
|
412
|
+
}
|
|
413
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
414
|
+
const localVarHeaderParameter = {};
|
|
415
|
+
const localVarQueryParameter = {};
|
|
416
|
+
// authentication Roles required
|
|
417
|
+
// authentication BearerToken required
|
|
418
|
+
// http bearer authentication required
|
|
419
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
420
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
421
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
422
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
423
|
+
return {
|
|
424
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
425
|
+
options: localVarRequestOptions,
|
|
426
|
+
};
|
|
427
|
+
}),
|
|
428
|
+
/**
|
|
429
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
430
|
+
* @param {string} [targetId]
|
|
431
|
+
* @param {string} [after]
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
v1GetObservationSequenceResults: (targetId, after, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
436
|
+
const localVarPath = `/v1/observation-sequence-results`;
|
|
437
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
438
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
439
|
+
let baseOptions;
|
|
440
|
+
if (configuration) {
|
|
441
|
+
baseOptions = configuration.baseOptions;
|
|
442
|
+
}
|
|
443
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
444
|
+
const localVarHeaderParameter = {};
|
|
445
|
+
const localVarQueryParameter = {};
|
|
446
|
+
// authentication Roles required
|
|
447
|
+
// authentication BearerToken required
|
|
448
|
+
// http bearer authentication required
|
|
449
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
450
|
+
if (targetId !== undefined) {
|
|
451
|
+
localVarQueryParameter['targetId'] = targetId;
|
|
452
|
+
}
|
|
453
|
+
if (after !== undefined) {
|
|
454
|
+
localVarQueryParameter['after'] = (after instanceof Date) ?
|
|
455
|
+
after.toISOString() :
|
|
456
|
+
after;
|
|
457
|
+
}
|
|
458
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
460
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
461
|
+
return {
|
|
462
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
463
|
+
options: localVarRequestOptions,
|
|
464
|
+
};
|
|
465
|
+
}),
|
|
466
|
+
/**
|
|
467
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
468
|
+
* @param {*} [options] Override http request option.
|
|
469
|
+
* @throws {RequiredError}
|
|
470
|
+
*/
|
|
471
|
+
v1GetOrganizationTargets: (options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
472
|
+
const localVarPath = `/v1/organization-targets`;
|
|
473
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
474
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
475
|
+
let baseOptions;
|
|
476
|
+
if (configuration) {
|
|
477
|
+
baseOptions = configuration.baseOptions;
|
|
478
|
+
}
|
|
479
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
480
|
+
const localVarHeaderParameter = {};
|
|
481
|
+
const localVarQueryParameter = {};
|
|
482
|
+
// authentication Roles required
|
|
483
|
+
// authentication BearerToken required
|
|
484
|
+
// http bearer authentication required
|
|
485
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
486
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
487
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
488
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
489
|
+
return {
|
|
490
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
491
|
+
options: localVarRequestOptions,
|
|
492
|
+
};
|
|
493
|
+
}),
|
|
494
|
+
/**
|
|
495
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
496
|
+
* @param {OrbitType} [orbitType] orbit type
|
|
497
|
+
* @param {string} [noradId] norad id
|
|
498
|
+
* @param {*} [options] Override http request option.
|
|
499
|
+
* @throws {RequiredError}
|
|
500
|
+
*/
|
|
501
|
+
v1GetSatelliteTargets: (orbitType, noradId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
502
|
+
const localVarPath = `/v1/satellite-targets`;
|
|
503
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
504
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
505
|
+
let baseOptions;
|
|
506
|
+
if (configuration) {
|
|
507
|
+
baseOptions = configuration.baseOptions;
|
|
508
|
+
}
|
|
509
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
510
|
+
const localVarHeaderParameter = {};
|
|
511
|
+
const localVarQueryParameter = {};
|
|
512
|
+
// authentication Roles required
|
|
513
|
+
// authentication BearerToken required
|
|
514
|
+
// http bearer authentication required
|
|
515
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
516
|
+
if (orbitType !== undefined) {
|
|
517
|
+
localVarQueryParameter['orbitType'] = orbitType;
|
|
518
|
+
}
|
|
519
|
+
if (noradId !== undefined) {
|
|
520
|
+
localVarQueryParameter['noradId'] = noradId;
|
|
521
|
+
}
|
|
522
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
523
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
524
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
525
|
+
return {
|
|
526
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
527
|
+
options: localVarRequestOptions,
|
|
528
|
+
};
|
|
529
|
+
}),
|
|
530
|
+
/**
|
|
531
|
+
* get tdm
|
|
532
|
+
* @param {string} tdmId
|
|
533
|
+
* @param {*} [options] Override http request option.
|
|
534
|
+
* @throws {RequiredError}
|
|
535
|
+
*/
|
|
536
|
+
v1GetTdm: (tdmId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
537
|
+
// verify required parameter 'tdmId' is not null or undefined
|
|
538
|
+
(0, common_1.assertParamExists)('v1GetTdm', 'tdmId', tdmId);
|
|
539
|
+
const localVarPath = `/v1/tdm`;
|
|
540
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
541
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
542
|
+
let baseOptions;
|
|
543
|
+
if (configuration) {
|
|
544
|
+
baseOptions = configuration.baseOptions;
|
|
545
|
+
}
|
|
546
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
547
|
+
const localVarHeaderParameter = {};
|
|
548
|
+
const localVarQueryParameter = {};
|
|
549
|
+
// authentication Roles required
|
|
550
|
+
// authentication BearerToken required
|
|
551
|
+
// http bearer authentication required
|
|
552
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
553
|
+
if (tdmId !== undefined) {
|
|
554
|
+
localVarQueryParameter['tdmId'] = tdmId;
|
|
555
|
+
}
|
|
556
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
557
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
558
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
559
|
+
return {
|
|
560
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
561
|
+
options: localVarRequestOptions,
|
|
562
|
+
};
|
|
563
|
+
}),
|
|
564
|
+
/**
|
|
565
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
566
|
+
* @param {string} [targetId]
|
|
567
|
+
* @param {string} [after]
|
|
568
|
+
* @param {*} [options] Override http request option.
|
|
569
|
+
* @throws {RequiredError}
|
|
570
|
+
*/
|
|
571
|
+
v1GetTdms: (targetId, after, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
572
|
+
const localVarPath = `/v1/tdms`;
|
|
573
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
574
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
575
|
+
let baseOptions;
|
|
576
|
+
if (configuration) {
|
|
577
|
+
baseOptions = configuration.baseOptions;
|
|
578
|
+
}
|
|
579
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
580
|
+
const localVarHeaderParameter = {};
|
|
581
|
+
const localVarQueryParameter = {};
|
|
582
|
+
// authentication Roles required
|
|
583
|
+
// authentication BearerToken required
|
|
584
|
+
// http bearer authentication required
|
|
585
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
586
|
+
if (targetId !== undefined) {
|
|
587
|
+
localVarQueryParameter['targetId'] = targetId;
|
|
588
|
+
}
|
|
589
|
+
if (after !== undefined) {
|
|
590
|
+
localVarQueryParameter['after'] = (after instanceof Date) ?
|
|
591
|
+
after.toISOString() :
|
|
592
|
+
after;
|
|
593
|
+
}
|
|
594
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
595
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
596
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
597
|
+
return {
|
|
598
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
599
|
+
options: localVarRequestOptions,
|
|
600
|
+
};
|
|
601
|
+
}),
|
|
602
|
+
/**
|
|
603
|
+
* Get the currently configured webhooks
|
|
604
|
+
* @param {*} [options] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
*/
|
|
607
|
+
v1GetWebhookConfigurations: (options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
608
|
+
const localVarPath = `/v1/communications/webhooks`;
|
|
609
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
610
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
611
|
+
let baseOptions;
|
|
612
|
+
if (configuration) {
|
|
613
|
+
baseOptions = configuration.baseOptions;
|
|
614
|
+
}
|
|
615
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
616
|
+
const localVarHeaderParameter = {};
|
|
617
|
+
const localVarQueryParameter = {};
|
|
618
|
+
// authentication Roles required
|
|
619
|
+
// authentication BearerToken required
|
|
620
|
+
// http bearer authentication required
|
|
621
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
622
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
623
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
624
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
625
|
+
return {
|
|
626
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
627
|
+
options: localVarRequestOptions,
|
|
628
|
+
};
|
|
629
|
+
}),
|
|
630
|
+
/**
|
|
631
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
632
|
+
* @param {V1UpdateEmailConfiguration} v1UpdateEmailConfiguration request to update an organization email preference
|
|
633
|
+
* @param {*} [options] Override http request option.
|
|
634
|
+
* @throws {RequiredError}
|
|
635
|
+
*/
|
|
636
|
+
v1UpdateEmailConfiguration: (v1UpdateEmailConfiguration, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
637
|
+
// verify required parameter 'v1UpdateEmailConfiguration' is not null or undefined
|
|
638
|
+
(0, common_1.assertParamExists)('v1UpdateEmailConfiguration', 'v1UpdateEmailConfiguration', v1UpdateEmailConfiguration);
|
|
639
|
+
const localVarPath = `/v1/communications/email`;
|
|
640
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
641
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
642
|
+
let baseOptions;
|
|
643
|
+
if (configuration) {
|
|
644
|
+
baseOptions = configuration.baseOptions;
|
|
645
|
+
}
|
|
646
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
647
|
+
const localVarHeaderParameter = {};
|
|
648
|
+
const localVarQueryParameter = {};
|
|
649
|
+
// authentication Roles required
|
|
650
|
+
// authentication BearerToken required
|
|
651
|
+
// http bearer authentication required
|
|
652
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
653
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
654
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
655
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
656
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
657
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1UpdateEmailConfiguration, localVarRequestOptions, configuration);
|
|
658
|
+
return {
|
|
659
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
660
|
+
options: localVarRequestOptions,
|
|
661
|
+
};
|
|
662
|
+
}),
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
|
|
666
|
+
/**
|
|
667
|
+
* DefaultApi - functional programming interface
|
|
668
|
+
* @export
|
|
669
|
+
*/
|
|
670
|
+
const DefaultApiFp = function (configuration) {
|
|
671
|
+
const localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
|
|
672
|
+
return {
|
|
673
|
+
/**
|
|
674
|
+
* create an image set
|
|
675
|
+
* @param {V1CreateImageSet} v1CreateImageSet request to create the Image Set
|
|
676
|
+
* @param {*} [options] Override http request option.
|
|
677
|
+
* @throws {RequiredError}
|
|
678
|
+
*/
|
|
679
|
+
v1CreateImageSet(v1CreateImageSet, options) {
|
|
680
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
681
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateImageSet(v1CreateImageSet, options);
|
|
682
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
683
|
+
});
|
|
684
|
+
},
|
|
685
|
+
/**
|
|
686
|
+
* create an image set image
|
|
687
|
+
* @param {V1CreateImageSetImage} v1CreateImageSetImage request to create an image set image
|
|
688
|
+
* @param {*} [options] Override http request option.
|
|
689
|
+
* @throws {RequiredError}
|
|
690
|
+
*/
|
|
691
|
+
v1CreateImageSetImage(v1CreateImageSetImage, options) {
|
|
692
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
693
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateImageSetImage(v1CreateImageSetImage, options);
|
|
694
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
695
|
+
});
|
|
696
|
+
},
|
|
697
|
+
/**
|
|
698
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
699
|
+
* @param {V1OrganizationTarget} v1OrganizationTarget create organization target
|
|
700
|
+
* @param {*} [options] Override http request option.
|
|
701
|
+
* @throws {RequiredError}
|
|
702
|
+
*/
|
|
703
|
+
v1CreateOrganizationTarget(v1OrganizationTarget, options) {
|
|
704
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
705
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateOrganizationTarget(v1OrganizationTarget, options);
|
|
706
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
707
|
+
});
|
|
708
|
+
},
|
|
709
|
+
/**
|
|
710
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
711
|
+
* @param {V1UpdateWebhookConfiguration} v1UpdateWebhookConfiguration request to create an organization webhook
|
|
712
|
+
* @param {*} [options] Override http request option.
|
|
713
|
+
* @throws {RequiredError}
|
|
714
|
+
*/
|
|
715
|
+
v1CreateWebhookConfiguration(v1UpdateWebhookConfiguration, options) {
|
|
716
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
717
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1UpdateWebhookConfiguration, options);
|
|
718
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
719
|
+
});
|
|
720
|
+
},
|
|
721
|
+
/**
|
|
722
|
+
* delete an organization target
|
|
723
|
+
* @param {string} satelliteTargetId
|
|
724
|
+
* @param {*} [options] Override http request option.
|
|
725
|
+
* @throws {RequiredError}
|
|
726
|
+
*/
|
|
727
|
+
v1DeleteOrganizationTarget(satelliteTargetId, options) {
|
|
728
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
729
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteOrganizationTarget(satelliteTargetId, options);
|
|
730
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
731
|
+
});
|
|
732
|
+
},
|
|
733
|
+
/**
|
|
734
|
+
* Delete an existing webhook configuration
|
|
735
|
+
* @param {string} id webhook id
|
|
736
|
+
* @param {*} [options] Override http request option.
|
|
737
|
+
* @throws {RequiredError}
|
|
738
|
+
*/
|
|
739
|
+
v1DeleteWebhookConfiguration(id, options) {
|
|
740
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
741
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteWebhookConfiguration(id, options);
|
|
742
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
743
|
+
});
|
|
744
|
+
},
|
|
745
|
+
/**
|
|
746
|
+
* get an image set
|
|
747
|
+
* @param {string} id
|
|
748
|
+
* @param {*} [options] Override http request option.
|
|
749
|
+
* @throws {RequiredError}
|
|
750
|
+
*/
|
|
751
|
+
v1GetImageSet(id, options) {
|
|
752
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
753
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetImageSet(id, options);
|
|
754
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
755
|
+
});
|
|
756
|
+
},
|
|
757
|
+
/**
|
|
758
|
+
* get an image
|
|
759
|
+
* @param {string} imageId
|
|
760
|
+
* @param {*} [options] Override http request option.
|
|
761
|
+
* @throws {RequiredError}
|
|
762
|
+
*/
|
|
763
|
+
v1GetImageSetImage(imageId, options) {
|
|
764
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
765
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetImageSetImage(imageId, options);
|
|
766
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
767
|
+
});
|
|
768
|
+
},
|
|
769
|
+
/**
|
|
770
|
+
* get image set images
|
|
771
|
+
* @param {Array<string>} imageSets
|
|
772
|
+
* @param {*} [options] Override http request option.
|
|
773
|
+
* @throws {RequiredError}
|
|
774
|
+
*/
|
|
775
|
+
v1GetImageSetImages(imageSets, options) {
|
|
776
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
777
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetImageSetImages(imageSets, options);
|
|
778
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
779
|
+
});
|
|
780
|
+
},
|
|
781
|
+
/**
|
|
782
|
+
* get image sets for targets observed for your organization
|
|
783
|
+
* @param {*} [options] Override http request option.
|
|
784
|
+
* @throws {RequiredError}
|
|
785
|
+
*/
|
|
786
|
+
v1GetImageSets(options) {
|
|
787
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
788
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetImageSets(options);
|
|
789
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
790
|
+
});
|
|
791
|
+
},
|
|
792
|
+
/**
|
|
793
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
794
|
+
* @param {string} [targetId]
|
|
795
|
+
* @param {string} [after]
|
|
796
|
+
* @param {*} [options] Override http request option.
|
|
797
|
+
* @throws {RequiredError}
|
|
798
|
+
*/
|
|
799
|
+
v1GetObservationSequenceResults(targetId, after, options) {
|
|
800
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
801
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationSequenceResults(targetId, after, options);
|
|
802
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
803
|
+
});
|
|
804
|
+
},
|
|
805
|
+
/**
|
|
806
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
807
|
+
* @param {*} [options] Override http request option.
|
|
808
|
+
* @throws {RequiredError}
|
|
809
|
+
*/
|
|
810
|
+
v1GetOrganizationTargets(options) {
|
|
811
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
812
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOrganizationTargets(options);
|
|
813
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
814
|
+
});
|
|
815
|
+
},
|
|
816
|
+
/**
|
|
817
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
818
|
+
* @param {OrbitType} [orbitType] orbit type
|
|
819
|
+
* @param {string} [noradId] norad id
|
|
820
|
+
* @param {*} [options] Override http request option.
|
|
821
|
+
* @throws {RequiredError}
|
|
822
|
+
*/
|
|
823
|
+
v1GetSatelliteTargets(orbitType, noradId, options) {
|
|
824
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
825
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSatelliteTargets(orbitType, noradId, options);
|
|
826
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
827
|
+
});
|
|
828
|
+
},
|
|
829
|
+
/**
|
|
830
|
+
* get tdm
|
|
831
|
+
* @param {string} tdmId
|
|
832
|
+
* @param {*} [options] Override http request option.
|
|
833
|
+
* @throws {RequiredError}
|
|
834
|
+
*/
|
|
835
|
+
v1GetTdm(tdmId, options) {
|
|
836
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
837
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetTdm(tdmId, options);
|
|
838
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
839
|
+
});
|
|
840
|
+
},
|
|
841
|
+
/**
|
|
842
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
843
|
+
* @param {string} [targetId]
|
|
844
|
+
* @param {string} [after]
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
*/
|
|
848
|
+
v1GetTdms(targetId, after, options) {
|
|
849
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
850
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetTdms(targetId, after, options);
|
|
851
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
852
|
+
});
|
|
853
|
+
},
|
|
854
|
+
/**
|
|
855
|
+
* Get the currently configured webhooks
|
|
856
|
+
* @param {*} [options] Override http request option.
|
|
857
|
+
* @throws {RequiredError}
|
|
858
|
+
*/
|
|
859
|
+
v1GetWebhookConfigurations(options) {
|
|
860
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
861
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetWebhookConfigurations(options);
|
|
862
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
863
|
+
});
|
|
864
|
+
},
|
|
865
|
+
/**
|
|
866
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
867
|
+
* @param {V1UpdateEmailConfiguration} v1UpdateEmailConfiguration request to update an organization email preference
|
|
868
|
+
* @param {*} [options] Override http request option.
|
|
869
|
+
* @throws {RequiredError}
|
|
870
|
+
*/
|
|
871
|
+
v1UpdateEmailConfiguration(v1UpdateEmailConfiguration, options) {
|
|
872
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
873
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1UpdateEmailConfiguration(v1UpdateEmailConfiguration, options);
|
|
874
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
875
|
+
});
|
|
876
|
+
},
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
exports.DefaultApiFp = DefaultApiFp;
|
|
880
|
+
/**
|
|
881
|
+
* DefaultApi - factory interface
|
|
882
|
+
* @export
|
|
883
|
+
*/
|
|
884
|
+
const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
885
|
+
const localVarFp = (0, exports.DefaultApiFp)(configuration);
|
|
886
|
+
return {
|
|
887
|
+
/**
|
|
888
|
+
* create an image set
|
|
889
|
+
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
890
|
+
* @param {*} [options] Override http request option.
|
|
891
|
+
* @throws {RequiredError}
|
|
892
|
+
*/
|
|
893
|
+
v1CreateImageSet(requestParameters, options) {
|
|
894
|
+
return localVarFp.v1CreateImageSet(requestParameters.v1CreateImageSet, options).then((request) => request(axios, basePath));
|
|
895
|
+
},
|
|
896
|
+
/**
|
|
897
|
+
* create an image set image
|
|
898
|
+
* @param {DefaultApiV1CreateImageSetImageRequest} requestParameters Request parameters.
|
|
899
|
+
* @param {*} [options] Override http request option.
|
|
900
|
+
* @throws {RequiredError}
|
|
901
|
+
*/
|
|
902
|
+
v1CreateImageSetImage(requestParameters, options) {
|
|
903
|
+
return localVarFp.v1CreateImageSetImage(requestParameters.v1CreateImageSetImage, options).then((request) => request(axios, basePath));
|
|
904
|
+
},
|
|
905
|
+
/**
|
|
906
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
907
|
+
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
908
|
+
* @param {*} [options] Override http request option.
|
|
909
|
+
* @throws {RequiredError}
|
|
910
|
+
*/
|
|
911
|
+
v1CreateOrganizationTarget(requestParameters, options) {
|
|
912
|
+
return localVarFp.v1CreateOrganizationTarget(requestParameters.v1OrganizationTarget, options).then((request) => request(axios, basePath));
|
|
913
|
+
},
|
|
914
|
+
/**
|
|
915
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
916
|
+
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
917
|
+
* @param {*} [options] Override http request option.
|
|
918
|
+
* @throws {RequiredError}
|
|
919
|
+
*/
|
|
920
|
+
v1CreateWebhookConfiguration(requestParameters, options) {
|
|
921
|
+
return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfiguration, options).then((request) => request(axios, basePath));
|
|
922
|
+
},
|
|
923
|
+
/**
|
|
924
|
+
* delete an organization target
|
|
925
|
+
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
v1DeleteOrganizationTarget(requestParameters, options) {
|
|
930
|
+
return localVarFp.v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(axios, basePath));
|
|
931
|
+
},
|
|
932
|
+
/**
|
|
933
|
+
* Delete an existing webhook configuration
|
|
934
|
+
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
935
|
+
* @param {*} [options] Override http request option.
|
|
936
|
+
* @throws {RequiredError}
|
|
937
|
+
*/
|
|
938
|
+
v1DeleteWebhookConfiguration(requestParameters, options) {
|
|
939
|
+
return localVarFp.v1DeleteWebhookConfiguration(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
940
|
+
},
|
|
941
|
+
/**
|
|
942
|
+
* get an image set
|
|
943
|
+
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
944
|
+
* @param {*} [options] Override http request option.
|
|
945
|
+
* @throws {RequiredError}
|
|
946
|
+
*/
|
|
947
|
+
v1GetImageSet(requestParameters, options) {
|
|
948
|
+
return localVarFp.v1GetImageSet(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
949
|
+
},
|
|
950
|
+
/**
|
|
951
|
+
* get an image
|
|
952
|
+
* @param {DefaultApiV1GetImageSetImageRequest} requestParameters Request parameters.
|
|
953
|
+
* @param {*} [options] Override http request option.
|
|
954
|
+
* @throws {RequiredError}
|
|
955
|
+
*/
|
|
956
|
+
v1GetImageSetImage(requestParameters, options) {
|
|
957
|
+
return localVarFp.v1GetImageSetImage(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
958
|
+
},
|
|
959
|
+
/**
|
|
960
|
+
* get image set images
|
|
961
|
+
* @param {DefaultApiV1GetImageSetImagesRequest} requestParameters Request parameters.
|
|
962
|
+
* @param {*} [options] Override http request option.
|
|
963
|
+
* @throws {RequiredError}
|
|
964
|
+
*/
|
|
965
|
+
v1GetImageSetImages(requestParameters, options) {
|
|
966
|
+
return localVarFp.v1GetImageSetImages(requestParameters.imageSets, options).then((request) => request(axios, basePath));
|
|
967
|
+
},
|
|
968
|
+
/**
|
|
969
|
+
* get image sets for targets observed for your organization
|
|
970
|
+
* @param {*} [options] Override http request option.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
*/
|
|
973
|
+
v1GetImageSets(options) {
|
|
974
|
+
return localVarFp.v1GetImageSets(options).then((request) => request(axios, basePath));
|
|
975
|
+
},
|
|
976
|
+
/**
|
|
977
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
978
|
+
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
979
|
+
* @param {*} [options] Override http request option.
|
|
980
|
+
* @throws {RequiredError}
|
|
981
|
+
*/
|
|
982
|
+
v1GetObservationSequenceResults(requestParameters = {}, options) {
|
|
983
|
+
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
984
|
+
},
|
|
985
|
+
/**
|
|
986
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
987
|
+
* @param {*} [options] Override http request option.
|
|
988
|
+
* @throws {RequiredError}
|
|
989
|
+
*/
|
|
990
|
+
v1GetOrganizationTargets(options) {
|
|
991
|
+
return localVarFp.v1GetOrganizationTargets(options).then((request) => request(axios, basePath));
|
|
992
|
+
},
|
|
993
|
+
/**
|
|
994
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
995
|
+
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
996
|
+
* @param {*} [options] Override http request option.
|
|
997
|
+
* @throws {RequiredError}
|
|
998
|
+
*/
|
|
999
|
+
v1GetSatelliteTargets(requestParameters = {}, options) {
|
|
1000
|
+
return localVarFp.v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(axios, basePath));
|
|
1001
|
+
},
|
|
1002
|
+
/**
|
|
1003
|
+
* get tdm
|
|
1004
|
+
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
1005
|
+
* @param {*} [options] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
*/
|
|
1008
|
+
v1GetTdm(requestParameters, options) {
|
|
1009
|
+
return localVarFp.v1GetTdm(requestParameters.tdmId, options).then((request) => request(axios, basePath));
|
|
1010
|
+
},
|
|
1011
|
+
/**
|
|
1012
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1013
|
+
* @param {DefaultApiV1GetTdmsRequest} requestParameters Request parameters.
|
|
1014
|
+
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @throws {RequiredError}
|
|
1016
|
+
*/
|
|
1017
|
+
v1GetTdms(requestParameters = {}, options) {
|
|
1018
|
+
return localVarFp.v1GetTdms(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
1019
|
+
},
|
|
1020
|
+
/**
|
|
1021
|
+
* Get the currently configured webhooks
|
|
1022
|
+
* @param {*} [options] Override http request option.
|
|
1023
|
+
* @throws {RequiredError}
|
|
1024
|
+
*/
|
|
1025
|
+
v1GetWebhookConfigurations(options) {
|
|
1026
|
+
return localVarFp.v1GetWebhookConfigurations(options).then((request) => request(axios, basePath));
|
|
1027
|
+
},
|
|
1028
|
+
/**
|
|
1029
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
1030
|
+
* @param {DefaultApiV1UpdateEmailConfigurationRequest} requestParameters Request parameters.
|
|
1031
|
+
* @param {*} [options] Override http request option.
|
|
1032
|
+
* @throws {RequiredError}
|
|
1033
|
+
*/
|
|
1034
|
+
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1035
|
+
return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfiguration, options).then((request) => request(axios, basePath));
|
|
1036
|
+
},
|
|
1037
|
+
};
|
|
1038
|
+
};
|
|
1039
|
+
exports.DefaultApiFactory = DefaultApiFactory;
|
|
1040
|
+
/**
|
|
1041
|
+
* DefaultApi - object-oriented interface
|
|
1042
|
+
* @export
|
|
1043
|
+
* @class DefaultApi
|
|
1044
|
+
* @extends {BaseAPI}
|
|
1045
|
+
*/
|
|
1046
|
+
class DefaultApi extends base_1.BaseAPI {
|
|
1047
|
+
/**
|
|
1048
|
+
* create an image set
|
|
1049
|
+
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
1050
|
+
* @param {*} [options] Override http request option.
|
|
1051
|
+
* @throws {RequiredError}
|
|
1052
|
+
* @memberof DefaultApi
|
|
1053
|
+
*/
|
|
1054
|
+
v1CreateImageSet(requestParameters, options) {
|
|
1055
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateImageSet(requestParameters.v1CreateImageSet, options).then((request) => request(this.axios, this.basePath));
|
|
1056
|
+
}
|
|
1057
|
+
/**
|
|
1058
|
+
* create an image set image
|
|
1059
|
+
* @param {DefaultApiV1CreateImageSetImageRequest} requestParameters Request parameters.
|
|
1060
|
+
* @param {*} [options] Override http request option.
|
|
1061
|
+
* @throws {RequiredError}
|
|
1062
|
+
* @memberof DefaultApi
|
|
1063
|
+
*/
|
|
1064
|
+
v1CreateImageSetImage(requestParameters, options) {
|
|
1065
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateImageSetImage(requestParameters.v1CreateImageSetImage, options).then((request) => request(this.axios, this.basePath));
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
1069
|
+
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
1070
|
+
* @param {*} [options] Override http request option.
|
|
1071
|
+
* @throws {RequiredError}
|
|
1072
|
+
* @memberof DefaultApi
|
|
1073
|
+
*/
|
|
1074
|
+
v1CreateOrganizationTarget(requestParameters, options) {
|
|
1075
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateOrganizationTarget(requestParameters.v1OrganizationTarget, options).then((request) => request(this.axios, this.basePath));
|
|
1076
|
+
}
|
|
1077
|
+
/**
|
|
1078
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
1079
|
+
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1080
|
+
* @param {*} [options] Override http request option.
|
|
1081
|
+
* @throws {RequiredError}
|
|
1082
|
+
* @memberof DefaultApi
|
|
1083
|
+
*/
|
|
1084
|
+
v1CreateWebhookConfiguration(requestParameters, options) {
|
|
1085
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfiguration, options).then((request) => request(this.axios, this.basePath));
|
|
1086
|
+
}
|
|
1087
|
+
/**
|
|
1088
|
+
* delete an organization target
|
|
1089
|
+
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
1090
|
+
* @param {*} [options] Override http request option.
|
|
1091
|
+
* @throws {RequiredError}
|
|
1092
|
+
* @memberof DefaultApi
|
|
1093
|
+
*/
|
|
1094
|
+
v1DeleteOrganizationTarget(requestParameters, options) {
|
|
1095
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
1096
|
+
}
|
|
1097
|
+
/**
|
|
1098
|
+
* Delete an existing webhook configuration
|
|
1099
|
+
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1100
|
+
* @param {*} [options] Override http request option.
|
|
1101
|
+
* @throws {RequiredError}
|
|
1102
|
+
* @memberof DefaultApi
|
|
1103
|
+
*/
|
|
1104
|
+
v1DeleteWebhookConfiguration(requestParameters, options) {
|
|
1105
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteWebhookConfiguration(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* get an image set
|
|
1109
|
+
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
1110
|
+
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @throws {RequiredError}
|
|
1112
|
+
* @memberof DefaultApi
|
|
1113
|
+
*/
|
|
1114
|
+
v1GetImageSet(requestParameters, options) {
|
|
1115
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetImageSet(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
1116
|
+
}
|
|
1117
|
+
/**
|
|
1118
|
+
* get an image
|
|
1119
|
+
* @param {DefaultApiV1GetImageSetImageRequest} requestParameters Request parameters.
|
|
1120
|
+
* @param {*} [options] Override http request option.
|
|
1121
|
+
* @throws {RequiredError}
|
|
1122
|
+
* @memberof DefaultApi
|
|
1123
|
+
*/
|
|
1124
|
+
v1GetImageSetImage(requestParameters, options) {
|
|
1125
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetImageSetImage(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
1126
|
+
}
|
|
1127
|
+
/**
|
|
1128
|
+
* get image set images
|
|
1129
|
+
* @param {DefaultApiV1GetImageSetImagesRequest} requestParameters Request parameters.
|
|
1130
|
+
* @param {*} [options] Override http request option.
|
|
1131
|
+
* @throws {RequiredError}
|
|
1132
|
+
* @memberof DefaultApi
|
|
1133
|
+
*/
|
|
1134
|
+
v1GetImageSetImages(requestParameters, options) {
|
|
1135
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetImageSetImages(requestParameters.imageSets, options).then((request) => request(this.axios, this.basePath));
|
|
1136
|
+
}
|
|
1137
|
+
/**
|
|
1138
|
+
* get image sets for targets observed for your organization
|
|
1139
|
+
* @param {*} [options] Override http request option.
|
|
1140
|
+
* @throws {RequiredError}
|
|
1141
|
+
* @memberof DefaultApi
|
|
1142
|
+
*/
|
|
1143
|
+
v1GetImageSets(options) {
|
|
1144
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetImageSets(options).then((request) => request(this.axios, this.basePath));
|
|
1145
|
+
}
|
|
1146
|
+
/**
|
|
1147
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1148
|
+
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
1149
|
+
* @param {*} [options] Override http request option.
|
|
1150
|
+
* @throws {RequiredError}
|
|
1151
|
+
* @memberof DefaultApi
|
|
1152
|
+
*/
|
|
1153
|
+
v1GetObservationSequenceResults(requestParameters = {}, options) {
|
|
1154
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
1155
|
+
}
|
|
1156
|
+
/**
|
|
1157
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
1158
|
+
* @param {*} [options] Override http request option.
|
|
1159
|
+
* @throws {RequiredError}
|
|
1160
|
+
* @memberof DefaultApi
|
|
1161
|
+
*/
|
|
1162
|
+
v1GetOrganizationTargets(options) {
|
|
1163
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetOrganizationTargets(options).then((request) => request(this.axios, this.basePath));
|
|
1164
|
+
}
|
|
1165
|
+
/**
|
|
1166
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
1167
|
+
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
1168
|
+
* @param {*} [options] Override http request option.
|
|
1169
|
+
* @throws {RequiredError}
|
|
1170
|
+
* @memberof DefaultApi
|
|
1171
|
+
*/
|
|
1172
|
+
v1GetSatelliteTargets(requestParameters = {}, options) {
|
|
1173
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(this.axios, this.basePath));
|
|
1174
|
+
}
|
|
1175
|
+
/**
|
|
1176
|
+
* get tdm
|
|
1177
|
+
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
1178
|
+
* @param {*} [options] Override http request option.
|
|
1179
|
+
* @throws {RequiredError}
|
|
1180
|
+
* @memberof DefaultApi
|
|
1181
|
+
*/
|
|
1182
|
+
v1GetTdm(requestParameters, options) {
|
|
1183
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetTdm(requestParameters.tdmId, options).then((request) => request(this.axios, this.basePath));
|
|
1184
|
+
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1187
|
+
* @param {DefaultApiV1GetTdmsRequest} requestParameters Request parameters.
|
|
1188
|
+
* @param {*} [options] Override http request option.
|
|
1189
|
+
* @throws {RequiredError}
|
|
1190
|
+
* @memberof DefaultApi
|
|
1191
|
+
*/
|
|
1192
|
+
v1GetTdms(requestParameters = {}, options) {
|
|
1193
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetTdms(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* Get the currently configured webhooks
|
|
1197
|
+
* @param {*} [options] Override http request option.
|
|
1198
|
+
* @throws {RequiredError}
|
|
1199
|
+
* @memberof DefaultApi
|
|
1200
|
+
*/
|
|
1201
|
+
v1GetWebhookConfigurations(options) {
|
|
1202
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetWebhookConfigurations(options).then((request) => request(this.axios, this.basePath));
|
|
1203
|
+
}
|
|
1204
|
+
/**
|
|
1205
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
1206
|
+
* @param {DefaultApiV1UpdateEmailConfigurationRequest} requestParameters Request parameters.
|
|
1207
|
+
* @param {*} [options] Override http request option.
|
|
1208
|
+
* @throws {RequiredError}
|
|
1209
|
+
* @memberof DefaultApi
|
|
1210
|
+
*/
|
|
1211
|
+
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1212
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfiguration, options).then((request) => request(this.axios, this.basePath));
|
|
1213
|
+
}
|
|
1214
|
+
}
|
|
1215
|
+
exports.DefaultApi = DefaultApi;
|