Releases: Worldline-Global-Collect/connect-sdk-ruby
Releases · Worldline-Global-Collect/connect-sdk-ruby
3.3.0
3.2.0
- Added:
- Added property
date_of_incorporation
to classCompanyInformation
. - Added property
payment_code
to classOrderTypeInformation
.
- Added property
- Removed:
- Removed property
payment_product816_specific_input
of classRedirectPaymentMethodSpecificInput
, as this property is no longer supported by the REST API.
- Removed property
3.1.0
- Added:
- Added property
network_token_used
to classCardPaymentMethodSpecificOutput
. - Added property
naics_commodity_code
to classOrderLineDetails
. - Added property
shipped_from_zip
to classShipping
.
- Added property
3.0.0
This SDK is a rebranded and updated version of the SDK that was previously published under the Ingenico name. Next to renaming to Worldline, the SDK has been restructured to better support future improvements like multiple API versions and different authentication mechanisms. You can use the migration guide to upgrade from the previous version. Previous versions and release notes of this SDK can be found here.
The following is an overview of changes:
- Added:
- Added optional
MetadataProvider
,Connection
,Authenticator
andMarshaller
parameters to methodscreate_communicator_from_configuration
,create_communicator_from_file
,create_client_from_configuration
andcreate_client_from_file
of classFactory
. - Added an optional
marshaller
parameter to methodcreate_helper
of classV1WebhooksFactory
(previously classWebhooks
).
- Added optional
- Changed:
- Renamed all modules, and moved classes between modules. Each API version now has its own module structure that contains all classes specific for that version, including classes like
APIError
, exceptions and webhooks classes. - Made the integrator required.
- Moved method
merchant
from classClient
to new classV1Client
. Instances of this class are available through methodv1
of classClient
. - Moved method
create_helper
from classWebhooks
to new classV1WebhooksFactory
. Instances of this class are available through methodv1
of classWebhooks
. - Replaced properties
api_key_id
andsecret_api_key
of classCommunicatorConfiguration
with more generic propertiesauthorization_id
andauthorization_secret
. The existing properties and constructor parameter names remain as aliases though. - Replace constant
EndpointConfiguration.@@DEFAULT_MAX_CONNECTIONS
and methodEndpointConfiguration.DEFAULT_MAX_CONNECTIONS
with methodCommunicatorConfiguration.default_max_connections
. - Renamed class
GlobalCollectException
toPlatformException
. - Renamed method
create_simple_authentication_signature
of classAuthenticator
toget_authorization
. - Renamed class
DefaultAuthenticator
toV1HMACAuthenticator
. - Renamed class
MetaDataProvider
and itsmeta_data_headers
property toMetadataProvider
andmetadata_headers
respectively. - Renamed methods
SDK_VERSION
,SERVER_META_INFO_HEADER
andPROHIBITED_HEADERS
of classMetadataProvider
tosdk_version
,server_meta_info_header
andprohibited_headers
respectively. - Made the
@@SDK_VERSION
,@@SERVER_META_INFO_HEADER
,@@PROHIBITED_HEADERS
and@@CHARSET
constants of classMetadataProvider
private. - Made the
CONTENT_TYPE
andJSON_CONTENT_TYPE
constants of classDefaultConnection
private. - Class
Connection
now includes theObfuscationCapable
mixin module. - Integrated class
Session
into classCommunicator
. - Changed the arguments of the
ApiResource
constructor to named arguments, to make it clear what each argument means.ApiResource
's communicator/parent parameter has also been split into separate parameters.
- Renamed all modules, and moved classes between modules. Each API version now has its own module structure that contains all classes specific for that version, including classes like
- Removed:
- Removed file
exceptions.rb
. - Removed file
modules.rb
. - Removed method
API_VERSION
of classClient
. - Removed method
create_exception
of classApiResource
in favor of separatecreate_exception
functions per API version. - Removed class
Session
. - Removed methods
create_session_from_configuration
,create_session_from_file
,create_communicator_from_session
andcreate_client_from_session
of classFactory
. - Removed parameter
authorization_type
from theV1HMACAuthenticator
constructor, as its value should always bev1HMAC
. - Removed constants
HMAC_ALGOR
,CONTENT_TYPE
,DATE
andXGCS
of classV1HMACAuthenticator
. These shouldn't have been exposed in the first place. - Removed method
get_signature_string
of classAuthorizationType
, as it always returnedV1HMAC
. - Removed method
validate
of classWebhooksHelper
. - Removed alias
INSTANCE
for methodinstance
of classDefaultMarshaller
. - Removed alias
INSTANCE
for methodinstance
of classStdoutCommunicatorLogger
. - Removed class
EndpointConfiguration
. Its properties have been merged into its only sub classCommunicatorConfiguration
. - Removed previously deprecated module
LoggingUtil
. - Removed previously deprecated classes
ValueObfuscator
,Obfuscator
,HeaderObfuscator
andPropertyObfuscator
of moduleWorldline::Connect::SDK::Logging
. - Removed class
WebhooksHelperBuilder
and methodWebhooks.create_helper_builder
.
- Removed file