@scenario-labs/sdk 2.7.0 → 3.0.0

package/src/resources/assets/download.ts

@@ -9,8 +9,12 @@ export class Download extends APIResource {
   /**
    * Retrieve the status and the url of a batch download assets request
    */
-  getStatus(jobID: string, options?: RequestOptions): APIPromise<DownloadGetStatusResponse> {
-    return this._client.get(path`/assets/download/${jobID}`, options);
+  getStatus(
+    jobID: string,
+    query: DownloadGetStatusParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DownloadGetStatusResponse> {
+    return this._client.get(path`/assets/download/${jobID}`, { query, ...options });
   }
 
   /**
@@ -18,20 +22,22 @@ export class Download extends APIResource {
    */
   request(
     assetID: string,
-    body: DownloadRequestParams,
+    params: DownloadRequestParams,
     options?: RequestOptions,
   ): APIPromise<DownloadRequestResponse> {
-    return this._client.post(path`/assets/${assetID}/download`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.post(path`/assets/${assetID}/download`, { query: { projectId }, body, ...options });
   }
 
   /**
    * Request a link to batch download assets (batch limited to 1000 assets)
    */
   requestBatch(
-    body: DownloadRequestBatchParams,
+    params: DownloadRequestBatchParams,
     options?: RequestOptions,
   ): APIPromise<DownloadRequestBatchResponse> {
-    return this._client.post('/assets/download', { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.post('/assets/download', { query: { projectId }, body, ...options });
   }
 }
 
@@ -66,9 +72,23 @@ export interface DownloadRequestBatchResponse {
   jobId: string;
 }
 
+export interface DownloadGetStatusParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
 export interface DownloadRequestParams {
   /**
-   * The format to download the asset in
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: The format to download the asset in
    */
   targetFormat?:
     | 'gif'
@@ -87,9 +107,21 @@ export interface DownloadRequestParams {
 }
 
 export interface DownloadRequestBatchParams {
+  /**
+   * Body param
+   */
   options: DownloadRequestBatchParams.Options;
 
+  /**
+   * Body param
+   */
   query: DownloadRequestBatchParams.Query;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export namespace DownloadRequestBatchParams {
@@ -132,6 +164,7 @@ export declare namespace Download {
     type DownloadGetStatusResponse as DownloadGetStatusResponse,
     type DownloadRequestResponse as DownloadRequestResponse,
     type DownloadRequestBatchResponse as DownloadRequestBatchResponse,
+    type DownloadGetStatusParams as DownloadGetStatusParams,
     type DownloadRequestParams as DownloadRequestParams,
     type DownloadRequestBatchParams as DownloadRequestBatchParams,
   };

package/src/resources/assets/index.ts

@@ -32,6 +32,7 @@ export {
   type DownloadGetStatusResponse,
   type DownloadRequestResponse,
   type DownloadRequestBatchResponse,
+  type DownloadGetStatusParams,
   type DownloadRequestParams,
   type DownloadRequestBatchParams,
 } from './download';

package/src/resources/collections/assets.ts

@@ -9,8 +9,13 @@ export class Assets extends APIResource {
   /**
    * Add assets to a specific collection
    */
-  add(collectionID: string, body: AssetAddParams, options?: RequestOptions): APIPromise<AssetAddResponse> {
-    return this._client.put(path`/collections/${collectionID}/assets`, { body, ...options });
+  add(collectionID: string, params: AssetAddParams, options?: RequestOptions): APIPromise<AssetAddResponse> {
+    const { projectId, ...body } = params;
+    return this._client.put(path`/collections/${collectionID}/assets`, {
+      query: { projectId },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -18,10 +23,15 @@ export class Assets extends APIResource {
    */
   remove(
     collectionID: string,
-    body: AssetRemoveParams,
+    params: AssetRemoveParams,
     options?: RequestOptions,
   ): APIPromise<AssetRemoveResponse> {
-    return this._client.delete(path`/collections/${collectionID}/assets`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.delete(path`/collections/${collectionID}/assets`, {
+      query: { projectId },
+      body,
+      ...options,
+    });
   }
 }
 
@@ -141,16 +151,29 @@ export namespace AssetRemoveResponse {
 
 export interface AssetAddParams {
   /**
-   * The ids of the assets to add to the collection. (Max 49 at once)
+   * Body param: The ids of the assets to add to the collection. (Max 49 at once)
    */
   assetIds: Array<string>;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface AssetRemoveParams {
   /**
-   * The ids of the assets to remove from the collection. (Max 49 at once)
+   * Body param: The ids of the assets to remove from the collection. (Max 49 at
+   * once)
    */
   assetIds: Array<string>;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export declare namespace Assets {

package/src/resources/collections/collections.ts

@@ -17,15 +17,20 @@ export class Collections extends APIResource {
   /**
    * Create a new collection
    */
-  create(body: CollectionCreateParams, options?: RequestOptions): APIPromise<CollectionCreateResponse> {
-    return this._client.post('/collections', { body, ...options });
+  create(params: CollectionCreateParams, options?: RequestOptions): APIPromise<CollectionCreateResponse> {
+    const { projectId, ...body } = params;
+    return this._client.post('/collections', { query: { projectId }, body, ...options });
   }
 
   /**
    * Get the details of a collection
    */
-  retrieve(collectionID: string, options?: RequestOptions): APIPromise<CollectionRetrieveResponse> {
-    return this._client.get(path`/collections/${collectionID}`, options);
+  retrieve(
+    collectionID: string,
+    query: CollectionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CollectionRetrieveResponse> {
+    return this._client.get(path`/collections/${collectionID}`, { query, ...options });
   }
 
   /**
@@ -33,10 +38,11 @@ export class Collections extends APIResource {
    */
   update(
     collectionID: string,
-    body: CollectionUpdateParams,
+    params: CollectionUpdateParams,
     options?: RequestOptions,
   ): APIPromise<CollectionUpdateResponse> {
-    return this._client.put(path`/collections/${collectionID}`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.put(path`/collections/${collectionID}`, { query: { projectId }, body, ...options });
   }
 
   /**
@@ -55,8 +61,13 @@ export class Collections extends APIResource {
   /**
    * Delete a collection
    */
-  delete(collectionID: string, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.delete(path`/collections/${collectionID}`, options);
+  delete(
+    collectionID: string,
+    params: CollectionDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { projectId } = params ?? {};
+    return this._client.delete(path`/collections/${collectionID}`, { query: { projectId }, ...options });
   }
 }
 
@@ -288,20 +299,40 @@ export type CollectionDeleteResponse = unknown;
 
 export interface CollectionCreateParams {
   /**
-   * The name of the collection.
+   * Body param: The name of the collection.
    */
   name: string;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export interface CollectionRetrieveParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface CollectionUpdateParams {
   /**
-   * The new name for the Collection
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: The new name for the Collection
    */
   name?: string;
 
   /**
-   * The AssetId of the image you want to use as a thumbnail for the collection. Set
-   * to null to unset the thumbnail.
+   * Body param: The AssetId of the image you want to use as a thumbnail for the
+   * collection. Set to null to unset the thumbnail.
    */
   thumbnail?: string;
 }
@@ -312,6 +343,20 @@ export interface CollectionListParams extends CollectionsCursorParams {
    * value is 100, minimum value is 1
    */
   pageSize?: number;
+
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export interface CollectionDeleteParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 Collections.Assets = Assets;
@@ -326,8 +371,10 @@ export declare namespace Collections {
     type CollectionDeleteResponse as CollectionDeleteResponse,
     type CollectionListResponsesCollectionsCursor as CollectionListResponsesCollectionsCursor,
     type CollectionCreateParams as CollectionCreateParams,
+    type CollectionRetrieveParams as CollectionRetrieveParams,
     type CollectionUpdateParams as CollectionUpdateParams,
     type CollectionListParams as CollectionListParams,
+    type CollectionDeleteParams as CollectionDeleteParams,
   };
 
   export {

package/src/resources/collections/index.ts

@@ -15,8 +15,10 @@ export {
   type CollectionListResponse,
   type CollectionDeleteResponse,
   type CollectionCreateParams,
+  type CollectionRetrieveParams,
   type CollectionUpdateParams,
   type CollectionListParams,
+  type CollectionDeleteParams,
   type CollectionListResponsesCollectionsCursor,
 } from './collections';
 export {

package/src/resources/collections/models.ts

@@ -9,8 +9,13 @@ export class Models extends APIResource {
   /**
    * Add models to a specific collection
    */
-  add(collectionID: string, body: ModelAddParams, options?: RequestOptions): APIPromise<ModelAddResponse> {
-    return this._client.put(path`/collections/${collectionID}/models`, { body, ...options });
+  add(collectionID: string, params: ModelAddParams, options?: RequestOptions): APIPromise<ModelAddResponse> {
+    const { projectId, ...body } = params;
+    return this._client.put(path`/collections/${collectionID}/models`, {
+      query: { projectId },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -18,10 +23,15 @@ export class Models extends APIResource {
    */
   remove(
     collectionID: string,
-    body: ModelRemoveParams,
+    params: ModelRemoveParams,
     options?: RequestOptions,
   ): APIPromise<ModelRemoveResponse> {
-    return this._client.delete(path`/collections/${collectionID}/models`, { body, ...options });
+    const { projectId, ...body } = params;
+    return this._client.delete(path`/collections/${collectionID}/models`, {
+      query: { projectId },
+      body,
+      ...options,
+    });
   }
 }
 
@@ -141,16 +151,29 @@ export namespace ModelRemoveResponse {
 
 export interface ModelAddParams {
   /**
-   * The ids of the models to add to the collection. (Max 49 at once)
+   * Body param: The ids of the models to add to the collection. (Max 49 at once)
    */
   modelIds: Array<string>;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface ModelRemoveParams {
   /**
-   * The ids of the models to remove from the collection. (Max 49 at once)
+   * Body param: The ids of the models to remove from the collection. (Max 49 at
+   * once)
    */
   modelIds: Array<string>;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export declare namespace Models {