/*
 *
 *  ZendeskSDKConstants.h
 *  ZendeskSDK
 *
 *  Created by Zendesk on 08/10/2014.
 *
 *  Copyright (c) 2014 Zendesk. All rights reserved.
 *
 *  By downloading or using the Zendesk Mobile SDK, You agree to the Zendesk Master
 *  Subscription Agreement https://www.zendesk.com/company/customers-partners/#master-subscription-agreement and Application Developer and API License
 *  Agreement https://www.zendesk.com/company/customers-partners/#application-developer-api-license-agreement and
 *  acknowledge that such terms govern Your use of and access to the Mobile SDK.
 *
 */

//! Project version number for ZendeskSDK.
FOUNDATION_EXPORT double ZendeskSDKVersionNumber;

//! Project version string for ZendeskSDK.
FOUNDATION_EXPORT NSString * const ZendeskSDKVersionString;


#pragma mark - ZDKToast

/**
 * Default toast animation time.
 */
extern NSTimeInterval const ZD_DefaultAnimationTime;


#pragma mark - ZDKAPI

/**
 * Notification that the SDK config has been updated from the server.
 * This notification will only be sent if a change has been detected.
 */
extern NSString * const ZDKAPI_ConfigUpdated;

/**
 * Notification that the SDK config failed to be fetched from server
 */
extern NSString * const ZDKAPI_ConfigUpdateFailed;

/**
 * Notification for triggering storage of requests.
 */
extern NSString * const ZDKAPI_RequestsUpdated;

/**
 * Notification for triggering storage of users.
 */
extern NSString * const ZDKAPI_UsersUpdated;

/**
 * Notification that the list is about to be retrieved.
 */
extern NSString * const ZDKAPI_CommentListStarting;

/**
 * Notification that the list has been retrieved.
 */
extern NSString * const ZDKAPI_CommentListSuccess;

/**
 * Notification that there was an error while retrieving the comment list.
 */
extern NSString * const ZDKAPI_CommentListError;

/**
 * Notification that a comment is about to be submitted.
 */
extern NSString * const ZDKAPI_CommentSubmissionStarting;

/**
 * Notification that a comment has been successfully submitted.
 */
extern NSString * const ZDKAPI_CommentSubmissionSuccess;

/**
 * Notification that there was an error during comment submission.
 */
extern NSString * const ZDKAPI_CommentSubmissionError;

/**
 * Notification that a request is about to be submitted.
 */
extern NSString * const ZDKAPI_RequestSubmissionStarting;

/**
 * Notification that a request has been successfully submitted.
 */
extern NSString * const ZDKAPI_RequestSubmissionSuccess;

/**
 * Notification that there was an error during request submission.
 */
extern NSString * const ZDKAPI_RequestSubmissionError;

/**
 * Notification that the request list is about to be retrieved.
 */
extern NSString * const ZDKAPI_RequestsStarting;

/**
 * Notification that the request list was successfully retrieved.
 */
extern NSString * const ZDKAPI_RequestsSuccess;

/**
 * Notification that there was an error while retrieving the request list.
 */
extern NSString * const ZDKAPI_RequestsError;

/**
 * Notification that the network status has changed.
 */
extern NSString * const ZDKAPI_ReachabilityChangedNotification;

/**
 *  Notification that an upload attachment request has started.
 */
extern NSString * const ZDKAPI_UploadAttachmentStarting;

/**
 *  Notification that an upload attachment request has succeeded.
 */
extern NSString * const ZDKAPI_UploadAttachmentSuccess;

/**
 *  Notification that an upload attachment request failed.
 */
extern NSString * const ZDKAPI_UploadAttachmentError;

/**
 *  Notification that an upload deletion is starting.
 */
extern NSString * const ZDKAPI_DeleteUploadStarting;

/**
 *  Notification that an upload deletion succeeded.
 */
extern NSString * const ZDKAPI_DeleteUploadSuccess;

/**
 *  Notification that an upload deletion failed.
 */
extern NSString * const ZDKAPI_DeleteUploadError;

/**
 * Notification that a request is about to be retrieved.
 */
extern NSString * const ZDKAPI_RequestByIdStarting;

/**
 * Notification that a request was successfully retrieved.
 */
extern NSString * const ZDKAPI_RequestByIdSuccess;

/**
 * Notification that there was an error while retrieving a request.
 */
extern NSString * const ZDKAPI_RequestByIdError;

