diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index ff3251e..83c6594 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,17 +1,17 @@ lockVersion: 2.0.0 id: 6be0ff6b-aa40-4b34-a3eb-72d091b3c545 management: - docChecksum: 8134778d948a05652350ab91383aff9c - docVersion: 3.1.0 - speakeasyVersion: 1.335.0 - generationVersion: 2.370.2 - releaseVersion: 0.0.3 - configChecksum: d41c4dd5448f6b31d422386248d2a5b0 + docChecksum: 8c2776c2cbcdc065c8bb4d1442f50ef5 + docVersion: 3.2.0 + speakeasyVersion: 1.343.0 + generationVersion: 2.376.0 + releaseVersion: 0.1.0 + configChecksum: 27191b201ea859cbe26f76a3507b6d48 repoURL: https://github.com/BoltApp/Bolt-CSharp-SDK.git features: csharp: additionalDependencies: 0.1.0 - core: 3.9.9 + core: 3.9.10 errorUnions: 0.1.0 flattening: 2.81.2 globalSecurity: 2.83.4 @@ -28,11 +28,11 @@ features: unions: 0.1.1 generatedFiles: - Boltpay/SDK/Account.cs - - Boltpay/SDK/Guest.cs - Boltpay/SDK/LoggedIn.cs + - Boltpay/SDK/Guest.cs - Boltpay/SDK/Payments.cs - - Boltpay/SDK/OAuth.cs - Boltpay/SDK/Orders.cs + - Boltpay/SDK/OAuth.cs - Boltpay/SDK/Testing.cs - Boltpay/SDK/BoltSDK.cs - global.json @@ -68,26 +68,21 @@ generatedFiles: - Boltpay/SDK/Models/Requests/AccountAddPaymentMethodResponse.cs - Boltpay/SDK/Models/Requests/AccountPaymentMethodDeleteRequest.cs - Boltpay/SDK/Models/Requests/AccountPaymentMethodDeleteResponse.cs + - Boltpay/SDK/Models/Requests/PaymentsInitializeRequest.cs + - Boltpay/SDK/Models/Requests/PaymentsInitializeResponse.cs + - Boltpay/SDK/Models/Requests/PaymentsActionRequest.cs + - Boltpay/SDK/Models/Requests/PaymentsActionResponse.cs - Boltpay/SDK/Models/Requests/GuestPaymentsInitializeSecurity.cs - Boltpay/SDK/Models/Requests/GuestPaymentsInitializeRequest.cs - Boltpay/SDK/Models/Requests/GuestPaymentsInitializeResponse.cs - - Boltpay/SDK/Models/Requests/GuestPaymentsUpdateSecurity.cs - - Boltpay/SDK/Models/Requests/GuestPaymentsUpdateRequest.cs - - Boltpay/SDK/Models/Requests/GuestPaymentsUpdateResponse.cs - Boltpay/SDK/Models/Requests/GuestPaymentsActionSecurity.cs - Boltpay/SDK/Models/Requests/GuestPaymentsActionRequest.cs - Boltpay/SDK/Models/Requests/GuestPaymentsActionResponse.cs - - Boltpay/SDK/Models/Requests/PaymentsInitializeRequest.cs - - Boltpay/SDK/Models/Requests/PaymentsInitializeResponse.cs - - Boltpay/SDK/Models/Requests/PaymentsUpdateRequest.cs - - Boltpay/SDK/Models/Requests/PaymentsUpdateResponse.cs - - Boltpay/SDK/Models/Requests/PaymentsActionRequest.cs - - Boltpay/SDK/Models/Requests/PaymentsActionResponse.cs - - Boltpay/SDK/Models/Requests/OauthGetTokenRequest.cs - - Boltpay/SDK/Models/Requests/OauthGetTokenResponse.cs - Boltpay/SDK/Models/Requests/OrdersCreateSecurity.cs - Boltpay/SDK/Models/Requests/OrdersCreateRequest.cs - Boltpay/SDK/Models/Requests/OrdersCreateResponse.cs + - Boltpay/SDK/Models/Requests/OauthGetTokenRequest.cs + - Boltpay/SDK/Models/Requests/OauthGetTokenResponse.cs - Boltpay/SDK/Models/Requests/TestingAccountCreateSecurity.cs - Boltpay/SDK/Models/Requests/TestingAccountCreateRequest.cs - Boltpay/SDK/Models/Requests/TestingAccountCreateResponse.cs @@ -144,21 +139,22 @@ generatedFiles: - Boltpay/SDK/Models/Components/PaymentResponsePendingStatus.cs - Boltpay/SDK/Models/Components/Action.cs - Boltpay/SDK/Models/Components/PaymentResponsePending.cs - - Boltpay/SDK/Models/Components/GuestPaymentInitializeRequest.cs + - Boltpay/SDK/Models/Components/PaymentInitializeRequest.cs + - Boltpay/SDK/Models/Components/PaymentMethodExtended.cs + - Boltpay/SDK/Models/Components/PaymentMethodReferenceTag.cs + - Boltpay/SDK/Models/Components/PaymentMethodReference.cs - Boltpay/SDK/Models/Components/Cart.cs - Boltpay/SDK/Models/Components/Currency.cs - Boltpay/SDK/Models/Components/Amount.cs - Boltpay/SDK/Models/Components/CartItem.cs - Boltpay/SDK/Models/Components/CartDiscount.cs - Boltpay/SDK/Models/Components/CartShipment.cs - - Boltpay/SDK/Models/Components/ProfileCreationData.cs - - Boltpay/SDK/Models/Components/PaymentUpdateRequest.cs - Boltpay/SDK/Models/Components/PaymentActionRequestTag.cs - Boltpay/SDK/Models/Components/PaymentActionRequest.cs - - Boltpay/SDK/Models/Components/PaymentInitializeRequest.cs - - Boltpay/SDK/Models/Components/PaymentMethodExtended.cs - - Boltpay/SDK/Models/Components/PaymentMethodReferenceTag.cs - - Boltpay/SDK/Models/Components/PaymentMethodReference.cs + - Boltpay/SDK/Models/Components/GuestPaymentInitializeRequest.cs + - Boltpay/SDK/Models/Components/ProfileCreationData.cs + - Boltpay/SDK/Models/Components/OrderResponse.cs + - Boltpay/SDK/Models/Components/Order.cs - Boltpay/SDK/Models/Components/GetAccessTokenResponse.cs - Boltpay/SDK/Models/Components/TokenRequest.cs - Boltpay/SDK/Models/Components/GrantType.cs @@ -167,8 +163,6 @@ generatedFiles: - Boltpay/SDK/Models/Components/RefreshTokenRequestGrantType.cs - Boltpay/SDK/Models/Components/RefreshTokenRequestScope.cs - Boltpay/SDK/Models/Components/RefreshTokenRequest.cs - - Boltpay/SDK/Models/Components/OrderResponse.cs - - Boltpay/SDK/Models/Components/Order.cs - Boltpay/SDK/Models/Components/EmailState.cs - Boltpay/SDK/Models/Components/PhoneState.cs - Boltpay/SDK/Models/Components/AccountTestCreationDataOutput.cs @@ -200,26 +194,21 @@ generatedFiles: - docs/Models/Requests/AccountAddPaymentMethodResponse.md - docs/Models/Requests/AccountPaymentMethodDeleteRequest.md - docs/Models/Requests/AccountPaymentMethodDeleteResponse.md + - docs/Models/Requests/PaymentsInitializeRequest.md + - docs/Models/Requests/PaymentsInitializeResponse.md + - docs/Models/Requests/PaymentsActionRequest.md + - docs/Models/Requests/PaymentsActionResponse.md - docs/Models/Requests/GuestPaymentsInitializeSecurity.md - docs/Models/Requests/GuestPaymentsInitializeRequest.md - docs/Models/Requests/GuestPaymentsInitializeResponse.md - - docs/Models/Requests/GuestPaymentsUpdateSecurity.md - - docs/Models/Requests/GuestPaymentsUpdateRequest.md - - docs/Models/Requests/GuestPaymentsUpdateResponse.md - docs/Models/Requests/GuestPaymentsActionSecurity.md - docs/Models/Requests/GuestPaymentsActionRequest.md - docs/Models/Requests/GuestPaymentsActionResponse.md - - docs/Models/Requests/PaymentsInitializeRequest.md - - docs/Models/Requests/PaymentsInitializeResponse.md - - docs/Models/Requests/PaymentsUpdateRequest.md - - docs/Models/Requests/PaymentsUpdateResponse.md - - docs/Models/Requests/PaymentsActionRequest.md - - docs/Models/Requests/PaymentsActionResponse.md - - docs/Models/Requests/OauthGetTokenRequest.md - - docs/Models/Requests/OauthGetTokenResponse.md - docs/Models/Requests/OrdersCreateSecurity.md - docs/Models/Requests/OrdersCreateRequest.md - docs/Models/Requests/OrdersCreateResponse.md + - docs/Models/Requests/OauthGetTokenRequest.md + - docs/Models/Requests/OauthGetTokenResponse.md - docs/Models/Requests/TestingAccountCreateSecurity.md - docs/Models/Requests/TestingAccountCreateRequest.md - docs/Models/Requests/TestingAccountCreateResponse.md @@ -276,21 +265,22 @@ generatedFiles: - docs/Models/Components/PaymentResponsePendingStatus.md - docs/Models/Components/Action.md - docs/Models/Components/PaymentResponsePending.md - - docs/Models/Components/GuestPaymentInitializeRequest.md + - docs/Models/Components/PaymentInitializeRequest.md + - docs/Models/Components/PaymentMethodExtended.md + - docs/Models/Components/PaymentMethodReferenceTag.md + - docs/Models/Components/PaymentMethodReference.md - docs/Models/Components/Cart.md - docs/Models/Components/Currency.md - docs/Models/Components/Amount.md - docs/Models/Components/CartItem.md - docs/Models/Components/CartDiscount.md - docs/Models/Components/CartShipment.md - - docs/Models/Components/ProfileCreationData.md - - docs/Models/Components/PaymentUpdateRequest.md - docs/Models/Components/PaymentActionRequestTag.md - docs/Models/Components/PaymentActionRequest.md - - docs/Models/Components/PaymentInitializeRequest.md - - docs/Models/Components/PaymentMethodExtended.md - - docs/Models/Components/PaymentMethodReferenceTag.md - - docs/Models/Components/PaymentMethodReference.md + - docs/Models/Components/GuestPaymentInitializeRequest.md + - docs/Models/Components/ProfileCreationData.md + - docs/Models/Components/OrderResponse.md + - docs/Models/Components/Order.md - docs/Models/Components/GetAccessTokenResponse.md - docs/Models/Components/TokenRequest.md - docs/Models/Components/GrantType.md @@ -299,8 +289,6 @@ generatedFiles: - docs/Models/Components/RefreshTokenRequestGrantType.md - docs/Models/Components/RefreshTokenRequestScope.md - docs/Models/Components/RefreshTokenRequest.md - - docs/Models/Components/OrderResponse.md - - docs/Models/Components/Order.md - docs/Models/Components/EmailState.md - docs/Models/Components/PhoneState.md - docs/Models/Components/AccountTestCreationDataOutput.md @@ -323,12 +311,13 @@ generatedFiles: - docs/sdks/boltsdk/README.md - docs/sdks/account/README.md - docs/sdks/payments/README.md - - docs/sdks/guest/README.md - docs/sdks/loggedin/README.md - - docs/sdks/oauth/README.md + - docs/sdks/guest/README.md - docs/sdks/orders/README.md + - docs/sdks/oauth/README.md - docs/sdks/testing/README.md - USAGE.md - .gitattributes - Boltpay/SDK/Hooks/SDKHooks.cs - Boltpay/SDK/Hooks/HookTypes.cs + - CONTRIBUTING.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 1a305a5..cafd387 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false csharp: - version: 0.0.3 + version: 0.1.0 additionalDependencies: [] author: Speakeasy clientServerStatusCodesAsErrors: true diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 7abec76..c753c3e 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.335.0 +speakeasyVersion: 1.343.0 sources: bolt-csharp-api: sourceNamespace: bolt-csharp-api - sourceRevisionDigest: sha256:c3a777d13cc74ca1c3bd6939c6dfbc029e49bc1339736b7f234289036e8c1735 - sourceBlobDigest: sha256:a77794aed1632fc0b912bb540d7fd20c2bfa147dc0c9b31b217d34f8e9b1af69 + sourceRevisionDigest: sha256:db3b4aa375e37ee2decce246cc3da3d423d1ff70f91fb07587fcc7691be35b5f + sourceBlobDigest: sha256:7a91be379d22da373358989e5d3966989afcc5b13c5d65e50a3c91acea2e0a17 tags: - latest - master @@ -11,8 +11,8 @@ targets: bolt-sdk: source: bolt-csharp-api sourceNamespace: bolt-csharp-api - sourceRevisionDigest: sha256:c3a777d13cc74ca1c3bd6939c6dfbc029e49bc1339736b7f234289036e8c1735 - sourceBlobDigest: sha256:a77794aed1632fc0b912bb540d7fd20c2bfa147dc0c9b31b217d34f8e9b1af69 + sourceRevisionDigest: sha256:db3b4aa375e37ee2decce246cc3da3d423d1ff70f91fb07587fcc7691be35b5f + sourceBlobDigest: sha256:7a91be379d22da373358989e5d3966989afcc5b13c5d65e50a3c91acea2e0a17 outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 diff --git a/Boltpay/SDK/Account.cs b/Boltpay/SDK/Account.cs index 0c150b8..c817220 100644 --- a/Boltpay/SDK/Account.cs +++ b/Boltpay/SDK/Account.cs @@ -23,12 +23,7 @@ namespace Boltpay.SDK using System; /// - /// Account endpoints allow you to view and manage shoppers' accounts. For example,
- /// - /// - /// you can add or remove addresses and payment information.
- /// - /// + /// Use the Accounts API to access shoppers' accounts to empower your checkout and facilitate shoppers' choices. /// public interface IAccount { @@ -55,10 +50,7 @@ public interface IAccount /// Edit an existing address /// /// - /// Edit an existing address on the shopper's account. This does not edit addresses
- /// that are already associated with other resources, such as transactions or
- /// shipments.
- /// + /// Edit an existing address on the shopper's account. This does not edit addresses that are already associated with other resources, such as transactions or shipments. /// /// Task UpdateAddressAsync(string xPublishableKey, string xMerchantClientId, string id, AddressListingInput addressListing); @@ -67,22 +59,16 @@ public interface IAccount /// Delete an existing address /// /// - /// Delete an existing address. Deleting an address does not invalidate transactions or
- /// shipments that are associated with it.
- /// + /// Delete an existing address. Deleting an address does not invalidate or remove the address from transactions or shipments that are associated with it. /// /// Task DeleteAddressAsync(string xPublishableKey, string xMerchantClientId, string id); /// - /// Add a payment method to a shopper's Bolt account Wallet. + /// Add a payment method /// /// - /// Add a payment method to a shopper's Bolt account Wallet. For security purposes, this request must come from
- /// your backend because authentication requires the use of your private key.<br />
- /// **Note**: Before using this API, the credit card details must be tokenized using Bolt's JavaScript library function,
- /// which is documented in Install the Bolt Tokenizer.
- /// + /// Add a payment method to a shopper's Bolt Account Wallet. For security purposes, this request must come from your backend. <br/> **Note**: Before using this API, the credit card details must be tokenized by Bolt's credit card tokenization service. Please review our Bolt Payment Field Component or Install the Bolt Tokenizer documentation. /// /// Task AddPaymentMethodAsync(string xPublishableKey, string xMerchantClientId, PaymentMethodInput paymentMethod); @@ -91,30 +77,23 @@ public interface IAccount /// Delete an existing payment method /// /// - /// Delete an existing payment method. Deleting a payment method does not invalidate transactions or
- /// orders that are associated with it.
- /// + /// Delete an existing payment method. Deleting a payment method does not invalidate or remove it from transactions or orders that are associated with it. /// /// Task DeletePaymentMethodAsync(string xPublishableKey, string xMerchantClientId, string id); } /// - /// Account endpoints allow you to view and manage shoppers' accounts. For example,
- /// - /// - /// you can add or remove addresses and payment information.
- /// - /// + /// Use the Accounts API to access shoppers' accounts to empower your checkout and facilitate shoppers' choices. /// public class Account: IAccount { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/Boltpay/SDK/BoltSDK.cs b/Boltpay/SDK/BoltSDK.cs index f4583f3..7212182 100644 --- a/Boltpay/SDK/BoltSDK.cs +++ b/Boltpay/SDK/BoltSDK.cs @@ -63,50 +63,31 @@ public static ServerEnvironment ToEnum(this string value) } /// - /// Bolt API Reference: A comprehensive Bolt API reference for interacting with Transactions, Orders, Product Catalog, Configuration, Testing, and much more. + /// Bolt API Reference: A comprehensive Bolt API reference for interacting with Accounts, Payments, Orders and more. /// public interface IBoltSDK { /// - /// Account endpoints allow you to view and manage shoppers' accounts. For example,
- /// - /// - /// you can add or remove addresses and payment information.
- /// - /// + /// Use the Accounts API to access shoppers' accounts to empower your checkout and facilitate shoppers' choices. /// public IAccount Account { get; } public IPayments Payments { get; } /// - /// Use this endpoint to retrieve an OAuth token. Use the token to allow your ecommerce server to make calls to the Account
- /// - /// - /// endpoint and create a one-click checkout experience for shoppers.
- /// - /// - /// - /// https://help.bolt.com/products/accounts/direct-api/oauth-guide/} + /// Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem. /// - public IOAuth OAuth { get; } + public IOrders Orders { get; } /// - /// Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem.
+ /// Use the OAuth API to enable your ecommerce server to make API calls on behalf of a Bolt logged-in shopper. /// - /// - /// - /// + /// https://help.bolt.com/products/accounts/direct-api/oauth-guide/} /// - public IOrders Orders { get; } + public IOAuth OAuth { get; } /// - /// Endpoints that allow you to generate and retrieve test data to verify certain
- /// - /// - /// flows in non-production environments.
- /// - /// + /// Use the Testing API to generate and retrieve test data to verify a subset of flows in non-production environments. /// public ITesting Testing { get; } } @@ -148,25 +129,25 @@ public ISpeakeasyHttpClient InitHooks(ISpeakeasyHttpClient client) } /// - /// Bolt API Reference: A comprehensive Bolt API reference for interacting with Transactions, Orders, Product Catalog, Configuration, Testing, and much more. + /// Bolt API Reference: A comprehensive Bolt API reference for interacting with Accounts, Payments, Orders and more. /// public class BoltSDK: IBoltSDK { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private int _serverIndex = 0; private ISpeakeasyHttpClient _client; private Func? _securitySource; public IAccount Account { get; private set; } public IPayments Payments { get; private set; } - public IOAuth OAuth { get; private set; } public IOrders Orders { get; private set; } + public IOAuth OAuth { get; private set; } public ITesting Testing { get; private set; } public BoltSDK(Security? security = null, Func? securitySource = null, int? serverIndex = null, ServerEnvironment? environment = null, string? serverUrl = null, Dictionary? urlParams = null, ISpeakeasyHttpClient? client = null, RetryConfig? retryConfig = null) @@ -224,10 +205,10 @@ public BoltSDK(Security? security = null, Func? securitySource = null, Payments = new Payments(_client, _securitySource, _serverUrl, SDKConfiguration); - OAuth = new OAuth(_client, _securitySource, _serverUrl, SDKConfiguration); + Orders = new Orders(_client, _securitySource, _serverUrl, SDKConfiguration); - Orders = new Orders(_client, _securitySource, _serverUrl, SDKConfiguration); + OAuth = new OAuth(_client, _securitySource, _serverUrl, SDKConfiguration); Testing = new Testing(_client, _securitySource, _serverUrl, SDKConfiguration); diff --git a/Boltpay/SDK/Boltpay.SDK.csproj b/Boltpay/SDK/Boltpay.SDK.csproj index 4ba367e..2eb5d37 100644 --- a/Boltpay/SDK/Boltpay.SDK.csproj +++ b/Boltpay/SDK/Boltpay.SDK.csproj @@ -2,7 +2,7 @@ true Boltpay.SDK - 0.0.3 + 0.1.0 Speakeasy net8.0 enable diff --git a/Boltpay/SDK/Guest.cs b/Boltpay/SDK/Guest.cs index 16e095f..49c09da 100644 --- a/Boltpay/SDK/Guest.cs +++ b/Boltpay/SDK/Guest.cs @@ -29,29 +29,16 @@ public interface IGuest /// Initialize a Bolt payment for guest shoppers /// /// - /// Initialize a Bolt payment token that will be used to reference this payment to
- /// Bolt when it is updated or finalized for guest shoppers.
- /// + /// Initialize a Bolt guest shopper's intent to pay for a cart, using the specified payment method. Payments must be finalized before indicating the payment result to the shopper. Some payment methods will finalize automatically after initialization. For these payments, they will transition directly to "finalized" and the response from Initialize Payment will contain a finalized payment. /// /// Task InitializeAsync(GuestPaymentsInitializeSecurity security, string xPublishableKey, string xMerchantClientId, GuestPaymentInitializeRequest guestPaymentInitializeRequest); /// - /// Update an existing guest payment + /// Finalize a pending guest payment /// /// - /// Update a pending guest payment
- /// - /// - /// - Task UpdateAsync(GuestPaymentsUpdateSecurity security, string xPublishableKey, string xMerchantClientId, string id, PaymentUpdateRequest paymentUpdateRequest); - - /// - /// Perform an irreversible action (e.g. finalize) on a pending guest payment - /// - /// - /// Perform an irreversible action on a pending guest payment, such as finalizing it.
- /// + /// Finalize a pending payment being made by a Bolt guest shopper. Upon receipt of a finalized payment result, payment success should be communicated to the shopper. /// /// Task PerformActionAsync(GuestPaymentsActionSecurity security, string xPublishableKey, string xMerchantClientId, string id, PaymentActionRequest paymentActionRequest); @@ -61,10 +48,10 @@ public class Guest: IGuest { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; @@ -198,123 +185,6 @@ public async Task InitializeAsync(GuestPayments } } - public async Task UpdateAsync(GuestPaymentsUpdateSecurity security, string xPublishableKey, string xMerchantClientId, string id, PaymentUpdateRequest paymentUpdateRequest) - { - var request = new GuestPaymentsUpdateRequest() - { - XPublishableKey = xPublishableKey, - XMerchantClientId = xMerchantClientId, - Id = id, - PaymentUpdateRequest = paymentUpdateRequest, - }; - string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/guest/payments/{id}", request); - - var httpRequest = new HttpRequestMessage(HttpMethod.Patch, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); - HeaderSerializer.PopulateHeaders(ref httpRequest, request); - - var serializedBody = RequestBodySerializer.Serialize(request, "PaymentUpdateRequest", "json", false, false); - if (serializedBody != null) - { - httpRequest.Content = serializedBody; - } - - httpRequest = new SecurityMetadata(() => security).Apply(httpRequest); - - var hookCtx = new HookContext("guestPaymentsUpdate", null, () => security); - - httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); - - HttpResponseMessage httpResponse; - try - { - httpResponse = await _client.SendAsync(httpRequest); - int _statusCode = (int)httpResponse.StatusCode; - - if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) - { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); - if (_httpResponse != null) - { - httpResponse = _httpResponse; - } - } - } - catch (Exception error) - { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); - if (_httpResponse != null) - { - httpResponse = _httpResponse; - } - else - { - throw; - } - } - - httpResponse = await this.SDKConfiguration.Hooks.AfterSuccessAsync(new AfterSuccessContext(hookCtx), httpResponse); - - var contentType = httpResponse.Content.Headers.ContentType?.MediaType; - int responseStatusCode = (int)httpResponse.StatusCode; - if(responseStatusCode == 200) - { - if(Utilities.IsContentTypeMatch("application/json", contentType)) - { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - var response = new GuestPaymentsUpdateResponse() - { - HttpMeta = new Models.Components.HTTPMetadata() - { - Response = httpResponse, - Request = httpRequest - } - }; - response.PaymentResponse = obj; - return response; - } - else - { - throw new SDKException("Unknown content type received", httpRequest, httpResponse); - } - } - else if(responseStatusCode >= 400 && responseStatusCode < 500) - { - if(Utilities.IsContentTypeMatch("application/json", contentType)) - { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - switch (obj!.Type.ToString()) { - case "error": - throw obj!.Error!; - case "field-error": - throw obj!.FieldError!; - default: - throw new InvalidOperationException("Unknown error type."); - }; - } - else - { - throw new SDKException("Unknown content type received", httpRequest, httpResponse); - } - } - else if(responseStatusCode >= 500 && responseStatusCode < 600) - { - throw new SDKException("API error occurred", httpRequest, httpResponse); - } - else - { - return new GuestPaymentsUpdateResponse() - { - HttpMeta = new Models.Components.HTTPMetadata() - { - Response = httpResponse, - Request = httpRequest - } - }; - } - } - public async Task PerformActionAsync(GuestPaymentsActionSecurity security, string xPublishableKey, string xMerchantClientId, string id, PaymentActionRequest paymentActionRequest) { var request = new GuestPaymentsActionRequest() diff --git a/Boltpay/SDK/LoggedIn.cs b/Boltpay/SDK/LoggedIn.cs index 366b4ea..88bbdf1 100644 --- a/Boltpay/SDK/LoggedIn.cs +++ b/Boltpay/SDK/LoggedIn.cs @@ -29,29 +29,17 @@ public interface ILoggedIn /// Initialize a Bolt payment for logged in shoppers /// /// - /// Initialize a Bolt payment token that will be used to reference this payment to
- /// Bolt when it is updated or finalized for logged in shoppers.
+ /// Initialize a Bolt logged-in shopper's intent to pay for a cart, using the specified payment method. Payments must be finalized before indicating the payment result to the shopper. Some payment methods will finalize automatically after initialization. For these payments, they will transition directly to "finalized" and the response from Initialize Payment will contain a finalized payment.
/// /// /// Task InitializeAsync(string xPublishableKey, string xMerchantClientId, PaymentInitializeRequest paymentInitializeRequest); /// - /// Update an existing payment + /// Finalize a pending payment /// /// - /// Update a pending payment
- /// - /// - /// - Task UpdateAsync(string xPublishableKey, string xMerchantClientId, string id, PaymentUpdateRequest paymentUpdateRequest); - - /// - /// Perform an irreversible action (e.g. finalize) on a pending payment - /// - /// - /// Perform an irreversible action on a pending payment, such as finalizing it.
- /// + /// Finalize a pending payment being made by a Bolt logged-in shopper. Upon receipt of a finalized payment result, payment success should be communicated to the shopper. /// /// Task PerformActionAsync(string xPublishableKey, string xMerchantClientId, string id, PaymentActionRequest paymentActionRequest); @@ -61,10 +49,10 @@ public class LoggedIn: ILoggedIn { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; @@ -201,126 +189,6 @@ public async Task InitializeAsync(string xPublishabl } } - public async Task UpdateAsync(string xPublishableKey, string xMerchantClientId, string id, PaymentUpdateRequest paymentUpdateRequest) - { - var request = new PaymentsUpdateRequest() - { - XPublishableKey = xPublishableKey, - XMerchantClientId = xMerchantClientId, - Id = id, - PaymentUpdateRequest = paymentUpdateRequest, - }; - string baseUrl = this.SDKConfiguration.GetTemplatedServerUrl(); - var urlString = URLBuilder.Build(baseUrl, "/payments/{id}", request); - - var httpRequest = new HttpRequestMessage(HttpMethod.Patch, urlString); - httpRequest.Headers.Add("user-agent", _userAgent); - HeaderSerializer.PopulateHeaders(ref httpRequest, request); - - var serializedBody = RequestBodySerializer.Serialize(request, "PaymentUpdateRequest", "json", false, false); - if (serializedBody != null) - { - httpRequest.Content = serializedBody; - } - - if (_securitySource != null) - { - httpRequest = new SecurityMetadata(_securitySource).Apply(httpRequest); - } - - var hookCtx = new HookContext("paymentsUpdate", null, _securitySource); - - httpRequest = await this.SDKConfiguration.Hooks.BeforeRequestAsync(new BeforeRequestContext(hookCtx), httpRequest); - - HttpResponseMessage httpResponse; - try - { - httpResponse = await _client.SendAsync(httpRequest); - int _statusCode = (int)httpResponse.StatusCode; - - if (_statusCode >= 400 && _statusCode < 500 || _statusCode >= 500 && _statusCode < 600) - { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), httpResponse, null); - if (_httpResponse != null) - { - httpResponse = _httpResponse; - } - } - } - catch (Exception error) - { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); - if (_httpResponse != null) - { - httpResponse = _httpResponse; - } - else - { - throw; - } - } - - httpResponse = await this.SDKConfiguration.Hooks.AfterSuccessAsync(new AfterSuccessContext(hookCtx), httpResponse); - - var contentType = httpResponse.Content.Headers.ContentType?.MediaType; - int responseStatusCode = (int)httpResponse.StatusCode; - if(responseStatusCode == 200) - { - if(Utilities.IsContentTypeMatch("application/json", contentType)) - { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - var response = new PaymentsUpdateResponse() - { - HttpMeta = new Models.Components.HTTPMetadata() - { - Response = httpResponse, - Request = httpRequest - } - }; - response.PaymentResponse = obj; - return response; - } - else - { - throw new SDKException("Unknown content type received", httpRequest, httpResponse); - } - } - else if(responseStatusCode >= 400 && responseStatusCode < 500) - { - if(Utilities.IsContentTypeMatch("application/json", contentType)) - { - var obj = ResponseBodyDeserializer.Deserialize(await httpResponse.Content.ReadAsStringAsync(), NullValueHandling.Ignore); - switch (obj!.Type.ToString()) { - case "error": - throw obj!.Error!; - case "field-error": - throw obj!.FieldError!; - default: - throw new InvalidOperationException("Unknown error type."); - }; - } - else - { - throw new SDKException("Unknown content type received", httpRequest, httpResponse); - } - } - else if(responseStatusCode >= 500 && responseStatusCode < 600) - { - throw new SDKException("API error occurred", httpRequest, httpResponse); - } - else - { - return new PaymentsUpdateResponse() - { - HttpMeta = new Models.Components.HTTPMetadata() - { - Response = httpResponse, - Request = httpRequest - } - }; - } - } - public async Task PerformActionAsync(string xPublishableKey, string xMerchantClientId, string id, PaymentActionRequest paymentActionRequest) { var request = new PaymentsActionRequest() diff --git a/Boltpay/SDK/Models/Components/Account.cs b/Boltpay/SDK/Models/Components/Account.cs index 5112e56..659375b 100644 --- a/Boltpay/SDK/Models/Components/Account.cs +++ b/Boltpay/SDK/Models/Components/Account.cs @@ -29,6 +29,9 @@ public class Account [JsonProperty("payment_methods")] public List PaymentMethods { get; set; } = default!; + /// + /// An account's identifying information. + /// [JsonProperty("profile")] public Profile? Profile { get; set; } } diff --git a/Boltpay/SDK/Models/Components/AuthorizationCodeRequest.cs b/Boltpay/SDK/Models/Components/AuthorizationCodeRequest.cs index 1e304eb..856bc30 100644 --- a/Boltpay/SDK/Models/Components/AuthorizationCodeRequest.cs +++ b/Boltpay/SDK/Models/Components/AuthorizationCodeRequest.cs @@ -29,33 +29,19 @@ public class AuthorizationCodeRequest public string Code { get; set; } = default!; /// - /// The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved
- /// - /// - /// in the Merchant Dashboard.
- /// - /// + /// The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved in your Merchant Dashboard. /// [SpeakeasyMetadata("form:name=client_id")] public string ClientId { get; set; } = default!; /// - /// The OAuth client secret, which corresponds the merchant API key, which can be retrieved in the
- /// - /// - /// Merchant Dashboard.
- /// - /// + /// The OAuth client secret, which corresponds the merchant API key, which can be retrieved in your Merchant Dashboard. /// [SpeakeasyMetadata("form:name=client_secret")] public string ClientSecret { get; set; } = default!; /// - /// The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.
- /// - /// - /// - /// + /// The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes. /// /// https://help.bolt.com/developers/references/bolt-oauth/#scopes} - OAuth Developer Reference /// @@ -63,12 +49,7 @@ public class AuthorizationCodeRequest public List Scope { get; set; } = default!; /// - /// A randomly generated string sent along with an authorization code. This must be included, if provided,
- /// - /// - /// in order to prevent CSRF attacks. used to prevent CSRF attacks.
- /// - /// + /// A randomly generated string sent along with an authorization code. This must be included if provided. It is used to prevent cross-site request forgery (CSRF) attacks. /// [SpeakeasyMetadata("form:name=state")] public string? State { get; set; } diff --git a/Boltpay/SDK/Models/Components/GetAccessTokenResponse.cs b/Boltpay/SDK/Models/Components/GetAccessTokenResponse.cs index f5a135c..6d41081 100644 --- a/Boltpay/SDK/Models/Components/GetAccessTokenResponse.cs +++ b/Boltpay/SDK/Models/Components/GetAccessTokenResponse.cs @@ -16,13 +16,13 @@ public class GetAccessTokenResponse { /// - /// A JWT token issued when the request includes the scope open_id. + /// A JSON Web Token (JWT) issued when the request includes the scope open_id. /// [JsonProperty("id_token")] public string? IdToken { get; set; } /// - /// An access token you can use to make requests on behalf of a Bolt Account. + /// An access token you can use to make requests on behalf of a Bolt shopper. /// [JsonProperty("access_token")] public string? AccessToken { get; set; } @@ -46,12 +46,7 @@ public class GetAccessTokenResponse public string? RefreshTokenScope { get; set; } /// - /// The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter.
- /// - /// - /// Options include `bolt.account.manage`, `bolt.account.view`, `openid`. Multiple values can be returned as space-separated strings.
- /// - /// + /// The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter. Options include `bolt.account.manage`, `bolt.account.view`, `openid`. Multiple values can be returned as space-separated strings. /// [JsonProperty("scope")] public string? Scope { get; set; } diff --git a/Boltpay/SDK/Models/Components/Order.cs b/Boltpay/SDK/Models/Components/Order.cs index 69ca6d3..40714dd 100644 --- a/Boltpay/SDK/Models/Components/Order.cs +++ b/Boltpay/SDK/Models/Components/Order.cs @@ -16,6 +16,9 @@ namespace Boltpay.SDK.Models.Components public class Order { + /// + /// An account's identifying information. + /// [JsonProperty("profile")] public Profile Profile { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Components/PaymentUpdateRequest.cs b/Boltpay/SDK/Models/Components/PaymentUpdateRequest.cs deleted file mode 100644 index 930bfe2..0000000 --- a/Boltpay/SDK/Models/Components/PaymentUpdateRequest.cs +++ /dev/null @@ -1,22 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Boltpay.SDK.Models.Components -{ - using Boltpay.SDK.Models.Components; - using Boltpay.SDK.Utils; - using Newtonsoft.Json; - - public class PaymentUpdateRequest - { - - [JsonProperty("cart")] - public Cart? Cart { get; set; } - } -} \ No newline at end of file diff --git a/Boltpay/SDK/Models/Components/Profile.cs b/Boltpay/SDK/Models/Components/Profile.cs index 2630522..a5e4cec 100644 --- a/Boltpay/SDK/Models/Components/Profile.cs +++ b/Boltpay/SDK/Models/Components/Profile.cs @@ -12,6 +12,9 @@ namespace Boltpay.SDK.Models.Components using Boltpay.SDK.Utils; using Newtonsoft.Json; + /// + /// An account's identifying information. + /// public class Profile { diff --git a/Boltpay/SDK/Models/Components/ProfileCreationData.cs b/Boltpay/SDK/Models/Components/ProfileCreationData.cs index 3edb89a..06d4c38 100644 --- a/Boltpay/SDK/Models/Components/ProfileCreationData.cs +++ b/Boltpay/SDK/Models/Components/ProfileCreationData.cs @@ -12,6 +12,9 @@ namespace Boltpay.SDK.Models.Components using Boltpay.SDK.Utils; using Newtonsoft.Json; + /// + /// An account's identifying information. + /// public class ProfileCreationData { diff --git a/Boltpay/SDK/Models/Components/RefreshTokenRequest.cs b/Boltpay/SDK/Models/Components/RefreshTokenRequest.cs index 7d74d97..e61a372 100644 --- a/Boltpay/SDK/Models/Components/RefreshTokenRequest.cs +++ b/Boltpay/SDK/Models/Components/RefreshTokenRequest.cs @@ -29,33 +29,19 @@ public class RefreshTokenRequest public string RefreshToken { get; set; } = default!; /// - /// The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved
- /// - /// - /// in the Merchant Dashboard.
- /// - /// + /// The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved in your Merchant Dashboard. /// [SpeakeasyMetadata("form:name=client_id")] public string ClientId { get; set; } = default!; /// - /// The OAuth client secret, which corresponds the merchant API key, which can be retrieved in the
- /// - /// - /// Merchant Dashboard.
- /// - /// + /// The OAuth client secret, which corresponds the merchant API key, which can be retrieved in your Merchant Dashboard. /// [SpeakeasyMetadata("form:name=client_secret")] public string ClientSecret { get; set; } = default!; /// - /// The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.
- /// - /// - /// - /// + /// The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes. /// /// https://help.bolt.com/developers/references/bolt-oauth/#scopes} - OAuth Developer Reference /// @@ -63,12 +49,7 @@ public class RefreshTokenRequest public List Scope { get; set; } = default!; /// - /// A randomly generated string sent along with an authorization code. This must be included, if provided,
- /// - /// - /// in order to prevent CSRF attacks. used to prevent CSRF attacks.
- /// - /// + /// A randomly generated string sent along with an authorization code. This must be included if provided. It is used to prevent cross-site request forgery (CSRF) attacks. /// [SpeakeasyMetadata("form:name=state")] public string? State { get; set; } diff --git a/Boltpay/SDK/Models/Errors/CartError.cs b/Boltpay/SDK/Models/Errors/CartError.cs index 5e3d697..b8ef28e 100644 --- a/Boltpay/SDK/Models/Errors/CartError.cs +++ b/Boltpay/SDK/Models/Errors/CartError.cs @@ -24,12 +24,7 @@ public class CartError : Exception public CartErrorTag DotTag { get; set; } = default!; /// - /// A human-readable error message, which might include information specific to
- /// - /// - /// the request that was made.
- /// - /// + /// A human-readable error message, which might include information specific to the request that was made. /// [JsonProperty("message")] private string? _message { get; set; } diff --git a/Boltpay/SDK/Models/Errors/CreditCardError.cs b/Boltpay/SDK/Models/Errors/CreditCardError.cs index 83da3d0..cac9ed5 100644 --- a/Boltpay/SDK/Models/Errors/CreditCardError.cs +++ b/Boltpay/SDK/Models/Errors/CreditCardError.cs @@ -24,12 +24,7 @@ public class CreditCardError : Exception public CreditCardErrorTag DotTag { get; set; } = default!; /// - /// A human-readable error message, which might include information specific to
- /// - /// - /// the request that was made.
- /// - /// + /// A human-readable error message, which might include information specific to the request that was made. /// [JsonProperty("message")] private string? _message { get; set; } diff --git a/Boltpay/SDK/Models/Errors/Error.cs b/Boltpay/SDK/Models/Errors/Error.cs index 4dc047a..d7ce4e1 100644 --- a/Boltpay/SDK/Models/Errors/Error.cs +++ b/Boltpay/SDK/Models/Errors/Error.cs @@ -24,12 +24,7 @@ public class Error : Exception public Models.Errors.DotTag DotTag { get; set; } = default!; /// - /// A human-readable error message, which might include information specific to
- /// - /// - /// the request that was made.
- /// - /// + /// A human-readable error message, which might include information specific to the request that was made. /// [JsonProperty("message")] private string? _message { get; set; } diff --git a/Boltpay/SDK/Models/Errors/FieldError.cs b/Boltpay/SDK/Models/Errors/FieldError.cs index e529e22..01fedba 100644 --- a/Boltpay/SDK/Models/Errors/FieldError.cs +++ b/Boltpay/SDK/Models/Errors/FieldError.cs @@ -27,12 +27,7 @@ public class FieldError : Exception public FieldErrorTag DotTag { get; set; } = default!; /// - /// A human-readable error message, which might include information specific to
- /// - /// - /// the request that was made.
- /// - /// + /// A human-readable error message, which might include information specific to the request that was made. /// [JsonProperty("message")] private string? _message { get; set; } diff --git a/Boltpay/SDK/Models/Requests/AccountAddPaymentMethodRequest.cs b/Boltpay/SDK/Models/Requests/AccountAddPaymentMethodRequest.cs index 4cbc347..fe36dbc 100644 --- a/Boltpay/SDK/Models/Requests/AccountAddPaymentMethodRequest.cs +++ b/Boltpay/SDK/Models/Requests/AccountAddPaymentMethodRequest.cs @@ -16,7 +16,7 @@ public class AccountAddPaymentMethodRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/AccountAddressCreateRequest.cs b/Boltpay/SDK/Models/Requests/AccountAddressCreateRequest.cs index 27666f0..c5c89b5 100644 --- a/Boltpay/SDK/Models/Requests/AccountAddressCreateRequest.cs +++ b/Boltpay/SDK/Models/Requests/AccountAddressCreateRequest.cs @@ -16,7 +16,7 @@ public class AccountAddressCreateRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/AccountAddressDeleteRequest.cs b/Boltpay/SDK/Models/Requests/AccountAddressDeleteRequest.cs index 0673975..718a550 100644 --- a/Boltpay/SDK/Models/Requests/AccountAddressDeleteRequest.cs +++ b/Boltpay/SDK/Models/Requests/AccountAddressDeleteRequest.cs @@ -15,7 +15,7 @@ public class AccountAddressDeleteRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/AccountAddressEditRequest.cs b/Boltpay/SDK/Models/Requests/AccountAddressEditRequest.cs index 4df1f11..8fbe260 100644 --- a/Boltpay/SDK/Models/Requests/AccountAddressEditRequest.cs +++ b/Boltpay/SDK/Models/Requests/AccountAddressEditRequest.cs @@ -16,7 +16,7 @@ public class AccountAddressEditRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/AccountGetRequest.cs b/Boltpay/SDK/Models/Requests/AccountGetRequest.cs index 4dc1552..a2fe51b 100644 --- a/Boltpay/SDK/Models/Requests/AccountGetRequest.cs +++ b/Boltpay/SDK/Models/Requests/AccountGetRequest.cs @@ -15,7 +15,7 @@ public class AccountGetRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/AccountPaymentMethodDeleteRequest.cs b/Boltpay/SDK/Models/Requests/AccountPaymentMethodDeleteRequest.cs index 40d313f..6117410 100644 --- a/Boltpay/SDK/Models/Requests/AccountPaymentMethodDeleteRequest.cs +++ b/Boltpay/SDK/Models/Requests/AccountPaymentMethodDeleteRequest.cs @@ -15,7 +15,7 @@ public class AccountPaymentMethodDeleteRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/GuestPaymentsActionRequest.cs b/Boltpay/SDK/Models/Requests/GuestPaymentsActionRequest.cs index d81c050..025a761 100644 --- a/Boltpay/SDK/Models/Requests/GuestPaymentsActionRequest.cs +++ b/Boltpay/SDK/Models/Requests/GuestPaymentsActionRequest.cs @@ -16,7 +16,7 @@ public class GuestPaymentsActionRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/GuestPaymentsInitializeRequest.cs b/Boltpay/SDK/Models/Requests/GuestPaymentsInitializeRequest.cs index 06ffefd..d83d868 100644 --- a/Boltpay/SDK/Models/Requests/GuestPaymentsInitializeRequest.cs +++ b/Boltpay/SDK/Models/Requests/GuestPaymentsInitializeRequest.cs @@ -16,7 +16,7 @@ public class GuestPaymentsInitializeRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateRequest.cs b/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateRequest.cs deleted file mode 100644 index 1e2e480..0000000 --- a/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateRequest.cs +++ /dev/null @@ -1,39 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Boltpay.SDK.Models.Requests -{ - using Boltpay.SDK.Models.Components; - using Boltpay.SDK.Utils; - - public class GuestPaymentsUpdateRequest - { - - /// - /// The publicly viewable identifier used to identify a merchant division. - /// - [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] - public string XPublishableKey { get; set; } = default!; - - /// - /// A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. - /// - [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Merchant-Client-Id")] - public string XMerchantClientId { get; set; } = default!; - - /// - /// The ID of the guest payment to update - /// - [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=id")] - public string Id { get; set; } = default!; - - [SpeakeasyMetadata("request:mediaType=application/json")] - public PaymentUpdateRequest PaymentUpdateRequest { get; set; } = default!; - } -} \ No newline at end of file diff --git a/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateResponse.cs b/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateResponse.cs deleted file mode 100644 index 5ef13cf..0000000 --- a/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateResponse.cs +++ /dev/null @@ -1,37 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Boltpay.SDK.Models.Requests -{ - using Boltpay.SDK.Models.Components; - using Boltpay.SDK.Utils; - using Newtonsoft.Json; - - public class GuestPaymentsUpdateResponse - { - - [JsonProperty("-")] - public HTTPMetadata HttpMeta { get; set; } = default!; - - /// - /// The pending payment was successfully updated - /// - public PaymentResponse? PaymentResponse { get; set; } - - public PaymentResponseFinalized? GetPaymentResponseFinalized() - { - return PaymentResponse != null ? PaymentResponse.PaymentResponseFinalized : null; - } - - public PaymentResponsePending? GetPaymentResponsePending() - { - return PaymentResponse != null ? PaymentResponse.PaymentResponsePending : null; - } - } -} \ No newline at end of file diff --git a/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateSecurity.cs b/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateSecurity.cs deleted file mode 100644 index 898d0c1..0000000 --- a/Boltpay/SDK/Models/Requests/GuestPaymentsUpdateSecurity.cs +++ /dev/null @@ -1,20 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Boltpay.SDK.Models.Requests -{ - using Boltpay.SDK.Utils; - - public class GuestPaymentsUpdateSecurity - { - - [SpeakeasyMetadata("security:scheme=true,type=apiKey,subType=header,name=X-API-Key")] - public string ApiKey { get; set; } = default!; - } -} \ No newline at end of file diff --git a/Boltpay/SDK/Models/Requests/OrdersCreateRequest.cs b/Boltpay/SDK/Models/Requests/OrdersCreateRequest.cs index 6cfb429..08e820f 100644 --- a/Boltpay/SDK/Models/Requests/OrdersCreateRequest.cs +++ b/Boltpay/SDK/Models/Requests/OrdersCreateRequest.cs @@ -16,7 +16,7 @@ public class OrdersCreateRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/PaymentsActionRequest.cs b/Boltpay/SDK/Models/Requests/PaymentsActionRequest.cs index 9023b6e..ba8884b 100644 --- a/Boltpay/SDK/Models/Requests/PaymentsActionRequest.cs +++ b/Boltpay/SDK/Models/Requests/PaymentsActionRequest.cs @@ -16,7 +16,7 @@ public class PaymentsActionRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/PaymentsInitializeRequest.cs b/Boltpay/SDK/Models/Requests/PaymentsInitializeRequest.cs index 6d67f2f..84e82ae 100644 --- a/Boltpay/SDK/Models/Requests/PaymentsInitializeRequest.cs +++ b/Boltpay/SDK/Models/Requests/PaymentsInitializeRequest.cs @@ -16,7 +16,7 @@ public class PaymentsInitializeRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/PaymentsUpdateRequest.cs b/Boltpay/SDK/Models/Requests/PaymentsUpdateRequest.cs deleted file mode 100644 index 0e59e3b..0000000 --- a/Boltpay/SDK/Models/Requests/PaymentsUpdateRequest.cs +++ /dev/null @@ -1,39 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Boltpay.SDK.Models.Requests -{ - using Boltpay.SDK.Models.Components; - using Boltpay.SDK.Utils; - - public class PaymentsUpdateRequest - { - - /// - /// The publicly viewable identifier used to identify a merchant division. - /// - [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] - public string XPublishableKey { get; set; } = default!; - - /// - /// A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. - /// - [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Merchant-Client-Id")] - public string XMerchantClientId { get; set; } = default!; - - /// - /// The ID of the payment to update - /// - [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=id")] - public string Id { get; set; } = default!; - - [SpeakeasyMetadata("request:mediaType=application/json")] - public PaymentUpdateRequest PaymentUpdateRequest { get; set; } = default!; - } -} \ No newline at end of file diff --git a/Boltpay/SDK/Models/Requests/PaymentsUpdateResponse.cs b/Boltpay/SDK/Models/Requests/PaymentsUpdateResponse.cs deleted file mode 100644 index 03e71fa..0000000 --- a/Boltpay/SDK/Models/Requests/PaymentsUpdateResponse.cs +++ /dev/null @@ -1,37 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. -// -// Changes to this file may cause incorrect behavior and will be lost when -// the code is regenerated. -// -//------------------------------------------------------------------------------ -#nullable enable -namespace Boltpay.SDK.Models.Requests -{ - using Boltpay.SDK.Models.Components; - using Boltpay.SDK.Utils; - using Newtonsoft.Json; - - public class PaymentsUpdateResponse - { - - [JsonProperty("-")] - public HTTPMetadata HttpMeta { get; set; } = default!; - - /// - /// The pending payment was successfully updated - /// - public PaymentResponse? PaymentResponse { get; set; } - - public PaymentResponseFinalized? GetPaymentResponseFinalized() - { - return PaymentResponse != null ? PaymentResponse.PaymentResponseFinalized : null; - } - - public PaymentResponsePending? GetPaymentResponsePending() - { - return PaymentResponse != null ? PaymentResponse.PaymentResponsePending : null; - } - } -} \ No newline at end of file diff --git a/Boltpay/SDK/Models/Requests/TestingAccountCreateRequest.cs b/Boltpay/SDK/Models/Requests/TestingAccountCreateRequest.cs index a2bf66e..1d5275b 100644 --- a/Boltpay/SDK/Models/Requests/TestingAccountCreateRequest.cs +++ b/Boltpay/SDK/Models/Requests/TestingAccountCreateRequest.cs @@ -16,7 +16,7 @@ public class TestingAccountCreateRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/Models/Requests/TestingAccountPhoneGetRequest.cs b/Boltpay/SDK/Models/Requests/TestingAccountPhoneGetRequest.cs index 54c4252..a12bfac 100644 --- a/Boltpay/SDK/Models/Requests/TestingAccountPhoneGetRequest.cs +++ b/Boltpay/SDK/Models/Requests/TestingAccountPhoneGetRequest.cs @@ -15,7 +15,7 @@ public class TestingAccountPhoneGetRequest { /// - /// The publicly viewable identifier used to identify a merchant division. + /// The publicly shareable identifier used to identify your Bolt merchant division. /// [SpeakeasyMetadata("header:style=simple,explode=false,name=X-Publishable-Key")] public string XPublishableKey { get; set; } = default!; diff --git a/Boltpay/SDK/OAuth.cs b/Boltpay/SDK/OAuth.cs index ecb99ee..acdef5b 100644 --- a/Boltpay/SDK/OAuth.cs +++ b/Boltpay/SDK/OAuth.cs @@ -23,12 +23,7 @@ namespace Boltpay.SDK using System; /// - /// Use this endpoint to retrieve an OAuth token. Use the token to allow your ecommerce server to make calls to the Account
- /// - /// - /// endpoint and create a one-click checkout experience for shoppers.
- /// - /// + /// Use the OAuth API to enable your ecommerce server to make API calls on behalf of a Bolt logged-in shopper. /// /// https://help.bolt.com/products/accounts/direct-api/oauth-guide/} /// @@ -46,12 +41,7 @@ public interface IOAuth } /// - /// Use this endpoint to retrieve an OAuth token. Use the token to allow your ecommerce server to make calls to the Account
- /// - /// - /// endpoint and create a one-click checkout experience for shoppers.
- /// - /// + /// Use the OAuth API to enable your ecommerce server to make API calls on behalf of a Bolt logged-in shopper. /// /// https://help.bolt.com/products/accounts/direct-api/oauth-guide/} /// @@ -59,10 +49,10 @@ public class OAuth: IOAuth { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/Boltpay/SDK/Orders.cs b/Boltpay/SDK/Orders.cs index 32425a3..5961fe1 100644 --- a/Boltpay/SDK/Orders.cs +++ b/Boltpay/SDK/Orders.cs @@ -23,41 +23,32 @@ namespace Boltpay.SDK using System; /// - /// Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem.
- /// - /// - /// - /// + /// Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem. /// public interface IOrders { /// - /// Create an order that was placed outside the Bolt ecosystem. + /// Create an order that was prepared outside the Bolt ecosystem. /// /// - /// Create an order that was placed outside the Bolt ecosystem.
- /// + /// Create an order that was prepared outside the Bolt ecosystem. Some Bolt-powered flows automatically manage order creation - in those flows the order ID will be provided separately and not through this API. /// /// Task OrdersCreateAsync(OrdersCreateSecurity security, string xPublishableKey, string xMerchantClientId, Order order); } /// - /// Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem.
- /// - /// - /// - /// + /// Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem. /// public class Orders: IOrders { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/Boltpay/SDK/Payments.cs b/Boltpay/SDK/Payments.cs index 7f374f6..3e09278 100644 --- a/Boltpay/SDK/Payments.cs +++ b/Boltpay/SDK/Payments.cs @@ -16,23 +16,23 @@ namespace Boltpay.SDK public interface IPayments { - public IGuest Guest { get; } public ILoggedIn LoggedIn { get; } + public IGuest Guest { get; } } public class Payments: IPayments { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; - public IGuest Guest { get; private set; } public ILoggedIn LoggedIn { get; private set; } + public IGuest Guest { get; private set; } public Payments(ISpeakeasyHttpClient client, Func? securitySource, string serverUrl, SDKConfig config) { @@ -40,8 +40,8 @@ public Payments(ISpeakeasyHttpClient client, Func? securitySource, str _securitySource = securitySource; _serverUrl = serverUrl; SDKConfiguration = config; - Guest = new Guest(_client, _securitySource, _serverUrl, SDKConfiguration); LoggedIn = new LoggedIn(_client, _securitySource, _serverUrl, SDKConfiguration); + Guest = new Guest(_client, _securitySource, _serverUrl, SDKConfiguration); } } } \ No newline at end of file diff --git a/Boltpay/SDK/Testing.cs b/Boltpay/SDK/Testing.cs index 9931d04..176c90a 100644 --- a/Boltpay/SDK/Testing.cs +++ b/Boltpay/SDK/Testing.cs @@ -23,12 +23,7 @@ namespace Boltpay.SDK using System; /// - /// Endpoints that allow you to generate and retrieve test data to verify certain
- /// - /// - /// flows in non-production environments.
- /// - /// + /// Use the Testing API to generate and retrieve test data to verify a subset of flows in non-production environments. /// public interface ITesting { @@ -37,8 +32,7 @@ public interface ITesting /// Create a test account /// /// - /// Create a Bolt shopper account for testing purposes.
- /// + /// Create a Bolt shopper account for testing purposes. /// /// Task CreateAccountAsync(TestingAccountCreateSecurity security, string xPublishableKey, AccountTestCreationData accountTestCreationData); @@ -47,39 +41,32 @@ public interface ITesting /// Get a random phone number /// /// - /// Get a random, fictitious phone number that is not assigned to any existing account.
- /// + /// Get a random, fictitious phone number that is not assigned to any existing Bolt account. /// /// Task TestingAccountPhoneGetAsync(TestingAccountPhoneGetSecurity security, string xPublishableKey); /// - /// Retrieve a test credit card, including its token + /// Retrieve a tokenized test credit card /// /// - /// Retrieve test credit card information. This includes its token, which can be used to process payments.
- /// + /// 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. /// /// Task GetCreditCardAsync(TestingCreditCardGetSecurity security, TestingCreditCardGetRequestBody request); } /// - /// Endpoints that allow you to generate and retrieve test data to verify certain
- /// - /// - /// flows in non-production environments.
- /// - /// + /// Use the Testing API to generate and retrieve test data to verify a subset of flows in non-production environments. /// public class Testing: ITesting { public SDKConfig SDKConfiguration { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.0.3"; - private const string _sdkGenVersion = "2.370.2"; - private const string _openapiDocVersion = "3.1.0"; - private const string _userAgent = "speakeasy-sdk/csharp 0.0.3 2.370.2 3.1.0 Boltpay.SDK"; + private const string _sdkVersion = "0.1.0"; + private const string _sdkGenVersion = "2.376.0"; + private const string _openapiDocVersion = "3.2.0"; + private const string _userAgent = "speakeasy-sdk/csharp 0.1.0 2.376.0 3.2.0 Boltpay.SDK"; private string _serverUrl = ""; private ISpeakeasyHttpClient _client; private Func? _securitySource; diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d585717 --- /dev/null +++ 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 index d612fa3..9cfbc3e 100644 --- a/README.md +++ b/README.md @@ -46,35 +46,33 @@ var res = await sdk.Account.GetDetailsAsync( * [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.LoggedIn](docs/sdks/loggedin/README.md) + +* [Initialize](docs/sdks/loggedin/README.md#initialize) - Initialize a Bolt payment for logged in shoppers +* [PerformAction](docs/sdks/loggedin/README.md#performaction) - Finalize a pending payment + ### [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 +* [PerformAction](docs/sdks/guest/README.md#performaction) - Finalize a pending guest payment -### [Payments.LoggedIn](docs/sdks/loggedin/README.md) +### [Orders](docs/sdks/orders/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 +* [OrdersCreate](docs/sdks/orders/README.md#orderscreate) - Create an order that was prepared outside the Bolt ecosystem. ### [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. - ### [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 diff --git a/RELEASES.md b/RELEASES.md index d95ab5b..0df7f59 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -18,4 +18,14 @@ Based on: ### Generated - [csharp v0.0.3] . ### Releases -- [NuGet v0.0.3] https://www.nuget.org/packages/Boltpay.SDK/0.0.3 - . \ No newline at end of file +- [NuGet v0.0.3] https://www.nuget.org/packages/Boltpay.SDK/0.0.3 - . + +## 2024-07-18 18:09:43 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.343.0 (2.376.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v0.1.0] . +### Releases +- [NuGet v0.1.0] https://www.nuget.org/packages/Boltpay.SDK/0.1.0 - . \ No newline at end of file diff --git a/docs/Models/Components/Account.md b/docs/Models/Components/Account.md index 82d6110..6aaed9d 100644 --- a/docs/Models/Components/Account.md +++ b/docs/Models/Components/Account.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | | `Addresses` | List<[AddressListing](../../Models/Components/AddressListing.md)> | :heavy_check_mark: | A list of addresses associated with this account. | | `PaymentMethods` | List<[PaymentMethod](../../Models/Components/PaymentMethod.md)> | :heavy_check_mark: | A list of payment methods associated with this account. | -| `Profile` | [Profile](../../Models/Components/Profile.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Profile` | [Profile](../../Models/Components/Profile.md) | :heavy_minus_sign: | An account's identifying information. | \ No newline at end of file diff --git a/docs/Models/Components/AuthorizationCodeRequest.md b/docs/Models/Components/AuthorizationCodeRequest.md index 2f0bf3e..201152b 100644 --- a/docs/Models/Components/AuthorizationCodeRequest.md +++ b/docs/Models/Components/AuthorizationCodeRequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `GrantType` | [GrantType](../../Models/Components/GrantType.md) | :heavy_check_mark: | The type of OAuth 2.0 grant being utilized. | authorization_code | -| `Code` | *string* | :heavy_check_mark: | Fetched value using OTP value from the Authorization Modal. | 7GSjMRSHs6Ak7C_zvVW6P2IhZOHxMK7HZKW1fMX85ms | -| `ClientId` | *string* | :heavy_check_mark: | The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved
in the Merchant Dashboard.
| 8fd9diIy59sj.IraJdeIgmdsO.fd233434fg2c616cgo932aa6e1e4fc627a9385045gr395222a127gi93c595rg4 | -| `ClientSecret` | *string* | :heavy_check_mark: | The OAuth client secret, which corresponds the merchant API key, which can be retrieved in the
Merchant Dashboard.
| 23ee7ec7301779eaff451d7c6f6cba322499e3c0ec752f800c72a8f99217e3a8 | -| `Scope` | List<[Scope](../../Models/Components/Scope.md)> | :heavy_check_mark: | The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.


