citypay_api_client 1.0.3 → 1.1.2

data/docs/Batch.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::Batch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_date** | **Date** | The date that the file was created in ISO-8601 format. |  |
+| **batch_id** | **Integer** | The batch id requested. | [optional] |
+| **batch_status** | **String** | The status of the batch. Possible values are - CANCELLED. The file has been cancelled by an administrator or server process.  - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::Batch.new(
+  batch_date: Thu Jan 02 00:00:00 UTC 2020,
+  batch_id: 35,
+  batch_status: COMPLETE
+)
+```
+

data/docs/BatchProcessingApi.md

@@ -0,0 +1,218 @@
+# CityPayApiClient::BatchProcessingApi
+
+All URIs are relative to *https://api.citypay.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**batch_process_request**](BatchProcessingApi.md#batch_process_request) | **POST** /v6/batch/process | Batch Process Request |
+| [**batch_retrieve_request**](BatchProcessingApi.md#batch_retrieve_request) | **POST** /v6/batch/retrieve | BatchReportRequest |
+| [**check_batch_status_request**](BatchProcessingApi.md#check_batch_status_request) | **POST** /v6/batch/status | CheckBatchStatus |
+
+
+## batch_process_request
+
+> <ProcessBatchResponse> batch_process_request(process_batch_request)
+
+Batch Process Request
+
+A batch process request is used to start the batch process workflow by uploading batch
+data and initialising a new batch for processing. Once validated the batch will be queued
+for processing and further updates can be received by a subsequent call to retrieve the batch
+status.
+
+
+### 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
+end
+
+api_instance = CityPayApiClient::BatchProcessingApi.new
+process_batch_request = CityPayApiClient::ProcessBatchRequest.new({batch_date: Date.parse('Thu Jan 02 00:00:00 UTC 2020'), batch_id: 35, transactions: [CityPayApiClient::BatchTransaction.new({account_id: 'aaabbb-cccddd-eee', amount: 3600})]}) # ProcessBatchRequest | 
+
+begin
+  # Batch Process Request
+  result = api_instance.batch_process_request(process_batch_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling BatchProcessingApi->batch_process_request: #{e}"
+end
+```
+
+#### Using the batch_process_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProcessBatchResponse>, Integer, Hash)> batch_process_request_with_http_info(process_batch_request)
+
+```ruby
+begin
+  # Batch Process Request
+  data, status_code, headers = api_instance.batch_process_request_with_http_info(process_batch_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProcessBatchResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling BatchProcessingApi->batch_process_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **process_batch_request** | [**ProcessBatchRequest**](ProcessBatchRequest.md) |  |  |
+
+### Return type
+
+[**ProcessBatchResponse**](ProcessBatchResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## batch_retrieve_request
+
+> <BatchReportResponseModel> batch_retrieve_request(batch_report_request)
+
+BatchReportRequest
+
+The report for a given batch.
+
+### 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
+end
+
+api_instance = CityPayApiClient::BatchProcessingApi.new
+batch_report_request = CityPayApiClient::BatchReportRequest.new({batch_id: 35}) # BatchReportRequest | 
+
+begin
+  # BatchReportRequest
+  result = api_instance.batch_retrieve_request(batch_report_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling BatchProcessingApi->batch_retrieve_request: #{e}"
+end
+```
+
+#### Using the batch_retrieve_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BatchReportResponseModel>, Integer, Hash)> batch_retrieve_request_with_http_info(batch_report_request)
+
+```ruby
+begin
+  # BatchReportRequest
+  data, status_code, headers = api_instance.batch_retrieve_request_with_http_info(batch_report_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BatchReportResponseModel>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling BatchProcessingApi->batch_retrieve_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_report_request** | [**BatchReportRequest**](BatchReportRequest.md) |  |  |
+
+### Return type
+
+[**BatchReportResponseModel**](BatchReportResponseModel.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## check_batch_status_request
+
+> <CheckBatchStatusResponse> check_batch_status_request(check_batch_status)
+
+CheckBatchStatus
+
+The operation is used to retrieve the status of a batch process.
+
+### 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
+end
+
+api_instance = CityPayApiClient::BatchProcessingApi.new
+check_batch_status = CityPayApiClient::CheckBatchStatus.new({batch_id: [78]}) # CheckBatchStatus | 
+
+begin
+  # CheckBatchStatus
+  result = api_instance.check_batch_status_request(check_batch_status)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling BatchProcessingApi->check_batch_status_request: #{e}"
+end
+```
+
+#### Using the check_batch_status_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckBatchStatusResponse>, Integer, Hash)> check_batch_status_request_with_http_info(check_batch_status)
+
+```ruby
+begin
+  # CheckBatchStatus
+  data, status_code, headers = api_instance.check_batch_status_request_with_http_info(check_batch_status)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckBatchStatusResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling BatchProcessingApi->check_batch_status_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_batch_status** | [**CheckBatchStatus**](CheckBatchStatus.md) |  |  |
+
+### Return type
+
+[**CheckBatchStatusResponse**](CheckBatchStatusResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+

data/docs/BatchReportRequest.md

@@ -0,0 +1,20 @@
+# CityPayApiClient::BatchReportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_id** | **Integer** | The batch id specified in the batch processing request. |  |
+| **client_account_id** | **String** | The batch account id that the batch was processed for. Defaults to your client id if not provided. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::BatchReportRequest.new(
+  batch_id: 35,
+  client_account_id: AC1
+)
+```
+

