@@ -59,43 +59,32 @@ or with the more ergonomic static factory methods.
5959An API key is scoped to a single workspace and should only be used on the server.
6060Obtain one from the Seam Console.
6161
62- ##### Set the ` SEAM_API_KEY ` environment variable
63-
62+ #####
6463``` ts
64+ // Set the `SEAM_API_KEY` environment variable
6565const seam = new SeamHttp ()
66- ```
67-
68- ##### Pass as the first argument to the constructor
6966
70- ``` ts
67+ // Pass as the first argument to the constructor
7168const seam = new SeamHttp (' your-api-key' )
72- ```
73-
74- ##### Pass as an option the constructor
7569
76- ``` ts
70+ // Pass as an option the constructor
7771const seam = new SeamHttp ({ apiKey: ' your-api-key' })
78- ```
79-
80- ##### Use the factory method
8172
82- ``` ts
73+ // Use the factory method
8374const seam = SeamHttp .fromApiKey (' your-api-key' )
8475```
8576
8677#### Client Session Token
8778
8879A Client Session Token is scoped to a client session and should only be used on the client.
8980
90- ##### Pass as an option the constructor
81+ #####
9182
9283``` ts
84+ // Pass as an option the constructor
9385const seam = new SeamHttp ({ clientSessionToken: ' some-client-session-token' })
94- ```
9586
96- ##### Use the factory method
97-
98- ``` ts
87+ // Use the factory method
9988const seam = SeamHttp .fromClientSessionToken (' some-client-session-token' )
10089```
10190
@@ -123,18 +112,15 @@ Obtain one from the Seam Console.
123112A workspace id must be provided when using this method
124113and all requests will be scoped to that workspace.
125114
126- ##### Pass as an option the constructor
127-
128115``` ts
116+ // Pass as an option the constructor
117+
129118const seam = new SeamHttp ({
130119 personalAccessToken: ' your-personal-access-token' ,
131120 workspaceId: ' your-workspace-id' ,
132121})
133- ```
134-
135- ##### Use the factory method
136122
137- ``` ts
123+ // Use the factory method
138124const seam = SeamHttp .fromPersonalAccessToken (
139125 ' some-console-session-token' ,
140126 ' your-workspace-id' ,
@@ -148,18 +134,14 @@ This authentication method is only used by internal Seam applications.
148134A workspace id must be provided when using this method
149135and all requests will be scoped to that workspace.
150136
151- ##### Pass as an option the constructor
152-
153137``` ts
138+ // Pass as an option the constructor
154139const seam = new SeamHttp ({
155140 consoleSessionToken: ' some-console-session-token' ,
156141 workspaceId: ' your-workspace-id' ,
157142})
158- ```
159143
160- ##### Use the factory method
161-
162- ``` ts
144+ // Use the factory method
163145const seam = SeamHttp .fromConsoleSessionToken (
164146 ' some-console-session-token' ,
165147 ' your-workspace-id' ,
0 commit comments