[OAuth Developer Reference](https://help.bolt.com/developers/references/bolt-oauth/#scopes) | | -| `State` | *string* | :heavy_minus_sign: | A randomly generated string sent along with an authorization code. This must be included, if provided,
in order to prevent CSRF attacks. used to prevent CSRF attacks.
| xyzABC123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `GrantType` | [GrantType](../../Models/Components/GrantType.md) | :heavy_check_mark: | The type of OAuth 2.0 grant being utilized. | authorization_code | +| `Code` | *string* | :heavy_check_mark: | Fetched value using OTP value from the Authorization Modal. | 7GSjMRSHs6Ak7C_zvVW6P2IhZOHxMK7HZKW1fMX85ms | +| `ClientId` | *string* | :heavy_check_mark: | The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved in your Merchant Dashboard. | 8fd9diIy59sj.IraJdeIgmdsO.fd233434fg2c616cgo932aa6e1e4fc627a9385045gr395222a127gi93c595rg4 | +| `ClientSecret` | *string* | :heavy_check_mark: | The OAuth client secret, which corresponds the merchant API key, which can be retrieved in your Merchant Dashboard. | 23ee7ec7301779eaff451d7c6f6cba322499e3c0ec752f800c72a8f99217e3a8 | +| `Scope` | List<[Scope](../../Models/Components/Scope.md)> | :heavy_check_mark: | The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.

[OAuth Developer Reference](https://help.bolt.com/developers/references/bolt-oauth/#scopes) | | +| `State` | *string* | :heavy_minus_sign: | A randomly generated string sent along with an authorization code. This must be included if provided. It is used to prevent cross-site request forgery (CSRF) attacks. | xyzABC123 | \ No newline at end of file diff --git a/docs/Models/Components/GetAccessTokenResponse.md b/docs/Models/Components/GetAccessTokenResponse.md index 8ddbd06..0d11706 100644 --- a/docs/Models/Components/GetAccessTokenResponse.md +++ b/docs/Models/Components/GetAccessTokenResponse.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IdToken` | *string* | :heavy_minus_sign: | A JWT token issued when the request includes the scope open_id. | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImFsaWNlQGV4YW1wbGUuY29tIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImV4cCI6MTcwNTY1MTczMSwiZmlyc3RfbmFtZSI6IkFsaWNlIiwiaXNzIjoiaHR0cDovL2FwaS5ib2x0LmNvbSIsImxhc3RfbmFtZSI6IkJha2VyIiwicGhvbmVfbnVtYmVyIjoiKzE0MTU1NTUwMTk5IiwicGhvbmVfbnVtYmVyX3ZlcmlmaWVkIjp0cnVlLCJpYXQiOjE3MDU2NDg0MjF9.Ir0aKx40zfNCZol1DnqchFx9ciHlyZY9y10mndEjOBHhpHif8-7aZl2UoJVs_0Hj-5ArEouUD6n-y1SJD0Wns-gDMoA0Etoc5dT_0zt0Kw5T8FvJWbyKyyGSDEwPFVADIRxDPMpVoHx0C0nwr_GudnIX7YG6p2HCsoGm2C04ZxKpifSixB3-xNB6k9u1ESWh0KjMCYzBQ2x9wbQ_S6kFtio075PFYcZ3iRQz8oD15NsZDd2czzZkRnGTGlpG0sAvScLXMvDDOWBIu-4wvOEOT7avunJQ_rOCYUlyJe7JGh0QllpeJNau8kx-4YGMeFTkeGM_hPIKsRF1e6o_rWp5CMJnmJDPme-zlJxWodyaHNed5XW-4DR7blv_PFOJNrRvymRoTOd74LIpS21GRCNYrphj7N6-TsSfO9hMQ9ehxrgNAryWbVtTM_3VvWyzX-SRa7BcRkS97sokxc04s3cbXra3x6brE3uL1yoOWNf8GDZNkv1uUAnrOZcTuLacrPjkQgOPb-chMiWS1L0Zd1wX3rqpeCyEswsGKxRRkpgwoBaVVQmLB9m51B6SXEvURTcy2Hx8KzgfXQ_-uC-KrniQxWzYms8A1lypKXkEcyMD2E4Q7EB4UeD2qZAk4tZo611uHegaHaEM7EQyFN3nxvibaqFpXzdxVmOCX0_wQr1nDNA | -| `AccessToken` | *string* | :heavy_minus_sign: | An access token you can use to make requests on behalf of a Bolt Account. | KCqordmSK6_lpkaXaXfGD8LwnKMGGOYy4Ju2IaBXpJI.CzOF7QOmGGQEgIzBjxOEh1FbRdDpzf9zbm9eHrCZ6zw | +| `IdToken` | *string* | :heavy_minus_sign: | A JSON Web Token (JWT) issued when the request includes the scope open_id. | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImFsaWNlQGV4YW1wbGUuY29tIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImV4cCI6MTcwNTY1MTczMSwiZmlyc3RfbmFtZSI6IkFsaWNlIiwiaXNzIjoiaHR0cDovL2FwaS5ib2x0LmNvbSIsImxhc3RfbmFtZSI6IkJha2VyIiwicGhvbmVfbnVtYmVyIjoiKzE0MTU1NTUwMTk5IiwicGhvbmVfbnVtYmVyX3ZlcmlmaWVkIjp0cnVlLCJpYXQiOjE3MDU2NDg0MjF9.Ir0aKx40zfNCZol1DnqchFx9ciHlyZY9y10mndEjOBHhpHif8-7aZl2UoJVs_0Hj-5ArEouUD6n-y1SJD0Wns-gDMoA0Etoc5dT_0zt0Kw5T8FvJWbyKyyGSDEwPFVADIRxDPMpVoHx0C0nwr_GudnIX7YG6p2HCsoGm2C04ZxKpifSixB3-xNB6k9u1ESWh0KjMCYzBQ2x9wbQ_S6kFtio075PFYcZ3iRQz8oD15NsZDd2czzZkRnGTGlpG0sAvScLXMvDDOWBIu-4wvOEOT7avunJQ_rOCYUlyJe7JGh0QllpeJNau8kx-4YGMeFTkeGM_hPIKsRF1e6o_rWp5CMJnmJDPme-zlJxWodyaHNed5XW-4DR7blv_PFOJNrRvymRoTOd74LIpS21GRCNYrphj7N6-TsSfO9hMQ9ehxrgNAryWbVtTM_3VvWyzX-SRa7BcRkS97sokxc04s3cbXra3x6brE3uL1yoOWNf8GDZNkv1uUAnrOZcTuLacrPjkQgOPb-chMiWS1L0Zd1wX3rqpeCyEswsGKxRRkpgwoBaVVQmLB9m51B6SXEvURTcy2Hx8KzgfXQ_-uC-KrniQxWzYms8A1lypKXkEcyMD2E4Q7EB4UeD2qZAk4tZo611uHegaHaEM7EQyFN3nxvibaqFpXzdxVmOCX0_wQr1nDNA | +| `AccessToken` | *string* | :heavy_minus_sign: | An access token you can use to make requests on behalf of a Bolt shopper. | KCqordmSK6_lpkaXaXfGD8LwnKMGGOYy4Ju2IaBXpJI.CzOF7QOmGGQEgIzBjxOEh1FbRdDpzf9zbm9eHrCZ6zw | | `ExpiresIn` | *long* | :heavy_minus_sign: | The access token's expiration, in seconds. | 3600 | | `RefreshToken` | *string* | :heavy_minus_sign: | A refresh token you can use to issue a brand new access token without obtaining a new authorization code. | 4hJYNO4GHvALZoocXoLenfNeFy1RR5ZT6G5JYrFbvkI.Q_PqV0lIszCNoN-85EwD-2nYZOVEepVgJSolx-Jbzrs | | `RefreshTokenScope` | *string* | :heavy_minus_sign: | The scope granted to the refresh token. Currently, refreshed token will only grant view permissions. | bolt.account.view | -| `Scope` | *string* | :heavy_minus_sign: | The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter.
Options include `bolt.account.manage`, `bolt.account.view`, `openid`. Multiple values can be returned as space-separated strings.
| bolt.account.manage openid | +| `Scope` | *string* | :heavy_minus_sign: | The scope granted to access token, depending on the scope granted to the authorization code as well as the scope parameter. Options include `bolt.account.manage`, `bolt.account.view`, `openid`. Multiple values can be returned as space-separated strings. | bolt.account.manage openid | | `TokenType` | *string* | :heavy_minus_sign: | The token_type will always be bearer. | bearer | \ No newline at end of file diff --git a/docs/Models/Components/Order.md b/docs/Models/Components/Order.md index e9febca..5b8ea2f 100644 --- a/docs/Models/Components/Order.md +++ b/docs/Models/Components/Order.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Profile` | [Profile](../../Models/Components/Profile.md) | :heavy_check_mark: | N/A | +| `Profile` | [Profile](../../Models/Components/Profile.md) | :heavy_check_mark: | An account's identifying information. | | `Cart` | [Cart](../../Models/Components/Cart.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Components/PaymentUpdateRequest.md b/docs/Models/Components/PaymentUpdateRequest.md deleted file mode 100644 index 7f364d9..0000000 --- a/docs/Models/Components/PaymentUpdateRequest.md +++ /dev/null @@ -1,8 +0,0 @@ -# PaymentUpdateRequest - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `Cart` | [Cart](../../Models/Components/Cart.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/Models/Components/Profile.md b/docs/Models/Components/Profile.md index 6f139ab..eec780b 100644 --- a/docs/Models/Components/Profile.md +++ b/docs/Models/Components/Profile.md @@ -1,5 +1,7 @@ # Profile +An account's identifying information. + ## Fields diff --git a/docs/Models/Components/ProfileCreationData.md b/docs/Models/Components/ProfileCreationData.md index 1445dca..6529aa1 100644 --- a/docs/Models/Components/ProfileCreationData.md +++ b/docs/Models/Components/ProfileCreationData.md @@ -1,5 +1,7 @@ # ProfileCreationData +An account's identifying information. + ## Fields diff --git a/docs/Models/Components/RefreshTokenRequest.md b/docs/Models/Components/RefreshTokenRequest.md index ef3b759..8bcf8bf 100644 --- a/docs/Models/Components/RefreshTokenRequest.md +++ b/docs/Models/Components/RefreshTokenRequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `GrantType` | [RefreshTokenRequestGrantType](../../Models/Components/RefreshTokenRequestGrantType.md) | :heavy_check_mark: | The type of OAuth 2.0 grant being utilized. | refresh_token | -| `RefreshToken` | *string* | :heavy_check_mark: | The value of the refresh token issued to you in the originating OAuth token request. | 4hJYNO4GHvALZoocXoLenfNeFy1RR5ZT6G5JYrFbvkI.Q_PqV0lIszCNoN-85EwD-2nYZOVEepVgJSolx-Jbzrs | -| `ClientId` | *string* | :heavy_check_mark: | The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved
in the Merchant Dashboard.
| 8fd9diIy59sj.IraJdeIgmdsO.fd233434fg2c616cgo932aa6e1e4fc627a9385045gr395222a127gi93c595rg4 | -| `ClientSecret` | *string* | :heavy_check_mark: | The OAuth client secret, which corresponds the merchant API key, which can be retrieved in the
Merchant Dashboard.
| 23ee7ec7301779eaff451d7c6f6cba322499e3c0ec752f800c72a8f99217e3a8 | -| `Scope` | List<[RefreshTokenRequestScope](../../Models/Components/RefreshTokenRequestScope.md)> | :heavy_check_mark: | The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.


[OAuth Developer Reference](https://help.bolt.com/developers/references/bolt-oauth/#scopes) | | -| `State` | *string* | :heavy_minus_sign: | A randomly generated string sent along with an authorization code. This must be included, if provided,
in order to prevent CSRF attacks. used to prevent CSRF attacks.
| xyzABC123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `GrantType` | [RefreshTokenRequestGrantType](../../Models/Components/RefreshTokenRequestGrantType.md) | :heavy_check_mark: | The type of OAuth 2.0 grant being utilized. | refresh_token | +| `RefreshToken` | *string* | :heavy_check_mark: | The value of the refresh token issued to you in the originating OAuth token request. | 4hJYNO4GHvALZoocXoLenfNeFy1RR5ZT6G5JYrFbvkI.Q_PqV0lIszCNoN-85EwD-2nYZOVEepVgJSolx-Jbzrs | +| `ClientId` | *string* | :heavy_check_mark: | The OAuth client ID, which corresponds to the merchant publishable key, which can be retrieved in your Merchant Dashboard. | 8fd9diIy59sj.IraJdeIgmdsO.fd233434fg2c616cgo932aa6e1e4fc627a9385045gr395222a127gi93c595rg4 | +| `ClientSecret` | *string* | :heavy_check_mark: | The OAuth client secret, which corresponds the merchant API key, which can be retrieved in your Merchant Dashboard. | 23ee7ec7301779eaff451d7c6f6cba322499e3c0ec752f800c72a8f99217e3a8 | +| `Scope` | List<[RefreshTokenRequestScope](../../Models/Components/RefreshTokenRequestScope.md)> | :heavy_check_mark: | The requested scopes. If the request is successful, the OAuth client will be able to perform operations requiring these scopes.

[OAuth Developer Reference](https://help.bolt.com/developers/references/bolt-oauth/#scopes) | | +| `State` | *string* | :heavy_minus_sign: | A randomly generated string sent along with an authorization code. This must be included if provided. It is used to prevent cross-site request forgery (CSRF) attacks. | xyzABC123 | \ No newline at end of file diff --git a/docs/Models/Errors/CartError.md b/docs/Models/Errors/CartError.md index 36194e1..71b0a9b 100644 --- a/docs/Models/Errors/CartError.md +++ b/docs/Models/Errors/CartError.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `DotTag` | [CartErrorTag](../../Models/Errors/CartErrorTag.md) | :heavy_check_mark: | The type of error returned | payment_already_exists | -| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to
the request that was made.
| A payment for this order already exists | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `DotTag` | [CartErrorTag](../../Models/Errors/CartErrorTag.md) | :heavy_check_mark: | The type of error returned | payment_already_exists | +| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to the request that was made. | A payment for this order already exists | \ No newline at end of file diff --git a/docs/Models/Errors/CreditCardError.md b/docs/Models/Errors/CreditCardError.md index 725f96a..99ed2bf 100644 --- a/docs/Models/Errors/CreditCardError.md +++ b/docs/Models/Errors/CreditCardError.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `DotTag` | [CreditCardErrorTag](../../Models/Errors/CreditCardErrorTag.md) | :heavy_check_mark: | The type of error returned | declined_invalid_cvv | -| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to
the request that was made.
| The payment was declined because the CVV is not valid | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `DotTag` | [CreditCardErrorTag](../../Models/Errors/CreditCardErrorTag.md) | :heavy_check_mark: | The type of error returned | declined_invalid_cvv | +| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to the request that was made. | The payment was declined because the CVV is not valid | \ No newline at end of file diff --git a/docs/Models/Errors/Error.md b/docs/Models/Errors/Error.md index 74c4ae5..c0020e1 100644 --- a/docs/Models/Errors/Error.md +++ b/docs/Models/Errors/Error.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `DotTag` | [Models.Errors.DotTag](../../Models/Errors/DotTag.md) | :heavy_check_mark: | The type of error returned | unprocessable_request | -| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to
the request that was made.
| We were unable to process your request. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `DotTag` | [Models.Errors.DotTag](../../Models/Errors/DotTag.md) | :heavy_check_mark: | The type of error returned | unprocessable_request | +| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to the request that was made. | We were unable to process your request. | \ No newline at end of file diff --git a/docs/Models/Errors/FieldError.md b/docs/Models/Errors/FieldError.md index 4ba40d4..b8c218a 100644 --- a/docs/Models/Errors/FieldError.md +++ b/docs/Models/Errors/FieldError.md @@ -5,8 +5,8 @@ An error that pertains to validation of a specific field in the request. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `DotTag` | [FieldErrorTag](../../Models/Errors/FieldErrorTag.md) | :heavy_check_mark: | The type of error returned | invalid_input_parameter | -| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to
the request that was made.
| We were unable to process your request. | -| `Field` | *string* | :heavy_check_mark: | The field (in its hierarchical form) that is failing validation. | address.phone | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `DotTag` | [FieldErrorTag](../../Models/Errors/FieldErrorTag.md) | :heavy_check_mark: | The type of error returned | invalid_input_parameter | +| `Message` | *string* | :heavy_check_mark: | A human-readable error message, which might include information specific to the request that was made. | We were unable to process your request. | +| `Field` | *string* | :heavy_check_mark: | The field (in its hierarchical form) that is failing validation. | address.phone | \ No newline at end of file diff --git a/docs/Models/Requests/AccountAddPaymentMethodRequest.md b/docs/Models/Requests/AccountAddPaymentMethodRequest.md index 179484d..ef36b2d 100644 --- a/docs/Models/Requests/AccountAddPaymentMethodRequest.md +++ b/docs/Models/Requests/AccountAddPaymentMethodRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `PaymentMethod` | [PaymentMethodInput](../../Models/Components/PaymentMethodInput.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/AccountAddressCreateRequest.md b/docs/Models/Requests/AccountAddressCreateRequest.md index 483ec5c..46a30f1 100644 --- a/docs/Models/Requests/AccountAddressCreateRequest.md +++ b/docs/Models/Requests/AccountAddressCreateRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `AddressListing` | [AddressListingInput](../../Models/Components/AddressListingInput.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/AccountAddressDeleteRequest.md b/docs/Models/Requests/AccountAddressDeleteRequest.md index ea48167..94588a7 100644 --- a/docs/Models/Requests/AccountAddressDeleteRequest.md +++ b/docs/Models/Requests/AccountAddressDeleteRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the address to delete | D4g3h5tBuVYK9 | \ No newline at end of file diff --git a/docs/Models/Requests/AccountAddressEditRequest.md b/docs/Models/Requests/AccountAddressEditRequest.md index 6578a5a..a4ac170 100644 --- a/docs/Models/Requests/AccountAddressEditRequest.md +++ b/docs/Models/Requests/AccountAddressEditRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the address to edit | D4g3h5tBuVYK9 | | `AddressListing` | [AddressListingInput](../../Models/Components/AddressListingInput.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/Models/Requests/AccountGetRequest.md b/docs/Models/Requests/AccountGetRequest.md index 893d69b..1d28887 100644 --- a/docs/Models/Requests/AccountGetRequest.md +++ b/docs/Models/Requests/AccountGetRequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | \ No newline at end of file diff --git a/docs/Models/Requests/AccountPaymentMethodDeleteRequest.md b/docs/Models/Requests/AccountPaymentMethodDeleteRequest.md index b7282ef..454eee9 100644 --- a/docs/Models/Requests/AccountPaymentMethodDeleteRequest.md +++ b/docs/Models/Requests/AccountPaymentMethodDeleteRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the payment method to delete | D4g3h5tBuVYK9 | \ No newline at end of file diff --git a/docs/Models/Requests/GuestPaymentsActionRequest.md b/docs/Models/Requests/GuestPaymentsActionRequest.md index f0e1ff3..1baa81d 100644 --- a/docs/Models/Requests/GuestPaymentsActionRequest.md +++ b/docs/Models/Requests/GuestPaymentsActionRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the guest payment to operate on | iKv7t5bgt1gg | | `PaymentActionRequest` | [PaymentActionRequest](../../Models/Components/PaymentActionRequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/Models/Requests/GuestPaymentsInitializeRequest.md b/docs/Models/Requests/GuestPaymentsInitializeRequest.md index 36b0dbd..c3852fb 100644 --- a/docs/Models/Requests/GuestPaymentsInitializeRequest.md +++ b/docs/Models/Requests/GuestPaymentsInitializeRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `GuestPaymentInitializeRequest` | [GuestPaymentInitializeRequest](../../Models/Components/GuestPaymentInitializeRequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/GuestPaymentsUpdateRequest.md b/docs/Models/Requests/GuestPaymentsUpdateRequest.md deleted file mode 100644 index bb34c4d..0000000 --- a/docs/Models/Requests/GuestPaymentsUpdateRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# GuestPaymentsUpdateRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | -| `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | -| `Id` | *string* | :heavy_check_mark: | The ID of the guest payment to update | iKv7t5bgt1gg | -| `PaymentUpdateRequest` | [PaymentUpdateRequest](../../Models/Components/PaymentUpdateRequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/Models/Requests/GuestPaymentsUpdateResponse.md b/docs/Models/Requests/GuestPaymentsUpdateResponse.md deleted file mode 100644 index e307af4..0000000 --- a/docs/Models/Requests/GuestPaymentsUpdateResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -# GuestPaymentsUpdateResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `HttpMeta` | [HTTPMetadata](../../Models/Components/HTTPMetadata.md) | :heavy_check_mark: | N/A | -| `PaymentResponse` | [PaymentResponse](../../Models/Components/PaymentResponse.md) | :heavy_minus_sign: | The pending payment was successfully updated | \ No newline at end of file diff --git a/docs/Models/Requests/GuestPaymentsUpdateSecurity.md b/docs/Models/Requests/GuestPaymentsUpdateSecurity.md deleted file mode 100644 index 37b1292..0000000 --- a/docs/Models/Requests/GuestPaymentsUpdateSecurity.md +++ /dev/null @@ -1,8 +0,0 @@ -# GuestPaymentsUpdateSecurity - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `ApiKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/OrdersCreateRequest.md b/docs/Models/Requests/OrdersCreateRequest.md index 2bab584..1b04fb3 100644 --- a/docs/Models/Requests/OrdersCreateRequest.md +++ b/docs/Models/Requests/OrdersCreateRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `Order` | [Order](../../Models/Components/Order.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/PaymentsActionRequest.md b/docs/Models/Requests/PaymentsActionRequest.md index bc76041..eb66fe4 100644 --- a/docs/Models/Requests/PaymentsActionRequest.md +++ b/docs/Models/Requests/PaymentsActionRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the payment to operate on | iKv7t5bgt1gg | | `PaymentActionRequest` | [PaymentActionRequest](../../Models/Components/PaymentActionRequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/Models/Requests/PaymentsInitializeRequest.md b/docs/Models/Requests/PaymentsInitializeRequest.md index 79dfd70..8b43817 100644 --- a/docs/Models/Requests/PaymentsInitializeRequest.md +++ b/docs/Models/Requests/PaymentsInitializeRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `PaymentInitializeRequest` | [PaymentInitializeRequest](../../Models/Components/PaymentInitializeRequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/PaymentsUpdateRequest.md b/docs/Models/Requests/PaymentsUpdateRequest.md deleted file mode 100644 index b0b945c..0000000 --- a/docs/Models/Requests/PaymentsUpdateRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# PaymentsUpdateRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | -| `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | -| `Id` | *string* | :heavy_check_mark: | The ID of the payment to update | iKv7t5bgt1gg | -| `PaymentUpdateRequest` | [PaymentUpdateRequest](../../Models/Components/PaymentUpdateRequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/Models/Requests/PaymentsUpdateResponse.md b/docs/Models/Requests/PaymentsUpdateResponse.md deleted file mode 100644 index 85c69dc..0000000 --- a/docs/Models/Requests/PaymentsUpdateResponse.md +++ /dev/null @@ -1,9 +0,0 @@ -# PaymentsUpdateResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `HttpMeta` | [HTTPMetadata](../../Models/Components/HTTPMetadata.md) | :heavy_check_mark: | N/A | -| `PaymentResponse` | [PaymentResponse](../../Models/Components/PaymentResponse.md) | :heavy_minus_sign: | The pending payment was successfully updated | \ No newline at end of file diff --git a/docs/Models/Requests/TestingAccountCreateRequest.md b/docs/Models/Requests/TestingAccountCreateRequest.md index b67aa32..e2f1eb1 100644 --- a/docs/Models/Requests/TestingAccountCreateRequest.md +++ b/docs/Models/Requests/TestingAccountCreateRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | -| `AccountTestCreationData` | [AccountTestCreationData](../../Models/Components/AccountTestCreationData.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | +| `AccountTestCreationData` | [AccountTestCreationData](../../Models/Components/AccountTestCreationData.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/Models/Requests/TestingAccountPhoneGetRequest.md b/docs/Models/Requests/TestingAccountPhoneGetRequest.md index 57ce5ed..9f16c5b 100644 --- a/docs/Models/Requests/TestingAccountPhoneGetRequest.md +++ b/docs/Models/Requests/TestingAccountPhoneGetRequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | \ No newline at end of file diff --git a/docs/sdks/account/README.md b/docs/sdks/account/README.md index e256aea..0694b29 100644 --- a/docs/sdks/account/README.md +++ b/docs/sdks/account/README.md @@ -3,9 +3,7 @@ ## Overview -Account endpoints allow you to view and manage shoppers' accounts. For example, -you can add or remove addresses and payment information. - +Use the Accounts API to access shoppers' accounts to empower your checkout and facilitate shoppers' choices. ### Available Operations @@ -13,7 +11,7 @@ you can add or remove addresses and payment information. * [AddAddress](#addaddress) - Add an address * [UpdateAddress](#updateaddress) - Edit an existing address * [DeleteAddress](#deleteaddress) - Delete an existing address -* [AddPaymentMethod](#addpaymentmethod) - Add a payment method to a shopper's Bolt account Wallet. +* [AddPaymentMethod](#addpaymentmethod) - Add a payment method * [DeletePaymentMethod](#deletepaymentmethod) - Delete an existing payment method ## GetDetails @@ -42,7 +40,7 @@ var res = await sdk.Account.GetDetailsAsync( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | @@ -95,7 +93,7 @@ var res = await sdk.Account.AddAddressAsync( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `AddressListing` | [AddressListingInput](../../Models/Components/AddressListingInput.md) | :heavy_check_mark: | N/A | @@ -112,10 +110,7 @@ var res = await sdk.Account.AddAddressAsync( ## UpdateAddress -Edit an existing address on the shopper's account. This does not edit addresses -that are already associated with other resources, such as transactions or -shipments. - +Edit an existing address on the shopper's account. This does not edit addresses that are already associated with other resources, such as transactions or shipments. ### Example Usage @@ -153,7 +148,7 @@ var res = await sdk.Account.UpdateAddressAsync( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the address to edit | D4g3h5tBuVYK9 | | `AddressListing` | [AddressListingInput](../../Models/Components/AddressListingInput.md) | :heavy_check_mark: | N/A | | @@ -171,9 +166,7 @@ var res = await sdk.Account.UpdateAddressAsync( ## DeleteAddress -Delete an existing address. Deleting an address does not invalidate transactions or -shipments that are associated with it. - +Delete an existing address. Deleting an address does not invalidate or remove the address from transactions or shipments that are associated with it. ### Example Usage @@ -198,7 +191,7 @@ var res = await sdk.Account.DeleteAddressAsync( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the address to delete | D4g3h5tBuVYK9 | @@ -215,11 +208,7 @@ var res = await sdk.Account.DeleteAddressAsync( ## AddPaymentMethod -Add a payment method to a shopper's Bolt account Wallet. For security purposes, this request must come from -your backend because authentication requires the use of your private key.
-**Note**: Before using this API, the credit card details must be tokenized using Bolt's JavaScript library function, -which is documented in [Install the Bolt Tokenizer](https://help.bolt.com/developers/references/bolt-tokenizer). - +Add a payment method to a shopper's Bolt Account Wallet. For security purposes, this request must come from your backend.
**Note**: Before using this API, the credit card details must be tokenized by Bolt's credit card tokenization service. Please review our [Bolt Payment Field Component](https://help.bolt.com/products/ignite/api-implementation/#enhance-payments) or [Install the Bolt Tokenizer](https://help.bolt.com/developers/references/bolt-tokenizer) documentation. ### Example Usage @@ -249,7 +238,7 @@ var res = await sdk.Account.AddPaymentMethodAsync( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `PaymentMethod` | [PaymentMethodInput](../../Models/Components/PaymentMethodInput.md) | :heavy_check_mark: | N/A | @@ -266,9 +255,7 @@ var res = await sdk.Account.AddPaymentMethodAsync( ## DeletePaymentMethod -Delete an existing payment method. Deleting a payment method does not invalidate transactions or -orders that are associated with it. - +Delete an existing payment method. Deleting a payment method does not invalidate or remove it from transactions or orders that are associated with it. ### Example Usage @@ -293,7 +280,7 @@ var res = await sdk.Account.DeletePaymentMethodAsync( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the payment method to delete | D4g3h5tBuVYK9 | diff --git a/docs/sdks/boltsdk/README.md b/docs/sdks/boltsdk/README.md index e6253fc..e31239d 100644 --- a/docs/sdks/boltsdk/README.md +++ b/docs/sdks/boltsdk/README.md @@ -3,7 +3,7 @@ ## Overview -Bolt API Reference: A comprehensive Bolt API reference for interacting with Transactions, Orders, Product Catalog, Configuration, Testing, and much more. +Bolt API Reference: A comprehensive Bolt API reference for interacting with Accounts, Payments, Orders and more. ### Available Operations diff --git a/docs/sdks/guest/README.md b/docs/sdks/guest/README.md index 87f2fbe..eaf538c 100644 --- a/docs/sdks/guest/README.md +++ b/docs/sdks/guest/README.md @@ -4,14 +4,11 @@ ### Available Operations * [Initialize](#initialize) - Initialize a Bolt payment for guest shoppers -* [Update](#update) - Update an existing guest payment -* [PerformAction](#performaction) - Perform an irreversible action (e.g. finalize) on a pending guest payment +* [PerformAction](#performaction) - Finalize a pending guest payment ## Initialize -Initialize a Bolt payment token that will be used to reference this payment to -Bolt when it is updated or finalized for guest shoppers. - +Initialize a Bolt guest shopper's intent to pay for a cart, using the specified payment method. Payments must be finalized before indicating the payment result to the shopper. Some payment methods will finalize automatically after initialization. For these payments, they will transition directly to "finalized" and the response from Initialize Payment will contain a finalized payment. ### Example Usage @@ -105,7 +102,7 @@ var res = await sdk.Payments.Guest.InitializeAsync( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `security` | [Boltpay.SDK.Models.Requests.GuestPaymentsInitializeSecurity](../../Models/Requests/GuestPaymentsInitializeSecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `GuestPaymentInitializeRequest` | [GuestPaymentInitializeRequest](../../Models/Components/GuestPaymentInitializeRequest.md) | :heavy_check_mark: | N/A | @@ -120,121 +117,9 @@ var res = await sdk.Payments.Guest.InitializeAsync( | Boltpay.SDK.Models.Errors.ResponsePaymentError | 4XX | application/json | | Boltpay.SDK.Models.Errors.SDKException | 4xx-5xx | */* | -## Update - -Update a pending guest payment - - -### Example Usage - -```csharp -using Boltpay.SDK; -using Boltpay.SDK.Models.Requests; -using Boltpay.SDK.Models.Components; -using System.Collections.Generic; - -var sdk = new BoltSDK(); - -var res = await sdk.Payments.Guest.UpdateAsync( - security: new GuestPaymentsUpdateSecurity() { - ApiKey = "", - }, - xPublishableKey: "", - xMerchantClientId: "", - id: "iKv7t5bgt1gg", - paymentUpdateRequest: new PaymentUpdateRequest() { - Cart = new Cart() { - OrderReference = "order_100", - OrderDescription = "Order #1234567890", - DisplayId = "215614191", - Shipments = new List() { - new CartShipment() { - Address = AddressReferenceInput.CreateExplicit( - new AddressReferenceExplicitInput() { - DotTag = Boltpay.SDK.Models.Components.AddressReferenceExplicitTag.Explicit, - FirstName = "Alice", - LastName = "Baker", - Company = "ACME Corporation", - StreetAddress1 = "535 Mission St, Ste 1401", - StreetAddress2 = "c/o Shipping Department", - Locality = "San Francisco", - PostalCode = "94105", - Region = "CA", - CountryCode = Boltpay.SDK.Models.Components.CountryCode.Us, - Email = "alice@example.com", - Phone = "+14155550199", - } - ), - Cost = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - Carrier = "FedEx", - }, - }, - Discounts = new List() { - new CartDiscount() { - Amount = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - Code = "SUMMER10DISCOUNT", - DetailsUrl = "https://www.example.com/SUMMER-SALE", - }, - }, - Items = new List() { - new CartItem() { - Name = "Bolt Swag Bag", - Reference = "item_100", - Description = "Large tote with Bolt logo.", - TotalAmount = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - UnitPrice = 1000, - Quantity = 1, - ImageUrl = "https://www.example.com/products/123456/images/1.png", - }, - }, - Total = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - Tax = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - }, -}); - -// handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [Boltpay.SDK.Models.Requests.GuestPaymentsUpdateSecurity](../../Models/Requests/GuestPaymentsUpdateSecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | -| `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | -| `Id` | *string* | :heavy_check_mark: | The ID of the guest payment to update | iKv7t5bgt1gg | -| `PaymentUpdateRequest` | [PaymentUpdateRequest](../../Models/Components/PaymentUpdateRequest.md) | :heavy_check_mark: | N/A | | - - -### Response - -**[GuestPaymentsUpdateResponse](../../Models/Requests/GuestPaymentsUpdateResponse.md)** -### Errors - -| Error Object | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| Boltpay.SDK.Models.Errors.Response4xx | 4XX | application/json | -| Boltpay.SDK.Models.Errors.SDKException | 4xx-5xx | */* | - ## PerformAction -Perform an irreversible action on a pending guest payment, such as finalizing it. - +Finalize a pending payment being made by a Bolt guest shopper. Upon receipt of a finalized payment result, payment success should be communicated to the shopper. ### Example Usage @@ -265,7 +150,7 @@ var res = await sdk.Payments.Guest.PerformActionAsync( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `security` | [Boltpay.SDK.Models.Requests.GuestPaymentsActionSecurity](../../Models/Requests/GuestPaymentsActionSecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the guest payment to operate on | iKv7t5bgt1gg | | `PaymentActionRequest` | [PaymentActionRequest](../../Models/Components/PaymentActionRequest.md) | :heavy_check_mark: | N/A | | diff --git a/docs/sdks/loggedin/README.md b/docs/sdks/loggedin/README.md index a315f2f..faf1f9a 100644 --- a/docs/sdks/loggedin/README.md +++ b/docs/sdks/loggedin/README.md @@ -4,13 +4,11 @@ ### Available Operations * [Initialize](#initialize) - Initialize a Bolt payment for logged in shoppers -* [Update](#update) - Update an existing payment -* [PerformAction](#performaction) - Perform an irreversible action (e.g. finalize) on a pending payment +* [PerformAction](#performaction) - Finalize a pending payment ## Initialize -Initialize a Bolt payment token that will be used to reference this payment to -Bolt when it is updated or finalized for logged in shoppers. +Initialize a Bolt logged-in shopper's intent to pay for a cart, using the specified payment method. Payments must be finalized before indicating the payment result to the shopper. Some payment methods will finalize automatically after initialization. For these payments, they will transition directly to "finalized" and the response from Initialize Payment will contain a finalized payment. ### Example Usage @@ -96,7 +94,7 @@ var res = await sdk.Payments.LoggedIn.InitializeAsync( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `PaymentInitializeRequest` | [PaymentInitializeRequest](../../Models/Components/PaymentInitializeRequest.md) | :heavy_check_mark: | N/A | @@ -111,119 +109,9 @@ var res = await sdk.Payments.LoggedIn.InitializeAsync( | Boltpay.SDK.Models.Errors.ResponsePaymentError | 4XX | application/json | | Boltpay.SDK.Models.Errors.SDKException | 4xx-5xx | */* | -## Update - -Update a pending payment - - -### Example Usage - -```csharp -using Boltpay.SDK; -using Boltpay.SDK.Models.Requests; -using Boltpay.SDK.Models.Components; -using System.Collections.Generic; - -var sdk = new BoltSDK(security: new Security() { - Oauth = "", - }); - -var res = await sdk.Payments.LoggedIn.UpdateAsync( - xPublishableKey: "", - xMerchantClientId: "", - id: "iKv7t5bgt1gg", - paymentUpdateRequest: new PaymentUpdateRequest() { - Cart = new Cart() { - OrderReference = "order_100", - OrderDescription = "Order #1234567890", - DisplayId = "215614191", - Shipments = new List() { - new CartShipment() { - Address = AddressReferenceInput.CreateExplicit( - new AddressReferenceExplicitInput() { - DotTag = Boltpay.SDK.Models.Components.AddressReferenceExplicitTag.Explicit, - FirstName = "Alice", - LastName = "Baker", - Company = "ACME Corporation", - StreetAddress1 = "535 Mission St, Ste 1401", - StreetAddress2 = "c/o Shipping Department", - Locality = "San Francisco", - PostalCode = "94105", - Region = "CA", - CountryCode = Boltpay.SDK.Models.Components.CountryCode.Us, - Email = "alice@example.com", - Phone = "+14155550199", - } - ), - Cost = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - Carrier = "FedEx", - }, - }, - Discounts = new List() { - new CartDiscount() { - Amount = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - Code = "SUMMER10DISCOUNT", - DetailsUrl = "https://www.example.com/SUMMER-SALE", - }, - }, - Items = new List() { - new CartItem() { - Name = "Bolt Swag Bag", - Reference = "item_100", - Description = "Large tote with Bolt logo.", - TotalAmount = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - UnitPrice = 1000, - Quantity = 1, - ImageUrl = "https://www.example.com/products/123456/images/1.png", - }, - }, - Total = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - Tax = new Amount() { - Currency = Boltpay.SDK.Models.Components.Currency.Usd, - Units = 900, - }, - }, -}); - -// handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | -| `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | -| `Id` | *string* | :heavy_check_mark: | The ID of the payment to update | iKv7t5bgt1gg | -| `PaymentUpdateRequest` | [PaymentUpdateRequest](../../Models/Components/PaymentUpdateRequest.md) | :heavy_check_mark: | N/A | | - - -### Response - -**[PaymentsUpdateResponse](../../Models/Requests/PaymentsUpdateResponse.md)** -### Errors - -| Error Object | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| Boltpay.SDK.Models.Errors.Response4xx | 4XX | application/json | -| Boltpay.SDK.Models.Errors.SDKException | 4xx-5xx | */* | - ## PerformAction -Perform an irreversible action on a pending payment, such as finalizing it. - +Finalize a pending payment being made by a Bolt logged-in shopper. Upon receipt of a finalized payment result, payment success should be communicated to the shopper. ### Example Usage @@ -252,7 +140,7 @@ var res = await sdk.Payments.LoggedIn.PerformActionAsync( | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | | `Id` | *string* | :heavy_check_mark: | The ID of the payment to operate on | iKv7t5bgt1gg | | `PaymentActionRequest` | [PaymentActionRequest](../../Models/Components/PaymentActionRequest.md) | :heavy_check_mark: | N/A | | diff --git a/docs/sdks/oauth/README.md b/docs/sdks/oauth/README.md index a1b1e50..bde5215 100644 --- a/docs/sdks/oauth/README.md +++ b/docs/sdks/oauth/README.md @@ -3,9 +3,7 @@ ## Overview -Use this endpoint to retrieve an OAuth token. Use the token to allow your ecommerce server to make calls to the Account -endpoint and create a one-click checkout experience for shoppers. - +Use the OAuth API to enable your ecommerce server to make API calls on behalf of a Bolt logged-in shopper. ### Available Operations diff --git a/docs/sdks/orders/README.md b/docs/sdks/orders/README.md index ec4de93..5e23689 100644 --- a/docs/sdks/orders/README.md +++ b/docs/sdks/orders/README.md @@ -5,15 +5,13 @@ Use the Orders API to create and manage orders, including orders that have been placed outside the Bolt ecosystem. - ### Available Operations -* [OrdersCreate](#orderscreate) - Create an order that was placed outside the Bolt ecosystem. +* [OrdersCreate](#orderscreate) - Create an order that was prepared outside the Bolt ecosystem. ## OrdersCreate -Create an order that was placed outside the Bolt ecosystem. - +Create an order that was prepared outside the Bolt ecosystem. Some Bolt-powered flows automatically manage order creation - in those flows the order ID will be provided separately and not through this API. ### Example Usage @@ -110,7 +108,7 @@ var res = await sdk.Orders.OrdersCreateAsync( | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `security` | [Boltpay.SDK.Models.Requests.OrdersCreateSecurity](../../Models/Requests/OrdersCreateSecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `XMerchantClientId` | *string* | :heavy_check_mark: | A unique identifier for a shopper's device, generated by Bolt. This header is required for proper attribution of this operation to your analytics reports. Omitting this header may result in incorrect statistics. | | `Order` | [Order](../../Models/Components/Order.md) | :heavy_check_mark: | N/A | diff --git a/docs/sdks/testing/README.md b/docs/sdks/testing/README.md index dbecf62..fd3aa2f 100644 --- a/docs/sdks/testing/README.md +++ b/docs/sdks/testing/README.md @@ -3,21 +3,18 @@ ## Overview -Endpoints that allow you to generate and retrieve test data to verify certain -flows in non-production environments. - +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 test credit card, including its token +* [GetCreditCard](#getcreditcard) - Retrieve a tokenized test credit card ## CreateAccount Create a Bolt shopper account for testing purposes. - ### Example Usage ```csharp @@ -48,7 +45,7 @@ var res = await sdk.Testing.CreateAccountAsync( | Parameter | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `security` | [Boltpay.SDK.Models.Requests.TestingAccountCreateSecurity](../../Models/Requests/TestingAccountCreateSecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | | `AccountTestCreationData` | [AccountTestCreationData](../../Models/Components/AccountTestCreationData.md) | :heavy_check_mark: | N/A | @@ -64,8 +61,7 @@ var res = await sdk.Testing.CreateAccountAsync( ## TestingAccountPhoneGet -Get a random, fictitious phone number that is not assigned to any existing account. - +Get a random, fictitious phone number that is not assigned to any existing Bolt account. ### Example Usage @@ -89,7 +85,7 @@ var res = await sdk.Testing.TestingAccountPhoneGetAsync( | Parameter | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `security` | [Boltpay.SDK.Models.Requests.TestingAccountPhoneGetSecurity](../../Models/Requests/TestingAccountPhoneGetSecurity.md) | :heavy_check_mark: | The security requirements to use for the request. | -| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly viewable identifier used to identify a merchant division. | +| `XPublishableKey` | *string* | :heavy_check_mark: | The publicly shareable identifier used to identify your Bolt merchant division. | ### Response @@ -104,8 +100,7 @@ var res = await sdk.Testing.TestingAccountPhoneGetAsync( ## GetCreditCard -Retrieve test credit card information. This includes its token, which can be used to process payments. - +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