@ourskyai/sda-api 1.3.4187 → 1.3.4196

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/sda-api@1.3.4187
1
+ ## @ourskyai/sda-api@1.3.4196
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.4187 --save
39
+ npm install @ourskyai/sda-api@1.3.4196 --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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -621,6 +621,58 @@ export interface V1CreateSurveyInstructionRequest {
621
621
  */
622
622
  'firstStepAt'?: string;
623
623
  }
624
+ /**
625
+ *
626
+ * @export
627
+ * @interface V1CreateWebhookConfigurationRequest
628
+ */
629
+ export interface V1CreateWebhookConfigurationRequest {
630
+ /**
631
+ *
632
+ * @type {string}
633
+ * @memberof V1CreateWebhookConfigurationRequest
634
+ */
635
+ 'url': string;
636
+ /**
637
+ *
638
+ * @type {string}
639
+ * @memberof V1CreateWebhookConfigurationRequest
640
+ */
641
+ 'secret': string;
642
+ /**
643
+ *
644
+ * @type {Array<WebhookEvent>}
645
+ * @memberof V1CreateWebhookConfigurationRequest
646
+ */
647
+ 'events': Array<WebhookEvent>;
648
+ /**
649
+ *
650
+ * @type {WebhookAuthType}
651
+ * @memberof V1CreateWebhookConfigurationRequest
652
+ */
653
+ 'authType'?: WebhookAuthType;
654
+ /**
655
+ *
656
+ * @type {string}
657
+ * @memberof V1CreateWebhookConfigurationRequest
658
+ */
659
+ 'authorization'?: string;
660
+ }
661
+
662
+
663
+ /**
664
+ *
665
+ * @export
666
+ * @interface V1CreateWebhookTestRequest
667
+ */
668
+ export interface V1CreateWebhookTestRequest {
669
+ /**
670
+ *
671
+ * @type {Array<WebhookEvent>}
672
+ * @memberof V1CreateWebhookTestRequest
673
+ */
674
+ 'events': Array<WebhookEvent>;
675
+ }
624
676
  /**
625
677
  *
626
678
  * @export
@@ -1750,45 +1802,6 @@ export interface V1UpdateSatelliteTargetRequest {
1750
1802
  */
1751
1803
  'crossSection'?: number;
1752
1804
  }
1753
- /**
1754
- *
1755
- * @export
1756
- * @interface V1UpdateWebhookConfigurationRequest
1757
- */
1758
- export interface V1UpdateWebhookConfigurationRequest {
1759
- /**
1760
- *
1761
- * @type {string}
1762
- * @memberof V1UpdateWebhookConfigurationRequest
1763
- */
1764
- 'url': string;
1765
- /**
1766
- *
1767
- * @type {string}
1768
- * @memberof V1UpdateWebhookConfigurationRequest
1769
- */
1770
- 'secret': string;
1771
- /**
1772
- *
1773
- * @type {Array<WebhookEvent>}
1774
- * @memberof V1UpdateWebhookConfigurationRequest
1775
- */
1776
- 'events': Array<WebhookEvent>;
1777
- /**
1778
- *
1779
- * @type {WebhookAuthType}
1780
- * @memberof V1UpdateWebhookConfigurationRequest
1781
- */
1782
- 'authType'?: WebhookAuthType;
1783
- /**
1784
- *
1785
- * @type {string}
1786
- * @memberof V1UpdateWebhookConfigurationRequest
1787
- */
1788
- 'authorization'?: string;
1789
- }
1790
-
1791
-
1792
1805
  /**
1793
1806
  *
1794
1807
  * @export
@@ -2190,13 +2203,13 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
2190
2203
  },
2191
2204
  /**
2192
2205
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
2193
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
2206
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
2194
2207
  * @param {*} [options] Override http request option.
2195
2208
  * @throws {RequiredError}
2196
2209
  */
