@ourskyai/sda-api 1.3.2816 → 1.3.3181

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * OurSky SDA
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
  *
- * The version of the OpenAPI document: 1.3.2816
+ * The version of the OpenAPI document: 1.3.3181
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -234,6 +234,18 @@ export interface ObservationResult {
      * @memberof ObservationResult
      */
     'dec': number;
+    /**
+     * The measured right ascension calibrated for stellar aberration in degrees
+     * @type {number}
+     * @memberof ObservationResult
+     */
+    'correctedRa'?: number;
+    /**
+     * The measured declination calibrated for stellar aberration in degrees
+     * @type {number}
+     * @memberof ObservationResult
+     */
+    'correctedDec'?: number;
     /**
      *
      * @type {ObservationBoundingBox}
@@ -265,6 +277,18 @@ export interface ObservationResult {
      */
     'features'?: Array<V1ObservationFeature>;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const ObservationState: {
+    readonly PENDING: "PENDING";
+    readonly UNDERWAY: "UNDERWAY";
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+};
+export type ObservationState = typeof ObservationState[keyof typeof ObservationState];
 /**
  *
  * @export
@@ -435,76 +459,46 @@ export interface V1CreateSatelliteTargetRequest {
 /**
  *
  * @export
- * @interface V1CreateSearchTaskRequest
+ * @interface V1CreateSearchInstructionRequest
  */
-export interface V1CreateSearchTaskRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof V1CreateSearchTaskRequest
-     */
-    'nodeId': string;
+export interface V1CreateSearchInstructionRequest {
     /**
      *
      * @type {string}
-     * @memberof V1CreateSearchTaskRequest
+     * @memberof V1CreateSearchInstructionRequest
      */
     'targetId': string;
     /**
      *
      * @type {TrackingType}
-     * @memberof V1CreateSearchTaskRequest
+     * @memberof V1CreateSearchInstructionRequest
      */
-    'trackingType'?: TrackingType;
+    'trackingType': TrackingType;
     /**
      *
-     * @type {Array<V1CreateSearchTaskRequestStepsInner>}
-     * @memberof V1CreateSearchTaskRequest
+     * @type {Array<V1SearchInstructionStep>}
+     * @memberof V1CreateSearchInstructionRequest
      */
-    'steps': Array<V1CreateSearchTaskRequestStepsInner>;
+    'steps': Array<V1SearchInstructionStep>;
 }
 /**
- * Search steps
+ *
  * @export
- * @interface V1CreateSearchTaskRequestStepsInner
+ * @interface V1CreateSurveyInstructionRequest
  */
-export interface V1CreateSearchTaskRequestStepsInner {
-    /**
-     * Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
-     * @type {number}
-     * @memberof V1CreateSearchTaskRequestStepsInner
-     */
-    'ra'?: number;
-    /**
-     * Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
-     * @type {number}
-     * @memberof V1CreateSearchTaskRequestStepsInner
-     */
-    'dec'?: number;
-    /**
-     * Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
-     * @type {number}
-     * @memberof V1CreateSearchTaskRequestStepsInner
-     */
-    'raOffset'?: number;
-    /**
-     * Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
-     * @type {number}
-     * @memberof V1CreateSearchTaskRequestStepsInner
-     */
-    'decOffset'?: number;
+export interface V1CreateSurveyInstructionRequest {
     /**
      *
      * @type {string}
-     * @memberof V1CreateSearchTaskRequestStepsInner
+     * @memberof V1CreateSurveyInstructionRequest
      */
-    'startTime': string;
+    'targetId': string;
     /**
      *
-     * @type {string}
-     * @memberof V1CreateSearchTaskRequestStepsInner
+     * @type {Array<V1SurveyInstructionStep>}
+     * @memberof V1CreateSurveyInstructionRequest
      */
-    'endTime': string;
+    'steps': Array<V1SurveyInstructionStep>;
 }
 /**
  *
@@ -1029,6 +1023,24 @@ export interface V1ObservationStatus {
      * @memberof V1ObservationStatus
      */
     'searchInstructionId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'surveyInstructionId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'completedAt'?: string;
+    /**
+     *
+     * @type {ObservationState}
+     * @memberof V1ObservationStatus
+     */
+    'state': ObservationState;
 }
 /**
  *
@@ -1153,6 +1165,142 @@ export interface V1SatelliteTarget {
      */
     'trackingStatus'?: SatelliteTargetTrackingStatus;
 }
