Package de.hybris.platform.integration.cis.subscription.service

Interface CisSubscriptionService

  • All Known Implementing Classes:
    DefaultCisSubscriptionService
    public interface CisSubscriptionService
    Service called from the facade layer which delegates requests from the client to the CIS server

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.http.ResponseEntity cancelSubscription​(java.lang.String cisClientRef, java.lang.String merchantSubscriptionId, java.lang.String effectiveFrom)
      Cancels an existing subscription
      org.springframework.http.ResponseEntity changeSubscriptionState​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionChangeStateRequest subscriptionChangeStateRequest)
      This methods calls the CIS server in order to change the status of an existing subscription
      org.springframework.http.ResponseEntity createCustomerProfile​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest createAccountRequest)
      The methods calls the CIS server in order to create a customer profile.
      org.springframework.http.ResponseEntity createSubscription​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionCreateRequest createSubscriptionRequest)
      This methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription
      org.springframework.http.ResponseEntity finalizeTransaction​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest)
      Calls the CIS Server in order to finalize the Web Session
      org.springframework.http.ResponseEntity getBillingActivityDetail​(java.lang.String cisClientRef, java.lang.String billingActivityId)
      Returns the billing activity detail for the given id.
      org.springframework.http.ResponseEntity getBillingActivityList​(java.lang.String cisClientRef, java.lang.String subscriptionId, java.util.Date fromDate, java.util.Date toDate)
      Returns the billing activity list for the given subscription optionally filtered by date.
      org.springframework.http.ResponseEntity getCustomerProfile​(java.lang.String cisClientRef, java.lang.String merchantAccountId)
      The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).
      org.springframework.http.ResponseEntity hpfUrl​(java.lang.String cisClientRef)
      Retrieves the URL for the silent order page
      org.springframework.http.ResponseEntity initializeTransaction​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest)
      Calls the CIS Server in order to initialize the Web Session
      org.springframework.http.ResponseEntity processPayNow​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionPayNowRequest payNowRequest)
      Calls the CIS Service to process the paynow prices of an order at the payment provider
      org.springframework.http.ResponseEntity replacePaymentMethod​(java.lang.String cisClientRef, java.lang.String merchantSubscriptionId, java.lang.String merchantPaymentMethodId, java.lang.String effectiveFrom)
      This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.
      org.springframework.http.ResponseEntity updatePaymentMethod​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisPaymentMethodUpdateRequest updatePaymentRequest)
      This methods calls the CIS server in order to perform changes on an existing payment method.
      org.springframework.http.ResponseEntity updateProfile​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest profileRequest)
      Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id
      org.springframework.http.ResponseEntity updateSubscription​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpdateRequest subscriptionUpdateRequest)
      This methods calls the CIS server in order to update an existing subscription
      org.springframework.http.ResponseEntity updateSubscription​(java.lang.String cisClientRef, java.lang.String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction)
      Updates an existing subscription
      org.springframework.http.ResponseEntity upgradeSubscription​(java.lang.String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpgradeRequest subscriptionUpgradeRequest)
      This methods calls the CIS server in order to upgrade an existing subscription

    • Method Detail

      • createCustomerProfile

        org.springframework.http.ResponseEntity createCustomerProfile​(java.lang.String cisClientRef,
                                                              com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest createAccountRequest)
        The methods calls the CIS server in order to create a customer profile.
        Parameters:
        cisClientRef - String
        createAccountRequest - CisSubscriptionProfileRequest
        Returns:
        result object from the CIS server
        Since:
        SBG API 5.2

      • updateProfile

        org.springframework.http.ResponseEntity updateProfile​(java.lang.String cisClientRef,
                                                      com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest profileRequest)
        Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id
        Parameters:
        cisClientRef - String
        profileRequest - CisSubscriptionProfileRequest
        Returns:
        result object from the CIS server

      • createSubscription

        org.springframework.http.ResponseEntity createSubscription​(java.lang.String cisClientRef,
                                                           com.hybris.cis.api.subscription.model.CisSubscriptionCreateRequest createSubscriptionRequest)
        This methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription
        Parameters:
        cisClientRef - String
        createSubscriptionRequest - CisSubscriptionCreateRequest
        Returns:
        result object from the CIS server
        Since:
        SBG API 5.2

      • replacePaymentMethod

        org.springframework.http.ResponseEntity replacePaymentMethod​(java.lang.String cisClientRef,
                                                             java.lang.String merchantSubscriptionId,
                                                             java.lang.String merchantPaymentMethodId,
                                                             java.lang.String effectiveFrom)
        This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.
        Parameters:
        cisClientRef - String
        merchantSubscriptionId - id of the subscription to be updated String
        merchantPaymentMethodId - id of the substituting payment method String
        effectiveFrom - when the new payment method should be effective String
        Returns:
        result object from the CIS server

      • processPayNow

        org.springframework.http.ResponseEntity processPayNow​(java.lang.String cisClientRef,
                                                      com.hybris.cis.api.subscription.model.CisSubscriptionPayNowRequest payNowRequest)
        Calls the CIS Service to process the paynow prices of an order at the payment provider
        Parameters:
        cisClientRef - String
        payNowRequest - CisSubscriptionPayNowRequest
        Returns:
        result object from the CIS server

      • initializeTransaction

        org.springframework.http.ResponseEntity initializeTransaction​(java.lang.String cisClientRef,
                                                              com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest)
        Calls the CIS Server in order to initialize the Web Session
        Parameters:
        cisClientRef - String
        initRequest - CisSubscriptionSessionInitRequest
        Returns:
        result object from the CIS server

      • finalizeTransaction

        org.springframework.http.ResponseEntity finalizeTransaction​(java.lang.String cisClientRef,
                                                            com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest)
        Calls the CIS Server in order to finalize the Web Session
        Parameters:
        cisClientRef - String
        finalizeRequest - CisSubscriptionSessionFinalizeRequest
        Returns:
        result object from the CIS server

      • hpfUrl

        org.springframework.http.ResponseEntity hpfUrl​(java.lang.String cisClientRef)
        Retrieves the URL for the silent order page
        Parameters:
        cisClientRef - String
        Returns:
        url as String

      • updatePaymentMethod

        org.springframework.http.ResponseEntity updatePaymentMethod​(java.lang.String cisClientRef,
                                                            com.hybris.cis.api.subscription.model.CisPaymentMethodUpdateRequest updatePaymentRequest)
        This methods calls the CIS server in order to perform changes on an existing payment method.
        Parameters:
        cisClientRef - String
        updatePaymentRequest - CisPaymentMethodUpdateRequest
        Returns:
        result object from the CIS server

      • cancelSubscription

        org.springframework.http.ResponseEntity cancelSubscription​(java.lang.String cisClientRef,
                                                           java.lang.String merchantSubscriptionId,
                                                           java.lang.String effectiveFrom)
        Cancels an existing subscription
        Parameters:
        cisClientRef - String
        merchantSubscriptionId - String
        effectiveFrom - String
        Returns:
        result object from the CIS server
        Since:
        SBG API 5.2

      • updateSubscription

        org.springframework.http.ResponseEntity updateSubscription​(java.lang.String cisClientRef,
                                                           java.lang.String subscriptionId,
                                                           boolean force,
                                                           CisSubscriptionUpdateAction updateAction)
        Updates an existing subscription
        Parameters:
        cisClientRef - String
        subscriptionId - String
        force - boolean flag set in request
        updateAction - CisSubscriptionUpdateAction
        Returns:
        result object from the CIS server

      • getCustomerProfile

        org.springframework.http.ResponseEntity getCustomerProfile​(java.lang.String cisClientRef,
                                                           java.lang.String merchantAccountId)
        The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).
        Parameters:
        cisClientRef - String
        merchantAccountId - String
        Returns:
        result object from the CIS server

      • upgradeSubscription

        org.springframework.http.ResponseEntity upgradeSubscription​(java.lang.String cisClientRef,
                                                            com.hybris.cis.api.subscription.model.CisSubscriptionUpgradeRequest subscriptionUpgradeRequest)
        This methods calls the CIS server in order to upgrade an existing subscription
        Parameters:
        cisClientRef - String
        subscriptionUpgradeRequest - CisSubscriptionUpgradeRequest
        Returns:
        result object from the CIS server

      • updateSubscription

        org.springframework.http.ResponseEntity updateSubscription​(java.lang.String cisClientRef,
                                                           com.hybris.cis.api.subscription.model.CisSubscriptionUpdateRequest subscriptionUpdateRequest)
        This methods calls the CIS server in order to update an existing subscription
        Parameters:
        cisClientRef - String
        subscriptionUpdateRequest - CisSubscriptionUpdateRequest
        Returns:
        result object from the CIS server

      • changeSubscriptionState

        org.springframework.http.ResponseEntity changeSubscriptionState​(java.lang.String cisClientRef,
                                                                com.hybris.cis.api.subscription.model.CisSubscriptionChangeStateRequest subscriptionChangeStateRequest)
        This methods calls the CIS server in order to change the status of an existing subscription
        Parameters:
        cisClientRef - String
        subscriptionChangeStateRequest - CisSubscriptionChangeStateRequest
        Returns:
        result object from the CIS server

      • getBillingActivityList

        org.springframework.http.ResponseEntity getBillingActivityList​(java.lang.String cisClientRef,
                                                               java.lang.String subscriptionId,
                                                               java.util.Date fromDate,
                                                               java.util.Date toDate)
        Returns the billing activity list for the given subscription optionally filtered by date.
        Parameters:
        cisClientRef - String
        subscriptionId - String
        fromDate - String
        toDate - String
        Returns:
        result object from the CIS server

      • getBillingActivityDetail

        org.springframework.http.ResponseEntity getBillingActivityDetail​(java.lang.String cisClientRef,
                                                                 java.lang.String billingActivityId)
        Returns the billing activity detail for the given id.
        Parameters:
        cisClientRef - String
        billingActivityId - String
        Returns:
        result object from the CIS server