2197
- v1CreateWebhookConfiguration: async (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
2198
- // verify required parameter 'v1UpdateWebhookConfigurationRequest' is not null or undefined
2199
- assertParamExists('v1CreateWebhookConfiguration', 'v1UpdateWebhookConfigurationRequest', v1UpdateWebhookConfigurationRequest)
2210
+ v1CreateWebhookConfiguration: async (v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
2211
+ // verify required parameter 'v1CreateWebhookConfigurationRequest' is not null or undefined
2212
+ assertParamExists('v1CreateWebhookConfiguration', 'v1CreateWebhookConfigurationRequest', v1CreateWebhookConfigurationRequest)
2200
2213
  const localVarPath = `/v1/communications/webhook`;
2201
2214
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2202
2215
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -2222,7 +2235,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
2222
2235
  setSearchParams(localVarUrlObj, localVarQueryParameter);
2223
2236
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2224
2237
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2225
- localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateWebhookConfigurationRequest, localVarRequestOptions, configuration)
2238
+ localVarRequestOptions.data = serializeDataIfNeeded(v1CreateWebhookConfigurationRequest, localVarRequestOptions, configuration)
2239
+
2240
+ return {
2241
+ url: toPathString(localVarUrlObj),
2242
+ options: localVarRequestOptions,
2243
+ };
2244
+ },
2245
+ /**
2246
+ * Test your organization\'s webhooks.
2247
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
2248
+ * @param {*} [options] Override http request option.
2249
+ * @throws {RequiredError}
2250
+ */
2251
+ v1CreateWebhookTest: async (v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
2252
+ // verify required parameter 'v1CreateWebhookTestRequest' is not null or undefined
2253
+ assertParamExists('v1CreateWebhookTest', 'v1CreateWebhookTestRequest', v1CreateWebhookTestRequest)
2254
+ const localVarPath = `/v1/communications/webhook-test`;
2255
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2256
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2257
+ let baseOptions;
2258
+ if (configuration) {
2259
+ baseOptions = configuration.baseOptions;
2260
+ }
2261
+
2262
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2263
+ const localVarHeaderParameter = {} as any;
2264
+ const localVarQueryParameter = {} as any;
2265
+
2266
+ // authentication Roles required
2267
+
2268
+ // authentication BearerToken required
2269
+ // http bearer authentication required
2270
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2271
+
2272
+
2273
+
2274
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2275
+
2276
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2277
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2278
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2279
+ localVarRequestOptions.data = serializeDataIfNeeded(v1CreateWebhookTestRequest, localVarRequestOptions, configuration)
2226
2280
 
2227
2281
  return {
2228
2282
  url: toPathString(localVarUrlObj),
@@ -3491,12 +3545,22 @@ export const DefaultApiFp = function(configuration?: Configuration) {
3491
3545
  },
3492
3546
  /**
3493
3547
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
3494
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
3548
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
3495
3549
  * @param {*} [options] Override http request option.
3496
3550
  * @throws {RequiredError}
3497
3551
  */
3498
- async v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
3499
- const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest, options);
3552
+ async v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
3553
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest, options);
3554
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
3555
+ },
3556
+ /**
3557
+ * Test your organization\'s webhooks.
3558
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
3559
+ * @param {*} [options] Override http request option.
3560
+ * @throws {RequiredError}
3561
+ */
3562
+ async v1CreateWebhookTest(v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
3563
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateWebhookTest(v1CreateWebhookTestRequest, options);
3500
3564
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
3501
3565
  },
3502
3566
  /**
@@ -3852,7 +3916,16 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
3852
3916
  * @throws {RequiredError}
3853
3917
  */
3854
3918
  v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
3855
- return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
3919
+ return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1CreateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
3920
+ },
3921
+ /**
3922
+ * Test your organization\'s webhooks.
3923
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
3924
+ * @param {*} [options] Override http request option.
3925
+ * @throws {RequiredError}
3926
+ */
3927
+ v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
3928
+ return localVarFp.v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(axios, basePath));
3856
3929
  },
3857
3930
  /**
3858
3931
  * Delete an image set.
@@ -4189,10 +4262,24 @@ export interface DefaultApiV1CreateSurveyInstructionRequest {
4189
4262
  export interface DefaultApiV1CreateWebhookConfigurationRequest {
4190
4263
  /**
4191
4264
  *
4192
- * @type {V1UpdateWebhookConfigurationRequest}
4265
+ * @type {V1CreateWebhookConfigurationRequest}
4193
4266
  * @memberof DefaultApiV1CreateWebhookConfiguration
4194
4267
  */
4195
- readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest
4268
+ readonly v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest
4269
+ }
4270
+
4271
+ /**
4272
+ * Request parameters for v1CreateWebhookTest operation in DefaultApi.
4273
+ * @export
4274
+ * @interface DefaultApiV1CreateWebhookTestRequest
4275
+ */
4276
+ export interface DefaultApiV1CreateWebhookTestRequest {
4277
+ /**
4278
+ *
4279
+ * @type {V1CreateWebhookTestRequest}
4280
+ * @memberof DefaultApiV1CreateWebhookTest
4281
+ */
4282
+ readonly v1CreateWebhookTestRequest: V1CreateWebhookTestRequest
4196
4283
  }
