Merge pull request #1034 from watson-developer-cloud/rc-candidate-major-release-4.0.0

Rc candidate major release 4.0.0

Author: jeff-arn

.bumpversion.cfg

@@ -5,7 +5,7 @@ message = Release version {new_version} [skip ci]
 
 [bumpversion:file:README.md]
 
-[bumpversion:file:Source/SupportingFiles/Shared.swift]
+[bumpversion:file:Sources/SupportingFiles/Shared.swift]
 
 [bumpversion:file:IBMWatsonAssistantV1.podspec]
 

.gitignore

@@ -1,6 +1,6 @@
 # Custom
-Source/SupportingFiles/Credentials.swift
-Source/SupportingFiles/WatsonCredentials.swift
+Sources/SupportingFiles/Credentials.swift
+Sources/SupportingFiles/WatsonCredentials.swift
 Tests/CompareComplyV1Tests/Resources/cloud-object-storage-credentials*
 
 # Build generated

.swiftlint.yml

@@ -1,7 +1,7 @@
 excluded: # paths to ignore during linting (takes precedence over `included`)
   - Carthage
-  - Source/SupportingFiles/Dependencies
-  - Source/*/Shared.swift
+  - Sources/SupportingFiles/Dependencies
+  - Sources/*/Shared.swift
 
 disabled_rules: # rule identifiers to exclude from running
   - closure_parameter_position
@@ -10,6 +10,8 @@ disabled_rules: # rule identifiers to exclude from running
   - cyclomatic_complexity
   - superfluous_disable_command
   - function_parameter_count
+  - identifier_name
+  - line_length
 
 opt_in_rules:
  - force_unwrapping

CHANGELOG.md

@@ -1,4 +1,275 @@
 
