com.starkinfra.MerchantCategory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Welcome to the Stark Infra Java SDK! This tool is made for Java developers who want to easily integrate with our API. This SDK version is compatible with the Stark Infra API v2.
There is a newer version: 0.11.2
Show newest version
package com.starkinfra;

import com.starkinfra.utils.Rest;
import com.starkinfra.utils.Generator;
import com.starkinfra.utils.SubResource;

import java.util.Map;
import java.util.HashMap;


public final class MerchantCategory extends SubResource {
    /**
     * MerchantCategory object
     * 
     * MerchantCategory's codes and types are used to define categories filters in IssuingRules.
     * A MerchantCategory filter must define exactly one parameter between code and type.
     * A type, such as "food", "services", etc., defines an entire group of merchant codes,
     * whereas a code only specifies a specific MCC.
     * 

     * Parameters:
     * code [string]: category's code. ex: "veterinaryServices", "fastFoodRestaurants"
     * type [string]: category's type. ex: "pets", "food"
     * name [string]: category's name. ex: "Veterinary services", "Fast food restaurants"
     * number [string]: category's number. ex: "742", "5814"
     *
     */
    static SubResource.ClassData data = new SubResource.ClassData(MerchantCategory.class, "MerchantCategory");

    public String code;
    public String type;
    public String name;
    public String number;

    /**
     * MerchantCategory object
     * 

     * MerchantCategory's codes and types are used to define categories filters in IssuingRules.
     * A MerchantCategory filter must define exactly one parameter between code and type.
     * A type, such as "food", "services", etc., defines an entire group of merchant codes,
     * whereas a code only specifies a specific MCC.
     * 

     * Parameters:
     * @param code [string]: category's code. ex: "veterinaryServices", "fastFoodRestaurants"
     * @param type [string]: category's type. ex: "pets", "food"
     */
    public MerchantCategory(String code, String type, String name, String number) {
        this.code = code;
        this.type = type;
        this.name = name;
        this.number = number;
    }

    /**
     * MerchantCategory object
     * 

     * MerchantCategory's codes and types are used to define categories filters in IssuingRules.
     * A MerchantCategory filter must define exactly one parameter between code and type.
     * A type, such as "food", "services", etc., defines an entire group of merchant codes,
     * whereas a code only specifies a specific MCC.
     * 

     * Parameters (required):
     * @param data map of properties for the creation of the MerchantCategory
     * code [string]: category's code. ex: "veterinaryServices", "fastFoodRestaurants"
     * type [string]: category's type. ex: "pets", "food"
     * 

     * Attributes (return-only):
     * name [string]: category's name. ex: "Veterinary services", "Fast food restaurants"
     * number [string]: category's number. ex: "742", "5814"
     * @throws Exception error in the request
     */
    public MerchantCategory(Map data) throws Exception {
        HashMap dataCopy = new HashMap<>(data);

        this.code = (String) dataCopy.remove("code");
        this.type = (String) dataCopy.remove("type");
        this.name = null;
        this.number = null;

        if (!dataCopy.isEmpty()) {
            throw new Exception("Unknown parameters used in constructor: [" + String.join(", ", dataCopy.keySet()) + "]");
        }
    }

    /**
     * Retrieve MerchantCategories
     * 

     * Receive a generator of MerchantCategory objects available in the Stark Infra API
     * 

     * Parameters:
     * @param params map of parameters for the query
     * search [string, default null]: keyword to search for code, name, number or shortCode
     * @param user [Project object, default null]: Project object. Not necessary if StarkInfra.Settings.user was set before function call
     * 

     * Return:
     * @return generator of MerchantCategory objects with updated attributes
     * @throws Exception error in the request
     */
    public static Generator query(Map params, User user) throws Exception {
        return Rest.getStream(data, params, user);
    }

    /**
     * Retrieve MerchantCategories
     * 

     * Receive a generator of MerchantCategory objects available in the Stark Infra API
     * 

     * Parameters:
     * @param params map of parameters for the query
     * search [string, default null]: keyword to search for code, name, number or shortCode
     * 

     * Return:
     * @return generator of MerchantCategory objects with updated attributes
     * @throws Exception error in the request
     */
    public static Generator query(Map params) throws Exception {
        return Rest.getStream(data, params, null);
    }

    /**
     * Retrieve MerchantCategories
     * 

     * Receive a generator of MerchantCategory objects available in the Stark Infra API
     * 

     * Parameters:
     * @param user [Project object, default null]: Project object. Not necessary if StarkInfra.Settings.user was set before function call
     * 

     * Return:
     * @return generator of MerchantCategory objects with updated attributes
     * @throws Exception error in the request
     */
    public static Generator query(User user) throws Exception{
        return Rest.getStream(data, new HashMap<>(), user);
    }

    /**
     * Retrieve MerchantCategories
     * 

     * Receive a generator of MerchantCategory objects available in the Stark Infra API
     * 
     * Return:
     * @return generator of MerchantCategory objects with updated attributes
     * @throws Exception error in the request
     */
    public static Generator query() throws Exception{
        return Rest.getStream(data, new HashMap<>(), null);
    }
}