4197
4284
 
4198
4285
  /**
@@ -4717,7 +4804,18 @@ export class DefaultApi extends BaseAPI {
4717
4804
  * @memberof DefaultApi
4718
4805
  */
4719
4806
  public v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig) {
4720
- return DefaultApiFp(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
4807
+ return DefaultApiFp(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1CreateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
4808
+ }
4809
+
4810
+ /**
4811
+ * Test your organization\'s webhooks.
4812
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
4813
+ * @param {*} [options] Override http request option.
4814
+ * @throws {RequiredError}
4815
+ * @memberof DefaultApi
4816
+ */
4817
+ public v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig) {
4818
+ return DefaultApiFp(this.configuration).v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(this.axios, this.basePath));
4721
4819
  }
4722
4820
 
4723
4821
  /**
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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -579,6 +579,56 @@ export interface V1CreateSurveyInstructionRequest {
579
579
  */
580
580
  'firstStepAt'?: string;
581
581
  }
582
+ /**
583
+ *
584
+ * @export
585
+ * @interface V1CreateWebhookConfigurationRequest
586
+ */
587
+ export interface V1CreateWebhookConfigurationRequest {
588
+ /**
589
+ *
590
+ * @type {string}
591
+ * @memberof V1CreateWebhookConfigurationRequest
592
+ */
593
+ 'url': string;
594
+ /**
595
+ *
596
+ * @type {string}
597
+ * @memberof V1CreateWebhookConfigurationRequest
598
+ */
599
+ 'secret': string;
600
+ /**
601
+ *
602
+ * @type {Array<WebhookEvent>}
603
+ * @memberof V1CreateWebhookConfigurationRequest
604
+ */
605
+ 'events': Array<WebhookEvent>;
606
+ /**
607
+ *
608
+ * @type {WebhookAuthType}
609
+ * @memberof V1CreateWebhookConfigurationRequest
610
+ */
611
+ 'authType'?: WebhookAuthType;
612
+ /**
613
+ *
614
+ * @type {string}
615
+ * @memberof V1CreateWebhookConfigurationRequest
616
+ */
617
+ 'authorization'?: string;
618
+ }
619
+ /**
620
+ *
621
+ * @export
622
+ * @interface V1CreateWebhookTestRequest
623
+ */
624
+ export interface V1CreateWebhookTestRequest {
625
+ /**
626
+ *
627
+ * @type {Array<WebhookEvent>}
628
+ * @memberof V1CreateWebhookTestRequest
629
+ */
630
+ 'events': Array<WebhookEvent>;
631
+ }
582
632
  /**
583
633
  *
584
634
  * @export
@@ -1696,43 +1746,6 @@ export interface V1UpdateSatelliteTargetRequest {
1696
1746
  */
1697
1747
  'crossSection'?: number;
1698
1748
  }
1699
- /**
1700
- *
1701
- * @export
1702
- * @interface V1UpdateWebhookConfigurationRequest
1703
- */
1704
- export interface V1UpdateWebhookConfigurationRequest {
1705
- /**
1706
- *
1707
- * @type {string}
1708
- * @memberof V1UpdateWebhookConfigurationRequest
1709
- */
1710
- 'url': string;
1711
- /**
1712
- *
1713
- * @type {string}
1714
- * @memberof V1UpdateWebhookConfigurationRequest
1715
- */
1716
- 'secret': string;
1717
- /**
1718
- *
1719
- * @type {Array<WebhookEvent>}
1720
- * @memberof V1UpdateWebhookConfigurationRequest
1721
- */
1722
- 'events': Array<WebhookEvent>;
1723
- /**
1724
- *
1725
- * @type {WebhookAuthType}
1726
- * @memberof V1UpdateWebhookConfigurationRequest
1727
- */
1728
- 'authType'?: WebhookAuthType;
1729
- /**
1730
- *
1731
- * @type {string}
1732
- * @memberof V1UpdateWebhookConfigurationRequest
1733
- */
1734
- 'authorization'?: string;
1735
- }
1736
1749
  /**
1737
1750
  *
1738
1751
  * @export
@@ -1916,11 +1929,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1916
1929
  v1CreateSurveyInstruction: (v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1917
1930
  /**
1918
1931
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
1919
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
1932
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
1920
1933
  * @param {*} [options] Override http request option.
1921
1934
  * @throws {RequiredError}
1922
1935
  */
