README.md update

Author: Dylan-FMK

.gitignore

@@ -6,7 +6,6 @@
 /.config
 /coverage/
 /InstalledFiles
-log/
 /pkg/
 /spec/reports/
 /spec/examples.txt
@@ -38,5 +37,3 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
-config.json
-.env

.openapi-generator/FILES

@@ -182,10 +182,12 @@ docs/TransactionDetailResponseSplitsInner.md
 docs/TransactionDetailResponseTenderInfo.md
 docs/TransactionPaymentResponse.md
 docs/TransactionPaymentResponseAchTenderInfo.md
+docs/TransactionPaymentResponseAchTenderInfoCommissionType.md
 docs/TransactionPaymentResponseBillingContact.md
 docs/TransactionPaymentResponseBillingContactAddress.md
 docs/TransactionPaymentResponseBillingContactName.md
 docs/TransactionPaymentResponseCcTenderInfo.md
+docs/TransactionPaymentResponseRefundOrigin.md
 docs/TransactionPaymentResponseRefundTransactions.md
 docs/TransactionPaymentResponseRefundTransactionsDataInner.md
 docs/TransactionPaymentResponseTransactionEntitySplitResponsesInner.md
@@ -386,10 +388,12 @@ lib/openapi_client/models/transaction_detail_response_splits_inner.rb
 lib/openapi_client/models/transaction_detail_response_tender_info.rb
 lib/openapi_client/models/transaction_payment_response.rb
 lib/openapi_client/models/transaction_payment_response_ach_tender_info.rb
+lib/openapi_client/models/transaction_payment_response_ach_tender_info_commission_type.rb
 lib/openapi_client/models/transaction_payment_response_billing_contact.rb
 lib/openapi_client/models/transaction_payment_response_billing_contact_address.rb
 lib/openapi_client/models/transaction_payment_response_billing_contact_name.rb
 lib/openapi_client/models/transaction_payment_response_cc_tender_info.rb
+lib/openapi_client/models/transaction_payment_response_refund_origin.rb
 lib/openapi_client/models/transaction_payment_response_refund_transactions.rb
 lib/openapi_client/models/transaction_payment_response_refund_transactions_data_inner.rb
 lib/openapi_client/models/transaction_payment_response_transaction_entity_split_responses_inner.rb
@@ -411,31 +415,6 @@ lib/openapi_client/models/verify_bank_account_response.rb
 lib/openapi_client/models/verify_bank_account_response_http_response.rb
 lib/openapi_client/version.rb
 openapi_client.gemspec
-spec/models/payment_intent_request_intent_spec.rb
-spec/models/payment_intent_request_pfr_spec.rb
-spec/models/payment_intent_request_splits_inner_spec.rb
-spec/models/payment_link_response_customers_inner_accounts_inner_spec.rb
-spec/models/payment_link_response_display_settings_intent_spec.rb
-spec/models/payment_link_response_display_settings_spec.rb
-spec/models/payment_link_response_payments_inner_spec.rb
-spec/models/payment_link_response_reference_data_list_inner_spec.rb
-spec/models/pf_endorsement_response_item_payment_intent_intent_spec.rb
-spec/models/pf_endorsement_response_item_payment_intent_spec.rb
-spec/models/pf_lite_generate_quote_response_item_e_sign_result_spec.rb
-spec/models/pf_lite_generate_quote_response_item_spec.rb
-spec/models/pf_lite_generate_quote_response_spec.rb
-spec/models/pf_lite_payment_link_request_customers_inner_address_spec.rb
-spec/models/pf_lite_payment_link_request_customers_inner_spec.rb
-spec/models/pf_lite_payment_link_request_reference_data_list_inner_spec.rb
-spec/models/pf_lite_quote_by_payment_link_response_policies_inner_carrier_spec.rb
-spec/models/pf_lite_quote_by_payment_link_response_policies_inner_spec.rb
-spec/models/quote_request_agent_address_spec.rb
-spec/models/quote_request_policies_inner_ga_address_spec.rb
-spec/models/secure_update_payment_link_request_settings_intent_spec.rb
-spec/models/token_link_response_data_inner_spec.rb
-spec/models/token_link_response_spec.rb
-spec/models/token_link_secure_request_intent_spec.rb
-spec/models/transaction_payment_response_refund_transactions_data_inner_spec.rb
-spec/models/transaction_payment_response_refund_transactions_spec.rb
-spec/models/vendor_request_dto_physical_address_spec.rb
+spec/models/transaction_payment_response_ach_tender_info_commission_type_spec.rb
+spec/models/transaction_payment_response_refund_origin_spec.rb
 spec/spec_helper.rb

