diff --git a/pom.xml b/pom.xml index bfd4433..c09b891 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ 4.0.0 com.cleeng cleeng-java-sdk - 2.7.0 + 2.8.0 Cleeng Java SDK @@ -72,6 +72,19 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9.1 + + + attach-javadocs + + jar + + + + org.eluder.coveralls coveralls-maven-plugin @@ -90,17 +103,6 @@ - - org.sonatype.plugins - nexus-staging-maven-plugin - 1.6.7 - true - - ossrh - https://oss.sonatype.org/ - true - - org.apache.maven.plugins maven-source-plugin @@ -113,16 +115,6 @@ - - - org.apache.maven.plugins - maven-release-plugin - 2.5 - - false - release - deploy - @@ -150,20 +142,41 @@ - - org.apache.maven.plugins - maven-gpg-plugin - 1.5 - - - sign-artifacts - verify - - sign - - - - + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + verify + + sign + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ossrh + https://oss.sonatype.org/ + false + + + + org.apache.maven.plugins + maven-release-plugin + 2.5 + + false + release + deploy + + @@ -202,7 +215,7 @@ org.asynchttpclient async-http-client - 2.0.29 + 2.0.35 junit diff --git a/src/main/java/com/cleeng/api/Cleeng.java b/src/main/java/com/cleeng/api/Cleeng.java index 3d06d16..39f8e61 100644 --- a/src/main/java/com/cleeng/api/Cleeng.java +++ b/src/main/java/com/cleeng/api/Cleeng.java @@ -15,768 +15,832 @@ public interface Cleeng { HttpClient getClient(); /** - * Creates a subscription offer.
- *
+ * Creates a subscription offer. + * * * @param offerData domain object representing offer data - * @return + * @return offer response + * @throws IOException if I/O exception occurred */ OfferResponse createSubscriptionOffer(SubscriptionOfferData offerData) throws IOException; /** * Creates subscription offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void createSubscriptionOfferAsync(List requests) throws IOException, InterruptedException; /** - * Updates a subscription offer.
- *
+ * Updates a subscription offer. + * * * @param offerData domain object representing offer data * @param offerId offer id - * @return + * @throws IOException if I/O exception occurred + * @return offer response */ OfferResponse updateSubscriptionOffer(SubscriptionOfferData offerData, String offerId) throws IOException; /** * Updates subscription offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests requests + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void updateSubscriptionOfferAsync(List requests) throws IOException, InterruptedException; /** - * Creates a single offer.
- *
+ * Creates a single offer. + * * * @param offerData domain object representing single offer data - * @return + * @throws IOException if I/O exception occurred + * @return Single offer response */ SingleOfferResponse createSingleOffer(SingleOfferData offerData) throws IOException; /** * Creates single offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void createSingleOfferAsync(List requests) throws IOException, InterruptedException; /** - * Updates a single offer.
- *
+ * Updates a single offer. * + * @param offerId offer Id * @param offerData domain object representing single offer data - * @return + * @throws IOException if I/O exception occurred + * @return Single offer response */ SingleOfferResponse updateSingleOffer(String offerId, SingleOfferData offerData) throws IOException; /** * Updates single offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void updateSingleOfferAsync(List requests) throws IOException, InterruptedException; /** - * Creates an event offer.
- *
+ * Creates an event offer. + * * * @param offerData domain object representing event offer data - * @return + * @throws IOException if I/O exception occurred + * @return event offer response */ EventOfferResponse createEventOffer(EventOfferData offerData) throws IOException; /** - * Creates an event offers (async).
- *
+ * Creates an event offers (async). + * * - * @param requests - * @throws IOException - * @throws InterruptedException + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void createEventOfferAsync(List requests) throws IOException, InterruptedException; /** - * Updates an event offer.
- *
+ * Updates an event offer. + * * * @param offerData domain object representing event offer data * @param offerId offer Id - * @return + * @throws IOException if I/O exception occurred + * @return event offer response */ EventOfferResponse updateEventOffer(EventOfferData offerData, String offerId) throws IOException; /** * Updates event offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void updateEventOfferAsync(List requests) throws IOException, InterruptedException; /** - * Creates a rental offer.
- *
+ * Creates a rental offer. + * * * @param offerData domain object representing rental offer data - * @return + * @throws IOException if I/O exception occurred + * @return rental offer response */ RentalOfferResponse createRentalOffer(RentalOfferData offerData) throws IOException; /** - * Creates rental offers (async).
- *
+ * Creates rental offers (async). * - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void createRentalOfferAsync(List requests) throws IOException, InterruptedException; /** - * Updates a rental offer.
- *
+ * Updates a rental offer. + * * * @param offerData domain object representing rental offer data * @param offerId offer Id - * @return + * @throws IOException if I/O exception occurred + * @return Rental Offer Response */ RentalOfferResponse updateRentalOffer(RentalOfferData offerData, String offerId) throws IOException; /** * Updates rental offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void updateRentalOfferAsync(List requests) throws IOException, InterruptedException; /** - * Creates a pass offer.
- *
+ * Creates a pass offer. + * * * @param offerData domain object representing pass offer data - * @return + * @throws IOException if I/O exception occurred + * @return pass offer response */ PassOfferResponse createPassOffer(PassOfferData offerData) throws IOException; /** - * Updates a pass offer.
- *
+ * Updates a pass offer. + * * * @param offerData domain object representing pass offer data * @param offerId offer Id - * @return + * @throws IOException if I/O exception occurred + * @return offer response */ - public OfferResponse updatePassOffer(PassOfferData offerData, String offerId) throws IOException; + OfferResponse updatePassOffer(PassOfferData offerData, String offerId) throws IOException; /** * Updates pass offers (async) - *
* - * @param requests - * @throws IOException - * @throws InterruptedException + * + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void updatePassOfferAsync(List requests) throws IOException, InterruptedException; /** - * Creates pass offers (async).
- *
+ * Creates pass offers (async). + * * - * @param requests - * @throws IOException - * @throws InterruptedException + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void createPassOfferAsync(List requests) throws IOException, InterruptedException; /** - * Lists subscription offers.
- *
+ * Lists subscription offers. + * * * @param criteria domain object representing search criteria * @param offset pagination offset * @param limit pagination's items per page - * @return + * @throws IOException if I/O exception occurred + * @return list subscription offers response */ ListSubscriptionOffersResponse listSubscriptionOffers(Criteria criteria, int offset, int limit) throws IOException; /** - * Lists subscription offers (async).
- *
+ * Lists subscription offers (async). + * * * @param requests collection of AsyncListRequest objects - * @throws IOException - * @throws InterruptedException + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listSubscriptionOffersAsync(List requests) throws IOException, InterruptedException; /** - * Lists single offers.
- *
+ * Lists single offers. + * * * @param criteria domain object representing search criteria * @param offset pagination offset * @param limit pagination's items per page - * @return + * @throws IOException if I/O exception occurred + * @return list of single offers response */ ListSingleOffersResponse listSingleOffers(Criteria criteria, int offset, int limit) throws IOException; /** - * Lists single offers (async).
- *
+ * Lists single offers (async). + * * * @param requests collection of AsyncListRequest objects - * @throws IOException - * @throws InterruptedException + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listSingleOffersAsync(List requests) throws IOException, InterruptedException; /** - * Lists vod offers.
- *
+ * Lists vod offers. + * * * @param criteria domain object representing search criteria * @param offset pagination offset * @param limit pagination's items per page - * @return + * @throws IOException if I/O exception occurred + * @return list vod offers response */ ListVodOffersResponse listVodOffers(Criteria criteria, int offset, int limit) throws IOException; /** - * Lists vod offers (async).
- *
+ * Lists vod offers (async). + * * * @param requests collection of AsyncListRequest objects - * @throws IOException - * @throws InterruptedException + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listVodOffersAsync(List requests) throws IOException, InterruptedException; /** - * Lists pass offers.
- *
+ * Lists pass offers. + * * * @param criteria domain object representing search criteria * @param offset pagination offset * @param limit pagination's limit - * @return + * @throws IOException if I/O exception occurred + * @return list pass offers response */ ListPassOffersResponse listPassOffers(Criteria criteria, int offset, int limit) throws IOException; /** - * Lists pass offers (async).
- *
+ * Lists pass offers (async). + * * * @param requests collection of AsyncListRequest objects - * @throws IOException - * @throws InterruptedException + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listPassOffersAsync(List requests) throws IOException, InterruptedException; /** - * Prepares a remote auth.
- *
+ * Prepares a remote auth. + * * * @param customerData domain object representing customer's data * @param flowDescription domain object representing flow description - * @return + * @throws IOException if I/O exception occurred + * @return prepare remote auth response */ PrepareRemoteAuthResponse prepareRemoteAuth(CustomerData customerData, FlowDescription flowDescription) throws IOException; /** - * Prepares a remote auth (async).
- *
+ * Prepares a remote auth (async). + * * * @param requests collection of AsyncPrepareRemoteAuthRequest objects - * @throws IOException - * @throws InterruptedException + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void prepareRemoteAuthAsync(List requests) throws IOException, InterruptedException; /** - * Generates a customer token.
- *
+ * Generates a customer token. + * * * @param customerEmail customer's email - * @return + * @throws IOException if I/O exception occurred + * @return token response */ TokenResponse generateCustomerToken(String customerEmail) throws IOException; /** - * Generates a customer token (async)
- *
+ * Generates a customer token (async) + * * * @param requests collection of AsyncTokenRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void generateCustomerTokenAsync(List requests) throws IOException, InterruptedException; /** - * Requests user's password reset.
- *
+ * Requests user's password reset. + * * * @param customerEmail customer's email - * @return + * @throws IOException if I/O exception occurred + * @return boolean response */ BooleanResponse requestPasswordReset(String customerEmail) throws IOException; /** - * Requests user's password reset (async).
- *
+ * Requests user's password reset (async). + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void requestPasswordResetAsync(List requests) throws IOException, InterruptedException; /** - * Updates user's password.
- *
+ * Updates user's password. + * * * @param customerEmail customer's email * @param resetPasswordToken token received on email * @param newPassword new password - * @return + * @throws IOException if I/O exception occurred + * @return boolean response */ BooleanResponse updateCustomerPassword(String customerEmail, String resetPasswordToken, String newPassword) throws IOException; /** - * Updates customer password (async).
- *
+ * Updates customer password (async). + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void updateCustomerPasswordAsync(List requests) throws IOException, InterruptedException; + void updateCustomerPasswordAsync(List requests) throws IOException, InterruptedException; /** - * Updates customer's subscription.
- *
+ * Updates customer's subscription. + * * * @param offerId offer Id * @param customerEmail customer email * @param offerData offer data - * @return + * @throws IOException if I/O exception occurred + * @return update customer subscription response */ UpdateCustomerSubscriptionResponse updateCustomerSubscription(String offerId, String customerEmail, UpdateCustomerSubscriptionOfferData offerData) throws IOException; /** - * Updates customer's subscription (async).
- *
+ * Updates customer's subscription (async). + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void updateCustomerSubscriptionAsync(List requests) throws IOException, InterruptedException; + void updateCustomerSubscriptionAsync(List requests) throws IOException, InterruptedException; /** - * Updates user's email.
- *
+ * Updates user's email. + * * * @param customerEmail customer's email * @param newEmail new email - * @return + * @throws IOException if I/O exception occurred + * @return boolean response */ BooleanResponse updateCustomerEmail(String customerEmail, String newEmail) throws IOException; /** - * Updates customer email (async).
- *
+ * Updates customer email (async). + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void updateCustomerEmailAsync(List requests) throws IOException, InterruptedException; + void updateCustomerEmailAsync(List requests) throws IOException, InterruptedException; /** - * Generates a customer token from facebook.
- *
+ * Generates a customer token from facebook. + * * * @param facebookId facebook login - * @return + * @throws IOException if I/O exception occurred + * @return token response */ TokenResponse generateCustomerTokenFromFacebook(String facebookId) throws IOException; /** - * Generates a customer token from facebook (async)
- *
+ * Generates a customer token from facebook (async) + * * * @param requests collection of AsyncTokenRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void generateCustomerTokenFromFacebookAsync(List requests) throws IOException, InterruptedException; /** - * Generates a customer token from password.
- *
+ * Generates a customer token from password. + * * * @param password password - * @return + * @param customerEmail customer email + * @throws IOException if I/O exception occurred + * @return token response */ TokenResponse generateCustomerTokenFromPassword(String password, String customerEmail) throws IOException; /** - * Generates a customer token from password (async)
- *
+ * Generates a customer token from password (async) + * * * @param requests collection of AsyncTokenRequest objects - * @return + * @throws IOException if I/O exception occurs + * @throws InterruptedException if operation thread is interrupted */ void generateCustomerTokenFromPasswordAsync(List requests) throws IOException, InterruptedException; /** - * Gets access status.
- *
+ * Gets access status. + * * * @param customerToken customer token * @param offerId offer Id * @param ipAddress IP address - * @return + * @throws IOException if I/O exception occurred + * @return get access status response */ GetAccessStatusResponse getAccessStatus(String customerToken, String offerId, String ipAddress) throws IOException; /** - * Gets access status (async)
- *
+ * Gets access status (async) + * * * @param requests collection of AsyncGetAccessStatusRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void getAccessStatusAsync(List requests) throws IOException, InterruptedException; + void getAccessStatusAsync(List requests) throws IOException, InterruptedException; /** - * Get accessible tags.
- *
+ * Get accessible tags. + * * * @param publisherToken publisher's token * @param customerToken customer's token - * @return + * @throws IOException if I/O exception occurred + * @return get accessible tags response */ GetAccessibleTagsResponse getAccessibleTags(String publisherToken, String customerToken) throws IOException; /** - * Gets accessible tags (async)
- *
+ * Gets accessible tags (async) + * * * @param requests collection of AsyncGetAccessibleTagsRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void getAccessibleTagsAsync(List requests) throws IOException, InterruptedException; /** - * Get customer
- *
+ * Get customer + * * * @param customerToken customer's token - * @return + * @throws IOException if I/O exception occurred + * @return get customer response */ GetCustomerResponse getCustomer(String customerToken) throws IOException; /** - * Get customer (async)
- *
+ * Get customer (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void getCustomerAsync(List requests) throws IOException, InterruptedException; /** - * Creates Vod offer
- *
+ * Creates Vod offer + * * * @param offerData vod offer data - * @return + * @throws IOException if I/O exception occurred + * @return vod offer response */ VodOfferResponse createVodOffer(VodOfferData offerData) throws IOException; /** - * Creates Vod offer (async)
- *
+ * Creates Vod offer (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void createVodOfferAsync(List requests) throws IOException, InterruptedException; /** - * Gets Vod offer
- *
+ * Gets Vod offer + * * * @param offerId an id of an offer - * @return + * @throws IOException if I/O exception occurred + * @return vod offer response */ - public VodOfferResponse getVodOffer(String offerId) throws IOException; + VodOfferResponse getVodOffer(String offerId) throws IOException; /** - * Gets Vod offer (async)
- *
+ * Gets Vod offer (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void getVodOfferAsync(List requests) throws IOException, InterruptedException; + void getVodOfferAsync(List requests) throws IOException, InterruptedException; /** - * Updates Vod offer
- *
+ * Updates Vod offer + * * * @param offerId offer id * @param offerData vod offer data - * @return + * @throws IOException if I/O exception occurred + * @return vod offer response */ - public VodOfferResponse updateVodOffer(String offerId, VodOfferData offerData) throws IOException; + VodOfferResponse updateVodOffer(String offerId, VodOfferData offerData) throws IOException; /** - * Updates Vod offer(s) (async)
- *
+ * Updates Vod offer(s) (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void updateVodOfferAsync(List requests) throws IOException, InterruptedException; + void updateVodOfferAsync(List requests) throws IOException, InterruptedException; /** * Generates a checkout url * - * @param customerEmail vod offer data + * @param customerEmail customer email + * @param flowDescription flow description * - * @return - * @throws IOException + * @return url response + * @throws IOException if I/O exception occurred */ - public UrlResponse generateCheckoutUrl(String customerEmail, FlowDescription flowDescription) throws IOException; + UrlResponse generateCheckoutUrl(String customerEmail, FlowDescription flowDescription) throws IOException; /** - * Generates checkout urls (async)
- *
+ * Generates checkout urls (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void generateCheckoutUrlAsync(List requests) throws IOException, InterruptedException; + void generateCheckoutUrlAsync(List requests) throws IOException, InterruptedException; /** * Registers a customer * * @param data customer data * - * @return - * @throws IOException + * @return token response + * @throws IOException if I/O exception occurred */ - public TokenResponse registerCustomer(CustomerData data) throws IOException; + TokenResponse registerCustomer(CustomerData data) throws IOException; /** - * Registers customers (async)
- *
+ * Registers customers (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void registerCustomerAsync(List requests) throws IOException, InterruptedException; + void registerCustomerAsync(List requests) throws IOException, InterruptedException; /** - * Generates my account url
- *
+ * Generates my account url + * * * @param customerEmail customer email - * @param modules lis of modules - * @return + * @param modules a list of modules + * @throws IOException if I/O exception occurred + * @return url response */ UrlResponse generateMyAccountUrl(String customerEmail, List modules) throws IOException; /** - * Generates my account url (async)
- *
+ * Generates my account url (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void generateMyAccountUrlAsync(List requests) throws IOException, InterruptedException; /** - * Lists payment details
- *
+ * Lists payment details + * * * @param userEmail user's email - * @return + * @throws IOException if I/O exception occurred + * @return payment details response */ PaymentDetailsResponse listPaymentDetails(String userEmail) throws IOException; /** - * Lists payment details (async)
- *
+ * Lists payment details (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listPaymentDetailsAsync(List requests) throws IOException, InterruptedException; /** - * Deletes payment details
- *
+ * Deletes payment details + * * * @param paymentDetailsId Id of payment details - * @return + * @throws IOException if I/O exception occurred + * @return boolean response */ BooleanResponse deletePaymentDetails(String paymentDetailsId) throws IOException; /** - * Deletes payment details (async)
- *
+ * Deletes payment details (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void deletePaymentDetailsAsync(List requests) throws IOException, InterruptedException; /** - * Checks if trial is allowd
- *
+ * Checks if trial is allowed + * * * @param customerEmail customer's email * @param offerId offer Id - * @return + * @throws IOException if I/O exception occurred + * @return boolean response */ - public BooleanResponse isTrialAllowed(String customerEmail, String offerId) throws IOException; + BooleanResponse isTrialAllowed(String customerEmail, String offerId) throws IOException; /** - * Checks if trial is allowd (async)
- *
+ * Checks if trial is allowd (async) + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ - public void isTrialAllowedAsync(List requests) throws IOException, InterruptedException; + void isTrialAllowedAsync(List requests) throws IOException, InterruptedException; /** - * Gets offerIds by video id
- *
+ * Gets offerIds by video id + * * * @param videoId video Id - * @return + * @throws IOException if I/O exception occurred + * @return list offer ids by video id response */ ListOfferIdsByVideoIdResponse listOfferIdsByVideoId(String videoId) throws IOException; /** - * Gets offerIds by video id (async)
- *
- *[ + * Gets offerIds by video id (async) + * + * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listOfferIdsByVideoIdAsync(List requests) throws IOException, InterruptedException; /** - * Lists customer subscriptions
- *
+ * Lists customer subscriptions + * * * @param customerEmail customer's email * @param offset pagination offset - * @patam limit pagination limit - * @return + * @param limit pagination limit + * @throws IOException if I/O exception occurred + * @return list customer subscriptions response */ ListCustomerSubscriptionsResponse listCustomerSubscriptions(String customerEmail, int offset, int limit) throws IOException; /** - * Gets offerIds by video id (async)
- *
- *[ + * Gets offerIds by video id (async) + * + * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void listCustomerSubscriptionsAsync(List requests) throws IOException, InterruptedException; /** - * Checks whether access to offer is granted
- *
+ * Checks whether access to offer is granted + * * * @param customerToken customer token * @param offerId offer id * @param deviceId device id * @param deviceType device type - * @return + * @throws IOException if I/O exception occurred + * @return get access status for device response */ GetAccessStatusForDeviceResponse getAccessStatusForDevice(String customerToken, String offerId, String deviceId, String deviceType) throws IOException; /** - * Checks whether access to offer is granted
- *
+ * Checks whether access to offer is granted + * * * @param requests collection of AsyncRequest objects - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void getAccessStatusForDeviceAsync(List requests) throws IOException, InterruptedException; /** - * Invokes a batch request (async)
- *
+ * Invokes a batch request (async) + * * * @param batch object containing a collection of individual requests - * @return + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void invokeBatchAsync(BatchAsyncRequest batch) throws IOException, InterruptedException; /** - * Invokes a batch request
- *
+ * Invokes a batch request + * * * @param batch object containing a collection of individual requests - * @return + * @throws IOException if I/O exception occurred + * @return batch response */ BatchResponse invokeBatch(BatchRequest batch) throws IOException; /** - * Updates Cleeng Capture data for given broadcaster and customer
- *
+ * Updates Cleeng Capture data for given broadcaster and customer * + * + * @param userId user Id * @param data object containing personal data - * @return + * @throws IOException if I/O exception occurred + * @return boolean response */ BooleanResponse updateBroadcasterSpecificPersonalDataWithCaptureAnswers(Integer userId, PersonalData data) throws IOException; /** * Updates Cleeng Capture data for given broadcaster and customer in an asynchronous way * - * @param requests - * @throws IOException - * @throws InterruptedException + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void updateBroadcasterSpecificPersonalDataWithCaptureAnswersAsync(List requests) throws IOException, InterruptedException; /** - * fetches customer data with additional broadcaster specific information
- *
+ * fetches customer data with additional broadcaster specific information + * * * @param userId user's Id - * @return + * @throws IOException if I/O exception occurred + * @return personal data response */ PersonalDataResponse fetchBroadcasterSpecificPersonalDataWithCaptureAnswers(Integer userId) throws IOException; /** * Fetches customer data with additional broadcaster specific information in an asynchronous way * - * @param requests - * @throws IOException - * @throws InterruptedException + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void fetchBroadcasterSpecificPersonalDataWithCaptureAnswersAsync(List requests) throws IOException, InterruptedException; @@ -784,33 +848,34 @@ public interface Cleeng { * Saves capture questions * * @param questions a list of questions - * @return - * @throws IOException + * @return boolean response + * @throws IOException if I/O exception occurred */ BooleanResponse saveCaptureQuestions(List questions) throws IOException; /** * Saves capture questions in an asynchronous way * - * @param requests - * @throws IOException - * @throws InterruptedException + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void saveCaptureQuestionsAsync(List requests) throws IOException, InterruptedException; /** * Fetches capture questions * - * @return - * @throws IOException + * @return capture question response + * @throws IOException if I/O exception occurred */ CaptureQuestionResponse fetchCaptureQuestions() throws IOException; /** * Fetches capture questions in an asynchronous way * - * @throws IOException - * @throws InterruptedException + * @param requests request objects + * @throws IOException if I/O exception occurred + * @throws InterruptedException if operation thread is interrupted */ void fetchCaptureQuestionsAsync(List requests) throws IOException, InterruptedException; } diff --git a/src/main/java/com/cleeng/api/CleengBuilder.java b/src/main/java/com/cleeng/api/CleengBuilder.java index 517a038..db8d585 100644 --- a/src/main/java/com/cleeng/api/CleengBuilder.java +++ b/src/main/java/com/cleeng/api/CleengBuilder.java @@ -60,7 +60,7 @@ public CleengBuilder setUseSandbox(boolean value) { /** * * @param value - indicating whether to block: 0 - block (override properties), 1: do not block (override properties), -1: does not specify (properties still will be used to set this, if not found in properties it will be set to not block) - * @return + * @return cleeng builder object */ public CleengBuilder setUseNonBlockingMode(int value) { this.useNonBlockingMode = value;