Merge pull request #31 from sovren/feature/update-urls

update property descriptions and URLs

README.md

@@ -75,7 +75,7 @@ For every relevant method in the `SovrenClient`, you can create a Matching UI se
 
 [examples]: https://github.com/sovren/sovren-dotnet/tree/master/examples
 [portal]: https://portal.sovren.com
-[api-docs]: https://docs.sovren.com
+[api-docs]: https://sovren.com/technical-specs/latest/rest-api/overview/
 [dotnet-core-cli-tools]: https://docs.microsoft.com/en-us/dotnet/core/tools/
 [nuget-cli]: https://docs.microsoft.com/en-us/nuget/tools/nuget-exe-cli-reference
 [package-manager-console]: https://docs.microsoft.com/en-us/nuget/tools/package-manager-console

examples/Parsing/Basic Parsing.md

@@ -9,7 +9,7 @@ public static async Task Main(string[] args)
     Document doc = new Document("resume.docx");
 
     //when you create a ParseRequest, you can specify many configuration settings
-    //in the ParseOptions. See https://docs.sovren.com/API/Rest/Parsing#parse-resume
+    //in the ParseOptions. See https://sovren.com/technical-specs/latest/rest-api/resume-parser/api/
     ParseRequest request = new ParseRequest(doc, new ParseOptions());
 
     try

examples/Parsing/Batch Parsing.md

@@ -6,7 +6,7 @@ public static async Task Main(string[] args)
     SovrenClient client = new SovrenClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
 
     //you can specify many configuration settings in the ParseOptions.
-    //See https://docs.sovren.com/API/Rest/Parsing#parse-resume
+    //See https://sovren.com/technical-specs/latest/rest-api/resume-parser/api/
     ParseOptions parseOptions = new ParseOptions();
 
     //only allow users to parse N at a time (otherwise, a single user could use up all the credits)

src/Sovren.SDK/Exceptions/SovrenException.cs

@@ -21,12 +21,12 @@ public class SovrenException : Exception
         public RestResponse RestResponse { get; protected set; }
 
         /// <summary>
-        /// The HTTP Status Code of the response. See <see href="https://docs.sovren.com/api/rest/#http-status-codes"/>
+        /// The HTTP Status Code of the response. See <see href="https://sovren.com/technical-specs/latest/rest-api/overview/#http-status-codes"/>
         /// </summary>
         public HttpStatusCode HttpStatusCode { get; protected set; }
 
         /// <summary>
-        /// The Info.Code of the response. This will indicate what type of error occurred. See <see href="https://docs.sovren.com/api/rest/#http-status-codes"/>
+        /// The Info.Code of the response. This will indicate what type of error occurred. See <see href="https://sovren.com/technical-specs/latest/rest-api/overview/#http-status-codes"/>
         /// </summary>
         public string SovrenErrorCode { get; protected set; }
 

src/Sovren.SDK/Extensions/ResumeExtensions.cs

@@ -140,7 +140,7 @@ public static bool DidTimeout(this ParseResumeResponseExtensions exts)
 
         /// <summary>
         /// Checks if Sovren found any possible problems in the converted text of the resume (prior to parsing).
-        /// <br/>For more info, see <see href="https://docs.sovren.com/#document-conversion-result-codes"/>
+        /// <br/>For more info, see <see href="https://sovren.com/technical-specs/latest/rest-api/resume-parser/overview/document-conversion-code/"/>
         /// </summary>
         public static bool HasConversionWarning(this ParseResumeResponseExtensions exts)
         {

src/Sovren.SDK/Models/API/ApiResponseInfoLite.cs

@@ -7,12 +7,12 @@ namespace Sovren.Models.API
 {
     /// <summary>
     /// Information/metadata for an individual REST API call.
-    /// <br/>See <see href="https://docs.sovren.com/API/Rest#http-status-codes"/>
+    /// <br/>See <see href="https://sovren.com/technical-specs/latest/rest-api/overview/#http-status-codes"/>
     /// </summary>
     public class ApiResponseInfoLite
     {
         /// <summary>
-        /// See <see href="https://docs.sovren.com/API/Rest#http-status-codes"/>
+        /// See <see href="https://sovren.com/technical-specs/latest/rest-api/overview/#http-status-codes"/>
         /// </summary>
         public string Code { get; set; }
 

src/Sovren.SDK/Models/API/Matching/Request/FilterCriteria.cs

@@ -48,7 +48,7 @@ public class JobTitleFilter
     {
         /// <summary>
         /// The name of the Job Title. Supports (*, ?) wildcard characters after the third character
-        /// in the term as defined in <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// in the term as defined in <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public string Title { get; set; }
 
@@ -92,7 +92,7 @@ public class FilterCriteria
 
         /// <summary>
         /// Full-text boolean semantic expresion. For full details on the syntax and supported 
-        /// operations refer to <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-fulltext"/>
+        /// operations refer to <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-fulltext"/>
         /// </summary>
         public string SearchExpression { get; set; }
 
@@ -109,7 +109,7 @@ public class FilterCriteria
         /// <summary>
         /// Results must have/require at least one of the security credentials specified.
         /// Supports (*, ?) wildcard characters after the third character in the term as defined 
-        /// in <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// in <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public List<string> SecurityCredentials { get; set; }
 
@@ -131,14 +131,14 @@ public class FilterCriteria
         /// <summary>
         /// Results must have at least one of the specified school names. Supports (*, ?) wildcard 
         /// characters after the third character in the term as defined in
-        /// <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public List<string> SchoolNames { get; set; }
 
         /// <summary>
         /// Results must have at least one of the specified degree names. Supports (*, ?) wildcard 
         /// characters after the third character in the term as defined in
-        /// <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public List<string> DegreeNames { get; set; }
 
@@ -170,7 +170,7 @@ public class FilterCriteria
         /// <summary>
         /// Results must have at least one of the specified employers. Supports (*, ?) wildcard 
         /// characters after the third character in the term as defined in
-        /// <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public List<string> Employers { get; set; }
 
@@ -239,7 +239,7 @@ public class FilterCriteria
         /// <summary>
         /// Results must have at least one of the specified certifications. Supports (*, ?) wildcard 
         /// characters after the third character in the term as defined in
-        /// <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public List<string> Certifications { get; set; }
 

src/Sovren.SDK/Models/API/Matching/Request/SkillFilter.cs

@@ -40,7 +40,7 @@ public class SkillFilter
     {
         /// <summary>
         /// The name of the skill. Supports (*, ?) wildcard characters after the third character in the term
-        /// as defined in <see href="https://docs.sovren.com/Documentation/AIMatching#ai-filtering-special-operators"/>
+        /// as defined in <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/querying/#ai-filtering-special-operators"/>
         /// </summary>
         public string SkillName { get; set; }
 

src/Sovren.SDK/Models/API/Matching/UI/GenerateUIResponse.cs

@@ -17,7 +17,7 @@ public class GenerateUIResponse
         /// display the Matching UI. This URL will be valid for at least 24 hours.
         /// <br/><b>NOTE: for security purposes, you should redirect a user to the session
         /// immediately after generating the session for that user</b>
-        /// <br/>For more info, see <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-authentication">here</see>
+        /// <br/>For more info, see <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#authentication">here</see>
         /// </summary>
         [JsonPropertyName("url")]//TODO: do we want to use these here? or just allow the property names to be the json names
         public string URL { get; set; }

src/Sovren.SDK/Models/API/Matching/UI/Hooks/UserActionHook.cs

@@ -18,7 +18,7 @@ public class UserActionHook
         /// <summary>
         /// Set to <see langword="true"/> to allow users to select multiple documents and perform this action on all of them at once. 
         /// <br/>NOTE: this can only be set to <see langword="true"/> when you use a <see cref="JsAction"/>. <see cref="UrlAction"/>s are not supported. 
-        /// <br/>See <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-hooks">here</see> for more info.
+        /// <br/>See <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks">here</see> for more info.
         /// </summary>
         public virtual bool IsBulk { get; set; }
     }
@@ -56,7 +56,7 @@ public class ServerSideHook : UserActionHook
         /// <summary>
         /// Any data from your system that you need to associate with this session/action. 
         /// This is sent (in addition to document information) in the POST body. 
-        /// <br/>For more information see <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-hooks">here</see>.
+        /// <br/>For more information see <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks">here</see>.
         /// </summary>
         public object CustomInfo { get; set; }
     }

src/Sovren.SDK/Models/API/Matching/UI/Hooks/UserActionHookCollection.cs

@@ -13,23 +13,23 @@ namespace Sovren.Models.API.Matching.UI.Hooks
     public class UserActionHookCollection
     {
         /// <summary>
-        /// The client-side <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-hooks">User Action Hooks</see> 
+        /// The client-side <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks">User Action Hooks</see> 
         /// for a Matching UI session. These can be used to do some client-side action (opening a tab/window, running some javascript)
         /// when a user clicks a button on a particular match result.
         /// </summary>
         public List<ClientSideHook> Client { get; set; }
 
         /// <summary>
         /// The server-side (HTTP POST)
-        /// <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-hooks">User Action Hooks</see> 
+        /// <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks">User Action Hooks</see> 
         /// for a Matching UI session. These can be used to do some server-side action (performs an HTTP POST to your server) 
         /// when a user clicks a button on a particular match result.
         /// </summary>
         public List<ServerSideHook> Server { get; set; }
 
         /// <summary>
         /// The server-side (HTTP POST)
-        /// <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-hooks">User Action Hooks</see> 
+        /// <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks">User Action Hooks</see> 
         /// for 'Sovren Sourcing' results during a Matching UI session. These can be used to do some server-side action (performs an HTTP POST to your server) 
         /// when a user clicks a button on a particular 'Sovren Sourcing' result.
         /// </summary>

src/Sovren.SDK/Models/API/Matching/UI/UIOptions.cs

@@ -69,14 +69,14 @@ public class UIOptions
         public bool ShowSavedSearches { get; set; }
 
         /// <summary>
-        /// Contains all the <see href="https://docs.sovren.com/Documentation/AIMatching#ui-match-hooks">User Action Hooks</see>
+        /// Contains all the <see href="https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks">User Action Hooks</see>
         /// for the Match UI session. These are used to make a seamless integration between your system and the Sovren Matching UI.
         /// </summary>
         public UserActionHookCollection Hooks { get; set; }
 
         /// <summary>
         /// Picklists shown in the UI for your users to filter on your user-defined tags.
-        /// <br/>See <seealso href="https://docs.sovren.com/Documentation/AIMatching#ai-custom-values"/>
+        /// <br/>See <seealso href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/user-defined-tags/"/>
         /// </summary>
         public List<UserDefinedTagsPicklist> UserDefinedTagsPicklists { get; set; }
 

src/Sovren.SDK/Models/API/Parsing/ConversionMetadata.cs

@@ -22,7 +22,7 @@ public class ConversionMetadata
 
         /// <summary>
         /// The computed validity based on the source text. This will indicate whether
-        /// a document looks like a legitimate resume/job or not. See <see href="https://docs.sovren.com/#document-conversion-result-codes"/>
+        /// a document looks like a legitimate resume/job or not. See <see href="https://sovren.com/technical-specs/latest/rest-api/resume-parser/overview/document-conversion-code/"/>
         /// </summary>
         public string OutputValidityCode { get; set; }
 

src/Sovren.SDK/Models/API/Parsing/ParseOptions.cs

@@ -19,20 +19,20 @@ public class BasicParseOptions
         //********************************
 
         /// <summary>
-        /// The configuration settings to use during parsing. See <see href="https://docs.sovren.com/#config-string-builder"/>.
+        /// The configuration settings to use during parsing. See <see href="https://sovren.com/technical-specs/latest/rest-api/resume-parser/overview/configuration/#config"/>.
         /// <br/>NOTE: leaving this <see langword="null"/>/empty will use the default parsing settings which is recommended in most cases.
         /// </summary>
         public string Configuration { get; set; }
 
         /// <summary>
         /// If you want to use custom skills lists during parsing, set those here. This not a recommended feature for most customers.
-        /// For more information, see <see href="https://docs.sovren.com/#customizing-data-content"/>
+        /// For more information, reach out to support@sovren.com
         /// </summary>
         public List<string> SkillsData { get; set; }
 
         /// <summary>
         /// If you want to use custom normalizations during parsing, set those here. This not a recommended feature for most customers.
-        /// For more information, see <see href="https://docs.sovren.com/#customizing-data-content"/>
+        /// For more information, reach out to support@sovren.com
         /// </summary>
         public string NormalizerData { get; set; }
 

src/Sovren.SDK/Models/API/Parsing/ParseRequest.cs

@@ -30,7 +30,7 @@ public class ParseRequest : ParseOptions
         /// result in rejection of data and/or additional charges, and will utterly decimate the usefulness of AI Matching and 
         /// any Sovren generated metadata. 
         /// <br/>
-        /// <br/>Use of the DocumentLastModified field is subject to the <see href="https://docs.sovren.com/Policies/AcceptableUse?h=revision-date">Acceptable Use Policy</see>.
+        /// <br/>Use of the DocumentLastModified field is subject to the <see href="https://sovren.com/policies-and-agreements/acceptable-use-policy/?h=revision-date">Acceptable Use Policy</see>.
         /// </summary>
         public string DocumentLastModified { get; protected set; }
 

src/Sovren.SDK/Models/Document.cs

@@ -31,7 +31,7 @@ public class Document
         /// <param name="fileBytes">The file byte array</param>
         /// <param name="lastModified">
         /// The last-revised date for this file.
-        /// <br/>Per our AUP (<see href="https://docs.sovren.com/Policies/AcceptableUse"/>), you
+        /// <br/>Per our AUP (<see href="https://sovren.com/policies-and-agreements/acceptable-use-policy/"/>), you
         /// MUST pass a good-faith last-revised date for every parse transaction.
         /// <br/>This is extremely important so that the Parser knows how to interpret dates in the document that 
         /// are expressed as "current" or "as of" (or similar) to correctly calculate date spans

src/Sovren.SDK/Models/Job/ParsedJob.cs

@@ -138,7 +138,7 @@ public class ParsedJob : ParsedDocument
         public JobMetadata JobMetadata { get; set; }
 
         /// <summary>
-        /// A list of <see href="https://docs.sovren.com/Documentation/AIMatching#ai-custom-values">user-defined tags</see> 
+        /// A list of <see href="https://sovren.com/technical-specs/latest/rest-api/ai-matching/overview/user-defined-tags/">user-defined tags</see> 
         /// that are assigned to this job. These are used to filter search/match queries in the AI Matching Engine.
         /// <br/>
         /// <b>NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.</b>

src/Sovren.SDK/Models/ParsedDocumentMetadata.cs

@@ -19,12 +19,20 @@ public class ParsedDocumentMetadata
         public string PlainText { get; set; }
 
         /// <summary>
-        /// The two-letter ISO 639-1 code for the language the document was written in
+        /// An ISO 639-1 code that represents the primary language of the parsed text. When the
+        /// language could not be automatically determined, it is reported as the special value
+        /// <c> iv </c>(invariant/unknown). Note that the two-letter ISO codes reported by the
+        /// Parser - such as <c> zh </c> for Chinese - do not differentiate between language
+        /// variants, such as Mandarin and Cantonese.
         /// </summary>
         public string DocumentLanguage { get; set; }
 
         /// <summary>
-        /// The xx-XX language/culture value for the parsed document. See also <see cref="DocumentLanguage"/>
+        /// An ISO 3066 code that represents the cultural context of the document regarding formatting of
+        /// numbers, dates, character symbols, etc. This value is usually a simple concatenation of the 
+        /// language and country codes, such as <c>en-US</c> for US English; however, note that culture
+        /// can be set independently of language and country to achieve fine-tuned cultural control over parsing,
+        /// so if you use this value you should not assume that it always matches the language and country.
         /// </summary>
         public string DocumentCulture { get; set; }
 

src/Sovren.SDK/Models/Resume/ContactInfo/ContactInformation.cs

@@ -28,7 +28,9 @@ public class ContactInformation
         public List<string> EmailAddresses { get; set; }
 
         /// <summary>
-        /// The candidate's location/address
+        /// The candidate's location/address. The Parser does not standardize addresses. Address standardization
+        /// services are available, including for example the Google Maps API, that can take the Parser's contact
+        /// info fields and standardize/geocode the data.
         /// </summary>
         public Location Location { get; set; }