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
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntitycancelSubscription(String cisClientRef, String merchantSubscriptionId, String effectiveFrom) Cancels an existing subscriptionorg.springframework.http.ResponseEntitychangeSubscriptionState(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 subscriptionorg.springframework.http.ResponseEntitycreateCustomerProfile(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.ResponseEntitycreateSubscription(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 subscriptionorg.springframework.http.ResponseEntityfinalizeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest) Calls the CIS Server in order to finalize the Web Sessionorg.springframework.http.ResponseEntitygetBillingActivityDetail(String cisClientRef, String billingActivityId) Returns the billing activity detail for the given id.org.springframework.http.ResponseEntitygetBillingActivityList(String cisClientRef, String subscriptionId, Date fromDate, Date toDate) Returns the billing activity list for the given subscription optionally filtered by date.org.springframework.http.ResponseEntitygetCustomerProfile(String cisClientRef, String merchantAccountId) The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).org.springframework.http.ResponseEntityRetrieves the URL for the silent order pageorg.springframework.http.ResponseEntityinitializeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest) Calls the CIS Server in order to initialize the Web Sessionorg.springframework.http.ResponseEntityprocessPayNow(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 providerorg.springframework.http.ResponseEntityreplacePaymentMethod(String cisClientRef, String merchantSubscriptionId, String merchantPaymentMethodId, 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.ResponseEntityupdatePaymentMethod(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.ResponseEntityupdateProfile(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 idorg.springframework.http.ResponseEntityupdateSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpdateRequest subscriptionUpdateRequest) This methods calls the CIS server in order to update an existing subscriptionorg.springframework.http.ResponseEntityupdateSubscription(String cisClientRef, String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction) Updates an existing subscriptionorg.springframework.http.ResponseEntityupgradeSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpgradeRequest subscriptionUpgradeRequest) This methods calls the CIS server in order to upgrade an existing subscription
-
Method Details
-
createCustomerProfile
org.springframework.http.ResponseEntity createCustomerProfile(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-StringcreateAccountRequest-CisSubscriptionProfileRequest- Returns:
- result object from the CIS server
- Since:
- SBG API 5.2
-
updateProfile
org.springframework.http.ResponseEntity updateProfile(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-StringprofileRequest-CisSubscriptionProfileRequest- Returns:
- result object from the CIS server
-
createSubscription
org.springframework.http.ResponseEntity createSubscription(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-StringcreateSubscriptionRequest-CisSubscriptionCreateRequest- Returns:
- result object from the CIS server
- Since:
- SBG API 5.2
-
replacePaymentMethod
org.springframework.http.ResponseEntity replacePaymentMethod(String cisClientRef, String merchantSubscriptionId, String merchantPaymentMethodId, String effectiveFrom) This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method. -
processPayNow
org.springframework.http.ResponseEntity processPayNow(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-StringpayNowRequest-CisSubscriptionPayNowRequest- Returns:
- result object from the CIS server
-
initializeTransaction
org.springframework.http.ResponseEntity initializeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest) Calls the CIS Server in order to initialize the Web Session- Parameters:
cisClientRef-StringinitRequest-CisSubscriptionSessionInitRequest- Returns:
- result object from the CIS server
-
finalizeTransaction
org.springframework.http.ResponseEntity finalizeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest) Calls the CIS Server in order to finalize the Web Session- Parameters:
cisClientRef-StringfinalizeRequest-CisSubscriptionSessionFinalizeRequest- Returns:
- result object from the CIS server
-
hpfUrl
Retrieves the URL for the silent order page- Parameters:
cisClientRef-String- Returns:
- url as String
-
updatePaymentMethod
org.springframework.http.ResponseEntity updatePaymentMethod(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-StringupdatePaymentRequest-CisPaymentMethodUpdateRequest- Returns:
- result object from the CIS server
-
cancelSubscription
org.springframework.http.ResponseEntity cancelSubscription(String cisClientRef, String merchantSubscriptionId, String effectiveFrom) Cancels an existing subscription -
updateSubscription
org.springframework.http.ResponseEntity updateSubscription(String cisClientRef, String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction) Updates an existing subscription- Parameters:
cisClientRef-StringsubscriptionId-Stringforce- boolean flag set in requestupdateAction-CisSubscriptionUpdateAction- Returns:
- result object from the CIS server
-
getCustomerProfile
org.springframework.http.ResponseEntity getCustomerProfile(String cisClientRef, String merchantAccountId) The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions). -
upgradeSubscription
org.springframework.http.ResponseEntity upgradeSubscription(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-StringsubscriptionUpgradeRequest-CisSubscriptionUpgradeRequest- Returns:
- result object from the CIS server
-
updateSubscription
org.springframework.http.ResponseEntity updateSubscription(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-StringsubscriptionUpdateRequest-CisSubscriptionUpdateRequest- Returns:
- result object from the CIS server
-
changeSubscriptionState
org.springframework.http.ResponseEntity changeSubscriptionState(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-StringsubscriptionChangeStateRequest-CisSubscriptionChangeStateRequest- Returns:
- result object from the CIS server
-
getBillingActivityList
org.springframework.http.ResponseEntity getBillingActivityList(String cisClientRef, String subscriptionId, Date fromDate, Date toDate) Returns the billing activity list for the given subscription optionally filtered by date. -
getBillingActivityDetail
org.springframework.http.ResponseEntity getBillingActivityDetail(String cisClientRef, String billingActivityId) Returns the billing activity detail for the given id.
-