////////////////////////////////////////////////////////////////////////////
//
// Copyright 2020 Realm Inc.
//
// 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 <Realm/RLMProviderClient.h>

@class RLMUserAPIKey, RLMObjectId;

RLM_HEADER_AUDIT_BEGIN(nullability, sendability)

/// Provider client for user API keys.
RLM_SWIFT_SENDABLE RLM_FINAL // immutable final class
@interface RLMAPIKeyAuth : RLMProviderClient

/// A block type used to report an error
RLM_SWIFT_SENDABLE // invoked on a background thread
typedef void(^RLMAPIKeyAuthOptionalErrorBlock)(NSError * _Nullable);

/// A block type used to return an `RLMUserAPIKey` on success, or an `NSError` on failure
RLM_SWIFT_SENDABLE // invoked on a background thread
typedef void(^RLMOptionalUserAPIKeyBlock)(RLMUserAPIKey * _Nullable, NSError * _Nullable);

/// A block type used to return an array of `RLMUserAPIKey` on success, or an `NSError` on failure
RLM_SWIFT_SENDABLE // invoked on a background thread
typedef void(^RLMUserAPIKeysBlock)(NSArray<RLMUserAPIKey *> *  _Nullable, NSError * _Nullable);

/**
  Creates a user API key that can be used to authenticate as the current user.
 
  @param name The name of the API key to be created.
  @param completion A callback to be invoked once the call is complete.
*/
- (void)createAPIKeyWithName:(NSString *)name
                  completion:(RLMOptionalUserAPIKeyBlock)completion NS_SWIFT_NAME(createAPIKey(named:completion:));

/**
  Fetches a user API key associated with the current user.
 
  @param objectId The ObjectId of the API key to fetch.
  @param completion A callback to be invoked once the call is complete.
 */
- (void)fetchAPIKey:(RLMObjectId *)objectId
         completion:(RLMOptionalUserAPIKeyBlock)completion;

/**
  Fetches the user API keys associated with the current user.
 
  @param completion A callback to be invoked once the call is complete.
 */
- (void)fetchAPIKeysWithCompletion:(RLMUserAPIKeysBlock)completion;

/**
  Deletes a user API key associated with the current user.
 
  @param objectId The ObjectId of the API key to delete.
  @param completion A callback to be invoked once the call is complete.
 */
- (void)deleteAPIKey:(RLMObjectId *)objectId
          completion:(RLMAPIKeyAuthOptionalErrorBlock)completion;

/**
  Enables a user API key associated with the current user.
 
  @param objectId The ObjectId of the  API key to enable.
  @param completion A callback to be invoked once the call is complete.
 */
- (void)enableAPIKey:(RLMObjectId *)objectId
          completion:(RLMAPIKeyAuthOptionalErrorBlock)completion;

/**
  Disables a user API key associated with the current user.
 
  @param objectId The ObjectId of the API key to disable.
  @param completion A callback to be invoked once the call is complete.
 */
- (void)disableAPIKey:(RLMObjectId *)objectId
           completion:(RLMAPIKeyAuthOptionalErrorBlock)completion;

@end

RLM_HEADER_AUDIT_END(nullability, sendability)