+/**
+ * Search Instruction
+ * @export
+ * @interface V1SearchInstruction
+ */
+export interface V1SearchInstruction {
+    /**
+     *
+     * @type {string}
+     * @memberof V1SearchInstruction
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SearchInstruction
+     */
+    'nodeId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SearchInstruction
+     */
+    'targetId': string;
+    /**
+     *
+     * @type {TrackingType}
+     * @memberof V1SearchInstruction
+     */
+    'trackingType': TrackingType;
+    /**
+     * Each step indicates an observation attempt at a given distance offset in the local spacecraft frame.  Offset values for each step should always be entered in absolute distance offset from the target\'s TLE, not relative to the previous step.
+     * @type {Array<V1SearchInstructionStep>}
+     * @memberof V1SearchInstruction
+     */
+    'steps': Array<V1SearchInstructionStep>;
+}
+/**
+ * Search Instruction Step
+ * @export
+ * @interface V1SearchInstructionStep
+ */
+export interface V1SearchInstructionStep {
+    /**
+     * Along-track offset in the local spacecraft frame.
+     * @type {number}
+     * @memberof V1SearchInstructionStep
+     */
+    'alongTrackOffsetMeters': number;
+    /**
+     * Cross-track offset in the local spacecraft frame.
+     * @type {number}
+     * @memberof V1SearchInstructionStep
+     */
+    'crossTrackOffsetMeters': number;
+    /**
+     * Radial offset in the local spacecraft frame.
+     * @type {number}
+     * @memberof V1SearchInstructionStep
+     */
+    'radialOffsetMeters': number;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SearchInstructionStep
+     */
+    'startTime': string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SearchInstructionStep
+     */
+    'endTime': string;
+}
+/**
+ *
+ * @export
+ * @interface V1SurveyInstruction
+ */
+export interface V1SurveyInstruction {
+    /**
+     *
+     * @type {string}
+     * @memberof V1SurveyInstruction
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SurveyInstruction
+     */
+    'nodeId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SurveyInstruction
+     */
+    'targetId': string;
+    /**
+     * Each step indicates a sidereal observation attempt at a given (Ra, Dec). When supplying coordinates, they should be given in J2000 reference frames using an SGP4 model for propagation.
+     * @type {Array<V1SurveyInstructionStep>}
+     * @memberof V1SurveyInstruction
+     */
+    'steps': Array<V1SurveyInstructionStep>;
+}
+/**
+ * Survey Instruction Step
+ * @export
+ * @interface V1SurveyInstructionStep
+ */
+export interface V1SurveyInstructionStep {
+    /**
+     *
+     * @type {number}
+     * @memberof V1SurveyInstructionStep
+     */
+    'ra': number;
+    /**
+     *
+     * @type {number}
+     * @memberof V1SurveyInstructionStep
+     */
+    'dec': number;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SurveyInstructionStep
+     */
+    'startTime': string;
+    /**
+     *
+     * @type {string}
+     * @memberof V1SurveyInstructionStep
+     */
+    'endTime': string;
+}
 /**
  * Target Correlation
  * @export
@@ -1411,12 +1559,19 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
-     * @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
+     * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
+     * @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    v1CreateSearchInstruction: (v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
+     * @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1CreateSurveyInstruction: (v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
@@ -1445,6 +1600,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     v1DeleteOrganizationTarget: (satelliteTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a search instruction.
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1DeleteSearchInstruction: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a survey instruction.
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1DeleteSurveyInstruction: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Delete a webhook configuration.
      * @param {string} id
@@ -1502,14 +1671,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      */
     v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,  by `searchInstructionId`, or by `surveyInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId` or `surveyInstructionId`, a `before` timestamp is not required.
      * @param {string} [targetId]
      * @param {string} [before]
      * @param {string} [searchInstructionId]