1923
- v1CreateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1936
+ v1CreateWebhookConfiguration: (v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1937
+ /**
1938
+ * Test your organization\'s webhooks.
1939
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
1940
+ * @param {*} [options] Override http request option.
1941
+ * @throws {RequiredError}
1942
+ */
1943
+ v1CreateWebhookTest: (v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1924
1944
  /**
1925
1945
  * Delete an image set.
1926
1946
  * @param {string} id
@@ -2172,11 +2192,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2172
2192
  v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
2173
2193
  /**
2174
2194
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
2175
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
2195
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
2196
+ * @param {*} [options] Override http request option.
2197
+ * @throws {RequiredError}
2198
+ */
2199
+ v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
2200
+ /**
2201
+ * Test your organization\'s webhooks.
2202
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
2176
2203
  * @param {*} [options] Override http request option.
2177
2204
  * @throws {RequiredError}
2178
2205
  */
2179
- v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
2206
+ v1CreateWebhookTest(v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
2180
2207
  /**
2181
2208
  * Delete an image set.
2182
2209
  * @param {string} id
@@ -2433,6 +2460,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2433
2460
  * @throws {RequiredError}
2434
2461
  */
2435
2462
  v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
2463
+ /**
2464
+ * Test your organization\'s webhooks.
2465
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
2466
+ * @param {*} [options] Override http request option.
2467
+ * @throws {RequiredError}
2468
+ */
2469
+ v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
2436
2470
  /**
2437
2471
  * Delete an image set.
2438
2472
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
@@ -2706,10 +2740,23 @@ export interface DefaultApiV1CreateSurveyInstructionRequest {
2706
2740
  export interface DefaultApiV1CreateWebhookConfigurationRequest {
2707
2741
  /**
2708
2742
  *
2709
- * @type {V1UpdateWebhookConfigurationRequest}
2743
+ * @type {V1CreateWebhookConfigurationRequest}
2710
2744
  * @memberof DefaultApiV1CreateWebhookConfiguration
2711
2745
  */
2712
- readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest;
2746
+ readonly v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest;
2747
+ }
2748
+ /**
2749
+ * Request parameters for v1CreateWebhookTest operation in DefaultApi.
2750
+ * @export
2751
+ * @interface DefaultApiV1CreateWebhookTestRequest
2752
+ */
2753
+ export interface DefaultApiV1CreateWebhookTestRequest {
2754
+ /**
2755
+ *
2756
+ * @type {V1CreateWebhookTestRequest}
2757
+ * @memberof DefaultApiV1CreateWebhookTest
2758
+ */
2759
+ readonly v1CreateWebhookTestRequest: V1CreateWebhookTestRequest;
2713
2760
  }
2714
2761
  /**
2715
2762
  * Request parameters for v1DeleteImageSet operation in DefaultApi.
@@ -3176,6 +3223,14 @@ export declare class DefaultApi extends BaseAPI {
3176
3223
  * @memberof DefaultApi
3177
3224
  */
3178
3225
  v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
3226
+ /**
3227
+ * Test your organization\'s webhooks.
3228
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
3229
+ * @param {*} [options] Override http request option.
3230
+ * @throws {RequiredError}
3231
+ * @memberof DefaultApi
3232
+ */
3233
+ v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
3179
3234
  /**
3180
3235
  * Delete an image set.
3181
3236
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
package/dist/api.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](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.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.4187
8
+ * The version of the OpenAPI document: 1.3.4196
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -373,13 +373,13 @@ const DefaultApiAxiosParamCreator = function (configuration) {
373
373
  }),
374
374
  /**
375
375
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
376
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
376
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
377
377
  * @param {*} [options] Override http request option.
378
378
  * @throws {RequiredError}
379
379
  */
380
- v1CreateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
381
- // verify required parameter 'v1UpdateWebhookConfigurationRequest' is not null or undefined
382
- (0, common_1.assertParamExists)('v1CreateWebhookConfiguration', 'v1UpdateWebhookConfigurationRequest', v1UpdateWebhookConfigurationRequest);
380
+ v1CreateWebhookConfiguration: (v1CreateWebhookConfigurationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
381
+ // verify required parameter 'v1CreateWebhookConfigurationRequest' is not null or undefined
382
+ (0, common_1.assertParamExists)('v1CreateWebhookConfiguration', 'v1CreateWebhookConfigurationRequest', v1CreateWebhookConfigurationRequest);
383
383
  const localVarPath = `/v1/communications/webhook`;
384
384
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
385
385
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -398,7 +398,40 @@ const DefaultApiAxiosParamCreator = function (configuration) {
398
398
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
399
399
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
400
400
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
401
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1UpdateWebhookConfigurationRequest, localVarRequestOptions, configuration);
401
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateWebhookConfigurationRequest, localVarRequestOptions, configuration);
402
+ return {
403
+ url: (0, common_1.toPathString)(localVarUrlObj),
404
+ options: localVarRequestOptions,
405
+ };
406
+ }),
407
+ /**
408
+ * Test your organization\'s webhooks.
409
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
410
+ * @param {*} [options] Override http request option.
411
+ * @throws {RequiredError}
412
+ */
413
+ v1CreateWebhookTest: (v1CreateWebhookTestRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
414
+ // verify required parameter 'v1CreateWebhookTestRequest' is not null or undefined
415
+ (0, common_1.assertParamExists)('v1CreateWebhookTest', 'v1CreateWebhookTestRequest', v1CreateWebhookTestRequest);
416
+ const localVarPath = `/v1/communications/webhook-test`;
417
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
418
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
419
+ let baseOptions;
420
+ if (configuration) {
421
+ baseOptions = configuration.baseOptions;
422
+ }
423
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
424
+ const localVarHeaderParameter = {};
425
+ const localVarQueryParameter = {};
426
+ // authentication Roles required
427
+ // authentication BearerToken required
428
+ // http bearer authentication required
429
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
430
+ localVarHeaderParameter['Content-Type'] = 'application/json';
431
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
432
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
433
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
434
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateWebhookTestRequest, localVarRequestOptions, configuration);
402
435
  return {
403
436
  url: (0, common_1.toPathString)(localVarUrlObj),
404
437
  options: localVarRequestOptions,
@@ -1450,13 +1483,25 @@ const DefaultApiFp = function (configuration) {
1450
1483
  },
1451
1484
  /**
1452
1485
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
1453
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
1486
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
1487
+ * @param {*} [options] Override http request option.
1488
+ * @throws {RequiredError}
1489
+ */
1490
+ v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest, options) {
1491
+ return __awaiter(this, void 0, void 0, function* () {
1492
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest, options);
1493
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1494
+ });
1495
+ },
1496
+ /**
1497
+ * Test your organization\'s webhooks.
1498
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
1454
1499
  * @param {*} [options] Override http request option.
1455
1500
  * @throws {RequiredError}
1456
1501
  */
