@ourskyai/sda-api 1.4.133 → 1.4.158

package/docs/DefaultApi.md

@@ -37,6 +37,8 @@ All URIs are relative to *https://api.prod.oursky.ai*
 |[**v1GetObservationStatuses**](#v1getobservationstatuses) | **GET** /v1/observation-statuses | |
 |[**v1GetOrganizationSatellitePotentials**](#v1getorganizationsatellitepotentials) | **GET** /v1/organization-target-potentials | |
 |[**v1GetOrganizationTarget**](#v1getorganizationtarget) | **GET** /v1/organization-target | |
+|[**v1GetOrganizationTargetLightcurve**](#v1getorganizationtargetlightcurve) | **GET** /v1/organization-target/lightcurve | |
+|[**v1GetOrganizationTargetLightcurves**](#v1getorganizationtargetlightcurves) | **GET** /v1/organization-target/lightcurves | |
 |[**v1GetOrganizationTargets**](#v1getorganizationtargets) | **GET** /v1/organization-targets | |
 |[**v1GetResolvedImageMetadata**](#v1getresolvedimagemetadata) | **GET** /v1/resolved-image-metadata | |
 |[**v1GetResolvedImageObservations**](#v1getresolvedimageobservations) | **GET** /v1/resolved-image-observations | |
@@ -1800,6 +1802,120 @@ const { status, data } = await apiInstance.v1GetOrganizationTarget(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **v1GetOrganizationTargetLightcurve**
+> V1Lightcurve v1GetOrganizationTargetLightcurve()
+
+Get the latest lightcurve for a satellite target the organization is tracking. Requires the light curves product feature.
+
+### Example
+
+```typescript
+import {
+    DefaultApi,
+    Configuration
+} from '@ourskyai/sda-api';
+
+const configuration = new Configuration();
+const apiInstance = new DefaultApi(configuration);
+
+let organizationTargetId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.v1GetOrganizationTargetLightcurve(
+    organizationTargetId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationTargetId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**V1Lightcurve**
+
+### Authorization
+
+[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | V1Lightcurve |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **v1GetOrganizationTargetLightcurves**
+> V1GetLightcurvesResponse v1GetOrganizationTargetLightcurves()
+
+Get lightcurves for a satellite target the organization is tracking. Requires the light curves product feature.
+
+### Example
+
+```typescript
+import {
+    DefaultApi,
+    Configuration
+} from '@ourskyai/sda-api';
+
+const configuration = new Configuration();
+const apiInstance = new DefaultApi(configuration);
+
+let organizationTargetId: string; // (default to undefined)
+let startDate: string; // (optional) (default to undefined)
+let endDate: string; // (optional) (default to undefined)
+let offset: number; // (optional) (default to 0)
+let limit: number; // (optional) (default to 50)
+
+const { status, data } = await apiInstance.v1GetOrganizationTargetLightcurves(
+    organizationTargetId,
+    startDate,
+    endDate,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationTargetId** | [**string**] |  | defaults to undefined|
+| **startDate** | [**string**] |  | (optional) defaults to undefined|
+| **endDate** | [**string**] |  | (optional) defaults to undefined|
+| **offset** | [**number**] |  | (optional) defaults to 0|
+| **limit** | [**number**] |  | (optional) defaults to 50|
+
+
+### Return type
+
+**V1GetLightcurvesResponse**
+
+### Authorization
+
+[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | V1GetLightcurvesResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **v1GetOrganizationTargets**
 > Array<V1OrganizationTarget> v1GetOrganizationTargets()
 

package/docs/LightcurveDataType.md

@@ -0,0 +1,11 @@
+# LightcurveDataType
+
+RAW for time-series photometry data with timestamps, PHASE_FOLDED for phase-folded data by rotation period
+
+## Enum
+
+* `RAW` (value: `'RAW'`)
+
+* `PHASE_FOLDED` (value: `'PHASE_FOLDED'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PeriodDetectionStatus.md

@@ -0,0 +1,17 @@
+# PeriodDetectionStatus
+
+Outcome of period detection attempt
+
+## Enum
+
+* `NOT_ATTEMPTED` (value: `'NOT_ATTEMPTED'`)
+
+* `INSUFFICIENT_DATA` (value: `'INSUFFICIENT_DATA'`)
+
+* `SUCCESS` (value: `'SUCCESS'`)
+
+* `LOW_CONFIDENCE` (value: `'LOW_CONFIDENCE'`)
+
+* `AMBIGUOUS` (value: `'AMBIGUOUS'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PeriodicityAlgorithm.md

@@ -0,0 +1,15 @@
+# PeriodicityAlgorithm
+
+Algorithm used to detect rotation period. NONE if period detection was not attempted.
+
+## Enum
+
+* `NONE` (value: `'NONE'`)
+
+* `STRING_LENGTH` (value: `'STRING_LENGTH'`)
+
+* `PHASE_DISPERSION_MINIMIZATION` (value: `'PHASE_DISPERSION_MINIMIZATION'`)
+
+* `BAYESIAN_PERIOD_SEARCH` (value: `'BAYESIAN_PERIOD_SEARCH'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1GetLightcurvesResponse.md

@@ -0,0 +1,22 @@
+# V1GetLightcurvesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lightcurves** | [**Array<V1Lightcurve>**](V1Lightcurve.md) |  | [default to undefined]
+**total** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetLightcurvesResponse } from '@ourskyai/sda-api';
+
+const instance: V1GetLightcurvesResponse = {
+    lightcurves,
+    total,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1Lightcurve.md

@@ -0,0 +1,50 @@
+# V1Lightcurve
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**targetId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**dataSpanStart** | **string** |  | [default to undefined]
+**dataSpanEnd** | **string** |  | [default to undefined]
+**dataType** | [**LightcurveDataType**](LightcurveDataType.md) |  | [default to undefined]
+**rawLightcurveId** | **string** | For phase-folded lightcurves, references the source raw lightcurve | [optional] [default to undefined]
+**totalPointCount** | **number** | Total number of points in the raw lightcurve | [default to undefined]
+**periodDetectionStatus** | [**PeriodDetectionStatus**](PeriodDetectionStatus.md) |  | [default to undefined]
+**periodicityAlgorithm** | [**PeriodicityAlgorithm**](PeriodicityAlgorithm.md) |  | [optional] [default to undefined]
+**periodSeconds** | **number** | Detected rotation period in seconds (null if not periodic) | [optional] [default to undefined]
+**periodConfidence** | **number** | Confidence score 0-1 for the detected period | [optional] [default to undefined]
+**periodSearchMinSeconds** | **number** | Minimum period searched | [optional] [default to undefined]
+**periodSearchMaxSeconds** | **number** | Maximum period searched | [optional] [default to undefined]
+**validPointCount** | **number** | Number of points that passed Nyquist filtering for the best period | [optional] [default to undefined]
+**points** | [**Array<V1LightcurveDataPoint>**](V1LightcurveDataPoint.md) | Photometry measurements | [default to undefined]
+
+## Example
+
+```typescript
+import { V1Lightcurve } from '@ourskyai/sda-api';
+
+const instance: V1Lightcurve = {
+    id,
+    targetId,
+    createdAt,
+    dataSpanStart,
+    dataSpanEnd,
+    dataType,
+    rawLightcurveId,
+    totalPointCount,
+    periodDetectionStatus,
+    periodicityAlgorithm,
+    periodSeconds,
+    periodConfidence,
+    periodSearchMinSeconds,
+    periodSearchMaxSeconds,
+    validPointCount,
+    points,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1LightcurveDataPoint.md

@@ -0,0 +1,28 @@
+# V1LightcurveDataPoint
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **string** |  | [default to undefined]
+**fractionalPeriod** | **number** | Phase within the rotation period (0.0-1.0). Only present for PHASE_FOLDED data. | [optional] [default to undefined]
+**standardMagnitude** | **number** | Magnitude normalized to standard range (1000 km) and solar phase angle (90 degrees) | [default to undefined]
+**rawMagnitude** | **number** | Observed apparent magnitude | [default to undefined]
+**solarPhaseAngleRadians** | **number** | Sun-satellite-observer angle in radians | [default to undefined]
+
+## Example
+
+```typescript
+import { V1LightcurveDataPoint } from '@ourskyai/sda-api';
+
+const instance: V1LightcurveDataPoint = {
+    timestamp,
+    fractionalPeriod,
+    standardMagnitude,
+    rawMagnitude,
+    solarPhaseAngleRadians,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

@@ -4,7 +4,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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs.  Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
  *
- * The version of the OpenAPI document: 1.4.133
+ * The version of the OpenAPI document: 1.4.158
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ourskyai/sda-api",
-  "version": "1.4.133",
+  "version": "1.4.158",
   "description": "OpenAPI client for @ourskyai/sda-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {