citypay_api_client 1.0.3 → 1.1.2

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
+)
 ```
 
-

data/docs/ListMerchantsResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**client_name** | **String** | The client name that was requested. | [optional] 
-**clientid** | **String** | The client id requested. | [optional] 
-**merchants** | [**Array<Merchant>**](Merchant.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_name** | **String** | The client name that was requested. | [optional] |
+| **clientid** | **String** | The client id requested. | [optional] |
+| **merchants** | [**Array<Merchant>**](Merchant.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::ListMerchantsResponse.new(client_name: null,
-                                 clientid: PC12345,
-                                 merchants: null)
+instance = CityPayApiClient::ListMerchantsResponse.new(
+  client_name: null,
+  clientid: PC12345,
+  merchants: null
+)
 ```
 
-

data/docs/MCC6012.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipient_account** | **String** | The account number of the recipient. | [optional] 
-**recipient_dob** | **String** | The date of birth of the recipient. | [optional] 
-**recipient_lastname** | **String** | The lastname of ther recepient. | [optional] 
-**recipient_postcode** | **String** | The postcode of the recipient. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient_account** | **String** | The account number of the recipient. | [optional] |
+| **recipient_dob** | **String** | The date of birth of the recipient. | [optional] |
+| **recipient_lastname** | **String** | The lastname of ther recepient. | [optional] |
+| **recipient_postcode** | **String** | The postcode of the recipient. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::MCC6012.new(recipient_account: null,
-                                 recipient_dob: null,
-                                 recipient_lastname: null,
-                                 recipient_postcode: null)
+instance = CityPayApiClient::MCC6012.new(
+  recipient_account: null,
+  recipient_dob: null,
+  recipient_lastname: null,
+  recipient_postcode: null
+)
 ```
 
-

data/docs/Merchant.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currency** | **String** | The currency of the merchant. | [optional] 
-**merchantid** | **Integer** | The merchant id which uniquely identifies the merchant account. | [optional] 
-**name** | **String** | The name of the merchant. | [optional] 
-**status** | **String** | The status of the account. | [optional] 
-**status_label** | **String** | The status label of the account. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | The currency of the merchant. | [optional] |
+| **merchantid** | **Integer** | The merchant id which uniquely identifies the merchant account. | [optional] |
+| **name** | **String** | The name of the merchant. | [optional] |
+| **status** | **String** | The status of the account. | [optional] |
+| **status_label** | **String** | The status label of the account. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::Merchant.new(currency: GBP,
-                                 merchantid: 11223344,
-                                 name: Merchant 1,
-                                 status: A,
-                                 status_label: Active)
+instance = CityPayApiClient::Merchant.new(
+  currency: GBP,
+  merchantid: 11223344,
+  name: Merchant 1,
+  status: A,
+  status_label: Active
+)
 ```
 
-

data/docs/OperationalFunctionsApi.md

@@ -0,0 +1,375 @@
+# CityPayApiClient::OperationalFunctionsApi
+
+All URIs are relative to *https://api.citypay.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**acl_check_request**](OperationalFunctionsApi.md#acl_check_request) | **POST** /v6/acl/check | ACL Check Request |
+| [**domain_key_check_request**](OperationalFunctionsApi.md#domain_key_check_request) | **POST** /dk/check | Domain Key Check Request |
+| [**domain_key_gen_request**](OperationalFunctionsApi.md#domain_key_gen_request) | **POST** /dk/gen | Domain Key Generation Request |
+| [**list_merchants_request**](OperationalFunctionsApi.md#list_merchants_request) | **GET** /v6/merchants/{clientid} | List Merchants Request |
+| [**ping_request**](OperationalFunctionsApi.md#ping_request) | **POST** /v6/ping | Ping Request |
+
+
+## acl_check_request
+
+> <AclCheckResponseModel> acl_check_request(acl_check_request)
+
+ACL Check Request
+
+Allows the checking of IP addresses against configured ACLs. Requests can perform a lookup of addresses in subnets and
+services such as AWS or Azure to check that those addresses are listed in the ACLs.
+
+
+### 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::OperationalFunctionsApi.new
+acl_check_request = CityPayApiClient::AclCheckRequest.new({ip: '8.8.8.8'}) # AclCheckRequest | 
+
+begin
+  # ACL Check Request
+  result = api_instance.acl_check_request(acl_check_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->acl_check_request: #{e}"
+end
+```
+
+#### Using the acl_check_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AclCheckResponseModel>, Integer, Hash)> acl_check_request_with_http_info(acl_check_request)
+
+```ruby
+begin
+  # ACL Check Request
+  data, status_code, headers = api_instance.acl_check_request_with_http_info(acl_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AclCheckResponseModel>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->acl_check_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acl_check_request** | [**AclCheckRequest**](AclCheckRequest.md) |  |  |
+
+### Return type
+
+[**AclCheckResponseModel**](AclCheckResponseModel.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## domain_key_check_request
+
+> <DomainKeyResponse> domain_key_check_request(domain_key_check_request)
+
+Domain Key Check Request
+
+Checks the contents of a `domain key`. Can be used for operational processes to ensure that the properties of a 
+domain key meet their expectations.
+
+
+### 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::OperationalFunctionsApi.new
+domain_key_check_request = CityPayApiClient::DomainKeyCheckRequest.new({domain_key: '3MEcU8cEf...QMeebACxcQVejmT1Wi'}) # DomainKeyCheckRequest | 
+
+begin
+  # Domain Key Check Request
+  result = api_instance.domain_key_check_request(domain_key_check_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->domain_key_check_request: #{e}"
+end
+```
+
+#### Using the domain_key_check_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainKeyResponse>, Integer, Hash)> domain_key_check_request_with_http_info(domain_key_check_request)
+
+```ruby
+begin
+  # Domain Key Check Request
+  data, status_code, headers = api_instance.domain_key_check_request_with_http_info(domain_key_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainKeyResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->domain_key_check_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_key_check_request** | [**DomainKeyCheckRequest**](DomainKeyCheckRequest.md) |  |  |
+
+### Return type
+
+[**DomainKeyResponse**](DomainKeyResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## domain_key_gen_request
+
+> <DomainKeyResponse> domain_key_gen_request(domain_key_request)
+
+Domain Key Generation Request
+
+Generates a domain key based on the permissions of the calling `api-key`. Domain keys can be used in _Direct Post_ and
+`XHR` calls to the API services.
+
+
+### 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::OperationalFunctionsApi.new
+domain_key_request = CityPayApiClient::DomainKeyRequest.new({domain: ['domain_example'], merchantid: 11223344}) # DomainKeyRequest | 
+
+begin
+  # Domain Key Generation Request
+  result = api_instance.domain_key_gen_request(domain_key_request)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->domain_key_gen_request: #{e}"
+end
+```
+
+#### Using the domain_key_gen_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainKeyResponse>, Integer, Hash)> domain_key_gen_request_with_http_info(domain_key_request)
+
+```ruby
+begin
+  # Domain Key Generation Request
+  data, status_code, headers = api_instance.domain_key_gen_request_with_http_info(domain_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainKeyResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->domain_key_gen_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_key_request** | [**DomainKeyRequest**](DomainKeyRequest.md) |  |  |
+
+### Return type
+
+[**DomainKeyResponse**](DomainKeyResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/xml
+- **Accept**: application/json, text/xml
+
+
+## list_merchants_request
+
+> <ListMerchantsResponse> list_merchants_request(clientid)
+
+List Merchants Request
+
+An operational request to list current merchants for a client.
+
+### Sorting
+
+Sorting can be performed by include a query parameter i.e. `/merchants/?sort=merchantid`
+
+Fields that can be sorted are `merchantid` or `name`.
+
+
+### 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::OperationalFunctionsApi.new
+clientid = 'clientid_example' # String | The client id to return merchants for, specifying \"default\" will use the value in your api key.
+
+begin
+  # List Merchants Request
+  result = api_instance.list_merchants_request(clientid)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->list_merchants_request: #{e}"
+end
+```
+
+#### Using the list_merchants_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListMerchantsResponse>, Integer, Hash)> list_merchants_request_with_http_info(clientid)
+
+```ruby
+begin
+  # List Merchants Request
+  data, status_code, headers = api_instance.list_merchants_request_with_http_info(clientid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListMerchantsResponse>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->list_merchants_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clientid** | **String** | The client id to return merchants for, specifying \&quot;default\&quot; will use the value in your api key. |  |
+
+### Return type
+
+[**ListMerchantsResponse**](ListMerchantsResponse.md)
+
+### Authorization
+
+[cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/xml
+
+
+## ping_request
+
+> <Acknowledgement> ping_request(ping)
+
+Ping Request
+
+A ping request which performs a connection and authentication test to the CityPay API server. The request
+will return a standard Acknowledgement with a response code `044` to signify a successful
+ping.
+
+The ping call is useful to confirm that you will be able to access 
+the API from behind any firewalls and that the permission
+model is granting access from your source.
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'citypay_api_client'
+# setup authorization
+CityPayApiClient.configure do |config|
+  # Configure API key authorization: cp-domain-key
+  config.api_key['cp-domain-key'] = 'YOUR API KEY'
+
+  config.api_key['cp-api-key'] = CityPayApiClient::ApiKey.new(client_id: 'YourClientId', licence_key: 'YourLicenceKey').generate
+end
+
+api_instance = CityPayApiClient::OperationalFunctionsApi.new
+ping = CityPayApiClient::Ping.new # Ping | 
+
+begin
+  # Ping Request
+  result = api_instance.ping_request(ping)
+  p result
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->ping_request: #{e}"
+end
+```
+
+#### Using the ping_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Acknowledgement>, Integer, Hash)> ping_request_with_http_info(ping)
+
+```ruby
+begin
+  # Ping Request
+  data, status_code, headers = api_instance.ping_request_with_http_info(ping)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Acknowledgement>
+rescue CityPayApiClient::ApiError => e
+  puts "Error when calling OperationalFunctionsApi->ping_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ping** | [**Ping**](Ping.md) |  |  |
+
+### Return type
+
+[**Acknowledgement**](Acknowledgement.md)
+
+### Authorization
+
+[cp-domain-key](../README.md#cp-domain-key), [cp-api-key](../README.md#cp-api-key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, text/xml
+- **Accept**: application/x-www-form-urlencoded, application/json, text/xml
+

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
+)
+```
+