@larc-iu/plaid-client 0.2.0-alpha.6 → 0.2.0-alpha.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -473,7 +473,7 @@ interface DocumentsBundle {
473
473
  checkLock(documentId: string, asOf?: string): Promise<any>;
474
474
  acquireLock(documentId: string, auditMessage?: string): Promise<any>;
475
475
  releaseLock(documentId: string, auditMessage?: string): Promise<any>;
476
- getMedia(documentId: string, asOf?: string): Promise<ArrayBuffer>;
476
+ getMedia(documentId: string): Promise<ArrayBuffer>;
477
477
  uploadMedia(
478
478
  documentId: string,
479
479
  file: File,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@larc-iu/plaid-client",
3
- "version": "0.2.0-alpha.6",
3
+ "version": "0.2.0-alpha.8",
4
4
  "description": "JavaScript client for the Plaid annotation API",
5
5
  "type": "module",
6
6
  "repository": {
package/src/index.js CHANGED
@@ -1247,13 +1247,13 @@ class PlaidClient {
1247
1247
  auditMessage,
1248
1248
  }),
1249
1249
  /**
1250
- * Get media file for a document
1250
+ * Get the media file for a document. Media is not versioned, so there is
1251
+ * no as-of form: the route refuses the parameter. Prefer the document's
1252
+ * own `mediaUrl`, which carries the file's version for caching.
1251
1253
  * @param {string} documentId - The document ID
1252
- * @param {string} [asOf] - Temporal query timestamp
1253
1254
  */
1254
- getMedia: (documentId, asOf) =>
1255
+ getMedia: (documentId) =>
1255
1256
  this._request("GET", `/api/v1/documents/${documentId}/media`, {
1256
- queryParams: { "as-of": asOf },
1257
1257
  noBatch: true,
1258
1258
  binaryResponse: true,
1259
1259
  }),