+# 4.0.0 (Preview) (https://github.com/watson-developer-cloud/swift-sdk/compare/3.6.0...4.0.0) (2020-10-29)
+
+## Breaking Changes
+
+### All Services
+* `init` now accepts a `serviceName` parameter to set the default service name of the instance
+
+### AssistantV1 Service
+
+* Now Accepts `includeCount` Parameter: `listWorkspaces()`, `listIntents()`, `listExamples()`, `listCounterexamples()`, `listEntities()`, `listValues()`, `listSynonyms()`, `listDialogNodes()`
+
+* `createWorkspace()`: function parameter reordering
+
+* `updateWorkspace()`: function parameter reordering
+
+* `createDialogNode()`: parameter `context` type change from `[Sting: JSON]?` to `DialogNodeContext?`
+
+* `updateDialogNode()`: parameter `newContext` type change from `[Sting: JSON]?` to `DialogNodeContext?`
+
+* `bulkClassify()`: function added - Identify intents and entities in multiple user utterances.
+
+
+### AssistantV1 Models
+
+#### Models Added
+`BulkClassifyOutput`, `BulkClassifyResponse`, `BulkClassifyUtterance`, `DialogNodeContext`, `DialogNodeOutputConnectToAgentTransferInfo`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeImage`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeOption`, `DialogNodeOutputGenericDialogNodeOutputResponseTypePause`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeText`, `RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`, `RuntimeResponseGenericRuntimeResponseTypeImage`, `RuntimeResponseGenericRuntimeResponseTypeOption`, `RuntimeResponseGenericRuntimeResponseTypePause`, `RuntimeResponseGenericRuntimeResponseTypeSuggestion`, `RuntimeResponseGenericRuntimeResponseTypeText`
+
+#### Models Removed
+`CreateWorkspace`, `DialogNodeSuggestionOutput`, `DialogSuggestionResponseGeneric`, `SystemResponse`, `UpdateCounterexample`, `UpdateDialogNode`, `UpdateEntity`, `UpdateExample`, `UpdateIntent`, `UpdateSynonym`, `UpdateValue`, `UpdateWorkspace`, `WorkspaceSystemSettings`, `WorkspaceSystemSettingsDisambiguation`, `WorkspaceSystemSettingsOffTopic`, `WorkspaceSystemSettingsSystemEntities`, `WorkspaceSystemSettingsTooling`, `WorkspaceSystemSettings`,
+
+#### Model Properties Changed
+`Context`
+* `system` type changed from `SystemResponse?` to `[String: JSON]?`
+
+`DialogSuggestion`
+* `output` type changed from `DialogSuggestionOutput?` to `[String: JSON]?`
+
+`Counterexample`, `CreateEntity`, `CreateIntent`, `CreateValue`, `Example`, `Synonym`
+* `created` read only
+* `updated` read only
+
+`DialogNodeOutput`
+* `integrations` added
+
+`MessageInput`
+
+* `suggestedText` read only
+* `originalText` read only
+
+`MessageRequest`
+
+* `actions` read only
+
+`Webhook`
+
+* `headers` renamed to `xheaders`
+
+#### Multiple/Unique Changes
+`DialogNode`
+* `context` type changed from `[String: JSON]?` to `DialogNodeContext?`
+* `disabled` parameter removed
+* `created` parameter removed
+* `updated` parameter removed
+
+`DialogNodeOutputGeneric`
+* Changed from struct to enum to discriminate between response types
+
+`RuntimeResponseGeneric`
+* Changed from struct to enum to discriminate between response types
+
+
+### AssistantV2 Service
+
+* `bulkClassify()`: function added - Identify intents and entities in multiple user utterances.
+
+### AssistantV2 Models
+
+#### Models Added
+`BulkClassifyOutput`, `BulkClassifyResponse`, `BulkClassifyUtterance`, `DialogNodeOutputConnectToAgentTransferInfo`, `RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`, `RuntimeResponseGenericRuntimeResponseTypeImage`, `RuntimeResponseGenericRuntimeResponseTypeOption`, `RuntimeResponseGenericRuntimeResponseTypePause`, `RuntimeResponseGenericRuntimeResponseTypeSuggestion`, `RuntimeResponseGenericRuntimeResponseTypeText`
+
+#### Models Removed
+`MessageContextSkills`, `MessageRequestStateless`
+
+#### Model Properties Changed
+`MessageContextGlobal`
+* `system` read only
+
+`MessageContext`, `MessageContextStateless`
+* `skills` type changed from `MessageContextSkills?` to `[String: MessageContextSkill]?`
+
+`MessageInputOptions` 
+* model parameters repositioned
+
+#### Multiple/Unique Changes
+`RuntimeResponseGeneric`
+* Changed from struct to enum to discriminate between response types
+
+### CompareComplyV1 Service
+
+* `listFeedback()`: `before` and `after` parameters removed
+
+### CompareComplyV1 Models
+
+#### Models Removed
+`FeedbackInput`
+
+#### Model Properties Changed
+`Category`, `TypeLabel`
+* `modification` added
+
+`OriginalLabelsOut`, `UpdatedLabelsOut`
+* `modification` removed
+
+### DiscoveryV1 Service
+
+* No changes
+
+### DiscoveryV1 Models
+
+#### Models Removed
+`CollQueryLarge`, `CreateCollectionRequest`, `CreateEnvironmentRequest`, `CreateEventObject`, `FedQueryLarge`, `GatewayName`, `GenericQueryAggregation`, `NewTrainingQuery`, `NluEnrichmentCategories`, `QueryLarge`, `TokenDict`, `TrainingExamplePatch`, `UpdateCollectionRequest`, `UpdateEnvironmentRequest`
+#### Model Prroperties Changed
+`Configuration`
+* `created` read only
+* `updated` read only
+* `configurationID` read only
+
+`Credentials`
+* `credentialID` read only
+
+`EventData`
+* `queryID` read only
+
+`NluEnrichmentFeatures`
+* `categories` type changed from `NluEnrichmentCategories?` to `[String: JSON]?`
+
+### DiscoveryV2 Service
+
+* `analyzeDocument()`: function added - Process a document using the specified collection's settings and return it for realtime use. - Currently CP4D only
+
+### DiscoveryV2 Models
+
+#### Models Added
+`AnalyzedDocument`, `AnalyzedResult`, `QueryResponsePassage`, `
+#### Models Removed
+`GenericQueryAggregation`, `ProjectCreation`, `ProjectName`, `QueryLarge`, `QueryNoticesResult`, `UpdateCollection`, `UpdateEnrichment`
+#### Model Properties Changed
+`CollectionDetails`
+* `collectionID` read only
+* `created` read only
+
+`QueryResponse`
+* `passages` added
+
+`TrainingExample`
+* `created` read only
+* `updated` read only
+
+`TraningQuery`
+* `created` read only
+* `updated` read only
+* `queryID` read only
+
+### LanguageTranslator Service
+* No changes
+
+### LanguageTranslatorV3 Models
+
+#### Models Removed
+`TranslateRequest`
+
+### NaturalLanguageClassifierV1 Service
+* No changes
+
+### NaturalLanguageClassifierV1 Models
+
+#### Models Removed
+`ClassifyCollectionInput`
+
+### NaturalLanguageUnderstanding Service
+* No changes
+
+### NaturalLanguageUnderstandingV1 Models
+
+#### Models Added
+`FeaturesResultsMetadata`
+#### Models Removed
+`AnalysisResultsMetadata`, `MetadataOptions`, `Parameters`
+#### Model Properties Changed
+`AnalysisResults`
+* `metadata` type changed from `AnalysisResultsMetadata?` to `FeaturesResultsMetadata?`
+
+`Features`
+* `metadata` type changed from `MetadataOptions?` to `[String: JSON]?`
+
+### PersonalityInsights Service
+IBM Watson™ Personality Insights is discontinued. For a period of one year from 1 December 2020, you will still be able to use Watson Personality Insights. However, as of 1 December 2021, the offering will no longer be available.
+
+As an alternative, we encourage you to consider migrating to IBM Watson™ Natural Language Understanding, a service on IBM Cloud® that uses deep learning to extract data and insights from text such as keywords, categories, sentiment, emotion, and syntax to provide insights for your business or industry. For more information, see About Natural Language Understanding.
+
+* `profile()`: csvHeaders parameter added
+
+* `profileAsCSV()`: return type changed from `WatsonResponse<String>?` to `WatsonResponse<Data>?`
+
+### PersonalityInightsV3 Models
+* No changes
+
+### SpeechToTextV1 Service
+* `trainLanguageModel()`: return type changed from `WatsonResponse<Void>?` to `WatsonResponse<TrainingResponse>?`
+
+* `trainAcousticModel()`: return type changed from `WatsonResponse<Void>?` to `WatsonResponse<TrainingResponse>?`
+
+### SpeechToTextV1 Models
+* No changes
+
+#### Models Removed
+`CreateAcousticModel`, `CreateLanguageModel`, `CustomWords`
+
+### TextToSpeechV1 Service
+* `createVoiceModel()`: function changed to `createCustomModel()` now returning `WatsonResponse<CustomModel>?`
+
+* `listVoiceModels()`: function changed to `listCustomModels()` now returning `WatsonResponse<CustomModels>?`
+
+* `updateVoiceModel()`: function changed to `updateCustomModel()`
+
+* `getVoiceModel()`: function changed to `getCustomModel()` now returning `WatsonResponse<CustomModel>?`
+
+* `deleteVoiceModel()`: function changed to `deleteCustomModel()`
+
+### TextToSpeechV1 Models
+
+#### Models Added
+`CustomModel`, `CustomModels`
+#### Models Removed
+`CreateVoiceModel`, `Text`, `UpdateVoiceModel`, `VoiceModel`, `VoiceModels`
+#### Model Properties Changed
+`Voice`
+* customization type changed from `VoiceModel?` to `CustomModel?`
+
+### ToneAnalyzerV3 Models
+
+#### Models Removed
+`ToneChatInput`
+
+### VisualRecognitionV3 Service
+IBM Watson™ Visual Recognition is discontinued. Existing instances are supported until 1 December 2021, but as of 7 January 2021, you can't create instances. Any instance that is provisioned on 1 December 2021 will be deleted.
+
+### VisualRecognitionV3 Models
+* No changes
+
+### VisualRecognitionV4 Service
+IBM Watson™ Visual Recognition is discontinued. Existing instances are supported until 1 December 2021, but as of 7 January 2021, you can't create instances. Any instance that is provisioned on 1 December 2021 will be deleted.
+
+* `getTrainingUsage()`: `startTime` and `endTime` parameter types changed from `String?` to `Date?`
+
+### VisualRecognitionV4 Models
+
+#### Models Added
+`CollectionTrainingStatus`, `ObjectDetailLocation`
+#### Models Removed
+`BaseCollection`, `BaseTrainingDataObjects`
+#### Model Properties Changed
+`Collection`
+* `trainingStatus` type changed from `TrainingStatus` to `CollectionTrainingStatus`
+
+`ObjectDetail`
+* `location` type changed from `Location` to `ObjectDetailLocation`
+
+`UpdateObjectMetadata`
+* `count` read only
+
 ## 3.0.0 (Preview) (https://github.com/watson-developer-cloud/swift-sdk/compare/2.3.0...3.0.0) (2019-10-04)
 
 ### Breaking Changes
