feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-b7fdba3d3f97c7debc22c7ca30b828bce81bcd64648df8c94029b27a3321ebb9.yml
-openapi_spec_hash: 03f1315f1d32ada42445ca920f047dff
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-33841d833a48438cd79a13b2e70eeb61551b67e954ed788209ece1b0f5886e15.yml
+openapi_spec_hash: 6a784691ea7c8cf7c2987c93f6a2ab25
 config_hash: e038b1acdad8015d8d29b65c78c345fa

README.md

@@ -53,6 +53,35 @@ const unifiedResponse: CasParser.UnifiedResponse = await client.casParser.camsKf
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed in many different forms:
+
+- `File` (or an object with the same structure)
+- a `fetch` `Response` (or an object with the same structure)
+- an `fs.ReadStream`
+- the return value of our `toFile` helper
+
+```ts
+import fs from 'fs';
+import CasParser, { toFile } from 'cas-parser';
+
+const client = new CasParser();
+
+// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
+await client.casParser.camsKfintech({ pdf_file: fs.createReadStream('/path/to/file') });
+
+// Or if you have the web `File` API you can pass a `File` instance:
+await client.casParser.camsKfintech({ pdf_file: new File(['my bytes'], 'file') });
+
+// You can also pass a `fetch` `Response`:
+await client.casParser.camsKfintech({ pdf_file: await fetch('https://somesite/file') });
+
+// Finally, if none of the above are convenient, you can use our `toFile` helper:
+await client.casParser.camsKfintech({ pdf_file: await toFile(Buffer.from('my bytes'), 'file') });
+await client.casParser.camsKfintech({ pdf_file: await toFile(new Uint8Array([0, 1, 2]), 'file') });
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API,

bin/publish-npm

@@ -58,4 +58,4 @@ else
 fi
 
 # Publish with the appropriate tag
-yarn publish --access public --tag "$TAG"
+yarn publish --tag "$TAG"

package.json

@@ -13,6 +13,9 @@
     "**/*"
   ],
   "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "./scripts/test",
     "build": "./scripts/build",

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL"
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
 fi

scripts/test

@@ -43,7 +43,7 @@ elif ! prism_is_running ; then
   echo -e "To run the server, pass in the path or url of your OpenAPI"
   echo -e "spec to the prism command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
   echo
 
   exit 1

src/client.ts

@@ -755,8 +755,10 @@ export class CasParser {
   casParser: API.CasParserResource = new API.CasParserResource(this);
   casGenerator: API.CasGenerator = new API.CasGenerator(this);
 }
+
 CasParser.CasParserResource = CasParserResource;
 CasParser.CasGenerator = CasGenerator;
+
 export declare namespace CasParser {
   export type RequestOptions = Opts.RequestOptions;
 

src/resources/cas-parser.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
+import { type Uploadable } from '../core/uploads';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
@@ -682,7 +683,7 @@ export interface CasParserCamsKfintechParams {
   /**
    * Base64 encoded CAS PDF file
    */
-  pdf_file?: string;
+  pdf_file?: Uploadable;
 
   /**
    * URL to the CAS PDF file
@@ -699,7 +700,7 @@ export interface CasParserCdslParams {
   /**
    * Base64 encoded CAS PDF file
    */
-  pdf_file?: string;
+  pdf_file?: Uploadable;
 
   /**
    * URL to the CAS PDF file
@@ -716,7 +717,7 @@ export interface CasParserNsdlParams {
   /**
    * Base64 encoded CAS PDF file
    */
-  pdf_file?: string;
+  pdf_file?: Uploadable;
 
   /**
    * URL to the CAS PDF file
@@ -733,7 +734,7 @@ export interface CasParserSmartParseParams {
   /**
    * Base64 encoded CAS PDF file
    */
-  pdf_file?: string;
+  pdf_file?: Uploadable;
 
   /**
    * URL to the CAS PDF file

tests/api-resources/cas-generator.test.ts

@@ -8,7 +8,7 @@ const client = new CasParser({
 });
 
 describe('resource casGenerator', () => {
-  // skipped: tests are disabled for the time being
+  // Prism tests are disabled
   test.skip('generateCas: only required params', async () => {
     const responsePromise = client.casGenerator.generateCas({
       email: '[email protected]',
@@ -25,7 +25,7 @@ describe('resource casGenerator', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  // skipped: tests are disabled for the time being
+  // Prism tests are disabled
   test.skip('generateCas: required and optional params', async () => {
     const response = await client.casGenerator.generateCas({
       email: '[email protected]',

tests/api-resources/cas-parser.test.ts

@@ -8,7 +8,7 @@ const client = new CasParser({
 });
 
 describe('resource casParser', () => {
-  // skipped: tests are disabled for the time being
+  // Prism tests are disabled
   test.skip('camsKfintech', async () => {
     const responsePromise = client.casParser.camsKfintech({});
     const rawResponse = await responsePromise.asResponse();
@@ -20,7 +20,7 @@ describe('resource casParser', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  // skipped: tests are disabled for the time being
+  // Prism tests are disabled
   test.skip('cdsl', async () => {
     const responsePromise = client.casParser.cdsl({});
     const rawResponse = await responsePromise.asResponse();
@@ -32,7 +32,7 @@ describe('resource casParser', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  // skipped: tests are disabled for the time being
+  // Prism tests are disabled
   test.skip('nsdl', async () => {
     const responsePromise = client.casParser.nsdl({});
     const rawResponse = await responsePromise.asResponse();
@@ -44,7 +44,7 @@ describe('resource casParser', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  // skipped: tests are disabled for the time being
+  // Prism tests are disabled
   test.skip('smartParse', async () => {
     const responsePromise = client.casParser.smartParse({});
     const rawResponse = await responsePromise.asResponse();