citypay_api_client 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +15 -14
- data/citypay_api_client.gemspec +4 -3
- data/docs/AirlineAdvice.md +1 -1
- data/docs/AuthRequest.md +3 -1
- data/docs/AuthResponse.md +5 -1
- data/docs/AuthorisationAndPaymentApi.md +300 -9
- data/docs/BatchProcessingApi.md +15 -11
- data/docs/BatchTransactionResultModel.md +5 -1
- data/docs/Card.md +1 -1
- data/docs/CardHolderAccountApi.md +64 -9
- data/docs/ChargeRequest.md +2 -0
- data/docs/ContactDetails.md +11 -11
- data/docs/DirectPostApi.md +40 -16
- data/docs/DirectPostRequest.md +3 -1
- data/docs/OperationalFunctionsApi.md +28 -8
- data/docs/PaylinkApi.md +249 -73
- data/docs/PaylinkCustomParam.md +3 -1
- data/docs/PaylinkFieldGuardModel.md +1 -1
- data/docs/PaylinkTokenRequestModel.md +4 -0
- data/docs/RegisterCard.md +1 -1
- data/docs/ThreeDSecure.md +1 -1
- data/docs/TokenisationResponseModel.md +2 -2
- data/docs/images/3dsv1-challenge.png +0 -0
- data/docs/images/3dsv2-challenge.png +0 -0
- data/docs/images/3dsv2-frictionless.png +0 -0
- data/docs/images/3dsv2-method-challenge.png +0 -0
- data/docs/images/3dsv2-method-frictionless.png +0 -0
- data/docs/images/3dsv2-no3d.png +0 -0
- data/docs/images/citypay-logo.svg +1 -0
- data/docs/images/direct-post-flow.png +0 -0
- data/docs/images/favicon.ico +0 -0
- data/docs/images/header.png +0 -0
- data/docs/images/logo.ai +1913 -4
- data/docs/images/logo.png +0 -0
- data/docs/images/logo.svg +1 -0
- data/docs/images/merchant-BPS-workflow.png +0 -0
- data/docs/images/paylink-field-guards.png +0 -0
- data/lib/.DS_Store +0 -0
- data/lib/citypay_api_client/api/authorisation_and_payment_api__.rb +4 -4
- data/lib/citypay_api_client/api/batch_processing_api__.rb +11 -11
- data/lib/citypay_api_client/api/card_holder_account_api__.rb +2 -2
- data/lib/citypay_api_client/api/direct_post_api__.rb +5 -5
- data/lib/citypay_api_client/api/operational_functions_api__.rb +3 -3
- data/lib/citypay_api_client/api/paylink_api__.rb +74 -74
- data/lib/citypay_api_client/api_client.rb +24 -22
- data/lib/citypay_api_client/api_error.rb +3 -2
- data/lib/citypay_api_client/configuration.rb +28 -9
- data/lib/citypay_api_client/models/account_create.rb +17 -20
- data/lib/citypay_api_client/models/account_status.rb +15 -20
- data/lib/citypay_api_client/models/acknowledgement.rb +27 -24
- data/lib/citypay_api_client/models/acl_check_request.rb +17 -20
- data/lib/citypay_api_client/models/acl_check_response_model.rb +15 -20
- data/lib/citypay_api_client/models/airline_advice.rb +45 -29
- data/lib/citypay_api_client/models/airline_segment.rb +35 -22
- data/lib/citypay_api_client/models/auth_reference.rb +41 -26
- data/lib/citypay_api_client/models/auth_references.rb +15 -20
- data/lib/citypay_api_client/models/auth_request.rb +66 -29
- data/lib/citypay_api_client/models/auth_response.rb +45 -22
- data/lib/citypay_api_client/models/authen_required.rb +15 -20
- data/lib/citypay_api_client/models/batch.rb +24 -21
- data/lib/citypay_api_client/models/batch_report_request.rb +23 -22
- data/lib/citypay_api_client/models/batch_report_response_model.rb +27 -20
- data/lib/citypay_api_client/models/batch_transaction.rb +25 -22
- data/lib/citypay_api_client/models/batch_transaction_result_model.rb +53 -22
- data/lib/citypay_api_client/models/bin.rb +15 -20
- data/lib/citypay_api_client/models/bin_lookup.rb +17 -20
- data/lib/citypay_api_client/models/c_res_auth_request.rb +15 -20
- data/lib/citypay_api_client/models/capture_request.rb +27 -22
- data/lib/citypay_api_client/models/card.rb +33 -26
- data/lib/citypay_api_client/models/card_holder_account.rb +19 -20
- data/lib/citypay_api_client/models/card_status.rb +15 -20
- data/lib/citypay_api_client/models/charge_request.rb +66 -29
- data/lib/citypay_api_client/models/check_batch_status.rb +23 -22
- data/lib/citypay_api_client/models/check_batch_status_response.rb +15 -20
- data/lib/citypay_api_client/models/contact_details.rb +77 -42
- data/lib/citypay_api_client/models/decision.rb +15 -20
- data/lib/citypay_api_client/models/direct_post_request.rb +66 -29
- data/lib/citypay_api_client/models/direct_token_auth_request.rb +15 -20
- data/lib/citypay_api_client/models/domain_key_check_request.rb +17 -20
- data/lib/citypay_api_client/models/domain_key_request.rb +19 -20
- data/lib/citypay_api_client/models/domain_key_response.rb +25 -22
- data/lib/citypay_api_client/models/error.rb +27 -24
- data/lib/citypay_api_client/models/event_data_model.rb +15 -20
- data/lib/citypay_api_client/models/exists.rb +17 -20
- data/lib/citypay_api_client/models/external_mpi.rb +39 -24
- data/lib/citypay_api_client/models/list_merchants_response.rb +21 -22
- data/lib/citypay_api_client/models/mcc6012.rb +15 -20
- data/lib/citypay_api_client/models/merchant.rb +15 -20
- data/lib/citypay_api_client/models/pa_res_auth_request.rb +19 -20
- data/lib/citypay_api_client/models/paylink_address.rb +52 -29
- data/lib/citypay_api_client/models/paylink_adjustment_request.rb +25 -22
- data/lib/citypay_api_client/models/paylink_attachment_request.rb +19 -20
- data/lib/citypay_api_client/models/paylink_attachment_result.rb +19 -20
- data/lib/citypay_api_client/models/paylink_bill_payment_token_request.rb +17 -20
- data/lib/citypay_api_client/models/paylink_card_holder.rb +30 -23
- data/lib/citypay_api_client/models/paylink_cart.rb +15 -20
- data/lib/citypay_api_client/models/paylink_cart_item_model.rb +15 -20
- data/lib/citypay_api_client/models/paylink_config.rb +15 -20
- data/lib/citypay_api_client/models/paylink_custom_param.rb +29 -22
- data/lib/citypay_api_client/models/paylink_email_notification_path.rb +17 -20
- data/lib/citypay_api_client/models/paylink_error_code.rb +19 -20
- data/lib/citypay_api_client/models/paylink_field_guard_model.rb +16 -21
- data/lib/citypay_api_client/models/paylink_part_payments.rb +15 -20
- data/lib/citypay_api_client/models/paylink_sms_notification_path.rb +17 -20
- data/lib/citypay_api_client/models/paylink_state_event.rb +15 -20
- data/lib/citypay_api_client/models/paylink_token_created.rb +21 -20
- data/lib/citypay_api_client/models/paylink_token_request_model.rb +75 -22
- data/lib/citypay_api_client/models/paylink_token_status.rb +15 -20
- data/lib/citypay_api_client/models/paylink_token_status_change_request.rb +19 -20
- data/lib/citypay_api_client/models/paylink_token_status_change_response.rb +17 -20
- data/lib/citypay_api_client/models/paylink_ui.rb +15 -20
- data/lib/citypay_api_client/models/ping.rb +21 -22
- data/lib/citypay_api_client/models/process_batch_request.rb +27 -22
- data/lib/citypay_api_client/models/process_batch_response.rb +17 -20
- data/lib/citypay_api_client/models/refund_request.rb +28 -21
- data/lib/citypay_api_client/models/register_card.rb +27 -22
- data/lib/citypay_api_client/models/request_challenged.rb +15 -20
- data/lib/citypay_api_client/models/retrieve_request.rb +23 -22
- data/lib/citypay_api_client/models/three_d_secure.rb +16 -21
- data/lib/citypay_api_client/models/tokenisation_response_model.rb +23 -24
- data/lib/citypay_api_client/models/void_request.rb +23 -22
- data/lib/citypay_api_client/version.rb +3 -3
- data/lib/citypay_api_client.rb +2 -2
- data/spec/.DS_Store +0 -0
- data/spec/it_api_sandbox_spec.rb +5 -11
- data/spec/models/account_create_spec.rb +1 -2
- data/spec/models/account_status_spec.rb +2 -2
- data/spec/models/airline_advice_spec.rb +0 -2
- data/spec/models/airline_segment_spec.rb +0 -2
- data/spec/models/auth_request_spec.rb +0 -2
- data/spec/models/auth_response_spec.rb +75 -30
- data/spec/models/batch_report_request_spec.rb +0 -2
- data/spec/models/batch_report_response_model_spec.rb +0 -2
- data/spec/models/batch_spec.rb +0 -2
- data/spec/models/batch_transaction_result_model_spec.rb +0 -2
- data/spec/models/batch_transaction_spec.rb +0 -2
- data/spec/models/bin_lookup_spec.rb +0 -2
- data/spec/models/capture_request_spec.rb +0 -2
- data/spec/models/card_holder_account_spec.rb +0 -2
- data/spec/models/charge_request_spec.rb +0 -2
- data/spec/models/direct_post_request_spec.rb +0 -2
- data/spec/models/domain_key_check_request_spec.rb +0 -2
- data/spec/models/paylink_token_request_model_spec.rb +0 -2
- data/spec/models/process_batch_request_spec.rb +0 -2
- data/spec/models/refund_request_spec.rb +0 -2
- data/spec/models/register_card_spec.rb +0 -2
- data/spec/spec_helper.rb +2 -2
- metadata +25 -12
- data/docs/OperationalApi.md +0 -214
- data/docs/PaymentProcessingApi.md +0 -559
@@ -1,11 +1,11 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
# This CityPay API is
|
4
|
+
# 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.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -120,6 +120,7 @@ module CityPayApiClient
|
|
120
120
|
# Show invalid properties with the reasons. Usually used together with valid?
|
121
121
|
# @return Array for valid properties with the reasons
|
122
122
|
def list_invalid_properties
|
123
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
123
124
|
invalid_properties = Array.new
|
124
125
|
invalid_properties
|
125
126
|
end
|
@@ -127,6 +128,7 @@ module CityPayApiClient
|
|
127
128
|
# Check to see if the all the properties in the model are valid
|
128
129
|
# @return true if the model is valid
|
129
130
|
def valid?
|
131
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
130
132
|
true
|
131
133
|
end
|
132
134
|
|
@@ -160,37 +162,30 @@ module CityPayApiClient
|
|
160
162
|
# @param [Hash] attributes Model attributes in the form of hash
|
161
163
|
# @return [Object] Returns the model itself
|
162
164
|
def self.build_from_hash(attributes)
|
163
|
-
new.build_from_hash(attributes)
|
164
|
-
end
|
165
|
-
|
166
|
-
# Builds the object from hash
|
167
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
168
|
-
# @return [Object] Returns the model itself
|
169
|
-
def build_from_hash(attributes)
|
170
165
|
return nil unless attributes.is_a?(Hash)
|
171
166
|
attributes = attributes.transform_keys(&:to_sym)
|
172
|
-
|
173
|
-
|
174
|
-
|
167
|
+
transformed_hash = {}
|
168
|
+
openapi_types.each_pair do |key, type|
|
169
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
170
|
+
transformed_hash["#{key}"] = nil
|
175
171
|
elsif type =~ /\AArray<(.*)>/i
|
176
172
|
# check to ensure the input is an array given that the attribute
|
177
173
|
# is documented as an array but the input is not
|
178
|
-
if attributes[
|
179
|
-
|
174
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
175
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
180
176
|
end
|
181
|
-
elsif !attributes[
|
182
|
-
|
177
|
+
elsif !attributes[attribute_map[key]].nil?
|
178
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
183
179
|
end
|
184
180
|
end
|
185
|
-
|
186
|
-
self
|
181
|
+
new(transformed_hash)
|
187
182
|
end
|
188
183
|
|
189
184
|
# Deserializes the data based on type
|
190
185
|
# @param string type Data type
|
191
186
|
# @param string value Value to be deserialized
|
192
187
|
# @return [Object] Deserialized data
|
193
|
-
def _deserialize(type, value)
|
188
|
+
def self._deserialize(type, value)
|
194
189
|
case type.to_sym
|
195
190
|
when :Time
|
196
191
|
Time.parse(value)
|
@@ -225,7 +220,7 @@ module CityPayApiClient
|
|
225
220
|
else # model
|
226
221
|
# models (e.g. Pet) or oneOf
|
227
222
|
klass = CityPayApiClient.const_get(type)
|
228
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
223
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
229
224
|
end
|
230
225
|
end
|
231
226
|
|
@@ -1,11 +1,11 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
# This CityPay API is
|
4
|
+
# 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.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -128,6 +128,7 @@ module CityPayApiClient
|
|
128
128
|
# Show invalid properties with the reasons. Usually used together with valid?
|
129
129
|
# @return Array for valid properties with the reasons
|
130
130
|
def list_invalid_properties
|
131
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
131
132
|
invalid_properties = Array.new
|
132
133
|
invalid_properties
|
133
134
|
end
|
@@ -135,6 +136,7 @@ module CityPayApiClient
|
|
135
136
|
# Check to see if the all the properties in the model are valid
|
136
137
|
# @return true if the model is valid
|
137
138
|
def valid?
|
139
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
138
140
|
true
|
139
141
|
end
|
140
142
|
|
@@ -169,37 +171,30 @@ module CityPayApiClient
|
|
169
171
|
# @param [Hash] attributes Model attributes in the form of hash
|
170
172
|
# @return [Object] Returns the model itself
|
171
173
|
def self.build_from_hash(attributes)
|
172
|
-
new.build_from_hash(attributes)
|
173
|
-
end
|
174
|
-
|
175
|
-
# Builds the object from hash
|
176
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
177
|
-
# @return [Object] Returns the model itself
|
178
|
-
def build_from_hash(attributes)
|
179
174
|
return nil unless attributes.is_a?(Hash)
|
180
175
|
attributes = attributes.transform_keys(&:to_sym)
|
181
|
-
|
182
|
-
|
183
|
-
|
176
|
+
transformed_hash = {}
|
177
|
+
openapi_types.each_pair do |key, type|
|
178
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
179
|
+
transformed_hash["#{key}"] = nil
|
184
180
|
elsif type =~ /\AArray<(.*)>/i
|
185
181
|
# check to ensure the input is an array given that the attribute
|
186
182
|
# is documented as an array but the input is not
|
187
|
-
if attributes[
|
188
|
-
|
183
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
184
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
189
185
|
end
|
190
|
-
elsif !attributes[
|
191
|
-
|
186
|
+
elsif !attributes[attribute_map[key]].nil?
|
187
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
192
188
|
end
|
193
189
|
end
|
194
|
-
|
195
|
-
self
|
190
|
+
new(transformed_hash)
|
196
191
|
end
|
197
192
|
|
198
193
|
# Deserializes the data based on type
|
199
194
|
# @param string type Data type
|
200
195
|
# @param string value Value to be deserialized
|
201
196
|
# @return [Object] Deserialized data
|
202
|
-
def _deserialize(type, value)
|
197
|
+
def self._deserialize(type, value)
|
203
198
|
case type.to_sym
|
204
199
|
when :Time
|
205
200
|
Time.parse(value)
|
@@ -234,7 +229,7 @@ module CityPayApiClient
|
|
234
229
|
else # model
|
235
230
|
# models (e.g. Pet) or oneOf
|
236
231
|
klass = CityPayApiClient.const_get(type)
|
237
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
232
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
238
233
|
end
|
239
234
|
end
|
240
235
|
|
@@ -1,11 +1,11 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
# This CityPay API is
|
4
|
+
# 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.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -258,6 +258,7 @@ module CityPayApiClient
|
|
258
258
|
# Show invalid properties with the reasons. Usually used together with valid?
|
259
259
|
# @return Array for valid properties with the reasons
|
260
260
|
def list_invalid_properties
|
261
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
261
262
|
invalid_properties = Array.new
|
262
263
|
invalid_properties
|
263
264
|
end
|
@@ -265,6 +266,7 @@ module CityPayApiClient
|
|
265
266
|
# Check to see if the all the properties in the model are valid
|
266
267
|
# @return true if the model is valid
|
267
268
|
def valid?
|
269
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
268
270
|
true
|
269
271
|
end
|
270
272
|
|
@@ -313,37 +315,30 @@ module CityPayApiClient
|
|
313
315
|
# @param [Hash] attributes Model attributes in the form of hash
|
314
316
|
# @return [Object] Returns the model itself
|
315
317
|
def self.build_from_hash(attributes)
|
316
|
-
new.build_from_hash(attributes)
|
317
|
-
end
|
318
|
-
|
319
|
-
# Builds the object from hash
|
320
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
321
|
-
# @return [Object] Returns the model itself
|
322
|
-
def build_from_hash(attributes)
|
323
318
|
return nil unless attributes.is_a?(Hash)
|
324
319
|
attributes = attributes.transform_keys(&:to_sym)
|
325
|
-
|
326
|
-
|
327
|
-
|
320
|
+
transformed_hash = {}
|
321
|
+
openapi_types.each_pair do |key, type|
|
322
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
323
|
+
transformed_hash["#{key}"] = nil
|
328
324
|
elsif type =~ /\AArray<(.*)>/i
|
329
325
|
# check to ensure the input is an array given that the attribute
|
330
326
|
# is documented as an array but the input is not
|
331
|
-
if attributes[
|
332
|
-
|
327
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
328
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
333
329
|
end
|
334
|
-
elsif !attributes[
|
335
|
-
|
330
|
+
elsif !attributes[attribute_map[key]].nil?
|
331
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
336
332
|
end
|
337
333
|
end
|
338
|
-
|
339
|
-
self
|
334
|
+
new(transformed_hash)
|
340
335
|
end
|
341
336
|
|
342
337
|
# Deserializes the data based on type
|
343
338
|
# @param string type Data type
|
344
339
|
# @param string value Value to be deserialized
|
345
340
|
# @return [Object] Deserialized data
|
346
|
-
def _deserialize(type, value)
|
341
|
+
def self._deserialize(type, value)
|
347
342
|
case type.to_sym
|
348
343
|
when :Time
|
349
344
|
Time.parse(value)
|
@@ -378,7 +373,7 @@ module CityPayApiClient
|
|
378
373
|
else # model
|
379
374
|
# models (e.g. Pet) or oneOf
|
380
375
|
klass = CityPayApiClient.const_get(type)
|
381
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
376
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
382
377
|
end
|
383
378
|
end
|
384
379
|
|
@@ -1,11 +1,11 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
# This CityPay API is
|
4
|
+
# 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.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -14,7 +14,10 @@ require 'time'
|
|
14
14
|
|
15
15
|
module CityPayApiClient
|
16
16
|
class PaylinkCustomParam
|
17
|
-
#
|
17
|
+
# The type of entry mode. A value of 'pre' will pre-render the custom parameter before the payment screen. Any other value will result in the custom parameter being displayed on the payment screen.
|
18
|
+
attr_accessor :entry_mode
|
19
|
+
|
20
|
+
# the type of html5 field, defaults to 'text'. Other options are 'dob' for a date of birth series of select list entry.
|
18
21
|
attr_accessor :field_type
|
19
22
|
|
20
23
|
# a group the parameter is linked with, allows for grouping with a title.
|
@@ -47,6 +50,7 @@ module CityPayApiClient
|
|
47
50
|
# Attribute mapping from ruby-style variable name to JSON key.
|
48
51
|
def self.attribute_map
|
49
52
|
{
|
53
|
+
:'entry_mode' => :'entry_mode',
|
50
54
|
:'field_type' => :'field_type',
|
51
55
|
:'group' => :'group',
|
52
56
|
:'label' => :'label',
|
@@ -68,6 +72,7 @@ module CityPayApiClient
|
|
68
72
|
# Attribute type mapping.
|
69
73
|
def self.openapi_types
|
70
74
|
{
|
75
|
+
:'entry_mode' => :'String',
|
71
76
|
:'field_type' => :'String',
|
72
77
|
:'group' => :'String',
|
73
78
|
:'label' => :'String',
|
@@ -102,6 +107,10 @@ module CityPayApiClient
|
|
102
107
|
h[k.to_sym] = v
|
103
108
|
}
|
104
109
|
|
110
|
+
if attributes.key?(:'entry_mode')
|
111
|
+
self.entry_mode = attributes[:'entry_mode']
|
112
|
+
end
|
113
|
+
|
105
114
|
if attributes.key?(:'field_type')
|
106
115
|
self.field_type = attributes[:'field_type']
|
107
116
|
end
|
@@ -120,6 +129,8 @@ module CityPayApiClient
|
|
120
129
|
|
121
130
|
if attributes.key?(:'name')
|
122
131
|
self.name = attributes[:'name']
|
132
|
+
else
|
133
|
+
self.name = nil
|
123
134
|
end
|
124
135
|
|
125
136
|
if attributes.key?(:'order')
|
@@ -146,6 +157,7 @@ module CityPayApiClient
|
|
146
157
|
# Show invalid properties with the reasons. Usually used together with valid?
|
147
158
|
# @return Array for valid properties with the reasons
|
148
159
|
def list_invalid_properties
|
160
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
149
161
|
invalid_properties = Array.new
|
150
162
|
if @name.nil?
|
151
163
|
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
@@ -157,6 +169,7 @@ module CityPayApiClient
|
|
157
169
|
# Check to see if the all the properties in the model are valid
|
158
170
|
# @return true if the model is valid
|
159
171
|
def valid?
|
172
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
160
173
|
return false if @name.nil?
|
161
174
|
true
|
162
175
|
end
|
@@ -166,6 +179,7 @@ module CityPayApiClient
|
|
166
179
|
def ==(o)
|
167
180
|
return true if self.equal?(o)
|
168
181
|
self.class == o.class &&
|
182
|
+
entry_mode == o.entry_mode &&
|
169
183
|
field_type == o.field_type &&
|
170
184
|
group == o.group &&
|
171
185
|
label == o.label &&
|
@@ -187,44 +201,37 @@ module CityPayApiClient
|
|
187
201
|
# Calculates hash code according to all attributes.
|
188
202
|
# @return [Integer] Hash code
|
189
203
|
def hash
|
190
|
-
[field_type, group, label, locked, name, order, pattern, placeholder, required, value].hash
|
204
|
+
[entry_mode, field_type, group, label, locked, name, order, pattern, placeholder, required, value].hash
|
191
205
|
end
|
192
206
|
|
193
207
|
# Builds the object from hash
|
194
208
|
# @param [Hash] attributes Model attributes in the form of hash
|
195
209
|
# @return [Object] Returns the model itself
|
196
210
|
def self.build_from_hash(attributes)
|
197
|
-
new.build_from_hash(attributes)
|
198
|
-
end
|
199
|
-
|
200
|
-
# Builds the object from hash
|
201
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
202
|
-
# @return [Object] Returns the model itself
|
203
|
-
def build_from_hash(attributes)
|
204
211
|
return nil unless attributes.is_a?(Hash)
|
205
212
|
attributes = attributes.transform_keys(&:to_sym)
|
206
|
-
|
207
|
-
|
208
|
-
|
213
|
+
transformed_hash = {}
|
214
|
+
openapi_types.each_pair do |key, type|
|
215
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
216
|
+
transformed_hash["#{key}"] = nil
|
209
217
|
elsif type =~ /\AArray<(.*)>/i
|
210
218
|
# check to ensure the input is an array given that the attribute
|
211
219
|
# is documented as an array but the input is not
|
212
|
-
if attributes[
|
213
|
-
|
220
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
221
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
214
222
|
end
|
215
|
-
elsif !attributes[
|
216
|
-
|
223
|
+
elsif !attributes[attribute_map[key]].nil?
|
224
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
217
225
|
end
|
218
226
|
end
|
219
|
-
|
220
|
-
self
|
227
|
+
new(transformed_hash)
|
221
228
|
end
|
222
229
|
|
223
230
|
# Deserializes the data based on type
|
224
231
|
# @param string type Data type
|
225
232
|
# @param string value Value to be deserialized
|
226
233
|
# @return [Object] Deserialized data
|
227
|
-
def _deserialize(type, value)
|
234
|
+
def self._deserialize(type, value)
|
228
235
|
case type.to_sym
|
229
236
|
when :Time
|
230
237
|
Time.parse(value)
|
@@ -259,7 +266,7 @@ module CityPayApiClient
|
|
259
266
|
else # model
|
260
267
|
# models (e.g. Pet) or oneOf
|
261
268
|
klass = CityPayApiClient.const_get(type)
|
262
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
269
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
263
270
|
end
|
264
271
|
end
|
265
272
|
|
@@ -1,11 +1,11 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
# This CityPay API is
|
4
|
+
# 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.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -99,12 +99,15 @@ module CityPayApiClient
|
|
99
99
|
if (value = attributes[:'to']).is_a?(Array)
|
100
100
|
self.to = value
|
101
101
|
end
|
102
|
+
else
|
103
|
+
self.to = nil
|
102
104
|
end
|
103
105
|
end
|
104
106
|
|
105
107
|
# Show invalid properties with the reasons. Usually used together with valid?
|
106
108
|
# @return Array for valid properties with the reasons
|
107
109
|
def list_invalid_properties
|
110
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
108
111
|
invalid_properties = Array.new
|
109
112
|
if @to.nil?
|
110
113
|
invalid_properties.push('invalid value for "to", to cannot be nil.')
|
@@ -116,6 +119,7 @@ module CityPayApiClient
|
|
116
119
|
# Check to see if the all the properties in the model are valid
|
117
120
|
# @return true if the model is valid
|
118
121
|
def valid?
|
122
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
119
123
|
return false if @to.nil?
|
120
124
|
true
|
121
125
|
end
|
@@ -148,37 +152,30 @@ module CityPayApiClient
|
|
148
152
|
# @param [Hash] attributes Model attributes in the form of hash
|
149
153
|
# @return [Object] Returns the model itself
|
150
154
|
def self.build_from_hash(attributes)
|
151
|
-
new.build_from_hash(attributes)
|
152
|
-
end
|
153
|
-
|
154
|
-
# Builds the object from hash
|
155
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
156
|
-
# @return [Object] Returns the model itself
|
157
|
-
def build_from_hash(attributes)
|
158
155
|
return nil unless attributes.is_a?(Hash)
|
159
156
|
attributes = attributes.transform_keys(&:to_sym)
|
160
|
-
|
161
|
-
|
162
|
-
|
157
|
+
transformed_hash = {}
|
158
|
+
openapi_types.each_pair do |key, type|
|
159
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
160
|
+
transformed_hash["#{key}"] = nil
|
163
161
|
elsif type =~ /\AArray<(.*)>/i
|
164
162
|
# check to ensure the input is an array given that the attribute
|
165
163
|
# is documented as an array but the input is not
|
166
|
-
if attributes[
|
167
|
-
|
164
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
165
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
168
166
|
end
|
169
|
-
elsif !attributes[
|
170
|
-
|
167
|
+
elsif !attributes[attribute_map[key]].nil?
|
168
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
171
169
|
end
|
172
170
|
end
|
173
|
-
|
174
|
-
self
|
171
|
+
new(transformed_hash)
|
175
172
|
end
|
176
173
|
|
177
174
|
# Deserializes the data based on type
|
178
175
|
# @param string type Data type
|
179
176
|
# @param string value Value to be deserialized
|
180
177
|
# @return [Object] Deserialized data
|
181
|
-
def _deserialize(type, value)
|
178
|
+
def self._deserialize(type, value)
|
182
179
|
case type.to_sym
|
183
180
|
when :Time
|
184
181
|
Time.parse(value)
|
@@ -213,7 +210,7 @@ module CityPayApiClient
|
|
213
210
|
else # model
|
214
211
|
# models (e.g. Pet) or oneOf
|
215
212
|
klass = CityPayApiClient.const_get(type)
|
216
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
213
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
217
214
|
end
|
218
215
|
end
|
219
216
|
|
@@ -1,11 +1,11 @@
|
|
1
1
|
=begin
|
2
2
|
#CityPay Payment API
|
3
3
|
|
4
|
-
# This CityPay API is
|
4
|
+
# 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.
|
5
5
|
|
6
6
|
Contact: support@citypay.com
|
7
7
|
Generated by: https://openapi-generator.tech
|
8
|
-
OpenAPI Generator version:
|
8
|
+
OpenAPI Generator version: 7.2.0
|
9
9
|
|
10
10
|
=end
|
11
11
|
|
@@ -64,16 +64,21 @@ module CityPayApiClient
|
|
64
64
|
|
65
65
|
if attributes.key?(:'code')
|
66
66
|
self.code = attributes[:'code']
|
67
|
+
else
|
68
|
+
self.code = nil
|
67
69
|
end
|
68
70
|
|
69
71
|
if attributes.key?(:'msg')
|
70
72
|
self.msg = attributes[:'msg']
|
73
|
+
else
|
74
|
+
self.msg = nil
|
71
75
|
end
|
72
76
|
end
|
73
77
|
|
74
78
|
# Show invalid properties with the reasons. Usually used together with valid?
|
75
79
|
# @return Array for valid properties with the reasons
|
76
80
|
def list_invalid_properties
|
81
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
77
82
|
invalid_properties = Array.new
|
78
83
|
if @code.nil?
|
79
84
|
invalid_properties.push('invalid value for "code", code cannot be nil.')
|
@@ -89,6 +94,7 @@ module CityPayApiClient
|
|
89
94
|
# Check to see if the all the properties in the model are valid
|
90
95
|
# @return true if the model is valid
|
91
96
|
def valid?
|
97
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
92
98
|
return false if @code.nil?
|
93
99
|
return false if @msg.nil?
|
94
100
|
true
|
@@ -119,37 +125,30 @@ module CityPayApiClient
|
|
119
125
|
# @param [Hash] attributes Model attributes in the form of hash
|
120
126
|
# @return [Object] Returns the model itself
|
121
127
|
def self.build_from_hash(attributes)
|
122
|
-
new.build_from_hash(attributes)
|
123
|
-
end
|
124
|
-
|
125
|
-
# Builds the object from hash
|
126
|
-
# @param [Hash] attributes Model attributes in the form of hash
|
127
|
-
# @return [Object] Returns the model itself
|
128
|
-
def build_from_hash(attributes)
|
129
128
|
return nil unless attributes.is_a?(Hash)
|
130
129
|
attributes = attributes.transform_keys(&:to_sym)
|
131
|
-
|
132
|
-
|
133
|
-
|
130
|
+
transformed_hash = {}
|
131
|
+
openapi_types.each_pair do |key, type|
|
132
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
133
|
+
transformed_hash["#{key}"] = nil
|
134
134
|
elsif type =~ /\AArray<(.*)>/i
|
135
135
|
# check to ensure the input is an array given that the attribute
|
136
136
|
# is documented as an array but the input is not
|
137
|
-
if attributes[
|
138
|
-
|
137
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
138
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
139
139
|
end
|
140
|
-
elsif !attributes[
|
141
|
-
|
140
|
+
elsif !attributes[attribute_map[key]].nil?
|
141
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
142
142
|
end
|
143
143
|
end
|
144
|
-
|
145
|
-
self
|
144
|
+
new(transformed_hash)
|
146
145
|
end
|
147
146
|
|
148
147
|
# Deserializes the data based on type
|
149
148
|
# @param string type Data type
|
150
149
|
# @param string value Value to be deserialized
|
151
150
|
# @return [Object] Deserialized data
|
152
|
-
def _deserialize(type, value)
|
151
|
+
def self._deserialize(type, value)
|
153
152
|
case type.to_sym
|
154
153
|
when :Time
|
155
154
|
Time.parse(value)
|
@@ -184,7 +183,7 @@ module CityPayApiClient
|
|
184
183
|
else # model
|
185
184
|
# models (e.g. Pet) or oneOf
|
186
185
|
klass = CityPayApiClient.const_get(type)
|
187
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
186
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
188
187
|
end
|
189
188
|
end
|
190
189
|
|