data/docs/BatchReportResponseModel.md

@@ -0,0 +1,28 @@
+# CityPayApiClient::BatchReportResponseModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The total amount that the batch contains. |  |
+| **batch_date** | **Date** | The date and time of the batch in ISO-8601 format. |  |
+| **batch_id** | **Integer** | The batch id specified in the batch processing request. |  |
+| **batch_status** | **String** | The status of the batch. Possible values are - CANCELLED. The file has been cancelled by an administrator or server process.  - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.  |  |
+| **client_account_id** | **String** | The batch account id that the batch was processed with. |  |
+| **transactions** | [**Array<BatchTransactionResultModel>**](BatchTransactionResultModel.md) |  |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::BatchReportResponseModel.new(
+  amount: 3600,
+  batch_date: Thu Jan 02 00:00:00 UTC 2020,
+  batch_id: 35,
+  batch_status: COMPLETE,
+  client_account_id: AC1,
+  transactions: null
+)
+```
+

data/docs/BatchTransaction.md

@@ -0,0 +1,24 @@
+# CityPayApiClient::BatchTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The card holder account id to process against. |  |
+| **amount** | **Integer** | The amount required to process in the lowest denomination. |  |
+| **identifier** | **String** | An identifier used to reference the transaction set by your integration. The value should be used to refer to the transaction in future calls. | [optional] |
+| **merchantid** | **Integer** | The CityPay merchant id used to process the transaction. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::BatchTransaction.new(
+  account_id: aaabbb-cccddd-eee,
+  amount: 3600,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  merchantid: 11223344
+)
+```
+

data/docs/BatchTransactionResultModel.md

@@ -0,0 +1,44 @@
+# CityPayApiClient::BatchTransactionResultModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The card holder account id used for the transaction. |  |
+| **amount** | **Integer** | The amount of the transaction processed. | [optional] |
+| **authcode** | **String** | The authorisation code of a successful transaction. | [optional] |
+| **datetime** | **Time** | The datetime that the transaction was processed. | [optional] |
+| **identifier** | **String** | The identifier of the transaction. |  |
+| **maskedpan** | **String** | A masked value of the card number used for processing displaying limited values that can be used on a receipt.  | [optional] |
+| **merchantid** | **Integer** | The merchant id of the transaction. |  |
+| **message** | **String** | A response message pertaining to the transaction. |  |
+| **result** | **Integer** | An integer result that indicates the outcome of the transaction. The Code value below maps to the result value  <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>  |  |
+| **result_code** | **String** | A result code of the transaction identifying the result of the transaction for success, rejection or decline. |  |
+| **scheme** | **String** | The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme_id** | **String** | The name of the card scheme of the transaction such as VI or MC.  | [optional] |
+| **scheme_logo** | **String** | A url containing a logo of the card scheme.  | [optional] |
+| **transno** | **Integer** | The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.  | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::BatchTransactionResultModel.new(
+  account_id: aaabbb-cccddd-eee,
+  amount: 3600,
+  authcode: 001245A,
+  datetime: 2020-01-02T18:32:28Z,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  maskedpan: 4***********0002,
+  merchantid: 11223344,
+  message: Approved 044332,
+  result: 1,
+  result_code: 0,
+  scheme: Visa,
+  scheme_id: MC,
+  scheme_logo: https://cdn.citypay.com/img/cs/visa-logo.svg,
+  transno: 78416
+)
+```
+

data/docs/Bin.md

@@ -0,0 +1,34 @@
+# CityPayApiClient::Bin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bin_commercial** | **Boolean** | Defines whether the card is a commercial card. | [optional] |
+| **bin_corporate** | **Boolean** | Defines whether the card is a corporate business card. | [optional] |
+| **bin_country_issued** | **String** | The determined country where the card was issued. | [optional] |
+| **bin_credit** | **Boolean** | Defines whether the card is a credit card. | [optional] |
+| **bin_currency** | **String** | The default currency determined for the card. | [optional] |
+| **bin_debit** | **Boolean** | Defines whether the card is a debit card. | [optional] |
+| **bin_description** | **String** | A description of the bin on the card to identify what type of product the card is. | [optional] |
+| **bin_eu** | **Boolean** | Defines whether the card is regulated within the EU. | [optional] |
+| **scheme** | **String** | The scheme that issued the card. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::Bin.new(
+  bin_commercial: null,
+  bin_corporate: null,
+  bin_country_issued: null,
+  bin_credit: null,
+  bin_currency: null,
+  bin_debit: null,
+  bin_description: Platinum Card,
+  bin_eu: null,
+  scheme: Visa
+)
+```
+

data/docs/BinLookup.md

@@ -0,0 +1,18 @@
+# CityPayApiClient::BinLookup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bin** | **Integer** | A bin value to use for lookup. |  |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::BinLookup.new(
+  bin: 543712
+)
+```
+

data/docs/CResAuthRequest.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cres** | **String** | The challenge response data forwarded by the ACS in 3D-Secure V2 processing. Data should be forwarded to CityPay unchanged for subsequent authorisation and processing.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cres** | **String** | The challenge response data forwarded by the ACS in 3D-Secure V2 processing. Data should be forwarded to CityPay unchanged for subsequent authorisation and processing.  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::CResAuthRequest.new(cres: x90+vZ/7Ll05Vid/jPfQn8adw+4D/vRDUGT19kndW97Hfirbv66ycfSp8jNlvy7PkHbx44NEt3vo...)
+instance = CityPayApiClient::CResAuthRequest.new(
+  cres: x90+vZ/7Ll05Vid/jPfQn8adw+4D/vRDUGT19kndW97Hfirbv66ycfSp8jNlvy7PkHbx44NEt3vo...
+)
 ```
 
-

