Skip to content

Commit c7c17cd

Browse files
feat(api): api update
1 parent d01f144 commit c7c17cd

15 files changed

Lines changed: 31 additions & 558 deletions

File tree

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 17
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-56b0f699c5437d9e5326626d35dfc972c17d01f12cb416c7f4854c8ea6d0e95e.yml
3-
openapi_spec_hash: 158f405c1880706266d83e6ff16b9d2f
1+
configured_endpoints: 12
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-6a9d3b677dcfb856dc571865c34b3fe401e4d7f0d799edfc743acb9a55800bd0.yml
3+
openapi_spec_hash: 037703a6c741e4310fda3f57c22fa51e
44
config_hash: 41c337f5cda03b13880617490f82bad0

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ const client = new CasParser({
3636
environment: 'environment_1', // or 'production' | 'environment_2'; defaults to 'production'
3737
});
3838

39-
const response = await client.credits.check();
39+
const unifiedResponse = await client.camsKfintech.parse();
4040

41-
console.log(response.enabled_features);
41+
console.log(unifiedResponse.demat_accounts);
4242
```
4343

4444
### Request & Response types
@@ -54,7 +54,7 @@ const client = new CasParser({
5454
environment: 'environment_1', // or 'production' | 'environment_2'; defaults to 'production'
5555
});
5656

57-
const response: CasParser.CreditCheckResponse = await client.credits.check();
57+
const unifiedResponse: CasParser.UnifiedResponse = await client.camsKfintech.parse();
5858
```
5959

6060
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -67,7 +67,7 @@ a subclass of `APIError` will be thrown:
6767

6868
<!-- prettier-ignore -->
6969
```ts
70-
const response = await client.credits.check().catch(async (err) => {
70+
const unifiedResponse = await client.camsKfintech.parse().catch(async (err) => {
7171
if (err instanceof CasParser.APIError) {
7272
console.log(err.status); // 400
7373
console.log(err.name); // BadRequestError
@@ -107,7 +107,7 @@ const client = new CasParser({
107107
});
108108

109109
// Or, configure per-request:
110-
await client.credits.check({
110+
await client.camsKfintech.parse({
111111
maxRetries: 5,
112112
});
113113
```
@@ -124,7 +124,7 @@ const client = new CasParser({
124124
});
125125

