@compass-labs/api-sdk 2.1.16 → 2.1.17-rc.1
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/README.md +3 -5
- package/codeSamples_typescript.yaml +1 -7
- package/dist/commonjs/funcs/earnEarnVaults.d.ts +6 -3
- package/dist/commonjs/funcs/earnEarnVaults.d.ts.map +1 -1
- package/dist/commonjs/funcs/earnEarnVaults.js +7 -3
- package/dist/commonjs/funcs/earnEarnVaults.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/index.d.ts +1 -2
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +1 -2
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/vaultinfo.d.ts +22 -110
- package/dist/commonjs/models/components/vaultinfo.d.ts.map +1 -1
- package/dist/commonjs/models/components/vaultinfo.js +19 -58
- package/dist/commonjs/models/components/vaultinfo.js.map +1 -1
- package/dist/commonjs/models/components/{vaultslistresponse.d.ts → vaultsresponse.d.ts} +5 -5
- package/dist/commonjs/models/components/vaultsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/{vaultslistresponse.js → vaultsresponse.js} +6 -6
- package/dist/commonjs/models/components/vaultsresponse.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +0 -1
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -1
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2earnvaults.d.ts +5 -0
- package/dist/commonjs/models/operations/v2earnvaults.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2earnvaults.js +2 -0
- package/dist/commonjs/models/operations/v2earnvaults.js.map +1 -1
- package/dist/commonjs/sdk/earn.d.ts +5 -9
- package/dist/commonjs/sdk/earn.d.ts.map +1 -1
- package/dist/commonjs/sdk/earn.js +4 -11
- package/dist/commonjs/sdk/earn.js.map +1 -1
- package/dist/esm/funcs/earnEarnVaults.d.ts +6 -3
- package/dist/esm/funcs/earnEarnVaults.d.ts.map +1 -1
- package/dist/esm/funcs/earnEarnVaults.js +7 -3
- package/dist/esm/funcs/earnEarnVaults.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/index.d.ts +1 -2
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +1 -2
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/vaultinfo.d.ts +22 -110
- package/dist/esm/models/components/vaultinfo.d.ts.map +1 -1
- package/dist/esm/models/components/vaultinfo.js +19 -58
- package/dist/esm/models/components/vaultinfo.js.map +1 -1
- package/dist/esm/models/components/{vaultslistresponse.d.ts → vaultsresponse.d.ts} +5 -5
- package/dist/esm/models/components/vaultsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/{vaultslistresponse.js → vaultsresponse.js} +4 -4
- package/dist/esm/models/components/vaultsresponse.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +0 -1
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -1
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2earnvaults.d.ts +5 -0
- package/dist/esm/models/operations/v2earnvaults.d.ts.map +1 -1
- package/dist/esm/models/operations/v2earnvaults.js +2 -0
- package/dist/esm/models/operations/v2earnvaults.js.map +1 -1
- package/dist/esm/sdk/earn.d.ts +5 -9
- package/dist/esm/sdk/earn.d.ts.map +1 -1
- package/dist/esm/sdk/earn.js +4 -11
- package/dist/esm/sdk/earn.js.map +1 -1
- package/docs/models/components/vaultinfo.md +19 -43
- package/docs/models/components/{vaultslistresponse.md → vaultsresponse.md} +15 -8
- package/docs/models/operations/v2earnvaultsrequest.md +4 -3
- package/docs/sdks/earn/README.md +8 -84
- package/examples/node_modules/@types/node/README.md +1 -1
- package/examples/node_modules/@types/node/package.json +2 -2
- package/examples/node_modules/@types/node/process.d.ts +5 -0
- package/examples/package-lock.json +3 -3
- package/package.json +1 -1
- package/src/funcs/earnEarnVaults.ts +10 -6
- package/src/lib/config.ts +2 -2
- package/src/models/components/index.ts +1 -2
- package/src/models/components/vaultinfo.ts +41 -168
- package/src/models/components/{vaultslistresponse.ts → vaultsresponse.ts} +8 -8
- package/src/models/operations/index.ts +0 -1
- package/src/models/operations/v2earnvaults.ts +7 -0
- package/src/sdk/earn.ts +5 -20
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.d.ts +0 -19
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.d.ts.map +0 -1
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.js +0 -129
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.js.map +0 -1
- package/dist/commonjs/models/components/earnpositionresponse.d.ts +0 -25
- package/dist/commonjs/models/components/earnpositionresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/earnpositionresponse.js +0 -64
- package/dist/commonjs/models/components/earnpositionresponse.js.map +0 -1
- package/dist/commonjs/models/components/vaultslistresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/vaultslistresponse.js.map +0 -1
- package/dist/commonjs/models/operations/v2earnpositionspositionid.d.ts +0 -25
- package/dist/commonjs/models/operations/v2earnpositionspositionid.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2earnpositionspositionid.js +0 -57
- package/dist/commonjs/models/operations/v2earnpositionspositionid.js.map +0 -1
- package/dist/esm/funcs/earnEarnPositionsPositionId.d.ts +0 -19
- package/dist/esm/funcs/earnEarnPositionsPositionId.d.ts.map +0 -1
- package/dist/esm/funcs/earnEarnPositionsPositionId.js +0 -93
- package/dist/esm/funcs/earnEarnPositionsPositionId.js.map +0 -1
- package/dist/esm/models/components/earnpositionresponse.d.ts +0 -25
- package/dist/esm/models/components/earnpositionresponse.d.ts.map +0 -1
- package/dist/esm/models/components/earnpositionresponse.js +0 -26
- package/dist/esm/models/components/earnpositionresponse.js.map +0 -1
- package/dist/esm/models/components/vaultslistresponse.d.ts.map +0 -1
- package/dist/esm/models/components/vaultslistresponse.js.map +0 -1
- package/dist/esm/models/operations/v2earnpositionspositionid.d.ts +0 -25
- package/dist/esm/models/operations/v2earnpositionspositionid.d.ts.map +0 -1
- package/dist/esm/models/operations/v2earnpositionspositionid.js +0 -20
- package/dist/esm/models/operations/v2earnpositionspositionid.js.map +0 -1
- package/docs/models/components/earnpositionresponse.md +0 -26
- package/docs/models/components/positionunion.md +0 -32
- package/docs/models/operations/v2earnpositionspositionidrequest.md +0 -21
- package/src/funcs/earnEarnPositionsPositionId.ts +0 -183
- package/src/models/components/earnpositionresponse.ts +0 -74
- package/src/models/operations/v2earnpositionspositionid.ts +0 -54
|
@@ -1,183 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
import { CompassApiSDKCore } from "../core.js";
|
|
6
|
-
import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
|
|
7
|
-
import * as M from "../lib/matchers.js";
|
|
8
|
-
import { compactMap } from "../lib/primitives.js";
|
|
9
|
-
import { safeParse } from "../lib/schemas.js";
|
|
10
|
-
import { RequestOptions } from "../lib/sdks.js";
|
|
11
|
-
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
12
|
-
import { pathToFunc } from "../lib/url.js";
|
|
13
|
-
import * as components from "../models/components/index.js";
|
|
14
|
-
import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
|
|
15
|
-
import {
|
|
16
|
-
ConnectionError,
|
|
17
|
-
InvalidRequestError,
|
|
18
|
-
RequestAbortedError,
|
|
19
|
-
RequestTimeoutError,
|
|
20
|
-
UnexpectedClientError,
|
|
21
|
-
} from "../models/errors/httpclienterrors.js";
|
|
22
|
-
import * as errors from "../models/errors/index.js";
|
|
23
|
-
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
24
|
-
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
25
|
-
import * as operations from "../models/operations/index.js";
|
|
26
|
-
import { APICall, APIPromise } from "../types/async.js";
|
|
27
|
-
import { Result } from "../types/fp.js";
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* Get earn position
|
|
31
|
-
*
|
|
32
|
-
* @remarks
|
|
33
|
-
* This endpoint fetches a single Compass Earn position by its encoded ID.
|
|
34
|
-
*/
|
|
35
|
-
export function earnEarnPositionsPositionId(
|
|
36
|
-
client: CompassApiSDKCore,
|
|
37
|
-
request: operations.V2EarnPositionsPositionIdRequest,
|
|
38
|
-
options?: RequestOptions,
|
|
39
|
-
): APIPromise<
|
|
40
|
-
Result<
|
|
41
|
-
components.EarnPositionResponse,
|
|
42
|
-
| errors.HTTPValidationError
|
|
43
|
-
| CompassAPISDKError
|
|
44
|
-
| ResponseValidationError
|
|
45
|
-
| ConnectionError
|
|
46
|
-
| RequestAbortedError
|
|
47
|
-
| RequestTimeoutError
|
|
48
|
-
| InvalidRequestError
|
|
49
|
-
| UnexpectedClientError
|
|
50
|
-
| SDKValidationError
|
|
51
|
-
>
|
|
52
|
-
> {
|
|
53
|
-
return new APIPromise($do(
|
|
54
|
-
client,
|
|
55
|
-
request,
|
|
56
|
-
options,
|
|
57
|
-
));
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
async function $do(
|
|
61
|
-
client: CompassApiSDKCore,
|
|
62
|
-
request: operations.V2EarnPositionsPositionIdRequest,
|
|
63
|
-
options?: RequestOptions,
|
|
64
|
-
): Promise<
|
|
65
|
-
[
|
|
66
|
-
Result<
|
|
67
|
-
components.EarnPositionResponse,
|
|
68
|
-
| errors.HTTPValidationError
|
|
69
|
-
| CompassAPISDKError
|
|
70
|
-
| ResponseValidationError
|
|
71
|
-
| ConnectionError
|
|
72
|
-
| RequestAbortedError
|
|
73
|
-
| RequestTimeoutError
|
|
74
|
-
| InvalidRequestError
|
|
75
|
-
| UnexpectedClientError
|
|
76
|
-
| SDKValidationError
|
|
77
|
-
>,
|
|
78
|
-
APICall,
|
|
79
|
-
]
|
|
80
|
-
> {
|
|
81
|
-
const parsed = safeParse(
|
|
82
|
-
request,
|
|
83
|
-
(value) =>
|
|
84
|
-
operations.V2EarnPositionsPositionIdRequest$outboundSchema.parse(value),
|
|
85
|
-
"Input validation failed",
|
|
86
|
-
);
|
|
87
|
-
if (!parsed.ok) {
|
|
88
|
-
return [parsed, { status: "invalid" }];
|
|
89
|
-
}
|
|
90
|
-
const payload = parsed.value;
|
|
91
|
-
const body = null;
|
|
92
|
-
|
|
93
|
-
const pathParams = {
|
|
94
|
-
position_id: encodeSimple("position_id", payload.position_id, {
|
|
95
|
-
explode: false,
|
|
96
|
-
charEncoding: "percent",
|
|
97
|
-
}),
|
|
98
|
-
};
|
|
99
|
-
|
|
100
|
-
const path = pathToFunc("/v2/earn/positions/{position_id}")(pathParams);
|
|
101
|
-
|
|
102
|
-
const query = encodeFormQuery({
|
|
103
|
-
"days": payload.days,
|
|
104
|
-
"user_address": payload.user_address,
|
|
105
|
-
});
|
|
106
|
-
|
|
107
|
-
const headers = new Headers(compactMap({
|
|
108
|
-
Accept: "application/json",
|
|
109
|
-
}));
|
|
110
|
-
|
|
111
|
-
const secConfig = await extractSecurity(client._options.apiKeyAuth);
|
|
112
|
-
const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
|
|
113
|
-
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
114
|
-
|
|
115
|
-
const context = {
|
|
116
|
-
options: client._options,
|
|
117
|
-
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
118
|
-
operationID: "v2_earn_positions_{position_id}",
|
|
119
|
-
oAuth2Scopes: null,
|
|
120
|
-
|
|
121
|
-
resolvedSecurity: requestSecurity,
|
|
122
|
-
|
|
123
|
-
securitySource: client._options.apiKeyAuth,
|
|
124
|
-
retryConfig: options?.retries
|
|
125
|
-
|| client._options.retryConfig
|
|
126
|
-
|| { strategy: "none" },
|
|
127
|
-
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
128
|
-
};
|
|
129
|
-
|
|
130
|
-
const requestRes = client._createRequest(context, {
|
|
131
|
-
security: requestSecurity,
|
|
132
|
-
method: "GET",
|
|
133
|
-
baseURL: options?.serverURL,
|
|
134
|
-
path: path,
|
|
135
|
-
headers: headers,
|
|
136
|
-
query: query,
|
|
137
|
-
body: body,
|
|
138
|
-
userAgent: client._options.userAgent,
|
|
139
|
-
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
|
|
140
|
-
}, options);
|
|
141
|
-
if (!requestRes.ok) {
|
|
142
|
-
return [requestRes, { status: "invalid" }];
|
|
143
|
-
}
|
|
144
|
-
const req = requestRes.value;
|
|
145
|
-
|
|
146
|
-
const doResult = await client._do(req, {
|
|
147
|
-
context,
|
|
148
|
-
errorCodes: ["422", "4XX", "5XX"],
|
|
149
|
-
retryConfig: context.retryConfig,
|
|
150
|
-
retryCodes: context.retryCodes,
|
|
151
|
-
});
|
|
152
|
-
if (!doResult.ok) {
|
|
153
|
-
return [doResult, { status: "request-error", request: req }];
|
|
154
|
-
}
|
|
155
|
-
const response = doResult.value;
|
|
156
|
-
|
|
157
|
-
const responseFields = {
|
|
158
|
-
HttpMeta: { Response: response, Request: req },
|
|
159
|
-
};
|
|
160
|
-
|
|
161
|
-
const [result] = await M.match<
|
|
162
|
-
components.EarnPositionResponse,
|
|
163
|
-
| errors.HTTPValidationError
|
|
164
|
-
| CompassAPISDKError
|
|
165
|
-
| ResponseValidationError
|
|
166
|
-
| ConnectionError
|
|
167
|
-
| RequestAbortedError
|
|
168
|
-
| RequestTimeoutError
|
|
169
|
-
| InvalidRequestError
|
|
170
|
-
| UnexpectedClientError
|
|
171
|
-
| SDKValidationError
|
|
172
|
-
>(
|
|
173
|
-
M.json(200, components.EarnPositionResponse$inboundSchema),
|
|
174
|
-
M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
|
|
175
|
-
M.fail("4XX"),
|
|
176
|
-
M.fail("5XX"),
|
|
177
|
-
)(response, req, { extraFields: responseFields });
|
|
178
|
-
if (!result.ok) {
|
|
179
|
-
return [result, { status: "complete", request: req, response }];
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
return [result, { status: "complete", request: req, response }];
|
|
183
|
-
}
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
import * as z from "zod/v3";
|
|
6
|
-
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
-
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
-
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
-
import { AavePosition, AavePosition$inboundSchema } from "./aaveposition.js";
|
|
10
|
-
import {
|
|
11
|
-
CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition,
|
|
12
|
-
CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
|
|
13
|
-
} from "./compassapibackendv2modelsearnreadresponsepositionsvaultposition.js";
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* The user's earn position.
|
|
17
|
-
*/
|
|
18
|
-
export type PositionUnion =
|
|
19
|
-
| AavePosition
|
|
20
|
-
| CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition;
|
|
21
|
-
|
|
22
|
-
/**
|
|
23
|
-
* Response model for a single earn position.
|
|
24
|
-
*/
|
|
25
|
-
export type EarnPositionResponse = {
|
|
26
|
-
/**
|
|
27
|
-
* The user's earn position.
|
|
28
|
-
*/
|
|
29
|
-
position:
|
|
30
|
-
| AavePosition
|
|
31
|
-
| CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition;
|
|
32
|
-
};
|
|
33
|
-
|
|
34
|
-
/** @internal */
|
|
35
|
-
export const PositionUnion$inboundSchema: z.ZodType<
|
|
36
|
-
PositionUnion,
|
|
37
|
-
z.ZodTypeDef,
|
|
38
|
-
unknown
|
|
39
|
-
> = z.union([
|
|
40
|
-
AavePosition$inboundSchema,
|
|
41
|
-
CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
|
|
42
|
-
]);
|
|
43
|
-
|
|
44
|
-
export function positionUnionFromJSON(
|
|
45
|
-
jsonString: string,
|
|
46
|
-
): SafeParseResult<PositionUnion, SDKValidationError> {
|
|
47
|
-
return safeParse(
|
|
48
|
-
jsonString,
|
|
49
|
-
(x) => PositionUnion$inboundSchema.parse(JSON.parse(x)),
|
|
50
|
-
`Failed to parse 'PositionUnion' from JSON`,
|
|
51
|
-
);
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
/** @internal */
|
|
55
|
-
export const EarnPositionResponse$inboundSchema: z.ZodType<
|
|
56
|
-
EarnPositionResponse,
|
|
57
|
-
z.ZodTypeDef,
|
|
58
|
-
unknown
|
|
59
|
-
> = z.object({
|
|
60
|
-
position: z.union([
|
|
61
|
-
AavePosition$inboundSchema,
|
|
62
|
-
CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
|
|
63
|
-
]),
|
|
64
|
-
});
|
|
65
|
-
|
|
66
|
-
export function earnPositionResponseFromJSON(
|
|
67
|
-
jsonString: string,
|
|
68
|
-
): SafeParseResult<EarnPositionResponse, SDKValidationError> {
|
|
69
|
-
return safeParse(
|
|
70
|
-
jsonString,
|
|
71
|
-
(x) => EarnPositionResponse$inboundSchema.parse(JSON.parse(x)),
|
|
72
|
-
`Failed to parse 'EarnPositionResponse' from JSON`,
|
|
73
|
-
);
|
|
74
|
-
}
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
import * as z from "zod/v3";
|
|
6
|
-
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
-
|
|
8
|
-
export type V2EarnPositionsPositionIdRequest = {
|
|
9
|
-
/**
|
|
10
|
-
* Base64-encoded position identifier
|
|
11
|
-
*/
|
|
12
|
-
positionId: string;
|
|
13
|
-
/**
|
|
14
|
-
* The address of the user to get the position for.
|
|
15
|
-
*/
|
|
16
|
-
userAddress: string;
|
|
17
|
-
/**
|
|
18
|
-
* How many days back from the current time to include in the blockchain scan (vault positions only).
|
|
19
|
-
*/
|
|
20
|
-
days?: number | undefined;
|
|
21
|
-
};
|
|
22
|
-
|
|
23
|
-
/** @internal */
|
|
24
|
-
export type V2EarnPositionsPositionIdRequest$Outbound = {
|
|
25
|
-
position_id: string;
|
|
26
|
-
user_address: string;
|
|
27
|
-
days?: number | undefined;
|
|
28
|
-
};
|
|
29
|
-
|
|
30
|
-
/** @internal */
|
|
31
|
-
export const V2EarnPositionsPositionIdRequest$outboundSchema: z.ZodType<
|
|
32
|
-
V2EarnPositionsPositionIdRequest$Outbound,
|
|
33
|
-
z.ZodTypeDef,
|
|
34
|
-
V2EarnPositionsPositionIdRequest
|
|
35
|
-
> = z.object({
|
|
36
|
-
positionId: z.string(),
|
|
37
|
-
userAddress: z.string(),
|
|
38
|
-
days: z.number().int().optional(),
|
|
39
|
-
}).transform((v) => {
|
|
40
|
-
return remap$(v, {
|
|
41
|
-
positionId: "position_id",
|
|
42
|
-
userAddress: "user_address",
|
|
43
|
-
});
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
export function v2EarnPositionsPositionIdRequestToJSON(
|
|
47
|
-
v2EarnPositionsPositionIdRequest: V2EarnPositionsPositionIdRequest,
|
|
48
|
-
): string {
|
|
49
|
-
return JSON.stringify(
|
|
50
|
-
V2EarnPositionsPositionIdRequest$outboundSchema.parse(
|
|
51
|
-
v2EarnPositionsPositionIdRequest,
|
|
52
|
-
),
|
|
53
|
-
);
|
|
54
|
-
}
|