Package com.inteliqua.rest.common

Enum APIResource

  • All Implemented Interfaces:
    Serializable, Comparable<APIResource>
    public enum APIResource
extends Enum<APIResource>
    Enum representing various API resources.

    This enum defines the different types of resources that can be accessed or manipulated via API requests. These resources represent entities or objects that the API can interact with, such as members, campaigns, stores, products, and more.

    • ADDRESS: Represents an address resource.
    • CAMPAIGN_EXECUTION: Represents a campaign execution resource.
    • CONSENT: Represents a consent resource.
    • COUPON: Represents a coupon resource.
    • COUPONSET: Represents a coupon set resource.
    • EMAIL: Represents an email resource.
    • FLOW_EXECUTION: Represents a flow execution resource.
    • LOYALTY_MEMBERSHIP: Represents a loyalty membership resource.
    • LOYALTY_MEMBERSHIP_TAG: Represents a loyalty membership tag resource.
    • LOYALTY_MEMBERSHIP_CLUB: Represents a loyalty membership club resource.
    • LOYALTY_MEMBERSHIP_POINT_LOG: Represents a loyalty membership point log resource.
    • LOYALTY_MEMBERSHIP_CARD: Represents a loyalty membership card resource.
    • LOYALTY_MEMBERSHIP_MOBILE: Represents a loyalty membership mobile resource.
    • MEMBER_BOOK_COUPON_GROUP: Represents a member book coupon group resource.
    • MEMBER_DEVICE: Represents a member device resource.
    • PERSON: Represents a person resource.
    • PERSON_TAG: Represents a person tag resource.
    • STORE: Represents a store resource.
    • STOREPOS: Represents a store point of sale (POS) resource.
    • TAG: Represents a tag resource.
    • TELEPHONE: Represents a telephone resource.
    • TRANSACTION: Represents a transaction resource.
    • TICKET: Represents a ticket resource.
    • TIER: Represents a tier resource.
    • PRODUCT: Represents a product resource.
    • MERCHANT: Represents a merchant resource.
    • APP_USER: Represents an app user resource.
    These resources are typically used when making API requests to perform various operations such as creating, updating, or fetching the data associated with these resources.

    • Enum Constant Detail

      • ADDRESS

        public static final APIResource ADDRESS
        Represents an address resource.

      • CAMPAIGN_EXECUTION

        public static final APIResource CAMPAIGN_EXECUTION
        Represents a campaign execution resource.

      • CONSENT

        public static final APIResource CONSENT
        Represents a consent resource.

      • COUPON

        public static final APIResource COUPON
        Represents a coupon resource.

      • COUPONSET

        public static final APIResource COUPONSET
        Represents a coupon set resource.

      • EMAIL

        public static final APIResource EMAIL
        Represents an email resource.

      • FLOW_EXECUTION

        public static final APIResource FLOW_EXECUTION
        Represents a flow execution resource.

      • LOYALTY_MEMBERSHIP

        public static final APIResource LOYALTY_MEMBERSHIP
        Represents a loyalty membership resource.

      • LOYALTY_MEMBERSHIP_TAG

        public static final APIResource LOYALTY_MEMBERSHIP_TAG
        Represents a loyalty membership tag resource.

      • LOYALTY_MEMBERSHIP_CLUB

        public static final APIResource LOYALTY_MEMBERSHIP_CLUB
        Represents a loyalty membership club resource.

      • LOYALTY_MEMBERSHIP_POINT_LOG

        public static final APIResource LOYALTY_MEMBERSHIP_POINT_LOG
        Represents a loyalty membership point log resource.

      • LOYALTY_MEMBERSHIP_CARD

        public static final APIResource LOYALTY_MEMBERSHIP_CARD
        Represents a loyalty membership card resource.

      • LOYALTY_MEMBERSHIP_MOBILE

        public static final APIResource LOYALTY_MEMBERSHIP_MOBILE
        Represents a loyalty membership mobile resource.

      • MEMBER_BOOK_COUPON_GROUP

        public static final APIResource MEMBER_BOOK_COUPON_GROUP
        Represents a member book coupon group resource.

      • MEMBER_DEVICE

        public static final APIResource MEMBER_DEVICE
        Represents a member device resource.

      • PERSON

        public static final APIResource PERSON
        Represents a person resource.

      • PERSON_TAG

        public static final APIResource PERSON_TAG
        Represents a person tag resource.

      • STORE

        public static final APIResource STORE
        Represents a store resource.

      • STOREPOS

        public static final APIResource STOREPOS
        Represents a store point of sale (POS) resource.

      • TAG

        public static final APIResource TAG
        Represents a tag resource.

      • TELEPHONE

        public static final APIResource TELEPHONE
        Represents a telephone resource.

      • TRANSACTION

        public static final APIResource TRANSACTION
        Represents a transaction resource.

      • TICKET

        public static final APIResource TICKET
        Represents a ticket resource.

      • TIER

        public static final APIResource TIER
        Represents a tier resource.

      • PRODUCT

        public static final APIResource PRODUCT
        Represents a product resource.

      • MERCHANT

        public static final APIResource MERCHANT
        Represents a merchant resource.

      • APP_USER

        public static final APIResource APP_USER
        Represents an app user resource.

    • Method Detail

      • values

        public static APIResource[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (APIResource c : APIResource.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static APIResource valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null