@ourskyai/platform-api 1.3.5002 → 1.3.5040

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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @ourskyai/platform-api@1.3.5002
1
+ ## @ourskyai/platform-api@1.3.5040
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @ourskyai/platform-api@1.3.5002 --save
39
+ npm install @ourskyai/platform-api@1.3.5040 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * OurSky Platform
5
5
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
6
  *
7
- * The version of the OpenAPI document: 1.3.5002
7
+ * The version of the OpenAPI document: 1.3.5040
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -818,6 +818,31 @@ export interface V1DiagnosticInstruction {
818
818
  }
819
819
 
820
820
 
821
+ /**
822
+ *
823
+ * @export
824
+ * @interface V1DurationMeasured
825
+ */
826
+ export interface V1DurationMeasured {
827
+ /**
828
+ *
829
+ * @type {string}
830
+ * @memberof V1DurationMeasured
831
+ */
832
+ 'name': string;
833
+ /**
834
+ *
835
+ * @type {string}
836
+ * @memberof V1DurationMeasured
837
+ */
838
+ 'startedAt': string;
839
+ /**
840
+ *
841
+ * @type {string}
842
+ * @memberof V1DurationMeasured
843
+ */
844
+ 'endedAt': string;
845
+ }
821
846
  /**
822
847
  * Elevation Mask Point
823
848
  * @export
@@ -962,6 +987,19 @@ export interface V1GetInstructionRequestUploadHealth {
962
987
  */
963
988
  'averageUploadDurationSeconds'?: number;
964
989
  }
990
+ /**
991
+ *
992
+ * @export
993
+ * @interface V1GetNodeCommandsResponse
994
+ */
995
+ export interface V1GetNodeCommandsResponse {
996
+ /**
997
+ *
998
+ * @type {Array<V1NodeCommand>}
999
+ * @memberof V1GetNodeCommandsResponse
1000
+ */
1001
+ 'nodeCommands': Array<V1NodeCommand>;
1002
+ }
965
1003
  /**
966
1004
  *
967
1005
  * @export
@@ -1258,6 +1296,19 @@ export interface V1GroundStationParticipant {
1258
1296
  }
1259
1297
 
1260
1298
 
1299
+ /**
1300
+ *
1301
+ * @export
1302
+ * @interface V1Halt
1303
+ */
1304
+ export interface V1Halt {
1305
+ /**
1306
+ *
1307
+ * @type {boolean}
1308
+ * @memberof V1Halt
1309
+ */
1310
+ 'placeholder'?: boolean;
1311
+ }
1261
1312
  /**
1262
1313
  * An image set represents a contiguous set of observations of the same target captured by the same node.
1263
1314
  * @export
@@ -1579,6 +1630,19 @@ export interface V1LatestHfrResponse {
1579
1630
  */
1580
1631
  'timestamp'?: string;
1581
1632
  }
1633
+ /**
1634
+ *
1635
+ * @export
1636
+ * @interface V1LogRecorded
1637
+ */
1638
+ export interface V1LogRecorded {
1639
+ /**
1640
+ *
1641
+ * @type {string}
1642
+ * @memberof V1LogRecorded
1643
+ */
1644
+ 'log': string;
1645
+ }
1582
1646
  /**
1583
1647
  *
1584
1648
  * @export
@@ -1742,6 +1806,60 @@ export interface V1Node {
1742
1806
  }
1743
1807
 
1744
1808
 
1809
+ /**
1810
+ *
1811
+ * @export
1812
+ * @interface V1NodeCommand
1813
+ */
1814
+ export interface V1NodeCommand {
1815
+ /**
1816
+ *
1817
+ * @type {string}
1818
+ * @memberof V1NodeCommand
1819
+ */
1820
+ 'id': string;
1821
+ /**
1822
+ *
1823
+ * @type {V1NodeCommandType}
1824
+ * @memberof V1NodeCommand
1825
+ */
1826
+ 'type': V1NodeCommandType;
1827
+ /**
1828
+ *
1829
+ * @type {V1NodeCommandBody}
1830
+ * @memberof V1NodeCommand
1831
+ */
1832
+ 'body': V1NodeCommandBody;
1833
+ /**
1834
+ *
1835
+ * @type {string}
1836
+ * @memberof V1NodeCommand
1837
+ */
1838
+ 'executableAt'?: string;
1839
+ }
1840
+
1841
+
1842
+ /**
1843
+ * @type V1NodeCommandBody
1844
+ * @export
1845
+ */
1846
+ export type V1NodeCommandBody = V1Halt | V1StartPerpetualInstructionLoop | V1StopPerpetualInstructionLoop;
1847
+
1848
+ /**
1849
+ *
1850
+ * @export
1851
+ * @enum {string}
1852
+ */
1853
+
1854
+ export const V1NodeCommandType = {
1855
+ V1_START_PERPETUAL_INSTRUCTION_LOOP: 'V1_START_PERPETUAL_INSTRUCTION_LOOP',
1856
+ V1_STOP_PERPETUAL_INSTRUCTION_LOOP: 'V1_STOP_PERPETUAL_INSTRUCTION_LOOP',
1857
+ V1_HALT: 'V1_HALT'
1858
+ } as const;
1859
+
1860
+ export type V1NodeCommandType = typeof V1NodeCommandType[keyof typeof V1NodeCommandType];
1861
+
1862
+
1745
1863
  /**
1746
1864
  *
1747
1865
  * @export
@@ -2331,6 +2449,19 @@ export interface V1Release {
2331
2449
  }
2332
2450
 
2333
2451
 
2452
+ /**
2453
+ *
2454
+ * @export
2455
+ * @interface V1SafetyStatusUpdated
2456
+ */
2457
+ export interface V1SafetyStatusUpdated {
2458
+ /**
2459
+ *
2460
+ * @type {boolean}
2461
+ * @memberof V1SafetyStatusUpdated
2462
+ */
2463
+ 'isSafe': boolean;
2464
+ }
2334
2465
  /**
2335
2466
  * Setup Action
2336
2467
  * @export
@@ -2394,6 +2525,32 @@ export interface V1SlewTimingInterval {
2394
2525
  */