data/docs/CaptureRequest.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**airline_data** | [**AirlineAdvice**](AirlineAdvice.md) |  | [optional] 
-**amount** | **Integer** | The completion amount provided in the lowest unit of currency for the specific currency of the merchant, with a variable length to a maximum of 12 digits. No decimal points to be included. For example with GBP 75.45 use the value 7545. Please check that you do not supply divisional characters such as 1,024 in the request which may be caused by some number formatters. If no amount is supplied, the original processing amount is used.  | [optional] 
-**identifier** | **String** | The identifier of the transaction to capture. If an empty value is supplied then a `trans_no` value must be supplied. | [optional] 
-**merchantid** | **Integer** | Identifies the merchant account to perform the capture for. | 
-**sdk** | **String** | An optional reference value for the calling client such as a version number i.e. | [optional] 
-**transno** | **Integer** | The transaction number of the transaction to look up and capture. If an empty value is supplied then an identifier value must be supplied. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **airline_data** | [**AirlineAdvice**](AirlineAdvice.md) |  | [optional] |
+| **amount** | **Integer** | The completion amount provided in the lowest unit of currency for the specific currency of the merchant, with a variable length to a maximum of 12 digits. No decimal points to be included. For example with GBP 75.45 use the value 7545. Please check that you do not supply divisional characters such as 1,024 in the request which may be caused by some number formatters.  If no amount is supplied, the original processing amount is used.  | [optional] |
+| **event_management** | [**EventDataModel**](EventDataModel.md) |  | [optional] |
+| **identifier** | **String** | The identifier of the transaction to capture. If an empty value is supplied then a `trans_no` value must be supplied. | [optional] |
+| **merchantid** | **Integer** | Identifies the merchant account to perform the capture for. |  |
+| **transno** | **Integer** | The transaction number of the transaction to look up and capture. If an empty value is supplied then an identifier value must be supplied. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::CaptureRequest.new(airline_data: null,
-                                 amount: 3600,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 merchantid: 11223344,
-                                 sdk: MyClient 1.3.0,
-                                 transno: 78416)
+instance = CityPayApiClient::CaptureRequest.new(
+  airline_data: null,
+  amount: 3600,
+  event_management: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  merchantid: 11223344,
+  transno: 78416
+)
 ```
 
-

data/docs/Card.md

@@ -2,50 +2,55 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bin_commercial** | **Boolean** | Defines whether the card is a commercial card. | [optional] 
-**bin_corporate** | **Boolean** | Defines whether the card is a corporate business card. | [optional] 
-**bin_country_issued** | **String** | The determined country where the card was issued. | [optional] 
-**bin_credit** | **Boolean** | Defines whether the card is a credit card. | [optional] 
-**bin_currency** | **String** | The default currency determined for the card. | [optional] 
-**bin_debit** | **Boolean** | Defines whether the card is a debit card. | [optional] 
-**bin_description** | **String** | A description of the bin on the card to identify what type of product the card is. | [optional] 
-**bin_eu** | **Boolean** | Defines whether the card is regulated within the EU. | [optional] 
-**card_id** | **String** | The id of the card that is returned. Should be used for referencing the card when perform any changes. | [optional] 
-**card_status** | **String** | The status of the card such, valid values are  - ACTIVE the card is active for processing  - INACTIVE the card is not active for processing  - EXPIRED for cards that have passed their expiry date.  | [optional] 
-**default** | **Boolean** | Determines if the card is the default card for the account and should be regarded as the first option to be used for processing. | [optional] 
-**expmonth** | **Integer** | The expiry month of the card. | [optional] 
-**expyear** | **Integer** | The expiry year of the card. | [optional] 
-**label** | **String** | A label which identifies this card. | [optional] 
-**label2** | **String** | A label which also provides the expiry date of the card. | [optional] 
-**last4digits** | **String** | The last 4 digits of the card to aid in identification. | [optional] 
-**scheme** | **String** | The scheme that issued the card. | [optional] 
-**token** | **String** | A token that can be used to process against the card. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bin_commercial** | **Boolean** | Defines whether the card is a commercial card. | [optional] |
+| **bin_corporate** | **Boolean** | Defines whether the card is a corporate business card. | [optional] |
+| **bin_country_issued** | **String** | The determined country where the card was issued. | [optional] |
+| **bin_credit** | **Boolean** | Defines whether the card is a credit card. | [optional] |
+| **bin_currency** | **String** | The default currency determined for the card. | [optional] |
+| **bin_debit** | **Boolean** | Defines whether the card is a debit card. | [optional] |
+| **bin_description** | **String** | A description of the bin on the card to identify what type of product the card is. | [optional] |
+| **bin_eu** | **Boolean** | Defines whether the card is regulated within the EU. | [optional] |
+| **card_id** | **String** | The id of the card that is returned. Should be used for referencing the card when perform any changes. | [optional] |
+| **card_status** | **String** | The status of the card such, valid values are   - ACTIVE the card is active for processing   - INACTIVE the card is not active for processing   - EXPIRED for cards that have passed their expiry date.  | [optional] |
+| **date_created** | **Time** | The date time of when the card was created. | [optional] |
+| **default** | **Boolean** | Determines if the card is the default card for the account and should be regarded as the first option to be used for processing. | [optional] |
+| **expmonth** | **Integer** | The expiry month of the card. | [optional] |
+| **expyear** | **Integer** | The expiry year of the card. | [optional] |
+| **label** | **String** | A label which identifies this card. | [optional] |
+| **label2** | **String** | A label which also provides the expiry date of the card. | [optional] |
+| **last4digits** | **String** | The last 4 digits of the card to aid in identification. | [optional] |
+| **name_on_card** | **String** | The name on the card. | [optional] |
+| **scheme** | **String** | The scheme that issued the card. | [optional] |
+| **token** | **String** | A token that can be used to process against the card. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::Card.new(bin_commercial: null,
-                                 bin_corporate: null,
-                                 bin_country_issued: null,
-                                 bin_credit: null,
-                                 bin_currency: null,
-                                 bin_debit: null,
-                                 bin_description: null,
-                                 bin_eu: null,
-                                 card_id: null,
-                                 card_status: null,
-                                 default: null,
-                                 expmonth: 9,
-                                 expyear: 2023,
-                                 label: Visa/0002,
-                                 label2: Visa/0002,Exp:2304,
-                                 last4digits: 2,
-                                 scheme: Visa,
-                                 token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr)
+instance = CityPayApiClient::Card.new(
+  bin_commercial: null,
+  bin_corporate: null,
+  bin_country_issued: null,
+  bin_credit: null,
+  bin_currency: null,
+  bin_debit: null,
+  bin_description: Platinum Card,
+  bin_eu: null,
+  card_id: null,
+  card_status: null,
+  date_created: 2020-01-02T18:32:28Z,
+  default: null,
+  expmonth: 9,
+  expyear: 2027,
+  label: Visa/0002,
+  label2: Visa/0002,Exp:2304,
+  last4digits: 2,
+  name_on_card: MR NE BODY,
+  scheme: Visa,
+  token: ctPCAPyNyCkx3Ry8wGyv8khC3ch2hUSB3Db..Qzr
+)
 ```
 
