Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Vertex Platform API
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertexvis.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples, - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
*
* The version of the OpenAPI document: 1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.vertexvis.api;
import com.vertexvis.ApiCallback;
import com.vertexvis.ApiClient;
import com.vertexvis.ApiException;
import com.vertexvis.ApiResponse;
import com.vertexvis.Configuration;
import com.vertexvis.Pair;
import com.vertexvis.ProgressRequestBody;
import com.vertexvis.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.vertexvis.model.CreateSceneItemRequest;
import com.vertexvis.model.Failure;
import com.vertexvis.model.QueuedJob;
import com.vertexvis.model.SceneItem;
import com.vertexvis.model.SceneItemList;
import java.util.UUID;
import com.vertexvis.model.UpdateSceneItemRequest;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class SceneItemsApi {
private ApiClient localVarApiClient;
public SceneItemsApi() {
this(Configuration.getDefaultApiClient());
}
public SceneItemsApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for createSceneItem
* @param id The `scene` ID. (required)
* @param createSceneItemRequest (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
409
Conflict
-
415
Unsupported Media Type
-
*/
public okhttp3.Call createSceneItemCall(UUID id, CreateSceneItemRequest createSceneItemRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = createSceneItemRequest;
// create path and map variables
String localVarPath = "/scenes/{id}/scene-items"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/vnd.api+json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createSceneItemValidateBeforeCall(UUID id, CreateSceneItemRequest createSceneItemRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling createSceneItem(Async)");
}
// verify the required parameter 'createSceneItemRequest' is set
if (createSceneItemRequest == null) {
throw new ApiException("Missing the required parameter 'createSceneItemRequest' when calling createSceneItem(Async)");
}
okhttp3.Call localVarCall = createSceneItemCall(id, createSceneItemRequest, _callback);
return localVarCall;
}
/**
*
* Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `scene` ID. (required)
* @param createSceneItemRequest (required)
* @return QueuedJob
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
409
Conflict
-
415
Unsupported Media Type
-
*/
public QueuedJob createSceneItem(UUID id, CreateSceneItemRequest createSceneItemRequest) throws ApiException {
ApiResponse localVarResp = createSceneItemWithHttpInfo(id, createSceneItemRequest);
return localVarResp.getData();
}
/**
*
* Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `scene` ID. (required)
* @param createSceneItemRequest (required)
* @return ApiResponse<QueuedJob>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
409
Conflict
-
415
Unsupported Media Type
-
*/
public ApiResponse createSceneItemWithHttpInfo(UUID id, CreateSceneItemRequest createSceneItemRequest) throws ApiException {
okhttp3.Call localVarCall = createSceneItemValidateBeforeCall(id, createSceneItemRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Create a `scene-item` for a `scene`. Provide the source geometry either via `part-revision` or `geometry-set` UUID using `relationship.source` or by supplied IDs using `attributes.source`. Provide an existing `scene` using `relationship.source` to clone it. Provide the hierarchical parent either via `scene-item` UUID using `relationship.source` or by supplied ID using `attributes.parent`. To reduce the time taken creating many hierarchical `scene-items`, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a `queued-scene-item`. Check the status via the getQueuedSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `scene` ID. (required)
* @param createSceneItemRequest (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
409
Conflict
-
415
Unsupported Media Type
-
*/
public okhttp3.Call createSceneItemAsync(UUID id, CreateSceneItemRequest createSceneItemRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createSceneItemValidateBeforeCall(id, createSceneItemRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteSceneItem
* @param id The `scene-item` ID. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call deleteSceneItemCall(UUID id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scene-items/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteSceneItemValidateBeforeCall(UUID id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling deleteSceneItem(Async)");
}
okhttp3.Call localVarCall = deleteSceneItemCall(id, _callback);
return localVarCall;
}
/**
*
* Delete a `scene-item`.
* @param id The `scene-item` ID. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public void deleteSceneItem(UUID id) throws ApiException {
deleteSceneItemWithHttpInfo(id);
}
/**
*
* Delete a `scene-item`.
* @param id The `scene-item` ID. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse deleteSceneItemWithHttpInfo(UUID id) throws ApiException {
okhttp3.Call localVarCall = deleteSceneItemValidateBeforeCall(id, null);
return localVarApiClient.execute(localVarCall);
}
/**
* (asynchronously)
* Delete a `scene-item`.
* @param id The `scene-item` ID. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call deleteSceneItemAsync(UUID id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteSceneItemValidateBeforeCall(id, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for getQueuedSceneItem
* @param id The `queued-scene-item` ID. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getQueuedSceneItemCall(UUID id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/queued-scene-items/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getQueuedSceneItemValidateBeforeCall(UUID id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getQueuedSceneItem(Async)");
}
okhttp3.Call localVarCall = getQueuedSceneItemCall(id, _callback);
return localVarCall;
}
/**
*
* Get a `queued-scene-item`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-item`. Once created, commit the scene via the updateScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `queued-scene-item` ID. (required)
* @return QueuedJob
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public QueuedJob getQueuedSceneItem(UUID id) throws ApiException {
ApiResponse localVarResp = getQueuedSceneItemWithHttpInfo(id);
return localVarResp.getData();
}
/**
*
* Get a `queued-scene-item`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-item`. Once created, commit the scene via the updateScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `queued-scene-item` ID. (required)
* @return ApiResponse<QueuedJob>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse getQueuedSceneItemWithHttpInfo(UUID id) throws ApiException {
okhttp3.Call localVarCall = getQueuedSceneItemValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get a `queued-scene-item`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `scene-item`. Once created, commit the scene via the updateScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `queued-scene-item` ID. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getQueuedSceneItemAsync(UUID id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getQueuedSceneItemValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getQueuedSceneItemDeletion
* @param id The `queued-scene-item-deletion` ID. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getQueuedSceneItemDeletionCall(UUID id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/queued-scene-item-deletions/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getQueuedSceneItemDeletionValidateBeforeCall(UUID id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getQueuedSceneItemDeletion(Async)");
}
okhttp3.Call localVarCall = getQueuedSceneItemDeletionCall(id, _callback);
return localVarCall;
}
/**
*
* Get a `queued-scene-item-deletion` by ID.
* @param id The `queued-scene-item-deletion` ID. (required)
* @return QueuedJob
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public QueuedJob getQueuedSceneItemDeletion(UUID id) throws ApiException {
ApiResponse localVarResp = getQueuedSceneItemDeletionWithHttpInfo(id);
return localVarResp.getData();
}
/**
*
* Get a `queued-scene-item-deletion` by ID.
* @param id The `queued-scene-item-deletion` ID. (required)
* @return ApiResponse<QueuedJob>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse getQueuedSceneItemDeletionWithHttpInfo(UUID id) throws ApiException {
okhttp3.Call localVarCall = getQueuedSceneItemDeletionValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get a `queued-scene-item-deletion` by ID.
* @param id The `queued-scene-item-deletion` ID. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getQueuedSceneItemDeletionAsync(UUID id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getQueuedSceneItemDeletionValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getSceneItem
* @param id The `scene-item` ID. (required)
* @param fieldsSceneItem Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getSceneItemCall(UUID id, String fieldsSceneItem, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scene-items/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (fieldsSceneItem != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("fields[scene-item]", fieldsSceneItem));
}
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getSceneItemValidateBeforeCall(UUID id, String fieldsSceneItem, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getSceneItem(Async)");
}
okhttp3.Call localVarCall = getSceneItemCall(id, fieldsSceneItem, _callback);
return localVarCall;
}
/**
*
* Get a `scene-item` by ID.
* @param id The `scene-item` ID. (required)
* @param fieldsSceneItem Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested. (optional)
* @return SceneItem
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public SceneItem getSceneItem(UUID id, String fieldsSceneItem) throws ApiException {
ApiResponse localVarResp = getSceneItemWithHttpInfo(id, fieldsSceneItem);
return localVarResp.getData();
}
/**
*
* Get a `scene-item` by ID.
* @param id The `scene-item` ID. (required)
* @param fieldsSceneItem Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested. (optional)
* @return ApiResponse<SceneItem>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse getSceneItemWithHttpInfo(UUID id, String fieldsSceneItem) throws ApiException {
okhttp3.Call localVarCall = getSceneItemValidateBeforeCall(id, fieldsSceneItem, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get a `scene-item` by ID.
* @param id The `scene-item` ID. (required)
* @param fieldsSceneItem Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getSceneItemAsync(UUID id, String fieldsSceneItem, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getSceneItemValidateBeforeCall(id, fieldsSceneItem, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getSceneItems
* @param id The `scene` ID. (required)
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterSource Source ID to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @param filterParent Parent ID to filter on. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getSceneItemsCall(UUID id, String pageCursor, Integer pageSize, String filterSource, String filterSuppliedId, UUID filterParent, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scenes/{id}/scene-items"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (pageCursor != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[cursor]", pageCursor));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[size]", pageSize));
}
if (filterSource != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[source]", filterSource));
}
if (filterSuppliedId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[suppliedId]", filterSuppliedId));
}
if (filterParent != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[parent]", filterParent));
}
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getSceneItemsValidateBeforeCall(UUID id, String pageCursor, Integer pageSize, String filterSource, String filterSuppliedId, UUID filterParent, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getSceneItems(Async)");
}
okhttp3.Call localVarCall = getSceneItemsCall(id, pageCursor, pageSize, filterSource, filterSuppliedId, filterParent, _callback);
return localVarCall;
}
/**
*
* Get `scene-items` for a `scene`.
* @param id The `scene` ID. (required)
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterSource Source ID to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @param filterParent Parent ID to filter on. (optional)
* @return SceneItemList
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public SceneItemList getSceneItems(UUID id, String pageCursor, Integer pageSize, String filterSource, String filterSuppliedId, UUID filterParent) throws ApiException {
ApiResponse localVarResp = getSceneItemsWithHttpInfo(id, pageCursor, pageSize, filterSource, filterSuppliedId, filterParent);
return localVarResp.getData();
}
/**
*
* Get `scene-items` for a `scene`.
* @param id The `scene` ID. (required)
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterSource Source ID to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @param filterParent Parent ID to filter on. (optional)
* @return ApiResponse<SceneItemList>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse getSceneItemsWithHttpInfo(UUID id, String pageCursor, Integer pageSize, String filterSource, String filterSuppliedId, UUID filterParent) throws ApiException {
okhttp3.Call localVarCall = getSceneItemsValidateBeforeCall(id, pageCursor, pageSize, filterSource, filterSuppliedId, filterParent, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get `scene-items` for a `scene`.
* @param id The `scene` ID. (required)
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterSource Source ID to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @param filterParent Parent ID to filter on. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getSceneItemsAsync(UUID id, String pageCursor, Integer pageSize, String filterSource, String filterSuppliedId, UUID filterParent, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getSceneItemsValidateBeforeCall(id, pageCursor, pageSize, filterSource, filterSuppliedId, filterParent, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for updateSceneItem
* @param id The `scene-item` ID. (required)
* @param updateSceneItemRequest (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call updateSceneItemCall(UUID id, UpdateSceneItemRequest updateSceneItemRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = updateSceneItemRequest;
// create path and map variables
String localVarPath = "/scene-items/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/vnd.api+json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateSceneItemValidateBeforeCall(UUID id, UpdateSceneItemRequest updateSceneItemRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling updateSceneItem(Async)");
}
// verify the required parameter 'updateSceneItemRequest' is set
if (updateSceneItemRequest == null) {
throw new ApiException("Missing the required parameter 'updateSceneItemRequest' when calling updateSceneItem(Async)");
}
okhttp3.Call localVarCall = updateSceneItemCall(id, updateSceneItemRequest, _callback);
return localVarCall;
}
/**
*
* Update a `scene-item`.
* @param id The `scene-item` ID. (required)
* @param updateSceneItemRequest (required)
* @return QueuedJob
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public QueuedJob updateSceneItem(UUID id, UpdateSceneItemRequest updateSceneItemRequest) throws ApiException {
ApiResponse localVarResp = updateSceneItemWithHttpInfo(id, updateSceneItemRequest);
return localVarResp.getData();
}
/**
*
* Update a `scene-item`.
* @param id The `scene-item` ID. (required)
* @param updateSceneItemRequest (required)
* @return ApiResponse<QueuedJob>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse updateSceneItemWithHttpInfo(UUID id, UpdateSceneItemRequest updateSceneItemRequest) throws ApiException {
okhttp3.Call localVarCall = updateSceneItemValidateBeforeCall(id, updateSceneItemRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Update a `scene-item`.
* @param id The `scene-item` ID. (required)
* @param updateSceneItemRequest (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
* content-location -
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call updateSceneItemAsync(UUID id, UpdateSceneItemRequest updateSceneItemRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateSceneItemValidateBeforeCall(id, updateSceneItemRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
}