2395
2526
  'durationMs': number;
2396
2527
  }
2528
+ /**
2529
+ *
2530
+ * @export
2531
+ * @interface V1StartPerpetualInstructionLoop
2532
+ */
2533
+ export interface V1StartPerpetualInstructionLoop {
2534
+ /**
2535
+ *
2536
+ * @type {boolean}
2537
+ * @memberof V1StartPerpetualInstructionLoop
2538
+ */
2539
+ 'placeholder'?: boolean;
2540
+ }
2541
+ /**
2542
+ *
2543
+ * @export
2544
+ * @interface V1StopPerpetualInstructionLoop
2545
+ */
2546
+ export interface V1StopPerpetualInstructionLoop {
2547
+ /**
2548
+ *
2549
+ * @type {boolean}
2550
+ * @memberof V1StopPerpetualInstructionLoop
2551
+ */
2552
+ 'placeholder'?: boolean;
2553
+ }
2397
2554
  /**
2398
2555
  *
2399
2556
  * @export
@@ -3400,6 +3557,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
3400
3557
 
3401
3558
 
3402
3559
 
3560
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3561
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3562
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3563
+
3564
+ return {
3565
+ url: toPathString(localVarUrlObj),
3566
+ options: localVarRequestOptions,
3567
+ };
3568
+ },
3569
+ /**
3570
+ * Delete a node command
3571
+ * @param {string} id
3572
+ * @param {*} [options] Override http request option.
3573
+ * @throws {RequiredError}
3574
+ */
3575
+ v1DeleteNodeCommand: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
3576
+ // verify required parameter 'id' is not null or undefined
3577
+ assertParamExists('v1DeleteNodeCommand', 'id', id)
3578
+ const localVarPath = `/v1/node-commands`;
3579
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3580
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3581
+ let baseOptions;
3582
+ if (configuration) {
3583
+ baseOptions = configuration.baseOptions;
3584
+ }
3585
+
3586
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
3587
+ const localVarHeaderParameter = {} as any;
3588
+ const localVarQueryParameter = {} as any;
3589
+
3590
+ // authentication Roles required
3591
+
3592
+ // authentication BearerToken required
3593
+ // http bearer authentication required
3594
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
3595
+
3596
+ if (id !== undefined) {
3597
+ localVarQueryParameter['id'] = id;
3598
+ }
3599
+
3600
+
3601
+
3403
3602
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3404
3603
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3405
3604
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3728,6 +3927,57 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
3728
3927
 
3729
3928
 
3730
3929
 
