# Testing (*testing*) ## Overview Use the Testing API to generate and retrieve test data to verify a subset of flows in non-production environments. ### Available Operations * [createAccount](#createaccount) - Create a test account * [testingAccountPhoneGet](#testingaccountphoneget) - Get a random phone number * [getCreditCard](#getcreditcard) - Retrieve a tokenized test credit card ## createAccount Create a Bolt shopper account for testing purposes. ### Example Usage ```typescript import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk"; import { EmailState, PhoneState } from "@boltpay/bolt-typescript-sdk/models/components"; const boltTypescriptSDK = new BoltTypescriptSDK(); async function run() { const result = await boltTypescriptSDK.testing.createAccount({ apiKey: "", }, { emailState: EmailState.Unverified, phoneState: PhoneState.Verified, isMigrated: true, hasAddress: true, hasCreditCard: true, }, ""); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { BoltTypescriptSDKCore } from "@boltpay/bolt-typescript-sdk/core.js"; import { testingCreateAccount } from "@boltpay/bolt-typescript-sdk/funcs/testingCreateAccount.js"; import { EmailState, PhoneState } from "@boltpay/bolt-typescript-sdk/models/components"; // Use `BoltTypescriptSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const boltTypescriptSDK = new BoltTypescriptSDKCore(); async function run() { const res = await testingCreateAccount(boltTypescriptSDK, { apiKey: "", }, { emailState: EmailState.Unverified, phoneState: PhoneState.Verified, isMigrated: true, hasAddress: true, hasCreditCard: true, }, ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `security` | [operations.TestingAccountCreateSecurity](../../models/operations/testingaccountcreatesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | | `xPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `accountTestCreationData` | [components.AccountTestCreationData](../../models/components/accounttestcreationdata.md) | :heavy_check_mark: | N/A | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `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. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.TestingAccountCreateResponse](../../models/operations/testingaccountcreateresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ----------------- | ----------------- | ----------------- | | errors.ErrorT | 4XX | application/json | | errors.FieldError | 4XX | application/json | | errors.SDKError | 5XX | \*/\* | ## testingAccountPhoneGet Get a random, fictitious phone number that is not assigned to any existing Bolt account. ### Example Usage ```typescript import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk"; const boltTypescriptSDK = new BoltTypescriptSDK(); async function run() { const result = await boltTypescriptSDK.testing.testingAccountPhoneGet({ apiKey: "", }, ""); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { BoltTypescriptSDKCore } from "@boltpay/bolt-typescript-sdk/core.js"; import { testingTestingAccountPhoneGet } from "@boltpay/bolt-typescript-sdk/funcs/testingTestingAccountPhoneGet.js"; // Use `BoltTypescriptSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const boltTypescriptSDK = new BoltTypescriptSDKCore(); async function run() { const res = await testingTestingAccountPhoneGet(boltTypescriptSDK, { apiKey: "", }, ""); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `security` | [operations.TestingAccountPhoneGetSecurity](../../models/operations/testingaccountphonegetsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | | `xPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `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. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.TestingAccountPhoneGetResponse](../../models/operations/testingaccountphonegetresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ----------------- | ----------------- | ----------------- | | errors.ErrorT | 4XX | application/json | | errors.FieldError | 4XX | application/json | | errors.SDKError | 5XX | \*/\* | ## getCreditCard Retrieve a test credit card that can be used to process payments in your Bolt testing environment. The response includes the card's Bolt credit card token. ### Example Usage ```typescript import { BoltTypescriptSDK } from "@boltpay/bolt-typescript-sdk"; import { Type } from "@boltpay/bolt-typescript-sdk/models/operations"; const boltTypescriptSDK = new BoltTypescriptSDK(); async function run() { const result = await boltTypescriptSDK.testing.getCreditCard({ apiKey: "", }, { type: Type.Approve, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { BoltTypescriptSDKCore } from "@boltpay/bolt-typescript-sdk/core.js"; import { testingGetCreditCard } from "@boltpay/bolt-typescript-sdk/funcs/testingGetCreditCard.js"; import { Type } from "@boltpay/bolt-typescript-sdk/models/operations"; // Use `BoltTypescriptSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const boltTypescriptSDK = new BoltTypescriptSDKCore(); async function run() { const res = await testingGetCreditCard(boltTypescriptSDK, { apiKey: "", }, { type: Type.Approve, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.TestingCreditCardGetRequestBody](../../models/operations/testingcreditcardgetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `security` | [operations.TestingCreditCardGetSecurity](../../models/operations/testingcreditcardgetsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `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. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.TestingCreditCardGetResponse](../../models/operations/testingcreditcardgetresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ----------------- | ----------------- | ----------------- | | errors.ErrorT | 4XX | application/json | | errors.FieldError | 4XX | application/json | | errors.SDKError | 5XX | \*/\* |