@ourskyai/sda-api 1.3.8639 → 1.4.118

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.
Files changed (119) hide show
  1. package/.openapi-generator/FILES +90 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +180 -4
  4. package/api.ts +1224 -2821
  5. package/base.ts +14 -24
  6. package/common.ts +20 -44
  7. package/configuration.ts +37 -17
  8. package/dist/api.d.ts +692 -2672
  9. package/dist/api.js +811 -293
  10. package/dist/base.d.ts +11 -23
  11. package/dist/base.js +5 -18
  12. package/dist/common.d.ts +6 -37
  13. package/dist/common.js +18 -40
  14. package/dist/configuration.d.ts +30 -15
  15. package/dist/configuration.js +5 -3
  16. package/dist/esm/api.d.ts +692 -2672
  17. package/dist/esm/api.js +811 -293
  18. package/dist/esm/base.d.ts +11 -23
  19. package/dist/esm/base.js +4 -17
  20. package/dist/esm/common.d.ts +6 -37
  21. package/dist/esm/common.js +16 -39
  22. package/dist/esm/configuration.d.ts +30 -15
  23. package/dist/esm/configuration.js +5 -3
  24. package/dist/esm/index.d.ts +1 -1
  25. package/dist/esm/index.js +1 -1
  26. package/dist/index.d.ts +1 -1
  27. package/dist/index.js +1 -1
  28. package/docs/AstrometricOffsets.md +31 -0
  29. package/docs/DefaultApi.md +3166 -0
  30. package/docs/EmptySuccess.md +20 -0
  31. package/docs/FilterType.md +60 -0
  32. package/docs/FitsHeader.md +22 -0
  33. package/docs/ImageSetType.md +24 -0
  34. package/docs/Location.md +25 -0
  35. package/docs/MountGeometry.md +10 -0
  36. package/docs/MountType.md +10 -0
  37. package/docs/ObservationBoundingBox.md +26 -0
  38. package/docs/ObservationQuality.md +26 -0
  39. package/docs/ObservationResult.md +57 -0
  40. package/docs/ObservationState.md +16 -0
  41. package/docs/OrbitType.md +42 -0
  42. package/docs/SatelliteTargetTrackingStatus.md +12 -0
  43. package/docs/SearchCompletedReason.md +17 -0
  44. package/docs/ShutterType.md +10 -0
  45. package/docs/SuccessfulCreate.md +20 -0
  46. package/docs/SuccessfulDelete.md +20 -0
  47. package/docs/TrackingType.md +12 -0
  48. package/docs/V1AllSkyPredictionLabel.md +16 -0
  49. package/docs/V1BlackoutVolumeRequest.md +23 -0
  50. package/docs/V1CreateDirectTaskInstructionRequest.md +28 -0
  51. package/docs/V1CreateImageMetadataRequest.md +26 -0
  52. package/docs/V1CreateImageSetImageRequest.md +32 -0
  53. package/docs/V1CreateImageSetImageResponse.md +23 -0
  54. package/docs/V1CreateImageSetRequest.md +28 -0
  55. package/docs/V1CreateOrganizationTargetRequest.md +26 -0
  56. package/docs/V1CreateSatelliteTargetRequest.md +32 -0
  57. package/docs/V1CreateSearchInstructionRequest.md +24 -0
  58. package/docs/V1CreateSurveyInstructionRequest.md +24 -0
  59. package/docs/V1CreateWebhookConfigurationRequest.md +28 -0
  60. package/docs/V1CreateWebhookTestRequest.md +20 -0
  61. package/docs/V1GetSatelliteTargetsResponse.md +20 -0
  62. package/docs/V1GroundStationParticipant.md +52 -0
  63. package/docs/V1HFRStar.md +25 -0
  64. package/docs/V1ImageFileType.md +10 -0
  65. package/docs/V1ImageMetadata.md +32 -0
  66. package/docs/V1ImageRejectionReason.md +64 -0
  67. package/docs/V1ImageSet.md +43 -0
  68. package/docs/V1ImageSetImage.md +77 -0
  69. package/docs/V1MatchedStar.md +39 -0
  70. package/docs/V1NodeCalibrationResult.md +48 -0
  71. package/docs/V1ObservationFeature.md +39 -0
  72. package/docs/V1ObservationSequenceResult.md +37 -0
  73. package/docs/V1ObservationSequenceResultImageSetsInner.md +28 -0
  74. package/docs/V1ObservationStatus.md +56 -0
  75. package/docs/V1ObservationWeather.md +22 -0
  76. package/docs/V1ObservedWeather.md +23 -0
  77. package/docs/V1ObserverLocation.md +24 -0
  78. package/docs/V1OrganizationTarget.md +32 -0
  79. package/docs/V1PassStage.md +12 -0
  80. package/docs/V1PixelCoordinates.md +23 -0
  81. package/docs/V1PlaneScanRequest.md +25 -0
  82. package/docs/V1PlateSolveResult.md +40 -0
  83. package/docs/V1PlateSolveStatus.md +12 -0
  84. package/docs/V1Point.md +25 -0
  85. package/docs/V1PredictedStreakLocation.md +26 -0
  86. package/docs/V1PredictedWeather.md +21 -0
  87. package/docs/V1PutOrbitProviderTLERequest.md +33 -0
  88. package/docs/V1ResolvedImageMetadata.md +52 -0
  89. package/docs/V1ResolvedImageObservation.md +37 -0
  90. package/docs/V1ResolvedImagePair.md +41 -0
  91. package/docs/V1ResolvedImageSet.md +25 -0
  92. package/docs/V1RicVolumeSearchRequest.md +29 -0
  93. package/docs/V1SIPCoefficients.md +40 -0
  94. package/docs/V1SatelliteCalibrationFamily.md +12 -0
  95. package/docs/V1SatellitePotential.md +37 -0
  96. package/docs/V1SatelliteTarget.md +83 -0
  97. package/docs/V1SearchInstruction.md +29 -0
  98. package/docs/V1SearchInstructionStep.md +27 -0
  99. package/docs/V1SharpeningMethod.md +10 -0
  100. package/docs/V1StateVector.md +43 -0
  101. package/docs/V1SurveyInstruction.md +28 -0
  102. package/docs/V1SurveyInstructionStep.md +33 -0
  103. package/docs/V1TargetCorrelation.md +31 -0
  104. package/docs/V1Tdm.md +35 -0
  105. package/docs/V1TimeTaggedRaDec.md +28 -0
  106. package/docs/V1Track.md +24 -0
  107. package/docs/V1Transformation.md +77 -0
  108. package/docs/V1UpdateEmailConfigurationRequest.md +20 -0
  109. package/docs/V1UpdateOrganizationTargetRequest.md +24 -0
  110. package/docs/V1UpdateSatelliteTargetRequest.md +34 -0
  111. package/docs/V1UpdateWebhookConfigurationRequest.md +22 -0
  112. package/docs/V1WebhookConfiguration.md +34 -0
  113. package/docs/V1WebhookLog.md +30 -0
  114. package/docs/V2Search.md +29 -0
  115. package/docs/WeatherCondition.md +20 -0
  116. package/docs/WebhookAuthType.md +13 -0
  117. package/docs/WebhookEvent.md +35 -0
  118. package/index.ts +1 -1
  119. package/package.json +4 -4
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * OurSky SDA
3
3
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
4
4
  *
