Skip to content

Commit 583c155

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.346.3
1 parent f8d9a23 commit 583c155

File tree

92 files changed

+3184
-1728
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+3184
-1728
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/esm
2+
/dist
3+
/.tshy
4+
/.tshy-*
15
/models
26
/models/errors
37
/types

‎.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55

66
/.eslintrc.js
77
/cjs
8+
/.tshy
9+
/.tshy-*

‎.speakeasy/gen.lock

+9-5
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,26 @@ id: 0115721b-c5d5-4598-9754-02eb24f100a8
33
management:
44
docChecksum: 108d5939aa1f55ecaef7b1e04e7745b6
55
docVersion: 1.0.0
6-
speakeasyVersion: 1.309.1
7-
generationVersion: 2.347.4
8-
releaseVersion: 0.9.1
9-
configChecksum: 3144aadae02ffcdbc2bcf9d1a9c2c8c7
6+
speakeasyVersion: 1.346.3
7+
generationVersion: 2.379.6
8+
releaseVersion: 0.10.0
9+
configChecksum: df1796ba257da0b8304dc3fd01342587
1010
repoURL: https://github.com/speakeasy-sdks/nango-typescript-sdk.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-sdks/nango-typescript-sdk
1313
published: true
1414
features:
1515
typescript:
1616
additionalDependencies: 0.1.0
17-
core: 3.10.0
17+
core: 3.11.10
18+
defaultEnabledRetries: 0.1.0
1819
flattening: 2.81.1
1920
globalSecurityCallbacks: 0.1.0
2021
globalServerURLs: 2.82.4
2122
groups: 2.81.2
2223
nameOverrides: 2.81.2
2324
responseFormat: 0.2.3
25+
retries: 2.83.0
2426
sdkHooks: 0.1.0
2527
serverIDs: 2.81.2
2628
generatedFiles:
@@ -158,6 +160,7 @@ generatedFiles:
158160
- docs/models/operations/patchproxyrequest.md
159161
- docs/models/operations/deleteproxyrequest.md
160162
- docs/sdks/nango/README.md
163+
- docs/lib/utils/retryconfig.md
161164
- docs/sdks/integrations/README.md
162165
- docs/sdks/connections/README.md
163166
- docs/sdks/records/README.md
@@ -170,3 +173,4 @@ generatedFiles:
170173
- src/hooks/hooks.ts
171174
- src/hooks/types.ts
172175
- src/hooks/index.ts
176+
- CONTRIBUTING.md

‎.speakeasy/workflow.lock

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
speakeasyVersion: 1.309.1
1+
speakeasyVersion: 1.346.3
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:28f8ad416a8c616c03f380901b4f45883c023ec04e4d65ae5a811a8168c45108
6-
sourceBlobDigest: sha256:efa987571d8346ba36b22ab4746cdde4b9470314c134765f1b925c8d4bf07dae
5+
sourceRevisionDigest: sha256:df54796f529635fb568ba72c74aaaef6cd6648b26e220d76c073c0fa406f7720
6+
sourceBlobDigest: sha256:ee8fa2cba530915e9b36f27a1b286a0b32b485e920a549ca7a809b1fb5fe68a5
77
tags:
88
- latest
9+
- main
910
targets:
1011
nango-ts:
1112
source: my-source
1213
sourceNamespace: my-source
13-
sourceRevisionDigest: sha256:28f8ad416a8c616c03f380901b4f45883c023ec04e4d65ae5a811a8168c45108
14-
sourceBlobDigest: sha256:efa987571d8346ba36b22ab4746cdde4b9470314c134765f1b925c8d4bf07dae
15-
outLocation: /Users/sagar/go/src/Nango-sample-sdk
14+
sourceRevisionDigest: sha256:df54796f529635fb568ba72c74aaaef6cd6648b26e220d76c073c0fa406f7720
15+
sourceBlobDigest: sha256:ee8fa2cba530915e9b36f27a1b286a0b32b485e920a549ca7a809b1fb5fe68a5
16+
outLocation: /github/workspace/repo
1617
workflow:
1718
workflowVersion: 1.0.0
1819
speakeasyVersion: latest

‎CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to This Repository
2+
3+
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
4+
5+
## How to Report Issues
6+
7+
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
8+
9+
- A clear and descriptive title
10+
- Steps to reproduce the issue
11+
- Expected and actual behavior
12+
- Any relevant logs, screenshots, or error messages
13+
- Information about your environment (e.g., operating system, software versions)
14+
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
15+
16+
## Issue Triage and Upstream Fixes
17+
18+
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
19+
20+
## Contact
21+
22+
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
23+
24+
Thank you for your understanding and cooperation!
25+
26+
The Maintainers

‎README.md

+62
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,68 @@ const sdk = new Nango({ httpClient });
277277
```
278278
<!-- End Custom HTTP Client [http-client] -->
279279

280+
<!-- Start Retries [retries] -->
281+
## Retries
282+
283+
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
284+
285+
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
286+
```typescript
287+
import { Nango } from "@speakeasy-sdks/nango";
288+
289+
const nango = new Nango();
290+
291+
async function run() {
292+
const result = await nango.integrations.list({
293+
retries: {
294+
strategy: "backoff",
295+
backoff: {
296+
initialInterval: 1,
297+
maxInterval: 50,
298+
exponent: 1.1,
299+
maxElapsedTime: 100,
300+
},
301+
retryConnectionErrors: false,
302+
},
303+
});
304+
305+
// Handle the result
306+
console.log(result);
307+
}
308+
309+
run();
310+
311+
```
312+
313+
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
314+
```typescript
315+
import { Nango } from "@speakeasy-sdks/nango";
316+
317+
const nango = new Nango({
318+
retryConfig: {
319+
strategy: "backoff",
320+
backoff: {
321+
initialInterval: 1,
322+
maxInterval: 50,
323+
exponent: 1.1,
324+
maxElapsedTime: 100,
325+
},
326+
retryConnectionErrors: false,
327+
},
328+
});
329+
330+
async function run() {
331+
const result = await nango.integrations.list();
332+
333+
// Handle the result
334+
console.log(result);
335+
}
336+
337+
run();
338+
339+
```
340+
<!-- End Retries [retries] -->
341+
280342
<!-- Placeholder for Future Speakeasy SDK Sections -->
281343

282344
# Development

‎RELEASES.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,12 @@ Based on:
130130
### Generated
131131
- [typescript v0.6.0] .
132132
### Releases
133-
- [NPM v0.6.0] https://www.npmjs.com/package/@simplesagar92/nango/v/0.6.0 - .
133+
- [NPM v0.6.0] https://www.npmjs.com/package/@simplesagar92/nango/v/0.6.0 - .
134+
135+
## 2024-07-28 00:26:03
136+
### Changes
137+
Based on:
138+
- OpenAPI Doc
139+
- Speakeasy CLI 1.346.3 (2.379.6) https://github.com/speakeasy-api/speakeasy
140+
### Generated
141+
- [typescript v0.10.0] .

‎RUNTIMES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This SDK is intended to be used in JavaScript runtimes that support the following features:
44

55
* [Web Fetch API][web-fetch]
6-
* [Web Streams API](web-streams) and in particular `ReadableStream`
6+
* [Web Streams API][web-streams] and in particular `ReadableStream`
77
* [Async iterables][async-iter] using `Symbol.asyncIterator`
88

99
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

‎docs/lib/utils/retryconfig.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# RetryConfig
2+
3+
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
4+
5+
## Fields
6+
7+
| Name | Type | Description | Example |
8+
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
9+
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
10+
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
11+
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
12+
13+
## BackoffStrategy
14+
15+
The backoff strategy allows retrying a request with an exponential backoff between each retry.
16+
17+
### Fields
18+
19+
| Name | Type | Description | Example |
20+
| ------------------ | ------------ | ----------------------------------------- | -------- |
21+
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
22+
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
23+
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
24+
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |

‎docs/sdks/actions/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ run();
3737
| `createActionTriggerRequest` | [components.CreateActionTriggerRequest](../../models/components/createactiontriggerrequest.md) | :heavy_check_mark: | N/A |
3838
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
3939
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
40+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
4041

4142

4243
### Response

0 commit comments

Comments
 (0)