Skip to content

Commit 046c5c0

Browse files
chore: update params name accessToken --> apiToken (#27)
Because - update params name accessToken --> apiToken This commit - update params name accessToken --> apiToken
1 parent d80a1b7 commit 046c5c0

File tree

9 files changed

+24
-24
lines changed

9 files changed

+24
-24
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import InstillClient from "@instill-ai/typescript-sdk";
4848
```
4949
baseUrl: string
5050
appVersion: string
51-
accessToken: Nullable<string>
51+
apiToken: Nullable<string>
5252
```
5353

5454
## Example app templetes
@@ -257,7 +257,7 @@ modelDefinitionName,
257257

258258
| function | params |
259259
| :--------------------- | :----------------------------------: |
260-
| getUserQuery | accessToken |
260+
| getUserQuery | apiToken |
261261
| checkUserIdExist | id |
262262
| getApiTokenQuery | tokenName |
263263
| listApiTokensQuery | pageSize, nextPageToken |

src/connector/ConnectorClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ class ConnectorClient {
2626
constructor(
2727
baseUrl: string,
2828
appVersion: string,
29-
accessToken: Nullable<string>
29+
apiToken: Nullable<string>
3030
) {
3131
let URL: Nullable<string> = `${baseUrl}/vdp/${appVersion}`;
3232

3333
this.axiosInstance = axios.create({
3434
baseURL: URL,
3535
headers: {
36-
Authorization: `Bearer ${accessToken}`,
36+
Authorization: `Bearer ${apiToken}`,
3737
},
3838
});
3939
}

src/helper/createClient.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { env } from "./config";
33
import { Nullable } from "../types";
44

55
export function createClient(
6-
accessToken: Nullable<string>,
6+
apiToken: Nullable<string>,
77
product: "base" | "model" | "vdp",
88
headers?: AxiosHeaders
99
) {
@@ -12,9 +12,9 @@ export function createClient(
1212
if (headers) {
1313
clientHeaders = headers;
1414
} else {
15-
if (accessToken) {
15+
if (apiToken) {
1616
clientHeaders = {
17-
Authorization: `Bearer ${accessToken}`,
17+
Authorization: `Bearer ${apiToken}`,
1818
"CF-Access-Client-Id": env("CF_ACCESS_CLIENT_ID")
1919
? env("CF_ACCESS_CLIENT_ID")
2020
: undefined,

src/index.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ class InstillClient {
1717
constructor(
1818
baseUrl: string,
1919
appVersion: string,
20-
accessToken: Nullable<string>
20+
apiToken: Nullable<string>
2121
) {
22-
this.Pipeline = new PipelineClient(baseUrl, appVersion, accessToken);
23-
this.Auth = new AuthClient(baseUrl, appVersion, accessToken);
24-
this.Connector = new ConnectorClient(baseUrl, appVersion, accessToken);
25-
this.Metric = new MetricClient(baseUrl, appVersion, accessToken);
26-
this.Model = new ModelClient(baseUrl, appVersion, accessToken);
27-
this.Operation = new OperationClient(baseUrl, appVersion, accessToken);
22+
this.Pipeline = new PipelineClient(baseUrl, appVersion, apiToken);
23+
this.Auth = new AuthClient(baseUrl, appVersion, apiToken);
24+
this.Connector = new ConnectorClient(baseUrl, appVersion, apiToken);
25+
this.Metric = new MetricClient(baseUrl, appVersion, apiToken);
26+
this.Model = new ModelClient(baseUrl, appVersion, apiToken);
27+
this.Operation = new OperationClient(baseUrl, appVersion, apiToken);
2828
}
2929
}
3030

src/metric/MetricClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ class MetricClient {
1616
constructor(
1717
baseUrl: string,
1818
appVersion: string,
19-
accessToken: Nullable<string>
19+
apiToken: Nullable<string>
2020
) {
2121
let URL: Nullable<string> = `${baseUrl}/base/${appVersion}`;
2222

2323
this.axiosInstance = axios.create({
2424
baseURL: URL,
2525
headers: {
26-
Authorization: `Bearer ${accessToken}`,
26+
Authorization: `Bearer ${apiToken}`,
2727
},
2828
});
2929
}

src/mgmt/AuthClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ class AuthClient {
2222
constructor(
2323
baseUrl: string,
2424
appVersion: string,
25-
accessToken: Nullable<string>
25+
apiToken: Nullable<string>
2626
) {
2727
let URL: Nullable<string> = `${baseUrl}/base/${appVersion}`;
2828

2929
this.axiosInstance = axios.create({
3030
baseURL: URL,
3131
headers: {
32-
Authorization: `Bearer ${accessToken}`,
32+
Authorization: `Bearer ${apiToken}`,
3333
},
3434
});
3535
}

src/model/ModelClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ class ModelClient {
2424
constructor(
2525
baseUrl: string,
2626
appVersion: string,
27-
accessToken: Nullable<string>
27+
apiToken: Nullable<string>
2828
) {
2929
let URL: Nullable<string> = `${baseUrl}/model/${appVersion}`;
3030

3131
this.axiosInstance = axios.create({
3232
baseURL: URL,
3333
headers: {
34-
Authorization: `Bearer ${accessToken}`,
34+
Authorization: `Bearer ${apiToken}`,
3535
},
3636
});
3737
}

src/operation/OperationClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ class OperationClient {
88
constructor(
99
baseUrl: string,
1010
appVersion: string,
11-
accessToken: Nullable<string>
11+
apiToken: Nullable<string>
1212
) {
1313
let URL: Nullable<string> = `${baseUrl}/model/${appVersion}`;
1414

1515
this.axiosInstance = axios.create({
1616
baseURL: URL,
1717
headers: {
18-
Authorization: `Bearer ${accessToken}`,
18+
Authorization: `Bearer ${apiToken}`,
1919
},
2020
});
2121
}

src/pipeline/PipelineClient.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ class PipelineClient {
3737
constructor(
3838
baseUrl: string,
3939
appVersion: string,
40-
accessToken: Nullable<string>
40+
apiToken: Nullable<string>
4141
) {
4242
let URL: Nullable<string> = `${baseUrl}/vdp/${appVersion}`;
4343

4444
this.axiosInstance = axios.create({
4545
baseURL: URL,
4646
headers: {
47-
Authorization: `Bearer ${accessToken}`,
47+
Authorization: `Bearer ${apiToken}`,
4848
},
4949
});
5050
}

0 commit comments

Comments
 (0)