3930
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3931
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3932
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3933
+
3934
+ return {
3935
+ url: toPathString(localVarUrlObj),
3936
+ options: localVarRequestOptions,
3937
+ };
3938
+ },
3939
+ /**
3940
+ * Get node commands
3941
+ * @param {string} nodeId
3942
+ * @param {string} executableAt
3943
+ * @param {*} [options] Override http request option.
3944
+ * @throws {RequiredError}
3945
+ */
3946
+ v1GetNodeCommands: async (nodeId: string, executableAt: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
3947
+ // verify required parameter 'nodeId' is not null or undefined
3948
+ assertParamExists('v1GetNodeCommands', 'nodeId', nodeId)
3949
+ // verify required parameter 'executableAt' is not null or undefined
3950
+ assertParamExists('v1GetNodeCommands', 'executableAt', executableAt)
3951
+ const localVarPath = `/v1/node-commands`;
3952
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3953
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3954
+ let baseOptions;
3955
+ if (configuration) {
3956
+ baseOptions = configuration.baseOptions;
3957
+ }
3958
+
3959
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3960
+ const localVarHeaderParameter = {} as any;
3961
+ const localVarQueryParameter = {} as any;
3962
+
3963
+ // authentication Roles required
3964
+
3965
+ // authentication BearerToken required
3966
+ // http bearer authentication required
3967
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
3968
+
3969
+ if (nodeId !== undefined) {
3970
+ localVarQueryParameter['nodeId'] = nodeId;
3971
+ }
3972
+
3973
+ if (executableAt !== undefined) {
3974
+ localVarQueryParameter['executableAt'] = (executableAt as any instanceof Date) ?
3975
+ (executableAt as any).toISOString() :
3976
+ executableAt;
3977
+ }
3978
+
3979
+
3980
+
3731
3981
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3732
3982
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3733
3983
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -4488,6 +4738,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
4488
4738
  const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteImageSetImage(imageId, options);
4489
4739
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4490
4740
  },
