citypay_api_client 1.0.3 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 353921c25e873f2f9265c87a6d7b0090bac363c9dc95907cf78d025a2b442c7a
-  data.tar.gz: 5c1155f422d3ac0b3655596b313fca732fe21b7f66a2a72aeae420fab7b8ee8d
+  metadata.gz: ffc51d5a014c59fc14c213cd2f0340323c31e8094fc8602fc27e357675e5fe0d
+  data.tar.gz: 4584d27c08da5b4aa0742ba6177dcbaa0ff1e6822481461056aa721be5b12de0
 SHA512:
-  metadata.gz: 4b593440b4d51f98c43860f07c579d8d4524034edf993ecf2fae11189d3d3e33c74e391ed677ba486a8b794cb8cfeb663949e59dde70ea02896baa16a0b9503f
-  data.tar.gz: 5750982411b91e4c30536a34693573a26f4de9aea88e479a98cdcec63b9cbfb960e4cd3dfdb420f5e724f8f483ed0dcfcded2f8e67a588f5e836f37a100105b9
+  metadata.gz: 8d9330bc04c09a6ab2b5346db177aa58a13ec7357841fa718c4ad4df9371bf51aa730d6d064ae497e8a1e75268b3fab16bf979334589e1549ec3fcfbce8ffb4f
+  data.tar.gz: 3c9b157bd6def911f761a3964abe6ff459ab297451c9e120e3ad40ae28d519bf48af0b98a05dc92199127afcabc81e0a8ed22d6842b5718a8a360359789d557a

data/README.md

@@ -1,24 +1,22 @@
 # CityPay API Client for Ruby
 
 CityPayApiClient - the Ruby gem for the CityPay Payment API