1457
- v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest, options) {
1502
+ v1CreateWebhookTest(v1CreateWebhookTestRequest, options) {
1458
1503
  return __awaiter(this, void 0, void 0, function* () {
1459
- const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest, options);
1504
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookTest(v1CreateWebhookTestRequest, options);
1460
1505
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1461
1506
  });
1462
1507
  },
@@ -1867,7 +1912,16 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
1867
1912
  * @throws {RequiredError}
1868
1913
  */
1869
1914
  v1CreateWebhookConfiguration(requestParameters, options) {
1870
- return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
1915
+ return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1CreateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
1916
+ },
1917
+ /**
1918
+ * Test your organization\'s webhooks.
1919
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
1920
+ * @param {*} [options] Override http request option.
1921
+ * @throws {RequiredError}
1922
+ */
1923
+ v1CreateWebhookTest(requestParameters, options) {
1924
+ return localVarFp.v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(axios, basePath));
1871
1925
  },
1872
1926
  /**
1873
1927
  * Delete an image set.
@@ -2187,7 +2241,17 @@ class DefaultApi extends base_1.BaseAPI {
2187
2241
  * @memberof DefaultApi
2188
2242
  */
2189
2243
  v1CreateWebhookConfiguration(requestParameters, options) {
2190
- return (0, exports.DefaultApiFp)(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
2244
+ return (0, exports.DefaultApiFp)(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1CreateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
2245
+ }
2246
+ /**
2247
+ * Test your organization\'s webhooks.
2248
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
2249
+ * @param {*} [options] Override http request option.
2250
+ * @throws {RequiredError}
2251
+ * @memberof DefaultApi
2252
+ */
2253
+ v1CreateWebhookTest(requestParameters, options) {
2254
+ return (0, exports.DefaultApiFp)(this.configuration).v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(this.axios, this.basePath));
2191
2255
  }
2192
2256
  /**
2193
2257
  * Delete an image set.
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](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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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](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.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.4187
8
+ * The version of the OpenAPI document: 1.3.4196
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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](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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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](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.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.4187
8
+ * The version of the OpenAPI document: 1.3.4196
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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](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.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.4187
8
+ * The version of the OpenAPI document: 1.3.4196
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -579,6 +579,56 @@ export interface V1CreateSurveyInstructionRequest {
579
579
  */
580
580
  'firstStepAt'?: string;
581
581
  }
