/*! @file OIDTVTokenRequest.h
   @brief AppAuth iOS SDK
   @copyright
       Copyright 2020 Google Inc.
   @copydetails
       Licensed under the Apache License, Version 2.0 (the "License");
       you may not use this file except in compliance with the License.
       You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

       Unless required by applicable law or agreed to in writing, software
       distributed under the License is distributed on an "AS IS" BASIS,
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       See the License for the specific language governing permissions and
       limitations under the License.
*/

#import "OIDTokenRequest.h"

#import <Foundation/Foundation.h>

@class OIDServiceConfiguration;
@class OIDTVServiceConfiguration;

NS_ASSUME_NONNULL_BEGIN

@interface OIDTVTokenRequest : OIDTokenRequest

/*! @brief The device code received from the authorization server.
    @remarks device_code
    @see https://tools.ietf.org/html/rfc8628#section-3.4
 */
@property(nonatomic, readonly) NSString *deviceCode;

/*! @internal
    @brief Unavailable. Please use
        @c initWithConfiguration:deviceCode:clientID:clientSecret:additionalParameters:additionalHeaders:
        or @c initWithCoder:.
*/
- (instancetype)init NS_UNAVAILABLE;

/*! @internal
    @brief Unavailable. Please use
        @c initWithConfiguration:deviceCode:clientID:clientSecret:additionalParameters:additionalHeaders:
        or @c initWithCoder:.
*/
- (instancetype)initWithConfiguration:(OIDServiceConfiguration *)configuration
                            grantType:(NSString *)grantType
                    authorizationCode:(nullable NSString *)code
                          redirectURL:(nullable NSURL *)redirectURL
                             clientID:(NSString *)clientID
                         clientSecret:(nullable NSString *)clientSecret
                               scopes:(nullable NSArray<NSString *> *)scopes
                         refreshToken:(nullable NSString *)refreshToken
                         codeVerifier:(nullable NSString *)codeVerifier
                 additionalParameters:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalParameters
                    additionalHeaders:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalHeaders
    NS_UNAVAILABLE;

/*! @internal
    @brief Unavailable. Please use
        @c initWithConfiguration:deviceCode:clientID:clientSecret:additionalParameters:additionalHeaders:
        or @c initWithCoder:.
*/
- (instancetype)initWithConfiguration:(OIDServiceConfiguration *)configuration
                            grantType:(NSString *)grantType
                    authorizationCode:(nullable NSString *)code
                          redirectURL:(nullable NSURL *)redirectURL
                             clientID:(NSString *)clientID
                         clientSecret:(nullable NSString *)clientSecret
                                scope:(nullable NSString *)scope
                         refreshToken:(nullable NSString *)refreshToken
                         codeVerifier:(nullable NSString *)codeVerifier
                 additionalParameters:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalParameters
                    additionalHeaders:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalHeaders
    NS_UNAVAILABLE;

/*! @brief Designated initializer.
    @param configuration The service's configuration.
    @param deviceCode The device verification code received from the authorization server.
    @param clientID The client identifier.
    @param clientSecret The client secret (nullable).
    @param additionalParameters The client's additional token request parameters.
*/
- (instancetype)initWithConfiguration:(OIDTVServiceConfiguration *)configuration
                           deviceCode:(NSString *)deviceCode
                             clientID:(NSString *)clientID
                         clientSecret:(nullable NSString *)clientSecret
                 additionalParameters:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalParameters;

/*! @brief Designated initializer.
    @param configuration The service's configuration.
    @param deviceCode The device verification code received from the authorization server.
    @param clientID The client identifier.
    @param clientSecret The client secret (nullable).
    @param additionalParameters The client's additional token request parameters.
    @param additionalHeaders The client's additional token request headers.
*/
- (instancetype)initWithConfiguration:(OIDTVServiceConfiguration *)configuration
                           deviceCode:(NSString *)deviceCode
                             clientID:(NSString *)clientID
                         clientSecret:(nullable NSString *)clientSecret
                 additionalParameters:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalParameters
                    additionalHeaders:
                     (nullable NSDictionary<NSString *, NSString *> *)additionalHeaders
    NS_DESIGNATED_INITIALIZER;

/*! @brief Designated initializer for NSSecureCoding.
    @param aDecoder Unarchiver object to decode
 */
- (instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;

@end

NS_ASSUME_NONNULL_END