/**
 *  Notification that a request to add tags to the user profile is about to start
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_AddUserTagsStarting;

/**
 *  Notification that a request to add user tags was completed successfully.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_AddUserTagsSuccess;

/**
 *  Notification that a request to add user tags failed.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_AddUserTagsFailure;

/**
 *  Notification that a request to delete tags from a user is about to start.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_DeleteUserTagsStarting;

/**
 *  Notification that a request to delete tags from a user succeeded.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_DeleteUserTagsSuccess;

/**
 *  Notification that a request to delete tags from a user failed.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_DeleteUserTagsFailure;

/**
 *  Notification that a request to get user fields is starting.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_GetUserFieldsStarting;

/**
 *  Notification that a request to get user fields has succeeded.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_GetUserFieldsSuccess;

/**
 *  Notification that a request to get user fields has failed.
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_GetUserFieldsFailure;

/**
 *  Notification that a request to add a user field is starting
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_SetUserFieldsStarting;

/**
 *  Notification that a request to add a user field has succeeded
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_SetUserFieldsSuccess;

/**
 *  Notification that a request to add a user field has failed
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_SetUserFieldsFailure;

/**
 *  Notification that a request to get a user has started
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_GetUserStarting;

/**
 *  Notification that a request to get a user has succeeded
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_GetUserSuccess;

/**
 *  Notification that a request to a user has failed
 *
 *  @since 1.4.0.1
 */
extern NSString * const ZDKAPI_GetUserFailure;





#pragma mark - Help Center


/**
 * Notification that help centre categories are being fetched.
 */
extern NSString * const ZD_HC_CategoriesStarting;

/**
 * Notification that help centre categories were updated.
 */
extern NSString * const ZD_HC_CategoriesUpdated;

/**
 * Notification that help centre sections are being fetched.
 */
extern NSString * const ZD_HC_SectionsStarting;

/**
 * Notification that help centre sections were updated.
 */
extern NSString * const ZD_HC_SectionsUpdated;

/**
 * Notification that help centre articles are being fetched.
 */
extern NSString * const ZD_HC_ArticlesStarting;

/**
 * Notification that help centre articles were updated.
 */
extern NSString * const ZD_HC_ArticlesUpdated;

/**
 *  Notification that help centre article is being fetched.
 *
 *  @since 1.3.1.1
 */
extern NSString * const ZD_HC_ArticleByIdStarting;

/**
 *  Notification that an article was successfully retrieved.
 *
 *  @since 1.3.1.1
 */
extern NSString * const ZD_HC_ArticleByIdSuccess;

/**
 * Notification that help centre attachments are being fetched.
 */
extern NSString * const ZD_HC_AttachmentsStarting;

/**
 * Notification that help centre attachments were updated.
 */
extern NSString * const ZD_HC_AttachmentsUpdated;

/**
 * Notification that help center article attachments failed to load.
 */
extern NSString * const ZD_HC_AttachmentsErrored;

/**
 *  Notification that help center search has started
 */
extern NSString * const ZD_HC_SearchStarting;

/**
 * Notification that help center search results have been successfully retrieved.
 */
extern NSString * const ZD_HC_SearchSuccess;

/**
 * Notification that a help centre category was selected.
 */
extern NSString * const ZD_HC_CategorySelected;

/**
 * Notification that a help centre category was being fetched.
 */
extern NSString * const ZD_HC_CategoryByIdStarting;

/**
 * Notification that a help centre category was successfully retrieved.
 */
extern NSString * const ZD_HC_CategoryByIdSuccess;

/**
 * Notification that a help centre category was selected.
 */
extern NSString * const ZD_HC_SectionSelected;

/*
 * Notification that a help centre article was selected.
 */
extern NSString * const ZD_HC_SectionArticle;

/*
 * Notification that a help centre section was being fetched
 */
extern NSString * const ZD_HC_SectionByIdStarting;

/*
 * Notification that a help centre section was successfully retrieved.
 */
extern NSString * const ZD_HC_SectionByIdSuccess;

/**
 *  Notification that a help center deflection search was started.
 */
extern NSString * const ZD_HC_DeflectionSearchStarting;

/**
 *  Notification that a help center deflection search succeed.
 */
extern NSString * const ZD_HC_DeflectionSearchSuccess;

/**
 *  Notification that a help center deflection search failed.
 */
extern NSString * const ZD_HC_DeflectionSearchError;

/**
 *  Notification that a Help Center article upvote request started
 */
extern NSString * const ZD_HC_UpvoteStarting;