+     * @param {string} [surveyInstructionId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
      * @param {*} [options] Override http request option.
@@ -1524,6 +1694,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     v1GetSatellitePotentials: (satelliteTargetId: string, until: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a satellite target that the OurSky platform can currently track by id.
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSatelliteTarget: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * The available satellite objects that the OurSky platform can currently track.
      * @param {OrbitType} [orbitType]
@@ -1532,6 +1709,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     v1GetSatelliteTargets: (orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSearchInstructions: (before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSurveyInstructions: (before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a TDM.
      * @param {string} tdmId
@@ -1602,12 +1793,19 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
     /**
-     * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
-     * @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
+     * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
+     * @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
+    v1CreateSearchInstruction(v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
+    /**
+     * Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
+     * @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
     /**
      * 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.
      * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
@@ -1636,6 +1834,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     v1DeleteOrganizationTarget(satelliteTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
+    /**
+     * Delete a search instruction.
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1DeleteSearchInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
+    /**
+     * Delete a survey instruction.
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1DeleteSurveyInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
     /**
      * Delete a webhook configuration.
      * @param {string} id
@@ -1693,14 +1905,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      */
     v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
     /**
-     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,  by `searchInstructionId`, or by `surveyInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId` or `surveyInstructionId`, a `before` timestamp is not required.
      * @param {string} [targetId]
      * @param {string} [before]
      * @param {string} [searchInstructionId]
+     * @param {string} [surveyInstructionId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
+    v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
     /**
      * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
      * @param {*} [options] Override http request option.
@@ -1715,6 +1928,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     v1GetSatellitePotentials(satelliteTargetId: string, until: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
+    /**
+     * Get a satellite target that the OurSky platform can currently track by id.
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSatelliteTarget(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SatelliteTarget>>;
     /**
      * The available satellite objects that the OurSky platform can currently track.
      * @param {OrbitType} [orbitType]
@@ -1723,6 +1943,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     v1GetSatelliteTargets(orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetSatelliteTargetsResponse>>;
+    /**
+     * Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSearchInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SearchInstruction>>>;
+    /**
+     * Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSurveyInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SurveyInstruction>>>;
     /**
      * Get a TDM.
      * @param {string} tdmId
@@ -1793,12 +2027,19 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
     /**
-     * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
-     * @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
+     * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
+     * @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
+    /**
+     * Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
+     * @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
+    v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
     /**
      * 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.
      * @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
@@ -1827,6 +2068,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
+    /**
+     * Delete a search instruction.
+     * @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1DeleteSearchInstruction(requestParameters: DefaultApiV1DeleteSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
+    /**
+     * Delete a survey instruction.
+     * @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1DeleteSurveyInstruction(requestParameters: DefaultApiV1DeleteSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
     /**
      * Delete a webhook configuration.
      * @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
@@ -1883,7 +2138,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      */
     v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
     /**
-     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,  by `searchInstructionId`, or by `surveyInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId` or `surveyInstructionId`, a `before` timestamp is not required.
      * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1902,6 +2157,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>>;
+    /**
+     * Get a satellite target that the OurSky platform can currently track by id.
+     * @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSatelliteTarget(requestParameters: DefaultApiV1GetSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1SatelliteTarget>;
     /**
      * The available satellite objects that the OurSky platform can currently track.
      * @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
@@ -1909,6 +2171,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<V1GetSatelliteTargetsResponse>;
+    /**
+     * Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSearchInstructions(requestParameters?: DefaultApiV1GetSearchInstructionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SearchInstruction>>;
+    /**
+     * Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    v1GetSurveyInstructions(requestParameters?: DefaultApiV1GetSurveyInstructionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SurveyInstruction>>;
     /**
      * Get a TDM.
      * @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
@@ -1997,17 +2273,30 @@ export interface DefaultApiV1CreateSatelliteTargetRequest {
     readonly v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest;
 }
 /**
- * Request parameters for v1CreateSearchTask operation in DefaultApi.
+ * Request parameters for v1CreateSearchInstruction operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1CreateSearchInstructionRequest
+ */
+export interface DefaultApiV1CreateSearchInstructionRequest {
+    /**
+     *
+     * @type {V1CreateSearchInstructionRequest}
+     * @memberof DefaultApiV1CreateSearchInstruction
+     */
+    readonly v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest;
+}
+/**
+ * Request parameters for v1CreateSurveyInstruction operation in DefaultApi.
  * @export
- * @interface DefaultApiV1CreateSearchTaskRequest
+ * @interface DefaultApiV1CreateSurveyInstructionRequest
  */
-export interface DefaultApiV1CreateSearchTaskRequest {
+export interface DefaultApiV1CreateSurveyInstructionRequest {
     /**
      *
-     * @type {V1CreateSearchTaskRequest}
-     * @memberof DefaultApiV1CreateSearchTask
+     * @type {V1CreateSurveyInstructionRequest}
+     * @memberof DefaultApiV1CreateSurveyInstruction
      */
-    readonly v1CreateSearchTaskRequest: V1CreateSearchTaskRequest;
+    readonly v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest;
 }
 /**
  * Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
@@ -2061,6 +2350,32 @@ export interface DefaultApiV1DeleteOrganizationTargetRequest {
      */
     readonly satelliteTargetId: string;
 }
+/**
+ * Request parameters for v1DeleteSearchInstruction operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1DeleteSearchInstructionRequest
+ */
+export interface DefaultApiV1DeleteSearchInstructionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DefaultApiV1DeleteSearchInstruction
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for v1DeleteSurveyInstruction operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1DeleteSurveyInstructionRequest
+ */
+export interface DefaultApiV1DeleteSurveyInstructionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DefaultApiV1DeleteSurveyInstruction
+     */
+    readonly id: string;
+}
 /**
  * Request parameters for v1DeleteWebhookConfiguration operation in DefaultApi.
  * @export
@@ -2182,6 +2497,12 @@ export interface DefaultApiV1GetObservationStatusesRequest {
      * @memberof DefaultApiV1GetObservationStatuses
      */
     readonly searchInstructionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DefaultApiV1GetObservationStatuses
+     */
+    readonly surveyInstructionId?: string;
 }
 /**
  * Request parameters for v1GetSatellitePotentials operation in DefaultApi.
@@ -2202,6 +2523,19 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
      */
     readonly until: string;
 }
+/**
+ * Request parameters for v1GetSatelliteTarget operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetSatelliteTargetRequest
+ */
+export interface DefaultApiV1GetSatelliteTargetRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DefaultApiV1GetSatelliteTarget
+     */
+    readonly id: string;
+}
 /**
  * Request parameters for v1GetSatelliteTargets operation in DefaultApi.
  * @export
@@ -2221,6 +2555,32 @@ export interface DefaultApiV1GetSatelliteTargetsRequest {
      */
     readonly noradId?: string;
 }
