@instructure/athena-api-client 2.7.0 → 2.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -13,12 +13,14 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import type { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
|
|
14
14
|
export interface GetTaxonomyRequest {
|
|
15
15
|
id: string;
|
|
16
|
+
xUserId: string;
|
|
16
17
|
}
|
|
17
18
|
export interface GetTaxonomyBySlugRequest {
|
|
18
19
|
slug: string;
|
|
20
|
+
xUserId: string;
|
|
19
21
|
}
|
|
20
22
|
export interface ListTaxonomiesRequest {
|
|
21
|
-
|
|
23
|
+
xUserId: string;
|
|
22
24
|
status?: ListTaxonomiesStatusEnum;
|
|
23
25
|
limit?: number;
|
|
24
26
|
offset?: number;
|
|
@@ -50,7 +52,7 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
50
52
|
/**
|
|
51
53
|
* List available taxonomies
|
|
52
54
|
*/
|
|
53
|
-
listTaxonomies(requestParameters
|
|
55
|
+
listTaxonomies(requestParameters: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
|
|
54
56
|
}
|
|
55
57
|
/**
|
|
56
58
|
* @export
|
|
@@ -37,8 +37,14 @@ class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
37
37
|
if (requestParameters['id'] == null) {
|
|
38
38
|
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomy().');
|
|
39
39
|
}
|
|
40
|
+
if (requestParameters['xUserId'] == null) {
|
|
41
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomy().');
|
|
42
|
+
}
|
|
40
43
|
const queryParameters = {};
|
|
41
44
|
const headerParameters = {};
|
|
45
|
+
if (requestParameters['xUserId'] != null) {
|
|
46
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
47
|
+
}
|
|
42
48
|
if (this.configuration && this.configuration.apiKey) {
|
|
43
49
|
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
44
50
|
}
|
|
@@ -70,8 +76,14 @@ class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
70
76
|
if (requestParameters['slug'] == null) {
|
|
71
77
|
throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getTaxonomyBySlug().');
|
|
72
78
|
}
|
|
79
|
+
if (requestParameters['xUserId'] == null) {
|
|
80
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyBySlug().');
|
|
81
|
+
}
|
|
73
82
|
const queryParameters = {};
|
|
74
83
|
const headerParameters = {};
|
|
84
|
+
if (requestParameters['xUserId'] != null) {
|
|
85
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
86
|
+
}
|
|
75
87
|
if (this.configuration && this.configuration.apiKey) {
|
|
76
88
|
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
77
89
|
}
|
|
@@ -100,10 +112,10 @@ class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
100
112
|
*/
|
|
101
113
|
listTaxonomiesRaw(requestParameters, initOverrides) {
|
|
102
114
|
return __awaiter(this, void 0, void 0, function* () {
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
queryParameters['accountId'] = requestParameters['accountId'];
|
|
115
|
+
if (requestParameters['xUserId'] == null) {
|
|
116
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listTaxonomies().');
|
|
106
117
|
}
|
|
118
|
+
const queryParameters = {};
|
|
107
119
|
if (requestParameters['status'] != null) {
|
|
108
120
|
queryParameters['status'] = requestParameters['status'];
|
|
109
121
|
}
|
|
@@ -114,6 +126,9 @@ class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
114
126
|
queryParameters['offset'] = requestParameters['offset'];
|
|
115
127
|
}
|
|
116
128
|
const headerParameters = {};
|
|
129
|
+
if (requestParameters['xUserId'] != null) {
|
|
130
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
131
|
+
}
|
|
117
132
|
if (this.configuration && this.configuration.apiKey) {
|
|
118
133
|
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
119
134
|
}
|
|
@@ -130,8 +145,8 @@ class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
130
145
|
/**
|
|
131
146
|
* List available taxonomies
|
|
132
147
|
*/
|
|
133
|
-
listTaxonomies() {
|
|
134
|
-
return __awaiter(this,
|
|
148
|
+
listTaxonomies(requestParameters, initOverrides) {
|
|
149
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
135
150
|
const response = yield this.listTaxonomiesRaw(requestParameters, initOverrides);
|
|
136
151
|
return yield response.value();
|
|
137
152
|
});
|
|
@@ -13,12 +13,14 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import type { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
|
|
14
14
|
export interface GetTaxonomyRequest {
|
|
15
15
|
id: string;
|
|
16
|
+
xUserId: string;
|
|
16
17
|
}
|
|
17
18
|
export interface GetTaxonomyBySlugRequest {
|
|
18
19
|
slug: string;
|
|
20
|
+
xUserId: string;
|
|
19
21
|
}
|
|
20
22
|
export interface ListTaxonomiesRequest {
|
|
21
|
-
|
|
23
|
+
xUserId: string;
|
|
22
24
|
status?: ListTaxonomiesStatusEnum;
|
|
23
25
|
limit?: number;
|
|
24
26
|
offset?: number;
|
|
@@ -50,7 +52,7 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
50
52
|
/**
|
|
51
53
|
* List available taxonomies
|
|
52
54
|
*/
|
|
53
|
-
listTaxonomies(requestParameters
|
|
55
|
+
listTaxonomies(requestParameters: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
|
|
54
56
|
}
|
|
55
57
|
/**
|
|
56
58
|
* @export
|
|
@@ -34,8 +34,14 @@ export class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
34
34
|
if (requestParameters['id'] == null) {
|
|
35
35
|
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomy().');
|
|
36
36
|
}
|
|
37
|
+
if (requestParameters['xUserId'] == null) {
|
|
38
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomy().');
|
|
39
|
+
}
|
|
37
40
|
const queryParameters = {};
|
|
38
41
|
const headerParameters = {};
|
|
42
|
+
if (requestParameters['xUserId'] != null) {
|
|
43
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
44
|
+
}
|
|
39
45
|
if (this.configuration && this.configuration.apiKey) {
|
|
40
46
|
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
41
47
|
}
|
|
@@ -67,8 +73,14 @@ export class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
67
73
|
if (requestParameters['slug'] == null) {
|
|
68
74
|
throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getTaxonomyBySlug().');
|
|
69
75
|
}
|
|
76
|
+
if (requestParameters['xUserId'] == null) {
|
|
77
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyBySlug().');
|
|
78
|
+
}
|
|
70
79
|
const queryParameters = {};
|
|
71
80
|
const headerParameters = {};
|
|
81
|
+
if (requestParameters['xUserId'] != null) {
|
|
82
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
83
|
+
}
|
|
72
84
|
if (this.configuration && this.configuration.apiKey) {
|
|
73
85
|
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
74
86
|
}
|
|
@@ -97,10 +109,10 @@ export class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
97
109
|
*/
|
|
98
110
|
listTaxonomiesRaw(requestParameters, initOverrides) {
|
|
99
111
|
return __awaiter(this, void 0, void 0, function* () {
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
queryParameters['accountId'] = requestParameters['accountId'];
|
|
112
|
+
if (requestParameters['xUserId'] == null) {
|
|
113
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listTaxonomies().');
|
|
103
114
|
}
|
|
115
|
+
const queryParameters = {};
|
|
104
116
|
if (requestParameters['status'] != null) {
|
|
105
117
|
queryParameters['status'] = requestParameters['status'];
|
|
106
118
|
}
|
|
@@ -111,6 +123,9 @@ export class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
111
123
|
queryParameters['offset'] = requestParameters['offset'];
|
|
112
124
|
}
|
|
113
125
|
const headerParameters = {};
|
|
126
|
+
if (requestParameters['xUserId'] != null) {
|
|
127
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
128
|
+
}
|
|
114
129
|
if (this.configuration && this.configuration.apiKey) {
|
|
115
130
|
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
116
131
|
}
|
|
@@ -127,8 +142,8 @@ export class TaxonomiesApi extends runtime.BaseAPI {
|
|
|
127
142
|
/**
|
|
128
143
|
* List available taxonomies
|
|
129
144
|
*/
|
|
130
|
-
listTaxonomies() {
|
|
131
|
-
return __awaiter(this,
|
|
145
|
+
listTaxonomies(requestParameters, initOverrides) {
|
|
146
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
132
147
|
const response = yield this.listTaxonomiesRaw(requestParameters, initOverrides);
|
|
133
148
|
return yield response.value();
|
|
134
149
|
});
|