/**
 * Copyright IBM Corporation 2018
 *
 * 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 Foundation

/**
 The **options** object defines which items to crawl from the source system.
 */
public struct SourceOptions: Codable {

    /**
     Array of folders to crawl from the Box source. Only valid, and required, when the **type** field of the **source**
     object is set to `box`.
     */
    public var folders: [SourceOptionsFolder]?

    /**
     Array of Salesforce document object types to crawl from the Salesforce source. Only valid, and required, when the
     **type** field of the **source** object is set to `salesforce`.
     */
    public var objects: [SourceOptionsObject]?

    /**
     Array of Microsoft SharePointoint Online site collections to crawl from the SharePoint source. Only valid and
     required when the **type** field of the **source** object is set to `sharepoint`.
     */
    public var siteCollections: [SourceOptionsSiteColl]?

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case folders = "folders"
        case objects = "objects"
        case siteCollections = "site_collections"
    }

    /**
     Initialize a `SourceOptions` with member variables.

     - parameter folders: Array of folders to crawl from the Box source. Only valid, and required, when the **type**
       field of the **source** object is set to `box`.
     - parameter objects: Array of Salesforce document object types to crawl from the Salesforce source. Only valid,
       and required, when the **type** field of the **source** object is set to `salesforce`.
     - parameter siteCollections: Array of Microsoft SharePointoint Online site collections to crawl from the
       SharePoint source. Only valid and required when the **type** field of the **source** object is set to
       `sharepoint`.

     - returns: An initialized `SourceOptions`.
    */
    public init(
        folders: [SourceOptionsFolder]? = nil,
        objects: [SourceOptionsObject]? = nil,
        siteCollections: [SourceOptionsSiteColl]? = nil
    )
    {
        self.folders = folders
        self.objects = objects
        self.siteCollections = siteCollections
    }

}