5
- * The version of the OpenAPI document: 1.3.8639
5
+ * The version of the OpenAPI document: 1.4.118
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,45 +10,33 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { Configuration } from './configuration';
13
- import type { AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
- options: AxiosRequestConfig;
23
+ options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
54
34
  }
35
+ interface ServerMap {
36
+ [key: string]: {
37
+ url: string;
38
+ description: string;
39
+ }[];
40
+ }
41
+ export declare const operationServerMap: ServerMap;
42
+ export {};
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * OurSky SDA
6
6
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.8639
8
+ * The version of the OpenAPI document: 1.4.118
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,42 +13,28 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
16
+ exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
17
17
  const axios_1 = require("axios");
18
18
  exports.BASE_PATH = "https://api.prod.oursky.ai".replace(/\/+$/, "");
19
- /**
20
- *
21
- * @export
22
- */
23
19
  exports.COLLECTION_FORMATS = {
24
20
  csv: ",",
25
21
  ssv: " ",
26
22
  tsv: "\t",
27
23
  pipes: "|",
28
24
  };
29
- /**
30
- *
31
- * @export
32
- * @class BaseAPI
33
- */
34
25
  class BaseAPI {
35
26
  constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
27
+ var _a;
36
28
  this.basePath = basePath;
37
29
  this.axios = axios;
38
30
  if (configuration) {
39
31
  this.configuration = configuration;
40
- this.basePath = configuration.basePath || this.basePath;
32
+ this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
41
33
  }
42
34
  }