-[![Build Status](https://travis-ci.org/citypay/citypay-api-client-ruby.svg?branch=master)](https://travis-ci.org/citypay/citypay-api-client-ruby)
+[![Ruby RSpec Tests](https://github.com/citypay/citypay-api-client-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/citypay/citypay-api-client-ruby/actions/workflows/build.yml)
 
 
-This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It
+This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It
 provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing,
 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and
-Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.
+Completion processing. The API is also capable of tokenized payments using cardholder Accounts.
 
 ## Compliance and Security
-<aside class=\"notice\">
-  Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely
-  and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including:
-</aside>
+Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by 
+Visa and MasterCard and the PCI Security Standards Council. These include
 
-* Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at
+* Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at
   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments
   as part of our compliance program.
-* The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or
+* The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or
   primary access number (PAN)
 * The application must not display the full card number on receipts, it is recommended to mask the PAN
   and show the last 4 digits. The API will return this for you for ease of receipt creation
@@ -33,10 +31,10 @@ Completion processing. The API is also capable of tokinsed payments using Card H
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 6.0.4
-- Package version: 1.0.3
+- API version: 6.6.23
+- Package version: 1.1.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [https://citypay.com/customer-centre/technical-support.html](https://citypay.com/customer-centre/technical-support.html)
+For more information, please visit [https://www.citypay.com/contacts/](https://www.citypay.com/contacts/)
 
 ## Installation
 
@@ -51,16 +49,16 @@ gem build citypay_api_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./citypay_api_client-1.0.3.gem
+gem install ./citypay_api_client-1.1.2.gem
 ```
 
-(for development, run `gem install --dev ./citypay_api_client-1.0.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./citypay_api_client-1.1.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'citypay_api_client', '~> 1.0.3'
+    gem 'citypay_api_client', '~> 1.1.2'
 
 ### Install from Git
 
@@ -89,43 +87,65 @@ CityPayApiClient.configure do |config|
   config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
 end
 
-api_instance = CityPayApiClient::CardHolderAccountApi.new
-accountid = 'accountid_example' # String | The account id that refers to the customer's account no. This value will have been provided when setting up the card holder account.
-card_id = 'card_id_example' # String | The id of the card that is presented by a call to retrieve a card holder account.
+api_instance = CityPayApiClient::AuthorisationAndPaymentApi.new
+auth_request = CityPayApiClient::AuthRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2027, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', merchantid: 11223344}) # AuthRequest | 
 
 begin
-  #Card Deletion
-  result = api_instance.account_card_delete_request(accountid, card_id)
+  #Authorisation
+  result = api_instance.authorisation_request(auth_request)
   p result
 rescue CityPayApiClient::ApiError => e
-  puts "Exception when calling CardHolderAccountApi->account_card_delete_request: #{e}"
+  puts "Exception when calling AuthorisationAndPaymentApi->authorisation_request: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.citypay.com/v6*
+All URIs are relative to *https://api.citypay.com*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CityPayApiClient::CardHolderAccountApi* | [**account_card_delete_request**](docs/CardHolderAccountApi.md#account_card_delete_request) | **DELETE** /account/{accountid}/card/{cardId} | Card Deletion
-*CityPayApiClient::CardHolderAccountApi* | [**account_card_register_request**](docs/CardHolderAccountApi.md#account_card_register_request) | **POST** /account/{accountid}/register | Card Registration
-*CityPayApiClient::CardHolderAccountApi* | [**account_card_status_request**](docs/CardHolderAccountApi.md#account_card_status_request) | **POST** /account/{accountid}/card/{cardId}/status | Card Status
-*CityPayApiClient::CardHolderAccountApi* | [**account_change_contact_request**](docs/CardHolderAccountApi.md#account_change_contact_request) | **POST** /account/{accountid}/contact | Contact Details Update
-*CityPayApiClient::CardHolderAccountApi* | [**account_create**](docs/CardHolderAccountApi.md#account_create) | **POST** /account/create | Account Create
-*CityPayApiClient::CardHolderAccountApi* | [**account_delete_request**](docs/CardHolderAccountApi.md#account_delete_request) | **DELETE** /account/{accountid} | Account Deletion
-*CityPayApiClient::CardHolderAccountApi* | [**account_retrieve_request**](docs/CardHolderAccountApi.md#account_retrieve_request) | **GET** /account/{accountid} | Account Retrieval
-*CityPayApiClient::CardHolderAccountApi* | [**account_status_request**](docs/CardHolderAccountApi.md#account_status_request) | **POST** /account/{accountid}/status | Account Status
-*CityPayApiClient::CardHolderAccountApi* | [**charge_request**](docs/CardHolderAccountApi.md#charge_request) | **POST** /charge | Charge
-*CityPayApiClient::OperationalApi* | [**list_merchants_request**](docs/OperationalApi.md#list_merchants_request) | **GET** /merchants/{clientid} | List Merchants Request
-*CityPayApiClient::OperationalApi* | [**ping_request**](docs/OperationalApi.md#ping_request) | **POST** /ping | Ping Request
-*CityPayApiClient::PaymentProcessingApi* | [**authorisation_request**](docs/PaymentProcessingApi.md#authorisation_request) | **POST** /authorise | Authorisation
-*CityPayApiClient::PaymentProcessingApi* | [**c_res_request**](docs/PaymentProcessingApi.md#c_res_request) | **POST** /cres | CRes
-*CityPayApiClient::PaymentProcessingApi* | [**capture_request**](docs/PaymentProcessingApi.md#capture_request) | **POST** /capture | Capture
-*CityPayApiClient::PaymentProcessingApi* | [**pa_res_request**](docs/PaymentProcessingApi.md#pa_res_request) | **POST** /pares | PaRes
-*CityPayApiClient::PaymentProcessingApi* | [**retrieval_request**](docs/PaymentProcessingApi.md#retrieval_request) | **POST** /retrieve | Retrieval
-*CityPayApiClient::PaymentProcessingApi* | [**void_request**](docs/PaymentProcessingApi.md#void_request) | **POST** /void | Void
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**authorisation_request**](docs/AuthorisationAndPaymentApi.md#authorisation_request) | **POST** /v6/authorise | Authorisation
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**bin_range_lookup_request**](docs/AuthorisationAndPaymentApi.md#bin_range_lookup_request) | **POST** /v6/bin | Bin Lookup
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**c_res_request**](docs/AuthorisationAndPaymentApi.md#c_res_request) | **POST** /v6/cres | CRes
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**capture_request**](docs/AuthorisationAndPaymentApi.md#capture_request) | **POST** /v6/capture | Capture
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**pa_res_request**](docs/AuthorisationAndPaymentApi.md#pa_res_request) | **POST** /v6/pares | PaRes
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**refund_request**](docs/AuthorisationAndPaymentApi.md#refund_request) | **POST** /v6/refund | Refund
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**retrieval_request**](docs/AuthorisationAndPaymentApi.md#retrieval_request) | **POST** /v6/retrieve | Retrieval
+*CityPayApiClient::AuthorisationAndPaymentApi* | [**void_request**](docs/AuthorisationAndPaymentApi.md#void_request) | **POST** /v6/void | Void
+*CityPayApiClient::BatchProcessingApi* | [**batch_process_request**](docs/BatchProcessingApi.md#batch_process_request) | **POST** /v6/batch/process | Batch Process Request
+*CityPayApiClient::BatchProcessingApi* | [**batch_retrieve_request**](docs/BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve | BatchReportRequest
+*CityPayApiClient::BatchProcessingApi* | [**check_batch_status_request**](docs/BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | CheckBatchStatus
+*CityPayApiClient::CardHolderAccountApi* | [**account_card_delete_request**](docs/CardHolderAccountApi.md#account_card_delete_request) | **DELETE** /v6/account/{accountid}/card/{cardId} | Card Deletion
+*CityPayApiClient::CardHolderAccountApi* | [**account_card_register_request**](docs/CardHolderAccountApi.md#account_card_register_request) | **POST** /v6/account/{accountid}/register | Card Registration
+*CityPayApiClient::CardHolderAccountApi* | [**account_card_status_request**](docs/CardHolderAccountApi.md#account_card_status_request) | **POST** /v6/account/{accountid}/card/{cardId}/status | Card Status
+*CityPayApiClient::CardHolderAccountApi* | [**account_change_contact_request**](docs/CardHolderAccountApi.md#account_change_contact_request) | **POST** /v6/account/{accountid}/contact | Contact Details Update
+*CityPayApiClient::CardHolderAccountApi* | [**account_create**](docs/CardHolderAccountApi.md#account_create) | **POST** /v6/account/create | Account Create
+*CityPayApiClient::CardHolderAccountApi* | [**account_delete_request**](docs/CardHolderAccountApi.md#account_delete_request) | **DELETE** /v6/account/{accountid} | Account Deletion
+*CityPayApiClient::CardHolderAccountApi* | [**account_exists_request**](docs/CardHolderAccountApi.md#account_exists_request) | **GET** /v6/account-exists/{accountid} | Account Exists
+*CityPayApiClient::CardHolderAccountApi* | [**account_retrieve_request**](docs/CardHolderAccountApi.md#account_retrieve_request) | **GET** /v6/account/{accountid} | Account Retrieval
+*CityPayApiClient::CardHolderAccountApi* | [**account_status_request**](docs/CardHolderAccountApi.md#account_status_request) | **POST** /v6/account/{accountid}/status | Account Status
+*CityPayApiClient::CardHolderAccountApi* | [**charge_request**](docs/CardHolderAccountApi.md#charge_request) | **POST** /v6/charge | Charge
+*CityPayApiClient::DirectPostApi* | [**direct_c_res_auth_request**](docs/DirectPostApi.md#direct_c_res_auth_request) | **POST** /direct/cres/auth/{uuid} | Handles a CRes response from ACS, returning back the result of authorisation
+*CityPayApiClient::DirectPostApi* | [**direct_c_res_tokenise_request**](docs/DirectPostApi.md#direct_c_res_tokenise_request) | **POST** /direct/cres/tokenise/{uuid} | Handles a CRes response from ACS, returning back a token for future authorisation
+*CityPayApiClient::DirectPostApi* | [**direct_post_auth_request**](docs/DirectPostApi.md#direct_post_auth_request) | **POST** /direct/auth | Direct Post Auth Request
+*CityPayApiClient::DirectPostApi* | [**direct_post_tokenise_request**](docs/DirectPostApi.md#direct_post_tokenise_request) | **POST** /direct/tokenise | Direct Post Tokenise Request
+*CityPayApiClient::DirectPostApi* | [**token_request**](docs/DirectPostApi.md#token_request) | **POST** /direct/token | Direct Post Token Request
+*CityPayApiClient::OperationalFunctionsApi* | [**acl_check_request**](docs/OperationalFunctionsApi.md#acl_check_request) | **POST** /v6/acl/check | ACL Check Request
+*CityPayApiClient::OperationalFunctionsApi* | [**domain_key_check_request**](docs/OperationalFunctionsApi.md#domain_key_check_request) | **POST** /dk/check | Domain Key Check Request
+*CityPayApiClient::OperationalFunctionsApi* | [**domain_key_gen_request**](docs/OperationalFunctionsApi.md#domain_key_gen_request) | **POST** /dk/gen | Domain Key Generation Request
+*CityPayApiClient::OperationalFunctionsApi* | [**list_merchants_request**](docs/OperationalFunctionsApi.md#list_merchants_request) | **GET** /v6/merchants/{clientid} | List Merchants Request
+*CityPayApiClient::OperationalFunctionsApi* | [**ping_request**](docs/OperationalFunctionsApi.md#ping_request) | **POST** /v6/ping | Ping Request
+*CityPayApiClient::PaylinkApi* | [**token_adjustment_request**](docs/PaylinkApi.md#token_adjustment_request) | **POST** /paylink/{token}/adjustment | Paylink Token Adjustment
+*CityPayApiClient::PaylinkApi* | [**token_changes_request**](docs/PaylinkApi.md#token_changes_request) | **POST** /paylink/token/changes | Paylink Token Audit
+*CityPayApiClient::PaylinkApi* | [**token_close_request**](docs/PaylinkApi.md#token_close_request) | **PUT** /paylink/{token}/close | Close Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_create_bill_payment_request**](docs/PaylinkApi.md#token_create_bill_payment_request) | **POST** /paylink/bill-payment | Create Bill Payment Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_create_request**](docs/PaylinkApi.md#token_create_request) | **POST** /paylink/create | Create Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_purge_attachments_request**](docs/PaylinkApi.md#token_purge_attachments_request) | **PUT** /paylink/{token}/purge-attachments | Purges any attachments for a Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_reconciled_request**](docs/PaylinkApi.md#token_reconciled_request) | **PUT** /paylink/{token}/reconciled | Reconcile Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_reopen_request**](docs/PaylinkApi.md#token_reopen_request) | **PUT** /paylink/{token}/reopen | Reopen Paylink Token
+*CityPayApiClient::PaylinkApi* | [**token_status_request**](docs/PaylinkApi.md#token_status_request) | **GET** /paylink/{token}/status | Paylink Token Status
 
 
 ## Documentation for Models
@@ -133,6 +153,8 @@ Class | Method | HTTP request | Description
  - [CityPayApiClient::AccountCreate](docs/AccountCreate.md)
  - [CityPayApiClient::AccountStatus](docs/AccountStatus.md)
  - [CityPayApiClient::Acknowledgement](docs/Acknowledgement.md)
+ - [CityPayApiClient::AclCheckRequest](docs/AclCheckRequest.md)
+ - [CityPayApiClient::AclCheckResponseModel](docs/AclCheckResponseModel.md)
  - [CityPayApiClient::AirlineAdvice](docs/AirlineAdvice.md)
  - [CityPayApiClient::AirlineSegment](docs/AirlineSegment.md)
  - [CityPayApiClient::AuthReference](docs/AuthReference.md)
@@ -140,31 +162,74 @@ Class | Method | HTTP request | Description
  - [CityPayApiClient::AuthRequest](docs/AuthRequest.md)
  - [CityPayApiClient::AuthResponse](docs/AuthResponse.md)
  - [CityPayApiClient::AuthenRequired](docs/AuthenRequired.md)
+ - [CityPayApiClient::Batch](docs/Batch.md)
+ - [CityPayApiClient::BatchReportRequest](docs/BatchReportRequest.md)
+ - [CityPayApiClient::BatchReportResponseModel](docs/BatchReportResponseModel.md)
+ - [CityPayApiClient::BatchTransaction](docs/BatchTransaction.md)
+ - [CityPayApiClient::BatchTransactionResultModel](docs/BatchTransactionResultModel.md)
+ - [CityPayApiClient::Bin](docs/Bin.md)
+ - [CityPayApiClient::BinLookup](docs/BinLookup.md)
  - [CityPayApiClient::CResAuthRequest](docs/CResAuthRequest.md)
  - [CityPayApiClient::CaptureRequest](docs/CaptureRequest.md)
  - [CityPayApiClient::Card](docs/Card.md)
  - [CityPayApiClient::CardHolderAccount](docs/CardHolderAccount.md)
  - [CityPayApiClient::CardStatus](docs/CardStatus.md)
  - [CityPayApiClient::ChargeRequest](docs/ChargeRequest.md)
+ - [CityPayApiClient::CheckBatchStatus](docs/CheckBatchStatus.md)
+ - [CityPayApiClient::CheckBatchStatusResponse](docs/CheckBatchStatusResponse.md)
  - [CityPayApiClient::ContactDetails](docs/ContactDetails.md)
  - [CityPayApiClient::Decision](docs/Decision.md)
+ - [CityPayApiClient::DirectPostRequest](docs/DirectPostRequest.md)
+ - [CityPayApiClient::DirectTokenAuthRequest](docs/DirectTokenAuthRequest.md)
+ - [CityPayApiClient::DomainKeyCheckRequest](docs/DomainKeyCheckRequest.md)
+ - [CityPayApiClient::DomainKeyRequest](docs/DomainKeyRequest.md)
+ - [CityPayApiClient::DomainKeyResponse](docs/DomainKeyResponse.md)
  - [CityPayApiClient::Error](docs/Error.md)
+ - [CityPayApiClient::EventDataModel](docs/EventDataModel.md)
+ - [CityPayApiClient::Exists](docs/Exists.md)
  - [CityPayApiClient::ExternalMPI](docs/ExternalMPI.md)
  - [CityPayApiClient::ListMerchantsResponse](docs/ListMerchantsResponse.md)
  - [CityPayApiClient::MCC6012](docs/MCC6012.md)
  - [CityPayApiClient::Merchant](docs/Merchant.md)
  - [CityPayApiClient::PaResAuthRequest](docs/PaResAuthRequest.md)
+ - [CityPayApiClient::PaylinkAddress](docs/PaylinkAddress.md)
+ - [CityPayApiClient::PaylinkAdjustmentRequest](docs/PaylinkAdjustmentRequest.md)
+ - [CityPayApiClient::PaylinkAttachmentRequest](docs/PaylinkAttachmentRequest.md)
+ - [CityPayApiClient::PaylinkAttachmentResult](docs/PaylinkAttachmentResult.md)
+ - [CityPayApiClient::PaylinkBillPaymentTokenRequest](docs/PaylinkBillPaymentTokenRequest.md)
+ - [CityPayApiClient::PaylinkCardHolder](docs/PaylinkCardHolder.md)
+ - [CityPayApiClient::PaylinkCart](docs/PaylinkCart.md)
+ - [CityPayApiClient::PaylinkCartItemModel](docs/PaylinkCartItemModel.md)
+ - [CityPayApiClient::PaylinkConfig](docs/PaylinkConfig.md)
+ - [CityPayApiClient::PaylinkCustomParam](docs/PaylinkCustomParam.md)
+ - [CityPayApiClient::PaylinkEmailNotificationPath](docs/PaylinkEmailNotificationPath.md)
+ - [CityPayApiClient::PaylinkErrorCode](docs/PaylinkErrorCode.md)
+ - [CityPayApiClient::PaylinkFieldGuardModel](docs/PaylinkFieldGuardModel.md)
+ - [CityPayApiClient::PaylinkPartPayments](docs/PaylinkPartPayments.md)
+ - [CityPayApiClient::PaylinkSMSNotificationPath](docs/PaylinkSMSNotificationPath.md)
+ - [CityPayApiClient::PaylinkStateEvent](docs/PaylinkStateEvent.md)
+ - [CityPayApiClient::PaylinkTokenCreated](docs/PaylinkTokenCreated.md)
+ - [CityPayApiClient::PaylinkTokenRequestModel](docs/PaylinkTokenRequestModel.md)
+ - [CityPayApiClient::PaylinkTokenStatus](docs/PaylinkTokenStatus.md)
+ - [CityPayApiClient::PaylinkTokenStatusChangeRequest](docs/PaylinkTokenStatusChangeRequest.md)
+ - [CityPayApiClient::PaylinkTokenStatusChangeResponse](docs/PaylinkTokenStatusChangeResponse.md)
+ - [CityPayApiClient::PaylinkUI](docs/PaylinkUI.md)
  - [CityPayApiClient::Ping](docs/Ping.md)
+ - [CityPayApiClient::ProcessBatchRequest](docs/ProcessBatchRequest.md)
+ - [CityPayApiClient::ProcessBatchResponse](docs/ProcessBatchResponse.md)
+ - [CityPayApiClient::RefundRequest](docs/RefundRequest.md)
  - [CityPayApiClient::RegisterCard](docs/RegisterCard.md)
  - [CityPayApiClient::RequestChallenged](docs/RequestChallenged.md)
  - [CityPayApiClient::RetrieveRequest](docs/RetrieveRequest.md)
  - [CityPayApiClient::ThreeDSecure](docs/ThreeDSecure.md)
+ - [CityPayApiClient::TokenisationResponseModel](docs/TokenisationResponseModel.md)
  - [CityPayApiClient::VoidRequest](docs/VoidRequest.md)
 
 
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### cp-api-key
 
 
@@ -172,3 +237,10 @@ Class | Method | HTTP request | Description
 - **API key parameter name**: cp-api-key
 - **Location**: HTTP header
 
+### cp-domain-key
+
+
+- **Type**: API key
+- **API key parameter name**: cp-domain-key
+- **Location**: URL query string
+

data/citypay_api_client.gemspec

@@ -3,11 +3,11 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+# This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts.  ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by  Visa and MasterCard and the PCI Security Standards Council. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
 
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -23,11 +23,11 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/citypay/citypay-api-client-ruby"
   s.summary     = "A ruby wrapper for the CityPay API"
   s.description = "CityPay API Client for Ruby"
-  s.license     = "MIT"
-  s.required_ruby_version = ">= 1.9"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
 

data/docs/AccountCreate.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** | A card holder account id used for uniquely identifying the account. This value will be used for future referencing of the account oand to link your system to this API. This value is immutable and never changes.  | 
-**contact** | [**ContactDetails**](ContactDetails.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | A card holder account id used for uniquely identifying the account. This value will be used for future referencing of the account oand to link your system to this API. This value is immutable and never changes.  |  |
+| **contact** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AccountCreate.new(account_id: aaabbb-cccddd-eee,
-                                 contact: null)
+instance = CityPayApiClient::AccountCreate.new(
+  account_id: aaabbb-cccddd-eee,
+  contact: null
+)
 ```
 
-

data/docs/AccountStatus.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** | The status of the account to set, valid values are ACTIVE or DISABLED. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The status of the account to set, valid values are ACTIVE or DISABLED. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AccountStatus.new(status: null)
+instance = CityPayApiClient::AccountStatus.new(
+  status: null
+)
 ```
 
-

data/docs/Acknowledgement.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** | A response code providing a result of the process. | [optional] 
-**context** | **String** | A context id of the process used for referencing transactions through support. | [optional] 
-**identifier** | **String** | An identifier if presented in the original request. | [optional] 
-**message** | **String** | A response message providing a description of the result of the process. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | A response code providing a result of the process. | [optional] |
+| **context** | **String** | A context id of the process used for referencing transactions through support. | [optional] |
+| **identifier** | **String** | An identifier if presented in the original request. | [optional] |
+| **message** | **String** | A response message providing a description of the result of the process. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::Acknowledgement.new(code: 0,
-                                 context: aspiu352908ns47n343598bads,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 message: Approved 044332)
+instance = CityPayApiClient::Acknowledgement.new(
+  code: 0,
+  context: aspiu352908ns47n343598bads,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  message: Approved 044332
+)
 ```
 
-

data/docs/AclCheckRequest.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::AclCheckRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** | An ip address to check for an ACL against. The address should be a publicly routable IPv4 address. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::AclCheckRequest.new(
+  ip: 8.8.8.8
+)
+```
+

data/docs/AclCheckResponseModel.md

@@ -0,0 +1,24 @@
+# CityPayApiClient::AclCheckResponseModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acl** | **String** | The name or value of the acl which was found to match the ip address. | [optional] |
+| **cache** | **Boolean** | Whether the ACL was returned via a cached instance. | [optional] |
+| **ip** | **String** | The IP address used in the lookup. | [optional] |
+| **provider** | **String** | The source provider of the ACL. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::AclCheckResponseModel.new(
+  acl: null,
+  cache: null,
+  ip: 8.8.8.8,
+  provider: null
+)
+```
+

data/docs/AirlineAdvice.md

@@ -2,46 +2,47 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**carrier_name** | **String** | The name of the airline carrier that generated the tickets for airline travel. | 
-**conjunction_ticket_indicator** | **Boolean** | true if a conjunction ticket (with additional coupons) was issued for an itinerary with more than four segments. Defaults to false.  | [optional] 
-**eticket_indicator** | **Boolean** | The Electronic Ticket Indicator, a code that indicates if an electronic ticket was issued.  Defaults to true. | [optional] 
-**no_air_segments** | **Integer** | A value that indicates the number of air travel segments included on this ticket. Valid entries include the numerals “0” through “4”. Required only if the transaction type is TKT or EXC.  | [optional] 
-**number_in_party** | **Integer** | The number of people in the party. | 
-**original_ticket_no** | **String** | Required if transaction type is EXC. | [optional] 
-**passenger_name** | **String** | The name of the passenger when the traveller is not the card member that purchased the ticket. Required only if the transaction type is TKT or EXC. | [optional] 
-**segment1** | [**AirlineSegment**](AirlineSegment.md) |  | 
-**segment2** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] 
-**segment3** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] 
-**segment4** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] 
-**ticket_issue_city** | **String** | The name of the city town or village where the transaction took place. | 
-**ticket_issue_date** | **Date** | The date the ticket was issued in ISO Date format (yyyy-MM-dd). | 
-**ticket_issue_name** | **String** | The name of the agency generating the ticket. | 
-**ticket_no** | **String** | This must be a valid ticket number, i.e. numeric (the first 3 digits must represent the valid IATA plate carrier code). The final check digit should be validated prior to submission. On credit charges, this field should contain the number of the original ticket, and not of a replacement.  | 
-**transaction_type** | **String** | This field contains the Transaction Type code assigned to this transaction. Valid codes include:   - `TKT` = Ticket Purchase  - `REF` = Refund  - `EXC` = Exchange Ticket  - `MSC` = Miscellaneous (non-Ticket Purchase- and non-Exchange Ticket-related transactions only).  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **carrier_name** | **String** | The name of the airline carrier that generated the tickets for airline travel. |  |
+| **conjunction_ticket_indicator** | **Boolean** | true if a conjunction ticket (with additional coupons) was issued for an itinerary with more than four segments. Defaults to false.  | [optional] |
+| **eticket_indicator** | **Boolean** | The Electronic Ticket Indicator, a code that indicates if an electronic ticket was issued.  Defaults to true. | [optional] |
+| **no_air_segments** | **Integer** | A value that indicates the number of air travel segments included on this ticket.  Valid entries include the numerals “0” through “4”. Required only if the transaction type is TKT or EXC.  | [optional] |
+| **number_in_party** | **Integer** | The number of people in the party. | [optional] |
+| **original_ticket_no** | **String** | Required if transaction type is EXC. | [optional] |
+| **passenger_name** | **String** | The name of the passenger when the traveller is not the card member that purchased the ticket. Required only if the transaction type is TKT or EXC. | [optional] |
+| **segment1** | [**AirlineSegment**](AirlineSegment.md) |  |  |
+| **segment2** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] |
+| **segment3** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] |
+| **segment4** | [**AirlineSegment**](AirlineSegment.md) |  | [optional] |
+| **ticket_issue_city** | **String** | The name of the city town or village where the transaction took place. |  |
+| **ticket_issue_date** | **Date** | The date the ticket was issued in ISO Date format (yyyy-MM-dd). |  |
+| **ticket_issue_name** | **String** | The name of the agency generating the ticket. |  |
+| **ticket_no** | **String** | This must be a valid ticket number, i.e. numeric (the first 3 digits must represent the valid IATA plate carrier code). The final check digit should be validated prior to submission. On credit charges, this field should contain the number of the original ticket, and not of a replacement.  |  |
+| **transaction_type** | **String** | This field contains the Transaction Type code assigned to this transaction. Valid codes include:   - `TKT` = Ticket Purchase   - `REF` = Refund   - `EXC` = Exchange Ticket   - `MSC` = Miscellaneous (non-Ticket Purchase- and non-Exchange Ticket-related transactions only).  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AirlineAdvice.new(carrier_name: EG Air,
-                                 conjunction_ticket_indicator: false,
-                                 eticket_indicator: true,
-                                 no_air_segments: 2,
-                                 number_in_party: 2,
-                                 original_ticket_no: null,
-                                 passenger_name: NE Person,
-                                 segment1: null,
-                                 segment2: null,
-                                 segment3: null,
-                                 segment4: null,
-                                 ticket_issue_city: London,
-                                 ticket_issue_date: Sat Aug 01 00:00:00 GMT 2020,
-                                 ticket_issue_name: Issue Name,
-                                 ticket_no: A112233,
-                                 transaction_type: TKT)
+instance = CityPayApiClient::AirlineAdvice.new(
+  carrier_name: EG Air,
+  conjunction_ticket_indicator: false,
+  eticket_indicator: true,
+  no_air_segments: 2,
+  number_in_party: 2,
+  original_ticket_no: null,
+  passenger_name: NE Person,
+  segment1: null,
+  segment2: null,
+  segment3: null,
+  segment4: null,
+  ticket_issue_city: London,
+  ticket_issue_date: Sat Aug 01 00:00:00 UTC 2020,
+  ticket_issue_name: Issue Name,
+  ticket_no: A112233,
+  transaction_type: TKT
+)
 ```
 
-

data/docs/AirlineSegment.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**arrival_location_code** | **String** | A standard airline routing code (airport code or location identifier) applicable to the arrival portion of this segment.  | 
-**carrier_code** | **String** | This field contains the two character airline designator code (air carrier code or airline code) that corresponds to the airline carrier applicable for up to four flight segments of this trip itinerary.  | 
-**class_service_code** | **String** | This field contains a code that corresponds to the fare class (A, B, C, D, Premium, Discounted, etc.) within the overall class of service (e.g., First Class, Business, Economy) applicable to this travel segment, as specified in the IATA Standard Code allocation table.  | 
-**departure_date** | **Date** | The Departure Date for the travel segment in ISO Date Format (yyyy-MM-dd). | 
-**departure_location_code** | **String** | A standard airline routing code (airport code or location identifier) applicable to the departure portion of this segment.  | [optional] 
-**flight_number** | **String** | This field contains the carrier-assigned Flight Number for this travel segment. | 
-**segment_fare** | **Integer** | This field contains the total Fare for this travel segment. | [optional] 
-**stop_over_indicator** | **String** | O = Stopover allowed, X = Stopover not allowed. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **arrival_location_code** | **String** | A standard airline routing code (airport code or location identifier) applicable to the arrival portion of this segment.  |  |
+| **carrier_code** | **String** | This field contains the two character airline designator code (air carrier code or airline code) that corresponds to the airline carrier applicable for up to four flight segments of this trip itinerary.  |  |
+| **class_service_code** | **String** | This field contains a code that corresponds to the fare class (A, B, C, D, Premium, Discounted, etc.) within the overall class of service (e.g., First Class, Business, Economy) applicable to this travel segment, as specified in the IATA Standard Code allocation table.  |  |
+| **departure_date** | **Date** | The Departure Date for the travel segment in ISO Date Format (yyyy-MM-dd). |  |
+| **departure_location_code** | **String** | A standard airline routing code (airport code or location identifier) applicable to the departure portion of this segment.  | [optional] |
+| **flight_number** | **String** | This field contains the carrier-assigned Flight Number for this travel segment. |  |
+| **segment_fare** | **Integer** | This field contains the total Fare for this travel segment. | [optional] |
+| **stop_over_indicator** | **String** | O = Stopover allowed, X = Stopover not allowed. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AirlineSegment.new(arrival_location_code: SOU,
-                                 carrier_code: ZZ,
-                                 class_service_code: CC,
-                                 departure_date: Sat Aug 01 00:00:00 GMT 2020,
-                                 departure_location_code: JER,
-                                 flight_number: 772,
-                                 segment_fare: 7500,
-                                 stop_over_indicator: 1)
+instance = CityPayApiClient::AirlineSegment.new(
+  arrival_location_code: SOU,
+  carrier_code: ZZ,
+  class_service_code: CC,
+  departure_date: Sat Aug 01 00:00:00 UTC 2020,
+  departure_location_code: JER,
+  flight_number: 772,
+  segment_fare: 7500,
+  stop_over_indicator: 1
+)
 ```
 
-