diff --git a/javascript/sample/missions_sample.js b/javascript/sample/missions_sample.js index 918824d..46665d5 100644 --- a/javascript/sample/missions_sample.js +++ b/javascript/sample/missions_sample.js @@ -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"]}`); } } } diff --git a/javascript/sdk/auth.json b/javascript/sdk/auth.json index b67007a..cdb5b26 100644 --- a/javascript/sdk/auth.json +++ b/javascript/sdk/auth.json @@ -12,6 +12,7 @@ } } }, + "description": "Authenticates the supplied client ID and secret and returns an OAuth authentication token.", "operationId": "post_login", "parameters": [ { @@ -63,7 +64,7 @@ "tags": [ { "name": "v1", - "description": "APIs for authenticating" + "description": "API for authenticating a Kespry client ID and secret." } ], "definitions": { diff --git a/javascript/sdk/auth/docs/V1Api.md b/javascript/sdk/auth/docs/V1Api.md index 31da4a5..120f3ef 100644 --- a/javascript/sdk/auth/docs/V1Api.md +++ b/javascript/sdk/auth/docs/V1Api.md @@ -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'); diff --git a/javascript/sdk/auth/src/api/V1Api.js b/javascript/sdk/auth/src/api/V1Api.js index 8b8a037..8e11c15 100644 --- a/javascript/sdk/auth/src/api/V1Api.js +++ b/javascript/sdk/auth/src/api/V1Api.js @@ -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} diff --git a/javascript/sdk/missions.json b/javascript/sdk/missions.json index 9a24c69..5897461 100644 --- a/javascript/sdk/missions.json +++ b/javascript/sdk/missions.json @@ -18,6 +18,7 @@ } } }, + "description": "Returns all Sites", "operationId": "get_sites", "tags": [ "v1" @@ -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" @@ -49,6 +50,7 @@ } } }, + "description": "Returns all missions for the specified site that are less than 90 days old.", "operationId": "get_missions", "tags": [ "v1" @@ -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" @@ -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" @@ -118,6 +121,7 @@ } } }, + "description": "Returns all markers for the specified mission", "operationId": "get_markers", "tags": [ "v1" @@ -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" @@ -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": { @@ -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" @@ -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", @@ -313,11 +318,11 @@ }, "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", @@ -325,19 +330,19 @@ }, "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", @@ -345,11 +350,11 @@ }, "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", @@ -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" @@ -418,23 +422,28 @@ }, "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", @@ -442,23 +451,26 @@ }, "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" diff --git a/javascript/sdk/missions/docs/Marker.md b/javascript/sdk/missions/docs/Marker.md index 665dc63..11cc0de 100644 --- a/javascript/sdk/missions/docs/Marker.md +++ b/javascript/sdk/missions/docs/Marker.md @@ -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] diff --git a/javascript/sdk/missions/docs/MarkerVolume.md b/javascript/sdk/missions/docs/MarkerVolume.md index 2a33be9..fdd16ce 100644 --- a/javascript/sdk/missions/docs/MarkerVolume.md +++ b/javascript/sdk/missions/docs/MarkerVolume.md @@ -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] diff --git a/javascript/sdk/missions/docs/Mission.md b/javascript/sdk/missions/docs/Mission.md index 7100f34..3e75480 100644 --- a/javascript/sdk/missions/docs/Mission.md +++ b/javascript/sdk/missions/docs/Mission.md @@ -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] diff --git a/javascript/sdk/missions/docs/Site.md b/javascript/sdk/missions/docs/Site.md index 21f0393..686cd99 100644 --- a/javascript/sdk/missions/docs/Site.md +++ b/javascript/sdk/missions/docs/Site.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **centerLat** | **Number** | Center latitude in WGS84 | [optional] **centerLng** | **Number** | Center longitude in WGS84 | [optional] **outline** | **Object** | Site outline as a GeoJson format in WGS84 | [optional] -**createdAt** | **String** | Date the site was created | [optional] -**updateAt** | **String** | Date the site was update | [optional] +**createdAt** | **String** | Date the site was created (UTC) | [optional] +**updatedAt** | **String** | Date the site was update (UTC) | [optional] diff --git a/javascript/sdk/missions/docs/V1Api.md b/javascript/sdk/missions/docs/V1Api.md index ddda6ec..ad0bc9c 100644 --- a/javascript/sdk/missions/docs/V1Api.md +++ b/javascript/sdk/missions/docs/V1Api.md @@ -17,6 +17,8 @@ Method | HTTP request | 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. + ### Example ```javascript var FirmatekMissionsApi = require('firmatek_missions_api'); @@ -71,6 +73,8 @@ Name | Type | Description | Notes +Returns all markers for the specified mission + ### Example ```javascript var FirmatekMissionsApi = require('firmatek_missions_api'); @@ -125,6 +129,8 @@ Name | Type | Description | Notes +Returns all missions for the specified site that are less than 90 days old. + ### Example ```javascript var FirmatekMissionsApi = require('firmatek_missions_api'); @@ -176,6 +182,8 @@ Name | Type | Description | Notes +Returns the latest mission for the specified site (if there are any that are less than 90 days old). + ### Example ```javascript var FirmatekMissionsApi = require('firmatek_missions_api'); @@ -227,6 +235,8 @@ Name | Type | Description | Notes +Returns all Sites + ### Example ```javascript var FirmatekMissionsApi = require('firmatek_missions_api'); diff --git a/javascript/sdk/missions/src/api/V1Api.js b/javascript/sdk/missions/src/api/V1Api.js index 1a0b213..018bcf8 100644 --- a/javascript/sdk/missions/src/api/V1Api.js +++ b/javascript/sdk/missions/src/api/V1Api.js @@ -56,6 +56,7 @@ */ /** + * 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. * @param {Number} missionId ID of the mission * @param {Number} siteId ID of the site * @param {module:api/V1Api~getMarkerVolumesCallback} callback The callback function, accepting three arguments: error, data, response @@ -109,6 +110,7 @@ */ /** + * Returns all markers for the specified mission * @param {Number} missionId ID of the mission * @param {Number} siteId ID of the site * @param {module:api/V1Api~getMarkersCallback} callback The callback function, accepting three arguments: error, data, response @@ -162,6 +164,7 @@ */ /** + * Returns all missions for the specified site that are less than 90 days old. * @param {Number} siteId ID of the site * @param {module:api/V1Api~getMissionsCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {@link Array.} @@ -208,6 +211,7 @@ */ /** + * Returns the latest mission for the specified site (if there are any that are less than 90 days old). * @param {Number} siteId ID of the site * @param {module:api/V1Api~getMissionsLatestForSiteCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {@link module:model/Mission} @@ -254,6 +258,7 @@ */ /** + * Returns all Sites * @param {module:api/V1Api~getSitesCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {@link Array.} */ diff --git a/javascript/sdk/missions/src/model/Marker.js b/javascript/sdk/missions/src/model/Marker.js index 9595e33..3ddd809 100644 --- a/javascript/sdk/missions/src/model/Marker.js +++ b/javascript/sdk/missions/src/model/Marker.js @@ -100,12 +100,10 @@ obj.productId = ApiClient.convertToType(data['product_id'], 'Number'); if (data.hasOwnProperty('volume_mode')) obj.volumeMode = ApiClient.convertToType(data['volume_mode'], 'String'); - if (data.hasOwnProperty('volume')) - obj.volume = ApiClient.convertToType(data['volume'], Object); - if (data.hasOwnProperty('defeatured_volume')) - obj.defeaturedVolume = ApiClient.convertToType(data['defeatured_volume'], Object); if (data.hasOwnProperty('base_points')) obj.basePoints = ApiClient.convertToType(data['base_points'], Object); + if (data.hasOwnProperty('messages')) + obj.messages = ApiClient.convertToType(data['messages'], [Object]); } return obj; } @@ -135,13 +133,13 @@ exports.prototype.description = undefined; /** - * Marker type + * 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) * @member {Number} markerType */ exports.prototype.markerType = undefined; /** - * Marker type + * Marker type: Point, LineString or Polygon * @member {String} shapeType */ exports.prototype.shapeType = undefined; @@ -153,25 +151,25 @@ exports.prototype.pileId = undefined; /** - * Pile ID + * ID of the known surface if the if the volume_mode is \"known_surface\" * @member {Number} knownSurfaceId */ exports.prototype.knownSurfaceId = undefined; /** - * Pile ID + * Density (kg/m3) * @member {Number} density */ exports.prototype.density = undefined; /** - * Pile ID + * Volume offset * @member {Number} offset */ exports.prototype.offset = undefined; /** - * Pile ID + * Elevation to use as the base of the pile if the volume_mode is \"fixed_elevation\" (m) * @member {Number} fixedElevation */ exports.prototype.fixedElevation = undefined; @@ -183,13 +181,13 @@ exports.prototype.geojson = undefined; /** - * Date the marker was created + * Date the marker was created (UTC) * @member {String} createdAt */ exports.prototype.createdAt = undefined; /** - * Date the marker was update + * Date the marker was updated (UTC) * @member {String} updatedAt */ exports.prototype.updatedAt = undefined; @@ -219,40 +217,34 @@ exports.prototype.isManual = undefined; /** - * Is the marker locked + * When true, reported volumes use the feature extracted DSM data * @member {Boolean} useExtracted */ exports.prototype.useExtracted = undefined; /** - * ID of the product + * ID of the product used if is_manual is False * @member {Number} productId */ exports.prototype.productId = undefined; /** - * Volume mode for the marker if it is a volume based marker + * Volume mode for the marker if it is a volume based marker. Values are base_points, fixed_elevation, known_surface or none * @member {String} volumeMode */ exports.prototype.volumeMode = undefined; /** - * Volume mode for the marker if it is a volume based marker - * @member {Object} volume - */ - exports.prototype.volume = undefined; - - /** - * Volume mode for the marker if it is a volume based marker - * @member {Object} defeaturedVolume + * Base points used to define the base of the pile if volume_mode is \"base_points\" + * @member {Object} basePoints */ - exports.prototype.defeaturedVolume = undefined; + exports.prototype.basePoints = undefined; /** - * Volume mode for the marker if it is a volume based marker - * @member {Object} basePoints + * 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.\"} + * @member {Array.} messages */ - exports.prototype.basePoints = undefined; + exports.prototype.messages = undefined; return exports; diff --git a/javascript/sdk/missions/src/model/MarkerVolume.js b/javascript/sdk/missions/src/model/MarkerVolume.js index 4e5e906..5297ab2 100644 --- a/javascript/sdk/missions/src/model/MarkerVolume.js +++ b/javascript/sdk/missions/src/model/MarkerVolume.js @@ -80,8 +80,8 @@ obj.threshold = ApiClient.convertToType(data['threshold'], 'Number'); if (data.hasOwnProperty('offset')) obj.offset = ApiClient.convertToType(data['offset'], 'Number'); - if (data.hasOwnProperty('computedDensity')) - obj.computedDensity = ApiClient.convertToType(data['computedDensity'], 'Number'); + if (data.hasOwnProperty('density')) + obj.density = ApiClient.convertToType(data['density'], 'Number'); if (data.hasOwnProperty('cutMass')) obj.cutMass = ApiClient.convertToType(data['cutMass'], 'Number'); if (data.hasOwnProperty('fillMass')) @@ -135,13 +135,13 @@ exports.prototype.perimeter = undefined; /** - * Cut Volume + * Cut Volume (m3) * @member {Number} cutVolume */ exports.prototype.cutVolume = undefined; /** - * Fill Volume + * Fill Volume (m3) * @member {Number} fillVolume */ exports.prototype.fillVolume = undefined; @@ -153,31 +153,31 @@ exports.prototype.threshold = undefined; /** - * Offset + * Offset (m3) * @member {Number} offset */ exports.prototype.offset = undefined; /** - * Density - * @member {Number} computedDensity + * Density (kg/m3) + * @member {Number} density */ - exports.prototype.computedDensity = undefined; + exports.prototype.density = undefined; /** - * Cut Mass + * Cut Mass (kg) * @member {Number} cutMass */ exports.prototype.cutMass = undefined; /** - * Fill Mass + * Fill Mass (kg) * @member {Number} fillMass */ exports.prototype.fillMass = undefined; /** - * Uses Extracted + * Indicates if the volume values were calculated using the feature extracted DSM * @member {Boolean} usesExtracted */ exports.prototype.usesExtracted = undefined; diff --git a/javascript/sdk/missions/src/model/Mission.js b/javascript/sdk/missions/src/model/Mission.js index b51f4f5..4ecc654 100644 --- a/javascript/sdk/missions/src/model/Mission.js +++ b/javascript/sdk/missions/src/model/Mission.js @@ -85,31 +85,31 @@ exports.prototype.id = undefined; /** - * Fly ID + * Internal image ID used by support * @member {String} uid */ exports.prototype.uid = undefined; /** - * Date the mission was captured + * Date the mission was captured (UTC) * @member {String} capturedAt */ exports.prototype.capturedAt = undefined; /** - * Date the mission was created + * Date the mission was created (UTC) * @member {String} createdAt */ exports.prototype.createdAt = undefined; /** - * Date the mission was updated + * Date the mission was updated (UTC) * @member {String} updatedAt */ exports.prototype.updatedAt = undefined; /** - * Mission status + * Mission status. Values are pending, pending_gps_update, waiting_for_gps_data, complete, preprocessing, waiting_for_upload, processing_error, or manual_processing * @member {String} status */ exports.prototype.status = undefined; diff --git a/javascript/sdk/missions/src/model/Site.js b/javascript/sdk/missions/src/model/Site.js index f006a11..acb5e8c 100644 --- a/javascript/sdk/missions/src/model/Site.js +++ b/javascript/sdk/missions/src/model/Site.js @@ -74,8 +74,8 @@ obj.outline = ApiClient.convertToType(data['outline'], Object); if (data.hasOwnProperty('created_at')) obj.createdAt = ApiClient.convertToType(data['created_at'], 'String'); - if (data.hasOwnProperty('update_at')) - obj.updateAt = ApiClient.convertToType(data['update_at'], 'String'); + if (data.hasOwnProperty('updated_at')) + obj.updatedAt = ApiClient.convertToType(data['updated_at'], 'String'); } return obj; } @@ -117,16 +117,16 @@ exports.prototype.outline = undefined; /** - * Date the site was created + * Date the site was created (UTC) * @member {String} createdAt */ exports.prototype.createdAt = undefined; /** - * Date the site was update - * @member {String} updateAt + * Date the site was update (UTC) + * @member {String} updatedAt */ - exports.prototype.updateAt = undefined; + exports.prototype.updatedAt = undefined; return exports; diff --git a/javascript/sdk/missions/test/api/V1Api.spec.js b/javascript/sdk/missions/test/api/V1Api.spec.js index e32a821..1c428c5 100644 --- a/javascript/sdk/missions/test/api/V1Api.spec.js +++ b/javascript/sdk/missions/test/api/V1Api.spec.js @@ -63,25 +63,25 @@ expect(data.surfaceDesc).to.be.a('string'); expect(data.surfaceDesc).to.be(""); expect(data.sku).to.be.a('string'); - expect(data.sku).to.be(""); + expect(data.sku).to.be("123456"); expect(data.surfaceArea).to.be.a('number'); - expect(data.surfaceArea).to.be(); + expect(data.surfaceArea).to.be(411.09); expect(data.perimeter).to.be.a('number'); - expect(data.perimeter).to.be(); + expect(data.perimeter).to.be(91.23); expect(data.cutVolume).to.be.a('number'); - expect(data.cutVolume).to.be(); + expect(data.cutVolume).to.be(608.44); expect(data.fillVolume).to.be.a('number'); - expect(data.fillVolume).to.be(); + expect(data.fillVolume).to.be(3.84); expect(data.threshold).to.be.a('number'); expect(data.threshold).to.be(); expect(data.offset).to.be.a('number'); expect(data.offset).to.be(); - expect(data.computedDensity).to.be.a('number'); - expect(data.computedDensity).to.be(); + expect(data.density).to.be.a('number'); + expect(data.density).to.be(1500.0); expect(data.cutMass).to.be.a('number'); - expect(data.cutMass).to.be(); + expect(data.cutMass).to.be(912657.94); expect(data.fillMass).to.be.a('number'); - expect(data.fillMass).to.be(); + expect(data.fillMass).to.be(5757.52); expect(data.usesExtracted).to.be.a('boolean'); expect(data.usesExtracted).to.be(false); } @@ -154,12 +154,18 @@ expect(data.productId).to.be(0); expect(data.volumeMode).to.be.a('string'); expect(data.volumeMode).to.be(""); - expect(data.volume).to.be.a(Object); - expect(data.volume).to.be(); - expect(data.defeaturedVolume).to.be.a(Object); - expect(data.defeaturedVolume).to.be(); expect(data.basePoints).to.be.a(Object); expect(data.basePoints).to.be(); + { + let dataCtr = data.messages; + expect(dataCtr).to.be.an(Array); + expect(dataCtr).to.not.be.empty(); + for (let p in dataCtr) { + let data = dataCtr[p]; + expect(data).to.be.a(Object); + expect(data).to.be(); + } + } } done(); @@ -284,8 +290,8 @@ expect(data.outline).to.be(); expect(data.createdAt).to.be.a('string'); expect(data.createdAt).to.be(""); - expect(data.updateAt).to.be.a('string'); - expect(data.updateAt).to.be(""); + expect(data.updatedAt).to.be.a('string'); + expect(data.updatedAt).to.be(""); } done(); diff --git a/javascript/sdk/missions/test/model/Marker.spec.js b/javascript/sdk/missions/test/model/Marker.spec.js index aed3019..e695816 100644 --- a/javascript/sdk/missions/test/model/Marker.spec.js +++ b/javascript/sdk/missions/test/model/Marker.spec.js @@ -166,24 +166,18 @@ // expect(instance.volumeMode).to.be(expectedValueLiteral); }); - it('should have the property volume (base name: "volume")', function() { - // TODO: update the code to test the property volume - expect(instance).to.have.property('volume'); - // expect(instance.volume).to.be(expectedValueLiteral); - }); - - it('should have the property defeaturedVolume (base name: "defeatured_volume")', function() { - // TODO: update the code to test the property defeaturedVolume - expect(instance).to.have.property('defeaturedVolume'); - // expect(instance.defeaturedVolume).to.be(expectedValueLiteral); - }); - it('should have the property basePoints (base name: "base_points")', function() { // TODO: update the code to test the property basePoints expect(instance).to.have.property('basePoints'); // expect(instance.basePoints).to.be(expectedValueLiteral); }); + it('should have the property messages (base name: "messages")', function() { + // TODO: update the code to test the property messages + expect(instance).to.have.property('messages'); + // expect(instance.messages).to.be(expectedValueLiteral); + }); + }); }); diff --git a/javascript/sdk/missions/test/model/MarkerVolume.spec.js b/javascript/sdk/missions/test/model/MarkerVolume.spec.js index cafcf6e..b1725bd 100644 --- a/javascript/sdk/missions/test/model/MarkerVolume.spec.js +++ b/javascript/sdk/missions/test/model/MarkerVolume.spec.js @@ -106,10 +106,10 @@ // expect(instance.offset).to.be(expectedValueLiteral); }); - it('should have the property computedDensity (base name: "computedDensity")', function() { - // TODO: update the code to test the property computedDensity - expect(instance).to.have.property('computedDensity'); - // expect(instance.computedDensity).to.be(expectedValueLiteral); + it('should have the property density (base name: "density")', function() { + // TODO: update the code to test the property density + expect(instance).to.have.property('density'); + // expect(instance.density).to.be(expectedValueLiteral); }); it('should have the property cutMass (base name: "cutMass")', function() { diff --git a/javascript/sdk/missions/test/model/Site.spec.js b/javascript/sdk/missions/test/model/Site.spec.js index 7d24533..c7fb9bd 100644 --- a/javascript/sdk/missions/test/model/Site.spec.js +++ b/javascript/sdk/missions/test/model/Site.spec.js @@ -82,10 +82,10 @@ // expect(instance.createdAt).to.be(expectedValueLiteral); }); - it('should have the property updateAt (base name: "update_at")', function() { - // TODO: update the code to test the property updateAt - expect(instance).to.have.property('updateAt'); - // expect(instance.updateAt).to.be(expectedValueLiteral); + it('should have the property updatedAt (base name: "updated_at")', function() { + // TODO: update the code to test the property updatedAt + expect(instance).to.have.property('updatedAt'); + // expect(instance.updatedAt).to.be(expectedValueLiteral); }); });