/**
 *  Notification that a Help Center article upvote request succeeded
 */
extern NSString * const ZD_HC_UpvoteSuccess;

/**
 *  Notification that a Help Center article upvote request failed
 */
extern NSString * const ZD_HC_UpvoteError;


/**
 *  Notification that a Help Center article downvote request started
 */
extern NSString * const ZD_HC_DownvoteStarting;

/**
 *  Notification that a Help Center article downvote request succeeded
 */
extern NSString * const ZD_HC_DownvoteSuccess;

/**
 *  Notification that a Help Center article downvote request failed
 */
extern NSString * const ZD_HC_DownvoteError;

/**
 *  Notification that a Help Center vote deletion request started
 */
extern NSString * const ZD_HC_VoteDeleteStarting;

/**
 *  Notification that a Help Center vote deletion request succeeded
 */
extern NSString * const ZD_HC_VoteDeleteSuccess;

/**
 *  Notification that a Help Center vote deletion request failed
 */
extern NSString * const ZD_HC_VoteDeleteError;


/**
 * Notification that a help centre request errored.
 */
extern NSString * const ZD_HC_RequestError;


/**
 * Notification for resigning first responder.
 */
extern NSString * const ZD_ResignFirstResponder;

#pragma mark - Agent Header Suffix format

/**
 *  Agent Header Suffix format.
 */
extern NSString * const ZDK_Header_Suffix_Format;

extern NSInteger const ZDCharacterLimitForUserAgentHeader;


#pragma mark - HTTP Header


// HTTP
extern NSString * const ZDD_HTTPPost;
extern NSString * const ZDD_HTTPGet;
extern NSString * const ZDD_HTTPPut;
extern NSString * const ZDD_HTTPDelete;

// HEADERS
extern NSString * const ZDD_ContentType;
extern NSString * const ZDD_ContentLength;
extern NSString * const ZDD_Accept;
extern NSString * const ZDD_TypeJSON;
extern NSString * const ZDD_UserAgent;
extern NSString * const ZDD_AcceptLanguage;
extern NSString * const ZDD_ClientIdentifier;

// MIME types
extern NSString * const ZDD_MIMETypeJPEG;
extern NSString * const ZDD_MIMETypePNG;
extern NSString * const ZDD_MIMETypeGIF;
extern NSString * const ZDD_MIMETypeTIFF;


#pragma mark - Error Domain


// ERRORS
/// error domain for any error reported by the API.
extern NSString * const ZDD_ERROR_Domain;
/// dictionary key for the API error message in the NSError user info dictionary.
extern NSString * const ZDD_ERROR_Key;

#pragma mark - Error Constants

extern NSString * const ZDD_Validator_Error_Key;


// itunes link formats
extern NSString * const iOS7AppStoreURLFormat;
extern NSString * const iOSAppStoreURLFormat;

extern NSString * const ZDSDKUserDefaultsKey;


// notifications

#pragma mark - Authentication types
extern NSString * const ZDK_AUTHENTICATION_JWT;
extern NSString * const ZDK_AUTHENTICATION_ANONYMOUS;

/* Article Voting Constants */
extern NSInteger const ZDK_Article_Down_Vote_Number;
extern NSInteger const ZDK_Article_Up_Vote_Number;
extern NSInteger const ZDK_Article_Even_Vote_Number;

/* Button Indexes in ZDKHelpCenterArticleView */
extern NSUInteger const ZDK_Article_Down_Vote_Button_Index;
extern NSUInteger const ZDK_Article_Up_Vote_Button_Index;

/**
 *  Represents the types of authentication SDK supports.
 *
 *  @since 1.3.4.1
 */
typedef NS_ENUM(NSUInteger, ZDKAuthenticationType){
    /**
     *  Authentication type unknown.
     *
     *  @since 1.3.4.1
     */
    ZDKAuthenticationTypeUnknown,
    /**
     *  JWT authentication.
     *
     *  @since 1.3.4.1
     */
    ZDKAuthenticationTypeJWT,
    /**
     *  Anonymous authentication.
     *
     *  @since 1.3.4.1
     */
    ZDKAuthenticationTypeAnonymous,
};


#if !__has_feature(nullability)
#define NS_ASSUME_NONNULL_BEGIN
#define NS_ASSUME_NONNULL_END
#define nullable
#define nonnull
#define null_unspecified
#define null_resettable
#define __nullable
#define __nonnull
#define __null_unspecified
#endif