Skip to content

Commit 524a60c

Browse files
Dylan-FMKDylan-FMK
committed
README.md update
1 parent 1b16f74 commit 524a60c

File tree

3 files changed

+42
-31
lines changed

3 files changed

+42
-31
lines changed

‎.openapi-generator-ignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@
2121
#docs/*.md
2222
# Then explicitly reverse the ignore rule for a single file:
2323
#!docs/README.md
24+
README.md

‎README.md‎

Lines changed: 38 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -47,39 +47,50 @@ Execute `pytest` to run the tests.
4747

4848
## Getting Started
4949

50+
1. Find and note your company AndDone Developer settings
51+
1. Login to (UAT) https://portal.uat.anddone.com/ (Production) https://portal.anddone.com/
52+
2. In the left menu, click "Developer" then "API Keys"
53+
3. Your xApiKey will be the API Key
54+
4. Your xAppKey will be the App Key
55+
2. Find your Origin by opening a browser and browse to: https://www.whatsmyip.org/ Your origin will be your IP Address
56+
3. Create a settings file to contain AndDone specific settings
57+
1. Rename config.example.json to config.json
58+
2. Input your API key, App key, and origin into the appropriate key values of config.json
59+
5060
Please follow the [installation procedure](#installation--usage) and then run the following:
5161

5262
```python
5363

5464
import openapi_client
5565
from openapi_client.rest import ApiException
5666
from pprint import pprint
67+
import json
5768

5869
# Defining the host is optional and defaults to https://api.uat.anddone.com
5970
# See configuration.py for a list of all supported configuration parameters.
6071
configuration = openapi_client.Configuration(
6172
host = "https://api.uat.anddone.com"
6273
)
6374

64-
65-
6675
# Enter a context with an instance of the API client
6776
with openapi_client.ApiClient(configuration) as api_client:
6877
# Create an instance of the API class
69-
api_instance = openapi_client.SecureAutopayEnrollmentApi(api_client)
70-
x_api_key = 'x_api_key_example' # str | an authorization header
71-
x_app_key = 'x_app_key_example' # str | an authorization header
72-
x_version = 'x_version_example' # str | x-version
73-
origin = 'origin_example' # str | origin
74-
auto_pay_enrollment_request = openapi_client.AutoPayEnrollmentRequest() # AutoPayEnrollmentRequest | Autopay Enrollment Detail
78+
api_instance = openapi_client.SecureEmbeddedPremiumFinanceApi(api_client)
79+
with open('config.json') as f:
80+
config = json.load(f)
81+
x_api_key = config['xApiKey']
82+
x_app_key = config['xAppKey']
83+
x_version = config['xVersion']
84+
origin = config['origin']
85+
pf_policy_update_request_dto = openapi_client.PFPolicyUpdateRequestDTO() # PFPolicyUpdateRequestDTO | Signature Request details (optional)
7586

7687
try:
77-
# This API is used for Autopay Enrollment.
78-
api_response = api_instance.secure_autopayenrollment_post(x_api_key, x_app_key, x_version, origin, auto_pay_enrollment_request)
79-
print("The response of SecureAutopayEnrollmentApi->secure_autopayenrollment_post:\n")
88+
# This API is will update the policy number
89+
api_response = api_instance.secure_epf_merchants_quotes_policy_put(x_api_key, x_app_key, x_version, origin, pf_policy_update_request_dto=pf_policy_update_request_dto)
90+
print("The response of SecureEmbeddedPremiumFinanceApi->secure_epf_merchants_quotes_policy_put:\n")
8091
pprint(api_response)
8192
except ApiException as e:
82-
print("Exception when calling SecureAutopayEnrollmentApi->secure_autopayenrollment_post: %s\n" % e)
93+
print("Exception when calling SecureEmbeddedPremiumFinanceApi->secure_epf_merchants_quotes_policy_put: %s\n" % e)
8394

8495
```
8596

@@ -89,7 +100,6 @@ All URIs are relative to *https://api.uat.anddone.com*
89100

90101
Class | Method | HTTP request | Description
91102
------------ | ------------- | ------------- | -------------
92-
*SecureAutopayEnrollmentApi* | [**secure_autopayenrollment_post**](docs/SecureAutopayEnrollmentApi.md#secure_autopayenrollment_post) | **POST** /secure/autopayenrollment | This API is used for Autopay Enrollment.
93103
*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
94104
*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.
95105
*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.
@@ -100,10 +110,11 @@ Class | Method | HTTP request | Description
100110
*SecureEmbeddedPremiumFinanceEndorsementsApi* | [**secure_epf_endorsements_post**](docs/SecureEmbeddedPremiumFinanceEndorsementsApi.md#secure_epf_endorsements_post) | **POST** /secure/epf/endorsements | This API will do a check of eligibility of account
101111
*SecureEmbeddedPremiumFinanceEndorsementsApi* | [**secure_epf_quote_endorsement_booking_put**](docs/SecureEmbeddedPremiumFinanceEndorsementsApi.md#secure_epf_quote_endorsement_booking_put) | **PUT** /secure/epf/quote/endorsement/booking | This API will update PFA to book a endorsement quote.
102112
*SecureEmbeddedPremiumFinanceEndorsementsApi* | [**secure_epf_quote_endorsement_post**](docs/SecureEmbeddedPremiumFinanceEndorsementsApi.md#secure_epf_quote_endorsement_post) | **POST** /secure/epf/quote/endorsement | This API will do return a quote for an existing policy or new policy for an existing account
113+
*SecureOrumApi* | [**secure_bankaccounts_details_post**](docs/SecureOrumApi.md#secure_bankaccounts_details_post) | **POST** /secure/bankaccounts/details | This API will request for verified bank account.
114+
*SecureOrumApi* | [**secure_bankaccounts_verify_post**](docs/SecureOrumApi.md#secure_bankaccounts_verify_post) | **POST** /secure/bankaccounts/verify | This API will request for account verification.
103115
*SecureOutboundPaymentsApi* | [**vendorapi_secure_outbound_payments_timelines_post**](docs/SecureOutboundPaymentsApi.md#vendorapi_secure_outbound_payments_timelines_post) | **POST** /vendorapi/secure/outboundPayments/timelines | This API gets outbound payment timelines
104116
*SecureOutboundPaymentsApi* | [**vendorapi_secure_outboundpayments_cancel_post**](docs/SecureOutboundPaymentsApi.md#vendorapi_secure_outboundpayments_cancel_post) | **POST** /vendorapi/secure/outboundpayments/cancel | This API cancel outbound payment request
105117
*SecureOutboundPaymentsApi* | [**vendorapi_secure_outboundpayments_detail_post**](docs/SecureOutboundPaymentsApi.md#vendorapi_secure_outboundpayments_detail_post) | **POST** /vendorapi/secure/outboundpayments/detail | This API fetch outbound payment by paymentId
106-
*SecureOutboundPaymentsApi* | [**vendorapi_secure_outboundpayments_image_post**](docs/SecureOutboundPaymentsApi.md#vendorapi_secure_outboundpayments_image_post) | **POST** /vendorapi/secure/outboundpayments/image | This API gets outbound payment JPG image in Base64 string format
107118
*SecureOutboundPaymentsApi* | [**vendorapi_secure_outboundpayments_post**](docs/SecureOutboundPaymentsApi.md#vendorapi_secure_outboundpayments_post) | **POST** /vendorapi/secure/outboundpayments | This API creates outbound payment request
108119
*SecureOutboundPaymentsApi* | [**vendorapi_secure_outboundpayments_search_post**](docs/SecureOutboundPaymentsApi.md#vendorapi_secure_outboundpayments_search_post) | **POST** /vendorapi/secure/outboundpayments/search | This API gets all outbound payment
109120
*SecurePaymentBatchingApi* | [**secure_batches_details_post**](docs/SecurePaymentBatchingApi.md#secure_batches_details_post) | **POST** /secure/batches/details | This API is used for getting Secure Payment Batch Details
@@ -147,8 +158,6 @@ Class | Method | HTTP request | Description
147158

148159
## Documentation For Models
149160

150-
- [AutoPayEnrollmentRequest](docs/AutoPayEnrollmentRequest.md)
151-
- [AutoPayEnrollmentResponse](docs/AutoPayEnrollmentResponse.md)
152161
- [BankDetailDto](docs/BankDetailDto.md)
153162
- [CancelPaymentRequestDTO](docs/CancelPaymentRequestDTO.md)
154163
- [DataDto](docs/DataDto.md)
@@ -157,14 +166,15 @@ Class | Method | HTTP request | Description
157166
- [HeadingDto](docs/HeadingDto.md)
158167
- [MerchantTransactionEntityResponse](docs/MerchantTransactionEntityResponse.md)
159168
- [MerchantTransactionEntityResponseDataInner](docs/MerchantTransactionEntityResponseDataInner.md)
160-
- [OutboundPaymentImageResponseDTO](docs/OutboundPaymentImageResponseDTO.md)
161169
- [OutboundPaymentTimelineResponseDTOInner](docs/OutboundPaymentTimelineResponseDTOInner.md)
162170
- [PFCheckEndorsementsRequest](docs/PFCheckEndorsementsRequest.md)
163171
- [PFCheckEndorsementsResponse](docs/PFCheckEndorsementsResponse.md)
164172
- [PFCheckEndorsementsResponseItem](docs/PFCheckEndorsementsResponseItem.md)
165173
- [PFCheckEndorsementsResponseItemPoliciesInner](docs/PFCheckEndorsementsResponseItemPoliciesInner.md)
166174
- [PFEndorsementRequest](docs/PFEndorsementRequest.md)
167175
- [PFEndorsementRequestQuote](docs/PFEndorsementRequestQuote.md)
176+
- [PFEndorsementRequestQuoteAgent](docs/PFEndorsementRequestQuoteAgent.md)
177+
- [PFEndorsementRequestQuoteAgentAddress](docs/PFEndorsementRequestQuoteAgentAddress.md)
168178
- [PFEndorsementRequestQuoteCommunication](docs/PFEndorsementRequestQuoteCommunication.md)
169179
- [PFEndorsementRequestQuoteDetails](docs/PFEndorsementRequestQuoteDetails.md)
170180
- [PFEndorsementRequestQuoteDetailsRecurringACH](docs/PFEndorsementRequestQuoteDetailsRecurringACH.md)
@@ -198,8 +208,6 @@ Class | Method | HTTP request | Description
198208
- [PFLiteQuoteByPaymentLinkResponsePoliciesInner](docs/PFLiteQuoteByPaymentLinkResponsePoliciesInner.md)
199209
- [PFLiteQuoteByPaymentLinkResponsePoliciesInnerCarrier](docs/PFLiteQuoteByPaymentLinkResponsePoliciesInnerCarrier.md)
200210
- [PFLiteSecureQuoteRequest](docs/PFLiteSecureQuoteRequest.md)
201-
- [PFLiteSecureQuoteRequestAgent](docs/PFLiteSecureQuoteRequestAgent.md)
202-
- [PFLiteSecureQuoteRequestAgentAddress](docs/PFLiteSecureQuoteRequestAgentAddress.md)
203211
- [PFLiteSecureQuoteRequestInsured](docs/PFLiteSecureQuoteRequestInsured.md)
204212
- [PFLiteSecureQuoteRequestInsuredAddress](docs/PFLiteSecureQuoteRequestInsuredAddress.md)
205213
- [PFLiteSecureQuoteRequestMerchant](docs/PFLiteSecureQuoteRequestMerchant.md)
@@ -234,10 +242,8 @@ Class | Method | HTTP request | Description
234242
- [PaymentIntentRequestSplitsInner](docs/PaymentIntentRequestSplitsInner.md)
235243
- [PaymentIntentResponse](docs/PaymentIntentResponse.md)
236244
- [PaymentIntentResponseCustomersInner](docs/PaymentIntentResponseCustomersInner.md)
237-
- [PaymentIntentResponseIntent](docs/PaymentIntentResponseIntent.md)
238245
- [PaymentLinkExpiresResponse](docs/PaymentLinkExpiresResponse.md)
239246
- [PaymentLinkRequest](docs/PaymentLinkRequest.md)
240-
- [PaymentLinkRequestReferenceDataListInner](docs/PaymentLinkRequestReferenceDataListInner.md)
241247
- [PaymentLinkRequestSettings](docs/PaymentLinkRequestSettings.md)
242248
- [PaymentLinkRequestSettingsIntent](docs/PaymentLinkRequestSettingsIntent.md)
243249
- [PaymentLinkResponse](docs/PaymentLinkResponse.md)
@@ -260,6 +266,7 @@ Class | Method | HTTP request | Description
260266
- [PaymentTimeLineRequestDto](docs/PaymentTimeLineRequestDto.md)
261267
- [QuoteRequest](docs/QuoteRequest.md)
262268
- [QuoteRequestAgent](docs/QuoteRequestAgent.md)
269+
- [QuoteRequestAgentAddress](docs/QuoteRequestAgentAddress.md)
263270
- [QuoteRequestDetails](docs/QuoteRequestDetails.md)
264271
- [QuoteRequestInsured](docs/QuoteRequestInsured.md)
265272
- [QuoteRequestInsuredAddress](docs/QuoteRequestInsuredAddress.md)
@@ -275,7 +282,6 @@ Class | Method | HTTP request | Description
275282
- [SecureBatchExecuteRequest](docs/SecureBatchExecuteRequest.md)
276283
- [SecureCancelledTransactionResponse](docs/SecureCancelledTransactionResponse.md)
277284
- [SecureMerchantTokenShortResponse](docs/SecureMerchantTokenShortResponse.md)
278-
- [SecurePFQuoteBookingRequest](docs/SecurePFQuoteBookingRequest.md)
279285
- [SecurePaymentBatchDetailsRequest](docs/SecurePaymentBatchDetailsRequest.md)
280286
- [SecurePaymentDetailsRequest](docs/SecurePaymentDetailsRequest.md)
281287
- [SecurePaymentLinkRequest](docs/SecurePaymentLinkRequest.md)
@@ -306,18 +312,17 @@ Class | Method | HTTP request | Description
306312
- [TokenLinkResponseDataInner](docs/TokenLinkResponseDataInner.md)
307313
- [TokenLinkSecureRequest](docs/TokenLinkSecureRequest.md)
308314
- [TokenLinkSecureRequestCustomersInner](docs/TokenLinkSecureRequestCustomersInner.md)
315+
- [TokenLinkSecureRequestIntent](docs/TokenLinkSecureRequestIntent.md)
309316
- [TokenRequest](docs/TokenRequest.md)
310317
- [TransactionDetailResponse](docs/TransactionDetailResponse.md)
311318
- [TransactionDetailResponseSplitsInner](docs/TransactionDetailResponseSplitsInner.md)
312319
- [TransactionDetailResponseTenderInfo](docs/TransactionDetailResponseTenderInfo.md)
313320
- [TransactionPaymentResponse](docs/TransactionPaymentResponse.md)
314321
- [TransactionPaymentResponseAchTenderInfo](docs/TransactionPaymentResponseAchTenderInfo.md)
315-
- [TransactionPaymentResponseAchTenderInfoCommissionType](docs/TransactionPaymentResponseAchTenderInfoCommissionType.md)
316322
- [TransactionPaymentResponseBillingContact](docs/TransactionPaymentResponseBillingContact.md)
317323
- [TransactionPaymentResponseBillingContactAddress](docs/TransactionPaymentResponseBillingContactAddress.md)
318324
- [TransactionPaymentResponseBillingContactName](docs/TransactionPaymentResponseBillingContactName.md)
319325
- [TransactionPaymentResponseCcTenderInfo](docs/TransactionPaymentResponseCcTenderInfo.md)
320-
- [TransactionPaymentResponseRefundOrigin](docs/TransactionPaymentResponseRefundOrigin.md)
321326
- [TransactionPaymentResponseRefundTransactions](docs/TransactionPaymentResponseRefundTransactions.md)
322327
- [TransactionPaymentResponseRefundTransactionsDataInner](docs/TransactionPaymentResponseRefundTransactionsDataInner.md)
323328
- [TransactionPaymentResponseTransactionEntitySplitResponsesInner](docs/TransactionPaymentResponseTransactionEntitySplitResponsesInner.md)
@@ -332,22 +337,27 @@ Class | Method | HTTP request | Description
332337
- [VendorResponseDTOTemplate](docs/VendorResponseDTOTemplate.md)
333338
- [VendorResponseDTOVerificationResultsInner](docs/VendorResponseDTOVerificationResultsInner.md)
334339
- [VendorTimelineResponseListInner](docs/VendorTimelineResponseListInner.md)
340+
- [VerificationEntityRequest](docs/VerificationEntityRequest.md)
341+
- [VerifyBankAccountRequest](docs/VerifyBankAccountRequest.md)
342+
- [VerifyBankAccountRequestBankAccountEntity](docs/VerifyBankAccountRequestBankAccountEntity.md)
343+
- [VerifyBankAccountResponse](docs/VerifyBankAccountResponse.md)
344+
- [VerifyBankAccountResponseHttpResponse](docs/VerifyBankAccountResponseHttpResponse.md)
335345

336346

337347
<a id="documentation-for-authorization"></a>
338348
## Documentation For Authorization
339349

340350

341351
Authentication schemes defined for the API:
342-
<a id="api-key"></a>
343-
### api-key
352+
<a id="x-api-key"></a>
353+
### x-api-key
344354

345355
- **Type**: API key
346356
- **API key parameter name**: x-api-key
347357
- **Location**: HTTP header
348358

349-
<a id="app-key"></a>
350-
### app-key
359+
<a id="x-app-key"></a>
360+
### x-app-key
351361

352362
- **Type**: API key
353363
- **API key parameter name**: x-app-key

‎test/test_secure_embedded_premium_finance_api.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def test_secure_epf_quotes_generate_post(self) -> None:
6565
"insured": {
6666
"uniqueId": self.app_key,
6767
"agentCustomerNumber": "Suyash",
68-
"email": "dylan.smith@fmkagency.com",
68+
"email": "test@test.com",
6969
"careOf": "Test",
7070
"address": {
7171
"name": "Sam",
@@ -79,7 +79,7 @@ def test_secure_epf_quotes_generate_post(self) -> None:
7979
},
8080
"agent": {
8181
"uniqueID": self.app_key,
82-
"email": "dylan.smith@fmkagency.com",
82+
"email": "test@test.com",
8383
"address": {
8484
"name": "Insurance Agency",
8585
"address1": "PO Box 486",
@@ -214,7 +214,7 @@ def test_secure_update_policy_endorsement_post(self) -> None:
214214
],
215215
"insured": {
216216
"AgentCustomerNumber": "Suyash",
217-
"Email": "dylan.smith@fmkagency.com",
217+
"Email": "test@test.com",
218218
"CareOf": "",
219219
"Address": {
220220
"Name": "Sam",

0 commit comments

Comments
 (0)