+/**
+ * Request parameters for v1GetSearchInstructions operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetSearchInstructionsRequest
+ */
+export interface DefaultApiV1GetSearchInstructionsRequest {
+    /**
+     * The timestamp to get the next page of results. Defaults to the current time.
+     * @type {string}
+     * @memberof DefaultApiV1GetSearchInstructions
+     */
+    readonly before?: string;
+}
+/**
+ * Request parameters for v1GetSurveyInstructions operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetSurveyInstructionsRequest
+ */
+export interface DefaultApiV1GetSurveyInstructionsRequest {
+    /**
+     * The timestamp to get the next page of results. Defaults to the current time.
+     * @type {string}
+     * @memberof DefaultApiV1GetSurveyInstructions
+     */
+    readonly before?: string;
+}
 /**
  * Request parameters for v1GetTdm operation in DefaultApi.
  * @export
@@ -2319,13 +2679,21 @@ export declare class DefaultApi extends BaseAPI {
      */
     v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
     /**
-     * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
-     * @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
+     * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
+     * @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
+    /**
+     * Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
+     * @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
+    v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
     /**
      * 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.
      * @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
@@ -2358,6 +2726,22 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
+    /**
+     * Delete a search instruction.
+     * @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    v1DeleteSearchInstruction(requestParameters: DefaultApiV1DeleteSearchInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
+    /**
+     * Delete a survey instruction.
+     * @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    v1DeleteSurveyInstruction(requestParameters: DefaultApiV1DeleteSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
     /**
      * Delete a webhook configuration.
      * @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
@@ -2422,7 +2806,7 @@ export declare class DefaultApi extends BaseAPI {
      */
     v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
     /**
-     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,  by `searchInstructionId`, or by `surveyInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId` or `surveyInstructionId`, a `before` timestamp is not required.
      * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -2444,6 +2828,14 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatellitePotential[], any>>;
+    /**
+     * Get a satellite target that the OurSky platform can currently track by id.
+     * @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    v1GetSatelliteTarget(requestParameters: DefaultApiV1GetSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatelliteTarget, any>>;
     /**
      * The available satellite objects that the OurSky platform can currently track.
      * @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
@@ -2452,6 +2844,22 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GetSatelliteTargetsResponse, any>>;
+    /**
+     * Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    v1GetSearchInstructions(requestParameters?: DefaultApiV1GetSearchInstructionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SearchInstruction[], any>>;
+    /**
+     * Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
+     * @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    v1GetSurveyInstructions(requestParameters?: DefaultApiV1GetSurveyInstructionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SurveyInstruction[], any>>;
     /**
      * Get a TDM.
      * @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.