126126
// Override per-request:
127-
await client.credits.check({
127+
await client.camsKfintech.parse({
128128
timeout: 5 * 1000,
129129
});
130130
```
@@ -147,13 +147,13 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
147147
```ts
148148
const client = new CasParser();
149149

150-
const response = await client.credits.check().asResponse();
150+
const response = await client.camsKfintech.parse().asResponse();
151151
console.log(response.headers.get('X-My-Header'));
152152
console.log(response.statusText); // access the underlying Response object
153153

154-
const { data: response, response: raw } = await client.credits.check().withResponse();
154+
const { data: unifiedResponse, response: raw } = await client.camsKfintech.parse().withResponse();
155155
console.log(raw.headers.get('X-My-Header'));
156-
console.log(response.enabled_features);
156+
console.log(unifiedResponse.demat_accounts);
157157
```
158158

159159
### Logging
@@ -233,7 +233,7 @@ parameter. This library doesn't validate at runtime that the request matches the
233233
send will be sent as-is.
234234

235235
```ts
236-
client.credits.check({
236+
client.camsKfintech.parse({
237237
// ...
238238
// @ts-expect-error baz is not yet public
239239
baz: 'undocumented option',

api.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,11 @@
11
# Credits
22

3-
Types:
4-
5-
- <code><a href="./src/resources/credits.ts">CreditCheckResponse</a></code>
6-
7-
Methods:
8-
9-
- <code title="post /credits">client.credits.<a href="./src/resources/credits.ts">check</a>() -> CreditCheckResponse</code>
10-
113
# Logs
124

13-
Types:
14-
15-
- <code><a href="./src/resources/logs.ts">LogCreateResponse</a></code>
16-
- <code><a href="./src/resources/logs.ts">LogGetSummaryResponse</a></code>
17-
18-
Methods:
19-
20-
- <code title="post /logs">client.logs.<a href="./src/resources/logs.ts">create</a>({ ...params }) -> LogCreateResponse</code>
21-
- <code title="post /logs/summary">client.logs.<a href="./src/resources/logs.ts">getSummary</a>({ ...params }) -> LogGetSummaryResponse</code>
22-
235
# AccessToken
246

25-
Types:
26-
27-
- <code><a href="./src/resources/access-token.ts">AccessTokenCreateResponse</a></code>
28-
29-
Methods:
30-
31-
- <code title="post /v1/access-token">client.accessToken.<a href="./src/resources/access-token.ts">create</a>({ ...params }) -> AccessTokenCreateResponse</code>
32-
337
# VerifyToken
348

35-
Types:
36-
37-
- <code><a href="./src/resources/verify-token.ts">VerifyTokenVerifyResponse</a></code>
38-
39-
Methods:
40-
41-
- <code title="post /v1/verify-token">client.verifyToken.<a href="./src/resources/verify-token.ts">verify</a>() -> VerifyTokenVerifyResponse</code>
42-
439
# CamsKfintech
4410

4511
Types:

packages/mcp-server/src/code-tool.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ For example:
2121
2222
\`\`\`
2323
async function run(client) {
24-
const response = await client.credits.check();
24+
const unifiedResponse = await client.camsKfintech.parse();
2525
26-
console.log(response.enabled_features);
26+
console.log(unifiedResponse.demat_accounts);
2727
}
2828
\`\`\`
2929

packages/mcp-server/src/methods.ts

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,6 @@ export type SdkMethod = {
1010
};
1111

1212
export const sdkMethods: SdkMethod[] = [
13-
{
14-
clientCallName: 'client.credits.check',
15-
fullyQualifiedName: 'credits.check',
16-
httpMethod: 'post',
17-
httpPath: '/credits',
18-
},
19-
{
20-
clientCallName: 'client.logs.create',
21-
fullyQualifiedName: 'logs.create',
22-
httpMethod: 'post',
23-
httpPath: '/logs',
24-
},
25-
{
26-
clientCallName: 'client.logs.getSummary',
27-
fullyQualifiedName: 'logs.getSummary',
28-
httpMethod: 'post',
29-
httpPath: '/logs/summary',
30-
},
31-
{
32-
clientCallName: 'client.accessToken.create',
33-
fullyQualifiedName: 'accessToken.create',
34-
httpMethod: 'post',
35-
httpPath: '/v1/access-token',
36-
},
37-
{
38-
clientCallName: 'client.verifyToken.verify',
39-
fullyQualifiedName: 'verifyToken.verify',
40-
httpMethod: 'post',
41-
httpPath: '/v1/verify-token',
42-
},
4313
{
4414
clientCallName: 'client.camsKfintech.parse',
4515
fullyQualifiedName: 'camsKfintech.parse',

src/client.ts

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import * as Errors from './core/error';
1616
import * as Uploads from './core/uploads';
1717
import * as API from './resources/index';
1818
import { APIPromise } from './core/api-promise';
19-
import { AccessToken, AccessTokenCreateParams, AccessTokenCreateResponse } from './resources/access-token';
19+
import { AccessToken } from './resources/access-token';
2020
import {
2121
CamsKfintech,
2222
CamsKfintechParseParams,
@@ -25,7 +25,7 @@ import {
2525
UnifiedResponse,
2626
} from './resources/cams-kfintech';
2727
import { ContractNote, ContractNoteParseParams, ContractNoteParseResponse } from './resources/contract-note';
28-
import { CreditCheckResponse, Credits } from './resources/credits';
28+
import { Credits } from './resources/credits';
2929
import {
3030
Inbox,
3131
InboxCheckConnectionStatusParams,
@@ -38,16 +38,10 @@ import {
3838
InboxListCasFilesResponse,
3939
} from './resources/inbox';
4040
import { Kfintech, KfintechGenerateCasParams, KfintechGenerateCasResponse } from './resources/kfintech';
41-
import {
42-
LogCreateParams,
43-
LogCreateResponse,
44-
LogGetSummaryParams,
45-
LogGetSummaryResponse,
46-
Logs,
47-
} from './resources/logs';
41+
import { Logs } from './resources/logs';
4842
import { Nsdl, NsdlParseParams } from './resources/nsdl';
4943
import { Smart, SmartParseCasPdfParams } from './resources/smart';
50-
import { VerifyToken, VerifyTokenVerifyResponse } from './resources/verify-token';
44+
import { VerifyToken } from './resources/verify-token';
5145
import { Cdsl, CdslParsePdfParams } from './resources/cdsl/cdsl';
5246
import { type Fetch } from './internal/builtin-types';
5347
import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
@@ -817,23 +811,13 @@ CasParser.Smart = Smart;
817811
export declare namespace CasParser {
818812
export type RequestOptions = Opts.RequestOptions;
819813

820-
export { Credits as Credits, type CreditCheckResponse as CreditCheckResponse };
814+
export { Credits as Credits };
821815

822-
export {
823-
Logs as Logs,
824-
type LogCreateResponse as LogCreateResponse,
825-
type LogGetSummaryResponse as LogGetSummaryResponse,
826-
type LogCreateParams as LogCreateParams,
827-
type LogGetSummaryParams as LogGetSummaryParams,
828-
};
816+
export { Logs as Logs };
829817

830-
export {
831-
AccessToken as AccessToken,
832-
type AccessTokenCreateResponse as AccessTokenCreateResponse,
833-
type AccessTokenCreateParams as AccessTokenCreateParams,
834-
};
818+
export { AccessToken as AccessToken };
835819

836-
export { VerifyToken as VerifyToken, type VerifyTokenVerifyResponse as VerifyTokenVerifyResponse };
820+
export { VerifyToken as VerifyToken };
837821

838822
export {
839823
CamsKfintech as CamsKfintech,

src/resources/access-token.ts

Lines changed: 1 addition & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,5 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../core/resource';
4-
import { APIPromise } from '../core/api-promise';
5-
import { RequestOptions } from '../internal/request-options';
64

7-
export class AccessToken extends APIResource {
8-
/**
9-
* Generate a short-lived access token from your API key.
10-
*
11-
* **Use this endpoint from your backend** to create tokens that can be safely
12-
* passed to frontend/SDK.
13-
*
14-
* Access tokens:
15-
*
16-
* - Are prefixed with `at_` for easy identification
17-
* - Valid for up to 60 minutes
18-
* - Can be used in place of API keys on all v4 endpoints
19-
* - Cannot be used to generate other access tokens
20-
*
21-
* @example
22-
* ```ts
23-
* const accessToken = await client.accessToken.create();
24-
* ```
25-
*/
26-
create(
27-
body: AccessTokenCreateParams | null | undefined = {},
28-
options?: RequestOptions,
29-
): APIPromise<AccessTokenCreateResponse> {
30-
return this._client.post('/v1/access-token', { body, ...options });
31-
}
32-
}
33-
34-
export interface AccessTokenCreateResponse {
35-
/**
36-
* The at\_ prefixed access token
37-
*/
38-
access_token?: string;
39-
40-
/**
41-
* Token validity in seconds
42-
*/
43-
expires_in?: number;
44-
45-
/**
46-
* Always "api_key" - token is a drop-in replacement for x-api-key header
47-
*/
48-
token_type?: string;
49-
}
50-
51-
export interface AccessTokenCreateParams {
52-
/**
53-
* Token validity in minutes (max 60)
54-
*/
55-
expiry_minutes?: number;
56-
}
57-
58-
export declare namespace AccessToken {
59-
export {
60-
type AccessTokenCreateResponse as AccessTokenCreateResponse,
61-
type AccessTokenCreateParams as AccessTokenCreateParams,
62-
};
63-
}
5+
export class AccessToken extends APIResource {}

src/resources/credits.ts

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,5 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../core/resource';
4-
import { APIPromise } from '../core/api-promise';
5-
import { RequestOptions } from '../internal/request-options';
64

7-
export class Credits extends APIResource {
8-
/**
9-
* Check your remaining API credits and usage for the current billing period.
10-
*
11-
* Returns:
12-
*
13-
* - Number of API calls used and remaining credits
14-
* - Credit limit and reset date
15-
* - List of enabled features for your plan
16-
*
17-
* Credits reset at the start of each billing period.
18-
*/
19-
check(options?: RequestOptions): APIPromise<CreditCheckResponse> {
20-
return this._client.post('/credits', options);
21-
}
22-
}
23-
24-
export interface CreditCheckResponse {
25-
/**
26-
* List of API features enabled for your plan
27-
*/
28-
enabled_features?: Array<string>;
29-
30-
/**
31-
* Whether the account has unlimited credits
32-
*/
33-
is_unlimited?: boolean;
34-
35-
/**
36-
* Total credit limit for billing period
37-
*/
38-
limit?: number;
39-
40-
/**
41-
* Remaining credits (null if unlimited)
42-
*/
43-
remaining?: number | null;
44-
45-
/**
46-
* When credits reset (ISO 8601)
47-
*/
48-
resets_at?: string | null;
49-
50-
/**
51-
* Number of credits used this billing period
52-
*/
53-
used?: number;
54-
}
55-
56-
export declare namespace Credits {
57-
export { type CreditCheckResponse as CreditCheckResponse };
58-
}
5+
export class Credits extends APIResource {}

src/resources/index.ts

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

3-
export { AccessToken, type AccessTokenCreateResponse, type AccessTokenCreateParams } from './access-token';
3+
export { AccessToken } from './access-token';
44
export {
55
CamsKfintech,
66
type LinkedHolder,
@@ -10,7 +10,7 @@ export {
1010
} from './cams-kfintech';
1111
export { Cdsl, type CdslParsePdfParams } from './cdsl/cdsl';
1212
export { ContractNote, type ContractNoteParseResponse, type ContractNoteParseParams } from './contract-note';
13-
export { Credits, type CreditCheckResponse } from './credits';
13+
export { Credits } from './credits';
1414
export {
1515
Inbox,
1616
type InboxCheckConnectionStatusResponse,
@@ -23,13 +23,7 @@ export {
2323
type InboxListCasFilesParams,
2424
} from './inbox';
2525
export { Kfintech, type KfintechGenerateCasResponse, type KfintechGenerateCasParams } from './kfintech';
26-
export {
27-
Logs,
28-
type LogCreateResponse,
29-
type LogGetSummaryResponse,
30-
type LogCreateParams,
31-
type LogGetSummaryParams,
32-
} from './logs';
26+
export { Logs } from './logs';
3327
export { Nsdl, type NsdlParseParams } from './nsdl';
3428
export { Smart, type SmartParseCasPdfParams } from './smart';
35-
export { VerifyToken, type VerifyTokenVerifyResponse } from './verify-token';
29+
export { VerifyToken } from './verify-token';

0 commit comments

Comments
 (0)