@dodi-smart/nuki-graphql-api/dist/api/models/AdvancedApiKey.d.ts

Nuki GraphQL API

export type AdvancedApiKey = {
    /**
     * The name of the company for which you apply for access
     */
    name: string;
    /**
     * The country of the headquarter or the country where you are mainly doing business in
     */
    country: string;
    /**
     * Describe the services and/or products you offer to your customers and how your customers would use Nuki devices in their processes
     */
    description: string;
    /**
     * The application type
     */
    type: AdvancedApiKey.type;
    /**
     * The status of the webhook posting automation
     */
    readonly webhookStatus?: AdvancedApiKey.webhookStatus;
    /**
     * A website where we can find more information on the company and its business model
     */
    url: string;
    /**
     * An email address where we can contact you for checks on your application
     */
    email: string;
    /**
     * The URL where our webhooks should point to
     */
    webhookUrl: string;
    /**
     * The features to trigger webhooks, for all types except 'ONLY_SECRET'
     */
    webhookFeatures: Array<'DEVICE_STATUS' | 'DEVICE_MASTERDATA' | 'DEVICE_CONFIG' | 'DEVICE_LOGS' | 'DEVICE_AUTHS' | 'ACCOUNT_USER'>;
    /**
     * The client secret, visible if application is approved (status >= 'TESTING')
     */
    secret: string;
    /**
     * The application status
     */
    status: AdvancedApiKey.status;
    /**
     * The creation date
     */
    creationDate: string;
    /**
     * The update date
     */
    updateDate: string;
};
export declare namespace AdvancedApiKey {
    /**
     * The application type
     */
    enum type {
        ONLY_SECRET = "ONLY_SECRET",
        SHORT_RENTAL = "SHORT_RENTAL",
        HEALTHCARE = "HEALTHCARE",
        SMART_HOME = "SMART_HOME",
        OTHER = "OTHER"
    }
    /**
     * The status of the webhook posting automation
     */
    enum webhookStatus {
        ACTIVE = "ACTIVE",
        DEACTIVATED = "DEACTIVATED"
    }
    /**
     * The application status
     */
    enum status {
        INACTIVE = "INACTIVE",
        APPLIED = "APPLIED",
        TESTING = "TESTING",
        ACTIVE = "ACTIVE"
    }
}
//# sourceMappingURL=AdvancedApiKey.d.ts.map