citypay_api_client 1.0.2 → 1.1.1

data/docs/PaResAuthRequest.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**md** | **String** | The Merchant Data (MD) which is a unique ID to reference the authentication session. This value will be created by CityPay when required. When responding from the ACS, this value will be returned by the ACS.  | 
-**pares** | **String** | The Payer Authentication Response packet which is returned by the ACS containing the  response of the authentication session including verification values. The response  is a base64 encoded packet and should be forwarded to CityPay untouched.  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **md** | **String** | The Merchant Data (MD) which is a unique ID to reference the authentication session.  This value will be created by CityPay when required. When responding from the ACS, this value will be returned by the ACS.  |  |
+| **pares** | **String** | The Payer Authentication Response packet which is returned by the ACS containing the  response of the authentication session including verification values. The response  is a base64 encoded packet and should be forwarded to CityPay untouched.  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::PaResAuthRequest.new(md: null,
-                                 pares: v66ycfSp8jNlvy7PkHbx44NEt3vox90+vZ/7Ll05Vid/jPfQn8adw+4D/vRDUGT19kndW97Hfirb...)
+instance = CityPayApiClient::PaResAuthRequest.new(
+  md: null,
+  pares: v66ycfSp8jNlvy7PkHbx44NEt3vox90+vZ/7Ll05Vid/jPfQn8adw+4D/vRDUGT19kndW97Hfirb...
+)
 ```
 
-

data/docs/PaylinkAddress.md

@@ -0,0 +1,30 @@
+# CityPayApiClient::PaylinkAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | The first line of the address. | [optional] |
+| **address2** | **String** | The second line of the address. | [optional] |
+| **address3** | **String** | The third line of the address. | [optional] |
+| **area** | **String** | The area such as city, department, town or parish. | [optional] |
+| **country** | **String** | The country code in ISO 3166 format. The country code should be an ISO-3166 2 or 3 digit country code. | [optional] |
+| **label** | **String** | A label for the address such as Head Office, Home Address. | [optional] |
+| **postcode** | **String** | The postcode or zip code of the address. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkAddress.new(
+  address1: 79 Parliament St,
+  address2: Westminster,
+  address3: null,
+  area: London,
+  country: GB,
+  label: Head Office,
+  postcode: L1 789
+)
+```
+

data/docs/PaylinkAdjustmentRequest.md

@@ -0,0 +1,22 @@
+# CityPayApiClient::PaylinkAdjustmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | An amount to adjust to. | [optional] |
+| **identifier** | **String** | An identifier of the original request. | [optional] |
+| **reason** | **String** | A textual reason for the adjustment. | [optional] |
+
+## Example
+
+```ruby
+require 'citypay_api_client'
+
+instance = CityPayApiClient::PaylinkAdjustmentRequest.new(
+  amount: 3600,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  reason: null
+)
+```
+