diff --git a/CyberSource/__init__.py b/CyberSource/__init__.py index a5e63973..94448aff 100644 --- a/CyberSource/__init__.py +++ b/CyberSource/__init__.py @@ -45,14 +45,18 @@ from .models.generate_public_key_request import GeneratePublicKeyRequest from .models.generate_unified_checkout_capture_context_request import GenerateUnifiedCheckoutCaptureContextRequest from .models.increment_auth_request import IncrementAuthRequest +from .models.inline_response_200 import InlineResponse200 +from .models.inline_response_200_keys import InlineResponse200Keys from .models.inline_response_400 import InlineResponse400 from .models.inline_response_400_1 import InlineResponse4001 from .models.inline_response_400_1_fields import InlineResponse4001Fields from .models.inline_response_400_2 import InlineResponse4002 from .models.inline_response_400_3 import InlineResponse4003 -from .models.inline_response_400_3_details import InlineResponse4003Details +from .models.inline_response_400_4 import InlineResponse4004 +from .models.inline_response_400_4_details import InlineResponse4004Details from .models.inline_response_400_details import InlineResponse400Details from .models.inline_response_400_errors import InlineResponse400Errors +from .models.inline_response_500 import InlineResponse500 from .models.inline_response_502 import InlineResponse502 from .models.inline_response_default import InlineResponseDefault from .models.inline_response_default__links import InlineResponseDefaultLinks @@ -725,7 +729,11 @@ from .models.ums_v1_users_get200_response_contact_information import UmsV1UsersGet200ResponseContactInformation from .models.ums_v1_users_get200_response_organization_information import UmsV1UsersGet200ResponseOrganizationInformation from .models.ums_v1_users_get200_response_users import UmsV1UsersGet200ResponseUsers +from .models.update_asym_keys_request import UpdateAsymKeysRequest from .models.update_invoice_request import UpdateInvoiceRequest +from .models.update_pgp_keys_request import UpdatePGPKeysRequest +from .models.update_pgp_keys_request_1 import UpdatePGPKeysRequest1 +from .models.update_password_keys_request import UpdatePasswordKeysRequest from .models.upv1capturecontexts_capture_mandate import Upv1capturecontextsCaptureMandate from .models.upv1capturecontexts_checkout_api_initialization import Upv1capturecontextsCheckoutApiInitialization from .models.upv1capturecontexts_order_information import Upv1capturecontextsOrderInformation @@ -792,6 +800,10 @@ from .apis.invoice_settings_api import InvoiceSettingsApi from .apis.invoices_api import InvoicesApi from .apis.key_generation_api import KeyGenerationApi +from .apis.keymanagement_api import KeymanagementApi +from .apis.keymanagementpassword_api import KeymanagementpasswordApi +from .apis.keymanagementpgp_api import KeymanagementpgpApi +from .apis.keymanagementscmp_api import KeymanagementscmpApi from .apis.net_fundings_api import NetFundingsApi from .apis.notification_of_changes_api import NotificationOfChangesApi from .apis.payer_authentication_api import PayerAuthenticationApi diff --git a/CyberSource/apis/__init__.py b/CyberSource/apis/__init__.py index 8bebc6a4..402773b5 100644 --- a/CyberSource/apis/__init__.py +++ b/CyberSource/apis/__init__.py @@ -20,6 +20,10 @@ from .invoice_settings_api import InvoiceSettingsApi from .invoices_api import InvoicesApi from .key_generation_api import KeyGenerationApi +from .keymanagement_api import KeymanagementApi +from .keymanagementpassword_api import KeymanagementpasswordApi +from .keymanagementpgp_api import KeymanagementpgpApi +from .keymanagementscmp_api import KeymanagementscmpApi from .net_fundings_api import NetFundingsApi from .notification_of_changes_api import NotificationOfChangesApi from .payer_authentication_api import PayerAuthenticationApi diff --git a/CyberSource/apis/asymmetric_key_management_api.py b/CyberSource/apis/asymmetric_key_management_api.py index 664f352b..f7c55d53 100644 --- a/CyberSource/apis/asymmetric_key_management_api.py +++ b/CyberSource/apis/asymmetric_key_management_api.py @@ -382,3 +382,124 @@ def get_p12_key_details_with_http_info(self, key_id, **kwargs): _preload_content=params.get('_preload_content', True), _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + + def update_asym_key(self, key_id, update_asym_keys_request, **kwargs): + """ + Activate or De-activate Asymmetric Key + Activate or De-activate Asymmetric Key + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_asym_key(key_id, update_asym_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdateAsymKeysRequest update_asym_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + if self.api_client.mconfig.log_config.enable_log: + self.logger.info("CALL TO METHOD `update_asym_key` STARTED") + + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_asym_key_with_http_info(key_id, update_asym_keys_request, **kwargs) + else: + (data) = self.update_asym_key_with_http_info(key_id, update_asym_keys_request, **kwargs) + return data + + def update_asym_key_with_http_info(self, key_id, update_asym_keys_request, **kwargs): + """ + Activate or De-activate Asymmetric Key + Activate or De-activate Asymmetric Key + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_asym_key_with_http_info(key_id, update_asym_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdateAsymKeysRequest update_asym_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['key_id', 'update_asym_keys_request'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_asym_key" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'key_id' is set + if ('key_id' not in params) or (params['key_id'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `key_id` when calling `update_asym_key`") + raise ValueError("Missing the required parameter `key_id` when calling `update_asym_key`") + # verify the required parameter 'update_asym_keys_request' is set + if ('update_asym_keys_request' not in params) or (params['update_asym_keys_request'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `update_asym_keys_request` when calling `update_asym_key`") + raise ValueError("Missing the required parameter `update_asym_keys_request` when calling `update_asym_key`") + + + collection_formats = {} + + path_params = {} + if 'key_id' in params: + path_params['keyId'] = params['key_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'update_asym_keys_request' in params: + body_params = params['update_asym_keys_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/hal+json;charset=utf-8']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json;charset=utf-8']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(f'/kms/v2/keys-asym/{key_id}', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='object', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/CyberSource/apis/keymanagement_api.py b/CyberSource/apis/keymanagement_api.py new file mode 100644 index 00000000..cd1d14ec --- /dev/null +++ b/CyberSource/apis/keymanagement_api.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient +import CyberSource.logging.log_factory as LogFactory + + +class KeymanagementApi(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, merchant_config, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + self.api_client.set_configuration(merchant_config) + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.api_client.mconfig.log_config) + + + + def search_keys(self, **kwargs): + """ + Search Keys + Search one or more Keys + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.search_keys(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param int offset: This allows you to specify the page offset from the resulting list resultset you want the records to be returned + :param int limit: This allows you to specify the total number of records to be returned off the resulting list resultset + :param str sort: This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. + :param list[str] organization_ids: List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. + :param list[str] key_ids: List of Key Ids to search. The maximum size of the Key Ids list is 1 + :param list[str] key_types: Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided + :param datetime expiration_start_date: Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided + :param datetime expiration_end_date: Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided + :return: InlineResponse200 + If the method is called asynchronously, + returns the request thread. + """ + + if self.api_client.mconfig.log_config.enable_log: + self.logger.info("CALL TO METHOD `search_keys` STARTED") + + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.search_keys_with_http_info(**kwargs) + else: + (data) = self.search_keys_with_http_info(**kwargs) + return data + + def search_keys_with_http_info(self, **kwargs): + """ + Search Keys + Search one or more Keys + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.search_keys_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param int offset: This allows you to specify the page offset from the resulting list resultset you want the records to be returned + :param int limit: This allows you to specify the total number of records to be returned off the resulting list resultset + :param str sort: This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. + :param list[str] organization_ids: List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. + :param list[str] key_ids: List of Key Ids to search. The maximum size of the Key Ids list is 1 + :param list[str] key_types: Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided + :param datetime expiration_start_date: Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided + :param datetime expiration_end_date: Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided + :return: InlineResponse200 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['offset', 'limit', 'sort', 'organization_ids', 'key_ids', 'key_types', 'expiration_start_date', 'expiration_end_date'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method search_keys" % key + ) + params[key] = val + del params['kwargs'] + + if 'expiration_start_date' in params and not re.search('yyyy-mm-dd', params['expiration_start_date']): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Invalid value for parameter `expiration_start_date` when calling `search_keys`, must conform to the pattern `/yyyy-mm-dd/`") + raise ValueError("Invalid value for parameter `expiration_start_date` when calling `search_keys`, must conform to the pattern `/yyyy-mm-dd/`") + if 'expiration_end_date' in params and not re.search('yyyy-mm-dd', params['expiration_end_date']): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Invalid value for parameter `expiration_end_date` when calling `search_keys`, must conform to the pattern `/yyyy-mm-dd/`") + raise ValueError("Invalid value for parameter `expiration_end_date` when calling `search_keys`, must conform to the pattern `/yyyy-mm-dd/`") + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'offset' in params: + query_params.append(('offset', params['offset'])) + if 'limit' in params: + query_params.append(('limit', params['limit'])) + if 'sort' in params: + query_params.append(('sort', params['sort'])) + if 'organization_ids' in params: + query_params.append(('organizationIds', params['organization_ids'])) + collection_formats['organizationIds'] = 'csv' + if 'key_ids' in params: + query_params.append(('keyIds', params['key_ids'])) + collection_formats['keyIds'] = 'csv' + if 'key_types' in params: + query_params.append(('keyTypes', params['key_types'])) + collection_formats['keyTypes'] = 'csv' + if 'expiration_start_date' in params: + query_params.append(('expirationStartDate', params['expiration_start_date'])) + if 'expiration_end_date' in params: + query_params.append(('expirationEndDate', params['expiration_end_date'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'GET' in ('POST'): + body_params = '{}' + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/hal+json;charset=utf-8']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json;charset=utf-8']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(f'/kms/v2/keys', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponse200', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/CyberSource/apis/keymanagementpassword_api.py b/CyberSource/apis/keymanagementpassword_api.py new file mode 100644 index 00000000..b2b05f82 --- /dev/null +++ b/CyberSource/apis/keymanagementpassword_api.py @@ -0,0 +1,167 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient +import CyberSource.logging.log_factory as LogFactory + + +class KeymanagementpasswordApi(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, merchant_config, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + self.api_client.set_configuration(merchant_config) + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.api_client.mconfig.log_config) + + + + def update_password(self, key_id, update_password_keys_request, **kwargs): + """ + Activate or De-activate Password + Activate or De-activate key of type password + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_password(key_id, update_password_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdatePasswordKeysRequest update_password_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + if self.api_client.mconfig.log_config.enable_log: + self.logger.info("CALL TO METHOD `update_password` STARTED") + + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_password_with_http_info(key_id, update_password_keys_request, **kwargs) + else: + (data) = self.update_password_with_http_info(key_id, update_password_keys_request, **kwargs) + return data + + def update_password_with_http_info(self, key_id, update_password_keys_request, **kwargs): + """ + Activate or De-activate Password + Activate or De-activate key of type password + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_password_with_http_info(key_id, update_password_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdatePasswordKeysRequest update_password_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['key_id', 'update_password_keys_request'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_password" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'key_id' is set + if ('key_id' not in params) or (params['key_id'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `key_id` when calling `update_password`") + raise ValueError("Missing the required parameter `key_id` when calling `update_password`") + # verify the required parameter 'update_password_keys_request' is set + if ('update_password_keys_request' not in params) or (params['update_password_keys_request'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `update_password_keys_request` when calling `update_password`") + raise ValueError("Missing the required parameter `update_password_keys_request` when calling `update_password`") + + + collection_formats = {} + + path_params = {} + if 'key_id' in params: + path_params['keyId'] = params['key_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'update_password_keys_request' in params: + body_params = params['update_password_keys_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/hal+json;charset=utf-8']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json;charset=utf-8']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(f'/kms/v2/keys-password/{keyId}', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='object', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/CyberSource/apis/keymanagementpgp_api.py b/CyberSource/apis/keymanagementpgp_api.py new file mode 100644 index 00000000..4e48386d --- /dev/null +++ b/CyberSource/apis/keymanagementpgp_api.py @@ -0,0 +1,167 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient +import CyberSource.logging.log_factory as LogFactory + + +class KeymanagementpgpApi(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, merchant_config, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + self.api_client.set_configuration(merchant_config) + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.api_client.mconfig.log_config) + + + + def update_pgp(self, key_id, update_pgp_keys_request, **kwargs): + """ + Activate or De-activate PGP Key + Activate or De-activate PGP Key + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_pgp(key_id, update_pgp_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdatePGPKeysRequest update_pgp_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + if self.api_client.mconfig.log_config.enable_log: + self.logger.info("CALL TO METHOD `update_pgp` STARTED") + + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_pgp_with_http_info(key_id, update_pgp_keys_request, **kwargs) + else: + (data) = self.update_pgp_with_http_info(key_id, update_pgp_keys_request, **kwargs) + return data + + def update_pgp_with_http_info(self, key_id, update_pgp_keys_request, **kwargs): + """ + Activate or De-activate PGP Key + Activate or De-activate PGP Key + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_pgp_with_http_info(key_id, update_pgp_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdatePGPKeysRequest update_pgp_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['key_id', 'update_pgp_keys_request'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_pgp" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'key_id' is set + if ('key_id' not in params) or (params['key_id'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `key_id` when calling `update_pgp`") + raise ValueError("Missing the required parameter `key_id` when calling `update_pgp`") + # verify the required parameter 'update_pgp_keys_request' is set + if ('update_pgp_keys_request' not in params) or (params['update_pgp_keys_request'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `update_pgp_keys_request` when calling `update_pgp`") + raise ValueError("Missing the required parameter `update_pgp_keys_request` when calling `update_pgp`") + + + collection_formats = {} + + path_params = {} + if 'key_id' in params: + path_params['keyId'] = params['key_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'update_pgp_keys_request' in params: + body_params = params['update_pgp_keys_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/hal+json;charset=utf-8']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json;charset=utf-8']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(f'/kms/v2/keys-pgp/{keyId}', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='object', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/CyberSource/apis/keymanagementscmp_api.py b/CyberSource/apis/keymanagementscmp_api.py new file mode 100644 index 00000000..48dd6713 --- /dev/null +++ b/CyberSource/apis/keymanagementscmp_api.py @@ -0,0 +1,167 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient +import CyberSource.logging.log_factory as LogFactory + + +class KeymanagementscmpApi(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, merchant_config, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + self.api_client.set_configuration(merchant_config) + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.api_client.mconfig.log_config) + + + + def update_scmp(self, key_id, update_pgp_keys_request, **kwargs): + """ + Update or Deactivate + Update or Deactivate scmp api Key + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_scmp(key_id, update_pgp_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdatePGPKeysRequest1 update_pgp_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + if self.api_client.mconfig.log_config.enable_log: + self.logger.info("CALL TO METHOD `update_scmp` STARTED") + + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_scmp_with_http_info(key_id, update_pgp_keys_request, **kwargs) + else: + (data) = self.update_scmp_with_http_info(key_id, update_pgp_keys_request, **kwargs) + return data + + def update_scmp_with_http_info(self, key_id, update_pgp_keys_request, **kwargs): + """ + Update or Deactivate + Update or Deactivate scmp api Key + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.update_scmp_with_http_info(key_id, update_pgp_keys_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str key_id: Key ID. (required) + :param UpdatePGPKeysRequest1 update_pgp_keys_request: (required) + :return: object + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['key_id', 'update_pgp_keys_request'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_scmp" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'key_id' is set + if ('key_id' not in params) or (params['key_id'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `key_id` when calling `update_scmp`") + raise ValueError("Missing the required parameter `key_id` when calling `update_scmp`") + # verify the required parameter 'update_pgp_keys_request' is set + if ('update_pgp_keys_request' not in params) or (params['update_pgp_keys_request'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `update_pgp_keys_request` when calling `update_scmp`") + raise ValueError("Missing the required parameter `update_pgp_keys_request` when calling `update_scmp`") + + + collection_formats = {} + + path_params = {} + if 'key_id' in params: + path_params['keyId'] = params['key_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'update_pgp_keys_request' in params: + body_params = params['update_pgp_keys_request'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/hal+json;charset=utf-8']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json;charset=utf-8']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(f'/kms/v2/keys-scmp/{keyId}', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='object', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/CyberSource/apis/reversal_api.py b/CyberSource/apis/reversal_api.py index 5c4cbe76..08450c44 100644 --- a/CyberSource/apis/reversal_api.py +++ b/CyberSource/apis/reversal_api.py @@ -263,7 +263,7 @@ def mit_reversal_with_http_info(self, mit_reversal_request, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(f'/pts/v2/reversals/', 'POST', + return self.api_client.call_api(f'/pts/v2/reversals', 'POST', path_params, query_params, header_params, diff --git a/CyberSource/apis/void_api.py b/CyberSource/apis/void_api.py index 859c2f5f..835ab558 100644 --- a/CyberSource/apis/void_api.py +++ b/CyberSource/apis/void_api.py @@ -142,7 +142,7 @@ def mit_void_with_http_info(self, mit_void_request, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api(f'/pts/v2/voids/', 'POST', + return self.api_client.call_api(f'/pts/v2/voids', 'POST', path_params, query_params, header_params, diff --git a/CyberSource/models/__init__.py b/CyberSource/models/__init__.py index 1a8f4b7b..b7325adb 100644 --- a/CyberSource/models/__init__.py +++ b/CyberSource/models/__init__.py @@ -45,14 +45,18 @@ from .generate_public_key_request import GeneratePublicKeyRequest from .generate_unified_checkout_capture_context_request import GenerateUnifiedCheckoutCaptureContextRequest from .increment_auth_request import IncrementAuthRequest +from .inline_response_200 import InlineResponse200 +from .inline_response_200_keys import InlineResponse200Keys from .inline_response_400 import InlineResponse400 from .inline_response_400_1 import InlineResponse4001 from .inline_response_400_1_fields import InlineResponse4001Fields from .inline_response_400_2 import InlineResponse4002 from .inline_response_400_3 import InlineResponse4003 -from .inline_response_400_3_details import InlineResponse4003Details +from .inline_response_400_4 import InlineResponse4004 +from .inline_response_400_4_details import InlineResponse4004Details from .inline_response_400_details import InlineResponse400Details from .inline_response_400_errors import InlineResponse400Errors +from .inline_response_500 import InlineResponse500 from .inline_response_502 import InlineResponse502 from .inline_response_default import InlineResponseDefault from .inline_response_default__links import InlineResponseDefaultLinks @@ -725,7 +729,11 @@ from .ums_v1_users_get200_response_contact_information import UmsV1UsersGet200ResponseContactInformation from .ums_v1_users_get200_response_organization_information import UmsV1UsersGet200ResponseOrganizationInformation from .ums_v1_users_get200_response_users import UmsV1UsersGet200ResponseUsers +from .update_asym_keys_request import UpdateAsymKeysRequest from .update_invoice_request import UpdateInvoiceRequest +from .update_pgp_keys_request import UpdatePGPKeysRequest +from .update_pgp_keys_request_1 import UpdatePGPKeysRequest1 +from .update_password_keys_request import UpdatePasswordKeysRequest from .upv1capturecontexts_capture_mandate import Upv1capturecontextsCaptureMandate from .upv1capturecontexts_checkout_api_initialization import Upv1capturecontextsCheckoutApiInitialization from .upv1capturecontexts_order_information import Upv1capturecontextsOrderInformation diff --git a/CyberSource/models/create_search_request.py b/CyberSource/models/create_search_request.py index 59f7e811..e64b53ac 100644 --- a/CyberSource/models/create_search_request.py +++ b/CyberSource/models/create_search_request.py @@ -197,7 +197,7 @@ def offset(self, offset): def limit(self): """ Gets the limit of this CreateSearchRequest. - Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. + Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. :return: The limit of this CreateSearchRequest. :rtype: int @@ -208,7 +208,7 @@ def limit(self): def limit(self, limit): """ Sets the limit of this CreateSearchRequest. - Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. + Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. :param limit: The limit of this CreateSearchRequest. :type: int diff --git a/CyberSource/models/inline_response_200.py b/CyberSource/models/inline_response_200.py new file mode 100644 index 00000000..3430cf21 --- /dev/null +++ b/CyberSource/models/inline_response_200.py @@ -0,0 +1,263 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse200(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'submit_time_utc': 'str', + 'total_count': 'int', + 'offset': 'int', + 'limit': 'int', + 'sort': 'str', + 'keys': 'list[InlineResponse200Keys]' + } + + attribute_map = { + 'submit_time_utc': 'submitTimeUtc', + 'total_count': 'totalCount', + 'offset': 'offset', + 'limit': 'limit', + 'sort': 'sort', + 'keys': 'keys' + } + + def __init__(self, submit_time_utc=None, total_count=None, offset=None, limit=None, sort=None, keys=None): + """ + InlineResponse200 - a model defined in Swagger + """ + + self._submit_time_utc = None + self._total_count = None + self._offset = None + self._limit = None + self._sort = None + self._keys = None + + if submit_time_utc is not None: + self.submit_time_utc = submit_time_utc + if total_count is not None: + self.total_count = total_count + if offset is not None: + self.offset = offset + if limit is not None: + self.limit = limit + if sort is not None: + self.sort = sort + if keys is not None: + self.keys = keys + + @property + def submit_time_utc(self): + """ + Gets the submit_time_utc of this InlineResponse200. + Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + + :return: The submit_time_utc of this InlineResponse200. + :rtype: str + """ + return self._submit_time_utc + + @submit_time_utc.setter + def submit_time_utc(self, submit_time_utc): + """ + Sets the submit_time_utc of this InlineResponse200. + Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + + :param submit_time_utc: The submit_time_utc of this InlineResponse200. + :type: str + """ + + self._submit_time_utc = submit_time_utc + + @property + def total_count(self): + """ + Gets the total_count of this InlineResponse200. + Specifies the total number of items found based on the request + + :return: The total_count of this InlineResponse200. + :rtype: int + """ + return self._total_count + + @total_count.setter + def total_count(self, total_count): + """ + Sets the total_count of this InlineResponse200. + Specifies the total number of items found based on the request + + :param total_count: The total_count of this InlineResponse200. + :type: int + """ + + self._total_count = total_count + + @property + def offset(self): + """ + Gets the offset of this InlineResponse200. + Specifies the record offset from the records are returned part of the response + + :return: The offset of this InlineResponse200. + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """ + Sets the offset of this InlineResponse200. + Specifies the record offset from the records are returned part of the response + + :param offset: The offset of this InlineResponse200. + :type: int + """ + + self._offset = offset + + @property + def limit(self): + """ + Gets the limit of this InlineResponse200. + Specifies the maximum number of records requested part of the response + + :return: The limit of this InlineResponse200. + :rtype: int + """ + return self._limit + + @limit.setter + def limit(self, limit): + """ + Sets the limit of this InlineResponse200. + Specifies the maximum number of records requested part of the response + + :param limit: The limit of this InlineResponse200. + :type: int + """ + + self._limit = limit + + @property + def sort(self): + """ + Gets the sort of this InlineResponse200. + Specifies a comma separated list of field names based on which the result is sorted. + + :return: The sort of this InlineResponse200. + :rtype: str + """ + return self._sort + + @sort.setter + def sort(self, sort): + """ + Sets the sort of this InlineResponse200. + Specifies a comma separated list of field names based on which the result is sorted. + + :param sort: The sort of this InlineResponse200. + :type: str + """ + + self._sort = sort + + @property + def keys(self): + """ + Gets the keys of this InlineResponse200. + + :return: The keys of this InlineResponse200. + :rtype: list[InlineResponse200Keys] + """ + return self._keys + + @keys.setter + def keys(self, keys): + """ + Sets the keys of this InlineResponse200. + + :param keys: The keys of this InlineResponse200. + :type: list[InlineResponse200Keys] + """ + + self._keys = keys + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse200): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response_200_keys.py b/CyberSource/models/inline_response_200_keys.py new file mode 100644 index 00000000..c32752e8 --- /dev/null +++ b/CyberSource/models/inline_response_200_keys.py @@ -0,0 +1,461 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse200Keys(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'merchant_name': 'str', + 'key_id': 'str', + 'key_type': 'str', + 'status': 'str', + 'expiration_date': 'date', + 'date_added': 'date', + 'added_by': 'str', + 'date_modified': 'date', + 'modified_by': 'str', + 'version': 'str', + 'serial_number': 'str', + 'issuer_name': 'str' + } + + attribute_map = { + 'organization_id': 'organizationId', + 'merchant_name': 'merchantName', + 'key_id': 'keyId', + 'key_type': 'keyType', + 'status': 'status', + 'expiration_date': 'expirationDate', + 'date_added': 'dateAdded', + 'added_by': 'addedBy', + 'date_modified': 'dateModified', + 'modified_by': 'modifiedBy', + 'version': 'version', + 'serial_number': 'serialNumber', + 'issuer_name': 'issuerName' + } + + def __init__(self, organization_id=None, merchant_name=None, key_id=None, key_type=None, status=None, expiration_date=None, date_added=None, added_by=None, date_modified=None, modified_by=None, version=None, serial_number=None, issuer_name=None): + """ + InlineResponse200Keys - a model defined in Swagger + """ + + self._organization_id = None + self._merchant_name = None + self._key_id = None + self._key_type = None + self._status = None + self._expiration_date = None + self._date_added = None + self._added_by = None + self._date_modified = None + self._modified_by = None + self._version = None + self._serial_number = None + self._issuer_name = None + + if organization_id is not None: + self.organization_id = organization_id + if merchant_name is not None: + self.merchant_name = merchant_name + if key_id is not None: + self.key_id = key_id + if key_type is not None: + self.key_type = key_type + if status is not None: + self.status = status + if expiration_date is not None: + self.expiration_date = expiration_date + if date_added is not None: + self.date_added = date_added + if added_by is not None: + self.added_by = added_by + if date_modified is not None: + self.date_modified = date_modified + if modified_by is not None: + self.modified_by = modified_by + if version is not None: + self.version = version + if serial_number is not None: + self.serial_number = serial_number + if issuer_name is not None: + self.issuer_name = issuer_name + + @property + def organization_id(self): + """ + Gets the organization_id of this InlineResponse200Keys. + Merchant Id + + :return: The organization_id of this InlineResponse200Keys. + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """ + Sets the organization_id of this InlineResponse200Keys. + Merchant Id + + :param organization_id: The organization_id of this InlineResponse200Keys. + :type: str + """ + + self._organization_id = organization_id + + @property + def merchant_name(self): + """ + Gets the merchant_name of this InlineResponse200Keys. + Merchant Name + + :return: The merchant_name of this InlineResponse200Keys. + :rtype: str + """ + return self._merchant_name + + @merchant_name.setter + def merchant_name(self, merchant_name): + """ + Sets the merchant_name of this InlineResponse200Keys. + Merchant Name + + :param merchant_name: The merchant_name of this InlineResponse200Keys. + :type: str + """ + + self._merchant_name = merchant_name + + @property + def key_id(self): + """ + Gets the key_id of this InlineResponse200Keys. + Key Id + + :return: The key_id of this InlineResponse200Keys. + :rtype: str + """ + return self._key_id + + @key_id.setter + def key_id(self, key_id): + """ + Sets the key_id of this InlineResponse200Keys. + Key Id + + :param key_id: The key_id of this InlineResponse200Keys. + :type: str + """ + + self._key_id = key_id + + @property + def key_type(self): + """ + Gets the key_type of this InlineResponse200Keys. + Key Type + + :return: The key_type of this InlineResponse200Keys. + :rtype: str + """ + return self._key_type + + @key_type.setter + def key_type(self, key_type): + """ + Sets the key_type of this InlineResponse200Keys. + Key Type + + :param key_type: The key_type of this InlineResponse200Keys. + :type: str + """ + + self._key_type = key_type + + @property + def status(self): + """ + Gets the status of this InlineResponse200Keys. + Status can be active/inactive + + :return: The status of this InlineResponse200Keys. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this InlineResponse200Keys. + Status can be active/inactive + + :param status: The status of this InlineResponse200Keys. + :type: str + """ + + self._status = status + + @property + def expiration_date(self): + """ + Gets the expiration_date of this InlineResponse200Keys. + Expiry Date. example - 2028-07-15 22:11:56 UTC + + :return: The expiration_date of this InlineResponse200Keys. + :rtype: date + """ + return self._expiration_date + + @expiration_date.setter + def expiration_date(self, expiration_date): + """ + Sets the expiration_date of this InlineResponse200Keys. + Expiry Date. example - 2028-07-15 22:11:56 UTC + + :param expiration_date: The expiration_date of this InlineResponse200Keys. + :type: date + """ + + self._expiration_date = expiration_date + + @property + def date_added(self): + """ + Gets the date_added of this InlineResponse200Keys. + Date Addded. example - 2018-04-25 22:11:56 UTC + + :return: The date_added of this InlineResponse200Keys. + :rtype: date + """ + return self._date_added + + @date_added.setter + def date_added(self, date_added): + """ + Sets the date_added of this InlineResponse200Keys. + Date Addded. example - 2018-04-25 22:11:56 UTC + + :param date_added: The date_added of this InlineResponse200Keys. + :type: date + """ + + self._date_added = date_added + + @property + def added_by(self): + """ + Gets the added_by of this InlineResponse200Keys. + Added By + + :return: The added_by of this InlineResponse200Keys. + :rtype: str + """ + return self._added_by + + @added_by.setter + def added_by(self, added_by): + """ + Sets the added_by of this InlineResponse200Keys. + Added By + + :param added_by: The added_by of this InlineResponse200Keys. + :type: str + """ + + self._added_by = added_by + + @property + def date_modified(self): + """ + Gets the date_modified of this InlineResponse200Keys. + Modified Date. + + :return: The date_modified of this InlineResponse200Keys. + :rtype: date + """ + return self._date_modified + + @date_modified.setter + def date_modified(self, date_modified): + """ + Sets the date_modified of this InlineResponse200Keys. + Modified Date. + + :param date_modified: The date_modified of this InlineResponse200Keys. + :type: date + """ + + self._date_modified = date_modified + + @property + def modified_by(self): + """ + Gets the modified_by of this InlineResponse200Keys. + Modified By + + :return: The modified_by of this InlineResponse200Keys. + :rtype: str + """ + return self._modified_by + + @modified_by.setter + def modified_by(self, modified_by): + """ + Sets the modified_by of this InlineResponse200Keys. + Modified By + + :param modified_by: The modified_by of this InlineResponse200Keys. + :type: str + """ + + self._modified_by = modified_by + + @property + def version(self): + """ + Gets the version of this InlineResponse200Keys. + Version + + :return: The version of this InlineResponse200Keys. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this InlineResponse200Keys. + Version + + :param version: The version of this InlineResponse200Keys. + :type: str + """ + + self._version = version + + @property + def serial_number(self): + """ + Gets the serial_number of this InlineResponse200Keys. + Serial Number + + :return: The serial_number of this InlineResponse200Keys. + :rtype: str + """ + return self._serial_number + + @serial_number.setter + def serial_number(self, serial_number): + """ + Sets the serial_number of this InlineResponse200Keys. + Serial Number + + :param serial_number: The serial_number of this InlineResponse200Keys. + :type: str + """ + + self._serial_number = serial_number + + @property + def issuer_name(self): + """ + Gets the issuer_name of this InlineResponse200Keys. + Issuer Name + + :return: The issuer_name of this InlineResponse200Keys. + :rtype: str + """ + return self._issuer_name + + @issuer_name.setter + def issuer_name(self, issuer_name): + """ + Sets the issuer_name of this InlineResponse200Keys. + Issuer Name + + :param issuer_name: The issuer_name of this InlineResponse200Keys. + :type: str + """ + + self._issuer_name = issuer_name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse200Keys): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response_400_3.py b/CyberSource/models/inline_response_400_3.py index 171b0d6c..85216cec 100644 --- a/CyberSource/models/inline_response_400_3.py +++ b/CyberSource/models/inline_response_400_3.py @@ -31,108 +31,117 @@ class InlineResponse4003(object): and the value is json key in definition. """ swagger_types = { - 'correlation_id': 'str', - 'details': 'list[InlineResponse4003Details]', - 'information_link': 'str', + 'submit_time_utc': 'str', + 'status': 'str', + 'reason': 'str', 'message': 'str', - 'reason': 'str' + 'details': 'list[PtsV2PaymentsPost201ResponseErrorInformationDetails]' } attribute_map = { - 'correlation_id': 'correlationId', - 'details': 'details', - 'information_link': 'informationLink', + 'submit_time_utc': 'submitTimeUtc', + 'status': 'status', + 'reason': 'reason', 'message': 'message', - 'reason': 'reason' + 'details': 'details' } - def __init__(self, correlation_id=None, details=None, information_link=None, message=None, reason=None): + def __init__(self, submit_time_utc=None, status=None, reason=None, message=None, details=None): """ InlineResponse4003 - a model defined in Swagger """ - self._correlation_id = None - self._details = None - self._information_link = None - self._message = None + self._submit_time_utc = None + self._status = None self._reason = None + self._message = None + self._details = None - if correlation_id is not None: - self.correlation_id = correlation_id + if submit_time_utc is not None: + self.submit_time_utc = submit_time_utc + if status is not None: + self.status = status + if reason is not None: + self.reason = reason + if message is not None: + self.message = message if details is not None: self.details = details - if information_link is not None: - self.information_link = information_link - self.message = message - self.reason = reason @property - def correlation_id(self): + def submit_time_utc(self): """ - Gets the correlation_id of this InlineResponse4003. + Gets the submit_time_utc of this InlineResponse4003. + Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. - :return: The correlation_id of this InlineResponse4003. + :return: The submit_time_utc of this InlineResponse4003. :rtype: str """ - return self._correlation_id + return self._submit_time_utc - @correlation_id.setter - def correlation_id(self, correlation_id): + @submit_time_utc.setter + def submit_time_utc(self, submit_time_utc): """ - Sets the correlation_id of this InlineResponse4003. + Sets the submit_time_utc of this InlineResponse4003. + Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. - :param correlation_id: The correlation_id of this InlineResponse4003. + :param submit_time_utc: The submit_time_utc of this InlineResponse4003. :type: str """ - self._correlation_id = correlation_id + self._submit_time_utc = submit_time_utc @property - def details(self): + def status(self): """ - Gets the details of this InlineResponse4003. + Gets the status of this InlineResponse4003. + The status of the submitted transaction. Possible values: - INVALID_REQUEST - :return: The details of this InlineResponse4003. - :rtype: list[InlineResponse4003Details] + :return: The status of this InlineResponse4003. + :rtype: str """ - return self._details + return self._status - @details.setter - def details(self, details): + @status.setter + def status(self, status): """ - Sets the details of this InlineResponse4003. + Sets the status of this InlineResponse4003. + The status of the submitted transaction. Possible values: - INVALID_REQUEST - :param details: The details of this InlineResponse4003. - :type: list[InlineResponse4003Details] + :param status: The status of this InlineResponse4003. + :type: str """ - self._details = details + self._status = status @property - def information_link(self): + def reason(self): """ - Gets the information_link of this InlineResponse4003. + Gets the reason of this InlineResponse4003. + The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - :return: The information_link of this InlineResponse4003. + :return: The reason of this InlineResponse4003. :rtype: str """ - return self._information_link + return self._reason - @information_link.setter - def information_link(self, information_link): + @reason.setter + def reason(self, reason): """ - Sets the information_link of this InlineResponse4003. + Sets the reason of this InlineResponse4003. + The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - :param information_link: The information_link of this InlineResponse4003. + :param reason: The reason of this InlineResponse4003. :type: str """ - self._information_link = information_link + self._reason = reason @property def message(self): """ Gets the message of this InlineResponse4003. + The detail message related to the status and reason listed above. :return: The message of this InlineResponse4003. :rtype: str @@ -143,43 +152,34 @@ def message(self): def message(self, message): """ Sets the message of this InlineResponse4003. + The detail message related to the status and reason listed above. :param message: The message of this InlineResponse4003. :type: str """ - if message is None: - raise ValueError("Invalid value for `message`, must not be `None`") self._message = message @property - def reason(self): + def details(self): """ - Gets the reason of this InlineResponse4003. + Gets the details of this InlineResponse4003. - :return: The reason of this InlineResponse4003. - :rtype: str + :return: The details of this InlineResponse4003. + :rtype: list[PtsV2PaymentsPost201ResponseErrorInformationDetails] """ - return self._reason + return self._details - @reason.setter - def reason(self, reason): + @details.setter + def details(self, details): """ - Sets the reason of this InlineResponse4003. + Sets the details of this InlineResponse4003. - :param reason: The reason of this InlineResponse4003. - :type: str + :param details: The details of this InlineResponse4003. + :type: list[PtsV2PaymentsPost201ResponseErrorInformationDetails] """ - if reason is None: - raise ValueError("Invalid value for `reason`, must not be `None`") - allowed_values = ["INVALID_APIKEY", "INVALID_SHIPPING_INPUT_PARAMS", "CAPTURE_CONTEXT_INVALID", "CAPTURE_CONTEXT_EXPIRED", "SDK_XHR_ERROR", "UNIFIEDPAYMENTS_VALIDATION_PARAMS", "UNIFIEDPAYMENTS_VALIDATION_FIELDS", "UNIFIEDPAYMENT_PAYMENT_PARAMITERS", "CREATE_TOKEN_TIMEOUT", "CREATE_TOKEN_XHR_ERROR", "SHOW_LOAD_CONTAINER_SELECTOR", "SHOW_LOAD_INVALID_CONTAINER", "SHOW_TOKEN_TIMEOUT", "SHOW_TOKEN_XHR_ERROR", "SHOW_PAYMENT_TIMEOUT"] - if reason not in allowed_values: - raise ValueError( - "Invalid value for `reason` ({0}), must be one of {1}" - .format(reason, allowed_values) - ) - self._reason = reason + self._details = details def to_dict(self): """ diff --git a/CyberSource/models/inline_response_400_4.py b/CyberSource/models/inline_response_400_4.py new file mode 100644 index 00000000..40da47b9 --- /dev/null +++ b/CyberSource/models/inline_response_400_4.py @@ -0,0 +1,235 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse4004(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'correlation_id': 'str', + 'details': 'list[InlineResponse4004Details]', + 'information_link': 'str', + 'message': 'str', + 'reason': 'str' + } + + attribute_map = { + 'correlation_id': 'correlationId', + 'details': 'details', + 'information_link': 'informationLink', + 'message': 'message', + 'reason': 'reason' + } + + def __init__(self, correlation_id=None, details=None, information_link=None, message=None, reason=None): + """ + InlineResponse4004 - a model defined in Swagger + """ + + self._correlation_id = None + self._details = None + self._information_link = None + self._message = None + self._reason = None + + if correlation_id is not None: + self.correlation_id = correlation_id + if details is not None: + self.details = details + if information_link is not None: + self.information_link = information_link + self.message = message + self.reason = reason + + @property + def correlation_id(self): + """ + Gets the correlation_id of this InlineResponse4004. + + :return: The correlation_id of this InlineResponse4004. + :rtype: str + """ + return self._correlation_id + + @correlation_id.setter + def correlation_id(self, correlation_id): + """ + Sets the correlation_id of this InlineResponse4004. + + :param correlation_id: The correlation_id of this InlineResponse4004. + :type: str + """ + + self._correlation_id = correlation_id + + @property + def details(self): + """ + Gets the details of this InlineResponse4004. + + :return: The details of this InlineResponse4004. + :rtype: list[InlineResponse4004Details] + """ + return self._details + + @details.setter + def details(self, details): + """ + Sets the details of this InlineResponse4004. + + :param details: The details of this InlineResponse4004. + :type: list[InlineResponse4004Details] + """ + + self._details = details + + @property + def information_link(self): + """ + Gets the information_link of this InlineResponse4004. + + :return: The information_link of this InlineResponse4004. + :rtype: str + """ + return self._information_link + + @information_link.setter + def information_link(self, information_link): + """ + Sets the information_link of this InlineResponse4004. + + :param information_link: The information_link of this InlineResponse4004. + :type: str + """ + + self._information_link = information_link + + @property + def message(self): + """ + Gets the message of this InlineResponse4004. + + :return: The message of this InlineResponse4004. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this InlineResponse4004. + + :param message: The message of this InlineResponse4004. + :type: str + """ + if message is None: + raise ValueError("Invalid value for `message`, must not be `None`") + + self._message = message + + @property + def reason(self): + """ + Gets the reason of this InlineResponse4004. + + :return: The reason of this InlineResponse4004. + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """ + Sets the reason of this InlineResponse4004. + + :param reason: The reason of this InlineResponse4004. + :type: str + """ + if reason is None: + raise ValueError("Invalid value for `reason`, must not be `None`") + allowed_values = ["INVALID_APIKEY", "INVALID_SHIPPING_INPUT_PARAMS", "CAPTURE_CONTEXT_INVALID", "CAPTURE_CONTEXT_EXPIRED", "SDK_XHR_ERROR", "UNIFIEDPAYMENTS_VALIDATION_PARAMS", "UNIFIEDPAYMENTS_VALIDATION_FIELDS", "UNIFIEDPAYMENT_PAYMENT_PARAMITERS", "CREATE_TOKEN_TIMEOUT", "CREATE_TOKEN_XHR_ERROR", "SHOW_LOAD_CONTAINER_SELECTOR", "SHOW_LOAD_INVALID_CONTAINER", "SHOW_TOKEN_TIMEOUT", "SHOW_TOKEN_XHR_ERROR", "SHOW_PAYMENT_TIMEOUT"] + if reason not in allowed_values: + raise ValueError( + "Invalid value for `reason` ({0}), must be one of {1}" + .format(reason, allowed_values) + ) + + self._reason = reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse4004): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response_400_3_details.py b/CyberSource/models/inline_response_400_4_details.py similarity index 82% rename from CyberSource/models/inline_response_400_3_details.py rename to CyberSource/models/inline_response_400_4_details.py index eda6a467..93a3a391 100644 --- a/CyberSource/models/inline_response_400_3_details.py +++ b/CyberSource/models/inline_response_400_4_details.py @@ -16,7 +16,7 @@ import re -class InlineResponse4003Details(object): +class InlineResponse4004Details(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -42,7 +42,7 @@ class InlineResponse4003Details(object): def __init__(self, location=None, message=None): """ - InlineResponse4003Details - a model defined in Swagger + InlineResponse4004Details - a model defined in Swagger """ self._location = None @@ -56,9 +56,9 @@ def __init__(self, location=None, message=None): @property def location(self): """ - Gets the location of this InlineResponse4003Details. + Gets the location of this InlineResponse4004Details. - :return: The location of this InlineResponse4003Details. + :return: The location of this InlineResponse4004Details. :rtype: str """ return self._location @@ -66,9 +66,9 @@ def location(self): @location.setter def location(self, location): """ - Sets the location of this InlineResponse4003Details. + Sets the location of this InlineResponse4004Details. - :param location: The location of this InlineResponse4003Details. + :param location: The location of this InlineResponse4004Details. :type: str """ @@ -77,9 +77,9 @@ def location(self, location): @property def message(self): """ - Gets the message of this InlineResponse4003Details. + Gets the message of this InlineResponse4004Details. - :return: The message of this InlineResponse4003Details. + :return: The message of this InlineResponse4004Details. :rtype: str """ return self._message @@ -87,9 +87,9 @@ def message(self): @message.setter def message(self, message): """ - Sets the message of this InlineResponse4003Details. + Sets the message of this InlineResponse4004Details. - :param message: The message of this InlineResponse4003Details. + :param message: The message of this InlineResponse4004Details. :type: str """ @@ -137,7 +137,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse4003Details): + if not isinstance(other, InlineResponse4004Details): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response_500.py b/CyberSource/models/inline_response_500.py new file mode 100644 index 00000000..89fca744 --- /dev/null +++ b/CyberSource/models/inline_response_500.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse500(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'submit_time_utc': 'str', + 'status': 'str', + 'reason': 'str', + 'message': 'str' + } + + attribute_map = { + 'submit_time_utc': 'submitTimeUtc', + 'status': 'status', + 'reason': 'reason', + 'message': 'message' + } + + def __init__(self, submit_time_utc=None, status=None, reason=None, message=None): + """ + InlineResponse500 - a model defined in Swagger + """ + + self._submit_time_utc = None + self._status = None + self._reason = None + self._message = None + + if submit_time_utc is not None: + self.submit_time_utc = submit_time_utc + if status is not None: + self.status = status + if reason is not None: + self.reason = reason + if message is not None: + self.message = message + + @property + def submit_time_utc(self): + """ + Gets the submit_time_utc of this InlineResponse500. + Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. + + :return: The submit_time_utc of this InlineResponse500. + :rtype: str + """ + return self._submit_time_utc + + @submit_time_utc.setter + def submit_time_utc(self, submit_time_utc): + """ + Sets the submit_time_utc of this InlineResponse500. + Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. + + :param submit_time_utc: The submit_time_utc of this InlineResponse500. + :type: str + """ + + self._submit_time_utc = submit_time_utc + + @property + def status(self): + """ + Gets the status of this InlineResponse500. + The status of the submitted request. Possible values: - SERVER_ERROR + + :return: The status of this InlineResponse500. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this InlineResponse500. + The status of the submitted request. Possible values: - SERVER_ERROR + + :param status: The status of this InlineResponse500. + :type: str + """ + + self._status = status + + @property + def reason(self): + """ + Gets the reason of this InlineResponse500. + The reason of the status. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT + + :return: The reason of this InlineResponse500. + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """ + Sets the reason of this InlineResponse500. + The reason of the status. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT + + :param reason: The reason of this InlineResponse500. + :type: str + """ + + self._reason = reason + + @property + def message(self): + """ + Gets the message of this InlineResponse500. + The detail message related to the status and reason listed above. + + :return: The message of this InlineResponse500. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this InlineResponse500. + The detail message related to the status and reason listed above. + + :param message: The message of this InlineResponse500. + :type: str + """ + + self._message = message + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse500): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/ptsv2payments_merchant_information.py b/CyberSource/models/ptsv2payments_merchant_information.py index 59af35b0..0c5a3f85 100644 --- a/CyberSource/models/ptsv2payments_merchant_information.py +++ b/CyberSource/models/ptsv2payments_merchant_information.py @@ -416,7 +416,7 @@ def failure_url(self, failure_url): def merchant_name(self): """ Gets the merchant_name of this Ptsv2paymentsMerchantInformation. - Use this field only if you are requesting payment with Payer Authentication serice together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank. + Use this field only if you are requesting payment with Payer Authentication service together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank. :return: The merchant_name of this Ptsv2paymentsMerchantInformation. :rtype: str @@ -427,7 +427,7 @@ def merchant_name(self): def merchant_name(self, merchant_name): """ Sets the merchant_name of this Ptsv2paymentsMerchantInformation. - Use this field only if you are requesting payment with Payer Authentication serice together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank. + Use this field only if you are requesting payment with Payer Authentication service together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank. :param merchant_name: The merchant_name of this Ptsv2paymentsMerchantInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_payment_information.py b/CyberSource/models/ptsv2payments_payment_information.py index acb4054f..1257c971 100644 --- a/CyberSource/models/ptsv2payments_payment_information.py +++ b/CyberSource/models/ptsv2payments_payment_information.py @@ -317,7 +317,7 @@ def payment_type(self, payment_type): def initiation_channel(self): """ Gets the initiation_channel of this Ptsv2paymentsPaymentInformation. - Mastercard-defined code that indicates how the account information was obtained. - `00` (default): Card - `01`: Removable secure element that is personalized for use with a mobile phone and controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC) - `02`: Key fob - `03`: Watch - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone with a non-removable, secure element that is controlled by the wireless service provider; for example, code division multiple access (CDMA) - `08`: Removable secure element that is personalized for use with a mobile phone and not controlled by the wireless service provider; example: memory card - `09`: Mobile phone with a non-removable, secure element that is not controlled by the wireless service provider - `10`: Removable secure element that is personalized for use with a tablet or e-book and is controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC) - `11`: Tablet or e-book with a non-removable, secure element that is controlled by the wireless service provider - `12`: Removable secure element that is personalized for use with a tablet or e-book and is not controlled by the wireless service provider - `13`: Tablet or e-book with a non-removable, secure element that is not controlled by the wireless service provider This field is supported only for Mastercard on CyberSource through VisaNet. #### Used by **Authorization** Optional field. + Mastercard-defined code that indicates how the account information was obtained. - `00`: Card - `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone - `02`: Key fob - `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA) - `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO - `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book - `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO - `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book - `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO - `14`: Mobile phone or smartphone with a payment application running in a host processor - `15`: Tablet or e-book with a payment application running in a host processor - `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor - `17`: Tablet or e-book with a payment application running in the TEE of a host processor - `18`: Watch with a payment application running in the TEE of a host processor - `19`: Watch with a payment application running in a host processor Values from 20–99 exclusively indicate the form factor only without also indicating the storage technology - `20`: Card - `21`: Phone e.g. Mobile Phone - `22`: Tablet/e-reader - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band - `24`: Sticker - `25`: PC - `26`: Device Peripheral e.g. mobile phone case or sleeve - `27`: Tag e.g. key fob or mobile tag - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links - `29`: Fashion Accessory e.g. handbag, bag charm and glasses - `30`: Garment e.g. dress - `31`: Domestic Appliance e.g refrigerator, washing machine - `32`: Vehicle e.g. vehicle, including vehicle attached devices - `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television 34–99 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice. This field is supported only for Mastercard on CyberSource through VisaNet. When initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support. #### Used by **Authorization** Optional field. :return: The initiation_channel of this Ptsv2paymentsPaymentInformation. :rtype: str @@ -328,7 +328,7 @@ def initiation_channel(self): def initiation_channel(self, initiation_channel): """ Sets the initiation_channel of this Ptsv2paymentsPaymentInformation. - Mastercard-defined code that indicates how the account information was obtained. - `00` (default): Card - `01`: Removable secure element that is personalized for use with a mobile phone and controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC) - `02`: Key fob - `03`: Watch - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone with a non-removable, secure element that is controlled by the wireless service provider; for example, code division multiple access (CDMA) - `08`: Removable secure element that is personalized for use with a mobile phone and not controlled by the wireless service provider; example: memory card - `09`: Mobile phone with a non-removable, secure element that is not controlled by the wireless service provider - `10`: Removable secure element that is personalized for use with a tablet or e-book and is controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC) - `11`: Tablet or e-book with a non-removable, secure element that is controlled by the wireless service provider - `12`: Removable secure element that is personalized for use with a tablet or e-book and is not controlled by the wireless service provider - `13`: Tablet or e-book with a non-removable, secure element that is not controlled by the wireless service provider This field is supported only for Mastercard on CyberSource through VisaNet. #### Used by **Authorization** Optional field. + Mastercard-defined code that indicates how the account information was obtained. - `00`: Card - `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone - `02`: Key fob - `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA) - `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO - `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book - `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO - `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book - `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO - `14`: Mobile phone or smartphone with a payment application running in a host processor - `15`: Tablet or e-book with a payment application running in a host processor - `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor - `17`: Tablet or e-book with a payment application running in the TEE of a host processor - `18`: Watch with a payment application running in the TEE of a host processor - `19`: Watch with a payment application running in a host processor Values from 20–99 exclusively indicate the form factor only without also indicating the storage technology - `20`: Card - `21`: Phone e.g. Mobile Phone - `22`: Tablet/e-reader - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band - `24`: Sticker - `25`: PC - `26`: Device Peripheral e.g. mobile phone case or sleeve - `27`: Tag e.g. key fob or mobile tag - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links - `29`: Fashion Accessory e.g. handbag, bag charm and glasses - `30`: Garment e.g. dress - `31`: Domestic Appliance e.g refrigerator, washing machine - `32`: Vehicle e.g. vehicle, including vehicle attached devices - `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television 34–99 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice. This field is supported only for Mastercard on CyberSource through VisaNet. When initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support. #### Used by **Authorization** Optional field. :param initiation_channel: The initiation_channel of this Ptsv2paymentsPaymentInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_payment_information_payment_type.py b/CyberSource/models/ptsv2payments_payment_information_payment_type.py index aeb4804c..58611eb3 100644 --- a/CyberSource/models/ptsv2payments_payment_information_payment_type.py +++ b/CyberSource/models/ptsv2payments_payment_information_payment_type.py @@ -62,7 +62,7 @@ def __init__(self, name=None, sub_type_name=None, method=None): def name(self): """ Gets the name of this Ptsv2paymentsPaymentInformationPaymentType. - A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) + A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank) :return: The name of this Ptsv2paymentsPaymentInformationPaymentType. :rtype: str @@ -73,7 +73,7 @@ def name(self): def name(self, name): """ Sets the name of this Ptsv2paymentsPaymentInformationPaymentType. - A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) + A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank) :param name: The name of this Ptsv2paymentsPaymentInformationPaymentType. :type: str diff --git a/CyberSource/models/ptsv2payments_payment_information_payment_type_method.py b/CyberSource/models/ptsv2payments_payment_information_payment_type_method.py index d95e39e2..596bd037 100644 --- a/CyberSource/models/ptsv2payments_payment_information_payment_type_method.py +++ b/CyberSource/models/ptsv2payments_payment_information_payment_type_method.py @@ -52,7 +52,7 @@ def __init__(self, name=None): def name(self): """ Gets the name of this Ptsv2paymentsPaymentInformationPaymentTypeMethod. - A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data + A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data :return: The name of this Ptsv2paymentsPaymentInformationPaymentTypeMethod. :rtype: str @@ -63,7 +63,7 @@ def name(self): def name(self, name): """ Sets the name of this Ptsv2paymentsPaymentInformationPaymentTypeMethod. - A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data + A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data :param name: The name of this Ptsv2paymentsPaymentInformationPaymentTypeMethod. :type: str diff --git a/CyberSource/models/ptsv2payments_point_of_sale_information.py b/CyberSource/models/ptsv2payments_point_of_sale_information.py index 8e81e7bf..eac4ad2f 100644 --- a/CyberSource/models/ptsv2payments_point_of_sale_information.py +++ b/CyberSource/models/ptsv2payments_point_of_sale_information.py @@ -816,7 +816,7 @@ def terminal_make(self, terminal_make): def service_code(self): """ Gets the service_code of this Ptsv2paymentsPointOfSaleInformation. - #### Visa Platform Connect Mastercard service code that is included in the track data. You can extract the service code from the track data and provide it in this API field. This field is supported only for Mastercard on Visa Platform Connect. + #### Visa Platform Connect Mastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. You can extract the service code from the track data and provide it in this API field. When not provided it will be extracted from: - Track2Data for MSR transactions - EMV tag 5F30 for EMV transactions To enable this feature please call support. :return: The service_code of this Ptsv2paymentsPointOfSaleInformation. :rtype: str @@ -827,7 +827,7 @@ def service_code(self): def service_code(self, service_code): """ Sets the service_code of this Ptsv2paymentsPointOfSaleInformation. - #### Visa Platform Connect Mastercard service code that is included in the track data. You can extract the service code from the track data and provide it in this API field. This field is supported only for Mastercard on Visa Platform Connect. + #### Visa Platform Connect Mastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. You can extract the service code from the track data and provide it in this API field. When not provided it will be extracted from: - Track2Data for MSR transactions - EMV tag 5F30 for EMV transactions To enable this feature please call support. :param service_code: The service_code of this Ptsv2paymentsPointOfSaleInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_point_of_sale_information_emv.py b/CyberSource/models/ptsv2payments_point_of_sale_information_emv.py index 27b510b4..ef19fcbc 100644 --- a/CyberSource/models/ptsv2payments_point_of_sale_information_emv.py +++ b/CyberSource/models/ptsv2payments_point_of_sale_information_emv.py @@ -123,7 +123,7 @@ def cardholder_verification_method_used(self, cardholder_verification_method_use def card_sequence_number(self): """ Gets the card_sequence_number of this Ptsv2paymentsPointOfSaleInformationEmv. - Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International + Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. When sequence number is not provided via this API field, the value is extracted from EMV tag 5F34 for Mastercard transactions. To enable this feature please call support. **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International :return: The card_sequence_number of this Ptsv2paymentsPointOfSaleInformationEmv. :rtype: str @@ -134,7 +134,7 @@ def card_sequence_number(self): def card_sequence_number(self, card_sequence_number): """ Sets the card_sequence_number of this Ptsv2paymentsPointOfSaleInformationEmv. - Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International + Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. When sequence number is not provided via this API field, the value is extracted from EMV tag 5F34 for Mastercard transactions. To enable this feature please call support. **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International :param card_sequence_number: The card_sequence_number of this Ptsv2paymentsPointOfSaleInformationEmv. :type: str diff --git a/CyberSource/models/ptsv2payments_processing_information_purchase_options.py b/CyberSource/models/ptsv2payments_processing_information_purchase_options.py index ef153811..f9de6725 100644 --- a/CyberSource/models/ptsv2payments_processing_information_purchase_options.py +++ b/CyberSource/models/ptsv2payments_processing_information_purchase_options.py @@ -80,7 +80,7 @@ def is_electronic_benefits_transfer(self, is_electronic_benefits_transfer): def type(self): """ Gets the type of this Ptsv2paymentsProcessingInformationPurchaseOptions. - Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. + Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. - `BUY` - `RENT` - `BOOK` - `SUBSCRIBE` - `DOWNLOAD` - `ORDER` - `CONTINUE` #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. :return: The type of this Ptsv2paymentsProcessingInformationPurchaseOptions. :rtype: str @@ -91,7 +91,7 @@ def type(self): def type(self, type): """ Sets the type of this Ptsv2paymentsProcessingInformationPurchaseOptions. - Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. + Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. - `BUY` - `RENT` - `BOOK` - `SUBSCRIBE` - `DOWNLOAD` - `ORDER` - `CONTINUE` #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. :param type: The type of this Ptsv2paymentsProcessingInformationPurchaseOptions. :type: str diff --git a/CyberSource/models/tss_v2_transactions_get200_response_payment_information_payment_type.py b/CyberSource/models/tss_v2_transactions_get200_response_payment_information_payment_type.py index 41463e89..94ce6ac4 100644 --- a/CyberSource/models/tss_v2_transactions_get200_response_payment_information_payment_type.py +++ b/CyberSource/models/tss_v2_transactions_get200_response_payment_information_payment_type.py @@ -62,7 +62,7 @@ def __init__(self, name=None, type=None, method=None): def name(self): """ Gets the name of this TssV2TransactionsGet200ResponsePaymentInformationPaymentType. - A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) + A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank) :return: The name of this TssV2TransactionsGet200ResponsePaymentInformationPaymentType. :rtype: str @@ -73,7 +73,7 @@ def name(self): def name(self, name): """ Sets the name of this TssV2TransactionsGet200ResponsePaymentInformationPaymentType. - A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) + A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank) :param name: The name of this TssV2TransactionsGet200ResponsePaymentInformationPaymentType. :type: str diff --git a/CyberSource/models/tss_v2_transactions_post201_response.py b/CyberSource/models/tss_v2_transactions_post201_response.py index 097e7d9d..e076c18c 100644 --- a/CyberSource/models/tss_v2_transactions_post201_response.py +++ b/CyberSource/models/tss_v2_transactions_post201_response.py @@ -255,7 +255,7 @@ def offset(self, offset): def limit(self): """ Gets the limit of this TssV2TransactionsPost201Response. - Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. + Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. :return: The limit of this TssV2TransactionsPost201Response. :rtype: int @@ -266,7 +266,7 @@ def limit(self): def limit(self, limit): """ Sets the limit of this TssV2TransactionsPost201Response. - Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. + Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. :param limit: The limit of this TssV2TransactionsPost201Response. :type: int diff --git a/CyberSource/models/update_asym_keys_request.py b/CyberSource/models/update_asym_keys_request.py new file mode 100644 index 00000000..aa3267ba --- /dev/null +++ b/CyberSource/models/update_asym_keys_request.py @@ -0,0 +1,155 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UpdateAsymKeysRequest(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'status': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'status': 'status', + 'organization_id': 'organizationId' + } + + def __init__(self, status=None, organization_id=None): + """ + UpdateAsymKeysRequest - a model defined in Swagger + """ + + self._status = None + self._organization_id = None + + self.status = status + self.organization_id = organization_id + + @property + def status(self): + """ + Gets the status of this UpdateAsymKeysRequest. + Status can be active/inactive + + :return: The status of this UpdateAsymKeysRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UpdateAsymKeysRequest. + Status can be active/inactive + + :param status: The status of this UpdateAsymKeysRequest. + :type: str + """ + if status is None: + raise ValueError("Invalid value for `status`, must not be `None`") + + self._status = status + + @property + def organization_id(self): + """ + Gets the organization_id of this UpdateAsymKeysRequest. + Organization Id + + :return: The organization_id of this UpdateAsymKeysRequest. + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """ + Sets the organization_id of this UpdateAsymKeysRequest. + Organization Id + + :param organization_id: The organization_id of this UpdateAsymKeysRequest. + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") + + self._organization_id = organization_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UpdateAsymKeysRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/update_password_keys_request.py b/CyberSource/models/update_password_keys_request.py new file mode 100644 index 00000000..b30116b9 --- /dev/null +++ b/CyberSource/models/update_password_keys_request.py @@ -0,0 +1,155 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UpdatePasswordKeysRequest(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'status': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'status': 'status', + 'organization_id': 'organizationId' + } + + def __init__(self, status=None, organization_id=None): + """ + UpdatePasswordKeysRequest - a model defined in Swagger + """ + + self._status = None + self._organization_id = None + + self.status = status + self.organization_id = organization_id + + @property + def status(self): + """ + Gets the status of this UpdatePasswordKeysRequest. + Status can be active/inactive + + :return: The status of this UpdatePasswordKeysRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UpdatePasswordKeysRequest. + Status can be active/inactive + + :param status: The status of this UpdatePasswordKeysRequest. + :type: str + """ + if status is None: + raise ValueError("Invalid value for `status`, must not be `None`") + + self._status = status + + @property + def organization_id(self): + """ + Gets the organization_id of this UpdatePasswordKeysRequest. + Organization Id + + :return: The organization_id of this UpdatePasswordKeysRequest. + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """ + Sets the organization_id of this UpdatePasswordKeysRequest. + Organization Id + + :param organization_id: The organization_id of this UpdatePasswordKeysRequest. + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") + + self._organization_id = organization_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UpdatePasswordKeysRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/update_pgp_keys_request.py b/CyberSource/models/update_pgp_keys_request.py new file mode 100644 index 00000000..9b9be311 --- /dev/null +++ b/CyberSource/models/update_pgp_keys_request.py @@ -0,0 +1,155 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UpdatePGPKeysRequest(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'status': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'status': 'status', + 'organization_id': 'organizationId' + } + + def __init__(self, status=None, organization_id=None): + """ + UpdatePGPKeysRequest - a model defined in Swagger + """ + + self._status = None + self._organization_id = None + + self.status = status + self.organization_id = organization_id + + @property + def status(self): + """ + Gets the status of this UpdatePGPKeysRequest. + Status can be active/inactive + + :return: The status of this UpdatePGPKeysRequest. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UpdatePGPKeysRequest. + Status can be active/inactive + + :param status: The status of this UpdatePGPKeysRequest. + :type: str + """ + if status is None: + raise ValueError("Invalid value for `status`, must not be `None`") + + self._status = status + + @property + def organization_id(self): + """ + Gets the organization_id of this UpdatePGPKeysRequest. + Organization Id + + :return: The organization_id of this UpdatePGPKeysRequest. + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """ + Sets the organization_id of this UpdatePGPKeysRequest. + Organization Id + + :param organization_id: The organization_id of this UpdatePGPKeysRequest. + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") + + self._organization_id = organization_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UpdatePGPKeysRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/update_pgp_keys_request_1.py b/CyberSource/models/update_pgp_keys_request_1.py new file mode 100644 index 00000000..5aacb8ca --- /dev/null +++ b/CyberSource/models/update_pgp_keys_request_1.py @@ -0,0 +1,237 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UpdatePGPKeysRequest1(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'status': 'str', + 'expiration_date': 'str', + 'version': 'str', + 'comment': 'str' + } + + attribute_map = { + 'organization_id': 'organizationId', + 'status': 'status', + 'expiration_date': 'expirationDate', + 'version': 'version', + 'comment': 'comment' + } + + def __init__(self, organization_id=None, status=None, expiration_date=None, version=None, comment=None): + """ + UpdatePGPKeysRequest1 - a model defined in Swagger + """ + + self._organization_id = None + self._status = None + self._expiration_date = None + self._version = None + self._comment = None + + if organization_id is not None: + self.organization_id = organization_id + if status is not None: + self.status = status + if expiration_date is not None: + self.expiration_date = expiration_date + if version is not None: + self.version = version + if comment is not None: + self.comment = comment + + @property + def organization_id(self): + """ + Gets the organization_id of this UpdatePGPKeysRequest1. + Organization Id + + :return: The organization_id of this UpdatePGPKeysRequest1. + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """ + Sets the organization_id of this UpdatePGPKeysRequest1. + Organization Id + + :param organization_id: The organization_id of this UpdatePGPKeysRequest1. + :type: str + """ + + self._organization_id = organization_id + + @property + def status(self): + """ + Gets the status of this UpdatePGPKeysRequest1. + Only inactive status is applicable for SCMP_API. Only status as inactive needs to be provided to deactivate scmp. + + :return: The status of this UpdatePGPKeysRequest1. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UpdatePGPKeysRequest1. + Only inactive status is applicable for SCMP_API. Only status as inactive needs to be provided to deactivate scmp. + + :param status: The status of this UpdatePGPKeysRequest1. + :type: str + """ + + self._status = status + + @property + def expiration_date(self): + """ + Gets the expiration_date of this UpdatePGPKeysRequest1. + Expiration Date. Required field to update the SCMP_API key + + :return: The expiration_date of this UpdatePGPKeysRequest1. + :rtype: str + """ + return self._expiration_date + + @expiration_date.setter + def expiration_date(self, expiration_date): + """ + Sets the expiration_date of this UpdatePGPKeysRequest1. + Expiration Date. Required field to update the SCMP_API key + + :param expiration_date: The expiration_date of this UpdatePGPKeysRequest1. + :type: str + """ + + self._expiration_date = expiration_date + + @property + def version(self): + """ + Gets the version of this UpdatePGPKeysRequest1. + Version. Required field to update the SCMP_API key + + :return: The version of this UpdatePGPKeysRequest1. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this UpdatePGPKeysRequest1. + Version. Required field to update the SCMP_API key + + :param version: The version of this UpdatePGPKeysRequest1. + :type: str + """ + + self._version = version + + @property + def comment(self): + """ + Gets the comment of this UpdatePGPKeysRequest1. + Comment. Optional field. Can be provided along with Expiration Date and Version + + :return: The comment of this UpdatePGPKeysRequest1. + :rtype: str + """ + return self._comment + + @comment.setter + def comment(self, comment): + """ + Sets the comment of this UpdatePGPKeysRequest1. + Comment. Optional field. Can be provided along with Expiration Date and Version + + :param comment: The comment of this UpdatePGPKeysRequest1. + :type: str + """ + + self._comment = comment + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UpdatePGPKeysRequest1): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/docs/AsymmetricKeyManagementApi.md b/docs/AsymmetricKeyManagementApi.md index 997e85d8..4b63e40f 100644 --- a/docs/AsymmetricKeyManagementApi.md +++ b/docs/AsymmetricKeyManagementApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**create_p12_keys**](AsymmetricKeyManagementApi.md#create_p12_keys) | **POST** /kms/v2/keys-asym | Create one or more PKCS12 keys [**delete_bulk_p12_keys**](AsymmetricKeyManagementApi.md#delete_bulk_p12_keys) | **POST** /kms/v2/keys-asym/deletes | Delete one or more PKCS12 keys [**get_p12_key_details**](AsymmetricKeyManagementApi.md#get_p12_key_details) | **GET** /kms/v2/keys-asym/{keyId} | Retrieves PKCS12 key details +[**update_asym_key**](AsymmetricKeyManagementApi.md#update_asym_key) | **PATCH** /kms/v2/keys-asym/{keyId} | Activate or De-activate Asymmetric Key # **create_p12_keys** @@ -153,3 +154,53 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **update_asym_key** +> object update_asym_key(key_id, update_asym_keys_request) + +Activate or De-activate Asymmetric Key + +Activate or De-activate Asymmetric Key + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.AsymmetricKeyManagementApi() +key_id = 'key_id_example' # str | Key ID. +update_asym_keys_request = CyberSource.UpdateAsymKeysRequest() # UpdateAsymKeysRequest | + +try: + # Activate or De-activate Asymmetric Key + api_response = api_instance.update_asym_key(key_id, update_asym_keys_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling AsymmetricKeyManagementApi->update_asym_key: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **key_id** | **str**| Key ID. | + **update_asym_keys_request** | [**UpdateAsymKeysRequest**](UpdateAsymKeysRequest.md)| | + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CreateSearchRequest.md b/docs/CreateSearchRequest.md index 7d0f9d75..b2041654 100644 --- a/docs/CreateSearchRequest.md +++ b/docs/CreateSearchRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **timezone** | **str** | Merchant’s time zone in ISO standard, using the TZ database format. For example: `America/Chicago` | [optional] **query** | **str** | String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide. | [optional] **offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] -**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. | [optional] +**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] **sort** | **str** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse200.md b/docs/InlineResponse200.md new file mode 100644 index 00000000..0cc3b301 --- /dev/null +++ b/docs/InlineResponse200.md @@ -0,0 +1,15 @@ +# InlineResponse200 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**total_count** | **int** | Specifies the total number of items found based on the request | [optional] +**offset** | **int** | Specifies the record offset from the records are returned part of the response | [optional] +**limit** | **int** | Specifies the maximum number of records requested part of the response | [optional] +**sort** | **str** | Specifies a comma separated list of field names based on which the result is sorted. | [optional] +**keys** | [**list[InlineResponse200Keys]**](InlineResponse200Keys.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse200Keys.md b/docs/InlineResponse200Keys.md new file mode 100644 index 00000000..e4e64646 --- /dev/null +++ b/docs/InlineResponse200Keys.md @@ -0,0 +1,22 @@ +# InlineResponse200Keys + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Merchant Id | [optional] +**merchant_name** | **str** | Merchant Name | [optional] +**key_id** | **str** | Key Id | [optional] +**key_type** | **str** | Key Type | [optional] +**status** | **str** | Status can be active/inactive | [optional] +**expiration_date** | **date** | Expiry Date. example - 2028-07-15 22:11:56 UTC | [optional] +**date_added** | **date** | Date Addded. example - 2018-04-25 22:11:56 UTC | [optional] +**added_by** | **str** | Added By | [optional] +**date_modified** | **date** | Modified Date. | [optional] +**modified_by** | **str** | Modified By | [optional] +**version** | **str** | Version | [optional] +**serial_number** | **str** | Serial Number | [optional] +**issuer_name** | **str** | Issuer Name | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse4003.md b/docs/InlineResponse4003.md index d77c8341..9b797aa4 100644 --- a/docs/InlineResponse4003.md +++ b/docs/InlineResponse4003.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**correlation_id** | **str** | | [optional] -**details** | [**list[InlineResponse4003Details]**](InlineResponse4003Details.md) | | [optional] -**information_link** | **str** | | [optional] -**message** | **str** | | -**reason** | **str** | | +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] +**reason** | **str** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] +**details** | [**list[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse4004.md b/docs/InlineResponse4004.md new file mode 100644 index 00000000..e4c8dca2 --- /dev/null +++ b/docs/InlineResponse4004.md @@ -0,0 +1,14 @@ +# InlineResponse4004 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlation_id** | **str** | | [optional] +**details** | [**list[InlineResponse4004Details]**](InlineResponse4004Details.md) | | [optional] +**information_link** | **str** | | [optional] +**message** | **str** | | +**reason** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse4003Details.md b/docs/InlineResponse4004Details.md similarity index 92% rename from docs/InlineResponse4003Details.md rename to docs/InlineResponse4004Details.md index 18586758..9dda7304 100644 --- a/docs/InlineResponse4003Details.md +++ b/docs/InlineResponse4004Details.md @@ -1,4 +1,4 @@ -# InlineResponse4003Details +# InlineResponse4004Details ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse500.md b/docs/InlineResponse500.md new file mode 100644 index 00000000..359a6716 --- /dev/null +++ b/docs/InlineResponse500.md @@ -0,0 +1,13 @@ +# InlineResponse500 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services. | [optional] +**status** | **str** | The status of the submitted request. Possible values: - SERVER_ERROR | [optional] +**reason** | **str** | The reason of the status. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT | [optional] +**message** | **str** | The detail message related to the status and reason listed above. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/KeymanagementApi.md b/docs/KeymanagementApi.md new file mode 100644 index 00000000..ab24e804 --- /dev/null +++ b/docs/KeymanagementApi.md @@ -0,0 +1,71 @@ +# CyberSource.KeymanagementApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search_keys**](KeymanagementApi.md#search_keys) | **GET** /kms/v2/keys | Search Keys + + +# **search_keys** +> InlineResponse200 search_keys(offset=offset, limit=limit, sort=sort, organization_ids=organization_ids, key_ids=key_ids, key_types=key_types, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date) + +Search Keys + +Search one or more Keys + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.KeymanagementApi() +offset = 56 # int | This allows you to specify the page offset from the resulting list resultset you want the records to be returned (optional) +limit = 56 # int | This allows you to specify the total number of records to be returned off the resulting list resultset (optional) +sort = 'sort_example' # str | This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. (optional) +organization_ids = ['organization_ids_example'] # list[str] | List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. (optional) +key_ids = ['key_ids_example'] # list[str] | List of Key Ids to search. The maximum size of the Key Ids list is 1 (optional) +key_types = ['key_types_example'] # list[str] | Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided (optional) +expiration_start_date = '2013-10-20T19:20:30+01:00' # datetime | Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional) +expiration_end_date = '2013-10-20T19:20:30+01:00' # datetime | Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided (optional) + +try: + # Search Keys + api_response = api_instance.search_keys(offset=offset, limit=limit, sort=sort, organization_ids=organization_ids, key_ids=key_ids, key_types=key_types, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date) + pprint(api_response) +except ApiException as e: + print("Exception when calling KeymanagementApi->search_keys: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int**| This allows you to specify the page offset from the resulting list resultset you want the records to be returned | [optional] + **limit** | **int**| This allows you to specify the total number of records to be returned off the resulting list resultset | [optional] + **sort** | **str**| This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted. | [optional] + **organization_ids** | [**list[str]**](str.md)| List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30. | [optional] + **key_ids** | [**list[str]**](str.md)| List of Key Ids to search. The maximum size of the Key Ids list is 1 | [optional] + **key_types** | [**list[str]**](str.md)| Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided | [optional] + **expiration_start_date** | **datetime**| Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] + **expiration_end_date** | **datetime**| Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided | [optional] + +### Return type + +[**InlineResponse200**](InlineResponse200.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/KeymanagementpasswordApi.md b/docs/KeymanagementpasswordApi.md new file mode 100644 index 00000000..448a5f72 --- /dev/null +++ b/docs/KeymanagementpasswordApi.md @@ -0,0 +1,59 @@ +# CyberSource.KeymanagementpasswordApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**update_password**](KeymanagementpasswordApi.md#update_password) | **PATCH** /kms/v2/keys-password/{keyId} | Activate or De-activate Password + + +# **update_password** +> object update_password(key_id, update_password_keys_request) + +Activate or De-activate Password + +Activate or De-activate key of type password + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.KeymanagementpasswordApi() +key_id = 'key_id_example' # str | Key ID. +update_password_keys_request = CyberSource.UpdatePasswordKeysRequest() # UpdatePasswordKeysRequest | + +try: + # Activate or De-activate Password + api_response = api_instance.update_password(key_id, update_password_keys_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling KeymanagementpasswordApi->update_password: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **key_id** | **str**| Key ID. | + **update_password_keys_request** | [**UpdatePasswordKeysRequest**](UpdatePasswordKeysRequest.md)| | + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/KeymanagementpgpApi.md b/docs/KeymanagementpgpApi.md new file mode 100644 index 00000000..85d77625 --- /dev/null +++ b/docs/KeymanagementpgpApi.md @@ -0,0 +1,59 @@ +# CyberSource.KeymanagementpgpApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**update_pgp**](KeymanagementpgpApi.md#update_pgp) | **PATCH** /kms/v2/keys-pgp/{keyId} | Activate or De-activate PGP Key + + +# **update_pgp** +> object update_pgp(key_id, update_pgp_keys_request) + +Activate or De-activate PGP Key + +Activate or De-activate PGP Key + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.KeymanagementpgpApi() +key_id = 'key_id_example' # str | Key ID. +update_pgp_keys_request = CyberSource.UpdatePGPKeysRequest() # UpdatePGPKeysRequest | + +try: + # Activate or De-activate PGP Key + api_response = api_instance.update_pgp(key_id, update_pgp_keys_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling KeymanagementpgpApi->update_pgp: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **key_id** | **str**| Key ID. | + **update_pgp_keys_request** | [**UpdatePGPKeysRequest**](UpdatePGPKeysRequest.md)| | + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/KeymanagementscmpApi.md b/docs/KeymanagementscmpApi.md new file mode 100644 index 00000000..a5c7cbb5 --- /dev/null +++ b/docs/KeymanagementscmpApi.md @@ -0,0 +1,59 @@ +# CyberSource.KeymanagementscmpApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**update_scmp**](KeymanagementscmpApi.md#update_scmp) | **PATCH** /kms/v2/keys-scmp/{keyId} | Update or Deactivate + + +# **update_scmp** +> object update_scmp(key_id, update_pgp_keys_request) + +Update or Deactivate + +Update or Deactivate scmp api Key + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.KeymanagementscmpApi() +key_id = 'key_id_example' # str | Key ID. +update_pgp_keys_request = CyberSource.UpdatePGPKeysRequest1() # UpdatePGPKeysRequest1 | + +try: + # Update or Deactivate + api_response = api_instance.update_scmp(key_id, update_pgp_keys_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling KeymanagementscmpApi->update_scmp: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **key_id** | **str**| Key ID. | + **update_pgp_keys_request** | [**UpdatePGPKeysRequest1**](UpdatePGPKeysRequest1.md)| | + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Ptsv2paymentsMerchantInformation.md b/docs/Ptsv2paymentsMerchantInformation.md index 99e1d1c7..5430b6a2 100644 --- a/docs/Ptsv2paymentsMerchantInformation.md +++ b/docs/Ptsv2paymentsMerchantInformation.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **cancel_url** | **str** | customer would be redirected to this url based on the decision of the transaction | [optional] **success_url** | **str** | customer would be redirected to this url based on the decision of the transaction | [optional] **failure_url** | **str** | customer would be redirected to this url based on the decision of the transaction | [optional] -**merchant_name** | **str** | Use this field only if you are requesting payment with Payer Authentication serice together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank. | [optional] +**merchant_name** | **str** | Use this field only if you are requesting payment with Payer Authentication service together. Your company’s name as you want it to appear to the customer in the issuing bank’s authentication form. This value overrides the value specified by your merchant bank. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsPaymentInformation.md b/docs/Ptsv2paymentsPaymentInformation.md index 0b139bb3..73191cf7 100644 --- a/docs/Ptsv2paymentsPaymentInformation.md +++ b/docs/Ptsv2paymentsPaymentInformation.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **legacy_token** | [**Ptsv2paymentsPaymentInformationLegacyToken**](Ptsv2paymentsPaymentInformationLegacyToken.md) | | [optional] **bank** | [**Ptsv2paymentsPaymentInformationBank**](Ptsv2paymentsPaymentInformationBank.md) | | [optional] **payment_type** | [**Ptsv2paymentsPaymentInformationPaymentType**](Ptsv2paymentsPaymentInformationPaymentType.md) | | [optional] -**initiation_channel** | **str** | Mastercard-defined code that indicates how the account information was obtained. - `00` (default): Card - `01`: Removable secure element that is personalized for use with a mobile phone and controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC) - `02`: Key fob - `03`: Watch - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone with a non-removable, secure element that is controlled by the wireless service provider; for example, code division multiple access (CDMA) - `08`: Removable secure element that is personalized for use with a mobile phone and not controlled by the wireless service provider; example: memory card - `09`: Mobile phone with a non-removable, secure element that is not controlled by the wireless service provider - `10`: Removable secure element that is personalized for use with a tablet or e-book and is controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC) - `11`: Tablet or e-book with a non-removable, secure element that is controlled by the wireless service provider - `12`: Removable secure element that is personalized for use with a tablet or e-book and is not controlled by the wireless service provider - `13`: Tablet or e-book with a non-removable, secure element that is not controlled by the wireless service provider This field is supported only for Mastercard on CyberSource through VisaNet. #### Used by **Authorization** Optional field. | [optional] +**initiation_channel** | **str** | Mastercard-defined code that indicates how the account information was obtained. - `00`: Card - `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone - `02`: Key fob - `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA) - `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO - `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book - `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO - `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book - `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO - `14`: Mobile phone or smartphone with a payment application running in a host processor - `15`: Tablet or e-book with a payment application running in a host processor - `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor - `17`: Tablet or e-book with a payment application running in the TEE of a host processor - `18`: Watch with a payment application running in the TEE of a host processor - `19`: Watch with a payment application running in a host processor Values from 20–99 exclusively indicate the form factor only without also indicating the storage technology - `20`: Card - `21`: Phone e.g. Mobile Phone - `22`: Tablet/e-reader - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band - `24`: Sticker - `25`: PC - `26`: Device Peripheral e.g. mobile phone case or sleeve - `27`: Tag e.g. key fob or mobile tag - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links - `29`: Fashion Accessory e.g. handbag, bag charm and glasses - `30`: Garment e.g. dress - `31`: Domestic Appliance e.g refrigerator, washing machine - `32`: Vehicle e.g. vehicle, including vehicle attached devices - `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television 34–99 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice. This field is supported only for Mastercard on CyberSource through VisaNet. When initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support. #### Used by **Authorization** Optional field. | [optional] **e_wallet** | [**Ptsv2paymentsPaymentInformationEWallet**](Ptsv2paymentsPaymentInformationEWallet.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsPaymentInformationPaymentType.md b/docs/Ptsv2paymentsPaymentInformationPaymentType.md index 3b7055b6..154cf0fc 100644 --- a/docs/Ptsv2paymentsPaymentInformationPaymentType.md +++ b/docs/Ptsv2paymentsPaymentInformationPaymentType.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) | [optional] +**name** | **str** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank) | [optional] **sub_type_name** | **str** | Detailed information about the Payment Type. Possible values: - `DEBIT`: Use this value to indicate a PIN debit transaction. Examples: For Card, if Credit or Debit or PrePaid. For Bank Transfer, if Online Bank Transfer or Wire Transfers. | [optional] **method** | [**Ptsv2paymentsPaymentInformationPaymentTypeMethod**](Ptsv2paymentsPaymentInformationPaymentTypeMethod.md) | | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationPaymentTypeMethod.md b/docs/Ptsv2paymentsPaymentInformationPaymentTypeMethod.md index 9de3d7f2..91e5aa31 100644 --- a/docs/Ptsv2paymentsPaymentInformationPaymentTypeMethod.md +++ b/docs/Ptsv2paymentsPaymentInformationPaymentTypeMethod.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data | [optional] +**name** | **str** | A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc For Japan Payment Processing Valid Values: - 1 Banking Data - 2 Authorization Data | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsPointOfSaleInformation.md b/docs/Ptsv2paymentsPointOfSaleInformation.md index 4211ef33..84e08dd5 100644 --- a/docs/Ptsv2paymentsPointOfSaleInformation.md +++ b/docs/Ptsv2paymentsPointOfSaleInformation.md @@ -30,7 +30,7 @@ Name | Type | Description | Notes **is_dedicated_hardware_terminal** | **str** | Type of mPOS device. Possible values: - 0: Dongle - 1: Phone or tablet This optional field is supported only for Mastercard transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 141 - Field: Mastercard mPOS Transaction The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. | [optional] **terminal_model** | **str** | This is the model name of the reader which is used to accept the payment. Possible values: - E3555 - P400 - A920 | [optional] **terminal_make** | **str** | This is the manufacturer name of the reader which is used to accept the payment. Possible values: - PAX - Verifone - Ingenico | [optional] -**service_code** | **str** | #### Visa Platform Connect Mastercard service code that is included in the track data. You can extract the service code from the track data and provide it in this API field. This field is supported only for Mastercard on Visa Platform Connect. | [optional] +**service_code** | **str** | #### Visa Platform Connect Mastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. You can extract the service code from the track data and provide it in this API field. When not provided it will be extracted from: - Track2Data for MSR transactions - EMV tag 5F30 for EMV transactions To enable this feature please call support. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsPointOfSaleInformationEmv.md b/docs/Ptsv2paymentsPointOfSaleInformationEmv.md index 0d6a7387..3a0fd690 100644 --- a/docs/Ptsv2paymentsPointOfSaleInformationEmv.md +++ b/docs/Ptsv2paymentsPointOfSaleInformationEmv.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tags** | **str** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional | [optional] **cardholder_verification_method_used** | **int** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature This field is supported only on **American Express Direct**. | [optional] -**card_sequence_number** | **str** | Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] +**card_sequence_number** | **str** | Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. When sequence number is not provided via this API field, the value is extracted from EMV tag 5F34 for Mastercard transactions. To enable this feature please call support. **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global. #### Used by Authorization: Optional PIN Debit processing: Optional #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] **fallback** | **bool** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX. | [optional] **fallback_condition** | **int** | Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - `1`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - `2`: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN** and **JCN Gateway**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. | [optional] **is_repeat** | **bool** | #### Visa Platform Connect Value “true” indicates this transaction is intentionally duplicated . The field contains value “true” which indicates that merchant has intentionally duplicated single tap transaction. Merchant is intentionally sending a duplicate auth request for a single tap txn because the issuer requested a PIN. | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md b/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md index 70c3c7ca..8e668bcd 100644 --- a/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **is_electronic_benefits_transfer** | **bool** | Flag that indicates whether this transaction is an EBT transaction. Possible values: - `true` - `false` #### PIN debit Required field for EBT and EBT voucher transactions that use PIN debit credit or PIN debit purchase; otherwise, not used. | [optional] -**type** | **str** | Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. | [optional] +**type** | **str** | Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. - `BUY` - `RENT` - `BOOK` - `SUBSCRIBE` - `DOWNLOAD` - `ORDER` - `CONTINUE` #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReversalApi.md b/docs/ReversalApi.md index 76bdb3ba..2940240c 100644 --- a/docs/ReversalApi.md +++ b/docs/ReversalApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**auth_reversal**](ReversalApi.md#auth_reversal) | **POST** /pts/v2/payments/{id}/reversals | Process an Authorization Reversal -[**mit_reversal**](ReversalApi.md#mit_reversal) | **POST** /pts/v2/reversals/ | Timeout Reversal +[**mit_reversal**](ReversalApi.md#mit_reversal) | **POST** /pts/v2/reversals | Timeout Reversal # **auth_reversal** diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md index ae22dd02..4feb9bd4 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) | [optional] +**name** | **str** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. Possible values: - `CARD` (use this for a PIN debit transaction) - `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit) - `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank) | [optional] **type** | **str** | Indicates the payment type used in this payment transaction. Example: credit card, check | [optional] **method** | **str** | Indicates the payment method used in this payment transaction. | [optional] diff --git a/docs/TssV2TransactionsPost201Response.md b/docs/TssV2TransactionsPost201Response.md index 147281bd..2e5e92fa 100644 --- a/docs/TssV2TransactionsPost201Response.md +++ b/docs/TssV2TransactionsPost201Response.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **timezone** | **str** | Merchant’s time zone in ISO standard, using the TZ database format. For example: `America/Chicago` | [optional] **query** | **str** | String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide. | [optional] **offset** | **int** | Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned. | [optional] -**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000. | [optional] +**limit** | **int** | Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500. | [optional] **sort** | **str** | A comma separated list of the following form: `submitTimeUtc:desc` | [optional] **count** | **int** | Results for this page, this could be below the limit. | [optional] **total_count** | **int** | Total number of results. | [optional] diff --git a/docs/UpdateAsymKeysRequest.md b/docs/UpdateAsymKeysRequest.md new file mode 100644 index 00000000..b9f87b32 --- /dev/null +++ b/docs/UpdateAsymKeysRequest.md @@ -0,0 +1,11 @@ +# UpdateAsymKeysRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | Status can be active/inactive | +**organization_id** | **str** | Organization Id | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatePGPKeysRequest.md b/docs/UpdatePGPKeysRequest.md new file mode 100644 index 00000000..2b958e49 --- /dev/null +++ b/docs/UpdatePGPKeysRequest.md @@ -0,0 +1,11 @@ +# UpdatePGPKeysRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | Status can be active/inactive | +**organization_id** | **str** | Organization Id | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatePGPKeysRequest1.md b/docs/UpdatePGPKeysRequest1.md new file mode 100644 index 00000000..98606738 --- /dev/null +++ b/docs/UpdatePGPKeysRequest1.md @@ -0,0 +1,14 @@ +# UpdatePGPKeysRequest1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | Organization Id | [optional] +**status** | **str** | Only inactive status is applicable for SCMP_API. Only status as inactive needs to be provided to deactivate scmp. | [optional] +**expiration_date** | **str** | Expiration Date. Required field to update the SCMP_API key | [optional] +**version** | **str** | Version. Required field to update the SCMP_API key | [optional] +**comment** | **str** | Comment. Optional field. Can be provided along with Expiration Date and Version | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatePasswordKeysRequest.md b/docs/UpdatePasswordKeysRequest.md new file mode 100644 index 00000000..f92638eb --- /dev/null +++ b/docs/UpdatePasswordKeysRequest.md @@ -0,0 +1,11 @@ +# UpdatePasswordKeysRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | Status can be active/inactive | +**organization_id** | **str** | Organization Id | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VoidApi.md b/docs/VoidApi.md index 84d54a8e..e1c8b0d4 100644 --- a/docs/VoidApi.md +++ b/docs/VoidApi.md @@ -4,7 +4,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**mit_void**](VoidApi.md#mit_void) | **POST** /pts/v2/voids/ | Timeout Void +[**mit_void**](VoidApi.md#mit_void) | **POST** /pts/v2/voids | Timeout Void [**void_capture**](VoidApi.md#void_capture) | **POST** /pts/v2/captures/{id}/voids | Void a Capture [**void_credit**](VoidApi.md#void_credit) | **POST** /pts/v2/credits/{id}/voids | Void a Credit [**void_payment**](VoidApi.md#void_payment) | **POST** /pts/v2/payments/{id}/voids | Void a Payment diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 225cacdf..50f70229 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -41,6 +41,10 @@ "name": "void", "description": "A void cancels a payment or capture. A transaction can be voided only when CyberSource has not already\nsubmitted the capture to your processor. You cannot undo a void.\n" }, + { + "name": "options", + "description": "An option is a service that is used to retrieve meta data, rendering details and different payment options available from Cybersource.\nIt can be used in many ways and Merchants must consult their Technical Partner in Cybersource for further details.\n" + }, { "name": "TransactionBatches", "description": "Get a list of batch files or details of Individual file processed through the Offline Transaction Submission Services.\n" @@ -270,11 +274,11 @@ }, { "name": "Recurring_Billing_Subscriptions", - "description": "For more information about Recurring Billing, see the [Recurring Billing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/user/all/rest/recurring-billing-user/recur-bill-services-intro.html)." + "description": "For more information about Recurring Billing, see the [Recurring Billing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-developer/recur-bill-services-intro.html)." }, { "name": "BIN_Lookup", - "description": "Cybersource BIN Lookup REST API provides Bank Identification Number (BIN) attributes, such as card type and issuer information, associated with a payment card.\n\n For more information on Token Management (TMS) see the Token Management section of the API reference, or the [Token Management Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-tms/intro.html).\n" + "description": "BIN Lookup Service provides clients with a network agnostic solution in obtaining Bank Identification Number (BIN) attributes for payment card credentials, empowering our clients to optimize authorizations, reduce fraud, and improve payment acceptance during the checkout experience.\n\nThe service uses multiple network BIN sources providing global and regional coverage when identifying BIN attributes such as: card network, card type (CREDIT, DEBIT, PREPAID), account type (PAN or Network Token), account prefix, issuer name, issuer country.\n\nThe service can flexibly manage primary account numbers (PANs), Token Management (TMS) tokens, along with Visa, Mastercard and Discover network tokens when calling the API.\n" }, { "name": "Transaction_Details", @@ -723,8 +727,8 @@ }, "type": { "type": "string", - "maxLength": 6, - "description": "Flag that indicates an EBT voucher transaction. Possible value:\n- `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher.\n\n#### PIN debit\nRequired field for EBT voucher transactions that use PIN debit purchase; otherwise, not used.\n" + "maxLength": 20, + "description": "Flag that indicates an EBT voucher transaction. Possible value:\n- `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher.\n- `BUY`\n- `RENT`\n- `BOOK`\n- `SUBSCRIBE`\n- `DOWNLOAD`\n- `ORDER`\n- `CONTINUE`\n\n#### PIN debit\nRequired field for EBT voucher transactions that use PIN debit purchase; otherwise, not used.\n" } } }, @@ -1156,7 +1160,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -1167,7 +1171,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -1176,7 +1180,7 @@ "initiationChannel": { "type": "string", "maxLength": 2, - "description": "Mastercard-defined code that indicates how the account information was obtained.\n\n- `00` (default): Card\n- `01`: Removable secure element that is personalized for use with a mobile phone and controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC)\n- `02`: Key fob\n- `03`: Watch\n- `04`: Mobile tag\n- `05`: Wristband\n- `06`: Mobile phone case or sleeve\n- `07`: Mobile phone with a non-removable, secure element that is controlled by the wireless service provider; for example, code division multiple access (CDMA)\n- `08`: Removable secure element that is personalized for use with a mobile phone and not controlled by the wireless service provider; example: memory card\n- `09`: Mobile phone with a non-removable, secure element that is not controlled by the wireless service provider\n- `10`: Removable secure element that is personalized for use with a tablet or e-book and is controlled by the wireless service provider; examples: subscriber identity module (SIM), universal integrated circuit card (UICC)\n- `11`: Tablet or e-book with a non-removable, secure element that is controlled by the wireless service provider\n- `12`: Removable secure element that is personalized for use with a tablet or e-book and is not controlled by the wireless service provider\n- `13`: Tablet or e-book with a non-removable, secure element that is not controlled by the wireless service provider\n\nThis field is supported only for Mastercard on CyberSource through VisaNet.\n\n#### Used by\n**Authorization**\nOptional field.\n" + "description": "Mastercard-defined code that indicates how the account information was obtained.\n\n- `00`: Card\n- `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone\n- `02`: Key fob\n- `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO\n- `04`: Mobile tag\n- `05`: Wristband\n- `06`: Mobile phone case or sleeve\n- `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA)\n- `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone\n- `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO\n- `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book\n- `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO\n- `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book\n- `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO\n- `14`: Mobile phone or smartphone with a payment application running in a host processor\n- `15`: Tablet or e-book with a payment application running in a host processor\n- `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor\n- `17`: Tablet or e-book with a payment application running in the TEE of a host processor\n- `18`: Watch with a payment application running in the TEE of a host processor\n- `19`: Watch with a payment application running in a host processor\n\nValues from 20\u201399 exclusively indicate the form factor only without also indicating the storage technology\n\n- `20`: Card\n- `21`: Phone e.g. Mobile Phone\n- `22`: Tablet/e-reader\n- `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band\n- `24`: Sticker\n- `25`: PC\n- `26`: Device Peripheral e.g. mobile phone case or sleeve\n- `27`: Tag e.g. key fob or mobile tag\n- `28`: Jewelry e.g. ring, bracelet, necklace and cuff links\n- `29`: Fashion Accessory e.g. handbag, bag charm and glasses\n- `30`: Garment e.g. dress\n- `31`: Domestic Appliance e.g refrigerator, washing machine\n- `32`: Vehicle e.g. vehicle, including vehicle attached devices\n- `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television\n\n34\u201399 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice.\n\nThis field is supported only for Mastercard on CyberSource through VisaNet.\nWhen initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support.\n\n#### Used by\n**Authorization**\nOptional field.\n" }, "eWallet": { "type": "object", @@ -1792,7 +1796,7 @@ }, "referenceDataCode": { "type": "string", - "maxLength": 2, + "maxLength": 150, "description": "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n\nFor details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" }, "referenceDataNumber": { @@ -2344,7 +2348,7 @@ "merchantName": { "type": "string", "maxLength": 25, - "description": "Use this field only if you are requesting payment with Payer Authentication serice together.\n\nYour company\u2019s name as you want it to appear to the customer in the issuing bank\u2019s authentication form.\nThis value overrides the value specified by your merchant bank.\n" + "description": "Use this field only if you are requesting payment with Payer Authentication service together.\n\nYour company\u2019s name as you want it to appear to the customer in the issuing bank\u2019s authentication form.\nThis value overrides the value specified by your merchant bank.\n" } } }, @@ -2793,7 +2797,7 @@ "cardSequenceNumber": { "type": "string", "maxLength": 3, - "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is\navailable only on CyberSource through VisaNet and FDC Nashville Global.\n\n#### Used by\nAuthorization: Optional\nPIN Debit processing: Optional\n\n#### GPX\n\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n" + "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\n\nThis value enables issuers to distinguish among multiple cards that are linked to the same account.\n\nThis value can also act as a tracking tool when reissuing cards. \n\nWhen this value is available, it is provided by the chip reader. \n\nWhen the chip reader does not provide this value, do not include this field in your request.\n\nWhen sequence number is not provided via this API field, the value is extracted from EMV tag 5F34 for Mastercard transactions. To enable this feature please call support.\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\n\nAll other card present information applies only to credit card processing. \n\nPIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global.\n\n#### Used by\nAuthorization: Optional\nPIN Debit processing: Optional\n\n#### GPX\n\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n" }, "fallback": { "type": "boolean", @@ -2910,7 +2914,7 @@ "serviceCode": { "type": "string", "maxLength": 3, - "description": "#### Visa Platform Connect\nMastercard service code that is included in the track data.\nYou can extract the service code from the track data and provide it in this API field.\nThis field is supported only for Mastercard on Visa Platform Connect.\n" + "description": "#### Visa Platform Connect\nMastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. \nYou can extract the service code from the track data and provide it in this API field. \n\nWhen not provided it will be extracted from:\n - Track2Data for MSR transactions\n - EMV tag 5F30 for EMV transactions\n\nTo enable this feature please call support.\n" } } }, @@ -3718,7 +3722,7 @@ }, "reservationSystemCode": { "type": "string", - "maxLength": 4, + "maxLength": 20, "description": "Code that specifies the computerized reservation system used to make the reservation and purchase the ticket.\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces;\nspecial characters are not included.\nOptional request field.\n" }, "processIdentifier": { @@ -9261,7 +9265,7 @@ } } }, - "/pts/v2/reversals/": { + "/pts/v2/reversals": { "post": { "summary": "Timeout Reversal", "description": "This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.", @@ -10418,7 +10422,7 @@ }, "referenceDataCode": { "type": "string", - "maxLength": 2, + "maxLength": 150, "description": "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n\nFor details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" }, "referenceDataNumber": { @@ -11634,7 +11638,7 @@ }, "reservationSystemCode": { "type": "string", - "maxLength": 4, + "maxLength": 20, "description": "Code that specifies the computerized reservation system used to make the reservation and purchase the ticket.\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces;\nspecial characters are not included.\nOptional request field.\n" }, "processIdentifier": { @@ -12757,7 +12761,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -12768,7 +12772,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -14188,7 +14192,7 @@ }, "reservationSystemCode": { "type": "string", - "maxLength": 4, + "maxLength": 20, "description": "Code that specifies the computerized reservation system used to make the reservation and purchase the ticket.\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces;\nspecial characters are not included.\nOptional request field.\n" }, "processIdentifier": { @@ -15158,7 +15162,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -15169,7 +15173,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -16589,7 +16593,7 @@ }, "reservationSystemCode": { "type": "string", - "maxLength": 4, + "maxLength": 20, "description": "Code that specifies the computerized reservation system used to make the reservation and purchase the ticket.\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces;\nspecial characters are not included.\nOptional request field.\n" }, "processIdentifier": { @@ -17651,7 +17655,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -17662,7 +17666,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -18397,7 +18401,7 @@ "cardSequenceNumber": { "type": "string", "maxLength": 3, - "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\nAll other card present information applies only to credit card processing. PIN debit processing is\navailable only on CyberSource through VisaNet and FDC Nashville Global.\n\n#### Used by\nAuthorization: Optional\nPIN Debit processing: Optional\n\n#### GPX\n\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n" + "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\n\nThis value enables issuers to distinguish among multiple cards that are linked to the same account.\n\nThis value can also act as a tracking tool when reissuing cards. \n\nWhen this value is available, it is provided by the chip reader. \n\nWhen the chip reader does not provide this value, do not include this field in your request.\n\nWhen sequence number is not provided via this API field, the value is extracted from EMV tag 5F34 for Mastercard transactions. To enable this feature please call support.\n\n**Note** Card present information about EMV applies only to credit card processing and PIN debit processing.\n\nAll other card present information applies only to credit card processing. \n\nPIN debit processing is available only on CyberSource through VisaNet and FDC Nashville Global.\n\n#### Used by\nAuthorization: Optional\nPIN Debit processing: Optional\n\n#### GPX\n\nThis field only supports transactions from the following card types:\n- Visa\n- Mastercard\n- AMEX\n- Discover\n- Diners\n- JCB\n- Union Pay International\n" }, "fallback": { "type": "boolean", @@ -18514,7 +18518,7 @@ "serviceCode": { "type": "string", "maxLength": 3, - "description": "#### Visa Platform Connect\nMastercard service code that is included in the track data.\nYou can extract the service code from the track data and provide it in this API field.\nThis field is supported only for Mastercard on Visa Platform Connect.\n" + "description": "#### Visa Platform Connect\nMastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. \nYou can extract the service code from the track data and provide it in this API field. \n\nWhen not provided it will be extracted from:\n - Track2Data for MSR transactions\n - EMV tag 5F30 for EMV transactions\n\nTo enable this feature please call support.\n" } } }, @@ -19252,7 +19256,7 @@ }, "reservationSystemCode": { "type": "string", - "maxLength": 4, + "maxLength": 20, "description": "Code that specifies the computerized reservation system used to make the reservation and purchase the ticket.\nFormat: English characters only.\nRestricted string data type that indicates a sequence of letters, numbers, and spaces;\nspecial characters are not included.\nOptional request field.\n" }, "processIdentifier": { @@ -20260,7 +20264,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -20271,7 +20275,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -20598,7 +20602,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -20609,7 +20613,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -20936,7 +20940,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -20947,7 +20951,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -21274,7 +21278,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -21285,7 +21289,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -21533,7 +21537,7 @@ } } }, - "/pts/v2/voids/": { + "/pts/v2/voids": { "post": { "summary": "Timeout Void", "description": "This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout). This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in your payment, capture, refund, or credit API call and use same transactionId in this API request payload to reverse the payment.", @@ -21637,7 +21641,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "subTypeName": { "type": "string", @@ -21648,7 +21652,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal, 7Eleven, alfamart, etc\n\nFor Japan Payment Processing Valid Values:\n- 1 Banking Data\n- 2 Authorization Data\n" } } } @@ -58137,7 +58141,7 @@ "properties": { "name": { "type": "string", - "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n" + "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\nPossible values:\n- `CARD` (use this for a PIN debit transaction)\n- `CHECK` (use this for all eCheck payment transactions - ECP Debit, ECP Follow-on Credit, ECP StandAlone Credit)\n- `bankTransfer` (use for Online Bank Transafer for methods such as P24, iDeal, Estonia Bank)\n" }, "type": { "type": "string", @@ -59525,7 +59529,7 @@ }, "limit": { "type": "integer", - "description": "Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000.\n" + "description": "Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500.\n" }, "sort": { "type": "string", @@ -59578,7 +59582,7 @@ }, "limit": { "type": "integer", - "description": "Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000.\n" + "description": "Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500.\n" }, "sort": { "type": "string", @@ -60386,7 +60390,7 @@ }, "limit": { "type": "integer", - "description": "Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000.\n" + "description": "Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500.\n" }, "sort": { "type": "string", @@ -74542,12 +74546,10 @@ } } } - } - }, - "/kms/v2/keys-asym/deletes": { - "post": { - "summary": "Delete one or more PKCS12 keys", - "description": "'Delete one or more PKCS12 keys'\n", + }, + "patch": { + "summary": "Activate or De-activate Asymmetric Key", + "description": "Activate or De-activate Asymmetric Key\n", "tags": [ "Asymmetric Key Management" ], @@ -74557,68 +74559,33 @@ "secondLevelApiLifeCycle": "hidden", "apiLifeCycle": "hidden" }, - "operationId": "deleteBulkP12Keys", + "operationId": "UpdateAsymKey", "parameters": [ { - "name": "deleteBulkP12KeysRequest", + "name": "keyId", + "in": "path", + "description": "Key ID.\n", + "required": true, + "type": "string" + }, + { + "name": "UpdateAsymKeysRequest", "in": "body", "required": true, "schema": { "type": "object", + "required": [ + "status", + "organizationId" + ], "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" - } - } - } - } + "status": { + "type": "string", + "description": "Status can be active/inactive" }, - "keyInformation": { - "type": "array", - "items": { - "type": "object", - "description": "key information\n", - "required": [ - "organizationId", - "keyId" - ], - "properties": { - "organizationId": { - "type": "string", - "description": "Merchant Id\n" - }, - "referenceNumber": { - "type": "string", - "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n" - }, - "keyId": { - "type": "string", - "description": "Key Serial Number" - } - } - } + "organizationId": { + "type": "string", + "description": "Organization Id" } } } @@ -74626,103 +74593,13 @@ ], "responses": { "200": { - "description": "Successful response\n", + "description": "Successful response.", "schema": { - "title": "kmsV2KeysAsymDeletesPost200Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" - } - } - } - } - }, - "keyInformation": { - "type": "array", - "items": { - "type": "object", - "description": "key information\n", - "properties": { - "organizationId": { - "type": "string", - "description": "Merchant Id\n" - }, - "referenceNumber": { - "type": "string", - "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n" - }, - "keyId": { - "type": "string", - "description": "Key Serial Number\n" - }, - "status": { - "type": "string", - "description": "The status of the key.\n\nPossible values:\n - FAILED\n - ACTIVE\n - INACTIVE\n - EXPIRED\n" - }, - "message": { - "type": "string", - "description": "message in case of failed key" - }, - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" - } - } - } - } - } - } - } - } - } - } + "type": "object" } }, "400": { - "description": "Invalid request\n", + "description": "Invalid request.", "schema": { "type": "object", "properties": { @@ -74736,21 +74613,33 @@ }, "reason": { "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n" + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" }, "message": { "type": "string", "description": "The detail message related to the status and reason listed above." }, - "statusCode": { - "type": "string", - "description": "HTTP status code of the submitted request.\n\nPossible values:\n - 500\n" + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } } } } }, - "502": { - "description": "Unexpected system error or system timeout.\n", + "500": { + "description": "Unexpected system error or system timeout.", "schema": { "type": "object", "properties": { @@ -74760,7 +74649,7 @@ }, "status": { "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" + "description": "The status of the submitted request.\n\nPossible values:\n - SERVER_ERROR\n" }, "reason": { "type": "string", @@ -74769,10 +74658,6 @@ "message": { "type": "string", "description": "The detail message related to the status and reason listed above." - }, - "statusCode": { - "type": "string", - "description": "HTTP status code of the submitted request.\n\nPossible values:\n - 500\n" } } } @@ -74780,30 +74665,23 @@ } } }, - "/kms/v2/keys-sym/verifi": { + "/kms/v2/keys-asym/deletes": { "post": { + "summary": "Delete one or more PKCS12 keys", + "description": "'Delete one or more PKCS12 keys'\n", + "tags": [ + "Asymmetric Key Management" + ], "x-devcenter-metaData": { "categoryTag": "Key_Management", "firstLevelApiLifeCycle": "hidden", "secondLevelApiLifeCycle": "hidden", "apiLifeCycle": "hidden" }, - "summary": "Create Shared-Secret Keys as per verifi spec", - "description": "Create one or more Shared-Secret Keys as per Verifi spec with 32 chars, store digest algo during key generation.\n", - "tags": [ - "Symmetric Key Management" - ], - "operationId": "createV2SharedSecretKeys-verifi", + "operationId": "deleteBulkP12Keys", "parameters": [ { - "name": "v-ic-domain", - "in": "header", - "description": "domain", - "required": true, - "type": "string" - }, - { - "name": "createSharedSecretKeysVerifiRequest", + "name": "deleteBulkP12KeysRequest", "in": "body", "required": true, "schema": { @@ -74844,7 +74722,8 @@ "type": "object", "description": "key information\n", "required": [ - "organizationId" + "organizationId", + "keyId" ], "properties": { "organizationId": { @@ -74855,14 +74734,9 @@ "type": "string", "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n" }, - "digestAlgorithm": { + "keyId": { "type": "string", - "description": "Algorithm for message signature authentication\n", - "enum": [ - "HMACSHA1", - "HMACSHA2" - ], - "default": "HMACSHA2" + "description": "Key Serial Number" } } } @@ -74872,20 +74746,267 @@ } ], "responses": { - "201": { - "description": "Successful response.", + "200": { + "description": "Successful response\n", "schema": { - "title": "kmsV2KeysSymPost201Response", + "title": "kmsV2KeysAsymDeletesPost200Response", "type": "object", "properties": { "submitTimeUtc": { "type": "string", "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - ACCEPTED\n" - }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + } + } + }, + "keyInformation": { + "type": "array", + "items": { + "type": "object", + "description": "key information\n", + "properties": { + "organizationId": { + "type": "string", + "description": "Merchant Id\n" + }, + "referenceNumber": { + "type": "string", + "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n" + }, + "keyId": { + "type": "string", + "description": "Key Serial Number\n" + }, + "status": { + "type": "string", + "description": "The status of the key.\n\nPossible values:\n - FAILED\n - ACTIVE\n - INACTIVE\n - EXPIRED\n" + }, + "message": { + "type": "string", + "description": "message in case of failed key" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request\n", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "statusCode": { + "type": "string", + "description": "HTTP status code of the submitted request.\n\nPossible values:\n - 500\n" + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.\n", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "statusCode": { + "type": "string", + "description": "HTTP status code of the submitted request.\n\nPossible values:\n - 500\n" + } + } + } + } + } + } + }, + "/kms/v2/keys-sym/verifi": { + "post": { + "x-devcenter-metaData": { + "categoryTag": "Key_Management", + "firstLevelApiLifeCycle": "hidden", + "secondLevelApiLifeCycle": "hidden", + "apiLifeCycle": "hidden" + }, + "summary": "Create Shared-Secret Keys as per verifi spec", + "description": "Create one or more Shared-Secret Keys as per Verifi spec with 32 chars, store digest algo during key generation.\n", + "tags": [ + "Symmetric Key Management" + ], + "operationId": "createV2SharedSecretKeys-verifi", + "parameters": [ + { + "name": "v-ic-domain", + "in": "header", + "description": "domain", + "required": true, + "type": "string" + }, + { + "name": "createSharedSecretKeysVerifiRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + } + } + }, + "keyInformation": { + "type": "array", + "items": { + "type": "object", + "description": "key information\n", + "required": [ + "organizationId" + ], + "properties": { + "organizationId": { + "type": "string", + "description": "Merchant Id\n" + }, + "referenceNumber": { + "type": "string", + "description": "Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client\u2019s convenience. If client specifies value for this field in the request, it is expected to be available in the response.\n" + }, + "digestAlgorithm": { + "type": "string", + "description": "Algorithm for message signature authentication\n", + "enum": [ + "HMACSHA1", + "HMACSHA2" + ], + "default": "HMACSHA2" + } + } + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "kmsV2KeysSymPost201Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - ACCEPTED\n" + }, "clientReferenceInformation": { "type": "object", "properties": { @@ -75043,6 +75164,614 @@ } } }, + "/kms/v2/keys": { + "get": { + "summary": "Search Keys", + "description": "Search one or more Keys", + "tags": [ + "key-management" + ], + "x-devcenter-metaData": { + "categoryTag": "Key_Management", + "firstLevelApiLifeCycle": "hidden", + "secondLevelApiLifeCycle": "hidden", + "apiLifeCycle": "hidden" + }, + "operationId": "searchKeys", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "This allows you to specify the page offset from the resulting list resultset you want the records to be returned", + "type": "integer" + }, + { + "name": "limit", + "in": "query", + "description": "This allows you to specify the total number of records to be returned off the resulting list resultset", + "type": "integer" + }, + { + "name": "sort", + "in": "query", + "description": "This allows you to specify a comma separated list of fields in the order which the resulting list resultset must be sorted.", + "type": "string" + }, + { + "name": "organizationIds", + "in": "query", + "description": "List of Orgaization Ids to search. The maximum size of the organization Ids list is 1. The maximum length of Organization Id is 30.", + "type": "array", + "items": { + "type": "string" + } + }, + { + "name": "keyIds", + "in": "query", + "description": "List of Key Ids to search. The maximum size of the Key Ids list is 1", + "type": "array", + "items": { + "type": "string" + } + }, + { + "name": "keyTypes", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "Key Type, Possible values - certificate, password, pgp and scmp_api. When Key Type is provided atleast one more filter needs to be provided" + }, + { + "name": "expirationStartDate", + "in": "query", + "type": "string", + "format": "date-time", + "pattern": "yyyy-mm-dd", + "description": "Expiry Filter Start Date. When Expiration Date filter is provided, atleast one more filter needs to be provided" + }, + { + "name": "expirationEndDate", + "in": "query", + "type": "string", + "format": "date-time", + "pattern": "yyyy-mm-dd", + "description": "Expiry Filter End Date. When Expiration Date filter is provided, atleast one more filter needs to be provided" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "object", + "description": "Successful searchKeysResponse", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n", + "example": "2016-08-11T22:47:57Z" + }, + "totalCount": { + "type": "integer", + "description": "Specifies the total number of items found based on the request" + }, + "offset": { + "type": "integer", + "description": "Specifies the record offset from the records are returned part of the response" + }, + "limit": { + "type": "integer", + "description": "Specifies the maximum number of records requested part of the response" + }, + "sort": { + "type": "string", + "description": "Specifies a comma separated list of field names based on which the result is sorted." + }, + "keys": { + "type": "array", + "items": { + "type": "object", + "description": "KeyResponseEntry", + "properties": { + "organizationId": { + "type": "string", + "description": "Merchant Id" + }, + "merchantName": { + "type": "string", + "description": "Merchant Name" + }, + "keyId": { + "type": "string", + "description": "Key Id" + }, + "keyType": { + "type": "string", + "description": "Key Type" + }, + "status": { + "type": "string", + "description": "Status can be active/inactive" + }, + "expirationDate": { + "type": "string", + "format": "date", + "pattern": "yyyy-mm-dd hh:mm:ss zzz", + "description": "Expiry Date. example - 2028-07-15 22:11:56 UTC" + }, + "dateAdded": { + "type": "string", + "format": "date", + "pattern": "yyyy-mm-dd hh:mm:ss zzz", + "description": "Date Addded. example - 2018-04-25 22:11:56 UTC" + }, + "addedBy": { + "type": "string", + "description": "Added By" + }, + "dateModified": { + "type": "string", + "format": "date", + "pattern": "yyyy-mm-dd hh:mm:ss zzz", + "description": "Modified Date.", + "example": "2022-04-25 22:11:56 UTC" + }, + "modifiedBy": { + "type": "string", + "description": "Modified By" + }, + "version": { + "type": "string", + "description": "Version" + }, + "serialNumber": { + "type": "string", + "description": "Serial Number" + }, + "issuerName": { + "type": "string", + "description": "Issuer Name" + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } + } + } + } + }, + "500": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted request.\n\nPossible values:\n - SERVER_ERROR\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + } + } + }, + "/kms/v2/keys-password/{keyId}": { + "patch": { + "summary": "Activate or De-activate Password", + "description": "Activate or De-activate key of type password\n", + "tags": [ + "key-management-password" + ], + "x-devcenter-metaData": { + "categoryTag": "Key_Management", + "firstLevelApiLifeCycle": "hidden", + "secondLevelApiLifeCycle": "hidden", + "apiLifeCycle": "hidden" + }, + "operationId": "UpdatePassword", + "parameters": [ + { + "name": "keyId", + "in": "path", + "description": "Key ID.\n", + "required": true, + "type": "string" + }, + { + "name": "UpdatePasswordKeysRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "required": [ + "status", + "organizationId" + ], + "properties": { + "status": { + "type": "string", + "description": "Status can be active/inactive" + }, + "organizationId": { + "type": "string", + "description": "Organization Id" + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "object" + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } + } + } + } + }, + "500": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted request.\n\nPossible values:\n - SERVER_ERROR\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + } + } + }, + "/kms/v2/keys-pgp/{keyId}": { + "patch": { + "summary": "Activate or De-activate PGP Key", + "description": "Activate or De-activate PGP Key\n", + "tags": [ + "key-management-pgp" + ], + "x-devcenter-metaData": { + "categoryTag": "Key_Management", + "firstLevelApiLifeCycle": "hidden", + "secondLevelApiLifeCycle": "hidden", + "apiLifeCycle": "hidden" + }, + "operationId": "UpdatePGP", + "parameters": [ + { + "name": "keyId", + "in": "path", + "description": "Key ID.\n", + "required": true, + "type": "string" + }, + { + "name": "UpdatePGPKeysRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "required": [ + "status", + "organizationId" + ], + "properties": { + "status": { + "type": "string", + "description": "Status can be active/inactive" + }, + "organizationId": { + "type": "string", + "description": "Organization Id" + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "object" + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } + } + } + } + }, + "500": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted request.\n\nPossible values:\n - SERVER_ERROR\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + } + } + }, + "/kms/v2/keys-scmp/{keyId}": { + "patch": { + "summary": "Update or Deactivate", + "description": "Update or Deactivate scmp api Key\n", + "tags": [ + "key-management-scmp" + ], + "x-devcenter-metaData": { + "categoryTag": "Key_Management", + "firstLevelApiLifeCycle": "hidden", + "secondLevelApiLifeCycle": "hidden", + "apiLifeCycle": "hidden" + }, + "operationId": "UpdateSCMP", + "parameters": [ + { + "name": "keyId", + "in": "path", + "description": "Key ID.\n", + "required": true, + "type": "string" + }, + { + "name": "UpdatePGPKeysRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization Id" + }, + "status": { + "type": "string", + "description": "Only inactive status is applicable for SCMP_API. Only status as inactive needs to be provided to deactivate scmp." + }, + "expirationDate": { + "type": "string", + "description": "Expiration Date. Required field to update the SCMP_API key" + }, + "version": { + "type": "string", + "description": "Version. Required field to update the SCMP_API key" + }, + "comment": { + "type": "string", + "description": "Comment. Optional field. Can be provided along with Expiration Date and Version" + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "object" + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } + } + } + } + }, + "500": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted request.\n\nPossible values:\n - SERVER_ERROR\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + } + } + }, "/up/v1/capture-contexts": { "x-name": "Generate Unified Checkout Capture Context", "x-description": "Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the paramiters for how Unified Chkcout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initate Unified Checkout within a merchnat web page", diff --git a/setup.py b/setup.py index 7dbab75c..9661c5df 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ from setuptools import setup, find_packages NAME = "cybersource-rest-client-python" -VERSION = "0.0.40" +VERSION = "0.0.41" # To install the library, run the following # # python setup.py install diff --git a/test/test_asymmetric_key_management_api.py b/test/test_asymmetric_key_management_api.py index de50e9d6..39c1476f 100644 --- a/test/test_asymmetric_key_management_api.py +++ b/test/test_asymmetric_key_management_api.py @@ -55,6 +55,14 @@ def test_get_p12_key_details(self): """ pass + def test_update_asym_key(self): + """ + Test case for update_asym_key + + Activate or De-activate Asymmetric Key + """ + pass + if __name__ == '__main__': unittest.main() diff --git a/test/test_inline_response_400_3_details.py b/test/test_inline_response_200.py similarity index 64% rename from test/test_inline_response_400_3_details.py rename to test/test_inline_response_200.py index dc96c622..89bbb2c1 100644 --- a/test/test_inline_response_400_3_details.py +++ b/test/test_inline_response_200.py @@ -19,11 +19,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response_400_3_details import InlineResponse4003Details +from CyberSource.models.inline_response_200 import InlineResponse200 -class TestInlineResponse4003Details(unittest.TestCase): - """ InlineResponse4003Details unit test stubs """ +class TestInlineResponse200(unittest.TestCase): + """ InlineResponse200 unit test stubs """ def setUp(self): pass @@ -31,12 +31,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse4003Details(self): + def testInlineResponse200(self): """ - Test InlineResponse4003Details + Test InlineResponse200 """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response_400_3_details.InlineResponse4003Details() + #model = CyberSource.models.inline_response_200.InlineResponse200() pass diff --git a/test/test_inline_response_200_keys.py b/test/test_inline_response_200_keys.py new file mode 100644 index 00000000..6a902b46 --- /dev/null +++ b/test/test_inline_response_200_keys.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response_200_keys import InlineResponse200Keys + + +class TestInlineResponse200Keys(unittest.TestCase): + """ InlineResponse200Keys unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse200Keys(self): + """ + Test InlineResponse200Keys + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response_200_keys.InlineResponse200Keys() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_400_4.py b/test/test_inline_response_400_4.py new file mode 100644 index 00000000..e081f653 --- /dev/null +++ b/test/test_inline_response_400_4.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response_400_4 import InlineResponse4004 + + +class TestInlineResponse4004(unittest.TestCase): + """ InlineResponse4004 unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse4004(self): + """ + Test InlineResponse4004 + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response_400_4.InlineResponse4004() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_400_4_details.py b/test/test_inline_response_400_4_details.py new file mode 100644 index 00000000..6fbe5c13 --- /dev/null +++ b/test/test_inline_response_400_4_details.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response_400_4_details import InlineResponse4004Details + + +class TestInlineResponse4004Details(unittest.TestCase): + """ InlineResponse4004Details unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse4004Details(self): + """ + Test InlineResponse4004Details + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response_400_4_details.InlineResponse4004Details() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_500.py b/test/test_inline_response_500.py new file mode 100644 index 00000000..20c89cff --- /dev/null +++ b/test/test_inline_response_500.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response_500 import InlineResponse500 + + +class TestInlineResponse500(unittest.TestCase): + """ InlineResponse500 unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse500(self): + """ + Test InlineResponse500 + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response_500.InlineResponse500() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_keymanagement_api.py b/test/test_keymanagement_api.py new file mode 100644 index 00000000..35dfaae7 --- /dev/null +++ b/test/test_keymanagement_api.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.apis.keymanagement_api import KeymanagementApi + + +class TestKeymanagementApi(unittest.TestCase): + """ KeymanagementApi unit test stubs """ + + def setUp(self): + self.api = CyberSource.apis.keymanagement_api.KeymanagementApi() + + def tearDown(self): + pass + + def test_search_keys(self): + """ + Test case for search_keys + + Search Keys + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_keymanagementpassword_api.py b/test/test_keymanagementpassword_api.py new file mode 100644 index 00000000..24104565 --- /dev/null +++ b/test/test_keymanagementpassword_api.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.apis.keymanagementpassword_api import KeymanagementpasswordApi + + +class TestKeymanagementpasswordApi(unittest.TestCase): + """ KeymanagementpasswordApi unit test stubs """ + + def setUp(self): + self.api = CyberSource.apis.keymanagementpassword_api.KeymanagementpasswordApi() + + def tearDown(self): + pass + + def test_update_password(self): + """ + Test case for update_password + + Activate or De-activate Password + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_keymanagementpgp_api.py b/test/test_keymanagementpgp_api.py new file mode 100644 index 00000000..c410cb99 --- /dev/null +++ b/test/test_keymanagementpgp_api.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.apis.keymanagementpgp_api import KeymanagementpgpApi + + +class TestKeymanagementpgpApi(unittest.TestCase): + """ KeymanagementpgpApi unit test stubs """ + + def setUp(self): + self.api = CyberSource.apis.keymanagementpgp_api.KeymanagementpgpApi() + + def tearDown(self): + pass + + def test_update_pgp(self): + """ + Test case for update_pgp + + Activate or De-activate PGP Key + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_keymanagementscmp_api.py b/test/test_keymanagementscmp_api.py new file mode 100644 index 00000000..8179a18c --- /dev/null +++ b/test/test_keymanagementscmp_api.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.apis.keymanagementscmp_api import KeymanagementscmpApi + + +class TestKeymanagementscmpApi(unittest.TestCase): + """ KeymanagementscmpApi unit test stubs """ + + def setUp(self): + self.api = CyberSource.apis.keymanagementscmp_api.KeymanagementscmpApi() + + def tearDown(self): + pass + + def test_update_scmp(self): + """ + Test case for update_scmp + + Update or Deactivate + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_asym_keys_request.py b/test/test_update_asym_keys_request.py new file mode 100644 index 00000000..31a88cd8 --- /dev/null +++ b/test/test_update_asym_keys_request.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.update_asym_keys_request import UpdateAsymKeysRequest + + +class TestUpdateAsymKeysRequest(unittest.TestCase): + """ UpdateAsymKeysRequest unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateAsymKeysRequest(self): + """ + Test UpdateAsymKeysRequest + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.update_asym_keys_request.UpdateAsymKeysRequest() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_password_keys_request.py b/test/test_update_password_keys_request.py new file mode 100644 index 00000000..7258cfdd --- /dev/null +++ b/test/test_update_password_keys_request.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.update_password_keys_request import UpdatePasswordKeysRequest + + +class TestUpdatePasswordKeysRequest(unittest.TestCase): + """ UpdatePasswordKeysRequest unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePasswordKeysRequest(self): + """ + Test UpdatePasswordKeysRequest + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.update_password_keys_request.UpdatePasswordKeysRequest() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_pgp_keys_request.py b/test/test_update_pgp_keys_request.py new file mode 100644 index 00000000..9b598bbc --- /dev/null +++ b/test/test_update_pgp_keys_request.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.update_pgp_keys_request import UpdatePGPKeysRequest + + +class TestUpdatePGPKeysRequest(unittest.TestCase): + """ UpdatePGPKeysRequest unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePGPKeysRequest(self): + """ + Test UpdatePGPKeysRequest + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.update_pgp_keys_request.UpdatePGPKeysRequest() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_pgp_keys_request_1.py b/test/test_update_pgp_keys_request_1.py new file mode 100644 index 00000000..f514d2cc --- /dev/null +++ b/test/test_update_pgp_keys_request_1.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.update_pgp_keys_request_1 import UpdatePGPKeysRequest1 + + +class TestUpdatePGPKeysRequest1(unittest.TestCase): + """ UpdatePGPKeysRequest1 unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePGPKeysRequest1(self): + """ + Test UpdatePGPKeysRequest1 + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.update_pgp_keys_request_1.UpdatePGPKeysRequest1() + pass + + +if __name__ == '__main__': + unittest.main()