@ourskyai/sda-api 1.3.4931 → 1.3.5002
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 +2 -2
- package/api.ts +191 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +104 -1
- package/dist/api.js +130 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +104 -1
- package/dist/esm/api.js +130 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @ourskyai/sda-api@1.3.
|
|
1
|
+
## @ourskyai/sda-api@1.3.5002
|
|
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/sda-api@1.3.
|
|
39
|
+
npm install @ourskyai/sda-api@1.3.5002 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](https://api.prod.oursky.ai/docs/sda#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](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.5002
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1790,6 +1790,25 @@ export interface V1UpdateEmailConfigurationRequest {
|
|
|
1790
1790
|
*/
|
|
1791
1791
|
'emails': Array<string>;
|
|
1792
1792
|
}
|
|
1793
|
+
/**
|
|
1794
|
+
*
|
|
1795
|
+
* @export
|
|
1796
|
+
* @interface V1UpdateOrganizationTargetRequest
|
|
1797
|
+
*/
|
|
1798
|
+
export interface V1UpdateOrganizationTargetRequest {
|
|
1799
|
+
/**
|
|
1800
|
+
*
|
|
1801
|
+
* @type {string}
|
|
1802
|
+
* @memberof V1UpdateOrganizationTargetRequest
|
|
1803
|
+
*/
|
|
1804
|
+
'organizationTargetId': string;
|
|
1805
|
+
/**
|
|
1806
|
+
* Desired minutes between revisits. The platform will do a best effort to observe the target at this rate. This is an enterprise feature only.
|
|
1807
|
+
* @type {number}
|
|
1808
|
+
* @memberof V1UpdateOrganizationTargetRequest
|
|
1809
|
+
*/
|
|
1810
|
+
'revisitRateMinutes'?: number;
|
|
1811
|
+
}
|
|
1793
1812
|
/**
|
|
1794
1813
|
*
|
|
1795
1814
|
* @export
|
|
@@ -3044,6 +3063,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
3044
3063
|
|
|
3045
3064
|
|
|
3046
3065
|
|
|
3066
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3067
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3068
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3069
|
+
|
|
3070
|
+
return {
|
|
3071
|
+
url: toPathString(localVarUrlObj),
|
|
3072
|
+
options: localVarRequestOptions,
|
|
3073
|
+
};
|
|
3074
|
+
},
|
|
3075
|
+
/**
|
|
3076
|
+
* Get an existing organization target
|
|
3077
|
+
* @param {string} organizationTargetId
|
|
3078
|
+
* @param {*} [options] Override http request option.
|
|
3079
|
+
* @throws {RequiredError}
|
|
3080
|
+
*/
|
|
3081
|
+
v1GetOrganizationTarget: async (organizationTargetId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3082
|
+
// verify required parameter 'organizationTargetId' is not null or undefined
|
|
3083
|
+
assertParamExists('v1GetOrganizationTarget', 'organizationTargetId', organizationTargetId)
|
|
3084
|
+
const localVarPath = `/v1/organization-target`;
|
|
3085
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3086
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3087
|
+
let baseOptions;
|
|
3088
|
+
if (configuration) {
|
|
3089
|
+
baseOptions = configuration.baseOptions;
|
|
3090
|
+
}
|
|
3091
|
+
|
|
3092
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3093
|
+
const localVarHeaderParameter = {} as any;
|
|
3094
|
+
const localVarQueryParameter = {} as any;
|
|
3095
|
+
|
|
3096
|
+
// authentication Roles required
|
|
3097
|
+
|
|
3098
|
+
// authentication BearerToken required
|
|
3099
|
+
// http bearer authentication required
|
|
3100
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3101
|
+
|
|
3102
|
+
if (organizationTargetId !== undefined) {
|
|
3103
|
+
localVarQueryParameter['organizationTargetId'] = organizationTargetId;
|
|
3104
|
+
}
|
|
3105
|
+
|
|
3106
|
+
|
|
3107
|
+
|
|
3047
3108
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3048
3109
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3049
3110
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -3552,6 +3613,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
3552
3613
|
options: localVarRequestOptions,
|
|
3553
3614
|
};
|
|
3554
3615
|
},
|
|
3616
|
+
/**
|
|
3617
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
3618
|
+
* @param {V1UpdateOrganizationTargetRequest} v1UpdateOrganizationTargetRequest
|
|
3619
|
+
* @param {*} [options] Override http request option.
|
|
3620
|
+
* @throws {RequiredError}
|
|
3621
|
+
*/
|
|
3622
|
+
v1UpdateOrganizationTarget: async (v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3623
|
+
// verify required parameter 'v1UpdateOrganizationTargetRequest' is not null or undefined
|
|
3624
|
+
assertParamExists('v1UpdateOrganizationTarget', 'v1UpdateOrganizationTargetRequest', v1UpdateOrganizationTargetRequest)
|
|
3625
|
+
const localVarPath = `/v1/organization-target`;
|
|
3626
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3627
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3628
|
+
let baseOptions;
|
|
3629
|
+
if (configuration) {
|
|
3630
|
+
baseOptions = configuration.baseOptions;
|
|
3631
|
+
}
|
|
3632
|
+
|
|
3633
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
3634
|
+
const localVarHeaderParameter = {} as any;
|
|
3635
|
+
const localVarQueryParameter = {} as any;
|
|
3636
|
+
|
|
3637
|
+
// authentication Roles required
|
|
3638
|
+
|
|
3639
|
+
// authentication BearerToken required
|
|
3640
|
+
// http bearer authentication required
|
|
3641
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3642
|
+
|
|
3643
|
+
|
|
3644
|
+
|
|
3645
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3646
|
+
|
|
3647
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3648
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3649
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3650
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateOrganizationTargetRequest, localVarRequestOptions, configuration)
|
|
3651
|
+
|
|
3652
|
+
return {
|
|
3653
|
+
url: toPathString(localVarUrlObj),
|
|
3654
|
+
options: localVarRequestOptions,
|
|
3655
|
+
};
|
|
3656
|
+
},
|
|
3555
3657
|
/**
|
|
3556
3658
|
* Update satellite target.
|
|
3557
3659
|
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
@@ -3890,6 +3992,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
3890
3992
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetOrganizationSatellitePotentials(until, includeWeather, options);
|
|
3891
3993
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3892
3994
|
},
|
|
3995
|
+
/**
|
|
3996
|
+
* Get an existing organization target
|
|
3997
|
+
* @param {string} organizationTargetId
|
|
3998
|
+
* @param {*} [options] Override http request option.
|
|
3999
|
+
* @throws {RequiredError}
|
|
4000
|
+
*/
|
|
4001
|
+
async v1GetOrganizationTarget(organizationTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>> {
|
|
4002
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetOrganizationTarget(organizationTargetId, options);
|
|
4003
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4004
|
+
},
|
|
3893
4005
|
/**
|
|
3894
4006
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
3895
4007
|
* @param {*} [options] Override http request option.
|
|
@@ -4008,6 +4120,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
4008
4120
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest, options);
|
|
4009
4121
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4010
4122
|
},
|
|
4123
|
+
/**
|
|
4124
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
4125
|
+
* @param {V1UpdateOrganizationTargetRequest} v1UpdateOrganizationTargetRequest
|
|
4126
|
+
* @param {*} [options] Override http request option.
|
|
4127
|
+
* @throws {RequiredError}
|
|
4128
|
+
*/
|
|
4129
|
+
async v1UpdateOrganizationTarget(v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>> {
|
|
4130
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateOrganizationTarget(v1UpdateOrganizationTargetRequest, options);
|
|
4131
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4132
|
+
},
|
|
4011
4133
|
/**
|
|
4012
4134
|
* Update satellite target.
|
|
4013
4135
|
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
@@ -4253,6 +4375,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
4253
4375
|
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>> {
|
|
4254
4376
|
return localVarFp.v1GetOrganizationSatellitePotentials(requestParameters.until, requestParameters.includeWeather, options).then((request) => request(axios, basePath));
|
|
4255
4377
|
},
|
|
4378
|
+
/**
|
|
4379
|
+
* Get an existing organization target
|
|
4380
|
+
* @param {DefaultApiV1GetOrganizationTargetRequest} requestParameters Request parameters.
|
|
4381
|
+
* @param {*} [options] Override http request option.
|
|
4382
|
+
* @throws {RequiredError}
|
|
4383
|
+
*/
|
|
4384
|
+
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget> {
|
|
4385
|
+
return localVarFp.v1GetOrganizationTarget(requestParameters.organizationTargetId, options).then((request) => request(axios, basePath));
|
|
4386
|
+
},
|
|
4256
4387
|
/**
|
|
4257
4388
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
4258
4389
|
* @param {*} [options] Override http request option.
|
|
@@ -4350,6 +4481,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
4350
4481
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
4351
4482
|
return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
4352
4483
|
},
|
|
4484
|
+
/**
|
|
4485
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
4486
|
+
* @param {DefaultApiV1UpdateOrganizationTargetRequest} requestParameters Request parameters.
|
|
4487
|
+
* @param {*} [options] Override http request option.
|
|
4488
|
+
* @throws {RequiredError}
|
|
4489
|
+
*/
|
|
4490
|
+
v1UpdateOrganizationTarget(requestParameters: DefaultApiV1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget> {
|
|
4491
|
+
return localVarFp.v1UpdateOrganizationTarget(requestParameters.v1UpdateOrganizationTargetRequest, options).then((request) => request(axios, basePath));
|
|
4492
|
+
},
|
|
4353
4493
|
/**
|
|
4354
4494
|
* Update satellite target.
|
|
4355
4495
|
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
@@ -4742,6 +4882,20 @@ export interface DefaultApiV1GetOrganizationSatellitePotentialsRequest {
|
|
|
4742
4882
|
readonly includeWeather?: boolean
|
|
4743
4883
|
}
|
|
4744
4884
|
|
|
4885
|
+
/**
|
|
4886
|
+
* Request parameters for v1GetOrganizationTarget operation in DefaultApi.
|
|
4887
|
+
* @export
|
|
4888
|
+
* @interface DefaultApiV1GetOrganizationTargetRequest
|
|
4889
|
+
*/
|
|
4890
|
+
export interface DefaultApiV1GetOrganizationTargetRequest {
|
|
4891
|
+
/**
|
|
4892
|
+
*
|
|
4893
|
+
* @type {string}
|
|
4894
|
+
* @memberof DefaultApiV1GetOrganizationTarget
|
|
4895
|
+
*/
|
|
4896
|
+
readonly organizationTargetId: string
|
|
4897
|
+
}
|
|
4898
|
+
|
|
4745
4899
|
/**
|
|
4746
4900
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
4747
4901
|
* @export
|
|
@@ -4938,6 +5092,20 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
|
4938
5092
|
readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest
|
|
4939
5093
|
}
|
|
4940
5094
|
|
|
5095
|
+
/**
|
|
5096
|
+
* Request parameters for v1UpdateOrganizationTarget operation in DefaultApi.
|
|
5097
|
+
* @export
|
|
5098
|
+
* @interface DefaultApiV1UpdateOrganizationTargetRequest
|
|
5099
|
+
*/
|
|
5100
|
+
export interface DefaultApiV1UpdateOrganizationTargetRequest {
|
|
5101
|
+
/**
|
|
5102
|
+
*
|
|
5103
|
+
* @type {V1UpdateOrganizationTargetRequest}
|
|
5104
|
+
* @memberof DefaultApiV1UpdateOrganizationTarget
|
|
5105
|
+
*/
|
|
5106
|
+
readonly v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest
|
|
5107
|
+
}
|
|
5108
|
+
|
|
4941
5109
|
/**
|
|
4942
5110
|
* Request parameters for v1UpdateSatelliteTarget operation in DefaultApi.
|
|
4943
5111
|
* @export
|
|
@@ -5236,6 +5404,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
5236
5404
|
return DefaultApiFp(this.configuration).v1GetOrganizationSatellitePotentials(requestParameters.until, requestParameters.includeWeather, options).then((request) => request(this.axios, this.basePath));
|
|
5237
5405
|
}
|
|
5238
5406
|
|
|
5407
|
+
/**
|
|
5408
|
+
* Get an existing organization target
|
|
5409
|
+
* @param {DefaultApiV1GetOrganizationTargetRequest} requestParameters Request parameters.
|
|
5410
|
+
* @param {*} [options] Override http request option.
|
|
5411
|
+
* @throws {RequiredError}
|
|
5412
|
+
* @memberof DefaultApi
|
|
5413
|
+
*/
|
|
5414
|
+
public v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig) {
|
|
5415
|
+
return DefaultApiFp(this.configuration).v1GetOrganizationTarget(requestParameters.organizationTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
5416
|
+
}
|
|
5417
|
+
|
|
5239
5418
|
/**
|
|
5240
5419
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
5241
5420
|
* @param {*} [options] Override http request option.
|
|
@@ -5355,6 +5534,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
5355
5534
|
return DefaultApiFp(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5356
5535
|
}
|
|
5357
5536
|
|
|
5537
|
+
/**
|
|
5538
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
5539
|
+
* @param {DefaultApiV1UpdateOrganizationTargetRequest} requestParameters Request parameters.
|
|
5540
|
+
* @param {*} [options] Override http request option.
|
|
5541
|
+
* @throws {RequiredError}
|
|
5542
|
+
* @memberof DefaultApi
|
|
5543
|
+
*/
|
|
5544
|
+
public v1UpdateOrganizationTarget(requestParameters: DefaultApiV1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig) {
|
|
5545
|
+
return DefaultApiFp(this.configuration).v1UpdateOrganizationTarget(requestParameters.v1UpdateOrganizationTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5546
|
+
}
|
|
5547
|
+
|
|
5358
5548
|
/**
|
|
5359
5549
|
* Update satellite target.
|
|
5360
5550
|
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](https://api.prod.oursky.ai/docs/sda#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](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.5002
|
|
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 SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](https://api.prod.oursky.ai/docs/sda#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](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.5002
|
|
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 SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](https://api.prod.oursky.ai/docs/sda#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](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.5002
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.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](https://api.prod.oursky.ai/docs/sda#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](https://api.prod.oursky.ai/docs/sda#tag/organization-targets/get/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](https://api.prod.oursky.ai/docs/sda#tag/webhooks/post/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](https://api.prod.oursky.ai/docs/sda#tag/tdms/get/v1/tdms) endpoint to poll for TDMs. 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.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.5002
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1734,6 +1734,25 @@ export interface V1UpdateEmailConfigurationRequest {
|
|
|
1734
1734
|
*/
|
|
1735
1735
|
'emails': Array<string>;
|
|
1736
1736
|
}
|
|
1737
|
+
/**
|
|
1738
|
+
*
|
|
1739
|
+
* @export
|
|
1740
|
+
* @interface V1UpdateOrganizationTargetRequest
|
|
1741
|
+
*/
|
|
1742
|
+
export interface V1UpdateOrganizationTargetRequest {
|
|
1743
|
+
/**
|
|
1744
|
+
*
|
|
1745
|
+
* @type {string}
|
|
1746
|
+
* @memberof V1UpdateOrganizationTargetRequest
|
|
1747
|
+
*/
|
|
1748
|
+
'organizationTargetId': string;
|
|
1749
|
+
/**
|
|
1750
|
+
* Desired minutes between revisits. The platform will do a best effort to observe the target at this rate. This is an enterprise feature only.
|
|
1751
|
+
* @type {number}
|
|
1752
|
+
* @memberof V1UpdateOrganizationTargetRequest
|
|
1753
|
+
*/
|
|
1754
|
+
'revisitRateMinutes'?: number;
|
|
1755
|
+
}
|
|
1737
1756
|
/**
|
|
1738
1757
|
*
|
|
1739
1758
|
* @export
|
|
@@ -2129,6 +2148,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2129
2148
|
* @throws {RequiredError}
|
|
2130
2149
|
*/
|
|
2131
2150
|
v1GetOrganizationSatellitePotentials: (until: string, includeWeather?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2151
|
+
/**
|
|
2152
|
+
* Get an existing organization target
|
|
2153
|
+
* @param {string} organizationTargetId
|
|
2154
|
+
* @param {*} [options] Override http request option.
|
|
2155
|
+
* @throws {RequiredError}
|
|
2156
|
+
*/
|
|
2157
|
+
v1GetOrganizationTarget: (organizationTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2132
2158
|
/**
|
|
2133
2159
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2134
2160
|
* @param {*} [options] Override http request option.
|
|
@@ -2214,6 +2240,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2214
2240
|
* @throws {RequiredError}
|
|
2215
2241
|
*/
|
|
2216
2242
|
v1UpdateEmailConfiguration: (v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2243
|
+
/**
|
|
2244
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
2245
|
+
* @param {V1UpdateOrganizationTargetRequest} v1UpdateOrganizationTargetRequest
|
|
2246
|
+
* @param {*} [options] Override http request option.
|
|
2247
|
+
* @throws {RequiredError}
|
|
2248
|
+
*/
|
|
2249
|
+
v1UpdateOrganizationTarget: (v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2217
2250
|
/**
|
|
2218
2251
|
* Update satellite target.
|
|
2219
2252
|
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
@@ -2408,6 +2441,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2408
2441
|
* @throws {RequiredError}
|
|
2409
2442
|
*/
|
|
2410
2443
|
v1GetOrganizationSatellitePotentials(until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
2444
|
+
/**
|
|
2445
|
+
* Get an existing organization target
|
|
2446
|
+
* @param {string} organizationTargetId
|
|
2447
|
+
* @param {*} [options] Override http request option.
|
|
2448
|
+
* @throws {RequiredError}
|
|
2449
|
+
*/
|
|
2450
|
+
v1GetOrganizationTarget(organizationTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>>;
|
|
2411
2451
|
/**
|
|
2412
2452
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2413
2453
|
* @param {*} [options] Override http request option.
|
|
@@ -2493,6 +2533,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2493
2533
|
* @throws {RequiredError}
|
|
2494
2534
|
*/
|
|
2495
2535
|
v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
2536
|
+
/**
|
|
2537
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
2538
|
+
* @param {V1UpdateOrganizationTargetRequest} v1UpdateOrganizationTargetRequest
|
|
2539
|
+
* @param {*} [options] Override http request option.
|
|
2540
|
+
* @throws {RequiredError}
|
|
2541
|
+
*/
|
|
2542
|
+
v1UpdateOrganizationTarget(v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>>;
|
|
2496
2543
|
/**
|
|
2497
2544
|
* Update satellite target.
|
|
2498
2545
|
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
@@ -2680,6 +2727,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2680
2727
|
* @throws {RequiredError}
|
|
2681
2728
|
*/
|
|
2682
2729
|
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>>;
|
|
2730
|
+
/**
|
|
2731
|
+
* Get an existing organization target
|
|
2732
|
+
* @param {DefaultApiV1GetOrganizationTargetRequest} requestParameters Request parameters.
|
|
2733
|
+
* @param {*} [options] Override http request option.
|
|
2734
|
+
* @throws {RequiredError}
|
|
2735
|
+
*/
|
|
2736
|
+
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget>;
|
|
2683
2737
|
/**
|
|
2684
2738
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2685
2739
|
* @param {*} [options] Override http request option.
|
|
@@ -2755,6 +2809,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2755
2809
|
* @throws {RequiredError}
|
|
2756
2810
|
*/
|
|
2757
2811
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
2812
|
+
/**
|
|
2813
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
2814
|
+
* @param {DefaultApiV1UpdateOrganizationTargetRequest} requestParameters Request parameters.
|
|
2815
|
+
* @param {*} [options] Override http request option.
|
|
2816
|
+
* @throws {RequiredError}
|
|
2817
|
+
*/
|
|
2818
|
+
v1UpdateOrganizationTarget(requestParameters: DefaultApiV1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget>;
|
|
2758
2819
|
/**
|
|
2759
2820
|
* Update satellite target.
|
|
2760
2821
|
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
@@ -3111,6 +3172,19 @@ export interface DefaultApiV1GetOrganizationSatellitePotentialsRequest {
|
|
|
3111
3172
|
*/
|
|
3112
3173
|
readonly includeWeather?: boolean;
|
|
3113
3174
|
}
|
|
3175
|
+
/**
|
|
3176
|
+
* Request parameters for v1GetOrganizationTarget operation in DefaultApi.
|
|
3177
|
+
* @export
|
|
3178
|
+
* @interface DefaultApiV1GetOrganizationTargetRequest
|
|
3179
|
+
*/
|
|
3180
|
+
export interface DefaultApiV1GetOrganizationTargetRequest {
|
|
3181
|
+
/**
|
|
3182
|
+
*
|
|
3183
|
+
* @type {string}
|
|
3184
|
+
* @memberof DefaultApiV1GetOrganizationTarget
|
|
3185
|
+
*/
|
|
3186
|
+
readonly organizationTargetId: string;
|
|
3187
|
+
}
|
|
3114
3188
|
/**
|
|
3115
3189
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
3116
3190
|
* @export
|
|
@@ -3288,6 +3362,19 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
|
3288
3362
|
*/
|
|
3289
3363
|
readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest;
|
|
3290
3364
|
}
|
|
3365
|
+
/**
|
|
3366
|
+
* Request parameters for v1UpdateOrganizationTarget operation in DefaultApi.
|
|
3367
|
+
* @export
|
|
3368
|
+
* @interface DefaultApiV1UpdateOrganizationTargetRequest
|
|
3369
|
+
*/
|
|
3370
|
+
export interface DefaultApiV1UpdateOrganizationTargetRequest {
|
|
3371
|
+
/**
|
|
3372
|
+
*
|
|
3373
|
+
* @type {V1UpdateOrganizationTargetRequest}
|
|
3374
|
+
* @memberof DefaultApiV1UpdateOrganizationTarget
|
|
3375
|
+
*/
|
|
3376
|
+
readonly v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest;
|
|
3377
|
+
}
|
|
3291
3378
|
/**
|
|
3292
3379
|
* Request parameters for v1UpdateSatelliteTarget operation in DefaultApi.
|
|
3293
3380
|
* @export
|
|
@@ -3512,6 +3599,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3512
3599
|
* @memberof DefaultApi
|
|
3513
3600
|
*/
|
|
3514
3601
|
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatellitePotential[], any>>;
|
|
3602
|
+
/**
|
|
3603
|
+
* Get an existing organization target
|
|
3604
|
+
* @param {DefaultApiV1GetOrganizationTargetRequest} requestParameters Request parameters.
|
|
3605
|
+
* @param {*} [options] Override http request option.
|
|
3606
|
+
* @throws {RequiredError}
|
|
3607
|
+
* @memberof DefaultApi
|
|
3608
|
+
*/
|
|
3609
|
+
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OrganizationTarget, any>>;
|
|
3515
3610
|
/**
|
|
3516
3611
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
3517
3612
|
* @param {*} [options] Override http request option.
|
|
@@ -3598,6 +3693,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3598
3693
|
* @memberof DefaultApi
|
|
3599
3694
|
*/
|
|
3600
3695
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
3696
|
+
/**
|
|
3697
|
+
* Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
|
|
3698
|
+
* @param {DefaultApiV1UpdateOrganizationTargetRequest} requestParameters Request parameters.
|
|
3699
|
+
* @param {*} [options] Override http request option.
|
|
3700
|
+
* @throws {RequiredError}
|
|
3701
|
+
* @memberof DefaultApi
|
|
3702
|
+
*/
|
|
3703
|
+
v1UpdateOrganizationTarget(requestParameters: DefaultApiV1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OrganizationTarget, any>>;
|
|
3601
3704
|
/**
|
|
3602
3705
|
* Update satellite target.
|
|
3603
3706
|
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|