Fix organization docs (#491)

auth0 · Apr 2, 2021 · aff7af7 · aff7af7
1 parent 574aa3a
commit aff7af7
Show file tree

Hide file tree

Showing 11 changed files with 118 additions and 112 deletions.
diff --git a/docs/api/Auth0.ManagementApi.Clients.OrganizationsClient.html b/docs/api/Auth0.ManagementApi.Clients.OrganizationsClient.html
@@ -387,7 +387,8 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><span class="xref">System.String</span></td>
         <td><span class="parametername">organizationId</span></td>
-        <td></td>
+        <td><p>The id of the organization to which you want to invite a user.</p>
+</td>
       </tr>
       <tr>
         <td><a class="xref" href="Auth0.ManagementApi.Models.OrganizationCreateInvitationRequest.html">OrganizationCreateInvitationRequest</a></td>
@@ -751,13 +752,13 @@ <h5 class="returns">Returns</h5>
     </tbody>
   </table>
   <a id="Auth0_ManagementApi_Clients_OrganizationsClient_GetAllInvitationsAsync_" data-uid="Auth0.ManagementApi.Clients.OrganizationsClient.GetAllInvitationsAsync*"></a>
-  <h4 id="Auth0_ManagementApi_Clients_OrganizationsClient_GetAllInvitationsAsync_System_String_Auth0_ManagementApi_Models_OrganizationGetAllRequest_Auth0_ManagementApi_Paging_PaginationInfo_" data-uid="Auth0.ManagementApi.Clients.OrganizationsClient.GetAllInvitationsAsync(System.String,Auth0.ManagementApi.Models.OrganizationGetAllRequest,Auth0.ManagementApi.Paging.PaginationInfo)">GetAllInvitationsAsync(String, OrganizationGetAllRequest, PaginationInfo)</h4>
+  <h4 id="Auth0_ManagementApi_Clients_OrganizationsClient_GetAllInvitationsAsync_System_String_Auth0_ManagementApi_Models_OrganizationGetAllInvitationsRequest_Auth0_ManagementApi_Paging_PaginationInfo_" data-uid="Auth0.ManagementApi.Clients.OrganizationsClient.GetAllInvitationsAsync(System.String,Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest,Auth0.ManagementApi.Paging.PaginationInfo)">GetAllInvitationsAsync(String, OrganizationGetAllInvitationsRequest, PaginationInfo)</h4>
   <div class="markdown level1 summary"><p>Retrieves a list of all organization invitations.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Task&lt;IPagedList&lt;OrganizationInvitation&gt;&gt; GetAllInvitationsAsync(string organizationId, OrganizationGetAllRequest request, PaginationInfo pagination)</code></pre>
+    <pre><code class="lang-csharp hljs">public Task&lt;IPagedList&lt;OrganizationInvitation&gt;&gt; GetAllInvitationsAsync(string organizationId, OrganizationGetAllInvitationsRequest request, PaginationInfo pagination)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -776,9 +777,10 @@ <h5 class="parameters">Parameters</h5>
 </td>
       </tr>
       <tr>
-        <td><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllRequest.html">OrganizationGetAllRequest</a></td>
+        <td><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.html">OrganizationGetAllInvitationsRequest</a></td>
         <td><span class="parametername">request</span></td>
-        <td></td>
+        <td><p>The <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.html">OrganizationGetAllInvitationsRequest</a> containing the properties to retrieve the organization invitations.</p>
+</td>
       </tr>
       <tr>
         <td><a class="xref" href="Auth0.ManagementApi.Paging.PaginationInfo.html">PaginationInfo</a></td>
@@ -1044,13 +1046,13 @@ <h5 class="returns">Returns</h5>
     </tbody>
   </table>
   <a id="Auth0_ManagementApi_Clients_OrganizationsClient_GetInvitationAsync_" data-uid="Auth0.ManagementApi.Clients.OrganizationsClient.GetInvitationAsync*"></a>
-  <h4 id="Auth0_ManagementApi_Clients_OrganizationsClient_GetInvitationAsync_System_String_System_String_Auth0_ManagementApi_Models_OrganizationGetRequest_" data-uid="Auth0.ManagementApi.Clients.OrganizationsClient.GetInvitationAsync(System.String,System.String,Auth0.ManagementApi.Models.OrganizationGetRequest)">GetInvitationAsync(String, String, OrganizationGetRequest)</h4>
+  <h4 id="Auth0_ManagementApi_Clients_OrganizationsClient_GetInvitationAsync_System_String_System_String_Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_" data-uid="Auth0.ManagementApi.Clients.OrganizationsClient.GetInvitationAsync(System.String,System.String,Auth0.ManagementApi.Models.OrganizationGetInvitationRequest)">GetInvitationAsync(String, String, OrganizationGetInvitationRequest)</h4>
   <div class="markdown level1 summary"><p>Retrieves an organization invitation by its id.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Task&lt;OrganizationInvitation&gt; GetInvitationAsync(string organizationId, string invitationId, OrganizationGetRequest request)</code></pre>
+    <pre><code class="lang-csharp hljs">public Task&lt;OrganizationInvitation&gt; GetInvitationAsync(string organizationId, string invitationId, OrganizationGetInvitationRequest request)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -1075,9 +1077,10 @@ <h5 class="parameters">Parameters</h5>
 </td>
       </tr>
       <tr>
-        <td><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html">OrganizationGetRequest</a></td>
+        <td><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html">OrganizationGetInvitationRequest</a></td>
         <td><span class="parametername">request</span></td>
-        <td></td>
+        <td><p>The <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html">OrganizationGetInvitationRequest</a> containing the properties to retrieve the organization invitation.</p>
+</td>
       </tr>
     </tbody>
   </table>

diff --git a/...Api.Models.OrganizationGetAllRequest.html → ...OrganizationGetAllInvitationsRequest.html b/...Api.Models.OrganizationGetAllRequest.html → ...OrganizationGetAllInvitationsRequest.html
@@ -5,10 +5,10 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>Class OrganizationGetAllRequest
+    <title>Class OrganizationGetAllInvitationsRequest
    </title>
     <meta name="viewport" content="width=device-width">
-    <meta name="title" content="Class OrganizationGetAllRequest
+    <meta name="title" content="Class OrganizationGetAllInvitationsRequest
    ">
     <meta name="generator" content="docfx 2.56.4.0">
 
@@ -68,26 +68,26 @@
         </div>
         <div class="article row grid-right">
           <div class="col-md-10">
-            <article class="content wrap" id="_content" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllRequest">
+            <article class="content wrap" id="_content" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest">
 
 
-  <h1 id="Auth0_ManagementApi_Models_OrganizationGetAllRequest" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllRequest" class="text-break">Class OrganizationGetAllRequest
+  <h1 id="Auth0_ManagementApi_Models_OrganizationGetAllInvitationsRequest" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest" class="text-break">Class OrganizationGetAllInvitationsRequest
   </h1>
   <div class="markdown level0 summary"></div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
     <div class="level0"><span class="xref">System.Object</span></div>
-    <div class="level1"><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html">OrganizationGetRequest</a></div>
-    <div class="level2"><span class="xref">OrganizationGetAllRequest</span></div>
+    <div class="level1"><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html">OrganizationGetInvitationRequest</a></div>
+    <div class="level2"><span class="xref">OrganizationGetAllInvitationsRequest</span></div>
   </div>
   <div class="inheritedMembers">
     <h5>Inherited Members</h5>
     <div>
-      <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html#Auth0_ManagementApi_Models_OrganizationGetRequest_Fields">OrganizationGetRequest.Fields</a>
+      <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html#Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_Fields">OrganizationGetInvitationRequest.Fields</a>
     </div>
     <div>
-      <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html#Auth0_ManagementApi_Models_OrganizationGetRequest_IncludeFields">OrganizationGetRequest.IncludeFields</a>
+      <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html#Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_IncludeFields">OrganizationGetInvitationRequest.IncludeFields</a>
     </div>
     <div>
       <span class="xref">System.Object.Equals(System.Object)</span>
@@ -113,14 +113,14 @@ <h5>Inherited Members</h5>
   </div>
   <h6><strong>Namespace</strong>: <a class="xref" href="Auth0.ManagementApi.Models.html">Auth0.ManagementApi.Models</a></h6>
   <h6><strong>Assembly</strong>: Auth0.ManagementApi.dll</h6>
-  <h5 id="Auth0_ManagementApi_Models_OrganizationGetAllRequest_syntax">Syntax</h5>
+  <h5 id="Auth0_ManagementApi_Models_OrganizationGetAllInvitationsRequest_syntax">Syntax</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public class OrganizationGetAllRequest : OrganizationGetRequest</code></pre>
+    <pre><code class="lang-csharp hljs">public class OrganizationGetAllInvitationsRequest : OrganizationGetInvitationRequest</code></pre>
   </div>
   <h3 id="properties">Properties
   </h3>
-  <a id="Auth0_ManagementApi_Models_OrganizationGetAllRequest_Sort_" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllRequest.Sort*"></a>
-  <h4 id="Auth0_ManagementApi_Models_OrganizationGetAllRequest_Sort" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllRequest.Sort">Sort</h4>
+  <a id="Auth0_ManagementApi_Models_OrganizationGetAllInvitationsRequest_Sort_" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.Sort*"></a>
+  <h4 id="Auth0_ManagementApi_Models_OrganizationGetAllInvitationsRequest_Sort" data-uid="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.Sort">Sort</h4>
   <div class="markdown level1 summary"><p>Field to sort by.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
@@ -143,7 +143,7 @@ <h5 class="propertyValue">Property Value</h5>
       </tr>
     </tbody>
   </table>
-  <h5 id="Auth0_ManagementApi_Models_OrganizationGetAllRequest_Sort_remarks">Remarks</h5>
+  <h5 id="Auth0_ManagementApi_Models_OrganizationGetAllInvitationsRequest_Sort_remarks">Remarks</h5>
   <div class="markdown level1 remarks"><p>Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1.</p>
 </div>
 </article>

diff --git a/...entApi.Models.OrganizationGetRequest.html → ...els.OrganizationGetInvitationRequest.html b/...entApi.Models.OrganizationGetRequest.html → ...els.OrganizationGetInvitationRequest.html
@@ -5,10 +5,10 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>Class OrganizationGetRequest
+    <title>Class OrganizationGetInvitationRequest
    </title>
     <meta name="viewport" content="width=device-width">
-    <meta name="title" content="Class OrganizationGetRequest
+    <meta name="title" content="Class OrganizationGetInvitationRequest
    ">
     <meta name="generator" content="docfx 2.56.4.0">
 
@@ -68,18 +68,18 @@
         </div>
         <div class="article row grid-right">
           <div class="col-md-10">
-            <article class="content wrap" id="_content" data-uid="Auth0.ManagementApi.Models.OrganizationGetRequest">
+            <article class="content wrap" id="_content" data-uid="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest">
 
 
-  <h1 id="Auth0_ManagementApi_Models_OrganizationGetRequest" data-uid="Auth0.ManagementApi.Models.OrganizationGetRequest" class="text-break">Class OrganizationGetRequest
+  <h1 id="Auth0_ManagementApi_Models_OrganizationGetInvitationRequest" data-uid="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest" class="text-break">Class OrganizationGetInvitationRequest
   </h1>
   <div class="markdown level0 summary"></div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
     <div class="level0"><span class="xref">System.Object</span></div>
-    <div class="level1"><span class="xref">OrganizationGetRequest</span></div>
-      <div class="level2"><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllRequest.html">OrganizationGetAllRequest</a></div>
+    <div class="level1"><span class="xref">OrganizationGetInvitationRequest</span></div>
+      <div class="level2"><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.html">OrganizationGetAllInvitationsRequest</a></div>
   </div>
   <div class="inheritedMembers">
     <h5>Inherited Members</h5>
@@ -107,15 +107,15 @@ <h5>Inherited Members</h5>
   </div>
   <h6><strong>Namespace</strong>: <a class="xref" href="Auth0.ManagementApi.Models.html">Auth0.ManagementApi.Models</a></h6>
   <h6><strong>Assembly</strong>: Auth0.ManagementApi.dll</h6>
-  <h5 id="Auth0_ManagementApi_Models_OrganizationGetRequest_syntax">Syntax</h5>
+  <h5 id="Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_syntax">Syntax</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public class OrganizationGetRequest</code></pre>
+    <pre><code class="lang-csharp hljs">public class OrganizationGetInvitationRequest</code></pre>
   </div>
   <h3 id="properties">Properties
   </h3>
-  <a id="Auth0_ManagementApi_Models_OrganizationGetRequest_Fields_" data-uid="Auth0.ManagementApi.Models.OrganizationGetRequest.Fields*"></a>
-  <h4 id="Auth0_ManagementApi_Models_OrganizationGetRequest_Fields" data-uid="Auth0.ManagementApi.Models.OrganizationGetRequest.Fields">Fields</h4>
-  <div class="markdown level1 summary"><p>A comma separated list of fields to include or exclude (depending on <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html#Auth0_ManagementApi_Models_OrganizationGetRequest_IncludeFields">IncludeFields</a>) from the result, empty to retrieve all fields.</p>
+  <a id="Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_Fields_" data-uid="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.Fields*"></a>
+  <h4 id="Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_Fields" data-uid="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.Fields">Fields</h4>
+  <div class="markdown level1 summary"><p>A comma separated list of fields to include or exclude (depending on <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html#Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_IncludeFields">IncludeFields</a>) from the result, empty to retrieve all fields.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -137,9 +137,9 @@ <h5 class="propertyValue">Property Value</h5>
       </tr>
     </tbody>
   </table>
-  <a id="Auth0_ManagementApi_Models_OrganizationGetRequest_IncludeFields_" data-uid="Auth0.ManagementApi.Models.OrganizationGetRequest.IncludeFields*"></a>
-  <h4 id="Auth0_ManagementApi_Models_OrganizationGetRequest_IncludeFields" data-uid="Auth0.ManagementApi.Models.OrganizationGetRequest.IncludeFields">IncludeFields</h4>
-  <div class="markdown level1 summary"><p>Specifies whether the fields specified in <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html#Auth0_ManagementApi_Models_OrganizationGetRequest_Fields">Fields</a> should be included or excluded in the result.</p>
+  <a id="Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_IncludeFields_" data-uid="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.IncludeFields*"></a>
+  <h4 id="Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_IncludeFields" data-uid="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.IncludeFields">IncludeFields</h4>
+  <div class="markdown level1 summary"><p>Specifies whether the fields specified in <a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html#Auth0_ManagementApi_Models_OrganizationGetInvitationRequest_Fields">Fields</a> should be included or excluded in the result.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>

diff --git a/docs/api/Auth0.ManagementApi.Models.html b/docs/api/Auth0.ManagementApi.Models.html
@@ -337,9 +337,9 @@ <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationDeleteMemberRol
       <section></section>
       <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationDeleteMembersRequest.html">OrganizationDeleteMembersRequest</a></h4>
       <section></section>
-      <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllRequest.html">OrganizationGetAllRequest</a></h4>
+      <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.html">OrganizationGetAllInvitationsRequest</a></h4>
       <section></section>
-      <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetRequest.html">OrganizationGetRequest</a></h4>
+      <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html">OrganizationGetInvitationRequest</a></h4>
       <section></section>
       <h4><a class="xref" href="Auth0.ManagementApi.Models.OrganizationInvitation.html">OrganizationInvitation</a></h4>
       <section></section>

diff --git a/docs/api/toc.html b/docs/api/toc.html
@@ -622,10 +622,10 @@
                               <a href="Auth0.ManagementApi.Models.OrganizationDeleteMembersRequest.html" name="" title="OrganizationDeleteMembersRequest">OrganizationDeleteMembersRequest</a>
                           </li>
                           <li>
-                              <a href="Auth0.ManagementApi.Models.OrganizationGetAllRequest.html" name="" title="OrganizationGetAllRequest">OrganizationGetAllRequest</a>
+                              <a href="Auth0.ManagementApi.Models.OrganizationGetAllInvitationsRequest.html" name="" title="OrganizationGetAllInvitationsRequest">OrganizationGetAllInvitationsRequest</a>
                           </li>
                           <li>
-                              <a href="Auth0.ManagementApi.Models.OrganizationGetRequest.html" name="" title="OrganizationGetRequest">OrganizationGetRequest</a>
+                              <a href="Auth0.ManagementApi.Models.OrganizationGetInvitationRequest.html" name="" title="OrganizationGetInvitationRequest">OrganizationGetInvitationRequest</a>
                           </li>
                           <li>
                               <a href="Auth0.ManagementApi.Models.OrganizationInvitation.html" name="" title="OrganizationInvitation">OrganizationInvitation</a>