-

data/docs/CardHolderAccount.md

@@ -2,30 +2,33 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** | The account id of the card holder account provided by the merchant which uniquely identifies the account.  | 
-**cards** | [**Array<Card>**](Card.md) |  | [optional] 
-**contact** | [**ContactDetails**](ContactDetails.md) |  | 
-**date_created** | **DateTime** | The date and time the account was created. | [optional] 
-**default_card_id** | **String** | The id of the default card. | [optional] 
-**default_card_index** | **String** | The index in the array of the default card. | [optional] 
-**status** | **String** | Defines the status of the account for processing valid values are   - ACTIVE for active accounts that are able to process  - DISABLED for accounts that are currently disabled for processing.  | [optional] 
-**unique_id** | **String** | A unique id of the card holder account which uniquely identifies the stored account. This value is not searchable. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The account id of the card holder account provided by the merchant which uniquely identifies the account.  |  |
+| **cards** | [**Array<Card>**](Card.md) |  | [optional] |
+| **contact** | [**ContactDetails**](ContactDetails.md) |  |  |
+| **date_created** | **Time** | The date and time the account was created. | [optional] |
+| **default_card_id** | **String** | The id of the default card. | [optional] |
+| **default_card_index** | **Integer** | The index in the array of the default card. | [optional] |
+| **last_modified** | **Time** | The date and time the account was last modified. | [optional] |
+| **status** | **String** | Defines the status of the account for processing valid values are   - ACTIVE for active accounts that are able to process   - DISABLED for accounts that are currently disabled for processing.  | [optional] |
+| **unique_id** | **String** | A unique id of the card holder account which uniquely identifies the stored account. This value is not searchable. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::CardHolderAccount.new(account_id: aaabbb-cccddd-eee,
-                                 cards: null,
-                                 contact: null,
-                                 date_created: 2020-01-02T18:32:28Z,
-                                 default_card_id: null,
-                                 default_card_index: null,
-                                 status: null,
-                                 unique_id: null)
+instance = CityPayApiClient::CardHolderAccount.new(
+  account_id: aaabbb-cccddd-eee,
+  cards: null,
+  contact: null,
+  date_created: 2020-01-02T18:32:28Z,
+  default_card_id: null,
+  default_card_index: null,
+  last_modified: 2020-01-02T18:32:28Z,
+  status: null,
+  unique_id: null
+)
 ```
 
-