Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc 3.0.1, Speakeasy CLI 1.123.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@speakeasybot
speakeasybot committed Nov 27, 2023
1 parent 12d3e78 commit 5d65327
Show file tree
Hide file tree
Showing 13 changed files with 6,781 additions and 1,091 deletions.
63 changes: 31 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,30 @@ It has been generated successfully based on your OpenAPI spec. However, it is no
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
<!-- Start SDK Installation -->
<!-- Start SDK Installation [installation] -->
## SDK Installation

### NPM

```bash
npm add Bolt-Typescript-SDK
npm add @boltpay/bolt-typescript-sdk
```

### Yarn

```bash
yarn add Bolt-Typescript-SDK
yarn add @boltpay/bolt-typescript-sdk
```
<!-- End SDK Installation -->
<!-- End SDK Installation [installation] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
<!-- Start SDK Example Usage -->

### Example

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async () => {
const sdk = new BoltTypescriptSDK({
Expand All @@ -55,12 +56,11 @@ import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
})();

```
<!-- End SDK Example Usage -->
<!-- End SDK Example Usage [usage] -->

<!-- Start SDK Available Operations -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations


### [account](docs/sdks/account/README.md)

* [getDetails](docs/sdks/account/README.md#getdetails) - Retrieve account details
Expand Down Expand Up @@ -92,9 +92,9 @@ import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";

* [createAccount](docs/sdks/testing/README.md#createaccount) - Create a test account
* [getCreditCard](docs/sdks/testing/README.md#getcreditcard) - Retrieve a test credit card, including its token
<!-- End SDK Available Operations -->
<!-- End Available Resources and Operations [operations] -->

<!-- Start Error Handling -->
<!-- Start Error Handling [errors] -->
## Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
Expand All @@ -107,8 +107,8 @@ Handling errors in this SDK should largely match your expectations. All operati
Example

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand All @@ -134,9 +134,9 @@ const xPublishableKey: string = "string";
}
})();
```
<!-- End Error Handling -->
<!-- End Error Handling [errors] -->
<!-- Start Server Selection -->
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Index
Expand All @@ -150,8 +150,8 @@ You can override the default server globally by passing a server index to the `s
#### Example

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";
(async () => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -181,8 +181,8 @@ Some of the server options above contain variables. If you want to set the value

The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";
(async () => {
const sdk = new BoltTypescriptSDK({
Expand All @@ -202,17 +202,17 @@ import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
})();
```
<!-- End Server Selection -->
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.

For example, you could specify a header for every request that your sdk makes as follows:

```typescript
from Bolt-Typescript-SDK import BoltTypescriptSDK;
from @boltpay/bolt-typescript-sdk import BoltTypescriptSDK;
import axios;
const httpClient = axios.create({
Expand All @@ -221,10 +221,9 @@ const httpClient = axios.create({
const sdk = new BoltTypescriptSDK({defaultClient: httpClient});
```
<!-- End Custom HTTP Client -->

<!-- Start Authentication -->
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes
Expand All @@ -238,8 +237,8 @@ This SDK supports the following security schemes globally:

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";
(async () => {
const sdk = new BoltTypescriptSDK({
Expand All @@ -263,7 +262,7 @@ import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";

Some operations in this SDK require the security scheme to be specified at the request level. For example:
```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import {
Amount,
Cart,
Expand All @@ -273,11 +272,11 @@ import {
Currency,
GuestPaymentInitializeRequest,
ProfileCreationData,
} from "Bolt-Typescript-SDK/dist/models/components";
} from "@boltpay/bolt-typescript-sdk/dist/models/components";
import {
GuestPaymentsInitializeRequest,
GuestPaymentsInitializeSecurity,
} from "Bolt-Typescript-SDK/dist/models/operations";
} from "@boltpay/bolt-typescript-sdk/dist/models/operations";
(async () => {
const sdk = new BoltTypescriptSDK();
Expand Down Expand Up @@ -353,7 +352,7 @@ import {
})();
```
<!-- End Authentication -->
<!-- End Authentication [security] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,14 @@ Based on:
### Generated
- [typescript v0.1.0] .
### Releases
- [NPM v0.1.0] https://www.npmjs.com/package/Bolt-Typescript-SDK/v/0.1.0 - .
- [NPM v0.1.0] https://www.npmjs.com/package/Bolt-Typescript-SDK/v/0.1.0 - .

## 2023-11-27 17:52:07
### Changes
Based on:
- OpenAPI Doc 3.0.1
- Speakeasy CLI 1.123.0 (2.202.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.2.0] .
### Releases
- [NPM v0.2.0] https://www.npmjs.com/package/@boltpay/bolt-typescript-sdk/v/0.2.0 - .
8 changes: 4 additions & 4 deletions USAGE.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Start SDK Example Usage -->
<!-- Start SDK Example Usage [usage] -->
```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async () => {
const sdk = new BoltTypescriptSDK({
Expand All @@ -20,4 +20,4 @@ import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
})();

```
<!-- End SDK Example Usage -->
<!-- End SDK Example Usage [usage] -->
34 changes: 17 additions & 17 deletions docs/sdks/account/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Retrieve a shopper's account details, such as addresses and payment information
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountGetRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountGetRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -69,9 +69,9 @@ Add an address to the shopper's account
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AddressListingInput, CountryCode } from "Bolt-Typescript-SDK/dist/models/components";
import { AccountAddressCreateRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AddressListingInput, CountryCode } from "@boltpay/bolt-typescript-sdk/dist/models/components";
import { AccountAddressCreateRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -131,8 +131,8 @@ shipments that are associated with it.
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountAddressDeleteRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountAddressDeleteRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -181,9 +181,9 @@ shipments.
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AddressListingInput, CountryCode } from "Bolt-Typescript-SDK/dist/models/components";
import { AccountAddressEditRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AddressListingInput, CountryCode } from "@boltpay/bolt-typescript-sdk/dist/models/components";
import { AccountAddressEditRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -243,9 +243,9 @@ Determine whether or not an identifier is associated with an existing Bolt accou
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { Identifier, IdentifierType } from "Bolt-Typescript-SDK/dist/models/components";
import { AccountExistsRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { Identifier, IdentifierType } from "@boltpay/bolt-typescript-sdk/dist/models/components";
import { AccountExistsRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -298,8 +298,8 @@ which is documented in [Install the Bolt Tokenizer](https://help.bolt.com/develo
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountAddPaymentMethodRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountAddPaymentMethodRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down Expand Up @@ -346,8 +346,8 @@ orders that are associated with it.
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { AccountPaymentMethodDeleteRequest } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { AccountPaymentMethodDeleteRequest } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK({
Expand Down
18 changes: 9 additions & 9 deletions docs/sdks/guest/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Bolt when it is updated or finalized for guest shoppers.
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import {
Amount,
Cart,
Expand All @@ -26,8 +26,8 @@ import {
Currency,
GuestPaymentInitializeRequest,
ProfileCreationData,
} from "Bolt-Typescript-SDK/dist/models/components";
import { GuestPaymentsInitializeRequest, GuestPaymentsInitializeSecurity } from "Bolt-Typescript-SDK/dist/models/operations";
} from "@boltpay/bolt-typescript-sdk/dist/models/components";
import { GuestPaymentsInitializeRequest, GuestPaymentsInitializeSecurity } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK();
Expand Down Expand Up @@ -127,7 +127,7 @@ Update a pending guest payment
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import {
Amount,
Cart,
Expand All @@ -136,8 +136,8 @@ import {
CartShipment,
Currency,
PaymentUpdateRequest,
} from "Bolt-Typescript-SDK/dist/models/components";
import { GuestPaymentsUpdateRequest, GuestPaymentsUpdateSecurity } from "Bolt-Typescript-SDK/dist/models/operations";
} from "@boltpay/bolt-typescript-sdk/dist/models/components";
import { GuestPaymentsUpdateRequest, GuestPaymentsUpdateSecurity } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK();
Expand Down Expand Up @@ -231,9 +231,9 @@ Perform an irreversible action on a pending guest payment, such as finalizing it
### Example Usage

```typescript
import { BoltTypescriptSDK } from "Bolt-Typescript-SDK";
import { DotTag, PaymentActionRequest } from "Bolt-Typescript-SDK/dist/models/components";
import { GuestPaymentsActionRequest, GuestPaymentsActionSecurity } from "Bolt-Typescript-SDK/dist/models/operations";
import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk";
import { DotTag, PaymentActionRequest } from "@boltpay/bolt-typescript-sdk/dist/models/components";
import { GuestPaymentsActionRequest, GuestPaymentsActionSecurity } from "@boltpay/bolt-typescript-sdk/dist/models/operations";

(async() => {
const sdk = new BoltTypescriptSDK();
Expand Down
Loading

0 comments on commit 5d65327

Please sign in to comment.