@@ -544,7 +815,7 @@ VisualRecognitionV4 added :tada:
 
 
 ### SpeechToTextV1
-- The `tokenURL` and `websocketsURL` properties are no longer public. Setting the `serviceURL` will automatically update the other two URLs appropriately.
+- The `websocketsURL` property is no longer public. Setting the `serviceURL` will automatically update the property.
 - Add missing parameters `baseModelVersion`, `languageCustomizationID`, and `customerID` to the following methods:
     - `recognize()` (using an audio file)
     - `recognizeUsingWebsocket()`

IBMWatsonAssistantV1.podspec

@@ -16,10 +16,10 @@ natural-language input and uses machine learning to respond to customers in a wa
   s.ios.deployment_target = '10.0'
   s.source                = { :git => 'https://github.com/watson-developer-cloud/swift-sdk.git', :tag => "v#{s.version}" }
 
-  s.source_files          = 'Source/AssistantV1/**/*.swift',
-                            'Source/SupportingFiles/InsecureConnection.swift',
-                            'Source/SupportingFiles/Shared.swift'
-  s.exclude_files         = 'Source/AssistantV1/Shared.swift'
+  s.source_files          = 'Sources/AssistantV1/**/*.swift',
+                            'Sources/SupportingFiles/InsecureConnection.swift',
+                            'Sources/SupportingFiles/Shared.swift'
+  s.exclude_files         = 'Sources/AssistantV1/Shared.swift'
 
   s.swift_version         = ['4.2', '5.0', '5.1']
   s.dependency              'IBMSwiftSDKCore', '~> 1.0.0'