582
+ /**
583
+ *
584
+ * @export
585
+ * @interface V1CreateWebhookConfigurationRequest
586
+ */
587
+ export interface V1CreateWebhookConfigurationRequest {
588
+ /**
589
+ *
590
+ * @type {string}
591
+ * @memberof V1CreateWebhookConfigurationRequest
592
+ */
593
+ 'url': string;
594
+ /**
595
+ *
596
+ * @type {string}
597
+ * @memberof V1CreateWebhookConfigurationRequest
598
+ */
599
+ 'secret': string;
600
+ /**
601
+ *
602
+ * @type {Array<WebhookEvent>}
603
+ * @memberof V1CreateWebhookConfigurationRequest
604
+ */
605
+ 'events': Array<WebhookEvent>;
606
+ /**
607
+ *
608
+ * @type {WebhookAuthType}
609
+ * @memberof V1CreateWebhookConfigurationRequest
610
+ */
611
+ 'authType'?: WebhookAuthType;
612
+ /**
613
+ *
614
+ * @type {string}
615
+ * @memberof V1CreateWebhookConfigurationRequest
616
+ */
617
+ 'authorization'?: string;
618
+ }
619
+ /**
620
+ *
621
+ * @export
622
+ * @interface V1CreateWebhookTestRequest
623
+ */
624
+ export interface V1CreateWebhookTestRequest {
625
+ /**
626
+ *
627
+ * @type {Array<WebhookEvent>}
628
+ * @memberof V1CreateWebhookTestRequest
629
+ */
630
+ 'events': Array<WebhookEvent>;
631
+ }
582
632
  /**
583
633
  *
584
634
  * @export
@@ -1696,43 +1746,6 @@ export interface V1UpdateSatelliteTargetRequest {
1696
1746
  */
1697
1747
  'crossSection'?: number;
1698
1748
  }
1699
- /**
1700
- *
1701
- * @export
1702
- * @interface V1UpdateWebhookConfigurationRequest
1703
- */
1704
- export interface V1UpdateWebhookConfigurationRequest {
1705
- /**
1706
- *
1707
- * @type {string}
1708
- * @memberof V1UpdateWebhookConfigurationRequest
1709
- */
1710
- 'url': string;
1711
- /**
1712
- *
1713
- * @type {string}
1714
- * @memberof V1UpdateWebhookConfigurationRequest
1715
- */
1716
- 'secret': string;
1717
- /**
1718
- *
1719
- * @type {Array<WebhookEvent>}
1720
- * @memberof V1UpdateWebhookConfigurationRequest
1721
- */
1722
- 'events': Array<WebhookEvent>;
1723
- /**
1724
- *
1725
- * @type {WebhookAuthType}
1726
- * @memberof V1UpdateWebhookConfigurationRequest
1727
- */
1728
- 'authType'?: WebhookAuthType;
1729
- /**
1730
- *
1731
- * @type {string}
1732
- * @memberof V1UpdateWebhookConfigurationRequest
1733
- */
1734
- 'authorization'?: string;
1735
- }
1736
1749
  /**
1737
1750
  *
1738
1751
  * @export
@@ -1916,11 +1929,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1916
1929
  v1CreateSurveyInstruction: (v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1917
1930
  /**
1918
1931
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
1919
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
1932
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
1920
1933
  * @param {*} [options] Override http request option.
1921
1934
  * @throws {RequiredError}
1922
1935
  */
