citypay_api_client 1.0.2 → 1.1.1

data/docs/DirectPostApi.md

@@ -0,0 +1,365 @@
+# CityPayApiClient::DirectPostApi
+
+All URIs are relative to *https://api.citypay.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**direct_c_res_auth_request**](DirectPostApi.md#direct_c_res_auth_request) | **POST** /direct/cres/auth/{uuid} | Handles a CRes response from ACS, returning back the result of authorisation |
+| [**direct_c_res_tokenise_request**](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 |
+| [**direct_post_auth_request**](DirectPostApi.md#direct_post_auth_request) | **POST** /direct/auth | Direct Post Auth Request |
+| [**direct_post_tokenise_request**](DirectPostApi.md#direct_post_tokenise_request) | **POST** /direct/tokenise | Direct Post Tokenise Request |
+| [**token_request**](DirectPostApi.md#token_request) | **POST** /direct/token | Direct Post Token Request |
+
+
+## direct_c_res_auth_request
+
+> <AuthResponse> direct_c_res_auth_request(uuid, opts)
+
+Handles a CRes response from ACS, returning back the result of authorisation
+
+Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'citypay_api_client'
+
+api_instance = CityPayApiClient::DirectPostApi.new
+uuid = 'uuid_example' # String | An identifier used to track the CReq/CRes cycle.
+opts = {
+  cres: 'cres_example', # String | The CRES from the ACS.
+  three_ds_session_data: 'three_ds_session_data_example' # String | The session data from the ACS.
+}
+
+begin
+  # Handles a CRes response from ACS, returning back the result of authorisation
+  result = api_instance.direct_c_res_auth_request(uuid, opts)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_c_res_auth_request: #{e}"
+end
+```
+
+#### Using the direct_c_res_auth_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> direct_c_res_auth_request_with_http_info(uuid, opts)
+
+```ruby
+begin
+  # Handles a CRes response from ACS, returning back the result of authorisation
+  data, status_code, headers = api_instance.direct_c_res_auth_request_with_http_info(uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_c_res_auth_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** | An identifier used to track the CReq/CRes cycle. |  |
+| **cres** | **String** | The CRES from the ACS. | [optional] |
+| **three_ds_session_data** | **String** | The session data from the ACS. | [optional] |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json, application/xml, application/x-www-form-urlencoded
+
+
+## direct_c_res_tokenise_request
+
+> <TokenisationResponseModel> direct_c_res_tokenise_request(uuid, opts)
+
+Handles a CRes response from ACS, returning back a token for future authorisation
+
+Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid `threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'citypay_api_client'
+
+api_instance = CityPayApiClient::DirectPostApi.new
+uuid = 'uuid_example' # String | An identifier used to track the CReq/CRes cycle.
+opts = {
+  cres: 'cres_example', # String | The CRES from the ACS.
+  three_ds_session_data: 'three_ds_session_data_example' # String | The session data from the ACS.
+}
+
+begin
+  # Handles a CRes response from ACS, returning back a token for future authorisation
+  result = api_instance.direct_c_res_tokenise_request(uuid, opts)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_c_res_tokenise_request: #{e}"
+end
+```
+
+#### Using the direct_c_res_tokenise_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TokenisationResponseModel>, Integer, Hash)> direct_c_res_tokenise_request_with_http_info(uuid, opts)
+
+```ruby
+begin
+  # Handles a CRes response from ACS, returning back a token for future authorisation
+  data, status_code, headers = api_instance.direct_c_res_tokenise_request_with_http_info(uuid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TokenisationResponseModel>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_c_res_tokenise_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** | An identifier used to track the CReq/CRes cycle. |  |
+| **cres** | **String** | The CRES from the ACS. | [optional] |
+| **three_ds_session_data** | **String** | The session data from the ACS. | [optional] |
+
+### Return type
+
+[**TokenisationResponseModel**](TokenisationResponseModel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json, application/xml, application/x-www-form-urlencoded
+
+
+## direct_post_auth_request
+
+> <AuthResponse> direct_post_auth_request(direct_post_request)
+
+Direct Post Auth Request
+
+Used to initiate a direct post request transaction flow.  <pre class=\"inline-code language-bash\"> <code> curl https://api.citypay.com/direct/auth?cp-domain-key=n834ytqp84y... \\  -d \"amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW </code> </pre>. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'citypay_api_client'
+# setup authorization
+CityPayApiClient.configure do |config|
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
+
+  # Configure API key authorization: cp-domain-key
+  config.api_key['cp-domain-key'] = 'YOUR API KEY'
+end
+
+api_instance = CityPayApiClient::DirectPostApi.new
+direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
+
+begin
+  # Direct Post Auth Request
+  result = api_instance.direct_post_auth_request(direct_post_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_post_auth_request: #{e}"
+end
+```
+
+#### Using the direct_post_auth_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> direct_post_auth_request_with_http_info(direct_post_request)
+
+```ruby
+begin
+  # Direct Post Auth Request
+  data, status_code, headers = api_instance.direct_post_auth_request_with_http_info(direct_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_post_auth_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direct_post_request** | [**DirectPostRequest**](DirectPostRequest.md) |  |  |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, text/xml
+- **Accept**: application/json, application/xml, application/x-www-form-urlencoded, text/xml
+
+
+## direct_post_tokenise_request
+
+> <AuthResponse> direct_post_tokenise_request(direct_post_request)
+
+Direct Post Tokenise Request
+
+Used to initiate a direct post request transaction flow.  <pre class=\"inline-code language-bash\"> <code> curl https://api.citypay.com/v6/direct?cp-domain-key=n834ytqp84y... \\  -d \"amount=7500&identifier=example_trans&cardnumber=4000000000000002&expmonth=9&expyear=2028&bill_to_postcode=L1+7ZW </code> </pre>. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'citypay_api_client'
+# setup authorization
+CityPayApiClient.configure do |config|
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
+
+  # Configure API key authorization: cp-domain-key
+  config.api_key['cp-domain-key'] = 'YOUR API KEY'
+end
+
+api_instance = CityPayApiClient::DirectPostApi.new
+direct_post_request = CityPayApiClient::DirectPostRequest.new({amount: 3600, cardnumber: '4000 0000 0000 0002', expmonth: 9, expyear: 2025, identifier: '95b857a1-5955-4b86-963c-5a6dbfc4fb95', mac: '3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D'}) # DirectPostRequest | 
+
+begin
+  # Direct Post Tokenise Request
+  result = api_instance.direct_post_tokenise_request(direct_post_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_post_tokenise_request: #{e}"
+end
+```
+
+#### Using the direct_post_tokenise_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> direct_post_tokenise_request_with_http_info(direct_post_request)
+
+```ruby
+begin
+  # Direct Post Tokenise Request
+  data, status_code, headers = api_instance.direct_post_tokenise_request_with_http_info(direct_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->direct_post_tokenise_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direct_post_request** | [**DirectPostRequest**](DirectPostRequest.md) |  |  |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, text/xml
+- **Accept**: application/json, application/xml, application/x-www-form-urlencoded, text/xml
+
+
+## token_request
+
+> <AuthResponse> token_request(direct_token_auth_request)
+
+Direct Post Token Request
+
+Perform a request for authorisation for a previously generated token. This flow will return an authorisation response stating that the transaction was approved or declined. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'citypay_api_client'
+# setup authorization
+CityPayApiClient.configure do |config|
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
+
+  # Configure API key authorization: cp-domain-key
+  config.api_key['cp-domain-key'] = 'YOUR API KEY'
+end
+
+api_instance = CityPayApiClient::DirectPostApi.new
+direct_token_auth_request = CityPayApiClient::DirectTokenAuthRequest.new # DirectTokenAuthRequest | 
+
+begin
+  # Direct Post Token Request
+  result = api_instance.token_request(direct_token_auth_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->token_request: #{e}"
+end
+```
+
+#### Using the token_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> token_request_with_http_info(direct_token_auth_request)
+
+```ruby
+begin
+  # Direct Post Token Request
+  data, status_code, headers = api_instance.token_request_with_http_info(direct_token_auth_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling DirectPostApi->token_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direct_token_auth_request** | [**DirectTokenAuthRequest**](DirectTokenAuthRequest.md) |  |  |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key), [cp-domain-key](../README.md#cp-domain-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, text/xml
+- **Accept**: application/json, application/xml, application/x-www-form-urlencoded, text/xml
+

data/docs/DirectPostRequest.md

@@ -0,0 +1,58 @@
+# CityPayApiClient::DirectPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits.  No decimal points are to be included and no divisional characters such as 1,024.  The amount should be the total amount required for the transaction.  For example with GBP £1,021.95 the amount value is 102195.  |  |
+| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
+| **bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **cardnumber** | **String** | The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value.  The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting.  The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes.  When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.  |  |
+| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify posession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
+| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
+| **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
+| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
+| **expmonth** | **Integer** | The month of expiry of the card. The month value should be a numerical value between 1 and 12.  |  |
+| **expyear** | **Integer** | The year of expiry of the card.  |  |
+| **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
+| **mac** | **String** | A message authentication code ensures the data is authentic and that the intended amount has not been tampered with. The mac value is generated using a hash-based mac value. The following algorithm is used. - A key (k) is derived from your licence key - A value (v) is produced by concatenating the nonce, amount value and identifier, such as a purchase   with nonce `0123456789ABCDEF` an amount of £275.95 and an identifier of OD-12345678 would become   `0123456789ABCDEF27595OD-12345678` and extracting the UTF-8 byte values - The result from HMAC_SHA256(k, v) is hex-encoded (upper-case) - For instance, a licence key of `LK123456789`, a nonce of `0123456789ABCDEF`, an amount of `27595` and an identifier of `OD-12345678`  would generate a MAC of `163DBAB194D743866A9BCC7FC9C8A88FCD99C6BBBF08D619291212D1B91EE12E`.  |  |
+| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **name_on_card** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [optional] |
+| **nonce** | **String** | A random value Hex string (uppercase) which is provided to the API to perform a digest. The value will be used in any digest function.  | [optional] |
+| **redirect_failure** | **String** | The URL used to redirect back to your site when a transaction has been rejected or declined. Required if a url-encoded request.  | [optional] |
+| **redirect_success** | **String** | The URL used to redirect back to your site when a transaction has been tokenised or authorised. Required if a url-encoded request.  | [optional] |
+| **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [optional] |
+| **trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] |
+| **trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::DirectPostRequest.new(
+  amount: 3600,
+  avs_postcode_policy: null,
+  bill_to: null,
+  cardnumber: 4000 0000 0000 0002,
+  csc: 10,
+  csc_policy: null,
+  currency: GBP,
+  duplicate_policy: null,
+  expmonth: 9,
+  expyear: 2025,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  mac: 3896FBC43674AF59478DAF7F546FA4D4CB89981A936E6AAE997E43B55DF6C39D,
+  match_avsa: null,
+  name_on_card: MR NE BODY,
+  nonce: 0123456789ABCDEF,
+  redirect_failure: https://pay.mystore.com/continue_failure,
+  redirect_success: https://pay.mystore.com/continue_success,
+  ship_to: null,
+  threedsecure: null,
+  trans_info: null,
+  trans_type: null
+)
+```
+

data/docs/DirectTokenAuthRequest.md

@@ -0,0 +1,24 @@
+# CityPayApiClient::DirectTokenAuthRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nonce** | **String** | A random value string which is provided to the API to perform a digest. The value will be used by its UTF-8 byte representation of any digest function.  | [optional] |
+| **redirect_failure** | **String** | The URL used to redirect back to your site when a transaction has been rejected or declined. Required if a url-encoded request.  | [optional] |
+| **redirect_success** | **String** | The URL used to redirect back to your site when a transaction has been authorised. Required if a url-encoded request.  | [optional] |
+| **token** | **String** | The token required to process the transaction as presented by the direct post methodology.  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::DirectTokenAuthRequest.new(
+  nonce: 0123456789ABCDEF,
+  redirect_failure: https://pay.mystore.com/continue_failure,
+  redirect_success: https://pay.mystore.com/continue_success,
+  token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr
+)
+```
+

data/docs/DomainKeyCheckRequest.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::DomainKeyCheckRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_key** | **String** | The domain key to check.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::DomainKeyCheckRequest.new(
+  domain_key: 3MEcU8cEf...QMeebACxcQVejmT1Wi
+)
+```
+

data/docs/DomainKeyRequest.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::DomainKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **Array<String>** |  |  |
+| **live** | **Boolean** | Specifies if the key is to be used for production. Defaults to false.  | [optional] |
+| **merchantid** | **Integer** | The merchant id the domain key is to be used for.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::DomainKeyRequest.new(
+  domain: null,
+  live: true,
+  merchantid: 11223344
+)
+```
+

data/docs/DomainKeyResponse.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::DomainKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **Time** | The date the domain key was generated.  | [optional] |
+| **domain** | **Array<String>** |  |  |
+| **domain_key** | **String** | The domain key generated.  | [optional] |
+| **live** | **Boolean** | true if this key is a production key.  | [optional] |
+| **merchantid** | **Integer** | The merchant id the domain key is to be used for.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::DomainKeyResponse.new(
+  date_created: 2020-01-02T18:32:28Z,
+  domain: null,
+  domain_key: 3MEcU8cEf...QMeebACxcQVejmT1Wi,
+  live: true,
+  merchantid: 11223344
+)
+```
+

data/docs/Error.md

@@ -2,22 +2,25 @@
 
 ## 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] |
+| **response_dt** | **Time** | The ISO-8601 UTC date and time of the response data. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::Error.new(code: 0,
-                                 context: aspiu352908ns47n343598bads,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 message: Approved 044332)
+instance = CityPayApiClient::Error.new(
+  code: 0,
+  context: aspiu352908ns47n343598bads,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  message: Approved 044332,
+  response_dt: 2020-01-02T18:32:28Z
+)
 ```
 
-

data/docs/EventDataModel.md

@@ -0,0 +1,26 @@
+# CityPayApiClient::EventDataModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_end_date** | **Date** | The date when the event ends in ISO format (yyyy-MM-dd). | [optional] |
+| **event_id** | **String** | An id of the event. | [optional] |
+| **event_organiser_id** | **String** | An id of the event organiser. | [optional] |
+| **event_start_date** | **Date** | The date when the event starts in ISO format (yyyy-MM-dd). | [optional] |
+| **payment_type** | **String** | The type of payment such as `deposit` or `balance`. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::EventDataModel.new(
+  event_end_date: null,
+  event_id: null,
+  event_organiser_id: null,
+  event_start_date: null,
+  payment_type: null
+)
+```
+

data/docs/Exists.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::Exists
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Boolean value whether the entity is active. | [optional] |
+| **exists** | **Boolean** | Boolean value whether the entity exists. |  |
+| **last_modified** | **Time** | The last modified date of the entity. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::Exists.new(
+  active: true,
+  exists: true,
+  last_modified: 2020-01-02T18:32:28Z
+)
+```
+

data/docs/ExternalMPI.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authen_result** | **String** | The authentication result available from the MPI. | [optional] 
-**cavv** | **String** | A value determining the cardholder verification value supplied by the card scheme. | [optional] 
-**eci** | **Integer** | The obtained e-commerce indicator from the MPI. | [optional] 
-**enrolled** | **String** | A value determining whether the card holder was enrolled. | [optional] 
-**xid** | **String** | The XID used for processing with the MPI. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authen_result** | **String** | The authentication result available from the MPI. | [optional] |
+| **cavv** | **String** | A value determining the cardholder verification value supplied by the card scheme. | [optional] |
+| **eci** | **Integer** | The obtained e-commerce indicator from the MPI. | [optional] |
+| **enrolled** | **String** | A value determining whether the card holder was enrolled. | [optional] |
+| **xid** | **String** | The XID used for processing with the MPI. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::ExternalMPI.new(authen_result: null,
-                                 cavv: null,
-                                 eci: null,
-                                 enrolled: null,
-                                 xid: null)
+instance = CityPayApiClient::ExternalMPI.new(
+  authen_result: null,
+  cavv: null,
+  eci: null,
+  enrolled: null,
+  xid: null
+)
 ```
 
-