IBMWatsonAssistantV2.podspec

@@ -16,10 +16,10 @@ natural-language input and uses machine learning to respond to customers in a wa
   s.ios.deployment_target = '10.0'
   s.source                = { :git => 'https://github.com/watson-developer-cloud/swift-sdk.git', :tag => "v#{s.version}" }
 
-  s.source_files          = 'Source/AssistantV2/**/*.swift',
-                            'Source/SupportingFiles/InsecureConnection.swift',
-                            'Source/SupportingFiles/Shared.swift'
-  s.exclude_files         = 'Source/AssistantV2/Shared.swift'
+  s.source_files          = 'Sources/AssistantV2/**/*.swift',
+                            'Sources/SupportingFiles/InsecureConnection.swift',
+                            'Sources/SupportingFiles/Shared.swift'
+  s.exclude_files         = 'Sources/AssistantV2/Shared.swift'
 
   s.swift_version         = ['4.2', '5.0', '5.1']
   s.dependency              'IBMSwiftSDKCore', '~> 1.0.0'

IBMWatsonCompareComplyV1.podspec

@@ -15,10 +15,10 @@ IBM Watson™ Compare and Comply analyzes governing documents to provide details
   s.ios.deployment_target = '10.0'
   s.source                = { :git => 'https://github.com/watson-developer-cloud/swift-sdk.git', :tag => "v#{s.version}" }
 
-  s.source_files          = 'Source/CompareComplyV1/**/*.swift',
-                            'Source/SupportingFiles/InsecureConnection.swift',
-                            'Source/SupportingFiles/Shared.swift'
-  s.exclude_files         = 'Source/CompareComplyV1/Shared.swift'
+  s.source_files          = 'Sources/CompareComplyV1/**/*.swift',
+                            'Sources/SupportingFiles/InsecureConnection.swift',
+                            'Sources/SupportingFiles/Shared.swift'
+  s.exclude_files         = 'Sources/CompareComplyV1/Shared.swift'
 
   s.swift_version         = ['4.2', '5.0', '5.1']
   s.dependency              'IBMSwiftSDKCore', '~> 1.0.0'

IBMWatsonDiscoveryV1.podspec

@@ -17,10 +17,10 @@ as well as public and third-party data.
   s.ios.deployment_target = '10.0'
   s.source                = { :git => 'https://github.com/watson-developer-cloud/swift-sdk.git', :tag => "v#{s.version}" }
 
-  s.source_files          = 'Source/DiscoveryV1/**/*.swift',
-                            'Source/SupportingFiles/InsecureConnection.swift',
-                            'Source/SupportingFiles/Shared.swift'
-  s.exclude_files         = 'Source/DiscoveryV1/Shared.swift'
+  s.source_files          = 'Sources/DiscoveryV1/**/*.swift',
+                            'Sources/SupportingFiles/InsecureConnection.swift',
+                            'Sources/SupportingFiles/Shared.swift'
+  s.exclude_files         = 'Sources/DiscoveryV1/Shared.swift'
 
   s.swift_version         = ['4.2', '5.0', '5.1']
   s.dependency              'IBMSwiftSDKCore', '~> 1.0.0'

IBMWatsonDiscoveryV2.podspec

@@ -17,10 +17,10 @@ as well as public and third-party data. IBM Watson™ Discovery V2 is available
   s.ios.deployment_target = '10.0'
   s.source                = { :git => 'https://github.com/watson-developer-cloud/swift-sdk.git', :tag => "v#{s.version}" }
 
-  s.source_files          = 'Source/DiscoveryV2/**/*.swift',
-                            'Source/SupportingFiles/InsecureConnection.swift',
-                            'Source/SupportingFiles/Shared.swift'
-  s.exclude_files         = 'Source/DiscoveryV2/Shared.swift'
+  s.source_files          = 'Sources/DiscoveryV2/**/*.swift',
+                            'Sources/SupportingFiles/InsecureConnection.swift',
+                            'Sources/SupportingFiles/Shared.swift'
+  s.exclude_files         = 'Sources/DiscoveryV2/Shared.swift'
 
   s.swift_version         = ['4.2', '5.0', '5.1']
   s.dependency              'IBMSwiftSDKCore', '~> 1.0.0'