1923
- v1CreateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1936
+ v1CreateWebhookConfiguration: (v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1937
+ /**
1938
+ * Test your organization\'s webhooks.
1939
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
1940
+ * @param {*} [options] Override http request option.
1941
+ * @throws {RequiredError}
1942
+ */
1943
+ v1CreateWebhookTest: (v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1924
1944
  /**
1925
1945
  * Delete an image set.
1926
1946
  * @param {string} id
@@ -2172,11 +2192,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2172
2192
  v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
2173
2193
  /**
2174
2194
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
2175
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
2195
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
2196
+ * @param {*} [options] Override http request option.
2197
+ * @throws {RequiredError}
2198
+ */
2199
+ v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
2200
+ /**
2201
+ * Test your organization\'s webhooks.
2202
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
2176
2203
  * @param {*} [options] Override http request option.
2177
2204
  * @throws {RequiredError}
2178
2205
  */
2179
- v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
2206
+ v1CreateWebhookTest(v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
2180
2207
  /**
2181
2208
  * Delete an image set.
2182
2209
  * @param {string} id
@@ -2433,6 +2460,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2433
2460
  * @throws {RequiredError}
2434
2461
  */
2435
2462
  v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
2463
+ /**
2464
+ * Test your organization\'s webhooks.
2465
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
2466
+ * @param {*} [options] Override http request option.
2467
+ * @throws {RequiredError}
2468
+ */
2469
+ v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
2436
2470
  /**
2437
2471
  * Delete an image set.
2438
2472
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
@@ -2706,10 +2740,23 @@ export interface DefaultApiV1CreateSurveyInstructionRequest {
2706
2740
  export interface DefaultApiV1CreateWebhookConfigurationRequest {
2707
2741
  /**
2708
2742
  *
2709
- * @type {V1UpdateWebhookConfigurationRequest}
2743
+ * @type {V1CreateWebhookConfigurationRequest}
2710
2744
  * @memberof DefaultApiV1CreateWebhookConfiguration
2711
2745
  */
2712
- readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest;
2746
+ readonly v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest;
2747
+ }
2748
+ /**
2749
+ * Request parameters for v1CreateWebhookTest operation in DefaultApi.
2750
+ * @export
2751
+ * @interface DefaultApiV1CreateWebhookTestRequest
2752
+ */
2753
+ export interface DefaultApiV1CreateWebhookTestRequest {
2754
+ /**
2755
+ *
2756
+ * @type {V1CreateWebhookTestRequest}
2757
+ * @memberof DefaultApiV1CreateWebhookTest
2758
+ */
2759
+ readonly v1CreateWebhookTestRequest: V1CreateWebhookTestRequest;
2713
2760
  }
2714
2761
  /**
2715
2762
  * Request parameters for v1DeleteImageSet operation in DefaultApi.
@@ -3176,6 +3223,14 @@ export declare class DefaultApi extends BaseAPI {
3176
3223
  * @memberof DefaultApi
3177
3224
  */
3178
3225
  v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
3226
+ /**
3227
+ * Test your organization\'s webhooks.
3228
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
3229
+ * @param {*} [options] Override http request option.
3230
+ * @throws {RequiredError}
3231
+ * @memberof DefaultApi
3232
+ */
3233
+ v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
3179
3234
  /**
3180
3235
  * Delete an image set.
3181
3236
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
package/dist/esm/api.js 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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -370,13 +370,13 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
370
370
  }),
371
371
  /**
372
372
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
373
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
373
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
374
374
  * @param {*} [options] Override http request option.
375
375
  * @throws {RequiredError}
376
376
  */
377
- v1CreateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
378
- // verify required parameter 'v1UpdateWebhookConfigurationRequest' is not null or undefined
379
- assertParamExists('v1CreateWebhookConfiguration', 'v1UpdateWebhookConfigurationRequest', v1UpdateWebhookConfigurationRequest);
377
+ v1CreateWebhookConfiguration: (v1CreateWebhookConfigurationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
378
+ // verify required parameter 'v1CreateWebhookConfigurationRequest' is not null or undefined
379
+ assertParamExists('v1CreateWebhookConfiguration', 'v1CreateWebhookConfigurationRequest', v1CreateWebhookConfigurationRequest);
380
380
  const localVarPath = `/v1/communications/webhook`;
381
381
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
382
382
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -395,7 +395,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
395
395
  setSearchParams(localVarUrlObj, localVarQueryParameter);
396
396
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
397
397
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
398
- localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateWebhookConfigurationRequest, localVarRequestOptions, configuration);
398
+ localVarRequestOptions.data = serializeDataIfNeeded(v1CreateWebhookConfigurationRequest, localVarRequestOptions, configuration);
399
+ return {
400
+ url: toPathString(localVarUrlObj),
401
+ options: localVarRequestOptions,
402
+ };
403
+ }),
404
+ /**
405
+ * Test your organization\'s webhooks.
406
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
407
+ * @param {*} [options] Override http request option.
408
+ * @throws {RequiredError}
409
+ */
410
+ v1CreateWebhookTest: (v1CreateWebhookTestRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
411
+ // verify required parameter 'v1CreateWebhookTestRequest' is not null or undefined
412
+ assertParamExists('v1CreateWebhookTest', 'v1CreateWebhookTestRequest', v1CreateWebhookTestRequest);
413
+ const localVarPath = `/v1/communications/webhook-test`;
414
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
415
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
416
+ let baseOptions;
417
+ if (configuration) {
418
+ baseOptions = configuration.baseOptions;
419
+ }
420
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
421
+ const localVarHeaderParameter = {};
422
+ const localVarQueryParameter = {};
423
+ // authentication Roles required
424
+ // authentication BearerToken required
425
+ // http bearer authentication required
426
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
427
+ localVarHeaderParameter['Content-Type'] = 'application/json';
428
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
429
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
430
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
431
+ localVarRequestOptions.data = serializeDataIfNeeded(v1CreateWebhookTestRequest, localVarRequestOptions, configuration);
399
432
  return {
400
433
  url: toPathString(localVarUrlObj),
401
434
  options: localVarRequestOptions,
@@ -1446,13 +1479,25 @@ export const DefaultApiFp = function (configuration) {
1446
1479
  },
1447
1480
  /**
1448
1481
  * 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
1449
- * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
1482
+ * @param {V1CreateWebhookConfigurationRequest} v1CreateWebhookConfigurationRequest
1483
+ * @param {*} [options] Override http request option.
1484
+ * @throws {RequiredError}
1485
+ */
1486
+ v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest, options) {
1487
+ return __awaiter(this, void 0, void 0, function* () {
1488
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest, options);
1489
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1490
+ });
1491
+ },
1492
+ /**
1493
+ * Test your organization\'s webhooks.
1494
+ * @param {V1CreateWebhookTestRequest} v1CreateWebhookTestRequest
1450
1495
  * @param {*} [options] Override http request option.
1451
1496
  * @throws {RequiredError}
1452
1497
  */
