ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.337.1

BoltApp · Jul 17, 2024 · 026a6e6 · 026a6e6
1 parent 0187fae
commit 026a6e6
Show file tree

Hide file tree

Showing 78 changed files with 573 additions and 349 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,20 +1,21 @@
 lockVersion: 2.0.0
 id: 79fa0df9-852a-493c-b998-1d82654b5f18
 management:
-  docChecksum: 8134778d948a05652350ab91383aff9c
-  docVersion: 3.1.0
-  speakeasyVersion: 1.331.0
-  generationVersion: 2.365.0
-  releaseVersion: 0.17.1
-  configChecksum: 7ca902bf9ecf9be66f9391dea83d3b34
+  docChecksum: 1c6f0a40f6a34b5758d83681c80c8538
+  docVersion: 3.1.1
+  speakeasyVersion: 1.337.1
+  generationVersion: 2.373.2
+  releaseVersion: 0.18.0
+  configChecksum: 53969aeb13fadf716b60f94bca566c60
   repoURL: https://github.com/BoltApp/Bolt-Typescript-SDK.git
   repoSubDirectory: .
   installationURL: https://github.com/BoltApp/Bolt-Typescript-SDK
   published: true
 features:
   typescript:
     additionalDependencies: 0.1.0
-    core: 3.11.6
+    core: 3.11.7
+    defaultEnabledRetries: 0.1.0
     errorUnions: 0.1.0
     flattening: 2.81.1
     globalSecurity: 2.82.9
@@ -26,6 +27,7 @@ features:
     methodSecurity: 2.82.4
     nameOverrides: 2.81.2
     responseFormat: 0.2.3
+    retries: 2.83.0
     sdkHooks: 0.1.0
     unions: 2.85.5
 generatedFiles:
@@ -294,6 +296,7 @@ generatedFiles:
   - docs/models/errors/testingaccountphonegetresponsebody.md
   - docs/models/errors/testingcreditcardgetresponsebody.md
   - docs/sdks/bolttypescriptsdk/README.md
+  - docs/lib/utils/retryconfig.md
   - docs/sdks/account/README.md
   - docs/sdks/payments/README.md
   - docs/sdks/guest/README.md
@@ -306,3 +309,4 @@ generatedFiles:
   - src/hooks/hooks.ts
   - src/hooks/types.ts
   - src/hooks/index.ts
+  - CONTRIBUTING.md
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,18 +1,18 @@
-speakeasyVersion: 1.331.0
+speakeasyVersion: 1.337.1
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:06c8068d722d2be028f7bcfa60ad1adc4cfd6f8691e44e0da3ea6fccfce548e1
-        sourceBlobDigest: sha256:5ec4dc0eec5c87e6fe98d45c90baebdecf3c088ee12729fd2c45cd4185367c4a
+        sourceRevisionDigest: sha256:a29c38c34ea084412a21ec783cc9e0ecc2ad18bb42fd6caa7a45132d75063024
+        sourceBlobDigest: sha256:a17e5df430bc16f512ae76c093dd0dcd353e4994a539061a27c0575f157717d5
         tags:
             - latest
             - main
 targets:
     bolt-typescript:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:06c8068d722d2be028f7bcfa60ad1adc4cfd6f8691e44e0da3ea6fccfce548e1
-        sourceBlobDigest: sha256:5ec4dc0eec5c87e6fe98d45c90baebdecf3c088ee12729fd2c45cd4185367c4a
+        sourceRevisionDigest: sha256:a29c38c34ea084412a21ec783cc9e0ecc2ad18bb42fd6caa7a45132d75063024
+        sourceBlobDigest: sha256:a17e5df430bc16f512ae76c093dd0dcd353e4994a539061a27c0575f157717d5
         outLocation: /github/workspace/repo
 workflow:
     workflowVersion: 1.0.0

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Contributing to This Repository
+
+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.
+
+## How to Report Issues
+
+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:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Any relevant logs, screenshots, or error messages
+- Information about your environment (e.g., operating system, software versions)
+    - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
+
+## Issue Triage and Upstream Fixes
+
+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.
+
+## Contact
+
+If you have any questions or need further assistance, please feel free to reach out by opening an issue.
+
+Thank you for your understanding and cooperation!
+
+The Maintainers
diff --git a/README.md b/README.md
@@ -70,35 +70,35 @@ run();
 * [addAddress](docs/sdks/account/README.md#addaddress) - Add an address
 * [updateAddress](docs/sdks/account/README.md#updateaddress) - Edit an existing address
 * [deleteAddress](docs/sdks/account/README.md#deleteaddress) - Delete an existing address
-* [addPaymentMethod](docs/sdks/account/README.md#addpaymentmethod) - Add a payment method to a shopper's Bolt account Wallet.
+* [addPaymentMethod](docs/sdks/account/README.md#addpaymentmethod) - Add a payment method
 * [deletePaymentMethod](docs/sdks/account/README.md#deletepaymentmethod) - Delete an existing payment method
 
 
 ### [payments.guest](docs/sdks/guest/README.md)
 
 * [initialize](docs/sdks/guest/README.md#initialize) - Initialize a Bolt payment for guest shoppers
-* [update](docs/sdks/guest/README.md#update) - Update an existing guest payment
-* [performAction](docs/sdks/guest/README.md#performaction) - Perform an irreversible action (e.g. finalize) on a pending guest payment
+* [update](docs/sdks/guest/README.md#update) - Update a pending guest payment
+* [performAction](docs/sdks/guest/README.md#performaction) - Finalize a pending guest payment
 
 ### [payments.loggedIn](docs/sdks/loggedin/README.md)
 
 * [initialize](docs/sdks/loggedin/README.md#initialize) - Initialize a Bolt payment for logged in shoppers
-* [update](docs/sdks/loggedin/README.md#update) - Update an existing payment
-* [performAction](docs/sdks/loggedin/README.md#performaction) - Perform an irreversible action (e.g. finalize) on a pending payment
+* [update](docs/sdks/loggedin/README.md#update) - Update a pending payment
+* [performAction](docs/sdks/loggedin/README.md#performaction) - Finalize a pending payment
 
 ### [oAuth](docs/sdks/oauth/README.md)
 
 * [getToken](docs/sdks/oauth/README.md#gettoken) - Get OAuth token
 
 ### [orders](docs/sdks/orders/README.md)
 
-* [ordersCreate](docs/sdks/orders/README.md#orderscreate) - Create an order that was placed outside the Bolt ecosystem.
+* [ordersCreate](docs/sdks/orders/README.md#orderscreate) - Create an order that was prepared outside the Bolt ecosystem.
 
 ### [testing](docs/sdks/testing/README.md)
 
 * [createAccount](docs/sdks/testing/README.md#createaccount) - Create a test account
 * [testingAccountPhoneGet](docs/sdks/testing/README.md#testingaccountphoneget) - Get a random phone number
-* [getCreditCard](docs/sdks/testing/README.md#getcreditcard) - Retrieve a test credit card, including its token
+* [getCreditCard](docs/sdks/testing/README.md#getcreditcard) - Retrieve a tokenized test credit card
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Error Handling [errors] -->
@@ -408,6 +408,75 @@ run();
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- End Requirements [requirements] -->
 
+<!-- Start Retries [retries] -->
+## Retries
+
+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.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
+
+const boltTypescriptSDK = new BoltTypescriptSDK({
+    security: {
+        oauth: "<YOUR_OAUTH_HERE>",
+    },
+});
+
+async function run() {
+    const result = await boltTypescriptSDK.account.getDetails("<value>", "<value>", {
+        retries: {
+            strategy: "backoff",
+            backoff: {
+                initialInterval: 1,
+                maxInterval: 50,
+                exponent: 1.1,
+                maxElapsedTime: 100,
+            },
+            retryConnectionErrors: false,
+        },
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
+
+const boltTypescriptSDK = new BoltTypescriptSDK({
+    retryConfig: {
+        strategy: "backoff",
+        backoff: {
+            initialInterval: 1,
+            maxInterval: 50,
+            exponent: 1.1,
+            maxElapsedTime: 100,
+        },
+        retryConnectionErrors: false,
+    },
+    security: {
+        oauth: "<YOUR_OAUTH_HERE>",
+    },
+});
+
+async function run() {
+    const result = await boltTypescriptSDK.account.getDetails("<value>", "<value>");
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development

diff --git a/RELEASES.md b/RELEASES.md
@@ -528,4 +528,14 @@ Based on:
 ### Generated
 - [typescript v0.17.1] .
 ### Releases
-- [NPM v0.17.1] https://www.npmjs.com/package/@boltpay/bolt-typescript-sdk/v/0.17.1 - .
+- [NPM v0.17.1] https://www.npmjs.com/package/@boltpay/bolt-typescript-sdk/v/0.17.1 - .
+
+## 2024-07-17 00:18:43
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.337.1 (2.373.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.18.0] .
+### Releases
+- [NPM v0.18.0] https://www.npmjs.com/package/@boltpay/bolt-typescript-sdk/v/0.18.0 - .
diff --git a/docs/lib/utils/retryconfig.md b/docs/lib/utils/retryconfig.md
@@ -0,0 +1,24 @@
+# RetryConfig
+
+Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
+
+## Fields
+
+| Name                      | Type                                | Description                                                                                | Example     |
+| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
+| `strategy`                | `"backoff" | "none"`                | The retry strategy to use.                                                                 | `"backoff"` |
+| `backoff`                 | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters.                  |             |
+| `retryConnectionErrors`   | `*boolean*`                         | When strategy is "backoff", this determines whether or not to retry on connection errors.  | `true`      |
+
+## BackoffStrategy
+
+The backoff strategy allows retrying a request with an exponential backoff between each retry.
+
+### Fields
+
+| Name               | Type         | Description                               | Example  |
+| ------------------ | ------------ | ----------------------------------------- | -------- |
+| `initialInterval`  | `*number*`   | The initial interval in milliseconds.     | `500`    |
+| `maxInterval`      | `*number*`   | The maximum interval in milliseconds.     | `60000`  |
+| `exponent`         | `*number*`   | The exponent to use for the backoff.      | `1.5`    |
+| `maxElapsedTime`   | `*number*`   | The maximum elapsed time in milliseconds. | `300000` |
diff --git a/docs/models/components/account.md b/docs/models/components/account.md
@@ -7,4 +7,4 @@
 | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
 | `addresses`                                                              | [components.AddressListing](../../models/components/addresslisting.md)[] | :heavy_check_mark:                                                       | A list of addresses associated with this account.                        |
 | `paymentMethods`                                                         | *components.PaymentMethod*[]                                             | :heavy_check_mark:                                                       | A list of payment methods associated with this account.                  |
-| `profile`                                                                | [components.Profile](../../models/components/profile.md)                 | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `profile`                                                                | [components.Profile](../../models/components/profile.md)                 | :heavy_minus_sign:                                                       | An account's identifying information.                                    |