@spaciv/sdk 0.1.10 → 0.1.12
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.
- package/README.md +2 -2
- package/dist/apis/DataCollectionApi.d.ts +8 -8
- package/dist/apis/DataCollectionApi.js +4 -4
- package/dist/esm/apis/DataCollectionApi.d.ts +8 -8
- package/dist/esm/apis/DataCollectionApi.js +4 -4
- package/dist/esm/models/GetDatacollectionRes.d.ts +6 -6
- package/dist/esm/models/GetDatacollectionRes.js +4 -2
- package/dist/models/GetDatacollectionRes.d.ts +6 -6
- package/dist/models/GetDatacollectionRes.js +4 -2
- package/package.json +1 -1
- package/src/apis/DataCollectionApi.ts +8 -8
- package/src/models/GetDatacollectionRes.ts +9 -8
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.12
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @spaciv/sdk@0.1.
|
|
39
|
+
npm install @spaciv/sdk@0.1.12 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -65,7 +65,7 @@ export interface DataCollectionApiInterface {
|
|
|
65
65
|
*/
|
|
66
66
|
delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
67
67
|
/**
|
|
68
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
68
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
69
69
|
* @summary Get a data collection survey
|
|
70
70
|
* @param {string} id
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
@@ -74,7 +74,7 @@ export interface DataCollectionApiInterface {
|
|
|
74
74
|
*/
|
|
75
75
|
getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
|
|
76
76
|
/**
|
|
77
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
77
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
78
78
|
* Get a data collection survey
|
|
79
79
|
*/
|
|
80
80
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -134,7 +134,7 @@ export interface DataCollectionApiInterface {
|
|
|
134
134
|
*/
|
|
135
135
|
listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
|
|
136
136
|
/**
|
|
137
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
137
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
138
138
|
* @summary Update a data collection survey
|
|
139
139
|
* @param {string} id
|
|
140
140
|
* @param {DatacollectionBody} [datacollectionBody]
|
|
@@ -144,7 +144,7 @@ export interface DataCollectionApiInterface {
|
|
|
144
144
|
*/
|
|
145
145
|
updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
146
146
|
/**
|
|
147
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
147
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
148
148
|
* Update a data collection survey
|
|
149
149
|
*/
|
|
150
150
|
update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -174,12 +174,12 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
|
|
|
174
174
|
*/
|
|
175
175
|
delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
176
176
|
/**
|
|
177
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
177
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
178
178
|
* Get a data collection survey
|
|
179
179
|
*/
|
|
180
180
|
getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
|
|
181
181
|
/**
|
|
182
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
182
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
183
183
|
* Get a data collection survey
|
|
184
184
|
*/
|
|
185
185
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -224,12 +224,12 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
|
|
|
224
224
|
*/
|
|
225
225
|
listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
|
|
226
226
|
/**
|
|
227
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
227
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
228
228
|
* Update a data collection survey
|
|
229
229
|
*/
|
|
230
230
|
updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
231
231
|
/**
|
|
232
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
232
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
233
233
|
* Update a data collection survey
|
|
234
234
|
*/
|
|
235
235
|
update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -104,7 +104,7 @@ class DataCollectionApi extends runtime.BaseAPI {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
107
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
108
108
|
* Get a data collection survey
|
|
109
109
|
*/
|
|
110
110
|
getRaw(requestParameters, initOverrides) {
|
|
@@ -133,7 +133,7 @@ class DataCollectionApi extends runtime.BaseAPI {
|
|
|
133
133
|
});
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
136
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
137
137
|
* Get a data collection survey
|
|
138
138
|
*/
|
|
139
139
|
get(requestParameters, initOverrides) {
|
|
@@ -305,7 +305,7 @@ class DataCollectionApi extends runtime.BaseAPI {
|
|
|
305
305
|
});
|
|
306
306
|
}
|
|
307
307
|
/**
|
|
308
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
308
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
309
309
|
* Update a data collection survey
|
|
310
310
|
*/
|
|
311
311
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -336,7 +336,7 @@ class DataCollectionApi extends runtime.BaseAPI {
|
|
|
336
336
|
});
|
|
337
337
|
}
|
|
338
338
|
/**
|
|
339
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
339
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
340
340
|
* Update a data collection survey
|
|
341
341
|
*/
|
|
342
342
|
update(requestParameters, initOverrides) {
|
|
@@ -65,7 +65,7 @@ export interface DataCollectionApiInterface {
|
|
|
65
65
|
*/
|
|
66
66
|
delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
67
67
|
/**
|
|
68
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
68
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
69
69
|
* @summary Get a data collection survey
|
|
70
70
|
* @param {string} id
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
@@ -74,7 +74,7 @@ export interface DataCollectionApiInterface {
|
|
|
74
74
|
*/
|
|
75
75
|
getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
|
|
76
76
|
/**
|
|
77
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
77
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
78
78
|
* Get a data collection survey
|
|
79
79
|
*/
|
|
80
80
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -134,7 +134,7 @@ export interface DataCollectionApiInterface {
|
|
|
134
134
|
*/
|
|
135
135
|
listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
|
|
136
136
|
/**
|
|
137
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
137
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
138
138
|
* @summary Update a data collection survey
|
|
139
139
|
* @param {string} id
|
|
140
140
|
* @param {DatacollectionBody} [datacollectionBody]
|
|
@@ -144,7 +144,7 @@ export interface DataCollectionApiInterface {
|
|
|
144
144
|
*/
|
|
145
145
|
updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
146
146
|
/**
|
|
147
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
147
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
148
148
|
* Update a data collection survey
|
|
149
149
|
*/
|
|
150
150
|
update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -174,12 +174,12 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
|
|
|
174
174
|
*/
|
|
175
175
|
delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
176
176
|
/**
|
|
177
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
177
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
178
178
|
* Get a data collection survey
|
|
179
179
|
*/
|
|
180
180
|
getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
|
|
181
181
|
/**
|
|
182
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
182
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
183
183
|
* Get a data collection survey
|
|
184
184
|
*/
|
|
185
185
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -224,12 +224,12 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
|
|
|
224
224
|
*/
|
|
225
225
|
listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
|
|
226
226
|
/**
|
|
227
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
227
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
228
228
|
* Update a data collection survey
|
|
229
229
|
*/
|
|
230
230
|
updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
231
231
|
/**
|
|
232
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
232
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
233
233
|
* Update a data collection survey
|
|
234
234
|
*/
|
|
235
235
|
update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -101,7 +101,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
104
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
105
105
|
* Get a data collection survey
|
|
106
106
|
*/
|
|
107
107
|
getRaw(requestParameters, initOverrides) {
|
|
@@ -130,7 +130,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
|
|
|
130
130
|
});
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
133
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
133
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
134
134
|
* Get a data collection survey
|
|
135
135
|
*/
|
|
136
136
|
get(requestParameters, initOverrides) {
|
|
@@ -302,7 +302,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
|
|
|
302
302
|
});
|
|
303
303
|
}
|
|
304
304
|
/**
|
|
305
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
305
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
306
306
|
* Update a data collection survey
|
|
307
307
|
*/
|
|
308
308
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -333,7 +333,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
|
|
|
333
333
|
});
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
336
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
337
337
|
* Update a data collection survey
|
|
338
338
|
*/
|
|
339
339
|
update(requestParameters, initOverrides) {
|
|
@@ -24,22 +24,22 @@ export interface GetDatacollectionRes {
|
|
|
24
24
|
completed: number;
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
|
-
* @type {
|
|
27
|
+
* @type {number}
|
|
28
28
|
* @memberof GetDatacollectionRes
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
contributorCount: number;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
|
-
* @type {
|
|
33
|
+
* @type {DatacollectionChangelogBody}
|
|
34
34
|
* @memberof GetDatacollectionRes
|
|
35
35
|
*/
|
|
36
|
-
|
|
36
|
+
datacollection: DatacollectionChangelogBody;
|
|
37
37
|
/**
|
|
38
38
|
*
|
|
39
|
-
* @type {
|
|
39
|
+
* @type {string}
|
|
40
40
|
* @memberof GetDatacollectionRes
|
|
41
41
|
*/
|
|
42
|
-
|
|
42
|
+
id: string;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
45
|
* @type {number}
|
|
@@ -18,6 +18,8 @@ import { DatacollectionChangelogBodyFromJSON, DatacollectionChangelogBodyToJSON,
|
|
|
18
18
|
export function instanceOfGetDatacollectionRes(value) {
|
|
19
19
|
if (!('completed' in value) || value['completed'] === undefined)
|
|
20
20
|
return false;
|
|
21
|
+
if (!('contributorCount' in value) || value['contributorCount'] === undefined)
|
|
22
|
+
return false;
|
|
21
23
|
if (!('datacollection' in value) || value['datacollection'] === undefined)
|
|
22
24
|
return false;
|
|
23
25
|
if (!('id' in value) || value['id'] === undefined)
|
|
@@ -37,9 +39,9 @@ export function GetDatacollectionResFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
39
|
}
|
|
38
40
|
return {
|
|
39
41
|
'completed': json['completed'],
|
|
42
|
+
'contributorCount': json['contributorCount'],
|
|
40
43
|
'datacollection': DatacollectionChangelogBodyFromJSON(json['datacollection']),
|
|
41
44
|
'id': json['id'],
|
|
42
|
-
'legacyContributors': json['legacyContributors'] == null ? undefined : json['legacyContributors'],
|
|
43
45
|
'started': json['started'],
|
|
44
46
|
'total': json['total'],
|
|
45
47
|
};
|
|
@@ -53,9 +55,9 @@ export function GetDatacollectionResToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
53
55
|
}
|
|
54
56
|
return {
|
|
55
57
|
'completed': value['completed'],
|
|
58
|
+
'contributorCount': value['contributorCount'],
|
|
56
59
|
'datacollection': DatacollectionChangelogBodyToJSON(value['datacollection']),
|
|
57
60
|
'id': value['id'],
|
|
58
|
-
'legacyContributors': value['legacyContributors'],
|
|
59
61
|
'started': value['started'],
|
|
60
62
|
'total': value['total'],
|
|
61
63
|
};
|
|
@@ -24,22 +24,22 @@ export interface GetDatacollectionRes {
|
|
|
24
24
|
completed: number;
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
|
-
* @type {
|
|
27
|
+
* @type {number}
|
|
28
28
|
* @memberof GetDatacollectionRes
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
contributorCount: number;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
|
-
* @type {
|
|
33
|
+
* @type {DatacollectionChangelogBody}
|
|
34
34
|
* @memberof GetDatacollectionRes
|
|
35
35
|
*/
|
|
36
|
-
|
|
36
|
+
datacollection: DatacollectionChangelogBody;
|
|
37
37
|
/**
|
|
38
38
|
*
|
|
39
|
-
* @type {
|
|
39
|
+
* @type {string}
|
|
40
40
|
* @memberof GetDatacollectionRes
|
|
41
41
|
*/
|
|
42
|
-
|
|
42
|
+
id: string;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
45
|
* @type {number}
|
|
@@ -25,6 +25,8 @@ const DatacollectionChangelogBody_1 = require("./DatacollectionChangelogBody");
|
|
|
25
25
|
function instanceOfGetDatacollectionRes(value) {
|
|
26
26
|
if (!('completed' in value) || value['completed'] === undefined)
|
|
27
27
|
return false;
|
|
28
|
+
if (!('contributorCount' in value) || value['contributorCount'] === undefined)
|
|
29
|
+
return false;
|
|
28
30
|
if (!('datacollection' in value) || value['datacollection'] === undefined)
|
|
29
31
|
return false;
|
|
30
32
|
if (!('id' in value) || value['id'] === undefined)
|
|
@@ -44,9 +46,9 @@ function GetDatacollectionResFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
44
46
|
}
|
|
45
47
|
return {
|
|
46
48
|
'completed': json['completed'],
|
|
49
|
+
'contributorCount': json['contributorCount'],
|
|
47
50
|
'datacollection': (0, DatacollectionChangelogBody_1.DatacollectionChangelogBodyFromJSON)(json['datacollection']),
|
|
48
51
|
'id': json['id'],
|
|
49
|
-
'legacyContributors': json['legacyContributors'] == null ? undefined : json['legacyContributors'],
|
|
50
52
|
'started': json['started'],
|
|
51
53
|
'total': json['total'],
|
|
52
54
|
};
|
|
@@ -60,9 +62,9 @@ function GetDatacollectionResToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
60
62
|
}
|
|
61
63
|
return {
|
|
62
64
|
'completed': value['completed'],
|
|
65
|
+
'contributorCount': value['contributorCount'],
|
|
63
66
|
'datacollection': (0, DatacollectionChangelogBody_1.DatacollectionChangelogBodyToJSON)(value['datacollection']),
|
|
64
67
|
'id': value['id'],
|
|
65
|
-
'legacyContributors': value['legacyContributors'],
|
|
66
68
|
'started': value['started'],
|
|
67
69
|
'total': value['total'],
|
|
68
70
|
};
|
package/package.json
CHANGED
|
@@ -101,7 +101,7 @@ export interface DataCollectionApiInterface {
|
|
|
101
101
|
delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
102
102
|
|
|
103
103
|
/**
|
|
104
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
104
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
105
105
|
* @summary Get a data collection survey
|
|
106
106
|
* @param {string} id
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
@@ -111,7 +111,7 @@ export interface DataCollectionApiInterface {
|
|
|
111
111
|
getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
|
|
112
112
|
|
|
113
113
|
/**
|
|
114
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
114
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
115
115
|
* Get a data collection survey
|
|
116
116
|
*/
|
|
117
117
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -180,7 +180,7 @@ export interface DataCollectionApiInterface {
|
|
|
180
180
|
listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
|
|
181
181
|
|
|
182
182
|
/**
|
|
183
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
183
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
184
184
|
* @summary Update a data collection survey
|
|
185
185
|
* @param {string} id
|
|
186
186
|
* @param {DatacollectionBody} [datacollectionBody]
|
|
@@ -191,7 +191,7 @@ export interface DataCollectionApiInterface {
|
|
|
191
191
|
updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
192
192
|
|
|
193
193
|
/**
|
|
194
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
194
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
195
195
|
* Update a data collection survey
|
|
196
196
|
*/
|
|
197
197
|
update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -290,7 +290,7 @@ export class DataCollectionApi extends runtime.BaseAPI implements DataCollection
|
|
|
290
290
|
}
|
|
291
291
|
|
|
292
292
|
/**
|
|
293
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
293
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
294
294
|
* Get a data collection survey
|
|
295
295
|
*/
|
|
296
296
|
async getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>> {
|
|
@@ -328,7 +328,7 @@ export class DataCollectionApi extends runtime.BaseAPI implements DataCollection
|
|
|
328
328
|
}
|
|
329
329
|
|
|
330
330
|
/**
|
|
331
|
-
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts.
|
|
331
|
+
* Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. `contributorCount` is the number of uploaded contributors for callers with *View crowd modelling* or *Configure crowd modelling*, and 0 otherwise.
|
|
332
332
|
* Get a data collection survey
|
|
333
333
|
*/
|
|
334
334
|
async get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes> {
|
|
@@ -525,7 +525,7 @@ export class DataCollectionApi extends runtime.BaseAPI implements DataCollection
|
|
|
525
525
|
}
|
|
526
526
|
|
|
527
527
|
/**
|
|
528
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
528
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
529
529
|
* Update a data collection survey
|
|
530
530
|
*/
|
|
531
531
|
async updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
|
|
@@ -566,7 +566,7 @@ export class DataCollectionApi extends runtime.BaseAPI implements DataCollection
|
|
|
566
566
|
}
|
|
567
567
|
|
|
568
568
|
/**
|
|
569
|
-
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending
|
|
569
|
+
* Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
|
|
570
570
|
* Update a data collection survey
|
|
571
571
|
*/
|
|
572
572
|
async update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
|
|
@@ -35,22 +35,22 @@ export interface GetDatacollectionRes {
|
|
|
35
35
|
completed: number;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
|
-
* @type {
|
|
38
|
+
* @type {number}
|
|
39
39
|
* @memberof GetDatacollectionRes
|
|
40
40
|
*/
|
|
41
|
-
|
|
41
|
+
contributorCount: number;
|
|
42
42
|
/**
|
|
43
43
|
*
|
|
44
|
-
* @type {
|
|
44
|
+
* @type {DatacollectionChangelogBody}
|
|
45
45
|
* @memberof GetDatacollectionRes
|
|
46
46
|
*/
|
|
47
|
-
|
|
47
|
+
datacollection: DatacollectionChangelogBody;
|
|
48
48
|
/**
|
|
49
49
|
*
|
|
50
|
-
* @type {
|
|
50
|
+
* @type {string}
|
|
51
51
|
* @memberof GetDatacollectionRes
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
id: string;
|
|
54
54
|
/**
|
|
55
55
|
*
|
|
56
56
|
* @type {number}
|
|
@@ -70,6 +70,7 @@ export interface GetDatacollectionRes {
|
|
|
70
70
|
*/
|
|
71
71
|
export function instanceOfGetDatacollectionRes(value: object): value is GetDatacollectionRes {
|
|
72
72
|
if (!('completed' in value) || value['completed'] === undefined) return false;
|
|
73
|
+
if (!('contributorCount' in value) || value['contributorCount'] === undefined) return false;
|
|
73
74
|
if (!('datacollection' in value) || value['datacollection'] === undefined) return false;
|
|
74
75
|
if (!('id' in value) || value['id'] === undefined) return false;
|
|
75
76
|
if (!('started' in value) || value['started'] === undefined) return false;
|
|
@@ -88,9 +89,9 @@ export function GetDatacollectionResFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
88
89
|
return {
|
|
89
90
|
|
|
90
91
|
'completed': json['completed'],
|
|
92
|
+
'contributorCount': json['contributorCount'],
|
|
91
93
|
'datacollection': DatacollectionChangelogBodyFromJSON(json['datacollection']),
|
|
92
94
|
'id': json['id'],
|
|
93
|
-
'legacyContributors': json['legacyContributors'] == null ? undefined : json['legacyContributors'],
|
|
94
95
|
'started': json['started'],
|
|
95
96
|
'total': json['total'],
|
|
96
97
|
};
|
|
@@ -108,9 +109,9 @@ export function GetDatacollectionResToJSONTyped(value?: GetDatacollectionRes | n
|
|
|
108
109
|
return {
|
|
109
110
|
|
|
110
111
|
'completed': value['completed'],
|
|
112
|
+
'contributorCount': value['contributorCount'],
|
|
111
113
|
'datacollection': DatacollectionChangelogBodyToJSON(value['datacollection']),
|
|
112
114
|
'id': value['id'],
|
|
113
|
-
'legacyContributors': value['legacyContributors'],
|
|
114
115
|
'started': value['started'],
|
|
115
116
|
'total': value['total'],
|
|
116
117
|
};
|