1453
- v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest, options) {
1498
+ v1CreateWebhookTest(v1CreateWebhookTestRequest, options) {
1454
1499
  return __awaiter(this, void 0, void 0, function* () {
1455
- const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest, options);
1500
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateWebhookTest(v1CreateWebhookTestRequest, options);
1456
1501
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1457
1502
  });
1458
1503
  },
@@ -1862,7 +1907,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
1862
1907
  * @throws {RequiredError}
1863
1908
  */
1864
1909
  v1CreateWebhookConfiguration(requestParameters, options) {
1865
- return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
1910
+ return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1CreateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
1911
+ },
1912
+ /**
1913
+ * Test your organization\'s webhooks.
1914
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
1915
+ * @param {*} [options] Override http request option.
1916
+ * @throws {RequiredError}
1917
+ */
1918
+ v1CreateWebhookTest(requestParameters, options) {
1919
+ return localVarFp.v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(axios, basePath));
1866
1920
  },
1867
1921
  /**
1868
1922
  * Delete an image set.
@@ -2181,7 +2235,17 @@ export class DefaultApi extends BaseAPI {
2181
2235
  * @memberof DefaultApi
2182
2236
  */
2183
2237
  v1CreateWebhookConfiguration(requestParameters, options) {
2184
- return DefaultApiFp(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
2238
+ return DefaultApiFp(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1CreateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
2239
+ }
2240
+ /**
2241
+ * Test your organization\'s webhooks.
2242
+ * @param {DefaultApiV1CreateWebhookTestRequest} requestParameters Request parameters.
2243
+ * @param {*} [options] Override http request option.
2244
+ * @throws {RequiredError}
2245
+ * @memberof DefaultApi
2246
+ */
2247
+ v1CreateWebhookTest(requestParameters, options) {
2248
+ return DefaultApiFp(this.configuration).v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(this.axios, this.basePath));
2185
2249
  }
2186
2250
  /**
2187
2251
  * Delete an image set.
@@ -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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js 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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js 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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.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.4187
5
+ * The version of the OpenAPI document: 1.3.4196
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.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](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.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.4187
8
+ * The version of the OpenAPI document: 1.3.4196
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/index.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.4187
7
+ * The version of the OpenAPI document: 1.3.4196
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ourskyai/sda-api",
3
- "version": "1.3.4187",
3
+ "version": "1.3.4196",
4
4
  "description": "OpenAPI client for @ourskyai/sda-api",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {