[doc] Added documentation API V2 for custom fields

docs/dist/_sources/index.rst.txt

@@ -48,6 +48,7 @@ The goal of this library is to make life of developers as easy as possible.
    :hidden:
    :caption: Twitter API - v2
 
+   twitter-api-v2/basics
    twitter-api-v2/tweets
    twitter-api-v2/users
 

docs/dist/_sources/twitter-api-v2/basics.md.txt

@@ -0,0 +1,51 @@
+# Basics of API V2
+
+This page explain the basic concepts of Twitter API V2 and how Tweetinvi works.
+
+## Fields
+
+[Official Doc Link](https://developer.twitter.com/en/docs/twitter-api/fields)
+
+> The Twitter API v2 allows to specify which fields a query should return.
+
+<div class="note">
+
+By default Tweetinvi will request all the fields that are not subject to change from the user context.\
+It means all the fields apart from some metric fields (non_public_metrics, organic_metrics and promoted_metrics).
+</div>
+
+In Tweetinvi, you can add/remove fields by specifying them in the request parameters.\
+Tweetinvi list the fields available for each type of request in an associated `ResponseFields` class.
+
+``` c#
+// For a TweetQuery, you can find the fields in TweetResponseFields
+var tweetResponse = await client.TweetsV2.GetTweetAsync(new GetTweetV2Parameters(42)
+{
+    Expansions =
+    {
+        TweetResponseFields.Expansions.AuthorId,
+        TweetResponseFields.Expansions.ReferencedTweetsId,
+    },
+    TweetFields =
+    {
+        TweetResponseFields.Tweet.Attachments,
+        TweetResponseFields.Tweet.Entities
+    },
+    UserFields = TweetResponseFields.User.ALL
+});
+
+// For a User query
+var userResponse = userClient.UsersV2.GetUserByNameAsync(new GetUserByNameV2Parameters("tweetinviapi")
+{
+    Expansions =
+    {
+        UserResponseFields.Expansions.PinnedTweetId,
+    },
+    TweetFields =
+    {
+        UserResponseFields.Tweet.Attachments,
+        UserResponseFields.Tweet.Entities
+    },
+    UserFields = UserResponseFields.User.ALL
+});
+```

docs/dist/account-activity/account-activity-events.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/account-activity/account-activity-subscriptions.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/account-activity/account-activity-with-aspnet.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/account-activity/account-activity-with-http-server.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/account-activity/account-activity.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/authentication/authentication-pin-code.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/authentication/authentication-url-redirect.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/authentication/authentication.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/credentials/credentials.html

@@ -119,6 +119,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/credentials/rate-limits-handlers.html

@@ -117,6 +117,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/credentials/rate-limits.html

@@ -119,6 +119,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/genindex.html

@@ -110,6 +110,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/index.html

@@ -111,6 +111,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/intro/basic-concepts.html

@@ -122,6 +122,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/intro/getting-started.html

@@ -118,6 +118,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/exceptions.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/extended-tweets.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/help.html

@@ -111,6 +111,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/license.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/parameters-validators.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/releases.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/tweetinvi-container.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/more/twitter-labs.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/search.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/filtered-stream-filters.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/filtered-stream.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/labs-filtered-stream.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/labs-sample-stream.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/sample-stream.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/streams-introduction.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/streams/tweet-stream.html

@@ -112,6 +112,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/twitter-api-v1.1/direct-api-calls.html

@@ -118,6 +118,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/twitter-api-v1.1/help.html

@@ -38,7 +38,7 @@
 
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Tweets V2" href="../twitter-api-v2/tweets.html" />
+    <link rel="next" title="Basics of API V2" href="../twitter-api-v2/basics.html" />
     <link rel="prev" title="Trends" href="trends.html" /> 
 </head>
 
@@ -116,6 +116,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>
@@ -267,7 +268,7 @@ <h2>Twitter configuration<a class="headerlink" href="#twitter-configuration" tit
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="../twitter-api-v2/tweets.html" class="btn btn-neutral float-right" title="Tweets V2" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="../twitter-api-v2/basics.html" class="btn btn-neutral float-right" title="Basics of API V2" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="trends.html" class="btn btn-neutral float-left" title="Trends" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

docs/dist/twitter-api-v1.1/iterators.html

@@ -124,6 +124,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/twitter-api-v1.1/lists.html

@@ -119,6 +119,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/twitter-api-v1.1/messages.html

@@ -118,6 +118,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/twitter-api-v1.1/search.html

@@ -117,6 +117,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>

docs/dist/twitter-api-v1.1/timelines.html

@@ -118,6 +118,7 @@
 </ul>
 <p class="caption"><span class="caption-text">Twitter API - v2</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/basics.html">Basics of API V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/tweets.html">Tweets V2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../twitter-api-v2/users.html">Users V2</a></li>
 </ul>