Skip to content

Commit

Permalink
Automated SDK update from CircleCI (#3)
Browse files Browse the repository at this point in the history 
Co-authored-by: CircleCI SDK Automation Workflow <[email protected]>
  • Loading branch information
@CaryPeeblesFT @kesprysoftware
CaryPeeblesFT and kesprysoftware authored Oct 18, 2024
1 parent 038196b commit 52f7c40
Show file tree
Hide file tree
Showing 19 changed files with 179 additions and 157 deletions.
4 changes: 2 additions & 2 deletions javascript/sample/missions_sample.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,10 @@ async function performOperation(operation, missionsAPI) {
const missionId = await prompt('Enter a Mission ID: ');
const volumes = await getVolumesAsync(missionsAPI, siteId, missionId);
if (Array.isArray(volumes)){
console.log(`num,name,description,surface_desc,sku,surfaceArea,perimeter,cutVolume,fillVolume,threshold,offset,computedDensity,cutMass,fillMass,usesExtracted`);
console.log(`num,name,description,surface_desc,sku,surfaceArea,perimeter,cutVolume,fillVolume,threshold,offset,density,cutMass,fillMass,usesExtracted`);
for (let i = 0; i < volumes.length; i++) {
let volume = volumes[i];
console.log(`${volume["num"]}, ${volume["name"]}, ${volume["description"]}, ${volume["surfaceDesc"]}, ${volume["sku"]}, ${volume["surfaceArea"]}, ${volume["perimeter"]}, ${volume["cutVolume"]}, ${volume["fillVolume"]}, ${volume["threshold"]}, ${volume["offset"]}, ${volume["computedDensity"]}, ${volume["cutMass"]}, ${volume["fillMass"]}, ${volume["usesExtracted"]}`);
console.log(`${volume["num"]}, ${volume["name"]}, ${volume["description"]}, ${volume["surfaceDesc"]}, ${volume["sku"]}, ${volume["surfaceArea"]}, ${volume["perimeter"]}, ${volume["cutVolume"]}, ${volume["fillVolume"]}, ${volume["threshold"]}, ${volume["offset"]}, ${volume["density"]}, ${volume["cutMass"]}, ${volume["fillMass"]}, ${volume["usesExtracted"]}`);
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion javascript/sdk/auth.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
}
}
},
"description": "Authenticates the supplied client ID and secret and returns an OAuth authentication token.",
"operationId": "post_login",
"parameters": [
{
Expand Down Expand Up @@ -63,7 +64,7 @@
"tags": [
{
"name": "v1",
"description": "APIs for authenticating"
"description": "API for authenticating a Kespry client ID and secret."
}
],
"definitions": {
Expand Down
2 changes: 2 additions & 0 deletions javascript/sdk/auth/docs/V1Api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Method | HTTP request | Description


Authenticates the supplied client ID and secret and returns an OAuth authentication token.

### Example
```javascript
var ApplicationAuthorizationApi = require('application_authorization_api');
Expand Down
1 change: 1 addition & 0 deletions javascript/sdk/auth/src/api/V1Api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
*/

/**
* Authenticates the supplied client ID and secret and returns an OAuth authentication token.
* @param {String} grantType Grant type
* @param {module:api/V1Api~postLoginCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/Auth}
Expand Down
96 changes: 54 additions & 42 deletions javascript/sdk/missions.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
}
}
},
"description": "Returns all Sites",
"operationId": "get_sites",
"tags": [
"v1"
Expand All @@ -27,8 +28,8 @@
"/v1/sites/{site_id}/missions": {
"parameters": [
{
"in": "path",
"description": "ID of the site",
"in": "path",
"name": "site_id",
"required": true,
"type": "integer"
Expand All @@ -49,6 +50,7 @@
}
}
},
"description": "Returns all missions for the specified site that are less than 90 days old.",
"operationId": "get_missions",
"tags": [
"v1"
Expand All @@ -58,8 +60,8 @@
"/v1/sites/{site_id}/missions/latest": {
"parameters": [
{
"in": "path",
"description": "ID of the site",
"in": "path",
"name": "site_id",
"required": true,
"type": "integer"
Expand All @@ -77,6 +79,7 @@
}
}
},
"description": "Returns the latest mission for the specified site (if there are any that are less than 90 days old).",
"operationId": "get_missions_latest_for_site",
"tags": [
"v1"
Expand Down Expand Up @@ -118,6 +121,7 @@
}
}
},
"description": "Returns all markers for the specified mission",
"operationId": "get_markers",
"tags": [
"v1"
Expand Down Expand Up @@ -159,6 +163,7 @@
}
}
},
"description": "Returns all volumes for the specified mission. Note that markers of type model volume (marker_type=2) may return two records if multiple surfaces are specified. This data should match the data retrieved from the CSV download from the Volume Report.",
"operationId": "get_marker_volumes",
"tags": [
"v1"
Expand Down Expand Up @@ -199,7 +204,7 @@
"tags": [
{
"name": "v1",
"description": "APIs for accessing Kespry Missions"
"description": "APIs for accessing Kespry Missions. Missions are captured for each Site. Each mission may have multiple markers that represent different ways to analyze the mission data. Volume marker types report volume values."
}
],
"definitions": {
Expand Down Expand Up @@ -236,11 +241,11 @@
},
"created_at": {
"type": "string",
"description": "Date the site was created"
"description": "Date the site was created (UTC)"
},
"update_at": {
"updated_at": {
"type": "string",
"description": "Date the site was update"
"description": "Date the site was update (UTC)"
}
},
"type": "object"
Expand All @@ -256,23 +261,23 @@
},
"uid": {
"type": "string",
"description": "Fly ID"
"description": "Internal image ID used by support"
},
"captured_at": {
"type": "string",
"description": "Date the mission was captured"
"description": "Date the mission was captured (UTC)"
},
"created_at": {
"type": "string",
"description": "Date the mission was created"
"description": "Date the mission was created (UTC)"
},
"updated_at": {
"type": "string",
"description": "Date the mission was updated"
"description": "Date the mission was updated (UTC)"
},
"status": {
"type": "string",
"description": "Mission status"
"description": "Mission status. Values are pending, pending_gps_update, waiting_for_gps_data, complete, preprocessing, waiting_for_upload, processing_error, or manual_processing"
},
"outline": {
"type": "object",
Expand Down Expand Up @@ -313,43 +318,43 @@
},
"marker_type": {
"type": "integer",
"description": "Marker type"
"description": "Marker type, 0: point, 1: cross section, 2: model volume, 3: volume, 4: inventory volume, 5: area, 6: compliance line, 7: markup, 8: external (Firmatek Services)"
},
"shape_type": {
"type": "string",
"description": "Marker type"
"description": "Marker type: Point, LineString or Polygon"
},
"pile_id": {
"type": "integer",
"description": "Pile ID"
},
"known_surface_id": {
"type": "integer",
"description": "Pile ID"
"description": "ID of the known surface if the if the volume_mode is \"known_surface\""
},
"density": {
"type": "number",
"description": "Pile ID"
"description": "Density (kg/m3)"
},
"offset": {
"type": "number",
"description": "Pile ID"
"description": "Volume offset"
},
"fixed_elevation": {
"type": "number",
"description": "Pile ID"
"description": "Elevation to use as the base of the pile if the volume_mode is \"fixed_elevation\" (m)"
},
"geojson": {
"type": "object",
"description": "Geometry of the marker as a GeoJson format in WGS84"
},
"created_at": {
"type": "string",
"description": "Date the marker was created"
"description": "Date the marker was created (UTC)"
},
"updated_at": {
"type": "string",
"description": "Date the marker was update"
"description": "Date the marker was updated (UTC)"
},
"created_by": {
"type": "string",
Expand All @@ -369,27 +374,26 @@
},
"use_extracted": {
"type": "boolean",
"description": "Is the marker locked"
"description": "When true, reported volumes use the feature extracted DSM data"
},
"product_id": {
"type": "integer",
"description": "ID of the product"
"description": "ID of the product used if is_manual is False"
},
"volume_mode": {
"type": "string",
"description": "Volume mode for the marker if it is a volume based marker"
},
"volume": {
"type": "object",
"description": "Volume mode for the marker if it is a volume based marker"
},
"defeatured_volume": {
"type": "object",
"description": "Volume mode for the marker if it is a volume based marker"
"description": "Volume mode for the marker if it is a volume based marker. Values are base_points, fixed_elevation, known_surface or none"
},
"base_points": {
"type": "object",
"description": "Volume mode for the marker if it is a volume based marker"
"description": "Base points used to define the base of the pile if volume_mode is \"base_points\""
},
"messages": {
"type": "array",
"description": "Processing messages. If present is an array of objects of the form { \"code\": \"small_base_points_area\", \"level\": \"warn\", \"message\": \"Your base points only cover a small area. For accurate measurement add more points over a larger area if possible.\"}",
"items": {
"type": "object"
}
}
},
"type": "object"
Expand Down Expand Up @@ -418,47 +422,55 @@
},
"sku": {
"type": "string",
"description": "SKU Number"
"description": "SKU Number",
"example": "123456"
},
"surfaceArea": {
"type": "number",
"description": "Area (m2)"
"description": "Area (m2)",
"example": 411.09
},
"perimeter": {
"type": "number",
"description": "Perimeter (m)"
"description": "Perimeter (m)",
"example": 91.23
},
"cutVolume": {
"type": "number",
"description": "Cut Volume"
"description": "Cut Volume (m3)",
"example": 608.44
},
"fillVolume": {
"type": "number",
"description": "Fill Volume"
"description": "Fill Volume (m3)",
"example": 3.84
},
"threshold": {
"type": "number",
"description": "Minimum Threshold"
},
"offset": {
"type": "number",
"description": "Offset"
"description": "Offset (m3)"
},
"computedDensity": {
"density": {
"type": "number",
"description": "Density"
"description": "Density (kg/m3)",
"example": 1500.0
},
"cutMass": {
"type": "number",
"description": "Cut Mass"
"description": "Cut Mass (kg)",
"example": 912657.94
},
"fillMass": {
"type": "number",
"description": "Fill Mass"
"description": "Fill Mass (kg)",
"example": 5757.52
},
"usesExtracted": {
"type": "boolean",
"description": "Uses Extracted"
"description": "Indicates if the volume values were calculated using the feature extracted DSM"
}
},
"type": "object"
Expand Down
27 changes: 13 additions & 14 deletions javascript/sdk/missions/docs/Marker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,24 @@ Name | Type | Description | Notes
**imageId** | **Number** | Mission ID |
**name** | **String** | Marker name | [optional]
**description** | **String** | Marker description | [optional]
**markerType** | **Number** | Marker type | [optional]
**shapeType** | **String** | Marker type | [optional]
**markerType** | **Number** | Marker type, 0: point, 1: cross section, 2: model volume, 3: volume, 4: inventory volume, 5: area, 6: compliance line, 7: markup, 8: external (Firmatek Services) | [optional]
**shapeType** | **String** | Marker type: Point, LineString or Polygon | [optional]
**pileId** | **Number** | Pile ID | [optional]
**knownSurfaceId** | **Number** | Pile ID | [optional]
**density** | **Number** | Pile ID | [optional]
**offset** | **Number** | Pile ID | [optional]
**fixedElevation** | **Number** | Pile ID | [optional]
**knownSurfaceId** | **Number** | ID of the known surface if the if the volume_mode is \"known_surface\" | [optional]
**density** | **Number** | Density (kg/m3) | [optional]
**offset** | **Number** | Volume offset | [optional]
**fixedElevation** | **Number** | Elevation to use as the base of the pile if the volume_mode is \"fixed_elevation\" (m) | [optional]
**geojson** | **Object** | Geometry of the marker as a GeoJson format in WGS84 | [optional]
**createdAt** | **String** | Date the marker was created | [optional]
**updatedAt** | **String** | Date the marker was update | [optional]
**createdAt** | **String** | Date the marker was created (UTC) | [optional]
**updatedAt** | **String** | Date the marker was updated (UTC) | [optional]
**createdBy** | **String** | User who created the marker | [optional]
**updatedBy** | **String** | User who last updated the marker | [optional]
**locked** | **Boolean** | Is the marker locked | [optional]
**isManual** | **Boolean** | Is the marker manual or assigned to an inventory product | [optional]
**useExtracted** | **Boolean** | Is the marker locked | [optional]
**productId** | **Number** | ID of the product | [optional]
**volumeMode** | **String** | Volume mode for the marker if it is a volume based marker | [optional]
**volume** | **Object** | Volume mode for the marker if it is a volume based marker | [optional]
**defeaturedVolume** | **Object** | Volume mode for the marker if it is a volume based marker | [optional]
**basePoints** | **Object** | Volume mode for the marker if it is a volume based marker | [optional]
**useExtracted** | **Boolean** | When true, reported volumes use the feature extracted DSM data | [optional]
**productId** | **Number** | ID of the product used if is_manual is False | [optional]
**volumeMode** | **String** | Volume mode for the marker if it is a volume based marker. Values are base_points, fixed_elevation, known_surface or none | [optional]
**basePoints** | **Object** | Base points used to define the base of the pile if volume_mode is \"base_points\" | [optional]
**messages** | **[Object]** | Processing messages. If present is an array of objects of the form { \"code\": \"small_base_points_area\", \"level\": \"warn\", \"message\": \"Your base points only cover a small area. For accurate measurement add more points over a larger area if possible.\"} | [optional]


14 changes: 7 additions & 7 deletions javascript/sdk/missions/docs/MarkerVolume.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Name | Type | Description | Notes
**sku** | **String** | SKU Number | [optional]
**surfaceArea** | **Number** | Area (m2) | [optional]
**perimeter** | **Number** | Perimeter (m) | [optional]
**cutVolume** | **Number** | Cut Volume | [optional]
**fillVolume** | **Number** | Fill Volume | [optional]
**cutVolume** | **Number** | Cut Volume (m3) | [optional]
**fillVolume** | **Number** | Fill Volume (m3) | [optional]
**threshold** | **Number** | Minimum Threshold | [optional]
**offset** | **Number** | Offset | [optional]
**computedDensity** | **Number** | Density | [optional]
**cutMass** | **Number** | Cut Mass | [optional]
**fillMass** | **Number** | Fill Mass | [optional]
**usesExtracted** | **Boolean** | Uses Extracted | [optional]
**offset** | **Number** | Offset (m3) | [optional]
**density** | **Number** | Density (kg/m3) | [optional]
**cutMass** | **Number** | Cut Mass (kg) | [optional]
**fillMass** | **Number** | Fill Mass (kg) | [optional]
**usesExtracted** | **Boolean** | Indicates if the volume values were calculated using the feature extracted DSM | [optional]


10 changes: 5 additions & 5 deletions javascript/sdk/missions/docs/Mission.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | Mission ID |
**uid** | **String** | Fly ID | [optional]
**capturedAt** | **String** | Date the mission was captured | [optional]
**createdAt** | **String** | Date the mission was created | [optional]
**updatedAt** | **String** | Date the mission was updated | [optional]
**status** | **String** | Mission status | [optional]
**uid** | **String** | Internal image ID used by support | [optional]
**capturedAt** | **String** | Date the mission was captured (UTC) | [optional]
**createdAt** | **String** | Date the mission was created (UTC) | [optional]
**updatedAt** | **String** | Date the mission was updated (UTC) | [optional]
**status** | **String** | Mission status. Values are pending, pending_gps_update, waiting_for_gps_data, complete, preprocessing, waiting_for_upload, processing_error, or manual_processing | [optional]
**outline** | **Object** | Mission outline as a GeoJson format in WGS84 | [optional]
**missionOutline** | **Object** | Mission outline as a GeoJson format in WGS84 | [optional]
**operator** | **String** | Name of the flight operator | [optional]
Expand Down
Loading

0 comments on commit 52f7c40

Please sign in to comment.