com.vk.api.sdk.queries.orders.OrdersCancelSubscriptionQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Java library for VK API interaction, includes OAuth 2.0 authorization and API methods.
There is a newer version: 1.0.16
// Autogenerated from vk-api-schema. Please don't edit it manually.
package com.vk.api.sdk.queries.orders;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.base.responses.BoolResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Orders.cancelSubscription method
 */
public class OrdersCancelSubscriptionQuery extends AbstractQueryBuilder {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     * @param userId value of "user id" parameter. Minimum is 1. Entity - owner
     *
     * @param subscriptionId value of "subscription id" parameter. Minimum is 0.
     */
    public OrdersCancelSubscriptionQuery(VkApiClient client, ServiceActor actor, Long userId,
            Integer subscriptionId) {
        super(client, "orders.cancelSubscription", BoolResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
        userId(userId);
        subscriptionId(subscriptionId);
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public OrdersCancelSubscriptionQuery(VkApiClient client, ServiceActor actor) {
        super(client, "orders.cancelSubscription", BoolResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
    }

    /**
     * Set user id
     *
     * @param value value of "user id" parameter. Minimum is 1. Entity - owner
     *
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("user_id")
    public OrdersCancelSubscriptionQuery userId(Long value) {
        return unsafeParam("user_id", value);
    }

    /**
     * Set subscription id
     *
     * @param value value of "subscription id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("subscription_id")
    public OrdersCancelSubscriptionQuery subscriptionId(Integer value) {
        return unsafeParam("subscription_id", value);
    }

    /**
     * Set pending cancel
     *
     * @param value value of "pending cancel" parameter. By default 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("pending_cancel")
    public OrdersCancelSubscriptionQuery pendingCancel(Boolean value) {
        return unsafeParam("pending_cancel", value);
    }

    @Override
    protected OrdersCancelSubscriptionQuery getThis() {
        return this;
    }

    @Override
    protected List essentialKeys() {
        return Arrays.asList("subscription_id", "user_id", "access_token");
    }
}