4741
+ /**
4742
+ * Delete a node command
4743
+ * @param {string} id
4744
+ * @param {*} [options] Override http request option.
4745
+ * @throws {RequiredError}
4746
+ */
4747
+ async v1DeleteNodeCommand(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
4748
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteNodeCommand(id, options);
4749
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4750
+ },
4491
4751
  /**
4492
4752
  * Get cameras.
4493
4753
  * @param {*} [options] Override http request option.
@@ -4567,6 +4827,17 @@ export const DefaultApiFp = function(configuration?: Configuration) {
4567
4827
  const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNode(lineageId, options);
4568
4828
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4569
4829
  },
4830
+ /**
4831
+ * Get node commands
4832
+ * @param {string} nodeId
4833
+ * @param {string} executableAt
4834
+ * @param {*} [options] Override http request option.
4835
+ * @throws {RequiredError}
4836
+ */
4837
+ async v1GetNodeCommands(nodeId: string, executableAt: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetNodeCommandsResponse>> {
4838
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNodeCommands(nodeId, executableAt, options);
4839
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4840
+ },
4570
4841
  /**
4571
4842
  * returns the current release for the node
4572
4843
  * @param {string} lineageId lineage id
@@ -4853,6 +5124,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
4853
5124
  v1DeleteImageSetImage(requestParameters: DefaultApiV1DeleteImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
4854
5125
  return localVarFp.v1DeleteImageSetImage(requestParameters.imageId, options).then((request) => request(axios, basePath));
4855
5126
  },
5127
+ /**
5128
+ * Delete a node command
5129
+ * @param {DefaultApiV1DeleteNodeCommandRequest} requestParameters Request parameters.
5130
+ * @param {*} [options] Override http request option.
5131
+ * @throws {RequiredError}
5132
+ */
5133
+ v1DeleteNodeCommand(requestParameters: DefaultApiV1DeleteNodeCommandRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
5134
+ return localVarFp.v1DeleteNodeCommand(requestParameters.id, options).then((request) => request(axios, basePath));
5135
+ },
4856
5136
  /**
4857
5137
  * Get cameras.
4858
5138
  * @param {*} [options] Override http request option.
@@ -4924,6 +5204,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
4924
5204
  v1GetNode(requestParameters: DefaultApiV1GetNodeRequest, options?: AxiosRequestConfig): AxiosPromise<V1Node> {
4925
5205
  return localVarFp.v1GetNode(requestParameters.lineageId, options).then((request) => request(axios, basePath));
4926
5206
  },
5207
+ /**
5208
+ * Get node commands
5209
+ * @param {DefaultApiV1GetNodeCommandsRequest} requestParameters Request parameters.
5210
+ * @param {*} [options] Override http request option.
5211
+ * @throws {RequiredError}
5212
+ */
5213
+ v1GetNodeCommands(requestParameters: DefaultApiV1GetNodeCommandsRequest, options?: AxiosRequestConfig): AxiosPromise<V1GetNodeCommandsResponse> {
5214
+ return localVarFp.v1GetNodeCommands(requestParameters.nodeId, requestParameters.executableAt, options).then((request) => request(axios, basePath));
5215
+ },
4927
5216
  /**
4928
5217
  * returns the current release for the node
4929
5218
  * @param {DefaultApiV1GetNodeControllerReleaseRequest} requestParameters Request parameters.
@@ -5297,6 +5586,20 @@ export interface DefaultApiV1DeleteImageSetImageRequest {
5297
5586
  readonly imageId: string
5298
5587
  }
5299
5588
 
5589
+ /**
5590
+ * Request parameters for v1DeleteNodeCommand operation in DefaultApi.
5591
+ * @export
5592
+ * @interface DefaultApiV1DeleteNodeCommandRequest
5593
+ */
5594
+ export interface DefaultApiV1DeleteNodeCommandRequest {
5595
+ /**
5596
+ *
5597
+ * @type {string}
5598
+ * @memberof DefaultApiV1DeleteNodeCommand
5599
+ */
5600
+ readonly id: string
5601
+ }
5602
+
5300
5603
  /**
5301
5604
  * Request parameters for v1GetImageSet operation in DefaultApi.
5302
5605
  * @export
@@ -5395,6 +5698,27 @@ export interface DefaultApiV1GetNodeRequest {
5395
5698
  readonly lineageId: string
5396
5699
  }
5397
5700
 
5701
+ /**
5702
+ * Request parameters for v1GetNodeCommands operation in DefaultApi.
5703
+ * @export
5704
+ * @interface DefaultApiV1GetNodeCommandsRequest
5705
+ */
5706
+ export interface DefaultApiV1GetNodeCommandsRequest {
5707
+ /**
5708
+ *
5709
+ * @type {string}
5710
+ * @memberof DefaultApiV1GetNodeCommands
5711
+ */
5712
+ readonly nodeId: string
5713
+
5714
+ /**
5715
+ *
5716
+ * @type {string}
5717
+ * @memberof DefaultApiV1GetNodeCommands
5718
+ */
5719
+ readonly executableAt: string
5720
+ }
5721
+
5398
5722
  /**
5399
5723
  * Request parameters for v1GetNodeControllerRelease operation in DefaultApi.
5400
5724
  * @export
@@ -5769,6 +6093,17 @@ export class DefaultApi extends BaseAPI {
5769
6093
  return DefaultApiFp(this.configuration).v1DeleteImageSetImage(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
5770
6094
  }
5771
6095
 
6096
+ /**
6097
+ * Delete a node command
6098
+ * @param {DefaultApiV1DeleteNodeCommandRequest} requestParameters Request parameters.
6099
+ * @param {*} [options] Override http request option.
6100
+ * @throws {RequiredError}
6101
+ * @memberof DefaultApi
6102
+ */
6103
+ public v1DeleteNodeCommand(requestParameters: DefaultApiV1DeleteNodeCommandRequest, options?: AxiosRequestConfig) {
6104
+ return DefaultApiFp(this.configuration).v1DeleteNodeCommand(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
6105
+ }
6106
+
5772
6107
  /**
5773
6108
  * Get cameras.
5774
6109
  * @param {*} [options] Override http request option.
@@ -5856,6 +6191,17 @@ export class DefaultApi extends BaseAPI {
5856
6191
  return DefaultApiFp(this.configuration).v1GetNode(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
5857
6192
  }
5858
6193
 
6194
+ /**
6195
+ * Get node commands
6196
+ * @param {DefaultApiV1GetNodeCommandsRequest} requestParameters Request parameters.
6197
+ * @param {*} [options] Override http request option.
6198
+ * @throws {RequiredError}
6199
+ * @memberof DefaultApi
6200
+ */
6201
+ public v1GetNodeCommands(requestParameters: DefaultApiV1GetNodeCommandsRequest, options?: AxiosRequestConfig) {
6202
+ return DefaultApiFp(this.configuration).v1GetNodeCommands(requestParameters.nodeId, requestParameters.executableAt, options).then((request) => request(this.axios, this.basePath));
6203
+ }
6204
+
5859
6205
  /**
5860
6206
  * returns the current release for the node
5861
6207
  * @param {DefaultApiV1GetNodeControllerReleaseRequest} requestParameters Request parameters.
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * OurSky Platform
5
5
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
6
  *
7
- * The version of the OpenAPI document: 1.3.5002
7
+ * The version of the OpenAPI document: 1.3.5040
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * OurSky Platform
5
5
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
6
  *
7
- * The version of the OpenAPI document: 1.3.5002
7
+ * The version of the OpenAPI document: 1.3.5040
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * OurSky Platform
5
5
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
6
  *
7
- * The version of the OpenAPI document: 1.3.5002
7
+ * The version of the OpenAPI document: 1.3.5040
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).