README.md

@@ -1,166 +1,103 @@
-# AndDone Client Library - Ruby
+# openapi_client
 
-This client library integrates with AndDone's secure APIs.
+OpenapiClient - the Ruby gem for the Secure API
 
-Please see our developer documentation & API Explorer, linked below, for detailed instructions on how to integrate this into your systems.
+Secure API
 
-**Secure API Ruby Client**
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-This Ruby SDK is an auto-generated client for the AndDone Secure API, built using the [OpenAPI Generator](https://openapi-generator.tech).
-
-* **API version**: 2.3
-* **Package version**: 1.0.0
-* **Generator version**: 7.9.0
-* **Build package**: `org.openapitools.codegen.languages.RubyClientCodegen`
-* **Developer Documentation**: [DevDocs](https://docs.anddone.com/)
-* **API Explorer**: [AndDone API Explorer](https://docs.anddone.com/explorer/)
-
----
-
-## Table of Contents
-
-* [Requirements](#requirements)
-* [Installation](#installation)
-* [Configuration](#configuration)
-* [Quickstart](#quickstart)
-* [API Endpoints](#api-endpoints)
-* [Models](#models)
-* [Authorization](#authorization)
-* [Support & Versioning](#support--versioning)
-
----
-
-## Requirements
-
-* **Ruby 2.7+**
-* Bundler / RubyGems
-* Access to **AndDone Merchant Portal** for API keys
-
----
+- API version: 2.3
+- Package version: 1.0.0
+- Generator version: 7.9.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
 
-### Install from RubyGems
+### Build a gem
 
-If published, install via Bundler:
+To build the Ruby code into a gem:
 
-```ruby
-gem 'openapi_client', '~> 1.0.0'
-```
-
-Then run:
-
-```bash
-bundle install
-```
-
-### Install from Git
-
-If hosted on GitHub:
-
-```ruby
-gem 'openapi_client', :git => 'https://github.com/anddone-kit/AndDone-SecureAPI-ClientLibrary-Ruby.git'
+```shell
+gem build openapi_client.gemspec
 ```
 
-### Build & Install Locally
+Then either install the gem locally:
 
-```bash
-gem build openapi_client.gemspec
+```shell
 gem install ./openapi_client-1.0.0.gem
 ```
 
----
-
-## Configuration
-
-1. **Retrieve Developer Credentials:**
+(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)
 
-   1. Log in to AndDone Merchant Portal:
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-      * **UAT**: [https://portal.uat.anddone.com](https://portal.uat.anddone.com)
-      * **Production**: [https://portal.anddone.com](https://portal.anddone.com)
-   2. Go to **Developer → API Keys** in the left menu.
-   3. Copy:
+Finally add this to the Gemfile:
 
-      * `xApiKey` (API Key)
-      * `xAppKey` (App Key)
+    gem 'openapi_client', '~> 1.0.0'
 
-2. **Determine Your Origin:**
-   The `origin` is your public IP address.
-   Find it by searching **"what's my IP"** in Google or visiting [https://www.whatsmyip.org](https://www.whatsmyip.org).
+### Install from Git
 
-   * Contact AndDone support to ensure your origin IP is registered.
-   * Email: [support@anddone.com](mailto:support@anddone.com)
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
 
-3. **Create a Config File (Recommended):**
-   Rename `config.example.json` → `config.json` and fill with your keys:
+    gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
 
-   ```json
-   {
-     "x_api_key": "YOUR_API_KEY",
-     "x_app_key": "YOUR_APP_KEY",
-     "x_version": "2.3",
-     "origin": "YOUR_IP_ADDRESS"
-   }
-   ```
+### Include the Ruby code directly
 
----
+Include the Ruby code directly using `-I` as follows:
 
-## Quickstart
+```shell
+ruby -Ilib script.rb
+```
 
-Here’s a minimal working example to call the **Secure Create Payment Intent API**:
+## Getting Started
+1. Find and note your company AndDone Developer settings.
+   1. Login to (UAT) https://portal.uat.anddone.com/   (Production) https://portal.anddone.com/
+   2. In the left menu, click "Developer" then "API Keys"
+   3. Your xApiKey will be the API Key
+   4. Your xAppKey will be the App Key
+2. You will need to register your Origin with us to execute API calls against our Secure endpoints.
+   1. Typically, we use your domain for production or other hosted environments and IP address for local development environments.
+   2. Contact AndDone support (integrations@anddone.com) or your onboarding agent to ensure all your domains or IP addresses you may use are registered for use with our secure APIs.
+3. Please follow the [installation](#installation) procedure and then modify and run the following code:
 
 ```ruby
+# Load the gem
 require 'json'
 require 'openapi_client'
 
-# Load API keys from config.json
-file = File.read('./config.json')
-config = JSON.parse(file)
-
-x_api_key = config['x_api_key']
-x_app_key = config['x_app_key']
-x_version = config['x_version']
-origin   = config['origin']
-
-api = OpenapiClient::SecurePaymentIntentApi.new
-
-request = OpenapiClient::PaymentIntentRequest.new(
-  save_for_future: true,
-  amount: 10000,
-  title: "YOUR UNIQUE TITLE",
-  short_description: "shortDescription",
-  payment_description: "paymentDescription",
-  invoice_number: "ruby-sdk",
-  expires_in: "300000",
-  intent: {
-    payment_types: ["CreditCard", "ACH"]
-  },
-  enable_premium_finance: true,
-  additional_details_preference: "NoAdditionalDetails"
-)
+# Setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: x-api-key
+  config.api_key['x-api-key'] = 'YOUR_API_KEY'
+  # Configure API key authorization: x-app-key
+  config.api_key['x-app-key'] = 'YOUR_APP_KEY'
+end
+
+api_instance = OpenapiClient::SecurePaymentIntentApi.new
+x_api_key = 'x_api_key_example' # String | an authorization header
+x_app_key = 'x_app_key_example' # String | an authorization header
+x_version = 8.14 # Float | x-version
+origin = 'origin_example' # String | origin
+opts = { :payment_intent_request => JSON.parse('{YOUR_PAYMENT_INTENT_REQUEST}')
+}
 
 begin
-  result = api.secure_paymentintents_post(x_api_key, x_app_key, x_version, origin, request)
-  puts result
+  #This API will create a payment intent
+  result = api_instance.secure_paymentintents_post(x_api_key, x_app_key, x_version, origin, opts)
+  p result
 rescue OpenapiClient::ApiError => e
-  puts "Exception when calling SecurePaymentIntentApi: #{e}"
+  puts "Exception when calling SecurePaymentIntentApi->secure_paymentintents_post: #{e}"
 end
 ```
 
----
-
-## API Endpoints
-
-All URIs are relative to:
-
-* **UAT**: `https://api.uat.anddone.com`
-* **Production**: `https://api.anddone.com`
+## Documentation for API Endpoints
 
-<details>
-  <summary>Click to view all endpoints</summary>
+All URIs are relative to *https://api.uat.anddone.com*
 
-EmbeddedPremiumFinanceApi.md#secure_epf_quotes_booking_put) | **PUT** /secure/epf/quotes/booking | This API will update PFA to book a quote.
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OpenapiClient::SecureEmbeddedPremiumFinanceApi* | [**secure_epf_merchants_quotes_policy_put**](docs/SecureEmbeddedPremiumFinanceApi.md#secure_epf_merchants_quotes_policy_put) | **PUT** /secure/epf/merchants/quotes/policy | This API is will update the policy number
+*OpenapiClient::SecureEmbeddedPremiumFinanceApi* | [**secure_epf_quotes_booking_put**](docs/SecureEmbeddedPremiumFinanceApi.md#secure_epf_quotes_booking_put) | **PUT** /secure/epf/quotes/booking | This API will update PFA to book a quote.
 *OpenapiClient::SecureEmbeddedPremiumFinanceApi* | [**secure_epf_quotes_captureesign_put**](docs/SecureEmbeddedPremiumFinanceApi.md#secure_epf_quotes_captureesign_put) | **PUT** /secure/epf/quotes/captureesign | This API will eSign the pfa with insured name.
 *OpenapiClient::SecureEmbeddedPremiumFinanceApi* | [**secure_epf_quotes_generate_post**](docs/SecureEmbeddedPremiumFinanceApi.md#secure_epf_quotes_generate_post) | **POST** /secure/epf/quotes/generate | This API is used to Generate Quotes
 *OpenapiClient::SecureEmbeddedPremiumFinanceApi* | [**secure_epf_quotes_intent_post**](docs/SecureEmbeddedPremiumFinanceApi.md#secure_epf_quotes_intent_post) | **POST** /secure/epf/quotes/intent | This API will return quotes created againsts a payment intent.
@@ -214,14 +151,8 @@ EmbeddedPremiumFinanceApi.md#secure_epf_quotes_booking_put) | **PUT** /secure/ep
 *OpenapiClient::SecureVendorManagementApi* | [**vendorapi_secure_merchants_vendors_unsuspend_post**](docs/SecureVendorManagementApi.md#vendorapi_secure_merchants_vendors_unsuspend_post) | **POST** /vendorapi/secure/merchants/vendors/unsuspend | This API unsuspends vendor into system
 *OpenapiClient::SecureVoidsApi* | [**secure_cancellations_post**](docs/SecureVoidsApi.md#secure_cancellations_post) | **POST** /secure/cancellations | This API cancel a transaction.
 
-</details>
 
----
-
-## Models
-
-<details>
-  <summary>Click to view all models</summary>
+## Documentation for Models
 
  - [OpenapiClient::BankDetailDto](docs/BankDetailDto.md)
  - [OpenapiClient::CancelPaymentRequestDTO](docs/CancelPaymentRequestDTO.md)
@@ -346,6 +277,7 @@ EmbeddedPremiumFinanceApi.md#secure_epf_quotes_booking_put) | **PUT** /secure/ep
  - [OpenapiClient::RowDto](docs/RowDto.md)
  - [OpenapiClient::SecureBatchExecuteRequest](docs/SecureBatchExecuteRequest.md)
  - [OpenapiClient::SecureCancelledTransactionResponse](docs/SecureCancelledTransactionResponse.md)
+ - [OpenapiClient::SecureEpfQuotesPost200Response](docs/SecureEpfQuotesPost200Response.md)
  - [OpenapiClient::SecureMerchantTokenShortResponse](docs/SecureMerchantTokenShortResponse.md)
  - [OpenapiClient::SecurePaymentBatchDetailsRequest](docs/SecurePaymentBatchDetailsRequest.md)
  - [OpenapiClient::SecurePaymentDetailsRequest](docs/SecurePaymentDetailsRequest.md)
@@ -384,10 +316,12 @@ EmbeddedPremiumFinanceApi.md#secure_epf_quotes_booking_put) | **PUT** /secure/ep
  - [OpenapiClient::TransactionDetailResponseTenderInfo](docs/TransactionDetailResponseTenderInfo.md)
  - [OpenapiClient::TransactionPaymentResponse](docs/TransactionPaymentResponse.md)
  - [OpenapiClient::TransactionPaymentResponseAchTenderInfo](docs/TransactionPaymentResponseAchTenderInfo.md)
+ - [OpenapiClient::TransactionPaymentResponseAchTenderInfoCommissionType](docs/TransactionPaymentResponseAchTenderInfoCommissionType.md)
  - [OpenapiClient::TransactionPaymentResponseBillingContact](docs/TransactionPaymentResponseBillingContact.md)
  - [OpenapiClient::TransactionPaymentResponseBillingContactAddress](docs/TransactionPaymentResponseBillingContactAddress.md)
  - [OpenapiClient::TransactionPaymentResponseBillingContactName](docs/TransactionPaymentResponseBillingContactName.md)
  - [OpenapiClient::TransactionPaymentResponseCcTenderInfo](docs/TransactionPaymentResponseCcTenderInfo.md)
+ - [OpenapiClient::TransactionPaymentResponseRefundOrigin](docs/TransactionPaymentResponseRefundOrigin.md)
  - [OpenapiClient::TransactionPaymentResponseRefundTransactions](docs/TransactionPaymentResponseRefundTransactions.md)
  - [OpenapiClient::TransactionPaymentResponseRefundTransactionsDataInner](docs/TransactionPaymentResponseRefundTransactionsDataInner.md)
  - [OpenapiClient::TransactionPaymentResponseTransactionEntitySplitResponsesInner](docs/TransactionPaymentResponseTransactionEntitySplitResponsesInner.md)
@@ -409,24 +343,35 @@ EmbeddedPremiumFinanceApi.md#secure_epf_quotes_booking_put) | **PUT** /secure/ep
  - [OpenapiClient::VerifyBankAccountResponseHttpResponse](docs/VerifyBankAccountResponseHttpResponse.md)
 
 
-</details>
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### x-api-key
+
+
+- **Type**: API key
+- **API key parameter name**: x-api-key
+- **Location**: HTTP header
+
+### x-app-key
+
+
+- **Type**: API key
+- **API key parameter name**: x-app-key
+- **Location**: HTTP header
 
----
+### x-version
 
-## Authorization
 
-Authentication is handled via API keys in HTTP headers:
+- **Type**: API key
+- **API key parameter name**: x-version
+- **Location**: HTTP header
 
-| Key           | Location | Description             |
-| ------------- | -------- | ----------------------- |
-| **x-api-key** | Header   | Your API key            |
-| **x-app-key** | Header   | Your App key            |
-| **x-version** | Header   | API version (e.g., 2.3) |
-| **origin**    | Header   | Your public IP address  |
+### origin
 
----
 
-## Support & Versioning
+- **Type**: API key
+- **API key parameter name**: origin
+- **Location**: HTTP header
 
-* **API Environments:** Use UAT for testing; switch to Production only after validation.
-* **Issues:** Report bugs or request features via the [GitHub Issues](https://github.com/anddone-kit/AndDone-SecureAPI-ClientLibrary-Ruby/issues) page.

docs/MerchantTransactionEntityResponseDataInner.md

@@ -57,7 +57,7 @@
 | **adjustment_display_name** | **String** |  | [optional] |
 | **adjustment_descriptor_message** | **String** |  | [optional] |
 | **payment_adjustment_type** | **String** |  | [optional] |
-| **commission_type** | **String** |  | [optional] |
+| **commission_type** | [**TransactionPaymentResponseAchTenderInfoCommissionType**](TransactionPaymentResponseAchTenderInfoCommissionType.md) |  | [optional] |
 | **commission_value** | **Float** |  | [optional] |
 | **commission_fixed_value** | **Float** |  | [optional] |
 | **account_token** | **String** |  | [optional] |