3.1.0

• Added:
  • Added property network_token_used to class CardPaymentMethodSpecificOutput.
  • Added property naics_commodity_code to class OrderLineDetails.
  • Added property shipped_from_zip to class Shipping.

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 and Marshaller parameters to methods create_communicator_from_configuration, create_communicator_from_file, create_client_from_configuration and create_client_from_file of class Factory.
  • Added an optional marshaller parameter to method create_helper of class V1WebhooksFactory (previously class Webhooks).
• 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 class Client to new class V1Client. Instances of this class are available through method v1 of class Client.
  • Moved method create_helper from class Webhooks to new class V1WebhooksFactory. Instances of this class are available through method v1 of class Webhooks.
  • Replaced properties api_key_id and secret_api_key of class CommunicatorConfiguration with more generic properties authorization_id and authorization_secret. The existing properties and constructor parameter names remain as aliases though.
  • Replace constant EndpointConfiguration.@@DEFAULT_MAX_CONNECTIONS and method EndpointConfiguration.DEFAULT_MAX_CONNECTIONS with method CommunicatorConfiguration.default_max_connections.
  • Renamed class GlobalCollectException to PlatformException.
  • Renamed method create_simple_authentication_signature of class Authenticator to get_authorization.
  • Renamed class DefaultAuthenticator to V1HMACAuthenticator.
  • Renamed class MetaDataProvider and its meta_data_headers property to MetadataProvider and metadata_headers respectively.
  • Renamed methods SDK_VERSION, SERVER_META_INFO_HEADER and PROHIBITED_HEADERS of class MetadataProvider to sdk_version, server_meta_info_header and prohibited_headers respectively.
  • Made the @@SDK_VERSION, @@SERVER_META_INFO_HEADER, @@PROHIBITED_HEADERS and @@CHARSET constants of class MetadataProvider private.
  • Made the CONTENT_TYPE and JSON_CONTENT_TYPE constants of class DefaultConnection private.
  • Class Connection now includes the ObfuscationCapable mixin module.
  • Integrated class Session into class Communicator.
  • 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.
• Removed:
  • Removed file exceptions.rb.
  • Removed file modules.rb.
  • Removed method API_VERSION of class Client.
  • Removed method create_exception of class ApiResource in favor of separate create_exception functions per API version.
  • Removed class Session.
  • Removed methods create_session_from_configuration, create_session_from_file, create_communicator_from_session and create_client_from_session of class Factory.
  • Removed parameter authorization_type from the V1HMACAuthenticator constructor, as its value should always be v1HMAC.
  • Removed constants HMAC_ALGOR, CONTENT_TYPE, DATE and XGCS of class V1HMACAuthenticator. These shouldn't have been exposed in the first place.
  • Removed method get_signature_string of class AuthorizationType, as it always returned V1HMAC.
  • Removed method validate of class WebhooksHelper.
  • Removed alias INSTANCE for method instance of class DefaultMarshaller.
  • Removed alias INSTANCE for method instance of class StdoutCommunicatorLogger.
  • Removed class EndpointConfiguration. Its properties have been merged into its only sub class CommunicatorConfiguration.
  • Removed previously deprecated module LoggingUtil.
  • Removed previously deprecated classes ValueObfuscator, Obfuscator, HeaderObfuscator and PropertyObfuscator of module Worldline::Connect::SDK::Logging.
  • Removed class WebhooksHelperBuilder and method Webhooks.create_helper_builder.