43
35
  }
44
36
  exports.BaseAPI = BaseAPI;
45
37
  ;
46
- /**
47
- *
48
- * @export
49
- * @class RequiredError
50
- * @extends {Error}
51
- */
52
38
  class RequiredError extends Error {
53
39
  constructor(field, msg) {
54
40
  super(msg);
@@ -57,3 +43,4 @@ class RequiredError extends Error {
57
43
  }
58
44
  }
59
45
  exports.RequiredError = RequiredError;
46
+ exports.operationServerMap = {};
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * OurSky SDA
3
3
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
4
4
  *
5
- * The version of the OpenAPI document: 1.3.8639
5
+ * The version of the OpenAPI document: 1.4.118
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,54 +12,23 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
26
  /**
52
- *
53
- * @export
27
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
54
30
  */
31
+ export declare const replaceWithSerializableTypeIfNeeded: (key: any, value: any) => any;
55
32
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
33
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
- 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>;
34
+ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * OurSky SDA
6
6
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.8639
8
+ * The version of the OpenAPI document: 1.4.118
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,17 +22,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
25
+ exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
26
26
  const base_1 = require("./base");
27
- /**
28
- *
29
- * @export
30
- */
31
27
  exports.DUMMY_BASE_URL = 'https://example.com';
32
28
  /**
33
29
  *
34
30
  * @throws {RequiredError}
35
- * @export
36
31
  */
37
32
  const assertParamExists = function (functionName, paramName, paramValue) {
38
33
  if (paramValue === null || paramValue === undefined) {
@@ -40,10 +35,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
40
35
  }
41
36
  };
42
37
  exports.assertParamExists = assertParamExists;
43
- /**
44
- *
45
- * @export
46
- */
47
38
  const setApiKeyToObject = function (object, keyParamName, configuration) {
48
39
  return __awaiter(this, void 0, void 0, function* () {
49
40
  if (configuration && configuration.apiKey) {
@@ -55,20 +46,12 @@ const setApiKeyToObject = function (object, keyParamName, configuration) {
55
46
  });
56
47
  };
57
48
  exports.setApiKeyToObject = setApiKeyToObject;
58
- /**
59
- *
60
- * @export
61
- */
62
49
  const setBasicAuthToObject = function (object, configuration) {
63
50
  if (configuration && (configuration.username || configuration.password)) {
64
51
  object["auth"] = { username: configuration.username, password: configuration.password };
65
52
  }
66
53
  };
67
54
  exports.setBasicAuthToObject = setBasicAuthToObject;
68
- /**
69
- *
70
- * @export
71
- */
72
55
  const setBearerAuthToObject = function (object, configuration) {
73
56
  return __awaiter(this, void 0, void 0, function* () {
74
57
  if (configuration && configuration.accessToken) {
@@ -80,10 +63,6 @@ const setBearerAuthToObject = function (object, configuration) {
80
63
  });
81
64
  };
82
65
  exports.setBearerAuthToObject = setBearerAuthToObject;
83
- /**
84
- *
85
- * @export
86
- */
87
66
  const setOAuthToObject = function (object, name, scopes, configuration) {
88
67
  return __awaiter(this, void 0, void 0, function* () {
89
68
  if (configuration && configuration.accessToken) {
@@ -99,7 +78,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
99
78
  if (parameter == null)
100
79
  return;
101
80
  if (typeof parameter === "object") {
102
- if (Array.isArray(parameter)) {
81
+ if (Array.isArray(parameter) || parameter instanceof Set) {
103
82
  parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
104
83
  }
105
84
  else {
@@ -115,10 +94,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
115
94
  }
116
95
  }
117
96
  }
118
- /**
119
- *
120
- * @export
121
- */
122
97
  const setSearchParams = function (url, ...objects) {
123
98
  const searchParams = new URLSearchParams(url.search);
124
99
  setFlattenedQueryParams(searchParams, objects);
@@ -126,34 +101,37 @@ const setSearchParams = function (url, ...objects) {
126
101
  };
127
102
  exports.setSearchParams = setSearchParams;
128
103
  /**
129
- *
130
- * @export
104
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
105
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
106
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
131
107
  */
108
+ const replaceWithSerializableTypeIfNeeded = function (key, value) {
109
+ if (value instanceof Set) {
110
+ return Array.from(value);
111
+ }
112
+ else {
113
+ return value;
114
+ }
115
+ };
116
+ exports.replaceWithSerializableTypeIfNeeded = replaceWithSerializableTypeIfNeeded;
132
117
  const serializeDataIfNeeded = function (value, requestOptions, configuration) {
133
118
  const nonString = typeof value !== 'string';
134
119
  const needsSerialization = nonString && configuration && configuration.isJsonMime
135
120
  ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
136
121
  : nonString;
137
122
  return needsSerialization
138
- ? JSON.stringify(value !== undefined ? value : {})
123
+ ? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
139
124
  : (value || "");
140
125
  };
141
126
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
142
- /**
143
- *
144
- * @export
145
- */
146
127
  const toPathString = function (url) {
147
128
  return url.pathname + url.search + url.hash;
148
129
  };
149
130
  exports.toPathString = toPathString;
150
- /**
151
- *
152
- * @export
153
- */
154
131
  const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
155
132
  return (axios = globalAxios, basePath = BASE_PATH) => {
156
- const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: ((configuration === null || configuration === void 0 ? void 0 : configuration.basePath) || axios.defaults.baseURL || basePath) + axiosArgs.url });
133
+ var _a;
134
+ const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
157
135
  return axios.request(axiosRequestArgs);
158
136
  };
159
137
  };
@@ -2,19 +2,32 @@
2
2
  * OurSky SDA
3
3
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
4
4
  *
5
- * The version of the OpenAPI document: 1.3.8639
5
+ * The version of the OpenAPI document: 1.4.118
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
30
+ serverIndex?: number;
18
31
  baseOptions?: any;
19
32
  formDataCtor?: new () => any;
20
33
  }
@@ -22,42 +35,43 @@ export declare class Configuration {
22
35
  /**
23
36
  * parameter for apiKey security
24
37
  * @param name security name
25
- * @memberof Configuration
26
38
  */
27
39
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
40
  /**
29
41
  * parameter for basic security
30
- *
31
- * @type {string}
32
- * @memberof Configuration
33
42
  */
34
43
  username?: string;
35
44
  /**
36
45
  * parameter for basic security
37
- *
38
- * @type {string}
39
- * @memberof Configuration
40
46
  */
41
47
  password?: string;
42
48
  /**
43
49
  * parameter for oauth2 security
44
50
  * @param name security name
45
51
  * @param scopes oauth2 scope
46
- * @memberof Configuration
47
52
  */
48
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
49
54
  /**
50
- * override base path
51
- *
52
- * @type {string}
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
53
62
  * @memberof Configuration
54
63
  */
64
+ awsv4?: AWSv4Configuration;
65
+ /**
66
+ * override base path
67
+ */
55
68
  basePath?: string;
69
+ /**
70
+ * override server index
71
+ */
72
+ serverIndex?: number;
56
73
  /**
57
74
  * base options for axios calls
58
- *
59
- * @type {any}
60
- * @memberof Configuration
61
75
  */
62
76
  baseOptions?: any;
63
77
  /**
@@ -81,3 +95,4 @@ export declare class Configuration {
81
95
  */
82
96
  isJsonMime(mime: string): boolean;
83
97
  }
98
+ export {};
@@ -1,11 +1,10 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
- /* eslint-disable */
4
3
  /**
5
4
  * OurSky SDA
6
5
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
7
6
  *
8
- * The version of the OpenAPI document: 1.3.8639
7
+ * The version of the OpenAPI document: 1.4.118
9
8
  *
10
9
  *
11
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,12 +15,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
15
  exports.Configuration = void 0;
17
16
  class Configuration {
18
17
  constructor(param = {}) {
18
+ var _a;
19
19
  this.apiKey = param.apiKey;
20
20
  this.username = param.username;
21
21
  this.password = param.password;
22
22
  this.accessToken = param.accessToken;
23
+ this.awsv4 = param.awsv4;
23
24
  this.basePath = param.basePath;
24
- this.baseOptions = param.baseOptions;
25
+ this.serverIndex = param.serverIndex;
26
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
25
27
  this.formDataCtor = param.formDataCtor;
26
28
  }
27
29
  /**