Skip to content

Commit 6de2900

Browse files
fern-api[bot]fern-api[bot]
committed
SDK regeneration
1 parent f9e8df0 commit 6de2900

File tree

21 files changed

+459
-246
lines changed

21 files changed

+459
-246
lines changed

‎.npmignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ tests
66
.fernignore
77
.prettierrc.yml
88
tsconfig.json
9-
yarn.lock
9+
yarn.lock
10+
pnpm-lock.yaml

‎README.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# Anduril TypeScript Library
1+
# Lattice SDK TypeScript Library
22

33
![](https://www.anduril.com/lattice-sdk/)
44

5+
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fanduril%2Flattice-sdk-javascript)
56
[![npm shield](https://img.shields.io/npm/v/@anduril-industries/lattice-sdk)](https://www.npmjs.com/package/@anduril-industries/lattice-sdk)
67

7-
The Lattice SDK TypeScript library provides convenient access to the Lattice API from TypeScript.
8+
The Lattice SDK TypeScript library provides convenient access to the Lattice SDK APIs from TypeScript.
89

910
## Documentation
1011

@@ -548,6 +549,18 @@ const response = await client.entities.longPollEntityEvents(..., {
548549
});
549550
```
550551

552+
### Additional Query String Parameters
553+
554+
If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
555+
556+
```typescript
557+
const response = await client.entities.longPollEntityEvents(..., {
558+
queryParams: {
559+
'customQueryParamKey': 'custom query param value'
560+
}
561+
});
562+
```
563+
551564
### Retries
552565

553566
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@anduril-industries/lattice-sdk",
3-
"version": "2.2.0",
3+
"version": "2.2.1",
44
"private": false,
55
"repository": "github:anduril/lattice-sdk-javascript",
66
"license": "See LICENSE",

‎reference.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -801,6 +801,77 @@ while (page.hasNextPage()) {
801801
</dl>
802802
</details>
803803

804+
<details><summary><code>client.objects.<a href="/src/api/resources/objects/client/Client.ts">getObject</a>(objectPath, { ...params }) -> core.BinaryResponse</code></summary>
805+
<dl>
806+
<dd>
807+
808+
#### 📝 Description
809+
810+
<dl>
811+
<dd>
812+
813+
<dl>
814+
<dd>
815+
816+
Fetches an object from your environment using the objectPath path parameter.
817+
818+
</dd>
819+
</dl>
820+
</dd>
821+
</dl>
822+
823+
#### 🔌 Usage
824+
825+
<dl>
826+
<dd>
827+
828+
<dl>
829+
<dd>
830+
831+
```typescript
832+
await client.objects.getObject("objectPath");
833+
```
834+
835+
</dd>
836+
</dl>
837+
</dd>
838+
</dl>
839+
840+
#### ⚙️ Parameters
841+
842+
<dl>
843+
<dd>
844+
845+
<dl>
846+
<dd>
847+
848+
**objectPath:** `string` — The path of the object to fetch.
849+
850+
</dd>
851+
</dl>
852+
853+
<dl>
854+
<dd>
855+
856+
**request:** `Lattice.GetObjectRequest`
857+
858+
</dd>
859+
</dl>
860+
861+
<dl>
862+
<dd>
863+
864+
**requestOptions:** `Objects.RequestOptions`
865+
866+
</dd>
867+
</dl>
868+
</dd>
869+
</dl>
870+
871+
</dd>
872+
</dl>
873+
</details>
874+
804875
<details><summary><code>client.objects.<a href="/src/api/resources/objects/client/Client.ts">deleteObject</a>(objectPath) -> void</code></summary>
805876
<dl>
806877
<dd>

‎src/Client.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ export declare namespace LatticeClient {
2626
maxRetries?: number;
2727
/** A hook to abort the request. */
2828
abortSignal?: AbortSignal;
29+
/** Additional query string parameters to include in the request. */
30+
queryParams?: Record<string, unknown>;
2931
/** Additional headers to include in the request. */
3032
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3133
}
@@ -44,8 +46,8 @@ export class LatticeClient {
4446
{
4547
"X-Fern-Language": "JavaScript",
4648
"X-Fern-SDK-Name": "@anduril-industries/lattice-sdk",
47-
"X-Fern-SDK-Version": "2.2.0",
48-
"User-Agent": "@anduril-industries/lattice-sdk/2.2.0",
49+
"X-Fern-SDK-Version": "2.2.1",
50+
"User-Agent": "@anduril-industries/lattice-sdk/2.2.1",
4951
"X-Fern-Runtime": core.RUNTIME.type,
5052
"X-Fern-Runtime-Version": core.RUNTIME.version,
5153
},

‎src/api/resources/entities/client/Client.ts‎

Lines changed: 44 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ export declare namespace Entities {
2525
maxRetries?: number;
2626
/** A hook to abort the request. */
2727
abortSignal?: AbortSignal;
28+
/** Additional query string parameters to include in the request. */
29+
queryParams?: Record<string, unknown>;
2830
/** Additional headers to include in the request. */
2931
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
3032
}
@@ -69,6 +71,11 @@ export class Entities {
6971
request: Lattice.Entity,
7072
requestOptions?: Entities.RequestOptions,
7173
): Promise<core.WithRawResponse<Lattice.Entity>> {
74+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
75+
this._options?.headers,
76+
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
77+
requestOptions?.headers,
78+
);
7279
const _response = await core.fetcher({
7380
url: core.url.join(
7481
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -77,12 +84,9 @@ export class Entities {
7784
"api/v1/entities",
7885
),
7986
method: "PUT",
80-
headers: mergeHeaders(
81-
this._options?.headers,
82-
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
83-
requestOptions?.headers,
84-
),
87+
headers: _headers,
8588
contentType: "application/json",
89+
queryParameters: requestOptions?.queryParams,
8690
requestType: "json",
8791
body: request,
8892
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -147,6 +151,11 @@ export class Entities {
147151
entityId: string,
148152
requestOptions?: Entities.RequestOptions,
149153
): Promise<core.WithRawResponse<Lattice.Entity>> {
154+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
155+
this._options?.headers,
156+
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
157+
requestOptions?.headers,
158+
);
150159
const _response = await core.fetcher({
151160
url: core.url.join(
152161
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -155,11 +164,8 @@ export class Entities {
155164
`api/v1/entities/${encodeURIComponent(entityId)}`,
156165
),
157166
method: "GET",
158-
headers: mergeHeaders(
159-
this._options?.headers,
160-
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
161-
requestOptions?.headers,
162-
),
167+
headers: _headers,
168+
queryParameters: requestOptions?.queryParams,
163169
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
164170
maxRetries: requestOptions?.maxRetries,
165171
abortSignal: requestOptions?.abortSignal,
@@ -240,6 +246,11 @@ export class Entities {
240246
request: Lattice.EntityOverride = {},
241247
requestOptions?: Entities.RequestOptions,
242248
): Promise<core.WithRawResponse<Lattice.Entity>> {
249+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
250+
this._options?.headers,
251+
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
252+
requestOptions?.headers,
253+
);
243254
const _response = await core.fetcher({
244255
url: core.url.join(
245256
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -248,12 +259,9 @@ export class Entities {
248259
`api/v1/entities/${encodeURIComponent(entityId)}/override/${encodeURIComponent(fieldPath)}`,
249260
),
250261
method: "PUT",
251-
headers: mergeHeaders(
252-
this._options?.headers,
253-
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
254-
requestOptions?.headers,
255-
),
262+
headers: _headers,
256263
contentType: "application/json",
264+
queryParameters: requestOptions?.queryParams,
257265
requestType: "json",
258266
body: request,
259267
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -327,6 +335,11 @@ export class Entities {
327335
fieldPath: string,
328336
requestOptions?: Entities.RequestOptions,
329337
): Promise<core.WithRawResponse<Lattice.Entity>> {
338+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
339+
this._options?.headers,
340+
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
341+
requestOptions?.headers,
342+
);
330343
const _response = await core.fetcher({
331344
url: core.url.join(
332345
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -335,11 +348,8 @@ export class Entities {
335348
`api/v1/entities/${encodeURIComponent(entityId)}/override/${encodeURIComponent(fieldPath)}`,
336349
),
337350
method: "DELETE",
338-
headers: mergeHeaders(
339-
this._options?.headers,
340-
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
341-
requestOptions?.headers,
342-
),
351+
headers: _headers,
352+
queryParameters: requestOptions?.queryParams,
343353
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
344354
maxRetries: requestOptions?.maxRetries,
345355
abortSignal: requestOptions?.abortSignal,
@@ -420,6 +430,11 @@ export class Entities {
420430
request: Lattice.EntityEventRequest,
421431
requestOptions?: Entities.RequestOptions,
422432
): Promise<core.WithRawResponse<Lattice.EntityEventResponse>> {
433+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
434+
this._options?.headers,
435+
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
436+
requestOptions?.headers,
437+
);
423438
const _response = await core.fetcher({
424439
url: core.url.join(
425440
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -428,12 +443,9 @@ export class Entities {
428443
"api/v1/entities/events",
429444
),
430445
method: "POST",
431-
headers: mergeHeaders(
432-
this._options?.headers,
433-
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
434-
requestOptions?.headers,
435-
),
446+
headers: _headers,
436447
contentType: "application/json",
448+
queryParameters: requestOptions?.queryParams,
437449
requestType: "json",
438450
body: request,
439451
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -496,6 +508,11 @@ export class Entities {
496508
request: Lattice.EntityStreamRequest = {},
497509
requestOptions?: Entities.RequestOptions,
498510
): Promise<core.WithRawResponse<core.Stream<Lattice.StreamEntitiesResponse>>> {
511+
let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
512+
this._options?.headers,
513+
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
514+
requestOptions?.headers,
515+
);
499516
const _response = await core.fetcher<ReadableStream>({
500517
url: core.url.join(
501518
(await core.Supplier.get(this._options.baseUrl)) ??
@@ -504,12 +521,9 @@ export class Entities {
504521
"api/v1/entities/stream",
505522
),
506523
method: "POST",
507-
headers: mergeHeaders(
508-
this._options?.headers,
509-
mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
510-
requestOptions?.headers,
511-
),
524+
headers: _headers,
512525
contentType: "application/json",
526+
queryParameters: requestOptions?.queryParams,
513527
requestType: "json",
514528
body: request,
515529
responseType: "sse",

0 commit comments

Comments
 (0)